[revive] revm backend (#9285)

# EVM initial support  for pallet-revive

Initial EVM support via the REVM crate to create a dual-VM system that
can execute both PolkaVM and EVM

- Added `AllowEVMBytecode: Get<bool>` to the config to enable/disable
EVM call and instantiation
- CodeInfo has been updated to add the type of bytecode (EVM / PVM).
`migration/v2.rs` takes care of migrating existing storages
- The CodeUploadDeposit is not held by a pallet account instead of being
held on the uploader, It's automatically refunded when the refcount
drops to 0 and the code is removed.
- The basic flow of uploading an EVM contract and running it should work
- instructions are copied and adapted from REVM they should be ignored
in this PR and reviewed in follow-up PR
(**reviewers** please ignore
`substrate/frame/revive/src/vm/evm/instructions/*` for now)

## Implementation Guidelines

### Basic Instruction Structure
A basic instruction looks like this:

```rust
pub fn coinbase<'ext, E: Ext>(context: Context<'_, 'ext, E>) {
	gas_legacy!(context.interpreter, revm_gas::BASE);
	push!(context.interpreter, context.host.beneficiary().into_word().into());
}
```

### Required Changes for REVM Instructions

All instructions have been copied from `REVM` and updated with generic
types for pallet-revive. Two main changes are required:

#### 1. Gas Handling
Replace REVM gas calls with existing benchmarks where available:

```diff
- gas_legacy!(context.interpreter, revm_gas::BASE);
+ gas!(context.interpreter, RuntimeCosts::BlockAuthor);
```

#### 2. Context Access
Replace `context.host` calls with `context.extend` (set to `&mut Ext`):

```diff
- push!(context.interpreter, context.host.beneficiary().into_word().into());
+ let coinbase: Address = context.interpreter.extend.block_author().unwrap_or_default().0.into();
+ push!(context.interpreter, coinbase.into_word().into());
```

### Gas Benchmarking Notes
- For cases without existing benchmarks (e.g arithmetic, bitwise) , we
will keep `gas_legacy!`
- The u64 gas value are multiplied by a base cost benchmarked by
`evm_opcode`

- ### Important Rules
- All calls to `context.host` should be removed (initialized to default
values)
- All calls to `context.interpreter.gas` should be removed (except
`gas.memory` handled by `resize_memory!` macro)
- See `block_number` implementation as a reference example

The following instructions in src/vm/evm/instructions/** need to be
updated

### Basic Instructions

We probably don't need to touch these implementations here, they use the
gas_legacy! macro to charge a low gas value that will be scaled with our
gas_to_weight benchmark. The only thing needed here are tests that
exercise these instructions

<details>

#### Arithmetic Instructions

- [ ] **add**
- [ ] **mul**
- [ ] **sub**
- [ ] **div**
- [ ] **sdiv**
- [ ] **rem**
- [ ] **smod**
- [ ] **addmod**
- [ ] **mulmod**
- [ ] **exp**
- [ ] **signextend**

#### Bitwise Instructions

- [ ] **lt**
- [ ] **gt**
- [ ] **slt**
- [ ] **sgt**
- [ ] **eq**
- [ ] **iszero**
- [ ] **bitand**
- [ ] **bitor**
- [ ] **bitxor**
- [ ] **not**
- [ ] **byte**
- [ ] **shl**
- [ ] **shr**
- [ ] **sar**
- [ ] **clz**

#### Control Flow Instructions

- [ ] **jump**
- [ ] **jumpi**
- [ ] **jumpdest**
- [ ] **pc**
- [ ] **stop**
- [ ] **ret**
- [ ] **revert**
- [ ] **invalid**

### Memory Instructions
- [ ] **mload**
- [ ] **mstore**
- [ ] **mstore8**
- [ ] **msize**
- [ ] **mcopy**

#### Stack Instructions
- [ ] **pop**
- [ ] **push0**
- [ ] **push**
- [ ] **dup**
- [ ] **swap**

</details>

### Sys calls instructions

These instructions should be updated from using gas_legacy! to gas! with
the appropriate RuntimeCost, the returned value need to be pulled from
our `&mut Ext` ctx.interpreter.extend instead of the host or input
context value

<details>

#### Block Info Instructions

- [x] **block_number**
- [ ] **coinbase**
- [ ] **timestamp**
- [ ] **difficulty**
- [ ] **gaslimit**
- [ ] **chainid**
- [ ] **basefee**
- [ ] **blob_basefee**

#### Host Instructions

- [ ] **balance**
- [ ] **extcodesize**
- [ ] **extcodecopy**
- [ ] **extcodehash**
- [ ] **blockhash**
- [ ] **sload**
- [ ] **sstore**
- [ ] **tload**
- [ ] **tstore**
- [ ] **log**
- [ ] **selfdestruct**
- [ ] **selfbalance**

#### System Instructions
- [ ] **keccak256**
- [ ] **address**
- [ ] **caller**
- [ ] **callvalue**
- [ ] **calldataload**
- [ ] **calldatasize**
- [ ] **calldatacopy**
- [ ] **codesize**
- [ ] **codecopy**
- [ ] **returndatasize**
- [ ] **returndatacopy**
- [ ] **gas**

#### Transaction Info Instructions
- [ ] **origin**
- [ ] **gasprice**
- [ ] **blob_hash**

</details>

### Contract Instructions

These instructions should be updated,, that's where I expect the most
code change in the instruction implementation.
See how it's done in vm/pvm module, the final result should look pretty
similar to what we are doing there with the addition of custom gas_limit
calculation that works with our gas model.

see also example code here https://github.com/paritytech/revm_example

<details>

- [ ] **create**
- [ ] **create**
- [ ] **call**
- [ ] **call_code**
- [ ] **delegate_call**
- [ ] **static_call**

</details>

---------

Signed-off-by: Cyrill Leutwiler <[email protected]>
Signed-off-by: xermicus <[email protected]>
Co-authored-by: cmd[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Alexander Theißen <[email protected]>
Co-authored-by: xermicus <[email protected]>
Co-authored-by: 0xRVE <[email protected]>
Co-authored-by: Robert van Eerdewijk <[email protected]>

Author: 6 people

.github/workflows/tests-misc.yml

@@ -370,6 +370,17 @@ jobs:
           components: cargo, clippy, rust-docs, rust-src, rustfmt, rustc, rust-std
       - name: Install protobuf
         run: brew install protobuf
+      - name: install solc
+        run: brew install solidity
+      - name: Install resolc
+        run: |
+          VERSION="0.3.0"
+          ASSET_URL="https://github.com/paritytech/revive/releases/download/v$VERSION/resolc-universal-apple-darwin"
+          echo "Downloading resolc v$VERSION from $ASSET_URL"
+          curl -Lsf --show-error -o $HOME/.cargo/bin/resolc "$ASSET_URL"
+          chmod +x $HOME/.cargo/bin/resolc
+          xattr -c $HOME/.cargo/bin/resolc
+          resolc --version
       - name: cargo info
         run: |
           echo "######## rustup show ########"
@@ -406,3 +417,4 @@ jobs:
           else
             echo '### Good job! All the required jobs passed 🚀' >> $GITHUB_STEP_SUMMARY
           fi
+

cumulus/parachains/runtimes/assets/asset-hub-westend/src/lib.rs

@@ -1182,6 +1182,10 @@ impl pallet_revive::Config for Runtime {
 	type RuntimeMemory = ConstU32<{ 128 * 1024 * 1024 }>;
 	type PVFMemory = ConstU32<{ 512 * 1024 * 1024 }>;
 	type UnsafeUnstableInterface = ConstBool<false>;
+	#[cfg(feature = "runtime-benchmarks")]
+	type AllowEVMBytecode = ConstBool<true>;
+	#[cfg(not(feature = "runtime-benchmarks"))]
+	type AllowEVMBytecode = ConstBool<false>;
 	type UploadOrigin = EnsureSigned<Self::AccountId>;
 	type InstantiateOrigin = EnsureSigned<Self::AccountId>;
 	type RuntimeHoldReason = RuntimeHoldReason;
@@ -1199,7 +1203,10 @@ parameter_types! {
 impl pallet_migrations::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	#[cfg(not(feature = "runtime-benchmarks"))]
-	type Migrations = pallet_revive::migrations::v1::Migration<Runtime>;
+	type Migrations = (
+		pallet_revive::migrations::v1::Migration<Runtime>,
+		pallet_revive::migrations::v2::Migration<Runtime>,
+	);
 	// Benchmarks need mocked migrations to guarantee that they succeed.
 	#[cfg(feature = "runtime-benchmarks")]
 	type Migrations = pallet_migrations::mock_helpers::MockedMigrations;

cumulus/parachains/runtimes/assets/asset-hub-westend/tests/tests.rs

@@ -1664,11 +1664,14 @@ fn weight_of_message_increases_when_dealing_with_erc20s() {
 fn withdraw_and_deposit_erc20s() {
 	let sender: AccountId = ALICE.into();
 	let beneficiary: AccountId = BOB.into();
+	let revive_account = pallet_revive::Pallet::<Runtime>::account_id();
 	let checking_account =
 		asset_hub_westend_runtime::xcm_config::ERC20TransfersCheckingAccount::get();
 	let initial_wnd_amount = 10_000_000_000_000u128;
 
 	ExtBuilder::<Runtime>::default().build().execute_with(|| {
+		// Bring the revive account to life.
+		assert_ok!(Balances::mint_into(&revive_account, initial_wnd_amount));
 		// We need to give enough funds for every account involved so they
 		// can call `Revive::map_account`.
 		assert_ok!(Balances::mint_into(&sender, initial_wnd_amount));
@@ -1729,13 +1732,16 @@ fn withdraw_and_deposit_erc20s() {
 fn non_existent_erc20_will_error() {
 	let sender: AccountId = ALICE.into();
 	let beneficiary: AccountId = BOB.into();
+	let revive_account = pallet_revive::Pallet::<Runtime>::account_id();
 	let checking_account =
 		asset_hub_westend_runtime::xcm_config::ERC20TransfersCheckingAccount::get();
 	let initial_wnd_amount = 10_000_000_000_000u128;
 	// We try to withdraw an ERC20 token but the address doesn't exist.
 	let non_existent_contract_address = [1u8; 20];
 
 	ExtBuilder::<Runtime>::default().build().execute_with(|| {
+		// Bring the revive account to life.
+		assert_ok!(Balances::mint_into(&revive_account, initial_wnd_amount));
 		// We need to give enough funds for every account involved so they
 		// can call `Revive::map_account`.
 		assert_ok!(Balances::mint_into(&sender, initial_wnd_amount));
@@ -1772,11 +1778,15 @@ fn non_existent_erc20_will_error() {
 fn smart_contract_not_erc20_will_error() {
 	let sender: AccountId = ALICE.into();
 	let beneficiary: AccountId = BOB.into();
+	let revive_account = pallet_revive::Pallet::<Runtime>::account_id();
 	let checking_account =
 		asset_hub_westend_runtime::xcm_config::ERC20TransfersCheckingAccount::get();
 	let initial_wnd_amount = 10_000_000_000_000u128;
 
 	ExtBuilder::<Runtime>::default().build().execute_with(|| {
+		// Bring the revive account to life.
+		assert_ok!(Balances::mint_into(&revive_account, initial_wnd_amount));
+
 		// We need to give enough funds for every account involved so they
 		// can call `Revive::map_account`.
 		assert_ok!(Balances::mint_into(&sender, initial_wnd_amount));
@@ -1822,11 +1832,15 @@ fn smart_contract_not_erc20_will_error() {
 fn smart_contract_does_not_return_bool_fails() {
 	let sender: AccountId = ALICE.into();
 	let beneficiary: AccountId = BOB.into();
+	let revive_account = pallet_revive::Pallet::<Runtime>::account_id();
 	let checking_account =
 		asset_hub_westend_runtime::xcm_config::ERC20TransfersCheckingAccount::get();
 	let initial_wnd_amount = 10_000_000_000_000u128;
 
 	ExtBuilder::<Runtime>::default().build().execute_with(|| {
+		// Bring the revive account to life.
+		assert_ok!(Balances::mint_into(&revive_account, initial_wnd_amount));
+
 		// We need to give enough funds for every account involved so they
 		// can call `Revive::map_account`.
 		assert_ok!(Balances::mint_into(&sender, initial_wnd_amount));
@@ -1875,11 +1889,15 @@ fn smart_contract_does_not_return_bool_fails() {
 fn expensive_erc20_runs_out_of_gas() {
 	let sender: AccountId = ALICE.into();
 	let beneficiary: AccountId = BOB.into();
+	let revive_account = pallet_revive::Pallet::<Runtime>::account_id();
 	let checking_account =
 		asset_hub_westend_runtime::xcm_config::ERC20TransfersCheckingAccount::get();
 	let initial_wnd_amount = 10_000_000_000_000u128;
 
 	ExtBuilder::<Runtime>::default().build().execute_with(|| {
+		// Bring the revive account to life.
+		assert_ok!(Balances::mint_into(&revive_account, initial_wnd_amount));
+
 		// We need to give enough funds for every account involved so they
 		// can call `Revive::map_account`.
 		assert_ok!(Balances::mint_into(&sender, initial_wnd_amount));

cumulus/parachains/runtimes/testing/penpal/src/lib.rs

@@ -853,6 +853,7 @@ impl pallet_revive::Config for Runtime {
 	type RuntimeMemory = ConstU32<{ 128 * 1024 * 1024 }>;
 	type PVFMemory = ConstU32<{ 512 * 1024 * 1024 }>;
 	type UnsafeUnstableInterface = ConstBool<true>;
+	type AllowEVMBytecode = ConstBool<true>;
 	type UploadOrigin = EnsureSigned<Self::AccountId>;
 	type InstantiateOrigin = EnsureSigned<Self::AccountId>;
 	type RuntimeHoldReason = RuntimeHoldReason;

prdoc/pr_9285.prdoc

@@ -0,0 +1,17 @@
+title: '[revive] revm backend'
+doc:
+- audience: Runtime Dev
+  description: |
+    Initial EVM support for pallet-revive via the REVM crate to create a dual-VM system that can execute both PolkaVM and EVM
+    - Added AllowEVMBytecode: Get<bool> to the config to enable/disable EVM call and instantiation
+    - The basic flow of uploading an EVM contract and running it should work
+    - instructions are copied and adapted from REVM they should be ignored in this PR and reviewed in follow-up PR
+crates:
+- name: pallet-revive
+  bump: major
+- name: pallet-revive-fixtures
+  bump: patch
+- name: asset-hub-westend-runtime
+  bump: patch
+- name: penpal-runtime
+  bump: patch

substrate/bin/node/runtime/src/lib.rs

@@ -1490,6 +1490,7 @@ impl pallet_revive::Config for Runtime {
 	type NativeToEthRatio = ConstU32<1_000_000>; // 10^(18 - 12) Eth is 10^18, Native is 10^12.
 	type EthGasEncoder = ();
 	type FindAuthor = <Runtime as pallet_authorship::Config>::FindAuthor;
+	type AllowEVMBytecode = ConstBool<true>;
 }
 
 impl pallet_sudo::Config for Runtime {

substrate/frame/revive/fixtures/build.rs

@@ -463,7 +463,7 @@ fn generate_fixture_location(temp_dir: &Path, out_dir: &Path, entries: &[Entry])
 	// Generate sol! macros for Solidity contracts
 	for entry in entries.iter().filter(|e| matches!(e.contract_type, ContractType::Solidity)) {
 		let relative_path = format!("contracts/{}", entry.path().split('/').last().unwrap());
-		writeln!(file, r#"alloy_core::sol!("{}");"#, relative_path)
+		writeln!(file, r#"#[cfg(feature = "std")] alloy_core::sol!("{}");"#, relative_path)
 			.context("Failed to write sol! macro to fixture_location.rs")?;
 	}
 

substrate/frame/revive/fixtures/contracts/Fibonacci.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+contract Fibonacci {
+    function fib(uint n) public pure returns (uint) {
+        if (n <= 1) {
+            return n;
+        }
+        return fib(n - 1) + fib(n - 2);
+    }
+}