feature: ProviderCall #788

prestwich · 2024-05-27T16:08:07Z

Closes #736

Motivation

Allow providers to get outputs from arbitrary sources, including synchronous

Solution

Add a ProviderCall future that wraps 4 data sources (rpc, batch rpc, other future, ready)
change provider return types
change inner type of eth call and with_block

drive-by:

generalize into_owned_params
alphabetize some mod defs
improve mapping internal to rpccall
add map to waiter

PR Checklist

Added Tests
Added Documentation
Breaking changes

mattsse

makes sense,

this is still easy to follow imo

fix: rename to prov_call for disambiguation

prestwich · 2024-05-31T12:58:12Z

the main problem right now is figuring out how to integrate it into WithBlock and EthCall 🤔

yash-atreya · 2024-06-27T08:35:28Z

hey @prestwich

Taking this over, need it for #954

yash-atreya · 2024-06-27T08:42:36Z

hey @prestwich

Taking this over, need it for #954

Would appreciate it if you have any pointers on how to move forward from here.

I think only integrating ProviderCall with RpcWithBlock and EthCall remains?

* use `ClientRef` in EthCall instead of `WeakClient` * change lifetimes * add *_internal methods that return `EthCall`

This reverts commit 569d168.

yash-atreya · 2024-08-07T12:18:11Z

I think we can now unify Caller impls for WithBlock and EthCall? or maybe just do impl Caller for WeakClient<T>?

impl Caller for WeakClient<T> makes sense

klkvr · 2024-08-12T15:13:20Z

@yash-atreya one thing I find a bit confusing here is that by design of Caller it does not receive more context than a RequestPacket we are working with when overriding transport layers.

I think one valid usecase for this PR is for example changing Provider implementation to reading storage slots from some other source for get_storage_at requests. Currently this would require implementing a custom Caller which would manually deserialize eth_getStorageAt params to determine address, slot and block which adds an additional fallible step which wasn't required earlier when those methods returned just TransportResult

I think what we want for WithBlock is something that can produce a ProviderCall given a block_id: BlockId, and also is able to capture context such as Params. This is essentially fn(BlockId) -> ProviderCall, though we'd likely need more concrete type here to handle lifetimes in cases of borrowed rpc call params

…1159) * feat: RpcCall:map_params * WithBlockInner * Ready variant * fmt * use ProviderCall * clippy + fmt * add From<F> * make ProviderCall::Ready return a result * add docs * Update request.rs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * fmt --------- Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>

yash-atreya · 2024-08-21T06:28:48Z

@mattsse I believe this can be merged now

mattsse

I think this should work now,

mind giving this another close look @klkvr ?

klkvr · 2024-08-22T10:18:40Z

@yash-atreya wondering how do we decide which Provider methods return ProviderCall vs do async fn -> TransportResult<...>?

yash-atreya · 2024-08-26T05:48:33Z

@yash-atreya wondering how do we decide which Provider methods return ProviderCall vs do async fn -> TransportResult<...>?

Sorry for the delayed response.

TransportResult is also overridable like ProviderCall.

I believe subscribe/watch methods should be TransportResult since they return PollerBuilder, similar logic applies to send_tx_* methods.

Also, any RPC method where we accept a parameter by reference, should be TransportResult since replacing it with ProviderCall will introduce lifetimes. eg. get_fee_history

Rest can be made to return ProviderCall.

Should extension traits such as AdminApi, TraceApi etc. be moved to ProviderCall as well?

@mattsse wdyt?

klkvr · 2024-08-26T10:34:33Z

Also, any RPC method where we accept a parameter by reference, should be TransportResult since replacing it with ProviderCall will introduce lifetimes. eg. get_fee_history

Lifetimes should be fine, we already have them in e.g. estimate_gas

Should extension traits such as AdminApi, TraceApi etc. be moved to ProviderCall as well?

We are already using RpcWithBlock in TraceApi, so I wouldn't say that those aren't tied to provider already. Though I can see how changing their returns types to ProviderCall might break usecases unrelated to provider

yash-atreya · 2024-08-26T10:39:53Z

Lifetimes should be fine, we already have them in e.g. estimate_gas

We want to avoid introducing lifetimes in the trait as much as possible, eth_call and estimate_gas are exceptions since the addition of EthCall.

how changing their returns types to ProviderCall might break usecases unrelated to provider

+1

klkvr · 2024-09-07T18:04:48Z

crates/provider/src/provider/caller.rs

+use std::borrow::Cow;
+
+/// A caller that helper convert `RpcWithBlock` and `EthCall` into a `ProviderCall`.
+pub trait Caller<T, Params, Resp>: Send + Sync


given we're now wonly using this for EthCall, I think we should make it more call-specific, eg make it accept TransactionRequest, block and overrides directly to allow implementations to directly call underlying evm with them.

klkvr

lgtm overall, just a note on Caller trait, we can address this in a follow-up

* feature: ProviderCall fix: rename to prov_call for disambiguation * refactor: replace output types * doc: add note about fn pointers * feat: convert `EthCall` to `ProviderCall` * use `ClientRef` in EthCall instead of `WeakClient` * change lifetimes * add *_internal methods that return `EthCall` * doc nits * use `ClientRef` instead of `WeakClient` in `RpcWithBlock` * Revert "use `ClientRef` instead of `WeakClient` in `RpcWithBlock`" This reverts commit 569d168. * feat: RpcCallWithBlock enum val in provider call * nits * feat: integrate `RpcWithBlock` into `ProviderCall` * rm `RpcWithBlock` val from ProviderCall * feat(provider): caller trait for with_block calls * rm `WeakClient` from `RpcWithBlock` * introduce `Caller` into `RpcWithBlock` * use `WithBlockCall` in `RpcWithBlock`. polling doesn't work. * nit * feat(provider): add `WithBlockFut` - polls `ProviderCall` and maps response. * nit * revert 2ff402 * Revert "feat: convert `EthCall` to `ProviderCall`" This reverts commit 1cb1579. * doc nits * feat(provider): introduce `Caller` to `EthCall`. Arc it so that its cloneable * feat(provider): add `EthCaller` - converts EthCall into ProviderCall and strengthen test * update `EthCallFut` * holds `ProviderCall` * removes Clone * impl poll_preparing and poll_running on `EthCallFut` instead of `EthCallFutInner` * poll `ProviderCall` in `EthCall`using `EthCaller` * removes WeakClient from `EthCall` * updates `EthCallFutInner::Running` to store map * nit * wrap Caller in Arc to make `RpcWithBlock` cloneable * store in `ProvideCall` fut instance in `States` * store `ProviderCall` fut in `EthCallFutInner` * feat(provider): add `ParamsWithBlock` for `RpcWithBlock` * rm `block_id` from `Caller` trait * impl `Caller` for `WeakClient` * refactor(`ProviderCall`): don't rely on `Caller` in `RpcWithBlock` (alloy-rs#1159) * feat: RpcCall:map_params * WithBlockInner * Ready variant * fmt * use ProviderCall * clippy + fmt * add From<F> * make ProviderCall::Ready return a result * add docs * Update request.rs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * fmt --------- Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * refac(provider): use `ProviderCall` as return in trait * nit * doc nits * fix --------- Co-authored-by: Yash Atreya <44857776+yash-atreya@users.noreply.github.com> Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com> Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>

prestwich added enhancement New feature or request debt Tech debt which needs to be addressed labels May 27, 2024

prestwich self-assigned this May 27, 2024

prestwich requested review from DaniPopes, gakonst, mattsse, onbjerg and Evalir as code owners May 27, 2024 16:08

prestwich mentioned this pull request May 27, 2024

[Feature] Allow custom implementation for Provider methods #736

Closed

prestwich force-pushed the prestwich/provider-call-fut branch from b465c20 to b1496cb Compare May 28, 2024 09:02

mattsse approved these changes May 28, 2024

View reviewed changes

prestwich force-pushed the prestwich/provider-call-fut branch from b1496cb to 21b11f1 Compare May 31, 2024 10:23

prestwich added 2 commits May 31, 2024 12:48

feature: ProviderCall

26f9273

fix: rename to prov_call for disambiguation

refactor: replace output types

f14aa77

prestwich force-pushed the prestwich/provider-call-fut branch from 068c2e4 to f14aa77 Compare May 31, 2024 11:48

doc: add note about fn pointers

0b0b835

prestwich mentioned this pull request Jun 3, 2024

[Feature] Add a CachedReqwestProvider to cache RPC requests using a ReqwestProvider #770

Open

prestwich added the 0.1-rc.0 label Jun 3, 2024

DaniPopes removed the 0.1-rc.0 label Jun 5, 2024

prestwich marked this pull request as draft June 8, 2024 13:27

resolve conflicts

478ac23

yash-atreya added 6 commits June 27, 2024 17:50

feat: convert EthCall to ProviderCall

1cb1579

* use `ClientRef` in EthCall instead of `WeakClient` * change lifetimes * add *_internal methods that return `EthCall`

doc nits

2ff402b

use ClientRef instead of WeakClient in RpcWithBlock

569d168

Revert "use ClientRef instead of WeakClient in RpcWithBlock"

b06e897

This reverts commit 569d168.

feat: RpcCallWithBlock enum val in provider call

b16ab35

nits

095ed89

impl Caller for WeakClient

460fa46

klkvr and others added 2 commits August 21, 2024 07:31

resolve conflicts

9f48291

mattsse reviewed Aug 22, 2024

View reviewed changes

Merge branch 'main' into prestwich/provider-call-fut

e1f0cae

yash-atreya added 2 commits August 26, 2024 12:46

refac(provider): use ProviderCall as return in trait

4e199ce

nit

3822252

resolve conflicts

b4744ab

yash-atreya requested a review from emhane as a code owner August 26, 2024 12:06

resolve conflicts

d06bf26

yash-atreya requested a review from mattsse August 27, 2024 11:43

klkvr reviewed Sep 7, 2024

View reviewed changes

klkvr approved these changes Sep 7, 2024

View reviewed changes

doc nits

e175c13

yash-atreya mentioned this pull request Sep 9, 2024

feat(provider): LRUCache Layer #954

Merged

14 tasks

yash-atreya added 2 commits September 17, 2024 17:10

Merge branch 'main' into prestwich/provider-call-fut

5a8bba4

fix

8f53e56

mattsse approved these changes Sep 18, 2024

View reviewed changes

mattsse merged commit 6369bcc into main Sep 18, 2024
26 checks passed

mattsse deleted the prestwich/provider-call-fut branch September 18, 2024 10:06

yash-atreya mentioned this pull request Sep 25, 2024

feat(advanced): Provider trait over reth-db alloy-rs/examples#144

Merged

2 tasks

yash-atreya mentioned this pull request Oct 14, 2024

provider: make Caller more EthCall specific #1471

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: ProviderCall #788

feature: ProviderCall #788

prestwich commented May 27, 2024 •

edited by yash-atreya

Loading

mattsse left a comment

prestwich commented May 31, 2024

yash-atreya commented Jun 27, 2024

yash-atreya commented Jun 27, 2024 •

edited

Loading

yash-atreya commented Aug 7, 2024

klkvr commented Aug 12, 2024

yash-atreya commented Aug 21, 2024

mattsse left a comment

klkvr commented Aug 22, 2024 •

edited

Loading

yash-atreya commented Aug 26, 2024 •

edited

Loading

klkvr commented Aug 26, 2024

yash-atreya commented Aug 26, 2024

klkvr Sep 7, 2024

klkvr left a comment

feature: ProviderCall #788

feature: ProviderCall #788

Conversation

prestwich commented May 27, 2024 • edited by yash-atreya Loading

Motivation

Solution

PR Checklist

mattsse left a comment

Choose a reason for hiding this comment

prestwich commented May 31, 2024

yash-atreya commented Jun 27, 2024

yash-atreya commented Jun 27, 2024 • edited Loading

yash-atreya commented Aug 7, 2024

klkvr commented Aug 12, 2024

yash-atreya commented Aug 21, 2024

mattsse left a comment

Choose a reason for hiding this comment

klkvr commented Aug 22, 2024 • edited Loading

yash-atreya commented Aug 26, 2024 • edited Loading

klkvr commented Aug 26, 2024

yash-atreya commented Aug 26, 2024

klkvr Sep 7, 2024

Choose a reason for hiding this comment

klkvr left a comment

Choose a reason for hiding this comment

prestwich commented May 27, 2024 •

edited by yash-atreya

Loading

yash-atreya commented Jun 27, 2024 •

edited

Loading

klkvr commented Aug 22, 2024 •

edited

Loading

yash-atreya commented Aug 26, 2024 •

edited

Loading