1ece5d2020
* 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 |
||
|---|---|---|
| .github | ||
| bin | ||
| ethers | ||
| ethers-contract | ||
| ethers-core | ||
| ethers-middleware | ||
| ethers-providers | ||
| ethers-signers | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
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
Add ethers-rs to your repository
[dependencies]
ethers = { git = "https://github.com/gakonst/ethers-rs" }
Running the tests
Tests require the following installed:
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.
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.