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

Overview

This repository contains the following examples:

• Big numbers
  • Comparison and equivalence
  • Conversion
  • Creating Instances
  • Math operations
  • Math utilities
• Contracts
  • Deploy from artifact
  • Deploy from bytecode
  • Deploy from contract
  • Interact with ABI
  • Interact with contract instance
  • Decode custom JSON-RPC errors
  • Handle unknown return types using DynSol
• Fillers (Middleware)
  • Gas estimation filler
  • Nonce management filler
  • Recommended fillers
  • Wallet management filler
• Layers
  • Request / response logging layer
  • Retry-backoff layer
• Node Bindings
  • Deploy contract on local Anvil instance
  • Fork instance on Anvil
  • Fork provider on Anvil
  • Local instance on Anvil
  • Local provider on Anvil
  • Local provider on Geth
  • Local provider on Reth
  • Mock WETH balance with Anvil
• Primitives
  • Bytes and address types
  • Hashing functions
• Subscriptions
  • Subscribe and watch blocks
  • Watch and poll for contract event logs
  • Subscribe and listen for specific contract event logs
  • Subscribe and listen for all contract event logs
  • Subscribe and listen to pending transactions in the public mempool
  • Event multiplexer
• Providers
  • Builder
  • Builtin
  • HTTP with authentication
  • HTTP
  • IPC
  • WS
  • WS with authentication
• Queries
  • Query contract storage
  • Query contract deployed bytecode
  • Query logs
• sol! macro
  • Contracts
  • Events and errors
  • Decode returns
  • Structs and enums
  • User defined types
• Transactions
  • Decode input
  • Encode and decode EIP-1559 transaction
  • Get gas price in USD
  • Trace call
  • Trace transaction
  • Transfer ERC20 token
  • Transfer ETH
  • Sign and send a raw transaction
  • Send EIP-1559 transaction
  • Send legacy transaction
  • Send EIP-4844 transaction
  • Send EIP-7702 transaction
  • Send private transaction using Flashbots Protect
  • Send transaction with access list
• Wallets
  • AWS signer
  • Ledger signer
  • Private key signer
  • Mnemonic signer
  • Sign message
  • Verify message
  • Sign permit hash
  • Trezor signer
  • Yubi signer
  • Keystore signer
  • Create keystore
• Advanced
  • AnyNetwork
  • Decoding with json_abi
  • Encoding with dyn_abi
  • Static encoding with sol!
  • Using foundry-fork-db
  • Wrapping Provider trait over reth-db
• Comparison
  • Compare block headers between providers
  • Compare pending transactions between providers

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