Struct zenith_types::Zenith::ZenithInstance

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

A Zenith instance.

Contains type-safe methods for interacting with an on-chain instance of the Zenith 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<T: Transport + Clone, P: Provider<T, N>, N: Network> ZenithInstance<T, P, N>

Instantiation and getters/setters.

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

Creates a new wrapper around an on-chain Zenith 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<T, P: Clone, N> ZenithInstance<T, &P, N>

pub fn with_cloned_provider(self) -> ZenithInstance<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> ZenithInstance<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 addSequencer( &self, sequencer: Address, ) -> SolCallBuilder<T, &P, addSequencerCall, N>

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

pub fn blockCommitment( &self, header: <BlockHeader as SolType>::RustType, ) -> SolCallBuilder<T, &P, blockCommitmentCall, N>

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

pub fn defaultRollupChainId( &self, ) -> SolCallBuilder<T, &P, defaultRollupChainIdCall, N>

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

pub fn enter_0( &self, rollupRecipient: Address, ) -> SolCallBuilder<T, &P, enter_0Call, N>

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

pub fn enter_1( &self, rollupChainId: U256, rollupRecipient: Address, ) -> SolCallBuilder<T, &P, enter_1Call, N>

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

pub fn enterTransact( &self, rollupChainId: U256, etherRecipient: Address, to: Address, data: Bytes, value: U256, gas: U256, maxFeePerGas: U256, ) -> SolCallBuilder<T, &P, enterTransactCall, N>

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

pub fn isSequencer( &self, _0: Address, ) -> SolCallBuilder<T, &P, isSequencerCall, N>

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

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

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

pub fn nextSequence( &self, _rollupChainId: U256, ) -> SolCallBuilder<T, &P, nextSequenceCall, N>

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

pub fn removeSequencer( &self, sequencer: Address, ) -> SolCallBuilder<T, &P, removeSequencerCall, N>

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

pub fn sequencerAdmin(&self) -> SolCallBuilder<T, &P, sequencerAdminCall, N>

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

pub fn submitBlock( &self, header: <BlockHeader as SolType>::RustType, v: u8, r: FixedBytes<32>, s: FixedBytes<32>, _4: Bytes, ) -> SolCallBuilder<T, &P, submitBlockCall, N>

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

pub fn transact_0( &self, to: Address, data: Bytes, value: U256, gas: U256, maxFeePerGas: U256, ) -> SolCallBuilder<T, &P, transact_0Call, N>

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

pub fn transact_1( &self, rollupChainId: U256, to: Address, data: Bytes, value: U256, gas: U256, maxFeePerGas: U256, ) -> SolCallBuilder<T, &P, transact_1Call, N>

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

pub fn withdraw( &self, token: Address, recipient: Address, amount: U256, ) -> SolCallBuilder<T, &P, withdrawCall, N>

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

pub fn withdrawalAdmin(&self) -> SolCallBuilder<T, &P, withdrawalAdminCall, N>

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

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> ZenithInstance<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 BlockSubmitted_filter(&self) -> Event<T, &P, BlockSubmitted, N>

Creates a new event filter for the BlockSubmitted event.

pub fn Enter_filter(&self) -> Event<T, &P, Enter, N>

Creates a new event filter for the Enter event.

pub fn SequencerSet_filter(&self) -> Event<T, &P, SequencerSet, N>

Creates a new event filter for the SequencerSet event.

pub fn Transact_filter(&self) -> Event<T, &P, Transact, N>

Creates a new event filter for the Transact 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 ZenithInstance<T, P, N>

fn clone(&self) -> ZenithInstance<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 ZenithInstance<T, P, N>

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

Formats the value using the given formatter.