Struct TxDeposit

pub struct TxDeposit {
    pub source_hash: FixedBytes<32>,
    pub from: Address,
    pub to: TxKind,
    pub mint: Option<u128>,
    pub value: Uint<256, 4>,
    pub gas_limit: u64,
    pub is_system_transaction: bool,
    pub input: Bytes,
}

Available on crate feature consensus only.

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

Fields

source_hash: FixedBytes<32>

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: Uint<256, 4>

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<TxDeposit, Error>

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<TxDeposit, Error>

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 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 tx_hash(&self) -> FixedBytes<32>

Calculate the transaction hash.

pub fn signature() -> PrimitiveSignature

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

Trait Implementations

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

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<TxDeposit, Error>

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<TxDeposit, Error>

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.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

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<(), Error>

Formats the value using the given formatter.

impl Decodable for TxDeposit

fn decode(data: &mut &[u8]) -> Result<TxDeposit, Error>

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

impl Decodable2718 for TxDeposit

fn typed_decode(ty: u8, data: &mut &[u8]) -> Result<TxDeposit, Eip2718Error>

Decode the appropriate variant, based on the type flag.

fn fallback_decode(data: &mut &[u8]) -> Result<TxDeposit, Eip2718Error>

Decode the default variant.

fn extract_type_byte(buf: &mut &[u8]) -> Option<u8>

Extract the type byte from the buffer, if any. The type byte is the first byte, provided that that first byte is 0x7f or lower.

fn decode_2718(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn network_decode(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Decode an EIP-2718 transaction in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client.

impl Default for TxDeposit

fn default() -> TxDeposit

Returns the “default value” for a type.

impl DepositTransaction for TxDeposit

fn source_hash(&self) -> Option<FixedBytes<32>>

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<TxDeposit, <__D as Deserializer<'de>>::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 Encodable2718 for TxDeposit

fn type_flag(&self) -> Option<u8>

Return the type flag (if any).

fn encode_2718_len(&self) -> usize

The length of the 2718 encoded envelope. This is the length of the type flag + the length of the inner encoding.

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

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn is_legacy(&self) -> bool

True if the envelope is the legacy variant.

fn encoded_2718(&self) -> Vec<u8>

Encode the transaction according to [EIP-2718] rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn trie_hash(&self) -> FixedBytes<32>

Compute the hash as committed to in the MPT trie. This hash is used ONLY by the Ethereum merkle-patricia trie and associated proofs. Do not call this method unless you are building a full or light client.

fn seal(self) -> Sealed<Self>

Seal the encodable, by encoding and hashing it.

fn network_len(&self) -> usize

The length of the 2718 encoded envelope in network format. This is the length of the header + the length of the type flag and inner encoding.

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

Encode in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client.

impl From<TxDeposit> for OpTransactionRequest

fn from(tx: TxDeposit) -> OpTransactionRequest

Converts to this type from the input type.

impl From<TxDeposit> for OpTxEnvelope

fn from(v: TxDeposit) -> OpTxEnvelope

Converts to this type from the input type.

impl From<TxDeposit> for OpTypedTransaction

fn from(tx: TxDeposit) -> OpTypedTransaction

Converts to this type from the input type.

impl Hash for TxDeposit

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

where __H: Hasher,

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

fn hash_slow(&self) -> FixedBytes<32>

Calculate the seal hash, this may be slow.

fn seal_slow(self) -> Sealed<Self>

Seal the object by calculating the hash. This may be slow.

fn seal_ref_slow(&self) -> Sealed<&Self>

Seal a borrowed object by calculating the hash. This may be slow.

fn seal_unchecked(self, seal: FixedBytes<32>) -> Sealed<Self>

Instantiate an unchecked seal. This should be used with caution.

fn seal_ref_unchecked(&self, seal: FixedBytes<32>) -> Sealed<&Self>

Instantiate an unchecked seal. This should be used with caution.

impl Serialize for TxDeposit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transaction for TxDeposit

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

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 effective_gas_price(&self, _: Option<u64>) -> u128

Returns the effective gas price for the given base fee.

fn is_dynamic_fee(&self) -> bool

Returns true if the transaction supports dynamic fees.

fn kind(&self) -> TxKind

Returns the transaction kind.

fn is_create(&self) -> bool

Returns true if the transaction is a contract creation. We don’t provide a default implementation via kind as it copies the 21-byte TxKind for this simple check. A proper implementation shouldn’t allocate.

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

Get value.

fn input(&self) -> &Bytes

Get data.

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<&[FixedBytes<32>]>

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.

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

Returns the total gas for all blobs in this transaction.

impl Typed2718 for TxDeposit

fn ty(&self) -> u8

Returns the EIP-2718 type flag.

fn is_type(&self, ty: u8) -> bool

Returns true if the type matches the given type.

fn is_legacy(&self) -> bool

Returns true if the type is a legacy transaction.

fn is_eip2930(&self) -> bool

Returns true if the type is an EIP-2930 transaction.

fn is_eip1559(&self) -> bool

Returns true if the type is an EIP-1559 transaction.

fn is_eip4844(&self) -> bool

Returns true if the type is an EIP-4844 transaction.

fn is_eip7702(&self) -> bool

Returns true if the type is an EIP-7702 transaction.

impl Eq for TxDeposit

impl StructuralPartialEq for TxDeposit