feat(forge): Paris & Shanghai support & add `prevrandao` cheatcode #4856

Evalir · 2023-04-30T00:24:14Z

Motivation

Right now the default spec is still London and most tooling will now make Shanghai the default spec. We should update everything related to selecting specs post london, for Paris and Shanghai support, but keep Paris as default until solidity .8.20 is out and ethers switches over.

Solution

Adds Paris and Shanghai as supported specs (with Paris as default as Ethers falls back to it), along with updating tests to use the new Prevrandao cheatcode included in this PR. Closes #4855.

This impacts a few things (will look at this after today, getting late):

Cheatcode tests: difficulty is used on a few I believe, and difficulty doesn't work from Paris onwards. I assume we'll want to change/add tests to use prevrandao (which by extension prob means we need a prevrandao cheatcode).
Ethers will be bumped to 2.0.4.

The files changed tab looks daunting, but bear with me—most of those changes are just modifying compiler output so that tests pass.

mds1 · 2023-04-30T02:14:44Z

One thing to consider is that many chains users deploy to won’t support Shanghai/PUSH0, so during scripting we may want to check the chain ID (from the RPC url) and warn or error if it’s a chain not known to support Shanghai. Otherwise users might build/deploy contracts that work during testing but not in production

…n on tests

Evalir · 2023-04-30T06:21:46Z

@mds1 yup that's a great observation. what do you prefer? Right now the solidity compiler does not support PUSH0 yet so just warning could be fine for now—it would only concern hufflang folks rn. cc @mattsse

0xMelkor · 2023-04-30T13:10:04Z

cli/src/cmd/forge/script/mod.rs

+            let provider = ethers::providers::Provider::<Http>::try_from(rpc)?;
+            let chain_id = provider.get_chainid().await?;
+            if chain_id != U256::one() {
+                shell::println(format!("Shanghai is only supported on Ethereum Mainnet (Chain ID 1). This RPC uses chain id {} therefore contracts using PUSH0 will not work.", chain_id))?;


I'd change this to a more meaningful description. The average user does not think in terms of assembly. I would instead reference the EIP-3855 and provide a link

Also shanghai is also supported on goerli and sepolia, not just mainnet

Yeah agreed this message could be better—and probably a bit louder as well. I'm still not 100% sold on only warning actually though: I've seen some discussion around the topic and we might wanna consider instead erroring (with some mechanism to bypass this). we'll have the same story in cancun with transient storage so that's why I'm giving it some more thought

Improved the warning message here: c5b29b8

did some improvements, here's an example of how it looks:

It maybe should be even bigger—lmk what you think about copy and if we should make it even louder!

mds1 · 2023-04-30T13:31:39Z

Right now the solidity compiler does not support PUSH0 yet so just warning could be fine for now

It will support it and make it the default soon, though: ethereum/solidity#14158

Since hardhat and solc are making shanghai the default (which makes sense, since ethereum mainnet is still the primary target of these tools), I think it's ok for foundry to do so also, but a loud warning before deployments feels like a nice mitigation

config/src/lib.rs

forge/tests/it/config.rs

cli/src/cmd/forge/script/mod.rs

Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>

DaniPopes

LGTM, 1 question which can be resolved in another PR.

DaniPopes · 2023-05-04T13:18:26Z

evm/src/utils.rs

+/// Converts an `EvmVersion` into a `SpecId`
+pub fn evm_spec(evm: &EvmVersion) -> SpecId {
+    match evm {
+        EvmVersion::Istanbul => SpecId::ISTANBUL,
+        EvmVersion::Berlin => SpecId::BERLIN,
+        EvmVersion::London => SpecId::LONDON,
+        EvmVersion::Paris => SpecId::MERGE,
+        EvmVersion::Shanghai => SpecId::SHANGHAI,
+        _ => panic!("Unsupported EVM version"),
+    }
+}


I know you added just Paris and Shanghai (current is just istanbul, berlin, london), but is there any reason we didn't have more versions mapped in the first place? This panics in some cases: #4873

EvmVersion docs, SpecId docs

Introduced in #918: cc @onbjerg @mattsse

I am actually not sure and is a pending question I have myself—I wanna try and document how we're using the hard forks and if there's any reason not to include them all (and if we want to, ideally in another PR).

Let's discuss in separate issue - i dont recall a particular reason

mattsse

nice work!

looks good, one nit re error check and message

mattsse · 2023-05-04T15:33:52Z

cli/src/cmd/forge/script/mod.rs

+        if !chain_ids_supported {
+            let msg = "\
+EIP-3855 is not supported in one or more of the RPCs used.
+Contracts deployed with a Solidity version equal or higher than 0.8.20 might not work properly.
+For more information, please see https://eips.ethereum.org/EIPS/eip-3855";
+            shell::println(Paint::yellow(msg))?;


it'd be good to include the chain id that does not support it her, otherwise the user needs to identify this manually.

sweet, here's how it would look:

Ah will quickly change the message so it points out these are chain IDs. EDIT: ad8803f

gakonst · 2023-05-05T19:54:30Z

cli/src/cmd/forge/script/mod.rs

+EIP-3855 is not supported in one or more of the RPCs used.
+Unsupported Chain IDs: {}.
+Contracts deployed with a Solidity version equal or higher than 0.8.20 might not work properly.
+For more information, please see https://eips.ethereum.org/EIPS/eip-3855"#,


gakonst · 2023-05-05T19:55:53Z

evm/src/utils.rs

+/// Converts an `EvmVersion` into a `SpecId`
+pub fn evm_spec(evm: &EvmVersion) -> SpecId {
+    match evm {
+        EvmVersion::Istanbul => SpecId::ISTANBUL,
+        EvmVersion::Berlin => SpecId::BERLIN,
+        EvmVersion::London => SpecId::LONDON,
+        EvmVersion::Paris => SpecId::MERGE,
+        EvmVersion::Shanghai => SpecId::SHANGHAI,
+        _ => panic!("Unsupported EVM version"),
+    }
+}


Let's discuss in separate issue - i dont recall a particular reason

gakonst · 2023-05-05T19:56:38Z

testdata/spec/ShanghaiCompat.t.sol

+        bytes memory bytecode = hex"365f5f37365ff3";
+        // 36 CALLDATASIZE
+        // 5F PUSH0
+        // 5F PUSH0
+        // 37 CALLDATACOPY -> copies calldata at mem[0..calldatasize]
+
+        // 36 CALLDATASIZE
+        // 5F PUSH0
+        // F3 RETURN -> returns mem[0..calldatasize]
+


- update pragmas to 0.8.18 - use preverando instead difficulty (need a version of foundry containing foundry-rs/foundry#4856)

chore: upgrade default evm version to shanghai for optimizoors

b849598

Evalir changed the title ~~chore: upgrade default evm version to shanghai for optimizoors~~ General: Upgrade default EVM spec Apr 30, 2023

Evalir changed the title ~~General: Upgrade default EVM spec~~ [WIP] feat(forge): Upgrade default EVM spec Apr 30, 2023

Evalir requested review from mattsse and onbjerg and removed request for mattsse and onbjerg April 30, 2023 01:24

Evalir added 4 commits April 29, 2023 22:49

fix: make test runner actually respect evm_version

b117e1d

chore: clippy?

a5a5304

chore: add paris and shanghai to available evm versions but run londo…

f803eae

…n on tests

chore: add missing post-merge block properties

c6b4ca2

Evalir marked this pull request as ready for review April 30, 2023 06:01

Evalir marked this pull request as draft April 30, 2023 06:32

chore: poc on checking for shanghai compat per RPC

523c299

0xMelkor reviewed Apr 30, 2023

View reviewed changes

DaniPopes reviewed Apr 30, 2023

View reviewed changes

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

forge/tests/it/config.rs Outdated Show resolved Hide resolved

Evalir added 6 commits April 30, 2023 13:50

chore: dedupe evm_spec fn

761b6ca

feat: set default test runner config to shanghai

0ef28a6

Merge branch 'master' into evalir/upgrade_evm_version

caa7b44

feat: add prevrandao cheatcode

0e83345

chore: modify tests to use prevrandao

b724d9c

chore: fmt

69a189a

Evalir changed the title ~~[WIP] feat(forge): Upgrade default EVM spec~~ [WIP] feat(forge): Upgrade default EVM spec & add prevrandao cheatcode May 1, 2023

Evalir marked this pull request as ready for review May 1, 2023 23:14

Evalir changed the title ~~[WIP] feat(forge): Upgrade default EVM spec & add prevrandao cheatcode~~ feat(forge): Upgrade default EVM spec & add prevrandao cheatcode May 1, 2023

Evalir marked this pull request as draft May 1, 2023 23:19

chore: move shanghai compat test to its own spec folder

5bd9126

Evalir requested a review from 0xMelkor May 3, 2023 12:22

chore: remove duplicated function

edef79b

Evalir force-pushed the evalir/upgrade_evm_version branch from 6c20c36 to edef79b Compare May 3, 2023 12:45

DaniPopes requested changes May 3, 2023

View reviewed changes

cli/src/cmd/forge/script/mod.rs Outdated Show resolved Hide resolved

cli/src/cmd/forge/script/mod.rs Outdated Show resolved Hide resolved

cli/src/cmd/forge/script/mod.rs Outdated Show resolved Hide resolved

cli/src/cmd/forge/script/mod.rs Outdated Show resolved Hide resolved

Evalir and others added 2 commits May 3, 2023 10:16

Apply suggestions from code review

b17b21c

Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>

feat: rewrite shanghai support check to be more efficient

d58ebae

Evalir requested a review from DaniPopes May 3, 2023 15:39

Evalir force-pushed the evalir/upgrade_evm_version branch from 12599da to 06e493b Compare May 3, 2023 15:46

chore: use any

87aea94

Evalir force-pushed the evalir/upgrade_evm_version branch from 06e493b to 87aea94 Compare May 3, 2023 16:13

chore: fmt

6cfe5c3

DaniPopes approved these changes May 4, 2023

View reviewed changes

mattsse requested changes May 4, 2023

View reviewed changes

Evalir mentioned this pull request May 4, 2023

when running the forge test it doesn't work Unsupported EVM version #4873

Closed

2 tasks

Evalir added 2 commits May 4, 2023 13:26

chore: show chain IDs that are unsupported

c846898

Merge branch 'master' into evalir/upgrade_evm_version

a864839

Evalir requested a review from mattsse May 4, 2023 18:05

chore: point out unsupported chain IDs explicitly in message

ad8803f

Evalir mentioned this pull request May 4, 2023

Forge test crashes on minimal repo #4880

Closed

2 tasks

gakonst approved these changes May 5, 2023

View reviewed changes

gakonst merged commit e48db34 into master May 5, 2023

gakonst deleted the evalir/upgrade_evm_version branch May 5, 2023 19:57

This was referenced May 6, 2023

feat(cheatcodes): Add vm.prevrandao to Vm.sol foundry-rs/forge-std#373

Closed

docs: Add prevrandao cheatcode foundry-rs/book#889

Merged

grandizzy added a commit to ajna-finance/ajna-grants that referenced this pull request May 8, 2023

Q-AJN-8: Old Version of Solidity

e3099da

- update pragmas to 0.8.18 - use preverando instead difficulty (need a version of foundry containing foundry-rs/foundry#4856)

grandizzy mentioned this pull request May 8, 2023

Q-AJN-8: Old Version of Solidity ajna-finance/ajna-grants#73

Merged

grandizzy added a commit to ajna-finance/ajna-grants that referenced this pull request May 8, 2023

Q-AJN-8: Old Version of Solidity (#73)

88c81b8

- update pragmas to 0.8.18 - use preverando instead difficulty (need a version of foundry containing foundry-rs/foundry#4856)

vdrg mentioned this pull request May 8, 2023

Remove everything related to block difficulty nomoixyz/vulcan#110

Merged

Evalir mentioned this pull request May 11, 2023

feat(cheatcodes): Add vm.prevrandao to Vm.sol foundry-rs/forge-std#377

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(forge): Paris & Shanghai support & add `prevrandao` cheatcode #4856

feat(forge): Paris & Shanghai support & add `prevrandao` cheatcode #4856

Evalir commented Apr 30, 2023 •

edited

Loading

mds1 commented Apr 30, 2023

Evalir commented Apr 30, 2023

0xMelkor Apr 30, 2023

mds1 Apr 30, 2023

Evalir Apr 30, 2023 •

edited

Loading

Evalir May 2, 2023

Evalir May 2, 2023

mds1 commented Apr 30, 2023

DaniPopes left a comment

DaniPopes May 4, 2023

Evalir May 4, 2023

gakonst May 5, 2023

mattsse left a comment

mattsse May 4, 2023

Evalir May 4, 2023

Evalir May 4, 2023 •

edited

Loading

gakonst May 5, 2023

gakonst May 5, 2023

gakonst May 5, 2023

feat(forge): Paris & Shanghai support & add prevrandao cheatcode #4856

feat(forge): Paris & Shanghai support & add prevrandao cheatcode #4856

Conversation

Evalir commented Apr 30, 2023 • edited Loading

Motivation

Solution

mds1 commented Apr 30, 2023

Evalir commented Apr 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Evalir Apr 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mds1 commented Apr 30, 2023

DaniPopes 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

mattsse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Evalir May 4, 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

feat(forge): Paris & Shanghai support & add `prevrandao` cheatcode #4856

feat(forge): Paris & Shanghai support & add `prevrandao` cheatcode #4856

Evalir commented Apr 30, 2023 •

edited

Loading

Evalir Apr 30, 2023 •

edited

Loading

Evalir May 4, 2023 •

edited

Loading