Skip to main content

Module agglayer

Module agglayer 

Source
Expand description

Re-export the entire miden_client crate so external projects can use a single dependency. Provides AggLayer bridge components, note constructors, and helper types.

Modules§

b2agg_note
Bridge Out note creation utilities.
bridge
claim_note
config_note
CONFIG_AGG_BRIDGE note creation utilities.
errors
eth_types
faucet
update_ger_note
UPDATE_GER note creation utilities.
utils

Structs§

AggLayerBridge
An AccountComponent implementing the AggLayer Bridge.
AggLayerFaucet
An AccountComponent implementing the AggLayer Faucet.
B2AggNote
B2AGG (Bridge to AggLayer) note.
ClaimNote
CLAIM (Bridge from AggLayer) note.
ClaimNoteStorage
Data for creating a CLAIM note.
ConfigAggBridgeNote
CONFIG_AGG_BRIDGE note.
ConversionMetadata
The conversion metadata registered on the bridge for a single faucet.
EthAddress
Represents a plain Ethereum address (20 bytes).
EthAmount
Represents an Ethereum uint256 amount as 8 u32 values.
EthEmbeddedAccountId
Represents a Miden AccountId that can be encoded in the 20-byte Ethereum address format.
Keccak256Output
Keccak256 output representation (32-byte hash)
LeafData
Leaf data for CLAIM note creation. Contains network, address, amount, and metadata using typed representations.
MetadataHash
Represents a Keccak256 metadata hash as 32 bytes.
ProofData
Proof data for CLAIM note creation. Contains SMT proofs and root hashes using typed representations.
UpdateGerNote
UPDATE_GER note.

Enums§

AgglayerBridgeError
AggLayer Bridge related errors.
AgglayerFaucetError
AggLayer Faucet related errors.
EthAmountError
Error type for Ethereum amount conversions.
GlobalIndexError
Error type for GlobalIndex validation.

Functions§

agglayer_library
Returns the AggLayer Library containing all agglayer modules.
create_agglayer_faucet
Creates a new agglayer faucet account with the specified configuration.
create_bridge_account
Creates a new bridge account with the standard configuration.

Type Aliases§

CgiChainHash
Claimed Global Index (CGI) chain hash representation (32-byte Keccak256 hash)
ExitRoot
Exit root representation (32-byte Keccak256 hash)
GlobalIndex
Represents an AggLayer global index as a 256-bit value (32 bytes).
LeafValue
Leaf value representation (32-byte Keccak256 hash)
SmtNode
SMT node representation (32-byte Keccak256 hash)