repository·main·Indexed 42 days ago
https://github.com/alloy-rs/examplesA collection of practical examples and performance benchmarks for the alloy and alloy-core libraries. Covers Ethereum development tasks including contract interaction via the sol! macro, transaction management (EIP-1559, EIP-4844, EIP-7702), provider configuration (HTTP, WS, IPC), wallet signers, and ENS resolution. Includes benchmarks for ABI encoding, RLP, and U256 operations comparing Alloy against Ethers and EthAbi.
Alloy provides performance comparisons against other common Ethereum libraries (such as Ethers, EthAbi, Parity-Rlp) across several critical operations. Key performance advantages include:
Static encoding (up to 12.32x).Serialize performance (up to 20.29x faster).Encoding and Decoding compared to Parity-Rlp.amountIn and amountOut compared to Ethers.The examples are organized into several functional categories to help you find specific implementation patterns:
sol! macro: Using the macro for contracts, events, errors, and complex types like structs and enums.dyn_abi and json_abi.Many examples require a connection to a live network or a local fork. You must provide the connection details via environment variables depending on the protocol used:
RPC_URL.WS_URL.IPC_PATH.RPC_URLS with a comma-separated list of endpoints.Note on Networks: Ensure the endpoint matches the network expected by the specific example. For instance, any_network expects an Arbitrum Sepolia endpoint, while mainnet contract and ENS examples expect Ethereum mainnet.
# HTTP example
RPC_URL=https://your-ethereum-endpoint cargo run --example http
# WebSocket example
WS_URL=wss://your-websocket-endpoint cargo run --example <example_name>
# IPC example
IPC_PATH=/tmp/eth.ipc cargo run --example <example_name>
# Fallback layer with multiple endpoints
RPC_URLS=https://first-endpoint,https://second-endpoint cargo run --example fallback_layerTo execute a specific example from the repository, use the cargo run command with the --example flag followed by the name of the example.
cargo run --example mnemonic_signerserde to serialize and deserialize large function signatures compared to EthAbi. Specifically, serialization of large signatures is significantly faster in Alloy.Alloy provides high-performance ABI encoding for both static and dynamic function calls. In benchmarks comparing the Uniswap V2 swap function against Ethers, Alloy demonstrates significant speed advantages, particularly in static encoding.
function swap(uint amount0Out, uint amount1Out, address to, bytes calldata data) external;U256 implementation is optimized for high-speed arithmetic operations. Benchmarks using Uniswap V2 swap calculations (computing amountIn and amountOut) show that Alloy is significantly faster than comparable implementations.ethabi using complex contract structures like Seaport, Uniswap V4 Pool Manager, and Uniswap V3 Pool. While performance varies by contract type, Alloy remains competitive in serialization and deserialization tasks.Alloy's RLP (Recursive Length Prefix) implementation is designed for high performance. To use Alloy's RLP capabilities, derive the alloy_rlp::RlpEncodable and alloy_rlp::RlpDecodable traits on your structs. Benchmarks against Parity-Rlp show Alloy is faster for both encoding and decoding.
#[derive(alloy_rlp::RlpEncodable, alloy_rlp::RlpDecodable, rlp_derive::RlpDecodable, rlp_derive::RlpEncodable)]
pub struct MyStruct {
pub a: u128,
pub b: Vec<u8>,
}For automated discovery or programmatic access to the available examples, use the examples-index.json file. This index is generated from Cargo metadata and contains the following information for every example:
The get_amount_in function calculates the required amount_in to receive a specific amount of output, given the current reserves and token ordering.
use alloy::primitives::U256;
use helpers::get_amount_in;
let amount_in = get_amount_in(
reserves00, // reserves00
reserves01, // reserves01
is_weth0, // is_weth0
reserves10, // reserves10
reserves11, // reserves11
);