Support multiple underlying uint256 libraries (#399)

* Use uint reexport

Remove all reference of primitive_types except in evm_interpreter::uint.
Eventually this will allow us to support multiple underlying uint types.

* Run cargo fmt

* All skeletons needed for ruint and ethnum

* Add ZERO and ONE consts in U256Ext

* Move to_h256/from_h256 to_h160/from_h160 to U256Ext

* Make ruint compile

* Get ethnum to compile

* Make everything compile

We still need to implement those trait functions.

* Run cargo fmt

* Fix CI

* Unbreak semver for evm-interpreter

There's no reason to break it, just adding a few old functions back.

* Run cargo fmt

* Only require main crate to be built against ruint and ethnum

* Explicitly select packages to build for ruint and ethnum

* Run cargo fmt

* Add allow unused_imports

* Mark U256Ext as doc(hidden)

We expect frequent change in this trait, so we don't want it to be part of the
public API.

* Seal U256Ext trait

* Impl from/to_h256 for ethnum and ruint

* Rename addmod -> add_mod, mulmod -> mul_mod

* Native ruint add_mod and mul_mod

* Finish all ruint impls

* Better conversion function naming for uint

* Distinguish external and internal crates

External crates are not allowed to use U256Ext.

* Fix tests for ruint and ethnum

* Remove ethnum

Too different compared with primitive-types and ruint to reliably support.
Some semantics doesn't follow common uint standard.
Perhaps at a later date when we have type alias impl trait.

* Fix lint

* Run cargo fmt

* Allow unused imports of U256Ext

* Update rust toolchain to 1.92

* Make ruint compile on the rest of the crates

* Time-consuming tests

* Bump evm/evm-interpreter to 1.1.0

Author: sorpaas

.github/workflows/rust.yml

@@ -24,8 +24,11 @@ jobs:
       run: cargo clippy --workspace -- -D warnings
     - name: clippy no-std
       run: cargo clippy --workspace --no-default-features --all-targets -- -D warnings
-    - name: clippy with features
-      run: cargo clippy --workspace --all-features --all-targets -- -D warnings
+    - name: clippy with normal features
+      run: cargo clippy --workspace --features std,scale,serde --all-targets -- -D warnings
+    - name: clippy with ruint
+      run: cargo clippy --workspace --features ruint --all-targets -- -D warnings
+
   build:
     runs-on: ubuntu-latest
     steps:
@@ -35,28 +38,41 @@ jobs:
     - name: Build no-std
       run: cargo build --no-default-features
     - name: Build all-features
-      run: cargo build --all-features
-    - name: Run tests
-      run: cargo test --verbose
+      run: cargo build --workspace --features std,scale,serde
+    - name: Build ruint
+      run: cargo build --workspace --features ruint
+
   semver:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v5
     - name: Install cargo-semver-checks
       run: cargo install cargo-semver-checks --locked
     - name: SemVer evm-interpreter
-      run: cargo semver-checks -p evm-interpreter
+      run: cargo semver-checks --default-features -p evm-interpreter
     - name: SemVer evm
-      run: cargo semver-checks -p evm
+      run: cargo semver-checks --default-features -p evm
     - name: SemVer evm-precompile
-      run: cargo semver-checks -p evm-precompile
+      run: cargo semver-checks --default-features -p evm-precompile
     - name: SemVer evm-mainnet
-      run: cargo semver-checks -p evm-mainnet
+      run: cargo semver-checks --default-features -p evm-mainnet
+
   tests:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v5
       with:
         submodules: recursive
-    - name: Run tests
+    - name: Run main tests
       run: cargo test --all --release --verbose
+    - name: Run ruint tests.
+      run: cargo test --all --release --verbose --features ruint
+
+  time-consuming-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        submodules: recursive
+    - name: Run time consuming tests.
+      run: cargo test --all --release --verbose --features time-consuming

Cargo.toml

@@ -22,15 +22,15 @@ repository = "https://github.com/rust-ethereum/evm"
 keywords = ["no_std", "ethereum", "evm"]
 
 [workspace.dependencies]
-evm = { version = "1.0.0", path = ".", default-features = false }
-evm-interpreter = { version = "1.0.0", path = "interpreter", default-features = false }
+evm = { version = "1.1.0", path = ".", default-features = false }
+evm-interpreter = { version = "1.1.0", path = "interpreter", default-features = false }
 evm-precompile = { version = "1.0.0", path = "precompile", default-features = false }
 evm-mainnet = { version = "1.0.0", path = "mainnet", default-features = false }
 evm-compat = { version = "0.1.0", path = "compat", default-features = false }
 
 [package]
 name = "evm"
-version = "1.0.1"
+version = "1.1.0"
 edition = { workspace = true }
 rust-version = { workspace = true }
 license = { workspace = true }
@@ -40,7 +40,6 @@ keywords = { workspace = true }
 description = "Ethereum Virtual Machine"
 
 [dependencies]
-primitive-types = { version = "0.12", default-features = false, features = ["rlp"] }
 sha3 = { version = "0.10", default-features = false }
 evm-interpreter = { workspace = true }
 
@@ -50,16 +49,15 @@ hex = { version = "0.4", features = [ "serde" ] }
 [features]
 default = ["std"]
 std = [
-	"primitive-types/std",
 	"sha3/std",
 	"evm-interpreter/std",
 ]
 scale = [
-	"primitive-types/codec",
-	"primitive-types/scale-info",
 	"evm-interpreter/scale",
 ]
 serde = [
-	"primitive-types/impl-serde",
 	"evm-interpreter/serde",
 ]
+ruint = [
+    "evm-interpreter/ruint",
+]

features/evm64/Cargo.toml

@@ -10,12 +10,10 @@ repository = { workspace = true }
 keywords = { workspace = true }
 
 [dependencies]
-primitive-types = { version = "0.12", default-features = false, features = ["rlp"] }
 evm = { workspace = true }
 
 [features]
 default = ["std"]
 std = [
-	"primitive-types/std",
 	"evm/std",
 ]

features/evm64/src/eval.rs

@@ -1,13 +1,13 @@
 use core::ops::{BitAnd, BitOr, BitXor};
 
 use evm::interpreter::{Control, ExitException, Machine};
-use primitive_types::U256;
+use evm::uint::{U256, U256Ext};
 
 macro_rules! pop_u64 {
 	( $machine:expr, $( $x:ident ),* ) => (
 		$(
 			let $x = match $machine.stack.pop() {
-				Ok(value) => value.0[0],
+				Ok(value) => value.low_u64(),
 				Err(e) => return Control::Exit(e.into()),
 			};
 		)*
@@ -17,7 +17,7 @@ macro_rules! pop_u64 {
 macro_rules! push_u64 {
 	( $machine:expr, $( $x:expr ),* ) => (
 		$(
-			match $machine.stack.push(U256([$x, 0, 0, 0])) {
+			match $machine.stack.push(U256::from_u64($x)) {
 				Ok(()) => (),
 				Err(e) => return Control::Exit(e.into()),
 			}

features/evm64/src/gasometer.rs

@@ -1,3 +1,5 @@
+#[allow(unused_imports)]
+use evm::uint::U256Ext;
 use evm::{
 	interpreter::{Control, ExitException, Machine, Opcode},
 	standard::GasometerState,
@@ -66,7 +68,7 @@ where
 	#[allow(clippy::single_match)]
 	match opcode {
 		Opcode::EXP => {
-			let power = try_or_fail!(machine.stack.peek(1)).0[0];
+			let power = try_or_fail!(machine.stack.peek(1)).low_u64();
 			let cost = if power == 0 {
 				G_EXP64_STATIC
 			} else {

future/Cargo.toml

@@ -12,6 +12,3 @@ keywords.workspace = true
 [dependencies]
 evm = { path = ".." }
 environmental = "1.1"
-
-[dev-dependencies]
-primitive-types = "0.12"

future/tests/usability.rs

@@ -4,8 +4,8 @@ use evm::interpreter::{
 		Log, RuntimeBackend, RuntimeBaseBackend, RuntimeEnvironment, SetCodeOrigin, TouchKind,
 	},
 };
+use evm::uint::{H160, H256, U256};
 use evm_future::{FutureInterpreter, FutureInterpreterAction, FutureInterpreterSubmit};
-use primitive_types::{H160, H256, U256};
 use std::rc::Rc;
 
 struct EmptyAction;

fuzz/Cargo.toml

@@ -13,7 +13,6 @@ keywords.workspace = true
 [dependencies]
 arbitrary = { version = "1.4.1", features = ["derive"] }
 ziggy = { version = "1.3.2", default-features = false }
-primitive-types = { version = "0.12", default-features = false, features = ["rlp"] }
 # evm
 evm = { workspace = true }
 # grammar

fuzz/src/backend.rs

@@ -21,7 +21,7 @@
 use std::collections::BTreeMap;
 
 use evm::backend::{OverlayedChangeSet, RuntimeBaseBackend, RuntimeEnvironment};
-use primitive_types::{H160, H256, U256};
+use evm::uint::{H160, H256, U256};
 
 #[derive(Default, Clone, Debug, PartialEq)]
 pub struct MockAccount {

fuzz/src/main.rs

@@ -26,6 +26,8 @@ mod grammar;
 use std::alloc::System;
 
 use backend::MockBackend;
+#[allow(unused_imports)]
+use evm::uint::{H160, U256, U256Ext};
 use evm::{
 	backend::{OverlayedBackend, RuntimeBaseBackend},
 	interpreter::{
@@ -37,7 +39,6 @@ use evm::{
 		TransactValue, TransactValueCallCreate,
 	},
 };
-use primitive_types::{H160, U256};
 #[cfg(not(feature = "fuzzing"))]
 use stats_alloc::{INSTRUMENTED_SYSTEM, StatsAlloc};
 
@@ -72,7 +73,7 @@ fn main() {
 			backend::MockAccount {
 				balance: init_balance,
 				code: vec![],
-				nonce: U256::one(),
+				nonce: U256::ONE,
 				storage: Default::default(),
 				transient_storage: Default::default(),
 			},
@@ -85,7 +86,7 @@ fn main() {
 				salt: None,
 			},
 			caller: H160::from_low_u64_be(1),
-			value: U256::zero(),
+			value: U256::ZERO,
 			gas_limit,
 			gas_price: gas_price.into(),
 			access_list: vec![],
@@ -117,7 +118,7 @@ fn main() {
 				salt: None,
 			},
 			caller: H160::from_low_u64_be(1),
-			value: U256::zero(),
+			value: U256::ZERO,
 			gas_limit,
 			gas_price: gas_price.into(),
 			access_list: vec![],
@@ -141,7 +142,7 @@ fn main() {
 				data: calldata,
 			},
 			caller: user_address,
-			value: U256::zero(),
+			value: U256::ZERO,
 			gas_limit,
 			gas_price: gas_price.into(),
 			access_list: vec![],
@@ -160,7 +161,7 @@ fn main() {
 	});
 }
 fn assert_no_mint(backend: &MockBackend, initial_balance: U256) -> U256 {
-	let mut total = U256::zero();
+	let mut total = U256::ZERO;
 	for (_k, v) in backend.state.iter() {
 		total += v.balance;
 	}