Struct TxDeposit

pub struct TxDeposit {
    pub source_hash: B256,
    pub from: Address,
    pub to: TxKind,
    pub mint: Option<u128>,
    pub value: U256,
    pub gas_limit: u64,
    pub is_system_transaction: bool,
    pub input: Bytes,
}

Deposit transactions, also known as deposits are initiated on L1, and executed on L2.

Fields

source_hash: B256

Hash that uniquely identifies the source of the deposit.

from: Address

The address of the sender account.

to: TxKind

The address of the recipient account, or the null (zero-length) address if the deposited transaction is a contract creation.

mint: Option<u128>

The ETH value to mint on L2.

value: U256

The ETH value to send to the recipient account.

gas_limit: u64

The gas limit for the L2 transaction.

is_system_transaction: bool

Field indicating if this transaction is exempt from the L2 gas limit.

input: Bytes

Input has two uses depending if transaction is Create or Call (if to field is None or Some).

Implementations

impl TxDeposit

pub fn rlp_decode_fields(buf: &mut &[u8]) -> Result<Self>

Decodes the inner TxDeposit fields from RLP bytes.

NOTE: This assumes a RLP header has already been decoded, and just decodes the following RLP fields in the following order:

• source_hash
• from
• to
• mint
• value
• gas_limit
• is_system_transaction
• input

pub fn rlp_decode(buf: &mut &[u8]) -> Result<Self>

Decodes the transaction from RLP bytes.

pub fn size(&self) -> usize

Calculates a heuristic for the in-memory size of the TxDeposit transaction.

pub fn rlp_encode(&self, out: &mut dyn BufMut)

RLP encodes the transaction.

pub fn rlp_encoded_length(&self) -> usize

Get the length of the transaction when RLP encoded.

pub fn eip2718_encoded_length(&self) -> usize

Get the length of the transaction when EIP-2718 encoded. This is the 1 byte type flag + the length of the RLP encoded transaction.

pub fn eip2718_encode(&self, out: &mut dyn BufMut)

EIP-2718 encode the transaction with the given signature and the default type flag.

pub fn network_encoded_length(&self) -> usize

Get the length of the transaction when network encoded. This is the EIP-2718 encoded length with an outer RLP header.

pub fn network_encode(&self, out: &mut dyn BufMut)

Network encode the transaction with the given signature.

pub fn signature() -> Signature

Returns the signature for the optimism deposit transactions, which don’t include a signature.

Trait Implementations

impl Clone for TxDeposit

fn clone(&self) -> TxDeposit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TxDeposit

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

Formats the value using the given formatter.

impl Decodable for TxDeposit

fn decode(data: &mut &[u8]) -> Result<Self>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl Default for TxDeposit

fn default() -> TxDeposit

Returns the “default value” for a type.

impl DepositTransaction for TxDeposit

fn source_hash(&self) -> Option<B256>

Returns the hash that uniquely identifies the source of the deposit.

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

Returns the optional mint value of the deposit transaction.

fn is_system_transaction(&self) -> bool

Indicates whether the transaction is exempt from the L2 gas limit.

fn is_deposit(&self) -> bool

Checks if the transaction is a deposit transaction.

impl Encodable for TxDeposit

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

impl From<TxDeposit> for OpTxEnvelope

fn from(v: TxDeposit) -> Self

Converts to this type from the input type.

impl From<TxDeposit> for OpTypedTransaction

fn from(tx: TxDeposit) -> Self

Converts to this type from the input type.

impl Hash for TxDeposit

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TxDeposit

fn eq(&self, other: &TxDeposit) -> 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 Transaction for TxDeposit

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

Get chain_id.

fn nonce(&self) -> u64

Get nonce.

fn gas_limit(&self) -> u64

Get gas_limit.

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

Get gas_price.

fn max_fee_per_gas(&self) -> u128

Returns the EIP-1559 the maximum fee per gas the caller is willing to pay.

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

Returns the EIP-1559 Priority fee the caller is paying to the block author.

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

Max fee per blob gas for EIP-4844 transaction.

fn priority_fee_or_price(&self) -> u128

Return the max priority fee per gas if the transaction is an EIP-1559 transaction, and otherwise return the gas price.

fn kind(&self) -> TxKind

Returns the transaction kind.

fn value(&self) -> U256

Get value.

fn input(&self) -> &Bytes

Get data.

fn ty(&self) -> u8

Returns the transaction type

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

Returns the EIP-2930 access_list for the particular transaction type. Returns None for older transaction types.

fn blob_versioned_hashes(&self) -> Option<&[B256]>

Blob versioned hashes for eip4844 transaction. For previous transaction types this is None.

fn authorization_list(&self) -> Option<&[SignedAuthorization]>

Returns the SignedAuthorization list of the transaction.

fn effective_tip_per_gas(&self, base_fee: u64) -> Option<u128>

Returns the effective tip for this transaction.

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

Get the transaction’s address of the contract that will be called, or the address that will receive the transfer.

impl Eq for TxDeposit

impl StructuralPartialEq for TxDeposit