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.
ethers-rs will continue to be maintained until we have achieved
feature-parity in Alloy. No action is currently needed from developers.
Currently, Alloy is not hosted on crates.io, the Rust package registry.
To incorporate Alloy into your project, you will need to specify the GitHub repository as the source. This can be achieved by executing the following command in your terminal:
cargo add alloy --git https://github.com/alloy-rs/alloyAfter incorporating Alloy, you may wish to utilize specific features of the crate. These features can be enabled through modifications in your project's Cargo.toml file. A comprehensive list of available features can be found at this GitHub link.
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-anvil- RPC types for the Anvil development node.alloy-rpc-types-beacon- Ethereum RPC-related types for the Beacon API.alloy-rpc-types-engine- Ethereum execution-consensus layer (engine) API RPC typesalloy-rpc-types-eth- Ethereum RPC-related types for Alloy.alloy-rpc-types-trace- Ethereum RPC trace types
alloy-serde- Serde related helpers for Alloy.alloy-signer- Ethereum signer abstractionalloy-signer-aws- AWS KMS signer implementationalloy-signer-gcp- GCP KMS signer implementationalloy-signer-ledger- Ledger signer implementationalloy-signer-trezor- Trezor signer implementationalloy-signer-wallet- Local wallet (Keystore/Mnemonic/Yubihsm) 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
Alloy will keep a rolling MSRV (minimum supported rust version) policy of at least 6 months. When increasing the MSRV, the new Rust version must have been released at least six months ago. The current MSRV is 1.76.
Note that the MSRV is not increased automatically, and only as part of a minor 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.