VM/SM: Bundle Optimizations (Default wo Caches+EVMMockBlockchain, SM …

…Code put() Fix, VerkleSM out, runTx()+Code Opts) (#3601)

* Use shallowCopy() Caches copy() optimization also for VerkleSM to avoid Caches bundling on non-Caches default

* Fix default state manager missing direct code write when used without caches

* Do not initialize caches for default VM state manager

* Remove copy test not making sense any more under generalized cache/no-cache conditions

* Some more solid/qualified EVM dummy blockchain + interface naming to allow for exporting

* Use EVMMockBlockchain(Interface) as default for the VM, adjust some tests

* Move @ethereumjs/blockchain to dev dependencies in VM

* Rebuild package-lock.json

* Adjust/fix some client tests

* Lint fix

* Add Verkle SM methods as optional methods to interface, replace VerkleSM imports and castings in VM

* Also align client (no real effect yet, but generally try to work more on the interfaces and not the classes directly)

* Initialize runTx() default block with simpler constructor to avoid drawing all txs in

* Fully switch to DEFAULT_HEADER in VM.runTx() to avoid drawing in block code

* Opcode list size optimization

* More optimizations

* Precompile code optimizations

* More optimizations (precompile index.ts file)

* Some more

* Some doc compatification

* Add CSpell checker to CI and fix typos (#3590)

* monorepo: add cspell, add ALL unknown words to valid words

* cspell: split unknown words in ts/md

* filter out wrong words in cspell-ts.json

* cspell ignore hex values

* fix typos in all packages

* cspell: use cache

* cspell: update commands

* cspell: update md/ts words

* Typo fixes for README/CHANGELOG files

* cspell: ensure all relevant monorepo md files are checked

* ci: add cspell job

* cspell: update command

* temp add bogus to markdown

* remove bogus spell

* update ci name

* fix remaining typos + add words to cspell dict

* Update packages/client/CHANGELOG.md

* Update packages/util/CHANGELOG.md

* address review

* Remove almost all `cspell:ignore` (#3599)

* remove almost all cspell:ignore

* more spell changes

* cspell: fix problems

* evm: fix quadCoefficient

* cspell: fixes

* remove disable line

---------

Co-authored-by: Gabriel Rocheleau <[email protected]>

* Fix spell check

* Remove accidentally committed examples/test.ts file

---------

Co-authored-by: Jochem Brouwer <[email protected]>
Co-authored-by: Gabriel Rocheleau <[email protected]>

packages/block/src/block/constructors.ts

@@ -119,6 +119,18 @@ export function createBlock(blockData: BlockData = {}, opts?: BlockOptions) {
   )
 }
 
+/**
+ * Simple static constructor if only an empty block is needed
+ * (tree shaking advantages since it does not draw all the tx constructors in)
+ *
+ * @param headerData
+ * @param opts
+ */
+export function createEmptyBlock(headerData: HeaderData, opts?: BlockOptions) {
+  const header = createBlockHeader(headerData, opts)
+  return new Block(header)
+}
+
 /**
  * Static constructor to create a block from an array of Bytes values
  *

packages/block/test/block.spec.ts

@@ -20,6 +20,7 @@ import {
   createBlockFromBytesArray,
   createBlockFromRLPSerializedBlock,
   createBlockFromRPC,
+  createEmptyBlock,
   paramsBlock,
 } from '../src/index.js'
 
@@ -46,6 +47,9 @@ describe('[Block]: block functions', () => {
       'should use custom parameters provided',
     )
 
+    const emptyBlock = createEmptyBlock({}, { common })
+    assert.ok(bytesToHex(emptyBlock.hash()), 'block should initialize')
+
     // test default freeze values
     // also test if the options are carried over to the constructor
     block = createBlock({})

packages/client/src/execution/vmexecution.ts

@@ -221,7 +221,7 @@ export class VMExecution extends Execution {
   }
 
   async transitionToVerkle(merkleStateRoot: Uint8Array, assignToVM: boolean = true): Promise<void> {
-    if (this.vm.stateManager instanceof StatelessVerkleStateManager) {
+    if (typeof this.vm.stateManager.initVerkleExecutionWitness === 'function') {
       return
     }
 
@@ -230,15 +230,19 @@ export class VMExecution extends Execution {
         await this.setupMerkleVM()
       }
       const merkleVM = this.merkleVM!
-      const merkleStateManager = merkleVM.stateManager as DefaultStateManager
+      const merkleStateManager = merkleVM.stateManager
 
       if (this.verkleVM === undefined) {
         await this.setupVerkleVM()
       }
       const verkleVM = this.verkleVM!
-      const verkleStateManager = verkleVM.stateManager as StatelessVerkleStateManager
+      const verkleStateManager = verkleVM.stateManager
 
-      const verkleStateRoot = await verkleStateManager.getTransitionStateRoot(
+      // TODO: can we please implement this in a different way and not introduce a method
+      // *inside* one state manager which takes another state manager?
+      // That bloats the interface too much, this should be minimally a separate util method
+      // or fully move to client
+      const verkleStateRoot = await (verkleStateManager as any).getTransitionStateRoot(
         merkleStateManager,
         merkleStateRoot,
       )
@@ -416,7 +420,8 @@ export class VMExecution extends Execution {
             vm = this.verkleVM
           }
 
-          const needsStatelessExecution = vm.stateManager instanceof StatelessVerkleStateManager
+          const needsStatelessExecution =
+            typeof this.vm.stateManager.initVerkleExecutionWitness === 'function'
           if (needsStatelessExecution && block.executionWitness === undefined) {
             throw Error(`Verkle blocks need executionWitness for stateless execution`)
           } else {
@@ -576,7 +581,7 @@ export class VMExecution extends Execution {
       this.config.logger.warn(
         `Setting execution head to hash=${short(jumpToHash)} number=${jumpToNumber}`,
       )
-      await this.vm.blockchain.setIteratorHead('vm', jumpToHash)
+      await this.chain.blockchain.setIteratorHead('vm', jumpToHash)
     })
   }
 
@@ -595,19 +600,9 @@ export class VMExecution extends Execution {
         this.running = true
         let numExecuted: number | null | undefined = undefined
 
-        const { blockchain } = this.vm
-        if (typeof blockchain.getIteratorHead !== 'function') {
-          throw new Error('cannot get iterator head: blockchain has no getIteratorHead function')
-        }
-        let startHeadBlock = await blockchain.getIteratorHead()
+        let startHeadBlock = await this.chain.blockchain.getIteratorHead()
         await this.checkAndReset(startHeadBlock)
-
-        if (typeof blockchain.getCanonicalHeadBlock !== 'function') {
-          throw new Error(
-            'cannot get iterator head: blockchain has no getCanonicalHeadBlock function',
-          )
-        }
-        let canonicalHead = await blockchain.getCanonicalHeadBlock()
+        let canonicalHead = await this.chain.blockchain.getCanonicalHeadBlock()
 
         this.config.logger.debug(
           `Running execution startHeadBlock=${startHeadBlock?.header.number} canonicalHead=${canonicalHead?.header.number} loop=${loop}`,
@@ -637,14 +632,14 @@ export class VMExecution extends Execution {
           headBlock = undefined
           parentState = undefined
           errorBlock = undefined
-          this.vmPromise = blockchain
+          this.vmPromise = this.chain.blockchain
             .iterator(
               'vm',
               async (block: Block, reorg: boolean) => {
                 // determine starting state for block run
                 // if we are just starting or if a chain reorg has happened
                 if (headBlock === undefined || reorg) {
-                  headBlock = await blockchain.getBlock(block.header.parentHash)
+                  headBlock = await this.chain.blockchain.getBlock(block.header.parentHash)
                   parentState = headBlock.header.stateRoot
 
                   if (reorg) {
@@ -664,11 +659,6 @@ export class VMExecution extends Execution {
                 // run block, update head if valid
                 try {
                   const { number, timestamp } = block.header
-                  if (typeof blockchain.getTotalDifficulty !== 'function') {
-                    throw new Error(
-                      'cannot get iterator head: blockchain has no getTotalDifficulty function',
-                    )
-                  }
 
                   const hardfork = this.config.execCommon.getHardforkBy({
                     blockNumber: number,
@@ -692,7 +682,7 @@ export class VMExecution extends Execution {
                   }
                   if (
                     (!this.config.execCommon.gteHardfork(Hardfork.Osaka) &&
-                      this.vm.stateManager instanceof StatelessVerkleStateManager) ||
+                      typeof this.vm.stateManager.initVerkleExecutionWitness === 'function') ||
                     (this.config.execCommon.gteHardfork(Hardfork.Osaka) &&
                       this.vm.stateManager instanceof DefaultStateManager)
                   ) {
@@ -800,7 +790,7 @@ export class VMExecution extends Execution {
                         backStepToHash ?? 'na',
                       )} hasParentStateRoot=${short(backStepToRoot ?? 'na')}:\n${error}`,
                     )
-                    await this.vm.blockchain.setIteratorHead('vm', backStepToHash)
+                    await this.chain.blockchain.setIteratorHead('vm', backStepToHash)
                   } else {
                     this.config.logger.error(
                       `${errorMsg}, couldn't back step to vmHead number=${backStepTo} hash=${short(
@@ -855,14 +845,7 @@ export class VMExecution extends Execution {
 
           numExecuted = await this.vmPromise
           if (numExecuted !== null) {
-            let endHeadBlock
-            if (typeof this.vm.blockchain.getIteratorHead === 'function') {
-              endHeadBlock = await this.vm.blockchain.getIteratorHead('vm')
-            } else {
-              throw new Error(
-                'cannot get iterator head: blockchain has no getIteratorHead function',
-              )
-            }
+            const endHeadBlock = await this.chain.blockchain.getIteratorHead('vm')
 
             if (typeof numExecuted === 'number' && numExecuted > 0) {
               const firstNumber = startHeadBlock.header.number
@@ -891,12 +874,7 @@ export class VMExecution extends Execution {
               )
             }
             startHeadBlock = endHeadBlock
-            if (typeof this.vm.blockchain.getCanonicalHeadBlock !== 'function') {
-              throw new Error(
-                'cannot get iterator head: blockchain has no getCanonicalHeadBlock function',
-              )
-            }
-            canonicalHead = await this.vm.blockchain.getCanonicalHeadBlock()
+            canonicalHead = await this.chain.blockchain.getCanonicalHeadBlock()
           }
         }
 
@@ -917,19 +895,12 @@ export class VMExecution extends Execution {
       this.STATS_INTERVAL,
     )
 
-    const { blockchain } = this.vm
     if (this.running || !this.started) {
       return false
     }
 
-    if (typeof blockchain.getIteratorHead !== 'function') {
-      throw new Error('cannot get iterator head: blockchain has no getIteratorHead function')
-    }
-    const vmHeadBlock = await blockchain.getIteratorHead()
-    if (typeof blockchain.getCanonicalHeadBlock !== 'function') {
-      throw new Error('cannot get iterator head: blockchain has no getCanonicalHeadBlock function')
-    }
-    const canonicalHead = await blockchain.getCanonicalHeadBlock()
+    const vmHeadBlock = await this.chain.blockchain.getIteratorHead()
+    const canonicalHead = await this.chain.blockchain.getCanonicalHeadBlock()
 
     const infoStr = `vmHead=${vmHeadBlock.header.number} canonicalHead=${
       canonicalHead.header.number
@@ -984,7 +955,7 @@ export class VMExecution extends Execution {
   async executeBlocks(first: number, last: number, txHashes: string[]) {
     this.config.logger.info('Preparing for block execution (debug mode, no services started)...')
 
-    const block = await this.vm.blockchain.getBlock(first)
+    const block = await this.chain.blockchain.getBlock(first)
     const startExecutionHardfork = this.config.execCommon.getHardforkBy({
       blockNumber: block.header.number,
       timestamp: block.header.timestamp,
@@ -1000,13 +971,10 @@ export class VMExecution extends Execution {
     const vm = await this.vm.shallowCopy(false)
 
     for (let blockNumber = first; blockNumber <= last; blockNumber++) {
-      const block = await vm.blockchain.getBlock(blockNumber)
-      const parentBlock = await vm.blockchain.getBlock(block.header.parentHash)
+      const block = await this.chain.blockchain.getBlock(blockNumber)
+      const parentBlock = await this.chain.blockchain.getBlock(block.header.parentHash)
       // Set the correct state root
       const root = parentBlock.header.stateRoot
-      if (typeof vm.blockchain.getTotalDifficulty !== 'function') {
-        throw new Error('cannot get iterator head: blockchain has no getTotalDifficulty function')
-      }
       vm.common.setHardforkBy({
         blockNumber,
         timestamp: block.header.timestamp,

packages/client/src/miner/miner.ts

@@ -12,7 +12,7 @@ import type { Config } from '../config.js'
 import type { VMExecution } from '../execution/index.js'
 import type { FullEthereumService } from '../service/index.js'
 import type { FullSynchronizer } from '../sync/index.js'
-import type { CliqueConsensus } from '@ethereumjs/blockchain'
+import type { Blockchain, CliqueConsensus } from '@ethereumjs/blockchain'
 import type { CliqueConfig } from '@ethereumjs/common'
 import type { Miner as EthashMiner, Solution } from '@ethereumjs/ethash'
 
@@ -244,10 +244,9 @@ export class Miner {
       const [signerAddress, signerPrivKey] = this.config.accounts[0]
       cliqueSigner = signerPrivKey
       // Determine if signer is INTURN (2) or NOTURN (1)
-      inTurn = await (vmCopy.blockchain.consensus as CliqueConsensus).cliqueSignerInTurn(
-        signerAddress,
-        number,
-      )
+      inTurn = await (
+        (vmCopy.blockchain as Blockchain).consensus as CliqueConsensus
+      ).cliqueSignerInTurn(signerAddress, number)
       difficulty = inTurn ? 2 : 1
     }
 

packages/client/src/miner/pendingBlock.ts

@@ -104,9 +104,6 @@ export class PendingBlock {
     const { timestamp, mixHash, parentBeaconBlockRoot, coinbase } = headerData
     let { gasLimit } = parentBlock.header
 
-    if (typeof vm.blockchain.getTotalDifficulty !== 'function') {
-      throw new Error('cannot get iterator head: blockchain has no getTotalDifficulty function')
-    }
     vm.common.setHardforkBy({
       blockNumber: number,
       timestamp,

packages/client/test/miner/miner.spec.ts

@@ -22,7 +22,7 @@ import { wait } from '../integration/util.js'
 
 import type { FullSynchronizer } from '../../src/sync/index.js'
 import type { Block } from '@ethereumjs/block'
-import type { CliqueConsensus } from '@ethereumjs/blockchain'
+import type { Blockchain, CliqueConsensus } from '@ethereumjs/blockchain'
 import type { VM } from '@ethereumjs/vm'
 
 const A = {
@@ -242,7 +242,9 @@ describe('assembleBlocks() -> with a single tx', async () => {
   await txPool.add(txA01)
 
   // disable consensus to skip PoA block signer validation
-  ;(vm.blockchain.consensus as CliqueConsensus).cliqueActiveSigners = () => [A.address] // stub
+  ;((vm.blockchain as Blockchain).consensus as CliqueConsensus).cliqueActiveSigners = () => [
+    A.address,
+  ] // stub
 
   chain.putBlocks = (blocks: Block[]) => {
     it('should include tx in new block', () => {
@@ -280,7 +282,9 @@ describe('assembleBlocks() -> with a hardfork mismatching tx', async () => {
   })
 
   // disable consensus to skip PoA block signer validation
-  ;(vm.blockchain.consensus as CliqueConsensus).cliqueActiveSigners = () => [A.address] // stub
+  ;((vm.blockchain as Blockchain).consensus as CliqueConsensus).cliqueActiveSigners = () => [
+    A.address,
+  ] // stub
 
   chain.putBlocks = (blocks: Block[]) => {
     it('should not include tx', () => {