Complete Ethereum & Celo library and wallet implementation in Rust. https://docs.rs/ethers
Go to file
Matthias Seitz 44bb02f857
feat: substitute overloaded functions (#501)
* feat: substitute overloaded functions

* chore: update changelog
2021-10-13 12:53:43 +03:00
.github ci: add cache 2021-09-13 23:48:03 +03:00
bin docs: add contributing.md 2020-06-15 18:05:29 +03:00
ethers-contract feat: substitute overloaded functions (#501) 2021-10-13 12:53:43 +03:00
ethers-core chore(deps): bump thiserror from 1.0.29 to 1.0.30 (#500) 2021-10-11 15:42:55 +03:00
ethers-etherscan chore: remove unused && cargo fix (#496) 2021-10-10 09:31:34 +01:00
ethers-middleware chore(deps): bump thiserror from 1.0.29 to 1.0.30 (#500) 2021-10-11 15:42:55 +03:00
ethers-providers chore(deps): bump thiserror from 1.0.29 to 1.0.30 (#500) 2021-10-11 15:42:55 +03:00
ethers-signers chore(deps): bump thiserror from 1.0.29 to 1.0.30 (#500) 2021-10-11 15:42:55 +03:00
examples chore: simplify eip712 example (#492) 2021-10-08 17:31:42 +01:00
scripts ci: run examples in CI (#421) 2021-08-30 14:00:30 +03:00
src docs: fix broken ethers-js link (#475) 2021-09-28 22:40:36 +03:00
tests chore: pull ethers to top level directory (#398) 2021-08-21 15:34:21 +03:00
.gitignore derive-eip712: initial implementation of eip712 derive macro (#481) 2021-10-08 16:22:51 +01:00
CHANGELOG.md feat: substitute overloaded functions (#501) 2021-10-13 12:53:43 +03:00
CONTRIBUTING.md fix cargo fmt command in Contributing.md (#437) 2021-09-09 08:36:26 +03:00
Cargo.lock chore(deps): bump thiserror from 1.0.29 to 1.0.30 (#500) 2021-10-11 15:42:55 +03:00
Cargo.toml chore: simplify eip712 example (#492) 2021-10-08 17:31:42 +01:00
LICENSE-APACHE Dual license under MIT/Apache 2 (#28) 2020-06-18 08:20:20 +03:00
LICENSE-MIT Dual license under MIT/Apache 2 (#28) 2020-06-18 08:20:20 +03:00
README.md chore: add changelog (#424) 2021-08-31 13:52:11 +03:00

README.md

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

[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:

[dependencies]

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

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
  • Websockets / eth_subscribe
  • Hardware Wallet Support
  • Parity APIs (tracing, parity_blockWithReceipts)
  • Geth TxPool API
  • WASM Bindings
  • FFI Bindings
  • CLI for common operations

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.

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