Struct Optimism

pub struct Optimism { /* private fields */ }

Available on crate feature network only.

Types for an Op-stack network.

Trait Implementations

impl Clone for Optimism

fn clone(&self) -> Optimism

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Optimism

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

Formats the value using the given formatter.

impl Network for Optimism

type TxType = OpTxType

The network transaction type enum.

type TxEnvelope = OpTxEnvelope

The network transaction envelope type.

type UnsignedTx = OpTypedTransaction

An enum over the various transaction types.

type ReceiptEnvelope = OpReceiptEnvelope

The network receipt envelope type.

type Header = Header

The network header type.

type TransactionRequest = OpTransactionRequest

The JSON body of a transaction request.

type TransactionResponse = Transaction

The JSON body of a transaction response.

type ReceiptResponse = OpTransactionReceipt

The JSON body of a transaction receipt.

type HeaderResponse = Header

The JSON body of a header response.

type BlockResponse = Block<<Optimism as Network>::TransactionResponse, <Optimism as Network>::HeaderResponse>

The JSON body of a block response.

impl NetworkWallet<Optimism> for EthereumWallet

fn default_signer_address(&self) -> Address

Get the default signer address. This address should be used in NetworkWallet::sign_transaction_from when no specific signer is specified.

fn has_signer_for(&self, address: &Address) -> bool

Return true if the signer contains a credential for the given address.

fn signer_addresses(&self) -> impl Iterator<Item = Address>

Return an iterator of all signer addresses.

async fn sign_transaction_from( &self, sender: Address, tx: OpTypedTransaction, ) -> Result<OpTxEnvelope, Error>

Asynchronously sign an unsigned transaction, with a specified credential.

fn sign_transaction( &self, tx: <N as Network>::UnsignedTx, ) -> impl Send + Future<Output = Result<<N as Network>::TxEnvelope, Error>>

Asynchronously sign an unsigned transaction.

fn sign_request( &self, request: <N as Network>::TransactionRequest, ) -> impl Send + Future<Output = Result<<N as Network>::TxEnvelope, Error>>

Asynchronously sign a transaction request, using the sender specified in the from field.

impl TransactionBuilder<Optimism> for OpTransactionRequest

fn chain_id(&self) -> Option<u64>

Get the chain ID for the transaction.

fn set_chain_id(&mut self, chain_id: u64)

Set the chain ID for the transaction.

fn nonce(&self) -> Option<u64>

Get the nonce for the transaction.

fn set_nonce(&mut self, nonce: u64)

Set the nonce for the transaction.

fn input(&self) -> Option<&Bytes>

Get the input data for the transaction.

fn set_input<T>(&mut self, input: T)

where T: Into<Bytes>,

Set the input data for the transaction.

fn from(&self) -> Option<Address>

Get the sender for the transaction.

fn set_from(&mut self, from: Address)

Set the sender for the transaction.

fn kind(&self) -> Option<TxKind>

Get the kind of transaction.

fn clear_kind(&mut self)

Clear the kind of transaction.

fn set_kind(&mut self, kind: TxKind)

Set the kind of transaction.

fn value(&self) -> Option<Uint<256, 4>>

Get the value for the transaction.

fn set_value(&mut self, value: Uint<256, 4>)

Set the value for the transaction.

fn gas_price(&self) -> Option<u128>

Get the legacy gas price for the transaction.

fn set_gas_price(&mut self, gas_price: u128)

Set the legacy gas price for the transaction.

fn max_fee_per_gas(&self) -> Option<u128>

Get the max fee per gas for the transaction.

fn set_max_fee_per_gas(&mut self, max_fee_per_gas: u128)

Set the max fee per gas for the transaction.

fn max_priority_fee_per_gas(&self) -> Option<u128>

Get the max priority fee per gas for the transaction.

fn set_max_priority_fee_per_gas(&mut self, max_priority_fee_per_gas: u128)

Set the max priority fee per gas for the transaction.

fn gas_limit(&self) -> Option<u64>

Get the gas limit for the transaction.

fn set_gas_limit(&mut self, gas_limit: u64)

Set the gas limit for the transaction.

fn access_list(&self) -> Option<&AccessList>

Get the EIP-2930 access list for the transaction.

fn set_access_list(&mut self, access_list: AccessList)

Sets the EIP-2930 access list.

fn complete_type(&self, ty: OpTxType) -> Result<(), Vec<&'static str>>

Check if all necessary keys are present to build the specified type, returning a list of missing keys.

fn can_submit(&self) -> bool

True if the builder contains all necessary information to be submitted to the eth_sendTransaction endpoint.

fn can_build(&self) -> bool

True if the builder contains all necessary information to be built into a valid transaction.

fn output_tx_type(&self) -> OpTxType

Returns the transaction type that this builder will attempt to build. This does not imply that the builder is ready to build.

fn output_tx_type_checked(&self) -> Option<OpTxType>

Returns the transaction type that this builder will build. None if the builder is not ready to build.

fn prep_for_submission(&mut self)

Trim any conflicting keys and populate any computed fields (like blob hashes).

fn build_unsigned( self, ) -> Result<OpTypedTransaction, UnbuiltTransactionError<Optimism>>

Build an unsigned, but typed, transaction.

async fn build<W>( self, wallet: &W, ) -> Result<<Optimism as Network>::TxEnvelope, TransactionBuilderError<Optimism>>

where W: NetworkWallet<Optimism>,

Build a signed transaction.

fn with_chain_id(self, chain_id: u64) -> Self

Builder-pattern method for setting the chain ID.

fn with_nonce(self, nonce: u64) -> Self

Builder-pattern method for setting the nonce.

fn with_input<T>(self, input: T) -> Self

where T: Into<Bytes>,

Builder-pattern method for setting the input data.

fn with_from(self, from: Address) -> Self

Builder-pattern method for setting the sender.

fn with_kind(self, kind: TxKind) -> Self

Builder-pattern method for setting the kind of transaction.

fn to(&self) -> Option<Address>

Get the recipient for the transaction.

fn set_to(&mut self, to: Address)

Set the recipient for the transaction.

fn with_to(self, to: Address) -> Self

Builder-pattern method for setting the recipient.

fn set_create(&mut self)

Set the to field to a create call.

fn into_create(self) -> Self

Set the to field to a create call.

fn set_deploy_code<T>(&mut self, code: T)

where T: Into<Bytes>,

Deploy the code by making a create call with data. This will set the to field to TxKind::Create.

fn with_deploy_code<T>(self, code: T) -> Self

where T: Into<Bytes>,

Deploy the code by making a create call with data. This will set the to field to TxKind::Create.

fn set_call<T>(&mut self, t: &T)

where T: SolCall,

Set the data field to a contract call. This will clear the to field if it is set to TxKind::Create.

fn with_call<T>(self, t: &T) -> Self

where T: SolCall,

Make a contract call with data.

fn calculate_create_address(&self) -> Option<Address>

Calculates the address that will be created by the transaction, if any.

fn with_value(self, value: Uint<256, 4>) -> Self

Builder-pattern method for setting the value.

fn with_gas_price(self, gas_price: u128) -> Self

Builder-pattern method for setting the legacy gas price.

fn with_max_fee_per_gas(self, max_fee_per_gas: u128) -> Self

Builder-pattern method for setting max fee per gas .

fn with_max_priority_fee_per_gas(self, max_priority_fee_per_gas: u128) -> Self

Builder-pattern method for setting max priority fee per gas.

fn with_gas_limit(self, gas_limit: u64) -> Self

Builder-pattern method for setting the gas limit.

fn with_access_list(self, access_list: AccessList) -> Self

Builder-pattern method for setting the access list.

fn complete_preferred(&self) -> Result<(), Vec<&'static str>>

Check if all necessary keys are present to build the currently-preferred transaction type, returning a list of missing keys.

fn assert_preferred(&self, ty: <N as Network>::TxType)

Assert that the builder prefers a certain transaction type. This does not indicate that the builder is ready to build. This function uses a dbg_assert_eq! to check the builder status, and will have no affect in release builds.

fn assert_preferred_chained(self, ty: <N as Network>::TxType) -> Self

Assert that the builder prefers a certain transaction type. This does not indicate that the builder is ready to build. This function uses a dbg_assert_eq! to check the builder status, and will have no affect in release builds.

fn apply<F>(self, f: F) -> Self

where F: FnOnce(Self) -> Self,

Apply a function to the builder, returning the modified builder.

impl Copy for Optimism