Module agglayer 

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

agglayer_note

b2agg_note

Bridge Out note creation utilities.

bridge

claim_note

config_note

CONFIG_AGG_BRIDGE note creation utilities.

costs

Benchmarked consumption costs of the agglayer notes.

deregister_note

DEREGISTER_AGG_FAUCET note creation utilities.

errors

eth_types

faucet

remove_ger_note

REMOVE_GER note creation utilities.

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.

BridgeRoles

The accounts that initially hold each of the bridge’s privileged RBAC roles.

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.

DeregisterAggFaucetNote

DEREGISTER_AGG_FAUCET note.

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.

RemoveGerNote

REMOVE_GER note.

UpdateGerNote

UPDATE_GER note.

Enums

AddressConversionError

Error type for Ethereum address conversions.

AgglayerBridgeError

AggLayer Bridge related errors.

AgglayerFaucetError

AggLayer Faucet related errors.

AgglayerNote

The enum holding the types of notes provided by miden-agglayer, mirroring StandardNote.

EthAmountError

Error type for Ethereum amount conversions.

GlobalIndexError

Error type for GlobalIndex validation.

Functions

agglayer_package

Returns the AggLayer package containing all agglayer modules, including the note scripts.

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)

RemovedGerHashChain

Removed-GER hash chain representation (32-byte Keccak256 hash)

SmtNode

SMT node representation (32-byte Keccak256 hash)