WEB3-67: feat: switch Steel to alloy #183

Wollac · 2024-07-24T15:53:36Z

⚡️ Features

Replace ethers dependency completely with alloy.
Make host functions async.
Add support to build EvmEnv from any alloy provider.
Add more efficient RLP-based serialization for the header.

🛠 Fixes

Store the commitment inside the EvmEnv.
Use eth_getTransactionCount and eth_getBalance instead of eth_getProof to query basic account information.
Switch tests from pre-recorded RPC responses to Anvil.

🚨 Breaking Changes

EthEvmEnv::from_rpc now accepts a Url instead of a &str for the HTTP RPC endpoint.
EvmEnv::from_provider now requires an alloy provider, and the block number parameter has been changed to a BlockNumberOrTag.
EvmEnv::sol_commitment has been replaced with EvmEnv::commitment (to get a reference), or EvmEnv::into_commitment (to consume and return the commitment).
ETH_SEPOLIA_CHAIN_SPEC and ETH_MAINNET_CHAIN_SPEC have been moved to the ethereum module.
CachedProvider has been removed completely. As alternatives, you can:
- Use anvil --fork-url https://ethereum-rpc.publicnode.com@20475759 to create a cached fork for block 20475759.
- Cache the RPC responses on an HTTP level using Tower or a caching forward proxy.
The host functions are now async instead of blocking:

// Create an EVM environment from an RPC endpoint and a block number or tag.
let mut env = EthEvmEnv::from_rpc(args.rpc_url, BlockNumberOrTag::Latest).await?;
//  The `with_chain_spec` method is used to specify the chain configuration.
env = env.with_chain_spec(&ETH_SEPOLIA_CHAIN_SPEC);

// Preflight the call to prepare the input that is required to execute the function in
// the guest without RPC access. It also returns the result of the call.
let mut contract = Contract::preflight(CONTRACT, &mut env);
let returns = contract.call_builder(&CALL).from(CALLER).call().await?;

// Finally, construct the input from the environment.
let input = env.into_input().await?;

Wollac · 2024-08-05T17:08:43Z

steel/src/contract.rs

+        // we cannot clone the database, so it gets moved in and out of the task
+        let db = self.env.db.take().unwrap();
+
+        let (res, db) = tokio::task::spawn_blocking(move || {


I think it would be preferable, if Steel as a library relies on tokio. Would be nice if this could remain runtime agnostic.
However, we have to call a long running blocking function inside of an async library, I don't think there is a way around this.

Wollac · 2024-08-05T17:25:43Z

steel/src/host/mod.rs

-        };
-
-        EvmEnv::from_provider(provider, block_number)
+    pub async fn from_rpc(url: Url, number: BlockNumberOrTag) -> anyhow::Result<Self> {


Should be rather switch this to a block hash or tag?
Could there be situations in which the block number is not well defined, maybe due to re-orgs?

It's possible. One API solution to this is to use a builder pattern and split the method that adds the RPC URL from the method that specifies the block ref. In this case, we could provide two methods, one for BlockNumberOrTag and one for block hash (or something like that).

nategraf

Nice work! I added some comments. None of them are concerns about the core of this PR.

nategraf · 2024-08-05T23:21:01Z

Cargo.toml

-ethers-core = "2.0"
-ethers-providers = "2.0"


examples/erc20-counter/README.md

nategraf · 2024-08-05T23:27:02Z

examples/erc20-counter/apps/src/bin/publisher.rs

+    let provider = ProviderBuilder::new()
+        .with_recommended_fillers()
+        .wallet(wallet)
+        .on_http(args.rpc_url);


Another option is to use on_builtin to support HTTPS and WS URLs without code changes. https://docs.rs/alloy-provider/latest/alloy_provider/struct.ProviderBuilder.html#method.on_builtin

Very interesting, I didn't even know that existed. It even takes a string similar to the eth provider before...

🤔 I kinda liked the change to Url for its additional type safety and I guess HTTP is the more realistic provider as we don't rely on any pubsub and even then we have the from_provider for any alloy provider...

On the question of using Url, I also like that from a semantics point of view. With on_builtin, we could call url.as_str to pass it in, so we can keep that change either way. On the use of HTTP provider. I do see that we constrain the types to HTTP providers anyway. Something we should think about before marking 1.0 is whether we should/can loosen thew type constraints there. It's really not a major issue in any case.

The types of EthEvmEnv::from_rpc are only Http because this is what .on_http returns. There is also

risc0-ethereum/steel/src/host/mod.rs

Line 62 in eded136

pub async fn from_provider(provider: P, number: BlockNumberOrTag) -> anyhow::Result<Self> {

which works with any generic alloy provider.

steel/src/config.rs

nategraf · 2024-08-06T00:01:24Z

steel/src/host/mod.rs

-        };
-
-        EvmEnv::from_provider(provider, block_number)
+    pub async fn from_rpc(url: Url, number: BlockNumberOrTag) -> anyhow::Result<Self> {


It's possible. One API solution to this is to use a builder pattern and split the method that adds the RPC URL from the method that specifies the block ref. In this case, we could provide two methods, one for BlockNumberOrTag and one for block hash (or something like that).

steel/src/state.rs

nategraf · 2024-08-06T00:12:41Z

steel/src/state.rs

+        state_trie: MerkleTrie,
+        storage_tries: impl IntoIterator<Item = MerkleTrie>,
+        contracts: impl IntoIterator<Item = Bytes>,
+        block_hashes: HashMap<u64, B256>,


Should this also be impl IntoIterator or is there a reason not to (e.g. maybe it would waste a lot of time constructing the map)?

The HashMap is actually already constructed during validation in the into_env step. So I think it makes sense to just move it here.

steel/tests/steel.rs

steel/tests/erc20.rs

steel/tests/steel.rs

Pending #185 Attempt at solving #174 and #176. Closes #174 Closes #176 --------- Co-authored-by: Victor Graf <victor@risczero.com>

Wollac added 16 commits July 24, 2024 17:43

switch Steel to alloy

b30672c

remove ethers dependencies

fcd859a

cleanup Cargo.toml

90f76f3

fix serde

0996262

improve RlpHeader performance

8e595c3

minor refactoring

3c2093e

add ERC20 tests back

e438458

add more RPC checks

4c66d06

minor test cleanups

1b0109b

remove unused dependencies

ce727d0

fix examples

4de4a97

Paris oldest supported version

609fc39

fix steel tests

fa7e48a

make commitment explicit

913bc31

do not use eth_getProof in alloyDb

dea7825

add changelog

3728acf

Wollac self-assigned this Aug 5, 2024

Wollac marked this pull request as ready for review August 5, 2024 14:02

Wollac requested review from capossele and a team as code owners August 5, 2024 14:02

capossele approved these changes Aug 5, 2024

View reviewed changes

upgrade alloy to v0.2.1

6e84c9a

nategraf self-requested a review August 5, 2024 16:30

Wollac added 2 commits August 5, 2024 19:23

cleanup AlloyDb

3c84555

update README

f668c8a

Wollac commented Aug 5, 2024

View reviewed changes

nategraf approved these changes Aug 6, 2024

View reviewed changes

Wollac added 3 commits August 6, 2024 11:20

update alloy-rlp

9fa83a4

add comment

3b6b162

enable logging for blockhash

75f5718

Wollac added 4 commits August 6, 2024 16:03

chain spec cleanup

b2d6071

add solc compile instructions

f4e7e7f

fix fmt

eded136

Merge branch 'main' into feat/alloy

311692d

nategraf mentioned this pull request Aug 7, 2024

Improve groth16 encode API #179

Merged

Improve groth16 encode API (#179)

a42c5e3

Pending #185 Attempt at solving #174 and #176. Closes #174 Closes #176 --------- Co-authored-by: Victor Graf <victor@risczero.com>

github-actions bot changed the title ~~feat: switch Steel to alloy~~ WEB3-67: feat: switch Steel to alloy Aug 7, 2024

capossele and others added 5 commits August 7, 2024 09:33

Merge branch 'main' into feat/alloy

6f665c2

improve doc

519bf45

fix clippy warnings

76af633

make url dependency optional

d2d2fa3

improve CHANGELOG.md

26ec759

Wollac enabled auto-merge (squash) August 7, 2024 09:59

Wollac merged commit b2dcc8e into main Aug 7, 2024
9 checks passed

Wollac deleted the feat/alloy branch August 7, 2024 10:09

This was referenced Aug 7, 2024

Migrate usage of Ethers to Alloy in Steel #160

Closed

Steel does not work from async main #178

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WEB3-67: feat: switch Steel to alloy #183

WEB3-67: feat: switch Steel to alloy #183

Wollac commented Jul 24, 2024 •

edited

Loading

Wollac Aug 5, 2024

Wollac Aug 5, 2024

nategraf Aug 6, 2024

nategraf left a comment

nategraf Aug 5, 2024

nategraf Aug 5, 2024

Wollac Aug 6, 2024 •

edited

Loading

nategraf Aug 6, 2024

Wollac Aug 6, 2024

nategraf Aug 6, 2024

nategraf Aug 6, 2024

Wollac Aug 6, 2024

		ethers-core = "2.0"
		ethers-providers = "2.0"

WEB3-67: feat: switch Steel to alloy #183

WEB3-67: feat: switch Steel to alloy #183

Conversation

Wollac commented Jul 24, 2024 • edited Loading

⚡️ Features

🛠 Fixes

🚨 Breaking Changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nategraf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wollac Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wollac commented Jul 24, 2024 •

edited

Loading

Wollac Aug 6, 2024 •

edited

Loading