Alloy connects applications to blockchains.
Alloy is a rewrite of ethers-rs from the ground up, with exciting new
features, high performance, and excellent docs.
We also have a book on all things Alloy and many examples to help you get started.
Alloy consists of a number of crates that provide a range of functionality essential for interfacing with any Ethereum-based blockchain.
The easiest way to get started is to add the alloy crate with the full feature flag from the command-line using Cargo:
cargo add alloy --features fullAlternatively, you can add the following to your Cargo.toml file:
alloy = { version = "0.1", features = ["full"] }For a more fine-grained control over the features you wish to include, you can add the individual crates to your Cargo.toml file, or use the alloy crate with the features you need.
A comprehensive list of available features can be found on docs.rs or in the alloy crate's Cargo.toml.
This repository contains the following crates:
alloy: Meta-crate for the entire project, includingalloy-corealloy-consensus- Ethereum consensus interfacealloy-contract- Interact with on-chain contractsalloy-eips- Ethereum Improvement Proposal (EIP) implementationsalloy-genesis- Ethereum genesis file definitionsalloy-json-rpc- Core data types for JSON-RPC 2.0 clientsalloy-network- Network abstraction for RPC typesalloy-node-bindings- Ethereum execution-layer client bindingsalloy-provider- Interface with an Ethereum blockchainalloy-pubsub- Ethereum JSON-RPC publish-subscribe tower service and type definitionsalloy-rpc-client- Low-level Ethereum JSON-RPC client implementationalloy-rpc-types- Meta-crate for all Ethereum JSON-RPC typesalloy-rpc-types-admin- Types for theadminEthereum JSON-RPC namespacealloy-rpc-types-anvil- Types for the Anvil development node's Ethereum JSON-RPC namespacealloy-rpc-types-beacon- Types for the Ethereum Beacon Node APIalloy-rpc-types-engine- Types for theengineEthereum JSON-RPC namespacealloy-rpc-types-eth- Types for theethEthereum JSON-RPC namespacealloy-rpc-types-trace- Types for thetraceEthereum JSON-RPC namespacealloy-rpc-types-txpool- Types for thetxpoolEthereum JSON-RPC namespace
alloy-serde- Serde-related utilitiesalloy-signer- Ethereum signer abstractionalloy-signer-aws- AWS KMS signer implementationalloy-signer-gcp- GCP KMS signer implementationalloy-signer-ledger- Ledger signer implementationalloy-signer-local- Local (private key, keystore, mnemonic, YubiHSM) signer implementationsalloy-signer-trezor- Trezor signer implementation
alloy-transport- Low-level Ethereum JSON-RPC transport abstractionalloy-transport-http- HTTP transport implementationalloy-transport-ipc- IPC transport implementationalloy-transport-ws- WS transport implementation
The current MSRV (minimum supported rust version) is 1.76.
Alloy will keep a rolling MSRV policy of at least two versions behind the latest stable release (so if the latest stable release is 1.58, we would support 1.56).
Note that the MSRV is not increased automatically, and only as part of a patch (pre-1.0) or minor (post-1.0) release.
Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the Alloy project.
Pull requests will not be merged unless CI passes, so please ensure that your contribution follows the linting rules and passes clippy.
Because these crates are primarily network-focused, we do not intend to support
no_std for most of them at this time.
The following crates support no_std:
- alloy-eips
- alloy-genesis
- alloy-serde
- alloy-consensus
If you would like to add no_std support to a crate, please make sure to update
scripts/check_no_std.sh as well.
None of these crates would have been possible without the great work done in:
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in these crates by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
