Struct TransactionSigned

pub struct TransactionSigned {
    pub hash: TxHash,
    pub signature: PrimitiveSignature,
    pub transaction: Transaction,
}

Signed transaction.

Fields

hash: TxHash

Transaction hash

signature: PrimitiveSignature

The transaction signature values

transaction: Transaction

Raw transaction info

Implementations

impl TransactionSigned

pub const fn signature(&self) -> &Signature

Transaction signature.

pub const fn transaction(&self) -> &Transaction

Transaction

pub const fn hash(&self) -> TxHash

Transaction hash. Used to identify transaction.

pub const fn hash_ref(&self) -> &TxHash

Reference to transaction hash. Used to identify transaction.

pub fn recover_signer(&self) -> Option<Address>

Recover signer from signature and hash.

Returns None if the transaction’s signature is invalid following EIP-2, see also recover_signer.

Note:

This can fail for some early ethereum mainnet transactions pre EIP-2, use Self::recover_signer_unchecked if you want to recover the signer without ensuring that the signature has a low s value.

pub fn recover_signer_unchecked(&self) -> Option<Address>

Recover signer from signature and hash without ensuring that the signature has a low s value.

Returns None if the transaction’s signature is invalid, see also recover_signer_unchecked.

pub fn recover_signers<'a, T>(txes: T, num_txes: usize) -> Option<Vec<Address>>

where T: IntoParallelIterator<Item = &'a Self> + IntoIterator<Item = &'a Self> + Send,

Recovers a list of signers from a transaction list iterator.

Returns None, if some transaction’s signature is invalid, see also Self::recover_signer.

pub fn recover_signers_unchecked<'a, T>( txes: T, num_txes: usize, ) -> Option<Vec<Address>>

where T: IntoParallelIterator<Item = &'a Self> + IntoIterator<Item = &'a Self>,

Recovers a list of signers from a transaction list iterator without ensuring that the signature has a low s value.

Returns None, if some transaction’s signature is invalid, see also Self::recover_signer_unchecked.

pub const fn with_signer(self, signer: Address) -> TransactionSignedEcRecovered

Returns the TransactionSignedEcRecovered transaction with the given sender.

pub fn into_ecrecovered(self) -> Option<TransactionSignedEcRecovered>

Consumes the type, recover signer and return TransactionSignedEcRecovered

Returns None if the transaction’s signature is invalid, see also Self::recover_signer.

pub fn into_ecrecovered_unchecked(self) -> Option<TransactionSignedEcRecovered>

Consumes the type, recover signer and return TransactionSignedEcRecovered without ensuring that the signature has a low s value (EIP-2).

Returns None if the transaction’s signature is invalid, see also Self::recover_signer_unchecked.

pub fn try_ecrecovered(&self) -> Option<TransactionSignedEcRecovered>

Tries to recover signer and return TransactionSignedEcRecovered by cloning the type.

pub fn try_into_ecrecovered(self) -> Result<TransactionSignedEcRecovered, Self>

Tries to recover signer and return TransactionSignedEcRecovered.

Returns Err(Self) if the transaction’s signature is invalid, see also Self::recover_signer.

pub fn try_into_ecrecovered_unchecked( self, ) -> Result<TransactionSignedEcRecovered, Self>

Tries to recover signer and return TransactionSignedEcRecovered. without ensuring that the signature has a low s value (EIP-2).

Returns Err(Self) if the transaction’s signature is invalid, see also Self::recover_signer_unchecked.

pub fn recalculate_hash(&self) -> B256

Calculate transaction hash, eip2728 transaction does not contain rlp header and start with tx type.

pub fn from_transaction_and_signature( transaction: Transaction, signature: Signature, ) -> Self

Create a new signed transaction from a transaction and its signature.

This will also calculate the transaction hash using its encoding.

pub fn size(&self) -> usize

Calculate a heuristic for the in-memory size of the TransactionSigned.

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

Decodes legacy transaction from the data buffer.

This should be used only be used in general transaction decoding methods, which have already ensured that the input is a legacy transaction with the following format: rlp(legacy_tx)

Legacy transactions are encoded as lists, so the input should start with a RLP list header.

This expects rlp(legacy_tx)

Methods from Deref<Target = Transaction>

pub fn signature_hash(&self) -> B256

Heavy operation that return signature hash over rlp encoded transaction. It is only for signature signing or signer recovery.

pub fn kind(&self) -> TxKind

Gets the transaction’s [TxKind], which is the address of the recipient or [TxKind::Create] if the transaction is a contract creation.

pub 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.

Returns None if this is a CREATE transaction.

pub fn tx_type(&self) -> TxType

Get the transaction’s type

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

Returns the [AccessList] of the transaction.

Returns None for legacy transactions.

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

Returns the [SignedAuthorization] list of the transaction.

Returns None if this transaction is not EIP-7702.

pub fn is_dynamic_fee(&self) -> bool

Returns true if the tx supports dynamic fees

pub fn blob_versioned_hashes(&self) -> Option<Vec<B256>>

Blob versioned hashes for eip4844 transaction, for legacy, eip1559, eip2930 and eip7702 transactions this is None

This is also commonly referred to as the “blob versioned hashes” (BlobVersionedHashes).

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

Returns the blob gas used for all blobs of the EIP-4844 transaction if it is an EIP-4844 transaction.

This is the number of blobs times the DATA_GAS_PER_BLOB a single blob consumes.

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

Returns the effective miner gas tip cap (gasTipCap) for the given base fee: min(maxFeePerGas - baseFee, maxPriorityFeePerGas)

If the base fee is None, the max_priority_fee_per_gas, or gas price for non-EIP1559 transactions is returned.

Returns None if the basefee is higher than the Transaction::max_fee_per_gas.

pub fn input(&self) -> &Bytes

Get the transaction’s input field.

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

This encodes the transaction without the signature, and is only suitable for creating a hash intended for signing.

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

Produces EIP-2718 encoding of the transaction

pub fn is_legacy(&self) -> bool

Returns true if the transaction is a legacy transaction.

pub fn is_eip2930(&self) -> bool

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

pub fn is_eip1559(&self) -> bool

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

pub fn is_eip4844(&self) -> bool

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

pub fn is_eip7702(&self) -> bool

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

pub fn as_legacy(&self) -> Option<&TxLegacy>

Returns the [TxLegacy] variant if the transaction is a legacy transaction.

pub fn as_eip2930(&self) -> Option<&TxEip2930>

Returns the [TxEip2930] variant if the transaction is an EIP-2930 transaction.

pub fn as_eip1559(&self) -> Option<&TxEip1559>

Returns the [TxEip1559] variant if the transaction is an EIP-1559 transaction.

pub fn as_eip4844(&self) -> Option<&TxEip4844>

Returns the [TxEip4844] variant if the transaction is an EIP-4844 transaction.

pub fn as_eip7702(&self) -> Option<&TxEip7702>

Returns the [TxEip7702] variant if the transaction is an EIP-7702 transaction.

Trait Implementations

impl<'a> Arbitrary<'a> for TransactionSigned

Available on crate feature arbitrary only.

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

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

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, 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 AsRef<Transaction> for TransactionSigned

fn as_ref(&self) -> &Transaction

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

impl AsRef<TransactionSigned> for TransactionSigned

fn as_ref(&self) -> &Self

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

impl AsRef<TransactionSigned> for TransactionSignedEcRecovered

fn as_ref(&self) -> &TransactionSigned

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

impl Clone for TransactionSigned

fn clone(&self) -> TransactionSigned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionSigned

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

Formats the value using the given formatter.

impl Decodable for TransactionSigned

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

This Decodable implementation only supports decoding rlp encoded transactions as it’s used by p2p.

The p2p encoding format always includes an RLP header, although the type RLP header depends on whether or not the transaction is a legacy transaction.

If the transaction is a legacy transaction, it is just encoded as a RLP list: rlp(tx-data).

If the transaction is a typed transaction, it is encoded as a RLP string: rlp(tx-type || rlp(tx-data))

This can be used for decoding all signed transactions in p2p BlockBodies responses.

This cannot be used for decoding EIP-4844 transactions in p2p PooledTransactions, since the EIP-4844 variant of TransactionSigned does not include the blob sidecar.

For a method suitable for decoding pooled transactions, see PooledTransactionsElement.

CAUTION: Due to a quirk in [Header::decode], this method will succeed even if a typed transaction is encoded in this format, and does not start with a RLP header: tx-type || rlp(tx-data).

This is because [Header::decode] does not advance the buffer, and returns a length-1 string header if the first byte is less than 0xf7.

impl Decodable2718 for TransactionSigned

fn typed_decode(ty: u8, buf: &mut &[u8]) -> Eip2718Result<Self>

Decode the appropriate variant, based on the type flag.

fn fallback_decode(buf: &mut &[u8]) -> Eip2718Result<Self>

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 TransactionSigned

fn default() -> Self

Returns the “default value” for a type.

impl Deref for TransactionSigned

type Target = Transaction

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for TransactionSigned

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, TransactionSigned> for TransactionSigned<'de>

Available on crate feature serde-bincode-compat only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for TransactionSigned

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

This encodes the transaction with the signature, and an rlp header.

For legacy transactions, it encodes the transaction data: rlp(tx-data)

For EIP-2718 typed transactions, it encodes the transaction type followed by the rlp of the transaction: rlp(tx-type || rlp(tx-data))

fn length(&self) -> usize

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

impl Encodable2718 for TransactionSigned

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 FillTxEnv for TransactionSigned

fn fill_tx_env(&self, tx_env: &mut TxEnv, sender: Address)

Fills [TxEnv] with an [Address] and transaction.

impl<'a> From<&'a TransactionSigned> for TransactionSigned<'a>

Available on crate feature serde-bincode-compat only.

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

Converts to this type from the input type.

impl<'a> From<TransactionSigned<'a>> for TransactionSigned

Available on crate feature serde-bincode-compat only.

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

Converts to this type from the input type.

impl From<TransactionSigned> for TransactionSignedNoHash

fn from(tx: TransactionSigned) -> Self

Converts to this type from the input type.

impl From<TransactionSigned> for TransactionSignedVariant

fn from(value: TransactionSigned) -> Self

Converts to this type from the input type.

impl From<TransactionSignedEcRecovered> for TransactionSigned

fn from(recovered: TransactionSignedEcRecovered) -> Self

Converts to this type from the input type.

impl From<TransactionSignedNoHash> for TransactionSigned

fn from(tx: TransactionSignedNoHash) -> Self

Converts to this type from the input type.

impl Hash for TransactionSigned

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 TransactionSigned

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SerializeAs<TransactionSigned> for TransactionSigned<'_>

Available on crate feature serde-bincode-compat only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SignedTransaction for TransactionSigned

type Transaction = Transaction

Transaction type that is signed.

fn tx_hash(&self) -> &TxHash

Returns reference to transaction hash.

fn transaction(&self) -> &Self::Transaction

Returns reference to transaction.

fn signature(&self) -> &Signature

Returns reference to signature.

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

Recover signer from signature and hash.

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

Recover signer from signature and hash without ensuring that the signature has a low s value.

fn from_transaction_and_signature( transaction: Transaction, signature: Signature, ) -> Self

Create a new signed transaction from a transaction and its signature.

fn fill_tx_env(&self, tx_env: &mut TxEnv, sender: Address)

Fills [TxEnv] with an [Address] and transaction.

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

Calculate transaction hash, eip2728 transaction does not contain rlp header and start with tx type.

impl Transaction for TransactionSigned

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 effective_gas_price(&self, base_fee: 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 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 TryFrom<TransactionSigned> for PooledTransactionsElement

type Error = TransactionConversionError

The type returned in the event of a conversion error.

fn try_from(tx: TransactionSigned) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WithOtherFields<Transaction<AnyTxEnvelope>>> for TransactionSigned

Available on crate feature alloy-compat only.

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(tx: AnyRpcTransaction) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for TransactionSigned

impl StructuralPartialEq for TransactionSigned

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