feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986

Evalir · 2023-10-05T01:53:04Z

Ports of most of Foundry to use all the crates alloy/core, replacing common types, and ABI encoding/decoding.

Behavior should be mostly the same as our test suite is able to catch these, albeit manual testing was done with larger repos as well (Sparklend/Maple) with positive results.

It also removes a big portion of glue code from the codebase. The glue that remains is:

Tied to RPC types and providers, which will come up next, replaced per-crate in followup PRs.
Console log decoding on decode.rs still uses abigen, as the feature to decode typed logs is still missing from Alloy. See feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986 (comment)

ethers::etherscan and ethers::solc have also been removed in favor of foundry-block-explorers and foundry-compilers, which means we now have full ownership of these and do not depend on ethers anymore for this functionality.

Our dependency on ethers now consists of only:

RPC Types
Providers
Misc. wallet management utilities and libraries contained (aws, trezor, ledger, etc).

Planned followups are:

Finish cheatcode refactor to use static encoder
Move main executor to use SolCall.

gakonst

Good start

gakonst · 2023-10-06T20:51:33Z

crates/evm/src/trace/decoder.rs

@@ -144,25 +140,25 @@ impl CallTraceDecoder {
            // TODO: These are the Ethereum precompiles. We should add a way to support precompiles
            // for other networks, too.
            precompiles: precompiles!(
-                0x01: ecrecover(hash: FixedBytes(32), v: Uint(256), r: Uint(256), s: Uint(256)) -> (publicAddress: Address),


This change looks a bit odd cc @DaniPopes

The whole point of this macro is to make it easy to modify. Slapping format everywhere doesn't really help towards that. Anyway I am working on removing this in #5998 since some precompiles don't adhere to ABI so it doesn't matter.

gakonst · 2023-10-06T20:54:01Z

crates/evm/src/trace/mod.rs

-    core::utils::to_checksum,
-    types::{Bytes, DefaultFrame, GethDebugTracingOptions, StructLog, H256, U256},
-};
+use ethers::types::{DefaultFrame, GethDebugTracingOptions, StructLog};


These types should also go to alloy? I guess RPC crate under core/?

Think good opportunity to get that started, along with the TxRequest/Response/Receipt?

yep, we should move these to alloy somehow. Probably reth might have these somewhat reworked

crates/evm/src/trace/mod.rs

crates/evm/src/trace/node.rs

crates/evm/src/fuzz/strategies/int.rs

crates/evm/src/fuzz/strategies/param.rs

crates/evm/src/fuzz/strategies/state.rs

crates/evm/src/fuzz/strategies/uint.rs

crates/evm/src/trace/node.rs

DaniPopes · 2023-10-17T09:33:15Z

crates/evm/src/trace/decoder.rs

@@ -144,25 +140,25 @@ impl CallTraceDecoder {
            // TODO: These are the Ethereum precompiles. We should add a way to support precompiles
            // for other networks, too.
            precompiles: precompiles!(
-                0x01: ecrecover(hash: FixedBytes(32), v: Uint(256), r: Uint(256), s: Uint(256)) -> (publicAddress: Address),


The whole point of this macro is to make it easy to modify. Slapping format everywhere doesn't really help towards that. Anyway I am working on removing this in #5998 since some precompiles don't adhere to ABI so it doesn't matter.

crates/evm/src/fuzz/strategies/param.rs

crates/abi/src/bindings/alloy_console.rs

crates/abi/src/bindings/mod.rs

crates/evm/src/executor/mod.rs

crates/evm/src/decode.rs

crates/cast/bin/cmd/storage.rs

gakonst

I'm generally supportive of moving forward with this PR but want to point out a few things:

There's some code that was vendored over from ethers-rs to keep things going, that's fine but I would like to keep track of that code and what the plan is for it (e.g. Numeric type, unit conversions)
There's a few APIs that seem to have gotten worse not better, e.g. the DynSolValue decoding stuff, or the req for the user to pass validate=false to the decoder
I really dislike the U256::from stuff and think there must be a From impl that will work with us, please investigate what the path for including From for U256 is in ruint.

Basically, I like that we're moving forward, but I think in some places we need to look at the code and say "hey actually this became worse and it looks like there's something missing from Alloy, let me fix that first".

gakonst · 2023-10-24T19:19:17Z

Cargo.toml

+ethers = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-addressbook = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-core = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-contract = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-contract-abigen = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-providers = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-signers = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-middleware = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-etherscan = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+ethers-solc = { git = "https://github.com/gakonst/ethers-rs", rev = "9754f22d06a2defe5608c4c9b809cc361443a3dc" }
+
+foundry-compilers = { git = "https://github.com/foundry-rs/compilers" }
+foundry-block-explorers = { git = "https://github.com/foundry-rs/block-explorers"}
+
+alloy-dyn-abi = { git = "https://github.com/alloy-rs/core/" }
+alloy-primitives = { git = "https://github.com/alloy-rs/core/" }
+alloy-json-abi = { git = "https://github.com/alloy-rs/core/" }
+alloy-sol-types = { git = "https://github.com/alloy-rs/core/" }


what's the path towards removing these patches? why do we need them?

The main offender is foundry-block-explorers needing the chain enum from ethers. Once we have alloy-rs/chains we can publish both block explorers and compilers and remove the patches. For alloy, we need a newer release with all the new features we're using off of master.

gakonst · 2023-10-24T19:23:39Z

crates/cast/bin/cmd/create2.rs

-                    salt.clone(),
-                    init_code_hash,
-                ));
+                let addr = SimpleCast::to_checksum_address(&deployer.create2(salt, init_code_hash));


Agree supportive of combining the two if the functions are simple enough.

gakonst · 2023-10-24T19:26:32Z

crates/cast/bin/cmd/estimate.rs

-        value_parser = NameOrAddress::from_str,
+        value_parser = Address::from_str,
        default_value = "0x0000000000000000000000000000000000000000",
        env = "ETH_FROM",
    )]
-    from: NameOrAddress,
+    from: Address,


this should also remain nameoraddress -- maybe i didn't communicate this appropriately, my thought was that we pull in NameOrAddress from ethers-rs, and in the CLI you have a helper method that does the resolution for you, where you'd convert the ethers-rs returned Address from the ENS string to an Alloy Address

gakonst · 2023-10-24T19:27:29Z

crates/cast/bin/cmd/logs.rs

@@ -208,6 +211,78 @@ fn build_filter_topics(topics: Vec<String>) -> Result<TopicFilter, eyre::Error>
    })
 }

+fn parse_params<'a, I: IntoIterator<Item = (&'a ParamType, &'a str)>>(


Should this whole function be part of alloy?

gakonst · 2023-10-24T19:39:23Z

crates/evm/src/trace/decoder.rs

-                0x07: ecmul(x1: Uint(256), y1: Uint(256), s: Uint(256)) -> (x: Uint(256), y: Uint(256)),
-                0x08: ecpairing(x1: Uint(256), y1: Uint(256), x2: Uint(256), y2: Uint(256), x3: Uint(256), y3: Uint(256)) -> (success: Uint(256)),
-                0x09: blake2f(rounds: Uint(4), h: FixedBytes(64), m: FixedBytes(128), t: FixedBytes(16), f: FixedBytes(1)) -> (h: FixedBytes(64)),
+                0x01: ecrecover(hash: format!("bytes32"), v: format!("uint256"), r: format!("uint256"), s: format!("uint256")) -> (publicAddress: format!("address")),


this is very ugly and needs to be removed -- what's the plan for this? sol macro? let's pls track this?

Tracking on #6102

crates/evm/src/decode.rs

crates/config/src/utils.rs

crates/common/src/compile.rs

gakonst · 2023-10-24T20:19:43Z

crates/cli/src/utils/mod.rs

-        U256::from_str(value)?
+        U256::from_str_radix(value, 16)?
    } else {
-        U256::from(LenientTokenizer::tokenize_uint(value)?)
+        alloy_dyn_abi::DynSolType::coerce_str(&alloy_dyn_abi::DynSolType::Uint(256), value)?
+            .as_uint()
+            .wrap_err("Could not parse ether value from string")?
+            .0


this got more complex now, how do we simplify it back?

A move to SolCall should simplify this—will be done on a followup

…ecode.rs)

Evalir · 2023-10-25T07:57:33Z

Merging—CI is flaky due to arbitrum rpc limiting (happening on other PRs as well)

feat: find and replace all ethers_solc mentions outside anvil

ee18e87

Evalir changed the title ~~[WIP] feat: introduce foundry-compilers~~ [WIP] feat: foundry-compilers & alloy_json_abi EVM migration Oct 5, 2023

Evalir added 3 commits October 5, 2023 12:47

chore: keep resolving errors as fuzz is getting migrated

6c6aa4e

feat: fuzz/trace changes

f33e414

feat: partial trace migration

a8bb5b0

gakonst reviewed Oct 6, 2023

View reviewed changes

DaniPopes requested changes Oct 10, 2023

View reviewed changes

crates/evm/src/fuzz/strategies/int.rs Outdated Show resolved Hide resolved

crates/evm/src/fuzz/strategies/param.rs Show resolved Hide resolved

Evalir mentioned this pull request Oct 16, 2023

feat: foundry-cheatcodes #5998

Merged

16 tasks

DaniPopes mentioned this pull request Oct 16, 2023

Display parameter name alongside value if present in call traces #6048

Closed

Evalir added 2 commits October 17, 2023 18:17

chore: use temporal sol! macro in diff file for decode migration

adc2786

feat: use proptest traits instead of custom impl

8bc67d2

DaniPopes requested changes Oct 17, 2023

View reviewed changes

chore: address comments

65f0918

Evalir force-pushed the evalir/introduce-foundry-compilers branch from 691e3d5 to 65f0918 Compare October 17, 2023 10:26

Evalir added 8 commits October 17, 2023 19:29

chore: remove alloy console bindings

a54005a

feat: introduce foundry-block-explorers

2c70bd9

chore: partial common abi helpers migration

55ad9bf

feat: partial decode migration

94fb974

feat: re-introduce block-explorers

b3935cc

feat: fix compiler errors

8737a52

chore

988e756

chore: tentative inspector migration

5b8c207

Evalir commented Oct 18, 2023

View reviewed changes

crates/evm/src/executor/mod.rs Show resolved Hide resolved

Evalir added 3 commits October 18, 2023 22:54

Merge branch 'master' into evalir/introduce-foundry-compilers

bd2fbb3

feat: switch to using static decoder to decode errors

3c3b35c

chore: clippy

7484d3b

gakonst reviewed Oct 18, 2023

View reviewed changes

crates/evm/src/decode.rs Outdated Show resolved Hide resolved

Evalir added 3 commits October 19, 2023 13:40

feat: migrate trace types temporarily

3adebd5

chore: replace ethers tracing types for local tracing types

c44e796

chore: rebase

b51f741

Evalir force-pushed the evalir/introduce-foundry-compilers branch from f4738e1 to fb7bd39 Compare October 24, 2023 13:33

Evalir added 2 commits October 24, 2023 23:06

chore: resolve comments, more cleanup, remove unwraps

5500c14

chore: remove last mentions of ethers::etherscan

e4e347a

Evalir changed the title ~~feat(deps): Move to Alloy ABI encoding/decoding~~ feat(deps): Move to Alloy ABI encoding/decoding & alloy types Oct 24, 2023

Evalir requested review from DaniPopes and gakonst October 24, 2023 14:33

Evalir added 3 commits October 24, 2023 23:44

chore: remove ethers-solc feat

823a6e3

Merge branch 'master' into evalir/introduce-foundry-compilers

27f107a

chore: use alloy master again

cf7fdce

mattsse requested changes Oct 24, 2023

View reviewed changes

crates/cast/bin/cmd/storage.rs Outdated Show resolved Hide resolved

Evalir added 2 commits October 25, 2023 02:58

chore: readd NameOrAddress

371e817

chore: clippy/fmt

4e4e4c1

DaniPopes approved these changes Oct 24, 2023

View reviewed changes

chore: readd support on storage

bcd565f

Evalir mentioned this pull request Oct 24, 2023

Improvement: Migrate Executor to SolCall and define calls ahead of time #6098

Closed

gakonst approved these changes Oct 24, 2023

View reviewed changes

Evalir added 2 commits October 25, 2023 15:03

fix: add remappings on settings

bd3e506

chore: address comments (remove create2, noop map, remove eyre from d…

f958758

…ecode.rs)

Evalir mentioned this pull request Oct 25, 2023

Remove and dedupe ethers-rs vendored code #6104

Closed

chore: use NameOrAddress

963234d

Evalir merged commit 251ef74 into master Oct 25, 2023
16 of 17 checks passed

Evalir deleted the evalir/introduce-foundry-compilers branch October 25, 2023 07:57

This was referenced Oct 25, 2023

fix(anvil): format DynSolValues for printing on anvil errors #6111

Merged

feat(cli): migrate cli to alloy #5920

Closed

This was referenced Nov 1, 2023

wip: wallet/access list mig #5921

Closed

fix(cheatcodes): improve the error message when decoding possible hex values #6041

Closed

This was referenced Apr 26, 2024

Reset to upstream phylaxsystems/phoundry#12

Merged

feat/forge bin as lib phylaxsystems/phoundry#13

Merged

zerosnacks mentioned this pull request Jul 4, 2024

Display parameter name alongside value if present in call traces paradigmxyz/revm-inspectors#158

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986

feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986

Evalir commented Oct 5, 2023 •

edited

Loading

gakonst left a comment

gakonst Oct 6, 2023

DaniPopes Oct 17, 2023

gakonst Oct 6, 2023

Evalir Oct 7, 2023

DaniPopes Oct 17, 2023

gakonst left a comment

gakonst Oct 24, 2023

Evalir Oct 25, 2023 •

edited

Loading

gakonst Oct 24, 2023

gakonst Oct 24, 2023

gakonst Oct 24, 2023

gakonst Oct 24, 2023

Evalir Oct 25, 2023

gakonst Oct 24, 2023

Evalir Oct 25, 2023

Evalir commented Oct 25, 2023

feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986

feat(deps): Move to Alloy ABI encoding/decoding & alloy types #5986

Conversation

Evalir commented Oct 5, 2023 • edited Loading

gakonst left a 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

Choose a reason for hiding this comment

gakonst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Evalir Oct 25, 2023 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Evalir commented Oct 25, 2023

Evalir commented Oct 5, 2023 •

edited

Loading

Evalir Oct 25, 2023 •

edited

Loading