feat: added BlockNumber struct #1043

varun-doshi · 2024-12-31T17:21:31Z

Ref #1040

varun-doshi · 2024-12-31T17:22:29Z

This is currently in init state. I will implement the functions as advised next

PhilippGackstatter

Thanks for the contribution!

Looks good generally. I have some nits and mainly two comments.

I think we can make more use of BlockNumber in many places, see inline comments.
It would be great if we can get rid of the standalone functions so they are only accessed through BlockNumber::* functions:

miden-base/objects/src/block/header.rs

Lines 281 to 289 in c98b1b7

    
           /// Returns the block number of the epoch block for the given `epoch`. 
        
           pub const fn block_num_from_epoch(epoch: u16) -> u32 { 
        
               (epoch as u32) << BlockHeader::EPOCH_LENGTH_EXPONENT 
        
           } 
        
           /// Returns the epoch of the given block number. 
        
           pub const fn block_epoch_from_number(block_number: u32) -> u16 { 
        
               (block_number >> BlockHeader::EPOCH_LENGTH_EXPONENT) as u16 
        
           }

Not sure whether we should keep BlockHeader::block_epoch. It can be easily replaced by block_header.block_num().epoch(), but it's also convenient. Both options are fine, I think.

objects/src/block/header.rs

PhilippGackstatter

Thanks for the updates, it looks great!

I mentioned a couple more places where we can replace u32s with BlockNumber.

To get this PR in a mergable state, there are some other small tasks:

Add an entry in CHANGELOG.md pointing to this PR, for example.

Add BlockNumber struct (feat: added BlockNumber struct #1043).
Run make format, make clippy and make doc locally to ensure everything is formatted correctly, that no lints complain and that docs can be built without errors.
You can also run cargo test -p miden-objects --features testing to run tests locally and make sure CI won't complain.
There is a small merge conflict that needs to be resolved.

Scroll to the bottom of this PR to see which checks in CI are failing.

Thanks again for your contributions!

PhilippGackstatter · 2025-01-09T09:40:04Z

objects/src/block/header.rs

+/// Holds `u32` type to signify Block Number
+
+#[derive(Debug, Eq, PartialEq, Copy, Clone, PartialOrd, Ord, Hash)]
+/// A convenience wrapper around a `u32` representing the number of a block.
+///
+/// Each block has a unique number and block numbers increase monotonically by `1`.
+pub struct BlockNumber(u32);


Suggested change

/// Holds `u32` type to signify Block Number

#[derive(Debug, Eq, PartialEq, Copy, Clone, PartialOrd, Ord, Hash)]

/// A convenience wrapper around a `u32` representing the number of a block.

///

/// Each block has a unique number and block numbers increase monotonically by `1`.

pub struct BlockNumber(u32);

/// A convenience wrapper around a `u32` representing the number of a block.

///

/// Each block has a unique number and block numbers increase monotonically by `1`.

#[derive(Debug, Eq, PartialEq, Copy, Clone, PartialOrd, Ord, Hash)]

pub struct BlockNumber(u32);

Leftover docs from before.

Nit: derives are usually placed directly above the struct definition.

PhilippGackstatter · 2025-01-09T09:41:54Z

objects/src/block/header.rs

+    /// The epoch of a block can be obtained by shifting the block number to the right by this
+    /// exponent.
+    pub const EPOCH_LENGTH_EXPONENT: u8 = 16;


Suggested change

/// The epoch of a block can be obtained by shifting the block number to the right by this

/// exponent.

pub const EPOCH_LENGTH_EXPONENT: u8 = 16;

/// The length of an epoch expressed as a power of two. `2^(EPOCH_LENGTH_EXPONENT)` is the

/// number of blocks in an epoch.

///

/// The epoch of a block can be obtained by shifting the block number to the right by this

/// exponent.

pub const EPOCH_LENGTH_EXPONENT: u8 = 16;

The docs were moved incompletely. Can you remove them from the impl BlockHeader block and move them here?

PhilippGackstatter · 2025-01-09T09:44:09Z

objects/src/block/header.rs

+
+    pub const fn from_epoch(epoch: u16) -> BlockNumber {
+        BlockNumber((epoch as u32) << BlockNumber::EPOCH_LENGTH_EXPONENT)
+    }


Suggested change

pub const fn from_epoch(epoch: u16) -> BlockNumber {

BlockNumber((epoch as u32) << BlockNumber::EPOCH_LENGTH_EXPONENT)

}

/// Creates the [`BlockNumber`] corresponding to the epoch block for the provided `epoch`.

pub const fn from_epoch(epoch: u16) -> BlockNumber {

BlockNumber((epoch as u32) << BlockNumber::EPOCH_LENGTH_EXPONENT)

}

Public methods should be documented.

PhilippGackstatter · 2025-01-09T09:44:52Z

objects/src/block/header.rs

+    pub const fn block_epoch(&self) -> u16 {
+        (self.0 >> BlockNumber::EPOCH_LENGTH_EXPONENT) as u16
+    }


Suggested change

pub const fn block_epoch(&self) -> u16 {

(self.0 >> BlockNumber::EPOCH_LENGTH_EXPONENT) as u16

}

/// Returns the epoch to which this block number belongs.

pub const fn block_epoch(&self) -> u16 {

(self.0 >> BlockNumber::EPOCH_LENGTH_EXPONENT) as u16

}

Public methods should be documented.

PhilippGackstatter · 2025-01-09T09:45:15Z

objects/src/block/header.rs

+    pub fn as_u32(&self) -> u32 {
+        self.0
+    }


Suggested change

pub fn as_u32(&self) -> u32 {

self.0

}

/// Returns the block number as a `u32`.

pub fn as_u32(&self) -> u32 {

self.0

}

Public methods should be documented.

PhilippGackstatter · 2025-01-09T09:50:57Z

objects/src/transaction/chain_mmr.rs

+                return Err(ChainMmrError::block_num_too_big(
+                    chain_length,
+                    block.block_num().as_u32(),


Pretty much everywhere we used a u32 before to represent a block number we can now use BlockNumber, so also in ChainMmrError. Could you update those as well?

PhilippGackstatter · 2025-01-09T09:51:57Z

objects/src/transaction/chain_mmr.rs

    pub fn contains_block(&self, block_num: u32) -> bool {
-        self.blocks.contains_key(&block_num)
+        self.blocks.contains_key(&block_num.into())
    }

    /// Returns the block header for the specified block, or None if the block is not present in
    /// this chain MMR.
    pub fn get_block(&self, block_num: u32) -> Option<&BlockHeader> {
-        self.blocks.get(&block_num)
+        self.blocks.get(&block_num.into())
    }


I think these can also take BlockNumber now instead of u32.

PhilippGackstatter · 2025-01-09T09:58:03Z

objects/src/accounts/account_id_anchor.rs

+    pub fn new(
+        anchor_block_number: BlockNumber,


Suggested change

pub fn new(

anchor_block_number: BlockNumber,

pub fn new(

anchor_block_number: impl Into<BlockNumber>,

Just realized we could make this nicer by doing this.
That way we can pass both BlockNumber and u32 to this function.

You can just add a line let anchor_block_number = anchor_block_number.into() as the first line in this function to make the conversion.

PhilippGackstatter · 2025-01-09T09:59:40Z

objects/src/notes/location.rs

+    pub fn block_num(&self) -> BlockNumber {
+        self.block_num.into()


I think you can change the block_num field in NoteLocation directly to a BlockNumber, then we don't have to convert here.

…truct

bobbinth requested a review from PhilippGackstatter January 6, 2025 08:14

PhilippGackstatter reviewed Jan 7, 2025

View reviewed changes

varun-doshi force-pushed the varun/blocknumber-struct branch from 0b1e3ab to 0358d5d Compare January 8, 2025 17:35

varun-doshi requested a review from PhilippGackstatter January 8, 2025 17:36

PhilippGackstatter reviewed Jan 9, 2025

View reviewed changes

varun-doshi added 4 commits January 9, 2025 22:44

added BlockNumber type

dd82316

resolved comments

13a4d3d

resolved comments

8fa6ac3

Merge remote-tracking branch 'upstream/next' into varun/blocknumber-s…

e43148c

…truct

varun-doshi force-pushed the varun/blocknumber-struct branch from 0358d5d to e43148c Compare January 10, 2025 18:57

varun-doshi requested a review from PhilippGackstatter January 11, 2025 05:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added BlockNumber struct #1043

feat: added BlockNumber struct #1043

varun-doshi commented Dec 31, 2024

varun-doshi commented Dec 31, 2024

PhilippGackstatter left a comment

PhilippGackstatter left a comment •

edited

Loading

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

PhilippGackstatter Jan 9, 2025

	/// Returns the block number of the epoch block for the given `epoch`.
	pub const fn block_num_from_epoch(epoch: u16) -> u32 {
	(epoch as u32) << BlockHeader::EPOCH_LENGTH_EXPONENT
	}

	/// Returns the epoch of the given block number.
	pub const fn block_epoch_from_number(block_number: u32) -> u16 {
	(block_number >> BlockHeader::EPOCH_LENGTH_EXPONENT) as u16
	}

		pub fn block_num(&self) -> BlockNumber {
		self.block_num.into()

feat: added BlockNumber struct #1043

Are you sure you want to change the base?

feat: added BlockNumber struct #1043

Conversation

varun-doshi commented Dec 31, 2024

varun-doshi commented Dec 31, 2024

PhilippGackstatter left a comment

Choose a reason for hiding this comment

PhilippGackstatter left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PhilippGackstatter left a comment •

edited

Loading