Skip to main content

Crate eth

Crate eth 

Source
Expand description

no_std-first Ethereum protocol building blocks for Rust.
Explicit domains, bounded decode policy, constant-time primitives, and security-gated release evidence.


eth Rust crate overview

§eth

eth is the public facade crate for a no_std-first Ethereum execution-layer protocol workspace.

The crate is intentionally conservative at 0.5.0: it provides explicit Ethereum primitive domains, bounded decode-budget policy, stable error categories, small first-party crate boundaries, optional sanitization support, and release evidence before RPC, signer, EVM, Reth, or P2P integrations become real dependencies.

§Current Status

The current release is 0.5.0.

Implemented now:

  • no_std facade with small first-party support crates.
  • Ethereum domain newtypes for chain, block, gas, nonce, timestamp, address, hash, wei, and transaction type values.
  • Constant-time equality composition for fixed-width hash and wei values.
  • Bounded decode limits plus stateful cumulative allocation, item, and proof-node accounting.
  • Stable error codes, messages, categories, and formatting for codec, protocol, fork, feature, resource, and verification failures.
  • Optional sanitization bridge and derive macros outside the default feature set.
  • Release gates for formatting, clippy, tests, packaging, MSRV compatibility, dependency policy, audit, SBOM, and pentest evidence.

Not implemented yet:

  • No RPC transport.
  • No signer or local key storage.
  • No EVM execution adapter.
  • No Reth or P2P integration.
  • No transaction or block parser yet.

§Trust Dashboard

AreaStatus
LicenseEUPL-1.2
MSRVRust 1.90.0
Latest verified stableRust 1.96.0
Default targetno_std
Default featuresprotocol-core only
Default networking/signingnone
Unsafe policyfirst-party crates use #![forbid(unsafe_code)]
Release evidencelocal gates, cargo-deny, cargo-audit, SBOM, pentest report
Crate versionstracked in the version matrix

§Install

[dependencies]
eth = "0.5"

Disable defaults explicitly for embedded or freestanding builds:

[dependencies]
eth = { version = "0.5", default-features = false }

Optional sanitization support:

[dependencies]
eth = { version = "0.5", features = ["sanitization"] }

§Features

FeatureDefaultPurpose
stdnoEnables std support in admitted core crates.
evmnoFuture explicit EVM adapter boundary.
rpcnoFuture explicit RPC trust-policy boundary.
sanitizationnoRe-exports optional secret sanitization bridge APIs.
signernoFuture signer isolation boundary.
rethnoFuture Reth integration boundary.
testkitnoTest fixtures, conformance helpers, and adversarial inputs.

Default builds do not enable networking, signing, local key storage, Reth, P2P, or EVM execution.

§Primitive Domains

Use explicit Ethereum domains instead of unqualified integers and byte arrays:

use eth::primitives::{
    Address, B256, BlockNumber, ChainId, Gas, Nonce, TransactionType, Wei,
};

let chain = ChainId::new(1);
let block = BlockNumber::new(19_000_000);
let gas = Gas::new(21_000);
let nonce = Nonce::new(7);
let address = Address::from([0x11_u8; 20]);
let hash = B256::from([0x22_u8; 32]);
let value = Wei::from_u128(1_000_000_000_000_000_000);
let tx_type = TransactionType::try_new_typed(2);

assert_eq!(u64::from(chain), 1);
assert_eq!(u64::from(block), 19_000_000);
assert_eq!(u64::from(gas), 21_000);
assert_eq!(u64::from(nonce), 7);
assert_eq!(<[u8; 20]>::from(address), [0x11_u8; 20]);
assert_eq!(<[u8; 32]>::from(hash), [0x22_u8; 32]);
assert_eq!(value.to_be_bytes()[31], 0);
assert_eq!(tx_type.map(u8::from), Ok(2));

Legacy transactions are not typed EIP-2718 envelopes. Use TransactionType::LEGACY for APIs that need a legacy domain value, and try_new_typed for type bytes that will be encoded as typed envelopes.

§Constant-Time Composition

B256::ct_eq and Wei::ct_eq return subtle::Choice so compound checks can use & and | without short-circuiting:

use eth::primitives::B256;

let block_hash = B256::from([1_u8; 32]);
let expected_block_hash = B256::from([1_u8; 32]);
let receipts_root = B256::from([2_u8; 32]);
let expected_receipts_root = B256::from([2_u8; 32]);

let valid = block_hash.ct_eq(&expected_block_hash)
    & receipts_root.ct_eq(&expected_receipts_root);

assert!(bool::from(valid));

Convert Choice to bool only at the final trust boundary.

§Stable Errors

Error values expose stable codes, messages, and categories. They do not carry input bytes, keys, signatures, or other secret-bearing payloads:

use eth::error::{DecodeError, DecodeErrorCategory, ResourceError};

let error = DecodeError::AllocationExceeded;

assert_eq!(error.code(), "ETH_CODEC_ALLOCATION_EXCEEDED");
assert_eq!(error.category(), DecodeErrorCategory::ResourceExhaustion);
assert_eq!(error.resource(), Some(ResourceError::AllocationBytes));
assert_eq!(error.to_string(), "decoder exceeded the active allocation limit");

§Decode Budgets

Every future untrusted decoder is required to use explicit limits. Use DecodeAccumulator when more than one allocation can occur:

use eth::codec::{DecodeError, DecodeLimits};

let limits = DecodeLimits {
    max_input_bytes: 1024,
    max_list_items: 16,
    max_nesting_depth: 4,
    max_total_allocation: 64,
    max_proof_nodes: 8,
    max_total_items: 32,
};

assert_eq!(limits.check_input_len(512), Ok(()));

let mut budget = limits.accumulator();
assert_eq!(budget.check_allocation(32), Ok(()));
assert_eq!(budget.check_allocation(32), Ok(()));
assert_eq!(budget.check_allocation(1), Err(DecodeError::AllocationExceeded));
assert_eq!(budget.account_items(33), Err(DecodeError::ItemCountExceeded));

§Optional Sanitization

The main facade stays small by default. Applications that handle local secret material can opt into the sanitization bridge:

use eth::sanitization::{SecretBytes32, SecureSanitize};

let mut key = SecretBytes32::from_array([0x42_u8; 32]);
key.secure_sanitize();
assert!(key.constant_time_eq(&[0_u8; 32]));

For derive macros, depend on the support crate directly:

[dependencies]
eth-valkyoth-sanitization = { version = "0.5", features = ["derive"] }

§Support Crates

Most users should depend on eth. The eth-valkyoth-* crates are published so the workspace can keep small, auditable boundaries:

CrateDefaultPurpose
eth-valkyoth-primitivesyesChain, block, gas, nonce, address, hash, wei, and transaction type domains.
eth-valkyoth-codecyesBounded exact-consumption wire decoding policy.
eth-valkyoth-protocolyesFork-aware validation states and protocol context.
eth-valkyoth-verifyyesVerification boundaries for signatures, proofs, and replay domains.
eth-valkyoth-sanitizationnoOptional bridge to the sanitization crate.
eth-valkyoth-derivenoOptional sanitization derive macros.
eth-valkyoth-evmnoFuture EVM adapter boundary.
eth-valkyoth-rpcnoFuture RPC trust-policy boundary.
eth-valkyoth-signernoFuture signer isolation boundary.
eth-valkyoth-rethnoFuture Reth integration boundary.
eth-valkyoth-testkitnoFuture fixtures and conformance helpers.

§Rust Version Support

The minimum supported Rust version is Rust 1.90.0. New deployments should use the latest stable Rust verified by the release gates.

Compatibility evidence for 0.5.0:

RustLocal Evidence
1.90.0cargo check --workspace --all-features
1.91.0cargo check --workspace --all-features
1.92.0cargo check --workspace --all-features
1.93.0cargo check --workspace --all-features
1.94.0cargo check --workspace --all-features
1.95.0cargo check --workspace --all-features
1.96.0full release gate

§License

Licensed under the European Union Public Licence 1.2.

Re-exports§

pub use eth_valkyoth_codec as codec;
pub use eth_valkyoth_primitives as primitives;
pub use eth_valkyoth_protocol as protocol;
pub use eth_valkyoth_verify as verify;

Modules§

error
Stable error types re-exported by the facade crate.