2021-08-31 10:52:11 +00:00
# Changelog
## ethers-core
2021-11-29 14:31:39 +00:00
### Unreleased
2022-12-22 18:59:20 +00:00
2022-12-19 15:54:24 +00:00
-
2022-12-22 18:59:20 +00:00
- Fix typo in `RwClient` docs for `write_client` method.
2022-12-02 20:12:14 +00:00
- Graceful handling of WebSocket transport errors [#1889 ](https://github.com/gakonst/ethers-rs/issues/1889 ) [#1815 ](https://github.com/gakonst/ethers-rs/issues/1815 )
- `MiddlewareBuilder` trait to instantiate a `Provider` as `Middleware` layers.
- An `Event` builder can be instantiated specifying the event filter type, without the need to instantiate a contract.
- Add 'ethers_core::types::OpCode' and use in 'ethers_core::types::VMOperation' [#1857 ](https://github.com/gakonst/ethers-rs/issues/1857 )
- Remove rust_decimals dependency for ethers-core
- Add support for numbers greater than 2^96 for `ethers_core::utils::parse_units` [#1822 ](https://github.com/gakonst/ethers-rs/issues/1822 )
- Add comment about safety of u8 -> u64 cast in `ethers_core::types::Signature`
- Stop defaulting to the `"latest"` block in `eth_estimateGas` params [#1657 ](https://github.com/gakonst/ethers-rs/pull/1657 )
- Fix geth trace types for debug_traceTransaction rpc
- Fix RLP decoding of legacy `Transaction`
- Fix RLP encoding of `TransactionReceipt` [#1661 ](https://github.com/gakonst/ethers-rs/pull/1661 )
- Add `Unit8` helper type [#1639 ](https://github.com/gakonst/ethers-rs/pull/1639 )
- Add `evm.deployedBytecode.immutableReferences` output selector [#1523 ](https://github.com/gakonst/ethers-rs/pull/1523 )
- Added `get_erc1155_token_transfer_events` function for etherscan client [#1503 ](https://github.com/gakonst/ethers-rs/pull/1503 )
- Add support for Geth `debug_traceTransaction` [#1469 ](https://github.com/gakonst/ethers-rs/pull/1469 )
- Use correct, new transaction type for `typool_content` RPC endpoint [#1501 ](https://github.com/gakonst/ethers-rs/pull/1501 )
- Fix the default config for generated `BuildInfo` [#1458 ](https://github.com/gakonst/ethers-rs/pull/1458 )
- Allow configuration of the output directory of the generated `BuildInfo` [#1433 ](https://github.com/gakonst/ethers-rs/pull/1433 )
- capture unknown fields in `Block` and `Transaction` type via new `OtherFields` type [#1423 ](https://github.com/gakonst/ethers-rs/pull/1423 )
- Methods like `set_to()` from `TypedTransaction` can be chained
- Use H64 for Block Nonce [#1396 ](https://github.com/gakonst/ethers-rs/pull/1396 )
- Add `as_*_mut` methods on `TypedTransaction`
[#1310 ](https://github.com/gakonst/ethers-rs/pull/1310 )
- AWS EIP712 data signing no longer signs with EIP155
- Added Cronos testnet to etherscan options [#1276 ](https://github.com/gakonst/ethers-rs/pull/1276 )
- Fix parsing of a pending block
[#1272 ](https://github.com/gakonst/ethers-rs/pull/1272 )
- Removed Cronos mainnet beta from `is_legacy` [1246 ](https://github.com/gakonst/ethers-rs/pull/1246 )
- Fix RLP decoding of `from` field for `Eip1559TransactionRequest` and
`Eip2930TransactionRequest` , remove `Eip1559TransactionRequest` `sighash`
method [#1180 ](https://github.com/gakonst/ethers-rs/pull/1180 )
- Fix RLP encoding of absent access list in `Transaction` [1137 ](https://github.com/gakonst/ethers-rs/pull/1137 )
- Pass compilation time as additional argument to `Reporter::on_solc_success` [#1098 ](https://github.com/gakonst/ethers-rs/pull/1098 )
- Fix aws signer bug which maps un-normalized signature to error if no normalization occurs (in `aws::utils::decode_signature` )
- Implement signed transaction RLP decoding [#1096 ](https://github.com/gakonst/ethers-rs/pull/1096 )
- `Transaction::from` will default to `Address::zero()` . Add `recover_from` and
`recover_from_mut` methods for recovering the sender from signature, and also
setting the same on tx [#1075 ](https://github.com/gakonst/ethers-rs/pull/1075 ).
- Add Etherscan account API endpoints [#939 ](https://github.com/gakonst/ethers-rs/pull/939 )
- Add FTM Mainet and testnet to parse method "try_from" from Chain.rs and add cronos mainet and testnet to "from_str"
- Add FTM mainnet and testnet Multicall addresses [#927 ](https://github.com/gakonst/ethers-rs/pull/927 )
- Add Cronos mainnet beta and testnet to the list of known chains
[#926 ](https://github.com/gakonst/ethers-rs/pull/926 )
- `Chain::to_string` will return the same chain name as `Chain::from_str`
- Add `eth_syncing` [#848 ](https://github.com/gakonst/ethers-rs/pull/848 )
- Fix overflow and possible divide-by-zero in `estimate_priority_fee`
- Add BSC mainnet and testnet to the list of known chains
[#831 ](https://github.com/gakonst/ethers-rs/pull/831 )
- Returns error on invalid type conversion instead of panicking
[#691 ](https://github.com/gakonst/ethers-rs/pull/691/files )
- Change types mapping for solidity `bytes` to rust `ethers::core::Bytes` and
solidity `uint8[]` to rust `Vec<u8>` .
[#613 ](https://github.com/gakonst/ethers-rs/pull/613 )
- Fix `format_units` to return a `String` of representing a decimal point float
such that the decimal places don't get truncated.
[#597 ](https://github.com/gakonst/ethers-rs/pull/597 )
- Implement hex display format for `ethers::core::Bytes`
[#624 ](https://github.com/gakonst/ethers-rs/pull/624 ).
- Fix `fee_history` to first try with `block_count` encoded as a hex `QUANTITY` .
[#668 ](https://github.com/gakonst/ethers-rs/pull/668 )
- Fix `fill_transaction` to set nonces in transactions, if the sender is known
and no nonce is specified
- Move `fill_transaction` implementation to the provider, to allow middleware
to properly override its behavior.
- Add informational messages to solc installation and compilation.
- Significantly refactor `MultiAbigen` module generation. Now allows for lib
generation, and does not make unnecessary disk writes.
[#854 ](https://github.com/gakonst/ethers-rs/pull/852 )
- Refactor `ethers-contract-abigen` to use `eyre` instead of `anyhow` via
[#858 ](https://github.com/gakonst/ethers-rs/pull/858 )
- Add `Deployer.send_with_receipt -> Result<(Contract, Receipt), Error>`
so that the receipt can be returned to the called when deploying
a contract [#865 ](https://github.com/gakonst/ethers-rs/pull/865 )
- Add Arbitrum mainnet and testnet to the list of known chains
- Add ENS avatar and TXT records resolution
[#889 ](https://github.com/gakonst/ethers-rs/pull/889 )
- Do not override gas limits provided by an outer middleware when including an EIP-2930 access list
[#901 ](https://github.com/gakonst/ethers-rs/pull/901 )
- Add a getter to `ProjectCompileOutput` that returns a mapping of compiler
versions to a vector of name + contract struct tuples
[#908 ](https://github.com/gakonst/ethers-rs/pull/908 )
- Add Yul compilation [#994 ](https://github.com/gakonst/ethers-rs/pull/994 )
- Enforce commutativity of ENS reverse resolution
[#996 ](https://github.com/gakonst/ethers-rs/pull/996 )
- Add `TransactionReceipt::to` and `TransactionReceipt::from`
[#1184 ](https://github.com/gakonst/ethers-rs/pull/1184 )
- Add `From<H160>` and From< Vec < H160 > > traits to `ValueOrArray<H160>` [#1199 ](https://github.com/gakonst/ethers-rs/pull/1200 )
- Fix handling of Websocket connection errors [#1287 ](https://github.com/gakonst/ethers-rs/pull/1287 )
- Add Arithmetic Shift Right operation for I256 [#1323 ](https://github.com/gakonst/ethers-rs/issues/1323 )
- [#1535 ](https://github.com/gakonst/ethers-rs/pull/1535 ) Add support to Aurora and Aurora testnet networks.
- [#1632 ](https://github.com/gakonst/ethers-rs/pull/1632 ) Re-export `H32` from `ethabi` .
- [#1634 ](https://github.com/gakonst/ethers-rs/pull/1634 ) Derive missing `Clone` , `Copy` and `Debug` impls in ethers-etherscan.
- Bytes debug format now displays hex literals [#1658 ](https://github.com/gakonst/ethers-rs/pull/1658 )
- [#1451 ](https://github.com/gakonst/ethers-rs/issues/1451 ) Add Arithmetic Shift Left operation for I256
- [#1860 ](https://github.com/gakonst/ethers-rs/pull/1860 ) Update I256 type documentation calling out the inconsistency
between its right shift operator and standard library numeric types.
- [#842 ](https://github.com/gakonst/ethers-rs/issues/842 ) Add support for I256 types in `parse_units` and `format_units` .
Added `twos_complement` function for I256.
2022-12-15 07:47:59 +00:00
- [#1934 ](https://github.com/gakonst/ethers-rs/pull/1934 ) Allow 16 calls in multicall.
2022-12-18 11:05:02 +00:00
- [#1941 ](https://github.com/gakonst/ethers-rs/pull/1941 ) Add `add_calls` and `call_array` for `Multicall` .
2021-11-24 09:07:18 +00:00
2021-12-10 16:05:45 +00:00
## ethers-contract-abigen
2022-03-05 18:25:03 +00:00
### Unreleased
2022-12-02 20:12:14 +00:00
- Fix Cargo.toml generation issue that could cause dependency conflicts [#1852 ](https://github.com/gakonst/ethers-rs/pull/1852 )
- Use corresponding rust structs for event fields if they're solidity structs [#1674 ](https://github.com/gakonst/ethers-rs/pull/1674 )
- Add `ContractFilter` to filter contracts in `MultiAbigen` [#1564 ](https://github.com/gakonst/ethers-rs/pull/1564 )
- generate error bindings for custom errors [#1549 ](https://github.com/gakonst/ethers-rs/pull/1549 )
- Support overloaded events
[#1233 ](https://github.com/gakonst/ethers-rs/pull/1233 )
- Relax Clone requirements when Arc< Middleware > is used
[#1183 ](https://github.com/gakonst/ethers-rs/pull/1183 )
- Generate a deploy function if bytecode is provided in the abigen! input (json artifact)
[#1030 ](https://github.com/gakonst/ethers-rs/pull/1030 ).
- Generate correct bindings of struct's field names that are reserved words
[#989 ](https://github.com/gakonst/ethers-rs/pull/989 ).
- Generate correct binding module names that are reserved words
[#1498 ](https://github.com/gakonst/ethers-rs/pull/1498 ). Note: this changes
generated module names to snake case. For example, `MyContract` is now
`my_contract` rather than `mycontract_mod` .
- The `Cargo.toml` generated by bindings now includes the `abigen` feature on
ethers. [#1508 ](https://github.com/gakonst/ethers-rs/pull/1508 )
- More descriptive contract deserialization errors.
[#1633 ](https://github.com/gakonst/ethers-rs/pull/1633 )
2022-03-05 18:25:03 +00:00
### 0.6.0
2022-12-02 20:12:14 +00:00
- Add `MultiAbigen` to generate a series of contract bindings that can be kept in the repo
[#724 ](https://github.com/gakonst/ethers-rs/pull/724 ).
- Add provided `event_derives` to call and event enums as well
[#721 ](https://github.com/gakonst/ethers-rs/pull/721 ).
- Implement snowtrace and polygonscan on par with the etherscan integration
[#666 ](https://github.com/gakonst/ethers-rs/pull/666 ).
2021-12-10 16:05:45 +00:00
2021-11-26 16:49:19 +00:00
## ethers-solc
2021-08-31 10:52:11 +00:00
### Unreleased
2022-12-02 20:12:14 +00:00
- Add `OutputContext` to `ArtifactOutput` trait
[#1621 ](https://github.com/gakonst/ethers-rs/pull/1621 )
- On windows all paths in the `ProjectCompilerOutput` are now slashed by default
[#1540 ](https://github.com/gakonst/ethers-rs/pull/1540 )
- `ArtifactOutput::write_extras` now takes the `Artifacts` directly
[#1491 ](https://github.com/gakonst/ethers-rs/pull/1491 )
- Make `ethers-solc` optional dependency of `ethers` , needs `ethers-solc` feature to activate
[#1463 ](https://github.com/gakonst/ethers-rs/pull/1463 )
- Add `rawMetadata:String` field to configurable contract output
[#1365 ](https://github.com/gakonst/ethers-rs/pull/1365 )
- Use relative source paths and `solc --base-path`
[#1317 ](https://github.com/gakonst/ethers-rs/pull/1317 )
- Save cache entry objects with relative paths
[#1307 ](https://github.com/gakonst/ethers-rs/pull/1307 )
- Bundle svm, svm-builds and sha2 dependencies in new `svm-solc` feature
[#1071 ](https://github.com/gakonst/ethers-rs/pull/1071 )
- Emit artifact files for source files without any ContractDefinition
[#1296 ](https://github.com/gakonst/ethers-rs/pull/1296 )
- Wrap `ethabi::Contract` into new type `LosslessAbi` and `abi: Option<Abi>` with `abi: Option<LosslessAbi>` in `ConfigurableContractArtifact`
[#952 ](https://github.com/gakonst/ethers-rs/pull/952 )
- Let `Project` take ownership of `ArtifactOutput` and change trait interface
[#907 ](https://github.com/gakonst/ethers-rs/pull/907 )
- Total revamp of the `Project::compile` pipeline
[#802 ](https://github.com/gakonst/ethers-rs/pull/802 )
- Support multiple versions of compiled contracts
- Breaking: deprecate hardhat cache file compatibility, cache file now tracks artifact paths and their versions
- Fix flatten replacement target location
[#846 ](https://github.com/gakonst/ethers-rs/pull/846 )
- Fix duplicate files during flattening
[#813 ](https://github.com/gakonst/ethers-rs/pull/813 )
- Add ability to flatten file imports
[#774 ](https://github.com/gakonst/ethers-rs/pull/774 )
- Add dependency graph and resolve all imported libraryfiles
[#750 ](https://github.com/gakonst/ethers-rs/pull/750 )
- `Remapping::find_many` does not return a `Result` anymore
[#707 ](https://github.com/gakonst/ethers-rs/pull/707 )
- Add support for hardhat artifacts
[#677 ](https://github.com/gakonst/ethers-rs/pull/677 )
- Add more utility functions to the `Artifact` trait
[#673 ](https://github.com/gakonst/ethers-rs/pull/673 )
- Return cached artifacts from project `compile` when the cache only contains
some files
- Add support for library linking and make `Bytecode` 's `object` filed an
`enum BytecodeObject` [#656 ](https://github.com/gakonst/ethers-rs/pull/656 ).
- Nit: remove accidentally doubled double-quotes in an error message
- Fix when compiler-out metadata is empty and there's no internalType [#1182 ](https://github.com/gakonst/ethers-rs/pull/1182 )
- Add basic `solc` model checker options.
[#1258 ](https://github.com/gakonst/ethers-rs/pull/1258 )
2021-11-29 14:31:39 +00:00
2021-11-23 19:27:46 +00:00
### 0.6.0
2022-12-02 20:12:14 +00:00
- add `EthAbiCodec` proc macro to derive `AbiEncode` `AbiDecode` implementation
[#704 ](https://github.com/gakonst/ethers-rs/pull/704 )
- move `AbiEncode` `AbiDecode` trait to ethers-core and implement for core types
[#531 ](https://github.com/gakonst/ethers-rs/pull/531 )
- Add EIP-712 `sign_typed_data` signer method; add ethers-core type `Eip712`
trait and derive macro in ethers-derive-eip712
[#481 ](https://github.com/gakonst/ethers-rs/pull/481 )
derive-eip712: initial implementation of eip712 derive macro (#481)
* 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>
2021-10-08 15:22:51 +00:00
2021-09-27 10:20:10 +00:00
### 0.5.3
2022-12-02 20:12:14 +00:00
- Allow configuring the optimizer & passing arbitrary arguments to solc
[#427 ](https://github.com/gakonst/ethers-rs/pull/427 )
- Decimal support for `ethers_core::utils::parse_units`
[#463 ](https://github.com/gakonst/ethers-rs/pull/463 )
- Fixed Wei unit calculation in `Units`
[#460 ](https://github.com/gakonst/ethers-rs/pull/460 )
- Add `ethers_core::utils::get_create2_address_from_hash`
[#444 ](https://github.com/gakonst/ethers-rs/pull/444 )
- Bumped ethabi to 0.15.0 and fixing breaking changes
[#469 ](https://github.com/gakonst/ethers-rs/pull/469 ),
[#448 ](https://github.com/gakonst/ethers-rs/pull/448 ),
[#445 ](https://github.com/gakonst/ethers-rs/pull/445 )
2021-09-03 14:50:50 +00:00
2021-08-31 10:52:11 +00:00
### 0.5.2
derive-eip712: initial implementation of eip712 derive macro (#481)
* 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>
2021-10-08 15:22:51 +00:00
2022-12-02 20:12:14 +00:00
- Correctly RLP Encode transactions as received from the mempool
([#415](https://github.com/gakonst/ethers-rs/pull/415))
2021-08-31 10:52:11 +00:00
## ethers-providers
2022-03-13 11:58:29 +00:00
### Unreleased
2022-12-02 20:12:14 +00:00
- Convert provider errors to arbitrary middleware errors
[#1920 ](https://github.com/gakonst/ethers-rs/pull/1920 )
- Add a subset of the `admin` namespace
[1880 ](https://github.com/gakonst/ethers-rs/pull/1880 )
- Return String for net version
[1376 ](https://github.com/gakonst/ethers-rs/pull/1376 )
- Stream of paginated logs that load logs in small pages
[1285 ](https://github.com/gakonst/ethers-rs/pull/1285 )
- Load previous logs before subscribing to new logs in case fromBlock is set
[1264 ](https://github.com/gakonst/ethers-rs/pull/1264 )
- Add retries to the pending transaction future
[1221 ](https://github.com/gakonst/ethers-rs/pull/1221 )
- Add support for basic and bearer authentication in http and non-wasm websockets.
[829 ](https://github.com/gakonst/ethers-rs/pull/829 )
- Export `ethers_providers::IpcError` and `ethers_providers::QuorumError`
[1012 ](https://github.com/gakonst/ethers-rs/pull/1012 )
2022-03-13 11:58:29 +00:00
2021-11-23 19:27:46 +00:00
### 0.6.0
2022-12-02 20:12:14 +00:00
- re-export error types for `Http` and `Ws` providers in
[#570 ](https://github.com/gakonst/ethers-rs/pull/570 )
- add a method on the `Middleware` to broadcast a tx with a series of escalating
gas prices via [#566 ](https://github.com/gakonst/ethers-rs/pull/566 )
- Remove unnecessary `Serialize` constraint to `R` (the Response type) in the
`request` method of `JsonRpcClient` .
- Fix `http Provider` data race when generating new request `id` s.
- Add support for `net_version` RPC method.
[595 ](https://github.com/gakonst/ethers-rs/pull/595 )
- Add support for `evm_snapshot` and `evm_revert` dev RPC methods.
[640 ](https://github.com/gakonst/ethers-rs/pull/640 )
2021-11-23 19:27:46 +00:00
2021-09-27 10:20:10 +00:00
### 0.5.3
2022-12-02 20:12:14 +00:00
- Expose `ens` module [#435 ](https://github.com/gakonst/ethers-rs/pull/435 )
- Add `eth_getProof` [#459 ](https://github.com/gakonst/ethers-rs/pull/459 )
2021-09-20 21:08:43 +00:00
2021-08-31 10:52:11 +00:00
### 0.5.2
derive-eip712: initial implementation of eip712 derive macro (#481)
* 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>
2021-10-08 15:22:51 +00:00
2022-12-02 20:12:14 +00:00
- Set resolved ENS name during gas estimation
([1e5a9e](https://github.com/gakonst/ethers-rs/commit/1e5a9efb3c678eecd43d5c341b4932da35445831))
2021-08-31 10:52:11 +00:00
## ethers-signers
### Unreleased
2022-12-02 20:12:14 +00:00
- `eth-keystore-rs` crate updated. Allow an optional name for the to-be-generated
keystore file [#910 ](https://github.com/gakonst/ethers-rs/pull/910 )
2022-02-14 10:08:33 +00:00
2021-11-23 19:27:46 +00:00
### 0.6.0
2022-12-02 20:12:14 +00:00
- `LocalWallet::new_keystore` now returns a tuple `(LocalWallet, String)`
instead of `LocalWallet` , where the string represents the UUID of the newly
created encrypted JSON keystore. The JSON keystore is stored as a file
`/dir/uuid` . The issue [#557 ](https://github.com/gakonst/ethers-rs/issues/557 )
is addressed [#559 ](https://github.com/gakonst/ethers-rs/pull/559 )
2021-11-23 19:27:46 +00:00
2021-08-31 10:52:11 +00:00
## ethers-contract
2021-11-29 14:31:39 +00:00
### Unreleased
2022-12-02 20:12:14 +00:00
- Add abigen to default features
[#1684 ](https://github.com/gakonst/ethers-rs/pull/1684 )
- Add extra Multicall helper methods
[#1666 ](https://github.com/gakonst/ethers-rs/pull/1666 )
- Update Multicall to Multicall3
[#1584 ](https://github.com/gakonst/ethers-rs/pull/1584 )
- Add `Event::stream_with_meta` and `Event::subscribe_with_meta`
[#1483 ](https://github.com/gakonst/ethers-rs/pull/1483 )
- Added tx builder methods to `ContractFactory`
[#1289 ](https://github.com/gakonst/ethers-rs/pull/1289 )
- Relax Clone requirements when Arc< Middleware > is used
[#1183 ](https://github.com/gakonst/ethers-rs/pull/1183 )
- Add `EventStream::select` to combine streams with different event types
[#725 ](https://github.com/gakonst/ethers-rs/pull/725 )
- Substitute output tuples with rust struct types for function calls
[#664 ](https://github.com/gakonst/ethers-rs/pull/664 )
- Add AbiType implementation during EthAbiType expansion
[#647 ](https://github.com/gakonst/ethers-rs/pull/647 )
- fix Etherscan conditional HTTP support
[#632 ](https://github.com/gakonst/ethers-rs/pull/632 )
- use `CARGO_MANIFEST_DIR` as root for relative paths in abigen
[#631 ](https://github.com/gakonst/ethers-rs/pull/631 )
2021-11-29 14:31:39 +00:00
2021-11-23 19:27:46 +00:00
### 0.6.0
2022-12-02 20:12:14 +00:00
- Provide a way to opt out of networking support in abigen proc macro with
`abigen-offline` feature [#580 ](https://github.com/gakonst/ethers-rs/pull/580 )
- Add `.call()` method to `Deployer` for performing dry runs of contract
deployments. [#554 ](https://github.com/gakonst/ethers-rs/pull/554 )
- Improve error message from failure in `ethers_contract_abigen::Source::parse`
[#552 ](https://github.com/gakonst/ethers-rs/pull/552 )
- use enumerated aliases for overloaded functions
[#545 ](https://github.com/gakonst/ethers-rs/pull/545 )
- add `EthCall` trait and derive macro which generates matching structs for
contract calls [#517 ](https://github.com/gakonst/ethers-rs/pull/517 )
- Use rust types as contract function inputs for human readable abi
[#482 ](https://github.com/gakonst/ethers-rs/pull/482 )
- `abigen!` now generates `Display` for all events using the new `EthDisplay`
macro [#513 ](https://github.com/gakonst/ethers-rs/pull/513 )
- `abigen!` now supports overloaded functions natively
[#501 ](https://github.com/gakonst/ethers-rs/pull/501 )
- `abigen!` now supports multiple contracts
[#498 ](https://github.com/gakonst/ethers-rs/pull/498 )
2021-11-23 19:27:46 +00:00
2021-08-31 10:52:11 +00:00
### Unreleased
2021-09-27 10:20:10 +00:00
### 0.5.3
derive-eip712: initial implementation of eip712 derive macro (#481)
* 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>
2021-10-08 15:22:51 +00:00
2022-12-02 20:12:14 +00:00
- (De)Tokenize structs and events with only a single field as `Token:Tuple`
([#417](https://github.com/gakonst/ethers-rs/pull/417))
2021-08-31 10:52:11 +00:00
## ethers-middleware
### Unreleased
2022-12-21 14:44:42 +00:00
- Added `openssl` and `rustls` feature flags
[#1961 ](https://github.com/gakonst/ethers-rs/pull/1961 )
2022-12-02 20:12:14 +00:00
- Relax Clone requirements when Arc< Middleware > is used
[#1183 ](https://github.com/gakonst/ethers-rs/pull/1183 )
- Ensure a consistent chain ID between a Signer and Provider in SignerMiddleware
[#1095 ](https://gakonst/ethers-rs/pull/1095 )
- Add BlockNative gas oracle [#1175 ](https://github.com/gakonst/ethers-rs/pull/1175 )
2022-04-25 15:50:55 +00:00
2021-11-23 19:27:46 +00:00
### 0.6.0
2022-12-02 20:12:14 +00:00
- add the missing constructor for `Timelag` middleware via
[#568 ](https://github.com/gakonst/ethers-rs/pull/568 )
- Removes GasNow as a gas price oracle
[#508 ](https://github.com/gakonst/ethers-rs/pull/508 )
- add initialize_nonce public function to initialize NonceMiddleManager
2021-10-15 11:05:54 +00:00
2021-09-27 10:20:10 +00:00
### 0.5.3
2022-12-02 20:12:14 +00:00
- Added Time Lagged middleware
[#457 ](https://github.com/gakonst/ethers-rs/pull/457 )
