feat: add EVM RPC canister client by lpahlavi · Pull Request #447 · dfinity/evm-rpc-canister

lpahlavi · 2025-08-06T14:10:32Z

(XC-412) This PR is one of multiple to add an evm_rpc_client crate which offers a client for the EVM RPC canister, similar to the sol_rpc_client for the SOL RPC canister (see here).

This first PR adds a client which for now only supports the eth_getLogs method. In order to keep this PR's size manageable, a follow-up PR (#448) adds integration tests for the client which requires a significant refactoring of the integration tests.

gregorydemay

Thanks @lpahlavi for starting this effort! Some high-level comments first.

evm_rpc_client/Cargo.toml

evm_rpc_client/src/lib.rs

evm_rpc_types/Cargo.toml

Co-authored-by: gregorydemay <112856886+gregorydemay@users.noreply.github.com>

lpahlavi · 2025-08-20T05:52:21Z

Thanks a lot for the feedback @gregorydemay!

I would have a look at the follow-up PR (#448) that adds the integration tests for a concrete example of how this client is used. That PR is now ready for review. It is a bit of a shame that the changes are split across 2 PRs but as mentioned, otherwise I felt the combined PR would just be too big.

evm_rpc_types/src/lib.rs

evm_rpc_types/src/response/mod.rs

evm_rpc_types/src/result/mod.rs

…tLogArgs`

lpahlavi · 2025-08-21T10:15:58Z

Thanks a lot for the review and feedback @gregorydemay! Should now be ready for another round 🚀

gregorydemay

Thanks @lpahlavi for the improvements and adding the docs! The fix for map I would do in a separate PR, otherwise the code LGTM!

evm_rpc_client/src/lib.rs

evm_rpc_types/src/response/test.rs

evm_rpc_types/src/result/alloy.rs

evm_rpc_types/src/result/mod.rs

evm_rpc_client/src/lib.rs

lpahlavi · 2025-08-25T05:56:26Z

Once again thanks a lot for the review and feedback @gregorydemay! Should now be ready for another round.

gregorydemay

Thanks @lpahlavi for the multiple rounds of improvements!

evm_rpc_types/src/result/tests.rs

evm_rpc_types/src/result/mod.rs

evm_rpc_types/src/response/test.rs

(XC-412) Add a `PocketIcRuntime` implementation and some basic integration tests for the client's `eth_getLogs` method added in #447. Follow-up PRs will include adding more methods to the client and the corresponding integration tests using the infrastructure added in this PR. --------- Co-authored-by: gregorydemay <112856886+gregorydemay@users.noreply.github.com>

## 🤖 New release * `evm_rpc_types`: 2.1.0 -> 3.0.0 (✓ API compatible changes) * `evm_rpc_client`: 0.1.0 * `evm_rpc`: 2.5.0 -> 2.6.0 (✓ API compatible changes) <details><summary>Changelog</summary> ## `evm_rpc_types` <blockquote> ## [3.0.0] - 2025-10-20 ### Added - Add conversions between several types in this crate and the corresponding `alloy` types. These conversions are only available with the `alloy` feature ([#465](#465), [#466](#466), [#467](#467), [#476](#476)). - **Breaking:** Add `root` and `cumulativeGasUsed` fields to `TransactionsReceipt` type ([#474](#474)) [3.0.0]: https://github.com/dfinity/evm-rpc-canister/compare/evm_rpc_types-v2.1.0..evm_rpc_types-v3.0.0 </blockquote> ## `evm_rpc_client` <blockquote> ## [0.1.0] - 2025-10-20 ### Added - Add methods to modify RPC config to `RequestBuilder` ([#494](#494)) - Add `alloy` feature flag to `evm_rpc_client` ([#484](#484)) - Add new `json_request` endpoint ([#477](#477)) - Add client support for `eth_getTransactionReceipt` ([#476](#476)) - Add `eth_sendRawTransaction` client support ([#467](#467)) - Add client support for `eth_call` ([#466](#466)) - Add client support for `eth_getTransactionCount` ([#465](#465)) - Add support for `eth_feeHistory` to client ([#460](#460)) - Add support for `eth_getBlockByNumber` to client ([#459](#459)) - Add EVM RPC canister client ([#447](#447)) [0.1.0]: https://github.com/dfinity/evm-rpc-canister/releases/tag/evm_rpc_client-v0.1.0 </blockquote> ## `evm_rpc` <blockquote> ## [2.6.0] - 2025-10-20 ### Added - Add support for `root` and `cumulativeGasUsed` fields in `eth_getTransactionReceipt` response ([#474](#474)) - Add new `json_request` endpoint and deprecate existing `request` endpoint ([#477](#477)) ### Changed - Update `ic-cdk` to `v0.18.7` ([#489](#489)) - Update `dfx` to `v0.29.0` ([#490](#490)) - Cleanup unused dependencies ([#491](#491)) ### Removed - **Breaking**: Remove `getMetrics` endpoint, this is acceptable since it was a debugging endpoint ([#479](#479)) ### Fixed - Add `err_max_response_size_exceeded` to Prometheus metrics ([#487](#487)) [2.6.0]: v2.5.0...v2.6.0 </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Louis Pahlavi <louis.pahlavi@dfinity.org>

## 🤖 New release * `evm_rpc_types`: 2.1.0 -> 3.0.0 (✓ API compatible changes) * `evm_rpc_client`: 0.1.0 * `evm_rpc`: 2.5.0 -> 2.6.0 (✓ API compatible changes) <details><summary>Changelog</summary> ## `evm_rpc_types` <blockquote> ## [3.0.0] - 2025-10-20 ### Added - Add conversions between several types in this crate and the corresponding `alloy` types. These conversions are only available with the `alloy` feature ([#465](dfinity/evm-rpc-canister#465), [#466](dfinity/evm-rpc-canister#466), [#467](dfinity/evm-rpc-canister#467), [#476](dfinity/evm-rpc-canister#476)). - **Breaking:** Add `root` and `cumulativeGasUsed` fields to `TransactionsReceipt` type ([#474](dfinity/evm-rpc-canister#474)) [3.0.0]: https://github.com/dfinity/evm-rpc-canister/compare/evm_rpc_types-v2.1.0..evm_rpc_types-v3.0.0 </blockquote> ## `evm_rpc_client` <blockquote> ## [0.1.0] - 2025-10-20 ### Added - Add methods to modify RPC config to `RequestBuilder` ([#494](dfinity/evm-rpc-canister#494)) - Add `alloy` feature flag to `evm_rpc_client` ([#484](dfinity/evm-rpc-canister#484)) - Add new `json_request` endpoint ([#477](dfinity/evm-rpc-canister#477)) - Add client support for `eth_getTransactionReceipt` ([#476](dfinity/evm-rpc-canister#476)) - Add `eth_sendRawTransaction` client support ([#467](dfinity/evm-rpc-canister#467)) - Add client support for `eth_call` ([#466](dfinity/evm-rpc-canister#466)) - Add client support for `eth_getTransactionCount` ([#465](dfinity/evm-rpc-canister#465)) - Add support for `eth_feeHistory` to client ([#460](dfinity/evm-rpc-canister#460)) - Add support for `eth_getBlockByNumber` to client ([#459](dfinity/evm-rpc-canister#459)) - Add EVM RPC canister client ([#447](dfinity/evm-rpc-canister#447)) [0.1.0]: https://github.com/dfinity/evm-rpc-canister/releases/tag/evm_rpc_client-v0.1.0 </blockquote> ## `evm_rpc` <blockquote> ## [2.6.0] - 2025-10-20 ### Added - Add support for `root` and `cumulativeGasUsed` fields in `eth_getTransactionReceipt` response ([#474](dfinity/evm-rpc-canister#474)) - Add new `json_request` endpoint and deprecate existing `request` endpoint ([#477](dfinity/evm-rpc-canister#477)) ### Changed - Update `ic-cdk` to `v0.18.7` ([#489](dfinity/evm-rpc-canister#489)) - Update `dfx` to `v0.29.0` ([#490](dfinity/evm-rpc-canister#490)) - Cleanup unused dependencies ([#491](dfinity/evm-rpc-canister#491)) ### Removed - **Breaking**: Remove `getMetrics` endpoint, this is acceptable since it was a debugging endpoint ([#479](dfinity/evm-rpc-canister#479)) ### Fixed - Add `err_max_response_size_exceeded` to Prometheus metrics ([#487](dfinity/evm-rpc-canister#487)) [2.6.0]: dfinity/evm-rpc-canister@v2.5.0...v2.6.0 </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Louis Pahlavi <louis.pahlavi@dfinity.org>

lpahlavi added 11 commits August 6, 2025 15:33

XC-412: Initialize new empty evm_rpc_client crate

4d2c5a5

XC-412: Add skeleton for client

d10ee6a

XC-412: Add eth_getLogs to new client

4b71bd1

XC-412: Add empty changelog

07c8712

XC-412: Add more type conversions to alloy

d5d3413

XC-412: Use try_from instead of from

99d82b2

XC-412: Add get_logs to client

34c70b9

XC-412: Don't expose private types

fb4a545

XC-412: Remove new ProviderId type

041a47b

XC-412: Refactor and_then

33e50df

XC-412: Make f mutable

4619b97

lpahlavi requested a review from gregorydemay August 8, 2025 16:00

lpahlavi marked this pull request as ready for review August 8, 2025 16:01

lpahlavi requested a review from a team as a code owner August 8, 2025 16:01

lpahlavi mentioned this pull request Aug 8, 2025

test: client integration test infrastructure #448

Merged

gregorydemay reviewed Aug 19, 2025

View reviewed changes

evm_rpc_client/Cargo.toml Outdated Show resolved Hide resolved

evm_rpc_client/src/lib.rs Outdated Show resolved Hide resolved

evm_rpc_client/src/lib.rs Show resolved Hide resolved

evm_rpc_client/src/lib.rs Show resolved Hide resolved

evm_rpc_types/Cargo.toml Show resolved Hide resolved

XC-412: Fix repository link

5e8aeed

Co-authored-by: gregorydemay <112856886+gregorydemay@users.noreply.github.com>

lpahlavi requested a review from gregorydemay August 20, 2025 05:52

XC-412: Require docs

fff88e0

gregorydemay reviewed Aug 20, 2025

View reviewed changes

evm_rpc_types/src/lib.rs Outdated Show resolved Hide resolved

evm_rpc_types/src/response/mod.rs Outdated Show resolved Hide resolved

evm_rpc_types/src/result/mod.rs Show resolved Hide resolved

lpahlavi added 9 commits August 20, 2025 15:14

XC-412: Add rustdoc and examples

a547409

XC-412: Move type conversions to separate files

5e5c55a

XC-412: Flesh out examples

4a73233

XC-412: Move more type conversions to separate files

99d031c

XC-412: Add TODO for conversion from alloy_rpc_types::Filter to `Ge…

ab47bb8

…tLogArgs`

XC-412: Add some alloy conversion unit tests

59801f2

XC-412: Add unit tests for and_then method

ccb0f5d

Merge branch 'main' into lpahlavi/XC-412-evm-rpc-client

438dd53

XC-412: Formatting

b152927

XC-412: Add more unit tests

5de395d

lpahlavi requested a review from gregorydemay August 21, 2025 10:15

gregorydemay reviewed Aug 22, 2025

View reviewed changes

XC-412: Improve rustdocs

db3d6f5

lpahlavi requested a review from gregorydemay August 22, 2025 15:34

Merge branch 'main' into lpahlavi/XC-412-evm-rpc-client

71b37d4

XC-412: Add collapse to ande_then

c729d72

gregorydemay approved these changes Aug 25, 2025

View reviewed changes

evm_rpc_types/src/result/tests.rs Outdated Show resolved Hide resolved

evm_rpc_types/src/result/mod.rs Show resolved Hide resolved

evm_rpc_types/src/response/test.rs Show resolved Hide resolved

lpahlavi added 3 commits August 25, 2025 15:00

XC-412: Add explanation for hex_to_u32_digits

9a97a60

XC-412: Add unit tests for error consolidation

ee6ab99

XC-412: FOrMaTtInG

3efc9c1

lpahlavi merged commit 63adada into main Aug 25, 2025
11 checks passed

lpahlavi deleted the lpahlavi/XC-412-evm-rpc-client branch August 25, 2025 13:27

github-actions bot mentioned this pull request Sep 24, 2025

chore: release #483

Closed

This was referenced Oct 20, 2025

chore: release #499

Closed

chore: release #500

Merged

Conversation

lpahlavi commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi commented Aug 21, 2025

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi commented Aug 25, 2025

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lpahlavi commented Aug 6, 2025 •

edited

Loading

lpahlavi commented Aug 20, 2025 •

edited

Loading