Skip to content

Installation

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 from the command-line using Cargo:

cargo add alloy

Alternatively, you can add the following to your Cargo.toml file:

alloy = "1.0"

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.

After alloy is added as a dependency you can now import alloy as follows:

use alloy::{
    network::EthereumWallet,
    node_bindings::Anvil,
    primitives::U256,
    providers::ProviderBuilder,
    signers::local::PrivateKeySigner,
    sol,
};

Features

The alloy meta-crate defines a number of feature flags:

Default

  • std
  • reqwest
  • alloy-core/default
  • essentials

Essentials

  • essentials:
    • contract
    • provider-http
    • rpc-types
    • signer-local

Full, a set of the most commonly used flags to get started with alloy.

  • full:
    • consensus
    • eips
    • essentials
    • k256
    • kzg
    • network
    • provider-ws
    • provider-ipc
    • provider-trace-api
    • provider-txpool-api
    • provider-debug-api
    • provider-anvil-api
    • pubsub

By default alloy uses reqwest as HTTP client. Alternatively one can switch to hyper. The reqwest and hyper feature flags are mutually exclusive.

A complete list of available features can be found on docs.rs or in the alloy crate's Cargo.toml.

The feature flags largely correspond with and enable features from the following individual crates.

Crates

alloy consists out of the following crates:

alloy-core consists out of the following crates: