EVM/Monorepo: Verkle Decoupling (#3462)

* EVM: Replace direct StatelessVerkleStateManager (SVSM) cast with verkle-extended interface usage

* Add experimental AccessWitnessInterface to Common, use interface for AccessWitness implementation in StateManager

* Use AccessWitnessInterface in EVM

* Add verkle module to Util, replace EVM function calls, remove @ethereumjs/verkle dependency

* Rebuild package-lock.json

* Move VerkleCrypto type from verkle-cryptography-wasm to Util

* Make verkleCrypto passing in mandatory in StatelessVerkleStateManager, remove async create constructor, move verkle-cryptography-wasm to dev dependenciew

* Replace additional StatelessVerkleStateManager create() constructor instantiations, add verkle-cryptography-wasm to Client package.json

* Rebuild package-lock.json

* Move verkle helper functionality to Util verkle module, fully remove @ethereumjs/verkle usages

* Update VerkleExecutionWitness, VerkleProof type imports moved to Util

* Remove @ethereumjs/verkle dependency from VM

* Rebuild package-lock.json

* Additional import fix

* Yet another fix

* Merge remote-tracking branch 'origin/master' into verkle-statemanager-interface-and-evm-dependency-removal

Author: holgerd77

package-lock.json

@@ -38,7 +38,6 @@ import type {
   JsonBlock,
   JsonRpcBlock,
   RequestsBytes,
-  VerkleExecutionWitness,
   WithdrawalsBytes,
 } from './types.js'
 import type { Common } from '@ethereumjs/common'
@@ -53,6 +52,7 @@ import type {
   EthersProvider,
   PrefixedHexString,
   RequestBytes,
+  VerkleExecutionWitness,
   WithdrawalBytes,
 } from '@ethereumjs/util'
 

packages/block/src/block.ts

@@ -1,7 +1,7 @@
 import { bigIntToHex } from '@ethereumjs/util'
 
-import type { ExecutionPayload, VerkleExecutionWitness } from './types.js'
-import type { PrefixedHexString } from '@ethereumjs/util'
+import type { ExecutionPayload } from './types.js'
+import type { PrefixedHexString, VerkleExecutionWitness } from '@ethereumjs/util'
 
 type BeaconWithdrawal = {
   index: PrefixedHexString

packages/block/src/from-beacon-payload.ts

@@ -11,6 +11,7 @@ import type {
   JsonRpcWithdrawal,
   PrefixedHexString,
   RequestBytes,
+  VerkleExecutionWitness,
   WithdrawalBytes,
   WithdrawalData,
   WithdrawalRequestV1,
@@ -78,45 +79,6 @@ export interface BlockOptions {
   executionWitness?: VerkleExecutionWitness
 }
 
-export interface VerkleProof {
-  commitmentsByPath: PrefixedHexString[]
-  d: PrefixedHexString
-  depthExtensionPresent: PrefixedHexString
-  ipaProof: {
-    cl: PrefixedHexString[]
-    cr: PrefixedHexString[]
-    finalEvaluation: PrefixedHexString
-  }
-  otherStems: PrefixedHexString[]
-}
-
-export interface VerkleStateDiff {
-  stem: PrefixedHexString
-  suffixDiffs: {
-    currentValue: PrefixedHexString | null
-    newValue: PrefixedHexString | null
-    suffix: number | string
-  }[]
-}
-
-/**
- * Experimental, object format could eventual change.
- * An object that provides the state and proof necessary for verkle stateless execution
- * */
-export interface VerkleExecutionWitness {
-  /**
-   * An array of state diffs.
-   * Each item corresponding to state accesses or state modifications of the block.
-   * In the current design, it also contains the resulting state of the block execution (post-state).
-   */
-  stateDiff: VerkleStateDiff[]
-  /**
-   * The verkle proof for the block.
-   * Proves that the provided stateDiff belongs to the canonical verkle tree.
-   */
-  verkleProof: VerkleProof
-}
-
 /**
  * A block header's data.
  */

packages/block/src/types.ts

@@ -10,7 +10,8 @@ import * as payload87335 from './testdata/payload-slot-87335.json'
 import * as payload87475 from './testdata/payload-slot-87475.json'
 import * as testnetVerkleKaustinen from './testdata/testnetVerkleKaustinen.json'
 
-import type { BeaconPayloadJson, VerkleExecutionWitness } from '../src/index.js'
+import type { BeaconPayloadJson } from '../src/index.js'
+import type { VerkleExecutionWitness } from '@ethereumjs/util'
 
 describe('[fromExecutionPayloadJson]: 4844 devnet 5', () => {
   let common: Common

packages/block/test/from-beacon-payload.spec.ts

@@ -87,6 +87,7 @@
     "level": "^8.0.0",
     "memory-level": "^1.0.0",
     "prom-client": "^15.1.0",
+    "verkle-cryptography-wasm": "^0.4.2",
     "winston": "^3.3.3",
     "winston-daily-rotate-file": "^4.5.5",
     "yargs": "^17.7.1"

packages/client/package.json

@@ -23,6 +23,7 @@ import {
 } from '@ethereumjs/util'
 import { VM } from '@ethereumjs/vm'
 import { writeFileSync } from 'fs'
+import { loadVerkleCrypto } from 'verkle-cryptography-wasm'
 
 import { Event } from '../types.js'
 import { debugCodeReplayBlock } from '../util/debug.js'
@@ -190,8 +191,10 @@ export class VMExecution extends Execution {
       return
     }
     this.config.logger.info(`Setting up verkleVM`)
-    const stateManager = await StatelessVerkleStateManager.create({
+    const verkleCrypto = await loadVerkleCrypto()
+    const stateManager = new StatelessVerkleStateManager({
       initialStateRoot: this.config.initialVerkleStateRoot,
+      verkleCrypto,
     })
     this.verkleVM = await VM.create({
       common: this.config.execCommon,

packages/client/src/execution/vmexecution.ts

@@ -9,8 +9,9 @@ import genesisJSON from '../../testdata/geth-genesis/kaustinen6.json'
 import { getRpcClient, setupChain } from '../helpers.js'
 
 import type { Chain } from '../../../src/blockchain/index.js'
-import type { BeaconPayloadJson, VerkleExecutionWitness } from '@ethereumjs/block'
+import type { BeaconPayloadJson } from '@ethereumjs/block'
 import type { Common } from '@ethereumjs/common'
+import type { VerkleExecutionWitness } from '@ethereumjs/util'
 import type { HttpClient } from 'jayson/promise'
 const genesisVerkleStateRoot = '0x1fbf85345a3cbba9a6d44f991b721e55620a22397c2a93ee8d5011136ac300ee'
 const genesisVerkleBlockHash = '0x3fe165c03e7a77d1e3759362ebeeb16fd964cb411ce11fbe35c7032fab5b9a8a'

packages/client/test/rpc/engine/kaustinen6.spec.ts

@@ -65,6 +65,64 @@ export type AccessListBytesItem = [Uint8Array, Uint8Array[]]
 export type AccessListBytes = AccessListBytesItem[]
 export type AccessList = AccessListItem[]
 
+/**
+ * Verkle related
+ *
+ * Experimental (do not implement)
+ */
+export type AccessEventFlags = {
+  stemRead: boolean
+  stemWrite: boolean
+  chunkRead: boolean
+  chunkWrite: boolean
+  chunkFill: boolean
+}
+
+/**
+ * Verkle related
+ *
+ * Experimental (do not implement)
+ */
+export interface AccessWitnessInterface {
+  touchAndChargeProofOfAbsence(address: Address): bigint
+  touchAndChargeMessageCall(address: Address): bigint
+  touchAndChargeValueTransfer(caller: Address, target: Address): bigint
+  touchAndChargeContractCreateInit(address: Address): bigint
+  touchAndChargeContractCreateCompleted(address: Address): bigint
+  touchTxOriginAndComputeGas(origin: Address): bigint
+  touchTxTargetAndComputeGas(target: Address, { sendsValue }: { sendsValue?: boolean }): bigint
+  touchCodeChunksRangeOnReadAndChargeGas(contact: Address, startPc: number, endPc: number): bigint
+  touchCodeChunksRangeOnWriteAndChargeGas(contact: Address, startPc: number, endPc: number): bigint
+  touchAddressOnWriteAndComputeGas(
+    address: Address,
+    treeIndex: number | bigint,
+    subIndex: number | Uint8Array
+  ): bigint
+  touchAddressOnReadAndComputeGas(
+    address: Address,
+    treeIndex: number | bigint,
+    subIndex: number | Uint8Array
+  ): bigint
+  touchAddressAndChargeGas(
+    address: Address,
+    treeIndex: number | bigint,
+    subIndex: number | Uint8Array,
+    { isWrite }: { isWrite?: boolean }
+  ): bigint
+  touchAddress(
+    address: Address,
+    treeIndex: number | bigint,
+    subIndex: number | Uint8Array,
+    { isWrite }: { isWrite?: boolean }
+  ): AccessEventFlags
+  shallowCopy(): AccessWitnessInterface
+  merge(accessWitness: AccessWitnessInterface): void
+}
+
+/*
+ * Generic StateManager interface corresponding with the @ethereumjs/statemanager package
+ *
+ */
 export interface StateManagerInterface {
   getAccount(address: Address): Promise<Account | undefined>
   putAccount(address: Address, account?: Account): Promise<void>
@@ -85,6 +143,13 @@ export interface StateManagerInterface {
   hasStateRoot(root: Uint8Array): Promise<boolean> // only used in client
   shallowCopy(downlevelCaches?: boolean): StateManagerInterface
   getAppliedKey?(address: Uint8Array): Uint8Array
+
+  /*
+   * The following optional methods are Verkle related
+   *
+   * Experimental (do not implement)
+   */
+  checkChunkWitnessPresent?(contract: Address, programCounter: number): Promise<boolean>
 }
 
 export interface EVMStateManagerInterface extends StateManagerInterface {

packages/common/src/interfaces.ts

@@ -58,7 +58,6 @@
     "@ethereumjs/statemanager": "^2.3.0",
     "@ethereumjs/tx": "^5.3.0",
     "@ethereumjs/util": "^9.0.3",
-    "@ethereumjs/verkle": "^0.0.2",
     "@types/debug": "^4.1.9",
     "debug": "^4.3.3",
     "ethereum-cryptography": "^2.1.3",