Struct openzeppelin_rs::IOutbox

pub struct IOutbox<M>(_);

Implementations

impl<M: Middleware> IOutbox<M>

pub fn new<T: Into<Address>>(address: T, client: Arc<M>) -> Self

Creates a new contract instance with the specified ethers client at address. The contract derefs to a ethers::Contract object.

pub fn outbox_version(&self) -> ContractCall<M, u128>

Calls the contract’s OUTBOX_VERSION (0xc75184df) function

pub fn bridge(&self) -> ContractCall<M, Address>

Calls the contract’s bridge (0xe78cea92) function

pub fn calculate_item_hash( &self, l_2_sender: Address, to: Address, l_2_block: U256, l_1_block: U256, l_2_timestamp: U256, value: U256, data: Bytes ) -> ContractCall<M, [u8; 32]>

Calls the contract’s calculateItemHash (0x9f0c04bf) function

pub fn calculate_merkle_root( &self, proof: Vec<[u8; 32]>, path: U256, item: [u8; 32] ) -> ContractCall<M, [u8; 32]>

Calls the contract’s calculateMerkleRoot (0x007436d3) function

pub fn execute_transaction( &self, proof: Vec<[u8; 32]>, index: U256, l_2_sender: Address, to: Address, l_2_block: U256, l_1_block: U256, l_2_timestamp: U256, value: U256, data: Bytes ) -> ContractCall<M, ()>

Calls the contract’s executeTransaction (0x08635a95) function

pub fn execute_transaction_simulation( &self, index: U256, l_2_sender: Address, to: Address, l_2_block: U256, l_1_block: U256, l_2_timestamp: U256, value: U256, data: Bytes ) -> ContractCall<M, ()>

Calls the contract’s executeTransactionSimulation (0x288e5b10) function

pub fn is_spent(&self, index: U256) -> ContractCall<M, bool>

Calls the contract’s isSpent (0x5a129efe) function

pub fn l_2_to_l1_block(&self) -> ContractCall<M, U256>

Calls the contract’s l2ToL1Block (0x46547790) function

pub fn l_2_to_l1_eth_block(&self) -> ContractCall<M, U256>

Calls the contract’s l2ToL1EthBlock (0x8515bc6a) function

pub fn l_2_to_l1_output_id(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s l2ToL1OutputId (0x72f2a8c7) function

pub fn l_2_to_l1_sender(&self) -> ContractCall<M, Address>

Calls the contract’s l2ToL1Sender (0x80648b02) function

pub fn l_2_to_l1_timestamp(&self) -> ContractCall<M, U256>

Calls the contract’s l2ToL1Timestamp (0xb0f30537) function

pub fn rollup(&self) -> ContractCall<M, Address>

Calls the contract’s rollup (0xcb23bcb5) function

pub fn roots(&self, p0: [u8; 32]) -> ContractCall<M, [u8; 32]>

Calls the contract’s roots (0xae6dead7) function

pub fn spent(&self, p0: U256) -> ContractCall<M, [u8; 32]>

Calls the contract’s spent (0xd5b5cc23) function

pub fn update_send_root( &self, send_root: [u8; 32], l_2_block_hash: [u8; 32] ) -> ContractCall<M, ()>

Calls the contract’s updateSendRoot (0xa04cee60) function

pub fn out_box_transaction_executed_filter( &self ) -> Event<Arc<M>, M, OutBoxTransactionExecutedFilter>

Gets the contract’s OutBoxTransactionExecuted event

pub fn send_root_updated_filter( &self ) -> Event<Arc<M>, M, SendRootUpdatedFilter>

Gets the contract’s SendRootUpdated event

pub fn events(&self) -> Event<Arc<M>, M, IOutboxEvents>

Returns an Event builder for all the events of this contract.

Methods from Deref<Target = Contract<M>>

pub fn address(&self) -> H160

Returns the contract’s address

pub fn abi(&self) -> &Contract

Returns a reference to the contract’s ABI.

pub fn client(&self) -> Bwhere B: Clone,

Returns a pointer to the contract’s client.

pub fn client_ref(&self) -> &M

Returns a reference to the contract’s client.

pub fn connect<N>(&self, client: Arc<N>) -> ContractInstance<Arc<N>, N>where N: Middleware,

Returns a new contract instance using the provided client

Clones self internally

pub fn connect_with<C, N>(&self, client: C) -> ContractInstance<C, N>where C: Borrow<N>,

Returns a new contract instance using the provided client

Clones self internally

pub fn event_with_filter<D>(&self, filter: Filter) -> Event<B, M, D>where D: EthLogDecode,

Returns an Event builder with the provided filter.

pub fn event<D>(&self) -> Event<B, M, D>where D: EthEvent,

Returns an Event builder for the provided event.

pub fn event_for_name<D>(&self, name: &str) -> Result<Event<B, M, D>, Error>where D: EthLogDecode,

Returns an Event builder with the provided name.

pub fn method_hash<T, D>( &self, signature: [u8; 4], args: T ) -> Result<FunctionCall<B, M, D>, AbiError>where T: Tokenize, D: Detokenize,

Returns a transaction builder for the selected function signature. This should be preferred if there are overloaded functions in your smart contract

pub fn method<T, D>( &self, name: &str, args: T ) -> Result<FunctionCall<B, M, D>, AbiError>where T: Tokenize, D: Detokenize,

Returns a transaction builder for the provided function name. If there are multiple functions with the same name due to overloading, consider using the method_hash method instead, since this will use the first match.

pub fn at<T>(&self, address: T) -> ContractInstance<B, M>where T: Into<H160>,

Returns a new contract instance at address.

Clones self internally

Methods from Deref<Target = BaseContract>

pub fn encode<T>(&self, name: &str, args: T) -> Result<Bytes, AbiError>where T: Tokenize,

Returns the ABI encoded data for the provided function and arguments

If the function exists multiple times and you want to use one of the overloaded versions, consider using encode_with_selector

pub fn encode_with_selector<T>( &self, signature: [u8; 4], args: T ) -> Result<Bytes, AbiError>where T: Tokenize,

Returns the ABI encoded data for the provided function selector and arguments

pub fn decode<D, T>(&self, name: &str, bytes: T) -> Result<D, AbiError>where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded function arguments with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

pub fn decode_raw<T>( &self, name: &str, bytes: T ) -> Result<Vec<Token, Global>, AbiError>where T: AsRef<[u8]>,

Decodes the provided ABI encoded function arguments with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_output<D, T>(&self, name: &str, bytes: T) -> Result<D, AbiError>where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded function output with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

pub fn decode_output_raw<T>( &self, name: &str, bytes: T ) -> Result<Vec<Token, Global>, AbiError>where T: AsRef<[u8]>,

Decodes the provided ABI encoded function output with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_event<D>( &self, name: &str, topics: Vec<H256, Global>, data: Bytes ) -> Result<D, AbiError>where D: Detokenize,

Decodes for a given event name, given the log.topics and log.data fields from the transaction receipt

pub fn decode_event_raw( &self, name: &str, topics: Vec<H256, Global>, data: Bytes ) -> Result<Vec<Token, Global>, AbiError>

Decodes for a given event name, given the log.topics and log.data fields from the transaction receipt

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_with_selector_raw<T>( &self, signature: [u8; 4], bytes: T ) -> Result<Vec<Token, Global>, AbiError>where T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_with_selector<D, T>( &self, signature: [u8; 4], bytes: T ) -> Result<D, AbiError>where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

pub fn decode_input_raw<T>( &self, bytes: T ) -> Result<Vec<Token, Global>, AbiError>where T: AsRef<[u8]>,

Decodes the provided ABI encoded input bytes

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_input<D, T>(&self, bytes: T) -> Result<D, AbiError>where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded input bytes

pub fn decode_output_with_selector<D, T>( &self, signature: [u8; 4], bytes: T ) -> Result<D, AbiError>where D: Detokenize, T: AsRef<[u8]>,

Decode the provided ABI encoded bytes as the output of the provided function selector

pub fn decode_output_with_selector_raw<T>( &self, signature: [u8; 4], bytes: T ) -> Result<Vec<Token, Global>, AbiError>where T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

Returns a [Token] vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn abi(&self) -> &Contract

Returns a reference to the contract’s ABI

Trait Implementations

impl<M> Clone for IOutbox<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for IOutbox<M>

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

Formats the value using the given formatter.

impl<M> Deref for IOutbox<M>

type Target = ContractInstance<Arc<M>, M>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M> DerefMut for IOutbox<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<M: Middleware> From<ContractInstance<Arc<M>, M>> for IOutbox<M>

fn from(contract: Contract<M>) -> Self

Converts to this type from the input type.