Skip to main content

MessageTransmitterInstance

Struct MessageTransmitterInstance 

Source
pub struct MessageTransmitterInstance<P, N = Ethereum> { /* private fields */ }
Expand description

A MessageTransmitter instance.

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

Source§

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

Instantiation and getters/setters.

Source

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

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

See the wrapper’s documentation for more details.

Source

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

Returns a reference to the address.

Source

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

Sets the address.

Source

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

Sets the address and returns self.

Source

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

Returns a reference to the provider.

Source§

impl<P: Clone, N> MessageTransmitterInstance<&P, N>

Source

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

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

Source§

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

Function calls.

Source

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.

Source

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

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

Source

pub fn attesterManager(&self) -> SolCallBuilder<&P, attesterManagerCall, N>

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

Source

pub fn disableAttester( &self, attester: Address, ) -> SolCallBuilder<&P, disableAttesterCall, N>

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

Source

pub fn enableAttester( &self, newAttester: Address, ) -> SolCallBuilder<&P, enableAttesterCall, N>

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

Source

pub fn getEnabledAttester( &self, index: U256, ) -> SolCallBuilder<&P, getEnabledAttesterCall, N>

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

Source

pub fn getNumEnabledAttesters( &self, ) -> SolCallBuilder<&P, getNumEnabledAttestersCall, N>

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

Source

pub fn isEnabledAttester( &self, attester: Address, ) -> SolCallBuilder<&P, isEnabledAttesterCall, N>

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

Source

pub fn localDomain(&self) -> SolCallBuilder<&P, localDomainCall, N>

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

Source

pub fn maxMessageBodySize( &self, ) -> SolCallBuilder<&P, maxMessageBodySizeCall, N>

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

Source

pub fn nextAvailableNonce( &self, ) -> SolCallBuilder<&P, nextAvailableNonceCall, N>

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

Source

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

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

Source

pub fn pause(&self) -> SolCallBuilder<&P, pauseCall, N>

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

Source

pub fn paused(&self) -> SolCallBuilder<&P, pausedCall, N>

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

Source

pub fn pauser(&self) -> SolCallBuilder<&P, pauserCall, N>

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

Source

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

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

Source

pub fn receiveMessage( &self, message: Bytes, attestation: Bytes, ) -> SolCallBuilder<&P, receiveMessageCall, N>

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

Source

pub fn replaceMessage( &self, originalMessage: Bytes, originalAttestation: Bytes, newMessageBody: Bytes, newDestinationCaller: FixedBytes<32>, ) -> SolCallBuilder<&P, replaceMessageCall, N>

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

Source

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

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

Source

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

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

Source

pub fn sendMessage( &self, destinationDomain: u32, recipient: FixedBytes<32>, messageBody: Bytes, ) -> SolCallBuilder<&P, sendMessageCall, N>

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

Source

pub fn sendMessageWithCaller( &self, destinationDomain: u32, recipient: FixedBytes<32>, destinationCaller: FixedBytes<32>, messageBody: Bytes, ) -> SolCallBuilder<&P, sendMessageWithCallerCall, N>

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

Source

pub fn setMaxMessageBodySize( &self, newMaxMessageBodySize: U256, ) -> SolCallBuilder<&P, setMaxMessageBodySizeCall, N>

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

Source

pub fn setSignatureThreshold( &self, newSignatureThreshold: U256, ) -> SolCallBuilder<&P, setSignatureThresholdCall, N>

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

Source

pub fn signatureThreshold( &self, ) -> SolCallBuilder<&P, signatureThresholdCall, N>

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

Source

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

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

Source

pub fn unpause(&self) -> SolCallBuilder<&P, unpauseCall, N>

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

Source

pub fn updateAttesterManager( &self, newAttesterManager: Address, ) -> SolCallBuilder<&P, updateAttesterManagerCall, N>

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

Source

pub fn updatePauser( &self, _newPauser: Address, ) -> SolCallBuilder<&P, updatePauserCall, N>

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

Source

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

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

Source

pub fn usedNonces( &self, _0: FixedBytes<32>, ) -> SolCallBuilder<&P, usedNoncesCall, N>

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

Source

pub fn version(&self) -> SolCallBuilder<&P, versionCall, N>

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

Source§

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

Event filters.

Source

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.

Source

pub fn AttesterDisabled_filter(&self) -> Event<&P, AttesterDisabled, N>

Creates a new event filter for the AttesterDisabled event.

Source

pub fn AttesterEnabled_filter(&self) -> Event<&P, AttesterEnabled, N>

Creates a new event filter for the AttesterEnabled event.

Source

pub fn AttesterManagerUpdated_filter( &self, ) -> Event<&P, AttesterManagerUpdated, N>

Creates a new event filter for the AttesterManagerUpdated event.

Source

pub fn MaxMessageBodySizeUpdated_filter( &self, ) -> Event<&P, MaxMessageBodySizeUpdated, N>

Creates a new event filter for the MaxMessageBodySizeUpdated event.

Source

pub fn MessageReceived_filter(&self) -> Event<&P, MessageReceived, N>

Creates a new event filter for the MessageReceived event.

Source

pub fn MessageSent_filter(&self) -> Event<&P, MessageSent, N>

Creates a new event filter for the MessageSent event.

Source

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

Creates a new event filter for the OwnershipTransferStarted event.

Source

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

Creates a new event filter for the OwnershipTransferred event.

Source

pub fn Pause_filter(&self) -> Event<&P, Pause, N>

Creates a new event filter for the Pause event.

Source

pub fn PauserChanged_filter(&self) -> Event<&P, PauserChanged, N>

Creates a new event filter for the PauserChanged event.

Source

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

Creates a new event filter for the RescuerChanged event.

Source

pub fn SignatureThresholdUpdated_filter( &self, ) -> Event<&P, SignatureThresholdUpdated, N>

Creates a new event filter for the SignatureThresholdUpdated event.

Source

pub fn Unpause_filter(&self) -> Event<&P, Unpause, N>

Creates a new event filter for the Unpause event.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<P, N> Freeze for MessageTransmitterInstance<P, N>
where P: Freeze,

§

impl<P, N> RefUnwindSafe for MessageTransmitterInstance<P, N>

§

impl<P, N> Send for MessageTransmitterInstance<P, N>
where P: Send, N: Send,

§

impl<P, N> Sync for MessageTransmitterInstance<P, N>
where P: Sync, N: Sync,

§

impl<P, N> Unpin for MessageTransmitterInstance<P, N>
where P: Unpin, N: Unpin,

§

impl<P, N> UnsafeUnpin for MessageTransmitterInstance<P, N>
where P: UnsafeUnpin,

§

impl<P, N> UnwindSafe for MessageTransmitterInstance<P, N>
where P: UnwindSafe, N: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more