-
Notifications
You must be signed in to change notification settings - Fork 107
feat: add getLeafValue procedure
#2262
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 33 commits
Commits
Show all changes
35 commits
Select commit
Hold shift + click to select a range
46143c8
feat: add Solidity<>Miden address type conversion functions
partylikeits1983 3c84da6
fix: formatting
partylikeits1983 c71d9df
refactor: rm unnecessary indirection
partylikeits1983 779ab24
refactor: use crypto util functions
partylikeits1983 a8238b6
refactor: implement suggestions & refactor
partylikeits1983 5dd9c85
refactor: update logic & comments to little endian
partylikeits1983 99bcee7
Update crates/miden-agglayer/src/utils.rs
partylikeits1983 2d0a89a
refactor: improve EthAddress representation clarity and MASM alignment
partylikeits1983 3d45e7f
refactor: simplify ethereum_address_to_account_id proc
partylikeits1983 43cbcf3
fix: clippy
partylikeits1983 049e8be
fix: lint doc check
partylikeits1983 99161e3
refactor: use u32assert2
partylikeits1983 3dc29f6
refactor: simplify from_account_id() & u32 check
partylikeits1983 4c6289d
revert: undo drop addr4 in ethereum_address_to_account_id
partylikeits1983 a5f3309
Merge branch 'ajl-solidity-type-conversions' into ajl-agglayer-get-le…
partylikeits1983 576f907
feat: init getLeafValue() test
partylikeits1983 a8e35d3
feat: implement AdviceMap key based getLeafValue procedure
partylikeits1983 a1a1c3d
Update crates/miden-agglayer/src/eth_address.rs
partylikeits1983 359b3ef
refactor: update test name
partylikeits1983 1264d24
refactor: rename to EthAddressFormat
partylikeits1983 2288c0d
refactor: rearrange EthAddressFormat
partylikeits1983 d9c309a
refactor: rename file to eth_address_format
partylikeits1983 393ee03
Merge branch 'agglayer' into ajl-solidity-type-conversions
partylikeits1983 3c3c29e
fix: update script roots
partylikeits1983 a926316
Merge branch 'ajl-solidity-type-conversions' into ajl-agglayer-get-le…
mmagician af29827
chore: pipe words to memory
mmagician d6b9954
refactor: add stack comments
partylikeits1983 f9f2d57
chore: pipe words to memory instead of manual `adv_loadw`
partylikeits1983 d61f836
refactor: deduplicate execute_program_with_default_host
partylikeits1983 d51bed1
feat: add hardcoded expected hash to test
partylikeits1983 1388770
fix: verify hash matches commitment
mmagician f200752
fix: put data under correct key in advice map
mmagician 8ebdc7b
chore: merge agglayer
partylikeits1983 1567d89
fix: rm redundant file
partylikeits1983 c1aec4d
Merge branch 'agglayer' into ajl-agglayer-get-leaf-value
partylikeits1983 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -157,4 +157,3 @@ pub proc bridge_out | |
| exec.create_burn_note | ||
| # => [] | ||
| end | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
partylikeits1983 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| use alloc::format; | ||
| use alloc::string::{String, ToString}; | ||
| use core::fmt; | ||
|
|
||
| use miden_core::FieldElement; | ||
| use miden_protocol::Felt; | ||
| use miden_protocol::account::AccountId; | ||
| use miden_protocol::utils::{HexParseError, bytes_to_hex_string, hex_to_bytes}; | ||
|
|
||
| #[derive(Debug, Clone, PartialEq, Eq)] | ||
| pub enum AddrConvError { | ||
| NonZeroWordPadding, | ||
| NonZeroBytePrefix, | ||
| InvalidHexLength, | ||
| InvalidHexChar(char), | ||
| HexParseError, | ||
| FeltOutOfField, | ||
| InvalidAccountId, | ||
| } | ||
|
|
||
| impl fmt::Display for AddrConvError { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| match self { | ||
| AddrConvError::NonZeroWordPadding => write!(f, "non-zero word padding"), | ||
| AddrConvError::NonZeroBytePrefix => write!(f, "address has non-zero 4-byte prefix"), | ||
| AddrConvError::InvalidHexLength => { | ||
| write!(f, "invalid hex length (expected 40 hex chars)") | ||
| }, | ||
| AddrConvError::InvalidHexChar(c) => write!(f, "invalid hex character: {}", c), | ||
| AddrConvError::HexParseError => write!(f, "hex parse error"), | ||
| AddrConvError::FeltOutOfField => { | ||
| write!(f, "packed 64-bit word does not fit in the field") | ||
| }, | ||
| AddrConvError::InvalidAccountId => write!(f, "invalid AccountId"), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl From<HexParseError> for AddrConvError { | ||
| fn from(_err: HexParseError) -> Self { | ||
| AddrConvError::HexParseError | ||
| } | ||
| } | ||
|
|
||
| // ================================================================================================ | ||
| // ETHEREUM ADDRESS | ||
| // ================================================================================================ | ||
|
|
||
| /// Represents an Ethereum address format (20 bytes). | ||
| /// | ||
| /// # Representations used in this module | ||
| /// | ||
| /// - Raw bytes: `[u8; 20]` in the conventional Ethereum big-endian byte order (`bytes[0]` is the | ||
| /// most-significant byte). | ||
| /// - MASM "address\[5\]" limbs: 5 x u32 limbs in *little-endian limb order*: | ||
| /// - addr0 = bytes[16..19] (least-significant 4 bytes) | ||
| /// - addr1 = bytes[12..15] | ||
| /// - addr2 = bytes[ 8..11] | ||
| /// - addr3 = bytes[ 4.. 7] | ||
| /// - addr4 = bytes[ 0.. 3] (most-significant 4 bytes) | ||
| /// - Embedded AccountId format: `0x00000000 || prefix(8) || suffix(8)`, where: | ||
| /// - prefix = (addr3 << 32) | addr2 = bytes[4..11] as a big-endian u64 | ||
| /// - suffix = (addr1 << 32) | addr0 = bytes[12..19] as a big-endian u64 | ||
| /// | ||
| /// Note: prefix/suffix are *conceptual* 64-bit words; when converting to [`Felt`], we must ensure | ||
| /// `Felt::new(u64)` does not reduce mod p (checked explicitly in `to_account_id`). | ||
| #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
| pub struct EthAddressFormat([u8; 20]); | ||
|
|
||
| impl EthAddressFormat { | ||
| // EXTERNAL API - For integrators (Gateway, claim managers, etc.) | ||
| // -------------------------------------------------------------------------------------------- | ||
|
|
||
| /// Creates a new [`EthAddressFormat`] from a 20-byte array. | ||
| pub const fn new(bytes: [u8; 20]) -> Self { | ||
| Self(bytes) | ||
| } | ||
|
|
||
| /// Creates an [`EthAddressFormat`] from a hex string (with or without "0x" prefix). | ||
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns an error if the hex string is invalid or the hex part is not exactly 40 characters. | ||
| pub fn from_hex(hex_str: &str) -> Result<Self, AddrConvError> { | ||
| let hex_part = hex_str.strip_prefix("0x").unwrap_or(hex_str); | ||
| if hex_part.len() != 40 { | ||
| return Err(AddrConvError::InvalidHexLength); | ||
| } | ||
|
|
||
| let prefixed_hex = if hex_str.starts_with("0x") { | ||
| hex_str.to_string() | ||
| } else { | ||
| format!("0x{}", hex_str) | ||
| }; | ||
|
|
||
| let bytes: [u8; 20] = hex_to_bytes(&prefixed_hex)?; | ||
| Ok(Self(bytes)) | ||
| } | ||
|
|
||
| /// Creates an [`EthAddressFormat`] from an [`AccountId`]. | ||
| /// | ||
| /// **External API**: This function is used by integrators (Gateway, claim managers) to convert | ||
| /// Miden AccountIds into the Ethereum address format for constructing CLAIM notes or | ||
| /// interfacing when calling the Agglayer Bridge function bridgeAsset(). | ||
| /// | ||
| /// This conversion is infallible: an [`AccountId`] is two felts, and `as_int()` yields `u64` | ||
| /// words which we embed as `0x00000000 || prefix(8) || suffix(8)` (big-endian words). | ||
| /// | ||
| /// # Example | ||
| /// ```ignore | ||
| /// let destination_address = EthAddressFormat::from_account_id(destination_account_id).into_bytes(); | ||
| /// // then construct the CLAIM note with destination_address... | ||
| /// ``` | ||
| pub fn from_account_id(account_id: AccountId) -> Self { | ||
| let felts: [Felt; 2] = account_id.into(); | ||
|
|
||
| let mut out = [0u8; 20]; | ||
| out[4..12].copy_from_slice(&felts[0].as_int().to_be_bytes()); | ||
| out[12..20].copy_from_slice(&felts[1].as_int().to_be_bytes()); | ||
|
|
||
| Self(out) | ||
| } | ||
|
|
||
| /// Returns the raw 20-byte array. | ||
| pub const fn as_bytes(&self) -> &[u8; 20] { | ||
| &self.0 | ||
| } | ||
|
|
||
| /// Converts the address into a 20-byte array. | ||
| pub const fn into_bytes(self) -> [u8; 20] { | ||
| self.0 | ||
| } | ||
|
|
||
| /// Converts the Ethereum address to a hex string (lowercase, 0x-prefixed). | ||
| pub fn to_hex(&self) -> String { | ||
| bytes_to_hex_string(self.0) | ||
| } | ||
|
|
||
| // INTERNAL API - For CLAIM note processing | ||
| // -------------------------------------------------------------------------------------------- | ||
|
|
||
| /// Converts the Ethereum address format into an array of 5 [`Felt`] values for MASM processing. | ||
| /// | ||
| /// **Internal API**: This function is used internally during CLAIM note processing to convert | ||
| /// the address format into the MASM `address[5]` representation expected by the | ||
| /// `ethereum_address_format_to_account_id` procedure. | ||
| /// | ||
| /// The returned order matches the MASM `address\[5\]` convention (*little-endian limb order*): | ||
| /// - addr0 = bytes[16..19] (least-significant 4 bytes) | ||
| /// - addr1 = bytes[12..15] | ||
| /// - addr2 = bytes[ 8..11] | ||
| /// - addr3 = bytes[ 4.. 7] | ||
| /// - addr4 = bytes[ 0.. 3] (most-significant 4 bytes) | ||
| /// | ||
| /// Each limb is interpreted as a big-endian `u32` and stored in a [`Felt`]. | ||
| pub fn to_elements(&self) -> [Felt; 5] { | ||
| let mut result = [Felt::ZERO; 5]; | ||
|
|
||
| // i=0 -> bytes[16..20], i=4 -> bytes[0..4] | ||
| for (i, felt) in result.iter_mut().enumerate() { | ||
| let start = (4 - i) * 4; | ||
| let chunk = &self.0[start..start + 4]; | ||
| let value = u32::from_be_bytes([chunk[0], chunk[1], chunk[2], chunk[3]]); | ||
| *felt = Felt::new(value as u64); | ||
| } | ||
|
|
||
| result | ||
| } | ||
|
|
||
| /// Converts the Ethereum address format back to an [`AccountId`]. | ||
| /// | ||
| /// **Internal API**: This function is used internally during CLAIM note processing to extract | ||
| /// the original AccountId from the Ethereum address format. It mirrors the functionality of | ||
| /// the MASM `ethereum_address_format_to_account_id` procedure. | ||
| /// | ||
| /// # Errors | ||
| /// | ||
| /// Returns an error if: | ||
| /// - the first 4 bytes are not zero (not in the embedded AccountId format), | ||
| /// - packing the 8-byte prefix/suffix into [`Felt`] would reduce mod p, | ||
| /// - or the resulting felts do not form a valid [`AccountId`]. | ||
| pub fn to_account_id(&self) -> Result<AccountId, AddrConvError> { | ||
| let (prefix, suffix) = Self::bytes20_to_prefix_suffix(self.0)?; | ||
|
|
||
| // `Felt::new(u64)` may reduce mod p for some u64 values. Mirror the MASM `build_felt` | ||
| // safety: construct the felt, then require round-trip equality. | ||
| let prefix_felt = Felt::new(prefix); | ||
| if prefix_felt.as_int() != prefix { | ||
| return Err(AddrConvError::FeltOutOfField); | ||
| } | ||
|
|
||
| let suffix_felt = Felt::new(suffix); | ||
| if suffix_felt.as_int() != suffix { | ||
| return Err(AddrConvError::FeltOutOfField); | ||
| } | ||
|
|
||
| AccountId::try_from([prefix_felt, suffix_felt]).map_err(|_| AddrConvError::InvalidAccountId) | ||
| } | ||
|
|
||
| // HELPER FUNCTIONS | ||
| // -------------------------------------------------------------------------------------------- | ||
|
|
||
| /// Convert `[u8; 20]` -> `(prefix, suffix)` by extracting the last 16 bytes. | ||
| /// Requires the first 4 bytes be zero. | ||
| /// Returns prefix and suffix values that match the MASM little-endian limb implementation: | ||
| /// - prefix = bytes[4..12] as big-endian u64 = (addr3 << 32) | addr2 | ||
| /// - suffix = bytes[12..20] as big-endian u64 = (addr1 << 32) | addr0 | ||
| fn bytes20_to_prefix_suffix(bytes: [u8; 20]) -> Result<(u64, u64), AddrConvError> { | ||
| if bytes[0..4] != [0, 0, 0, 0] { | ||
| return Err(AddrConvError::NonZeroBytePrefix); | ||
| } | ||
|
|
||
| let prefix = u64::from_be_bytes(bytes[4..12].try_into().unwrap()); | ||
| let suffix = u64::from_be_bytes(bytes[12..20].try_into().unwrap()); | ||
|
|
||
| Ok((prefix, suffix)) | ||
| } | ||
| } | ||
|
|
||
| impl fmt::Display for EthAddressFormat { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| write!(f, "{}", self.to_hex()) | ||
| } | ||
| } | ||
|
|
||
| impl From<[u8; 20]> for EthAddressFormat { | ||
| fn from(bytes: [u8; 20]) -> Self { | ||
| Self(bytes) | ||
| } | ||
| } | ||
|
|
||
| impl From<AccountId> for EthAddressFormat { | ||
| fn from(account_id: AccountId) -> Self { | ||
| EthAddressFormat::from_account_id(account_id) | ||
| } | ||
| } | ||
|
|
||
| impl From<EthAddressFormat> for [u8; 20] { | ||
| fn from(addr: EthAddressFormat) -> Self { | ||
| addr.0 | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: might have been good to explain somewhere (briefly) that
LFEAF_VALUEis just a sequential hash ofLEAF_DATAusing `Keccak hash function.