10310ce3ad
* ToC * Big numbers section * Middleware examples: builder * Middleware examples: gas_escalator * Middleware examples: gas_oracle * Middleware examples: signer * Middleware examples: missing stubs * review: applied DaniPopes suggestions to big numbers * typo * Middleware examples: nonce_manager * cargo +nightly fmt * update roadmap * Middleware examples: policy * Middleware examples: added docs * Contracts examples: created folder; included abigen example * Contracts examples: refactor abigen docs. Fixed cargo example reference * Contracts examples: contract_events; minor docs changes * Moved each example under its own crate. Cargo builds locally TODO: Fix broken examples CI * Big numbers examples: used regular operators for math * Single examples run correctly (missing overall CI execution) Example crates dependencies Removed duplicates * review: Applied gakonst note to remove commented items in workspace manifest * review: Applied gakonst note to restore visibility on contract constructor * ci: - Run/Build examples in a single step to avoid duplicated scripts - Removed ci.yaml step "Build all examples" * cargo +nightly fmt * ci: fix WASM step error * Removed deprecated EthGasStation example * WASM example uses local copy of `contract_abi.json`. In this way we keep the WASM example auto-consistent, at the cost of a small duplication * Cargo.lock aligned to master branch * Removed useless comments in examples * review: Applied gakonst note to add panic!() on the policy middleware example * review: Applied gakonst suggestion to add a custom middleware example * typos in docs * Update examples/big-numbers/examples/bn_math_operations.rs review: Accepted commit suggested by DaniPopes Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * review: Applied DaniPopes suggestion on assert_eq! * Update examples/big-numbers/README.md review: Accepted DaniPopes suggestion on big-numbers docs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * review: All imports now reference the "ethers" crate * ci: added features ["ws", "rustls"] where needed cargo +nigthly fmt * Examples with special features (e.g. ipc, trezor etc.) are built alongside them. This is expressed as a "default" requirement in their respective Cargo.toml * cargo +nightly fmt * Examples: Gas oracle API keys from env Added missing features in middleware Cargo.toml * typo: use expect() instead of unwrap() * Updated ToC Moved 2 examples under more relevant folders * Gas oracle examples raise panic on middleware errors * review: removed useless [[example]] in Cargo.toml * review: removed #[allow(unused_must_use)] from gas_escalator example * review: Removed prefixes from file names * review: removed useless [[example]] in Cargo.toml * docs: Updated description to run examples in the workspace README.md Co-authored-by: Andrea Simeoni <> Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> |
||
---|---|---|
.cargo | ||
.github | ||
assets | ||
bin | ||
ethers-addressbook | ||
ethers-contract | ||
ethers-core | ||
ethers-etherscan | ||
ethers-middleware | ||
ethers-providers | ||
ethers-signers | ||
ethers-solc | ||
examples | ||
scripts | ||
src | ||
.clippy.toml | ||
.gitattributes | ||
.gitignore | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
Cargo.lock | ||
Cargo.toml | ||
LICENSE-APACHE | ||
LICENSE-MIT | ||
README.md | ||
flake.lock | ||
flake.nix | ||
release.toml | ||
rustfmt.toml |
README.md
ethers.rs
Complete Ethereum and Celo wallet implementation and utilities in Rust
Documentation
Extensive documentation and examples are available here.
Alternatively, you may clone the repository and run cd ethers/ && cargo doc --open
Examples are organized into individual crates under the /examples
folder.
You can run any of the examples by executing:
# cargo run -p <example-crate-name> --example <name>
cargo run -p examples-big-numbers --example math_operations
Add ethers-rs to your repository
[dependencies]
ethers = "1.0.0"
Running the tests
Tests require the following installed:
solc
(>=0.8.10). We also recommend using solc-select for more flexibility.anvil
geth
In addition, it is recommended that you set the ETHERSCAN_API_KEY
environment variable
for the abigen via Etherscan tests.
You can get one here.
EVM-compatible chains support
There are many chains live which are Ethereum JSON-RPC & EVM compatible, but do not yet have
support for EIP-2718 Typed Transactions. This means
that transactions submitted to them by default in ethers-rs will have invalid serialization. To
address that, you must use the legacy
feature flag:
[dependencies]
ethers = { version = "1.0.0", features = ["legacy"] }
Polygon support
There is abigen support for Polygon and the Mumbai test network. It is recommended that you set the POLYGONSCAN_API_KEY
environment variable.
You can get one here.
Avalanche support
There is abigen support for Avalanche and the Fuji test network. It is recommended that you set the SNOWTRACE_API_KEY
environment variable.
You can get one here.
Celo Support
Celo support is turned on via the feature-flag celo
:
[dependencies]
ethers = { version = "1.0.0", features = ["celo"] }
Celo's transactions differ from Ethereum transactions by including 3 new fields:
fee_currency
: The currency fees are paid in (None for CELO, otherwise it's an Address)gateway_fee_recipient
: The address of the fee recipient (None for no gateway fee paid)gateway_fee
: Gateway fee amount (None for no gateway fee paid)
The feature flag enables these additional fields in the transaction request builders and in the transactions which are fetched over JSON-RPC.
Features
- Ethereum JSON-RPC Client
- Interacting and deploying smart contracts
- Type safe smart contract bindings code generation
- Querying past events
- Event monitoring as
Stream
s - ENS as a first class citizen
- Celo support
- Polygon support
- Avalanche support
- Websockets /
eth_subscribe
- Hardware Wallet Support
- Parity APIs (
tracing
,parity_blockWithReceipts
) - Geth TxPool API
- WASM Bindings (see note)
- FFI Bindings (see note)
- CLI for common operations
Websockets
Websockets support is turned on via the feature-flag ws
:
[dependencies]
ethers = { version = "1.0.0", features = ["ws"] }
Interprocess Communication (IPC)
IPC support is turned on via the feature-flag ipc
:
[dependencies]
ethers = { version = "1.0.0", features = ["ipc"] }
HTTP Secure (HTTPS)
If you are looking to connect to a HTTPS endpoint, then you need to enable the rustls
or openssl
feature.
feature-flags.
To enable rustls
:
[dependencies]
ethers = { version = "1.0.0", features = ["rustls"] }
To enable openssl
:
[dependencies]
ethers = { version = "1.0.0", features = ["openssl"] }
Note on WASM and FFI bindings
You should be able to build a wasm app that uses ethers-rs (see the example for reference). If ethers fails to compile in WASM, please open an issue. There is currently no plan to provide an official JS/TS-accessible library interface. we believe ethers.js serves that need very well.
Similarly, you should be able to build FFI bindings to ethers-rs. If ethers fails to compile in c lib formats, please open an issue. There is currently no plan to provide official FFI bindings, and as ethers-rs is not yet stable 1.0.0, its interface may change significantly between versions.
Getting Help
First, see if the answer to your question can be found in the API documentation. If the answer is not there, try opening an issue with the question.
Join the ethers-rs telegram to chat with the community!
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 ethers-rs project.
If you make a Pull Request, do not forget to add your changes in the CHANGELOG and ensure your code is
properly formatted with cargo +nightly fmt
and clippy is happy cargo clippy
, you can even try to let clippy fix simple
issues itself: cargo +nightly clippy --fix -Z unstable-options
Related Projects
This library would not have been possible without the great work done in:
A lot of the code was inspired and adapted from them, to a unified and opinionated interface, built with async/await and std futures from the ground up.
Projects using ethers-rs
- Yield Liquidator: Liquidator for Yield Protocol
- MEV Inspect: Miner Extractable Value inspector
- Ethers Flashbots: Ethers middleware for Flashbots
- Ethers Fireblocks: Ethers middleware and signer for Fireblocks' API
- Celo Threshold BLS DKG: CLI for using Celo as a data availability network for the Joint-Feldman BLS DKG
- Celo Plumo Prover: Creates Celo's ultralight client proof from on-chain data
- Celo SNARK Setup Coordinator: Coordinator for executing a pipelined Groth16 SNARK setup