Complete Ethereum & Celo library and wallet implementation in Rust. https://docs.rs/ethers
Go to file
Georgios Konstantopoulos 1ece5d2020
Contract & Provider eth_subscribe support (#100)
* fix(block): fix block decoding from ws

* feat(pubsub): add pubsub traits and sub stream

Also use DeserializeOwned alias

* feat(transports): add notification type

* feat(ws): rewrite Ws for subscription support

* feat(provider): add eth_subscribe

* fix(celo): disable some celo tests due to ganache incompatibilities

* test(rinkeby): fix flaky test

* feat(contract): WS subscription bindings (#101)

* feat(middleware): add subscriptions to middleware methods

* feat(contract): add subscribe method to contracts
2020-11-30 11:33:06 +02:00
.github feat: add a mock transport (#99) 2020-11-27 14:57:44 +02:00
bin docs: add contributing.md 2020-06-15 18:05:29 +03:00
ethers feat: allow encoding/decoding function data (#90) 2020-10-29 09:48:24 +02:00
ethers-contract Contract & Provider eth_subscribe support (#100) 2020-11-30 11:33:06 +02:00
ethers-core Contract & Provider eth_subscribe support (#100) 2020-11-30 11:33:06 +02:00
ethers-middleware Contract & Provider eth_subscribe support (#100) 2020-11-30 11:33:06 +02:00
ethers-providers Contract & Provider eth_subscribe support (#100) 2020-11-30 11:33:06 +02:00
ethers-signers feat: Transaction Gas Price Escalator middleware (#81) 2020-10-08 18:56:36 +03:00
.gitignore lock 2020-05-24 19:33:24 +03:00
CONTRIBUTING.md docs: add contributing.md 2020-06-15 18:05:29 +03:00
Cargo.lock Contract & Provider eth_subscribe support (#100) 2020-11-30 11:33:06 +02:00
Cargo.toml feature: Middleware Architecture (#65) 2020-09-25 00:33:09 +03: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 Update README.md 2020-11-23 10:43:30 +02: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

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
  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.

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.

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.

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.