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 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(crate) fn fields_len(&self) -> usize

Outputs the length of the transaction’s fields, without a RLP header or length of the eip155 fields.

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

Encodes only the transaction’s fields into the desired buffer, without a RLP header. https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/deposits.md#the-deposited-transaction-type

pub fn size(&self) -> usize

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

pub(crate) const fn tx_type(&self) -> OpTxType

Get the transaction type

pub fn encode_inner(&self, out: &mut dyn BufMut, with_header: bool)

Inner encoding function that is used for both rlp [Encodable] trait and for calculating hash that for eip2718 does not require rlp header

pub fn encoded_len(&self, with_header: bool) -> usize

Output the length of the RLP signed transaction encoding.

If with_header is true, the length includes the RLP header.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for TxDeposit

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

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<'de> Deserialize<'de> for TxDeposit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeAs<'de, TxDeposit> for TxDeposit<'de>

Available on crate features serde and serde-bincode-compat only.

fn deserialize_as<D>(deserializer: D) -> Result<TxDeposit, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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<'a> From<&'a TxDeposit> for TxDeposit<'a>

Available on crate features serde and serde-bincode-compat only.

fn from(value: &'a TxDeposit) -> Self

Converts to this type from the input type.

impl<'a> From<TxDeposit<'a>> for TxDeposit

Available on crate features serde and serde-bincode-compat only.

fn from(value: TxDeposit<'a>) -> Self

Converts to this type from the input type.

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 Serialize for TxDeposit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> SerializeAs<TxDeposit> for TxDeposit<'a>

Available on crate features serde and serde-bincode-compat only.

fn serialize_as<S>(source: &TxDeposit, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

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 to(&self) -> TxKind

Get to.

fn value(&self) -> U256

Get value.

fn input(&self) -> &[u8]

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.

impl Eq for TxDeposit

impl StructuralPartialEq for TxDeposit

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: 192 bytes