Alloy Examples

These examples demonstrate the main features of alloy and alloy-core as well as how to use them.

Usage

To run an example, use the command cargo run --example <Example>:

cargo run --example mnemonic_signer

Examples that query a live network or fork it with Anvil require you to supply an endpoint:

RPC_URL=https://your-ethereum-endpoint cargo run --example http

WebSocket and IPC examples use WS_URL and IPC_PATH, respectively. Examples with authentication also list their required credential variables in the error they return.

The fallback-layer example accepts a comma-separated list instead:

RPC_URLS=https://first-endpoint,https://second-endpoint cargo run --example fallback_layer

Use an endpoint for the network named by the example. For example, any_network expects an Arbitrum Sepolia endpoint, while mainnet contract and ENS examples expect Ethereum mainnet. Examples that fork a network also require anvil in PATH. Hardware-wallet and cloud-signer examples require the device or credentials described in their source code.

For programmatic discovery, examples-index.json lists every example with its summary, source path, exact command, network, environment variables, binaries, services, and hardware requirements. The index is generated from Cargo metadata and the example source files.

Overview

This repository contains the following examples:

• [x] Big numbers
• [x] Comparison and equivalence
• [x] Conversion
• [x] Creating Instances
• [x] Math operations
• [x] Math utilities
• [x] Comparison
• [x] Compare block headers between providers
• [x] Compare pending transactions between providers
• [x] Contracts
• [x] Deploy from artifact
• [x] Deploy from bytecode
• [x] Deploy from contract
• [x] Deploy and link library
• [x] Interact with ABI
• [x] Interact with contract instance
• [x] Remove liquidity from a Uniswap V2-compatible pair
• [x] Decode custom JSON-RPC errors
• [x] Decode revert data into custom errors
• [x] Handle unknown return types using DynSol
• [x] Simple arbitrage profit calculator for WETH/DAI pools
• [x] Simulate an arbitrage between Uniswap V2 and Sushiswap
• [x] ENS
• [x] Look up ENS name from Ethereum address
• [x] Resolving ENS name to Ethereum address
• [x] Fillers (Middleware)
• [x] Gas estimation filler
• [x] Nonce management filler
• [x] Recommended fillers
• [x] Wallet management filler
• [x] Custom gas priority filler
• [x] Layers
• [x] Hyper layer transport
• [x] Request / response logging layer
• [x] Retry-backoff layer
• [x] Fallback layer
• [x] Delay layer
• [x] Node Bindings
• [x] Deploy contract on local Anvil instance
• [x] Fork instance on Anvil
• [x] Fork provider on Anvil
• [x] Local instance on Anvil
• [x] Local provider on Anvil
• [x] Local provider on Geth
• [x] Local provider on Reth
• [x] Mock WETH balance with Anvil
• [x] Primitives
• [x] Bytes and address types
• [x] Hashing functions
• [x] Providers
• [x] Builder
• [x] Builtin
• [x] HTTP with authentication
• [x] HTTP
• [x] IPC
• [x] Mocking a Provider
• [x] Wrapping a Provider
• [x] DynProvider
• [x] Multicall Batching Layer
• [x] Multicall Builder
• [x] WS
• [x] WS with authentication
• [x] WS with configurable reconnects
• [x] JSON-RPC Batch Request
• [x] Consensus x RPC types unification
• [x] Basic provider with no fillers
• [x] Queries
• [x] Query contract storage
• [x] Query contract deployed bytecode
• [x] Query logs
• [x] Query logs in chunks
• [x] sol! macro
• [x] Contracts
• [x] Events and errors
• [x] Decode returns
• [x] Structs and enums
• [x] User defined types
• [x] all_derives attribute
• [x] extra_derives attribute
• [x] Subscriptions
• [x] Subscribe and watch blocks
• [x] Resume a canonical block stream
• [x] Resume a canonical log stream
• [x] Watch and poll for contract event logs
• [x] Subscribe and listen for specific contract event logs
• [x] Subscribe and listen for all contract event logs
• [x] Subscribe and listen to pending transactions in the public mempool
• [x] Event multiplexer
• [x] Transactions
• [x] Decode input
• [x] Decode a receipt log
• [x] Encode and decode transaction envelopes
• [x] Encode and decode receipt envelopes
• [x] Get gas price in USD
• [x] Simulate using debug_traceCallMany
• [x] Simulate using trace_callMany
• [x] Trace call
• [x] Trace transaction
• [x] Transfer ERC20 token
• [x] Transfer ERC20 token using a signed permit
• [x] Transfer ETH
• [x] Sign and send a raw transaction
• [x] Send legacy transaction
• [x] Send EIP-1559 transaction
• [x] Send EIP-4844 transaction
• [x] Send EIP-7594 transaction
• [x] Send EIP-7702 transaction
• [x] Send private transaction using Flashbots Protect
• [x] Send transaction with access list
• [x] Wallets
• [x] AWS signer
• [x] GCP signer
• [x] Ledger signer
• [x] Private key signer
• [x] Mnemonic signer
• [x] Ethereum Wallet
• [x] Sign message
• [x] Verify message
• [x] Sign permit hash
• [x] Trezor signer
• [x] Turnkey signer
• [x] Yubi signer
• [x] Keystore signer
• [x] Create keystore
• [x] Advanced
• [x] AnyNetwork
• [x] Decoding with json_abi
• [x] Encoding with dyn_abi
• [x] Static encoding with sol!
• [x] Using foundry-fork-db
• [x] Uniswap V2 arbitrage profit calculation using Alloy
• [x] Uniswap V2 arbitrage profit calculation using Ethers
• [x] Uniswap V2 arbitrage simulation

Contributing

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.

License

^{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.}