d7ab229a4c
* derive-eip712: initial implementation of eip712 derive macro This commit provides an initial implementation for a derive macro to encode typed data according to EIP-712, https://eips.ethereum.org/EIPS/eip-712 Additionally, this commit introduces a new signer trait method: async fn sign_typed_data<T: Eip712 + Send + Sync>( &self, payload: &T, ) -> Result<Signature, Self::Error>; And implements the new method for each of the signers (wallet, ledger, aws). Additionally, these changes include using `WalletError` for the Wallet signer error type At the moment, derive does not recurse the primary type to find nested Eip712 structs. This is something that is noted in the source and currently responds with an error regarding custom types. A subsequent PR should be opened once this issue becomes needed. For the moment, the current implementation should satisfy non-nested, basic struct types. * rename to ethers-derive-eip712; move to ethers-core * refactor of derive-eip712 macro; use ParamType and EthAbiToken * macro updates; add byte array checker for paramtype; use literal constant for domain type hash * replace std::convert::Infallible with WalletError as Wallet signer error type * update workspace members and dev dependencies for examples folder * add example for eip712 and test against contract * remove extraneous backward slash in '\x19\x01' prefix; example tests pass * update unreleased change log * remove print statements * use parse_macro_input macro; remove dead code; handle nest struct not implemented error * move eip712 example to solidity-contract tests folder; update cargo workspace dependencies * allow optional EIP712Domain parameter when encoding eip712 struct and signing typed data * add documentation for eip712 feature * Update ethers-signers/src/ledger/mod.rs Co-authored-by: Sebastian Martinez <me@sebastinez.dev> * add error enum for Eip712Error; use sign_payload for ledger signer * add EIP712WithDomain type for providing a wrapper around custom setting of the domain * make LedgerWallet sign_payload public * use optional feature gated dependencies for eip712; add default method for encode_eip712 * add default domain_separator method, pre-compute separator hash * move derive-eip712 deps to dev deps * remove invalid sign payload parameter, add await on async method * remove deprecated comment * debugging 'bad key handle' error for ledger signer try using 'sign_message' * await sign digest for aws signer * remove extra space, fix fmt warning * fix test, fmt errors * use gt 0.6.0 pragma compiler version * enable ABIEncoderV2 for solidity test contract * chore: make test constructor public Co-authored-by: Sebastian Martinez <me@sebastinez.dev> Co-authored-by: Georgios Konstantopoulos <me@gakonst.com> |
||
|---|---|---|
| .github | ||
| bin | ||
| ethers-contract | ||
| ethers-core | ||
| ethers-etherscan | ||
| ethers-middleware | ||
| ethers-providers | ||
| ethers-signers | ||
| examples | ||
| scripts | ||
| src | ||
| tests | ||
| .gitignore | ||
| CHANGELOG.md | ||
| 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
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:
solc. We also recommend using solc-select for more flexibility.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.
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.
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