Feat: mega EOF

.catalog-info.yaml

@@ -0,0 +1,27 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Location
+metadata:
+    name: sputnikvm-public
+    description: SputnikVM repository
+spec:
+    targets:
+        - ./core/.catalog-info.yaml
+        - ./runtime/.catalog-info.yaml
+        - ./gasometer/.catalog-info.yaml
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+    name: sputnikvm-evm
+    title: SputnikVM evm
+    description: Main library that re-exports most things
+    tags:
+        - ethereum
+    links: []
+    annotations:
+        aurora.dev/security-tier: "1"
+spec:
+    owner: engine-team
+    type: library
+    lifecycle: production

.github/workflows/rust.yml

@@ -21,9 +21,10 @@ jobs:
 
       - name: Clippy
         run: cargo clippy --workspace --all-targets -- -D clippy::all -D clippy::nursery
-
       - name: Clippy no_std
         run: cargo clippy --no-default-features -- -D clippy::all -D clippy::nursery
+      - name: Clippy with features
+        run: cargo clippy --features tracing,create-fixed -- -D clippy::all -D clippy::nursery
 
   build:
     runs-on: ubuntu-latest

.github/workflows/security-analysis.yml

@@ -0,0 +1,15 @@
+---
+name: "Security Analysis"
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  contract_analysis:
+    name: "Shared"
+    uses: aurora-is-near/.github/.github/workflows/security_analysis.yml@master
+    secrets: inherit

Cargo.toml

@@ -9,19 +9,18 @@ keywords.workspace = true
 edition.workspace = true
 
 [workspace.dependencies]
-evm = { version = "0.46.0", path = "." }
-evm-core = { version = "0.46.0", path = "core", default-features = false }
-evm-gasometer = { version = "0.46.0", path = "gasometer", default-features = false }
-evm-runtime = { version = "0.46.0", path = "runtime", default-features = false }
-primitive-types = { version = "0.12", default-features = false }
+evm = { version = "0.47.0", path = "." }
+evm-core = { version = "0.47.0", path = "core", default-features = false }
+evm-gasometer = { version = "0.47.0", path = "gasometer", default-features = false }
+evm-runtime = { version = "0.47.0", path = "runtime", default-features = false }
+primitive-types = { version = "0.13", default-features = false }
 auto_impl = "1.0"
 sha3 = { version = "0.10", default-features = false }
 
 [dependencies]
-ethereum = { version = "0.15", default-features = false }
 log = { version = "0.4", default-features = false }
 primitive-types = { workspace = true, features = ["rlp"] }
-rlp = { version = "0.5", default-features = false }
+rlp = { version = "0.6", default-features = false, features = ["derive"] }
 smallvec = "1.13"
 
 # Optional dependencies
@@ -47,7 +46,6 @@ harness = false
 [features]
 default = ["std", "force-debug"]
 std = [
-    "ethereum/std",
     "log/std",
     "primitive-types/std",
     "rlp/std",
@@ -65,14 +63,12 @@ with-codec = [
     "scale-info",
     "primitive-types/codec",
     "primitive-types/scale-info",
-    "ethereum/with-codec",
     "evm-core/with-codec",
 ]
 with-serde = [
     "serde",
     "primitive-types/impl-serde",
     "evm-core/with-serde",
-    "ethereum/with-serde",
 ]
 tracing = [
     "environmental",
@@ -88,7 +84,7 @@ create-fixed = []
 print-debug = ["evm-gasometer/print-debug"]
 
 [workspace.package]
-version = "0.46.0"
+version = "0.47.0"
 license = "Apache-2.0"
 authors = ["Aurora Labs <[email protected]>", "Wei Tang <[email protected]>", "Parity Technologies <[email protected]>"]
 description = "Portable Ethereum Virtual Machine implementation written in pure Rust."

core/.catalog-info.yaml

@@ -0,0 +1,16 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+    name: sputnikvm-core
+    title: SputnikVM core
+    description: Core library defining the basic execution rules
+    tags:
+        - ethereum
+    links: []
+    annotations:
+        aurora.dev/security-tier: "1"
+spec:
+    owner: engine-team
+    type: library
+    lifecycle: production
+    subcomponentOf: sputnikvm-evm

core/src/error.rs

@@ -170,6 +170,17 @@ pub enum ExitError {
 	UsizeOverflow,
 	#[cfg_attr(feature = "with-codec", codec(index = 16))]
 	CreateContractStartingWithEF,
+
+	#[cfg_attr(feature = "with-codec", codec(index = 17))]
+	EOFDecodeError(EofDecodeError),
+	#[cfg_attr(feature = "with-codec", codec(index = 18))]
+	EOFOpcodeDisabledInLegacy,
+	#[cfg_attr(feature = "with-codec", codec(index = 19))]
+	InvalidEXTCALLTarget,
+	#[cfg_attr(feature = "with-codec", codec(index = 20))]
+	EOFUnexpectedCall,
+	#[cfg_attr(feature = "with-codec", codec(index = 21))]
+	EOFFunctionStackOverflow,
 }
 
 impl From<ExitError> for ExitReason {
@@ -202,3 +213,65 @@ impl From<ExitFatal> for ExitReason {
 		Self::Fatal(s)
 	}
 }
+
+/// EOF decode errors.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
+#[cfg_attr(
+	feature = "with-codec",
+	derive(scale_codec::Encode, scale_codec::Decode, scale_info::TypeInfo)
+)]
+#[cfg_attr(feature = "with-serde", derive(serde::Serialize, serde::Deserialize))]
+pub enum EofDecodeError {
+	/// Missing input while processing EOF.
+	MissingInput,
+	/// Missing body while processing EOF.
+	MissingBodyData,
+	/// Body size is more than specified in the header.
+	BodySizeMoreThanInHeader,
+	/// Invalid types section data.
+	InvalidTypesSectionData,
+	/// Invalid types section size.
+	InvalidTypesSectionSize,
+	/// Invalid EOF magic number.
+	InvalidEOFMagicNumber,
+	/// Invalid EOF version.
+	InvalidEOFVersion,
+	/// Invalid number for types kind
+	InvalidNumberForTypesKind,
+	/// Invalid number for code kind
+	InvalidNumberForCodeKind,
+	/// Invalid terminal byte
+	InvalidTerminalByte,
+	/// Invalid data kind
+	InvalidDataKind,
+	/// Invalid kind after code
+	InvalidKindAfterCode,
+	/// Mismatch of code and types sizes.
+	MismatchCodeAndTypesSize,
+	/// There should be at least one size.
+	SizesNotFound,
+	/// Missing size.
+	ShortInputForSizes,
+	/// Code size can't be zero
+	ZeroCodeSize,
+	/// Invalid code number.
+	TooManyCodeSections,
+	/// Invalid number of code sections.
+	InvalidNumberCodeSections,
+	/// Invalid container number.
+	InvalidNumberContainerSections,
+	/// Invalid initcode size.
+	InvalidEOFInitcodeSize,
+	/// Short body while processing EOF.
+	MissingBodyWithoutData,
+	/// Body size is more than specified in the header.
+	DanglingData,
+	/// Invalid types section data.
+	InvalidTypesSection,
+}
+
+impl From<EofDecodeError> for ExitError {
+	fn from(e: EofDecodeError) -> Self {
+		Self::EOFDecodeError(e)
+	}
+}

core/src/eval/bitwise.rs

@@ -42,17 +42,14 @@ pub fn not(op1: U256) -> U256 {
 #[inline]
 pub fn byte(op1: U256, op2: U256) -> U256 {
 	let mut ret = U256::zero();
-
-	for i in 0..256 {
-		if i < 8 && op1 < 32.into() {
-			let o: usize = op1.as_usize();
+	if op1 < 32.into() {
+		let o = op1.as_usize();
+		for i in 0..8 {
 			let t = 255 - (7 - i + 8 * o);
-			let bit_mask = U256::one() << t;
-			let value = (op2 & bit_mask) >> t;
+			let value = (op2 >> t) & U256::one();
 			ret = ret.overflowing_add(value << i).0;
 		}
 	}
-
 	ret
 }
 

core/src/eval/macros.rs

@@ -21,11 +21,7 @@ macro_rules! pop_h256 {
 	( $machine:expr, $( $x:ident ),* ) => (
 		$(
 			let $x = match $machine.stack.pop() {
-				Ok(value) => {
-					let mut res = H256([0; 32]);
-					value.to_big_endian(&mut res[..]);
-					res
-				},
+				Ok(value) => H256(value.to_big_endian()),
 				Err(e) => return Control::Exit(e.into()),
 			};
 		)*

core/src/lib.rs

@@ -28,7 +28,9 @@ mod stack;
 pub mod utils;
 mod valids;
 
-pub use crate::error::{Capture, ExitError, ExitFatal, ExitReason, ExitRevert, ExitSucceed, Trap};
+pub use crate::error::{
+	Capture, EofDecodeError, ExitError, ExitFatal, ExitReason, ExitRevert, ExitSucceed, Trap,
+};
 pub use crate::external::ExternalOperation;
 pub use crate::memory::Memory;
 pub use crate::opcode::Opcode;
@@ -103,6 +105,64 @@ impl Machine {
 		&self.position
 	}
 
+	/// Get the code with offset and increment the program counter.
+	/// If code range is out of bound, return empty slice.
+	///
+	/// ## Errors
+	/// Returns `ExitReason` if the program counter is invalid.
+	pub fn get_code_and_inc_pc(&mut self, offset: usize) -> Result<&[u8], ExitReason> {
+		let position = match &self.position {
+			Ok(pos) => *pos,
+			Err(e) => return Err(e.clone()),
+		};
+		let data = self
+			.code
+			.get(position..position + offset)
+			.unwrap_or_default();
+		self.position = Ok(position + offset);
+		Ok(data)
+	}
+
+	/// Increment the program counter with offset.
+	///
+	/// ## Errors
+	/// Returns `ExitReason` if the program counter is invalid.
+	pub fn inc_pc(&mut self, offset: usize) -> Result<(), ExitReason> {
+		let position = match &self.position {
+			Ok(pos) => *pos,
+			Err(e) => return Err(e.clone()),
+		};
+		self.position = Ok(position + offset);
+		Ok(())
+	}
+
+	/// Get the code with offset.
+	/// If code range is out of bound, return empty slice.
+	///
+	/// ## Errors
+	/// Returns `ExitReason` if the program counter is invalid.
+	pub fn get_code_with_offset(&mut self, offset: usize) -> Result<&[u8], ExitReason> {
+		let position = match &self.position {
+			Ok(pos) => *pos,
+			Err(e) => return Err(e.clone()),
+		};
+
+		Ok(self
+			.code
+			.get(position..position + offset)
+			.unwrap_or_default())
+	}
+
+	/// Set the program code. Usefuk for EOF.
+	pub fn set_code(&mut self, code: &[u8]) {
+		self.code = Rc::new(code.to_vec());
+	}
+
+	/// Set program counter. Useful for EOF.
+	pub fn set_pc(&mut self, position: usize) {
+		self.position = Ok(position);
+	}
+
 	/// Create a new machine with given code and data.
 	#[must_use]
 	pub fn new(

core/src/memory.rs

@@ -155,7 +155,7 @@ impl Memory {
 
 		if target_size > value.len() {
 			self.data[offset..((value.len()) + offset)].clone_from_slice(value);
-			for index in (value.len())..target_size {
+			for index in value.len()..target_size {
 				self.data[offset + index] = 0;
 			}
 		} else {

core/src/opcode.rs

@@ -470,6 +470,21 @@ impl Display for Opcode {
 			Self::LOG2 => "LOG2",
 			Self::LOG3 => "LOG3",
 			Self::LOG4 => "LOG4",
+			Self::DATALOAD => "DATALOAD",
+			Self::DATALOADN => "DATALOADN",
+			Self::DATASIZE => "DATASIZE",
+			Self::DATACOPY => "DATACOPY",
+			Self::RJUMP => "RJUMP",
+			Self::RJUMPI => "RJUMPI",
+			Self::RJUMPV => "RJUMPV",
+			Self::CALLF => "CALLF",
+			Self::RETF => "RETF",
+			Self::JUMPF => "JUMPF",
+			Self::DUPN => "DUPN",
+			Self::SWAPN => "SWAPN",
+			Self::EXCHANGE => "EXCHANGE",
+			Self::EOFCREATE => "EOFCREATE",
+			Self::RETURNCONTRACT => "RETURNCONTRACT",
 			Self::CREATE => "CREATE",
 			Self::CREATE2 => "CREATE2",
 			Self::CALL => "CALL",

core/src/stack.rs

@@ -62,11 +62,7 @@ impl Stack {
 	/// Return `ExitError`
 	#[inline]
 	pub fn pop_h256(&mut self) -> Result<H256, ExitError> {
-		self.pop().map(|it| {
-			let mut res = H256([0; 32]);
-			it.to_big_endian(&mut res.0);
-			res
-		})
+		self.pop().map(|it| H256(it.to_big_endian()))
 	}
 
 	/// Push a new value into the stack. If it will exceed the stack limit,
@@ -106,11 +102,7 @@ impl Stack {
 	/// # Errors
 	/// Return `ExitError`
 	pub fn peek_h256(&self, no_from_top: usize) -> Result<H256, ExitError> {
-		self.peek(no_from_top).map(|it| {
-			let mut res = H256([0; 32]);
-			it.to_big_endian(&mut res.0);
-			res
-		})
+		self.peek(no_from_top).map(|it| H256(it.to_big_endian()))
 	}
 
 	/// Peek a value at given index for the stack as usize.

evm-tests/EIP-152/src/lib.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Open Ethereum.  If not, see <http://www.gnu.org/licenses/>.
 
+#![allow(clippy::too_long_first_doc_paragraph)]
+
 #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 pub mod avx2;
 pub mod portable;