Struct TokenMessengerInstance 

pub struct TokenMessengerInstance<P, N = Ethereum> { /* private fields */ }

A TokenMessenger instance.

Contains type-safe methods for interacting with an on-chain instance of the TokenMessenger 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.

Implementations

impl<P: Provider<N>, N: Network> TokenMessengerInstance<P, N>

Instantiation and getters/setters.

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

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

See the wrapper’s documentation for more details.

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<P: Clone, N> TokenMessengerInstance<&P, N>

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

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

impl<P: Provider<N>, N: Network> TokenMessengerInstance<P, N>

Function calls.

pub fn call_builder<C: SolCall>(&self, call: &C) -> SolCallBuilder<&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 acceptOwnership(&self) -> SolCallBuilder<&P, acceptOwnershipCall, N>

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

pub fn addLocalMinter( &self, newLocalMinter: Address, ) -> SolCallBuilder<&P, addLocalMinterCall, N>

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

pub fn addRemoteTokenMessenger( &self, domain: u32, tokenMessenger: FixedBytes<32>, ) -> SolCallBuilder<&P, addRemoteTokenMessengerCall, N>

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

pub fn depositForBurn( &self, amount: U256, destinationDomain: u32, mintRecipient: FixedBytes<32>, burnToken: Address, ) -> SolCallBuilder<&P, depositForBurnCall, N>

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

pub fn depositForBurnWithCaller( &self, amount: U256, destinationDomain: u32, mintRecipient: FixedBytes<32>, burnToken: Address, destinationCaller: FixedBytes<32>, ) -> SolCallBuilder<&P, depositForBurnWithCallerCall, N>

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

pub fn handleReceiveMessage( &self, remoteDomain: u32, sender: FixedBytes<32>, messageBody: Bytes, ) -> SolCallBuilder<&P, handleReceiveMessageCall, N>

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

pub fn localMessageTransmitter( &self, ) -> SolCallBuilder<&P, localMessageTransmitterCall, N>

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

pub fn localMinter(&self) -> SolCallBuilder<&P, localMinterCall, N>

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

pub fn messageBodyVersion( &self, ) -> SolCallBuilder<&P, messageBodyVersionCall, N>

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

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

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

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

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

pub fn remoteTokenMessengers( &self, _0: u32, ) -> SolCallBuilder<&P, remoteTokenMessengersCall, N>

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

pub fn removeLocalMinter(&self) -> SolCallBuilder<&P, removeLocalMinterCall, N>

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

pub fn removeRemoteTokenMessenger( &self, domain: u32, ) -> SolCallBuilder<&P, removeRemoteTokenMessengerCall, N>

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

pub fn replaceDepositForBurn( &self, originalMessage: Bytes, originalAttestation: Bytes, newDestinationCaller: FixedBytes<32>, newMintRecipient: FixedBytes<32>, ) -> SolCallBuilder<&P, replaceDepositForBurnCall, N>

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

pub fn rescueERC20( &self, tokenContract: Address, to: Address, amount: U256, ) -> SolCallBuilder<&P, rescueERC20Call, N>

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

pub fn rescuer(&self) -> SolCallBuilder<&P, rescuerCall, N>

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

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

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

pub fn updateRescuer( &self, newRescuer: Address, ) -> SolCallBuilder<&P, updateRescuerCall, N>

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

impl<P: Provider<N>, N: Network> TokenMessengerInstance<P, N>

Event filters.

pub fn event_filter<E: SolEvent>(&self) -> Event<&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 DepositForBurn_filter(&self) -> Event<&P, DepositForBurn, N>

Creates a new event filter for the DepositForBurn event.

pub fn LocalMinterAdded_filter(&self) -> Event<&P, LocalMinterAdded, N>

Creates a new event filter for the LocalMinterAdded event.

pub fn LocalMinterRemoved_filter(&self) -> Event<&P, LocalMinterRemoved, N>

Creates a new event filter for the LocalMinterRemoved event.

pub fn MintAndWithdraw_filter(&self) -> Event<&P, MintAndWithdraw, N>

Creates a new event filter for the MintAndWithdraw event.

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

Creates a new event filter for the OwnershipTransferStarted event.

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

Creates a new event filter for the OwnershipTransferred event.

pub fn RemoteTokenMessengerAdded_filter( &self, ) -> Event<&P, RemoteTokenMessengerAdded, N>

Creates a new event filter for the RemoteTokenMessengerAdded event.

pub fn RemoteTokenMessengerRemoved_filter( &self, ) -> Event<&P, RemoteTokenMessengerRemoved, N>

Creates a new event filter for the RemoteTokenMessengerRemoved event.

pub fn RescuerChanged_filter(&self) -> Event<&P, RescuerChanged, N>

Creates a new event filter for the RescuerChanged event.

Trait Implementations

impl<P: Clone, N: Clone> Clone for TokenMessengerInstance<P, N>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, N> Debug for TokenMessengerInstance<P, N>

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

Formats the value using the given formatter.