Crate reth_primitives

Commonly used types in Reth.

This crate contains Ethereum primitive types and helper functions.

Feature Flags

• alloy-compat: Adds compatibility conversions for certain alloy types.
• arbitrary: Adds proptest and arbitrary support for primitive types.
• test-utils: Export utilities for testing
• reth-codec: Enables db codec support for reth types including zstd compression for certain types.

Re-exports

• pub use transaction::BlobTransaction;
• pub use transaction::PooledTransactionsElement;
• pub use transaction::PooledTransactionsElementEcRecovered;
• pub use transaction::InvalidTransactionError;
• pub use transaction::Transaction;
• pub use transaction::TransactionMeta;
• pub use transaction::TransactionSigned;
• pub use transaction::TransactionSignedEcRecovered;
• pub use transaction::TransactionSignedNoHash;
• pub use transaction::TxHashOrNumber;
• pub use transaction::TxType;
• pub use transaction::EIP1559_TX_TYPE_ID;
• pub use transaction::EIP2930_TX_TYPE_ID;
• pub use transaction::EIP4844_TX_TYPE_ID;
• pub use transaction::EIP7702_TX_TYPE_ID;
• pub use transaction::LEGACY_TX_TYPE_ID;
• pub use reth_static_file_types as static_file;
• pub use revm_primitives;
• pub use arbitrary;
  arbitrary
• pub use c_kzg as kzg;
  c-kzg

Modules

• arbitrary
  The Arbitrary trait crate.
• constants
  Ethereum protocol-related constants
• proofs
  Helper function for calculating Merkle proofs and hashes.
• serde_bincode_compatserde-bincode-compat
  Bincode-compatible serde implementations for commonly used types in Reth.
• transaction
  Transaction types.

Macros

• hardfork
  Macro that defines different variants of a chain specific enum. See crate::Hardfork as an example.

Structs

• Account
  An Ethereum account.
• BlobTransactionSidecar
  This represents a set of blobs, and its corresponding commitments and proofs.
• Block
  Ethereum full block.
• BlockBody
  A response to GetBlockBodies, containing bodies if any bodies were found.
• BlockWithSenders
  Sealed block with senders recovered from transactions.
• Bytecode
  Bytecode for an account.
• ChainHardforks
  Ordered list of a chain hardforks that implement Hardfork.
• DisplayHardforks
  A container for pretty-printing a list of hardforks.
• EnrForkIdEntry
  Represents a forward-compatible ENR entry for including the forkid in a node record via EIP-868. Forward compatibility is achieved via EIP-8.
• ForkFilter
  Filter that describes the state of blockchain and can be used to check incoming ForkIds for compatibility.
• ForkHash
  CRC32 hash of all previous forks starting from genesis block.
• ForkId
  A fork identifier as defined by EIP-2124. Serves as the chain compatibility identifier.
• ForkTransition
  Represents a transition from one fork to another
• GotExpected
  A pair of values, one of which is expected and one of which is actual.
• GotExpectedBoxed
  A pair of values, one of which is expected and one of which is actual.
• Head
  Describes the current head block.
• Header
  Ethereum Block header
• JumpTable
  A map of valid jump destinations.
• Log
  A log consists of an address, and some log data.
• LogData
  An Ethereum event log object.
• Receipt
  Receipt containing result of transaction execution.
• ReceiptWithBloom
  Receipt with calculated bloom filter.
• ReceiptWithBloomRef
  Receipt reference type with calculated bloom filter.
• Receipts
  A collection of receipts organized as a two-dimensional vector.
• Requests
  A list of EIP-7685 requests.
• ReusableDecompressorreth-codec
  Reusable decompressor that uses its own internal buffer.
• RpcBlockHash
  A block hash which may have a boolean requireCanonical field.
• SealedBlock
  Sealed Ethereum full block.
• SealedBlockWithSenders
  Sealed block with senders recovered from transactions.
• SealedHeader
  A Header that is sealed at a precalculated hash, use SealedHeader::unseal() if you want to modify header.
• Signature
  An Ethereum ECDSA signature.
• StorageEntry
  Account storage entry.
• Withdrawal
  Withdrawal represents a validator withdrawal from the consensus layer.
• Withdrawals
  Represents a collection of Withdrawals.

Enums

• BlobTransactionValidationErrorc-kzg
  An error that can occur when validating a BlobTransactionSidecar::validate.
• BlockId
  A Block Identifier. https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1898.md
• BlockNumberOrTag
  A block Number (or tag - “latest”, “earliest”, “pending”)
• EthereumHardfork
  The name of an Ethereum hardfork.
• ForkCondition
  The condition at which a fork is activated.
• ForkFilterKey
  How to filter forks.
• HeaderError
  Errors that can occur during header sanity checks.
• Request
  Ethereum execution layer requests.
• StaticFileSegment
  Segment of the data that can be moved to static files.
• ValidationError
  Reason for rejecting provided ForkId.

Constants

• DEV_GENESIS_HASH
  Testnet genesis hash: 0x2f980576711e3617a5e4d83dd539548ec0f7792007d505a3d2e9674833af2d7c
• EMPTY_OMMER_ROOT_HASH
  Ommer root of empty list: 0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347
• HOLESKY_GENESIS_HASH
  Holesky genesis hash: 0xb5f7f912443c940f21fd611f12828d75b534364ed9e95ca4e307729a4661bde4
• KECCAK_EMPTY
  Keccak256 over empty array: 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470
• MAINNET_GENESIS_HASH
  The Ethereum mainnet genesis hash: 0x0d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3
• RECEIPT_COMPRESSORreth-codec
  Thread receipt compressor.
• RECEIPT_DECOMPRESSORreth-codec
  Thread receipt decompressor.
• SEPOLIA_GENESIS_HASH
  Sepolia genesis hash: 0x25a5cc106eea7138acab33231d7160d69cb777ee0c2c553fcddf5138993e6dd9
• TRANSACTION_COMPRESSORreth-codec
  Thread Transaction compressor.
• TRANSACTION_DECOMPRESSORreth-codec
  Thread Transaction decompressor.

Statics

• DEV_HARDFORKS
  Dev hardforks
• RECEIPT_DICTIONARYreth-codec
  Compression/Decompression dictionary for Receipt.
• TRANSACTION_DICTIONARYreth-codec
  Compression/Decompression dictionary for Transaction.

Traits

• EthereumHardforks
  Helper methods for Ethereum forks.
• Hardfork
  Generic hardfork trait.
• Hardforks
  Generic trait over a set of ordered hardforks

Functions

• create_receipt_compressorreth-codec
  Fn creates receipt [Compressor]
• create_receipt_decompressorreth-codec
  Fn creates receipt [Decompressor]
• create_tx_compressorreth-codec
  Fn creates tx [Compressor]
• create_tx_decompressorreth-codec
  Fn creates tx [Decompressor]
• gas_spent_by_transactions
  Retrieves gas spent by transactions as a vector of tuples (transaction index, gas used).
• generate_valid_headerarbitrary
  Generates a header which is valid with respect to past and future forks. This means, for example, that if the withdrawals root is present, the base fee per gas is also present.
• logs_bloom
  Calculate receipt logs bloom.
• public_key_to_addresssecp256k1
  Converts a public key into an ethereum address by hashing the encoded public key with keccak256.
• recover_signer_uncheckedsecp256k1
  Recovers the address of the sender using secp256k1 pubkey recovery.
• sign_messagesecp256k1
  Signs message with the given secret key. Returns the corresponding signature.
• valid_header_strategyarbitrary
  Generates a proptest strategy for constructing an instance of a header which is valid with respect to past and future forks.

Type Aliases

• BlockHashOrNumber
  A block hash or a block number
• BlockNumHash
  A block number and a hash
• ForkBlock
  Block number and hash of the forked block.