4b685621ed
* tell Geth to expose the admin namespace * wip: add admin namespace support * add networking and peer related structs * add rest of chain config fields * add datadir to geth * fix data dir ref * add dev flag to geth * set dev only if block_time is not set * put mutually exclusive options in an enum * make block_time use the devmode enum * add p2p port to geth * add basic impls for admin endpoints * move from_int_or_hex to ethers-core utils * fix nodeinfo protocol field * the type is better represented by a struct which can have either eth or snap * add chain id and discovery toggle for Geth * remove PeerEvent * should re-add when peer event endpoints are implemented * simplify serde options for admin responses * change signature for peer modification apis * these admin apis accept an enode, which _may_ be an enr, but could also be a legacy enode "v4" url. * add note on where `ChainConfig` fields come from * add note on PeerInfo about the source of fields * add admin namespace support to CHANGELOG * update pr number in changelog * cargo fmt * move chainconfig to genesis in utils * accept genesis file in geth * add genesis writing to geth spawn * finally get geth nodes to connect * import io::Read in provider tests * fix PeerInfo and use enode id for provider test * make clippy happy * improve documentation for genesis module * remove not(wasm) attributes on genesis module * remove debugging printlns * remove io::Read from provider tests * add failing post merge test case * add full mainnet nodeinfo for testing * support deserializing json bignums to U256 * the serde_json arbitrary_precision feature is necessary so the serde_json::Number variant of `IntOrHexOrBigNum` can be converted into a string and fed into U256::from_dec_string * fix from_int_or_hex_opt doc string * remove third variant from IntOrHex * unnecessary since serde_json::Number handles smaller ints as well * add comments for ids * fix enode id type in admin_peers provider test * fix admin typo in Cargo.toml Co-authored-by: Georgios Konstantopoulos <me@gakonst.com> * add method to wait on a gethinstance adding a peer * fix dial loop and wait_to_add_peer doc comments * update geth * the build can be updated by changing the GETH_BUILD env var * wait for geth to exit on drop * remove unnecessary wait * fix mid-handshake PeerInfo deserialization * remove println * make tests less flaky * handle discovery with the rest of the non dev opts * dump geth stderr to debug failing ci test * add method which dumps the unread stderr of the geth instance into a string * remove call_raw debug println * bug is due to authrpc endpoint being in use * use unused port when authrpc port is not specified * remove dump_stderr from GethInstance * did not work properly anyways 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 | ||
| .clippy.toml | ||
| .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 = "1.0.0"
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 = { 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
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
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