Struct FoundryTransactionRequest 

pub struct FoundryTransactionRequest(WithOtherFields<TransactionRequest>);

Foundry transaction request builder.

This is implemented as a wrapper around [WithOtherFields<TransactionRequest>], which provides handling of deposit transactions.

Tuple Fields

0: WithOtherFields<TransactionRequest>

Implementations

impl FoundryTransactionRequest

pub fn new(inner: WithOtherFields<TransactionRequest>) -> Self

Create a new FoundryTransactionRequest from given [WithOtherFields<TransactionRequest>].

pub fn is_deposit(&self) -> bool

Check if this is a deposit transaction.

pub fn preferred_type(&self) -> FoundryTxType

Returns the minimal transaction type this request can be converted into based on the fields that are set. See [TransactionRequest::preferred_type].

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

Check if all necessary keys are present to build a 4844 transaction, returning a list of keys that are missing.

NOTE: Inner [TransactionRequest::complete_4844] method but “sidecar” key is filtered from error.

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

Check if all necessary keys are present to build a Deposit transaction, returning a list of keys that are missing.

pub fn buildable_type(&self) -> Option<FoundryTxType>

Return the tx type this request can be built as. Computed by checking the preferred type, and then checking for completeness.

pub fn missing_keys( &self, ) -> Result<FoundryTxType, (FoundryTxType, Vec<&'static str>)>

Check if all necessary keys are present to build a transaction.

Returns

• Ok(type) if all necessary keys are present to build the preferred type.
• Err((type, missing)) if some keys are missing to build the preferred type.

pub fn build_typed_tx(self) -> Result<FoundryTypedTx, Self>

Build a typed transaction from this request.

Converts the request into a FoundryTypedTx, handling all Ethereum and OP-stack transaction types.

Trait Implementations

impl AsMut<WithOtherFields<TransactionRequest>> for FoundryTransactionRequest

fn as_mut(&mut self) -> &mut WithOtherFields<TransactionRequest>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<WithOtherFields<TransactionRequest>> for FoundryTransactionRequest

fn as_ref(&self) -> &WithOtherFields<TransactionRequest>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FoundryTransactionRequest

fn clone(&self) -> FoundryTransactionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FoundryTransactionRequest

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

Formats the value using the given formatter.

impl Default for FoundryTransactionRequest

fn default() -> FoundryTransactionRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FoundryTransactionRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FoundryTransactionRequest> for WithOtherFields<TransactionRequest>

fn from(value: FoundryTransactionRequest) -> Self

Converts to this type from the input type.

impl From<FoundryTxEnvelope> for FoundryTransactionRequest

fn from(tx: FoundryTxEnvelope) -> Self

Converts to this type from the input type.

impl From<FoundryTypedTx> for FoundryTransactionRequest

fn from(tx: FoundryTypedTx) -> Self

Converts to this type from the input type.

impl From<WithOtherFields<TransactionRequest>> for FoundryTransactionRequest

fn from(value: WithOtherFields<TransactionRequest>) -> Self

Converts to this type from the input type.

impl PartialEq for FoundryTransactionRequest

fn eq(&self, other: &FoundryTransactionRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FoundryTransactionRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TransactionBuilder<FoundryNetwork> for FoundryTransactionRequest

fn prep_for_submission(&mut self)

Prepares FoundryTransactionRequest by trimming conflicting fields, and filling with default values the mandatory fields.

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

Get the chain ID for the transaction.

fn set_chain_id(&mut self, chain_id: ChainId)

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 take_nonce(&mut self) -> Option<u64>

Takes the nonce out of the transaction, clearing it.

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

Get the input data for the transaction.

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

Set the input data for the transaction.

fn set_input_kind<T: Into<Bytes>>( &mut self, input: T, kind: TransactionInputKind, )

Set the input data for the transaction, respecting the input kind

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<U256>

Get the value for the transaction.

fn set_value(&mut self, value: U256)

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: FoundryTxType) -> 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) -> FoundryTxType

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<FoundryTxType>

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

fn build_unsigned(self) -> BuildResult<FoundryTypedTx, FoundryNetwork>

Build an unsigned, but typed, transaction.

async fn build<W: NetworkWallet<FoundryNetwork>>( self, wallet: &W, ) -> Result<FoundryTxEnvelope, TransactionBuilderError<FoundryNetwork>>

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 without_nonce(self) -> Self

Takes the nonce out of the transaction, clearing it.

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

where T: Into<Bytes>,

Builder-pattern method for setting the input data.

fn with_input_kind<T>(self, input: T, kind: TransactionInputKind) -> Self

where T: Into<Bytes>,

Builder-pattern method for setting the input data, respecting the input kind

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.

fn try_apply<F, E>(self, f: F) -> Result<Self, E>

where F: FnOnce(Self) -> Result<Self, E>,

Apply a fallible function to the builder, returning the modified builder or an error.

impl Eq for FoundryTransactionRequest

impl StructuralPartialEq for FoundryTransactionRequest

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 512 bytes