move benchmarks dir to scripts dir

add `tsconfig.benchmarks.json` and npm run script `build:benchmarks`
add benchmarks instructions to `developer.md`

packages/vm/.gitignore

@@ -1 +1,2 @@
-.cachedb
+.cachedb
+scripts/benchmarks/*.js

packages/vm/developer.md

@@ -142,3 +142,26 @@ An extremely rich and powerful toolbox is the [evmlab](https://github.com/holima
 ```sh
 NODE_OPTIONS="--max-old-space-size=4096" clinic flame -- node ./tests/tester.js --blockchain --excludeDir='GeneralStateTests'
 ```
+
+## Benchmarks
+
+This helps us see how the VM performs when running mainnet blocks.
+
+We want to use the compiled JS so `ts-node` does not show up in the profile. So run:
+
+`npm run build:benchmarks`
+
+Then:
+
+`node ./scripts/benchmarks/mainnetBlocks.js scripts/benchmarks/fixture/blocks-prestate.json`
+
+If you want to get a more detailed look to find bottlenecks we can use `0x`.
+
+So run:
+
+```
+npm i -g 0x
+0x scripts/benchmarks/mainnetBlocks.js scripts/benchmarks/fixture/blocks-prestate.json
+```
+
+and open the link it generates.

packages/vm/package.json

@@ -9,6 +9,7 @@
   ],
   "scripts": {
     "build": "ethereumjs-config-build",
+    "build:benchmarks": "npm run build && tsc -p tsconfig.benchmarks.json",
     "prepublishOnly": "npm run lint && npm run build && npm run test:buildIntegrity",
     "coverage": "nyc npm run coverage:test && nyc report --reporter=lcov",
     "coverage:test": "npm run build && tape './tests/api/**/*.js' ./tests/tester.js --state --dist",

packages/vm/lib/benchmarks/mainnetBlocks.ts → packages/vm/scripts/benchmarks/mainnetBlocks.ts

@@ -1,13 +1,11 @@
 import * as fs from 'fs'
-import * as path from 'path'
-import * as assert from 'assert'
 import { merge } from 'lodash'
 import Account from '@ethereumjs/account'
 import { toBuffer, setLengthLeft } from 'ethereumjs-util'
 import { encode } from 'rlp'
 import blockFromRPC from '@ethereumjs/block/dist/from-rpc'
-import VM from '../'
-import { StateManager, DefaultStateManager } from '../state'
+import VM from '../../dist'
+import { StateManager, DefaultStateManager } from '../../dist/state'
 import BN = require('bn.js')
 
 async function main() {
@@ -41,7 +39,7 @@ async function main() {
           throw new Error('Unavailable blockhash requested')
         }
         return cb(null, { hash: () => toBuffer(bh) })
-      }
+      },
     }
     vm.blockchain = blockchain as any
 
@@ -57,18 +55,24 @@ async function main() {
       //console.log(`Running tx ${tx.hash()} took ${process.hrtime(start)[0]} s, ${txElapsed.toFixed(3)} ms`)
     }
     const elapsed = process.hrtime(start)[1] / 1000000
-    console.log(`Running block ${block.header.number} took ${process.hrtime(start)[0]} s, ${elapsed.toFixed(3)} ms`)
+    console.log(
+      `Running block ${block.header.number} took ${process.hrtime(start)[0]} s, ${elapsed.toFixed(
+        3,
+      )} ms`,
+    )
   }
 }
 
 export interface StateTestPreAccount {
   balance: string
   code: string
   nonce: string
-  storage: {[k: string]: string}
+  storage: { [k: string]: string }
 }
 
-export async function getPreState(pre: {[k: string]: StateTestPreAccount}): Promise<StateManager> {
+export async function getPreState(pre: {
+  [k: string]: StateTestPreAccount
+}): Promise<StateManager> {
   const state = new DefaultStateManager()
   for (const k in pre) {
     const kBuf = toBuffer(k)
@@ -88,10 +92,7 @@ export async function getPreState(pre: {[k: string]: StateTestPreAccount}): Prom
       await storageTrie.put(key, val)
     }
     acc.stateRoot = storageTrie.root
-    await state.putAccount(
-      kBuf,
-      acc
-    )
+    await state.putAccount(kBuf, acc)
     await state.putContractCode(kBuf, code)
   }
   return state
@@ -105,4 +106,8 @@ const hexToBuffer = (h: string, allowZero: boolean = false): Buffer => {
   return buf
 }
 
-main().then().catch((e: Error) => { throw e })
+main()
+  .then()
+  .catch((e: Error) => {
+    throw e
+  })

packages/vm/tsconfig.benchmarks.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@ethereumjs/config-tsc",
+  "compilerOptions": {
+    "target": "ES6",
+    "sourceMap": false,
+    "declaration": false
+  },
+  "include": ["scripts/benchmarks/**.ts"]
+}