Struct CitreaClient

pub struct CitreaClient {
    pub client: HttpClient,
    pub light_client_prover_client: HttpClient,
    pub wallet_address: Address,
    pub contract: BRIDGE_CONTRACTInstance<(), FillProvider<JoinFill<JoinFill<Identity, JoinFill<GasFiller, JoinFill<BlobGasFiller, JoinFill<NonceFiller, ChainIdFiller>>>>, WalletFiller<EthereumWallet>>, RootProvider>>,
}

Citrea client is responsible for interacting with the Citrea EVM and Citrea RPC.

Fields

client: HttpClient

light_client_prover_client: HttpClient

wallet_address: Address

contract: BRIDGE_CONTRACTInstance<(), FillProvider<JoinFill<JoinFill<Identity, JoinFill<GasFiller, JoinFill<BlobGasFiller, JoinFill<NonceFiller, ChainIdFiller>>>>, WalletFiller<EthereumWallet>>, RootProvider>>

Trait Implementations

impl CitreaClientT for CitreaClient

fn get_storage_proof<'life0, 'async_trait>( &'life0 self, l2_height: u64, deposit_index: u32, ) -> Pin<Box<dyn Future<Output = Result<StorageProof, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches the storage proof for a given deposit index and transaction ID.

This function interacts with an Citrea RPC endpoint to retrieve a storage proof, which includes proof details for both the UTXO and the deposit index.

Arguments

• l2_height - A u64 representing the L2 block height.
• deposit_index - A u32 representing the deposit index.

Returns

Returns a StorageProof struct containing serialized storage proofs for the UTXO and deposit index.

fn new<'async_trait>( citrea_rpc_url: String, light_client_prover_url: String, chain_id: u32, secret_key: Option<PrivateKeySigner>, ) -> Pin<Box<dyn Future<Output = Result<Self, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait,

Parameters

fn withdrawal_utxos<'life0, 'async_trait>( &'life0 self, withdrawal_index: u64, ) -> Pin<Box<dyn Future<Output = Result<OutPoint, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetches an UTXO from Citrea for the given withdrawal index.

fn collect_deposit_move_txids<'life0, 'async_trait>( &'life0 self, last_deposit_idx: Option<u32>, to_height: u64, ) -> Pin<Box<dyn Future<Output = Result<Vec<(u64, Txid)>, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns deposit move txids, starting from the last deposit index.

fn collect_withdrawal_utxos<'life0, 'async_trait>( &'life0 self, last_withdrawal_idx: Option<u32>, to_height: u64, ) -> Pin<Box<dyn Future<Output = Result<Vec<(u64, OutPoint)>, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns withdrawal utxos, starting from the last withdrawal index.

fn get_light_client_proof<'life0, 'async_trait>( &'life0 self, l1_height: u64, ) -> Pin<Box<dyn Future<Output = Result<Option<(LightClientProof, Receipt, u64)>, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the light client proof and its L2 height for the given L1 block height.

fn get_citrea_l2_height_range<'life0, 'async_trait>( &'life0 self, block_height: u64, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64), BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the L2 block height range for the given L1 block height.

fn get_replacement_deposit_move_txids<'life0, 'async_trait>( &'life0 self, from_height: u64, to_height: u64, ) -> Pin<Box<dyn Future<Output = Result<Vec<(u32, Txid)>, BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the replacement deposit move txids for the given range of blocks.

fn check_nofn_correctness<'life0, 'async_trait>( &'life0 self, nofn_xonly_pk: XOnlyPublicKey, ) -> Pin<Box<dyn Future<Output = Result<(), BridgeError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl Clone for CitreaClient

fn clone(&self) -> CitreaClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CitreaClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.