89bc6420bb
* ci: install anvil * test: use anvil instead of ganache * ci: fix anvil ver * ci: re-enable example tests * test: remove unnecessary assertions * test: enable anvil launch test * docs: typo * test: fix anvil chain id * ci: install ganache Ganache is needed for the Ganache tests * chore: remove legacy feature from some examples * ci: correctly build examples * test: use correct account balance for anvil * chore: remove sub_id == 1 check this was only possible in ganache because it gives serial sub ids, but in every other reasonable client the ids are generated randomly, so we cannot test for its value * test: ensure txs are different There is a bug in Ganache's mempool which accepts duplicate transactions (here with the same nonce), whereas here we pre-set all the nonces so that they end up having a different transaction hash. * test: ignore ganache tests * fix: terzor api changes * ci(examples): install Anvil, remove geth/ganache * test(provider): Anvil instead of Geth some tests start to fail now * fix: revert usage of Anvil in ipc tests Anvil does not support IPC yet * fix: update examples script * ci: use anvil for wasm example * replace last ganache usage Co-authored-by: Oliver Nordbjerg <hi@notbjerg.me> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com> |
||
|---|---|---|
| .cargo | ||
| .github | ||
| assets | ||
| bin | ||
| ethers-addressbook | ||
| ethers-contract | ||
| ethers-core | ||
| ethers-etherscan | ||
| ethers-middleware | ||
| ethers-providers | ||
| ethers-signers | ||
| ethers-solc | ||
| examples | ||
| scripts | ||
| src | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| 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
You can also run any of the examples by executing: cargo run -p ethers --example <name>
Add ethers-rs to your repository
[dependencies]
ethers = { git = "https://github.com/gakonst/ethers-rs" }
Running the tests
Tests require the following installed:
solc(>=0.8.10). We also recommend using solc-select for more flexibility.anvilgeth
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 = { git = "https://github.com/gakonst/ethers-rs", 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 = { git = "https://github.com/gakonst/ethers-rs", 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
Streams - 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
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 if
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 possibly 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