ethers.rs

Complete Ethereum and Celo wallet implementation and utilities in Rust

Github Actions

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

```toml [dependencies]

ethers = { git = "https://github.com/gakonst/ethers-rs" } ```

Running the tests

Tests require the following installed: 1. solc. We also recommend using solc-select for more flexibility. 2. ganache-cli

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:

```toml [dependencies]

ethers = { git = "https://github.com/gakonst/ethers-rs", features = ["legacy"] } ```

Celo Support

Celo support is turned on via the feature-flag celo:

```toml [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

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.

Related Projects

This library would not have been possibly without the great work done in: - ethers.js - rust-web3 - ethcontract-rs - guac_rs

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