Struct BRIDGE_CONTRACTInstance

pub struct BRIDGE_CONTRACTInstance<T, P, N = Ethereum> {
    address: Address,
    provider: P,
    _network_transport: PhantomData<(N, T)>,
}

A BRIDGE_CONTRACT instance.

Contains type-safe methods for interacting with an on-chain instance of the BRIDGE_CONTRACT contract located at a given address, using a given provider P.

If the contract bytecode is available (see the sol! documentation on how to provide it), the deploy and deploy_builder methods can be used to deploy a new instance of the contract.

See the module-level documentation for all the available methods.

Fields

address: Address

provider: P

_network_transport: PhantomData<(N, T)>

Implementations

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> BRIDGE_CONTRACTInstance<T, P, N>

Instantiation and getters/setters.

pub const fn new(address: Address, provider: P) -> Self

Creates a new wrapper around an on-chain BRIDGE_CONTRACT contract instance.

See the wrapper’s documentation for more details.

pub async fn deploy(provider: P) -> Result<BRIDGE_CONTRACTInstance<T, P, N>>

Deploys this contract using the given provider and constructor arguments, if any.

Returns a new instance of the contract, if the deployment was successful.

For more fine-grained control over the deployment process, use deploy_builder instead.

pub fn deploy_builder(provider: P) -> RawCallBuilder<T, P, N>

Creates a RawCallBuilder for deploying this contract using the given provider and constructor arguments, if any.

This is a simple wrapper around creating a RawCallBuilder with the data set to the bytecode concatenated with the constructor’s ABI-encoded arguments.

pub const fn address(&self) -> &Address

Returns a reference to the address.

pub fn set_address(&mut self, address: Address)

Sets the address.

pub fn at(self, address: Address) -> Self

Sets the address and returns self.

pub const fn provider(&self) -> &P

Returns a reference to the provider.

impl<T, P: Clone, N> BRIDGE_CONTRACTInstance<T, &P, N>

pub fn with_cloned_provider(self) -> BRIDGE_CONTRACTInstance<T, P, N>

Clones the provider and returns a new instance with the cloned provider.

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> BRIDGE_CONTRACTInstance<T, P, N>

Function calls.

pub fn call_builder<C: SolCall>(&self, call: &C) -> SolCallBuilder<T, &P, C, N>

Creates a new call builder using this contract instance’s provider and address.

Note that the call can be any function call, not just those defined in this contract. Prefer using the other methods for building type-safe contract calls.

pub fn CODESEP_POS(&self) -> SolCallBuilder<T, &P, CODESEP_POSCall, N>

Creates a new call builder for the [CODESEP_POS] function.

pub fn EPOCH(&self) -> SolCallBuilder<T, &P, EPOCHCall, N>

Creates a new call builder for the [EPOCH] function.

pub fn INPUT_INDEX(&self) -> SolCallBuilder<T, &P, INPUT_INDEXCall, N>

Creates a new call builder for the [INPUT_INDEX] function.

pub fn KEY_VERSION(&self) -> SolCallBuilder<T, &P, KEY_VERSIONCall, N>

Creates a new call builder for the [KEY_VERSION] function.

pub fn LIGHT_CLIENT(&self) -> SolCallBuilder<T, &P, LIGHT_CLIENTCall, N>

Creates a new call builder for the [LIGHT_CLIENT] function.

pub fn SCHNORR_VERIFIER_PRECOMPILE( &self, ) -> SolCallBuilder<T, &P, SCHNORR_VERIFIER_PRECOMPILECall, N>

Creates a new call builder for the [SCHNORR_VERIFIER_PRECOMPILE] function.

pub fn SIGHASH_ALL_HASH_TYPE( &self, ) -> SolCallBuilder<T, &P, SIGHASH_ALL_HASH_TYPECall, N>

Creates a new call builder for the [SIGHASH_ALL_HASH_TYPE] function.

pub fn SIGHASH_SINGLE_ANYONECANPAY_HASH_TYPE( &self, ) -> SolCallBuilder<T, &P, SIGHASH_SINGLE_ANYONECANPAY_HASH_TYPECall, N>

Creates a new call builder for the [SIGHASH_SINGLE_ANYONECANPAY_HASH_TYPE] function.

pub fn SPEND_TYPE_EXT(&self) -> SolCallBuilder<T, &P, SPEND_TYPE_EXTCall, N>

Creates a new call builder for the [SPEND_TYPE_EXT] function.

pub fn SPEND_TYPE_NO_EXT( &self, ) -> SolCallBuilder<T, &P, SPEND_TYPE_NO_EXTCall, N>

Creates a new call builder for the [SPEND_TYPE_NO_EXT] function.

pub fn SYSTEM_CALLER(&self) -> SolCallBuilder<T, &P, SYSTEM_CALLERCall, N>

Creates a new call builder for the [SYSTEM_CALLER] function.

pub fn acceptOwnership(&self) -> SolCallBuilder<T, &P, acceptOwnershipCall, N>

Creates a new call builder for the [acceptOwnership] function.

pub fn batchWithdraw( &self, txIds: Vec<FixedBytes<32>>, outputIds: Vec<FixedBytes<4>>, ) -> SolCallBuilder<T, &P, batchWithdrawCall, N>

Creates a new call builder for the [batchWithdraw] function.

pub fn deposit( &self, moveTx: <Transaction as SolType>::RustType, proof: <MerkleProof as SolType>::RustType, shaScriptPubkeys: FixedBytes<32>, ) -> SolCallBuilder<T, &P, depositCall, N>

Creates a new call builder for the [deposit] function.

pub fn depositAmount(&self) -> SolCallBuilder<T, &P, depositAmountCall, N>

Creates a new call builder for the [depositAmount] function.

pub fn depositPrefix(&self) -> SolCallBuilder<T, &P, depositPrefixCall, N>

Creates a new call builder for the [depositPrefix] function.

pub fn depositSuffix(&self) -> SolCallBuilder<T, &P, depositSuffixCall, N>

Creates a new call builder for the [depositSuffix] function.

pub fn depositTxIds( &self, _0: U256, ) -> SolCallBuilder<T, &P, depositTxIdsCall, N>

Creates a new call builder for the [depositTxIds] function.

pub fn failedDepositVault( &self, ) -> SolCallBuilder<T, &P, failedDepositVaultCall, N>

Creates a new call builder for the [failedDepositVault] function.

pub fn getAggregatedKey(&self) -> SolCallBuilder<T, &P, getAggregatedKeyCall, N>

Creates a new call builder for the [getAggregatedKey] function.

pub fn getWithdrawalCount( &self, ) -> SolCallBuilder<T, &P, getWithdrawalCountCall, N>

Creates a new call builder for the [getWithdrawalCount] function.

pub fn initialize( &self, _depositPrefix: Bytes, _depositSuffix: Bytes, _depositAmount: U256, ) -> SolCallBuilder<T, &P, initializeCall, N>

Creates a new call builder for the [initialize] function.

pub fn initialized(&self) -> SolCallBuilder<T, &P, initializedCall, N>

Creates a new call builder for the [initialized] function.

pub fn operator(&self) -> SolCallBuilder<T, &P, operatorCall, N>

Creates a new call builder for the [operator] function.

pub fn owner(&self) -> SolCallBuilder<T, &P, ownerCall, N>

Creates a new call builder for the [owner] function.

pub fn pendingOwner(&self) -> SolCallBuilder<T, &P, pendingOwnerCall, N>

Creates a new call builder for the [pendingOwner] function.

pub fn processedTxIds( &self, _0: FixedBytes<32>, ) -> SolCallBuilder<T, &P, processedTxIdsCall, N>

Creates a new call builder for the [processedTxIds] function.

pub fn renounceOwnership( &self, ) -> SolCallBuilder<T, &P, renounceOwnershipCall, N>

Creates a new call builder for the [renounceOwnership] function.

pub fn replaceDeposit( &self, replaceTx: <Transaction as SolType>::RustType, proof: <MerkleProof as SolType>::RustType, idToReplace: U256, shaScriptPubkeys: FixedBytes<32>, ) -> SolCallBuilder<T, &P, replaceDepositCall, N>

Creates a new call builder for the [replaceDeposit] function.

pub fn replacePrefix(&self) -> SolCallBuilder<T, &P, replacePrefixCall, N>

Creates a new call builder for the [replacePrefix] function.

pub fn replaceSuffix(&self) -> SolCallBuilder<T, &P, replaceSuffixCall, N>

Creates a new call builder for the [replaceSuffix] function.

pub fn safeWithdraw( &self, prepareTx: <Transaction as SolType>::RustType, prepareProof: <MerkleProof as SolType>::RustType, payoutTx: <Transaction as SolType>::RustType, blockHeader: Bytes, scriptPubKey: Bytes, ) -> SolCallBuilder<T, &P, safeWithdrawCall, N>

Creates a new call builder for the [safeWithdraw] function.

pub fn setDepositScript( &self, _depositPrefix: Bytes, _depositSuffix: Bytes, ) -> SolCallBuilder<T, &P, setDepositScriptCall, N>

Creates a new call builder for the [setDepositScript] function.

pub fn setFailedDepositVault( &self, _failedDepositVault: Address, ) -> SolCallBuilder<T, &P, setFailedDepositVaultCall, N>

Creates a new call builder for the [setFailedDepositVault] function.

pub fn setOperator( &self, _operator: Address, ) -> SolCallBuilder<T, &P, setOperatorCall, N>

Creates a new call builder for the [setOperator] function.

pub fn setReplaceScript( &self, _replacePrefix: Bytes, _replaceSuffix: Bytes, ) -> SolCallBuilder<T, &P, setReplaceScriptCall, N>

Creates a new call builder for the [setReplaceScript] function.

pub fn transferOwnership( &self, newOwner: Address, ) -> SolCallBuilder<T, &P, transferOwnershipCall, N>

Creates a new call builder for the [transferOwnership] function.

pub fn withdraw( &self, txId: FixedBytes<32>, outputId: FixedBytes<4>, ) -> SolCallBuilder<T, &P, withdrawCall, N>

Creates a new call builder for the [withdraw] function.

pub fn withdrawalUTXOs( &self, _0: U256, ) -> SolCallBuilder<T, &P, withdrawalUTXOsCall, N>

Creates a new call builder for the [withdrawalUTXOs] function.

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> BRIDGE_CONTRACTInstance<T, P, N>

Event filters.

pub fn event_filter<E: SolEvent>(&self) -> Event<T, &P, E, N>

Creates a new event filter using this contract instance’s provider and address.

Note that the type can be any event, not just those defined in this contract. Prefer using the other methods for building type-safe event filters.

pub fn Deposit_filter(&self) -> Event<T, &P, Deposit, N>

Creates a new event filter for the Deposit event.

pub fn DepositReplaced_filter(&self) -> Event<T, &P, DepositReplaced, N>

Creates a new event filter for the DepositReplaced event.

pub fn DepositScriptUpdate_filter(&self) -> Event<T, &P, DepositScriptUpdate, N>

Creates a new event filter for the DepositScriptUpdate event.

pub fn DepositTransferFailed_filter( &self, ) -> Event<T, &P, DepositTransferFailed, N>

Creates a new event filter for the DepositTransferFailed event.

pub fn FailedDepositVaultUpdated_filter( &self, ) -> Event<T, &P, FailedDepositVaultUpdated, N>

Creates a new event filter for the FailedDepositVaultUpdated event.

pub fn Initialized_filter(&self) -> Event<T, &P, Initialized, N>

Creates a new event filter for the Initialized event.

pub fn OperatorUpdated_filter(&self) -> Event<T, &P, OperatorUpdated, N>

Creates a new event filter for the OperatorUpdated event.

pub fn OwnershipTransferStarted_filter( &self, ) -> Event<T, &P, OwnershipTransferStarted, N>

Creates a new event filter for the OwnershipTransferStarted event.

pub fn OwnershipTransferred_filter( &self, ) -> Event<T, &P, OwnershipTransferred, N>

Creates a new event filter for the OwnershipTransferred event.

pub fn ReplaceScriptUpdate_filter(&self) -> Event<T, &P, ReplaceScriptUpdate, N>

Creates a new event filter for the ReplaceScriptUpdate event.

pub fn SafeWithdrawal_filter(&self) -> Event<T, &P, SafeWithdrawal, N>

Creates a new event filter for the SafeWithdrawal event.

pub fn Withdrawal_filter(&self) -> Event<T, &P, Withdrawal, N>

Creates a new event filter for the Withdrawal event.

Trait Implementations

impl<T: Clone, P: Clone, N: Clone> Clone for BRIDGE_CONTRACTInstance<T, P, N>

fn clone(&self) -> BRIDGE_CONTRACTInstance<T, P, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, P, N> Debug for BRIDGE_CONTRACTInstance<T, P, N>

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

Formats the value using the given formatter.