From 786a244c8e709844fcc5c3a4185daa6f9740950a Mon Sep 17 00:00:00 2001
From: acolytec3 <konjou@gmail.com>
Date: Mon, 10 Jul 2023 17:58:39 -0400
Subject: [PATCH] Update `EthersStateManager`  (#2873)

* Update ethersStateManager caching logic

* empty

---------

Co-authored-by: Jochem Brouwer <jochembrouwer96@gmail.com>
---
 package-lock.json                             |  19 +--
 packages/statemanager/examples/browser.html   |   2 +-
 .../statemanager/src/ethersStateManager.ts    |  21 ++-
 .../test/ethersStateManager.spec.ts           |  30 +++--
 .../testdata/providerData/mockProvider.ts     | 124 ++++++++++--------
 5 files changed, 106 insertions(+), 90 deletions(-)

diff --git a/package-lock.json b/package-lock.json
index b9a1913d9c..bd53b8d756 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -13712,14 +13712,6 @@
       "integrity": "sha512-q9JtQJKjpsVxCRVgQ+WapguSbKC3SQ5HEzFGPAJMStgh3QjCawp00UKv3MTTAArTmGmmPUvllHZoNbZ3gs0I+Q==",
       "dev": true
     },
-    "node_modules/mcl-wasm": {
-      "version": "0.7.9",
-      "resolved": "https://registry.npmjs.org/mcl-wasm/-/mcl-wasm-0.7.9.tgz",
-      "integrity": "sha512-iJIUcQWA88IJB/5L15GnJVnSQJmf/YaxxV6zRavv83HILHaJQb6y0iFyDMdDO0gN8X37tdxmAOrH/P8B6RB8sQ==",
-      "engines": {
-        "node": ">=8.9.0"
-      }
-    },
     "node_modules/md5-hex": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/md5-hex/-/md5-hex-3.0.1.tgz",
@@ -21337,7 +21329,6 @@
         "@ethereumjs/util": "^8.0.6",
         "debug": "^4.3.3",
         "ethereum-cryptography": "^2.0.0",
-        "mcl-wasm": "^0.7.1",
         "rustbn-wasm": "^0.2.0"
       },
       "devDependencies": {
@@ -21536,8 +21527,7 @@
         "@ethereumjs/tx": "^4.1.2",
         "@ethereumjs/util": "^8.0.6",
         "debug": "^4.3.3",
-        "ethereum-cryptography": "^2.0.0",
-        "mcl-wasm": "^0.7.1"
+        "ethereum-cryptography": "^2.0.0"
       },
       "devDependencies": {
         "@ethersproject/abi": "^5.0.12",
@@ -23461,7 +23451,6 @@
         "debug": "^4.3.3",
         "ethereum-cryptography": "^2.0.0",
         "level": "^8.0.0",
-        "mcl-wasm": "^0.7.1",
         "memory-level": "^1.0.0",
         "minimist": "^1.2.5",
         "node-dir": "^0.1.17",
@@ -23595,7 +23584,6 @@
         "c-kzg": "^2.1.0",
         "debug": "^4.3.3",
         "ethereum-cryptography": "^2.0.0",
-        "mcl-wasm": "^0.7.1",
         "minimist": "^1.2.5",
         "node-dir": "^0.1.17",
         "nyc": "^15.1.0",
@@ -32276,11 +32264,6 @@
       "integrity": "sha512-q9JtQJKjpsVxCRVgQ+WapguSbKC3SQ5HEzFGPAJMStgh3QjCawp00UKv3MTTAArTmGmmPUvllHZoNbZ3gs0I+Q==",
       "dev": true
     },
-    "mcl-wasm": {
-      "version": "0.7.9",
-      "resolved": "https://registry.npmjs.org/mcl-wasm/-/mcl-wasm-0.7.9.tgz",
-      "integrity": "sha512-iJIUcQWA88IJB/5L15GnJVnSQJmf/YaxxV6zRavv83HILHaJQb6y0iFyDMdDO0gN8X37tdxmAOrH/P8B6RB8sQ=="
-    },
     "md5-hex": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/md5-hex/-/md5-hex-3.0.1.tgz",
diff --git a/packages/statemanager/examples/browser.html b/packages/statemanager/examples/browser.html
index 66acf96271..93ecce291d 100644
--- a/packages/statemanager/examples/browser.html
+++ b/packages/statemanager/examples/browser.html
@@ -6,7 +6,7 @@
     <script type="module">
         import { Account, Address } from '@ethereumjs/util'
         import { DefaultStateManager } from '@ethereumjs/statemanager'
-        import { hexStringToBytes } from '@ethereumjs/util'
+        import { hexToBytes } from '@ethereumjs/util'
 
         const run = async () => {
             const stateManager = new DefaultStateManager()
diff --git a/packages/statemanager/src/ethersStateManager.ts b/packages/statemanager/src/ethersStateManager.ts
index 1b41b842e3..152fdd9cdd 100644
--- a/packages/statemanager/src/ethersStateManager.ts
+++ b/packages/statemanager/src/ethersStateManager.ts
@@ -217,7 +217,7 @@ export class EthersStateManager implements EVMStateManagerInterface {
 
   /**
    * Gets the code corresponding to the provided `address`.
-   * @param address - Address to get the `code` for
+   * @param address - Address to get the `account` for
    * @returns {Promise<Uint8Array>} - Resolves with the code corresponding to the provided address.
    * Returns an empty `Uint8Array` if the account has no associated code.
    */
@@ -261,11 +261,21 @@ export class EthersStateManager implements EVMStateManagerInterface {
    * @param address - Address under which to store `account`
    * @param account - The account to store
    */
-  async putAccount(address: Address, account: Account): Promise<void> {
+  async putAccount(address: Address, account: Account | undefined): Promise<void> {
     if (this.DEBUG) {
-      this._debug(`putting account data for ${address.toString()}`)
+      this._debug(
+        `Save account address=${address} nonce=${account?.nonce} balance=${
+          account?.balance
+        } contract=${account && account.isContract() ? 'yes' : 'no'} empty=${
+          account && account.isEmpty() ? 'yes' : 'no'
+        }`
+      )
+    }
+    if (account !== undefined) {
+      this._accountCache!.put(address, account)
+    } else {
+      this._accountCache!.del(address)
     }
-    this._accountCache.put(address, account)
   }
 
   /**
@@ -337,6 +347,7 @@ export class EthersStateManager implements EVMStateManagerInterface {
    */
   async checkpoint(): Promise<void> {
     this._accountCache.checkpoint()
+    this._storageCache.checkpoint()
   }
 
   /**
@@ -358,6 +369,8 @@ export class EthersStateManager implements EVMStateManagerInterface {
    */
   async revert(): Promise<void> {
     this._accountCache.revert()
+    this._storageCache.revert()
+    this._contractCache.clear()
   }
 
   async flush(): Promise<void> {
diff --git a/packages/statemanager/test/ethersStateManager.spec.ts b/packages/statemanager/test/ethersStateManager.spec.ts
index 74d08b7225..460f172843 100644
--- a/packages/statemanager/test/ethersStateManager.spec.ts
+++ b/packages/statemanager/test/ethersStateManager.spec.ts
@@ -132,6 +132,7 @@ describe('Ethers State Manager API tests', () => {
           state.getContractStorage(UNIerc20ContractAddress, setLengthLeft(bigIntToBytes(2n), 32)),
         'should not call provider.getStorageAt'
       )
+      await state.checkpoint()
 
       await state.putContractStorage(
         UNIerc20ContractAddress,
@@ -174,6 +175,23 @@ describe('Ethers State Manager API tests', () => {
         'account should not exist after being deleted'
       )
 
+      await state.revert()
+      assert.ok(
+        (await state.getAccount(vitalikDotEth)) !== undefined,
+        'account deleted since last checkpoint should exist after revert called'
+      )
+
+      const deletedSlotAfterRevert = await state.getContractStorage(
+        UNIerc20ContractAddress,
+        setLengthLeft(bigIntToBytes(2n), 32)
+      )
+
+      assert.equal(
+        deletedSlotAfterRevert.length,
+        4,
+        'slot deleted since last checkpoint should exist in storage cache after revert'
+      )
+
       try {
         await Block.fromJsonRpcProvider(provider, 'fakeBlockTag', {} as any)
         assert.fail('should have thrown')
@@ -184,18 +202,10 @@ describe('Ethers State Manager API tests', () => {
         )
       }
 
-      const newState = state.shallowCopy()
-
       assert.equal(
-        undefined,
         (state as any)._contractCache.get(UNIerc20ContractAddress),
-        'should not have any code for contract after cache is cleared'
-      )
-
-      assert.notEqual(
         undefined,
-        (newState as any)._contractCache.get(UNIerc20ContractAddress.toString()),
-        'state manager copy should have code for contract after cache is cleared on original state manager'
+        'should not have any code for contract after cache is reverted'
       )
 
       assert.equal((state as any)._blockTag, '0x1', 'blockTag defaults to 1')
@@ -203,6 +213,8 @@ describe('Ethers State Manager API tests', () => {
       assert.equal((state as any)._blockTag, '0x5', 'blockTag set to 0x5')
       state.setBlockTag('earliest')
       assert.equal((state as any)._blockTag, 'earliest', 'blockTag set to earliest')
+
+      await state.checkpoint()
     }
   })
 })
diff --git a/packages/statemanager/test/testdata/providerData/mockProvider.ts b/packages/statemanager/test/testdata/providerData/mockProvider.ts
index dcba253c15..9c2eeb64ed 100644
--- a/packages/statemanager/test/testdata/providerData/mockProvider.ts
+++ b/packages/statemanager/test/testdata/providerData/mockProvider.ts
@@ -14,84 +14,92 @@ export class MockProvider extends JsonRpcProvider {
     return fakeConnection as FetchRequest
   }
 
-  private getAccountValue = async (method: string, params: Array<any>) => {
-    switch (method) {
-      case 'eth_getProof':
-        return this.getProofValues(params as any)
-      case 'eth_getBlockByNumber':
-        return this.getBlockValues(params as any)
-      case 'eth_chainId': // Always pretends to be mainnet
-        return 1
-      case 'eth_getTransactionByHash':
-        return this.getTransactionData(params as any)
-      case 'eth_getCode':
-        return 0
-      case 'eth_getStorageAt':
-        return '0xabcd'
-      default:
-        throw new Error(`method ${method} not implemented`)
+  _send = async (payload: JsonRpcPayload | JsonRpcPayload[]): Promise<JsonRpcResult[]> => {
+    let method
+    let params
+    let id
+
+    if (Array.isArray(payload)) {
+      const results = []
+      for (const el of payload) {
+        ;({ method, params, id } = el)
+        results.push(await this.getValues(method, id, params))
+      }
+      return results
+    } else {
+      ;({ method, params, id } = payload)
+      return [await this.getValues(method, id, params)]
     }
   }
 
-  _send = async (payload: JsonRpcPayload | JsonRpcPayload[]): Promise<JsonRpcResult[]> => {
-    const { method, params, id } = payload as JsonRpcPayload
-
+  private getValues = async (method: string, id: number, params: any): Promise<JsonRpcResult> => {
     switch (method) {
       case 'eth_getProof':
-        return [
-          {
-            id,
-            result: this.getProofValues(params as any),
-          },
-        ]
+        return {
+          id,
+          result: this.getProofValues(params as any),
+        }
+
       case 'eth_getBlockByNumber':
-        return [
-          {
-            id,
-            result: this.getBlockValues(params as any),
-          },
-        ]
+        return {
+          id,
+          result: this.getBlockValues(params as any),
+        }
+
       case 'eth_chainId': // Always pretends to be mainnet
-        return [
-          {
-            id,
-            result: 1,
-          },
-        ]
+        return {
+          id,
+          result: 1,
+        }
       case 'eth_getTransactionByHash':
-        return [
-          {
-            id,
-            result: this.getTransactionData(params as any),
-          },
-        ]
+        return {
+          id,
+          result: this.getTransactionData(params as any),
+        }
+
       case 'eth_getCode': {
         let code = '0x'
         if ((params as any[])[0] !== '0xd8da6bf26964af9d7eed9e03e53415d37aa96045') {
           code = '0xab'
         }
-        return [
-          {
-            id,
-            result: code,
-          },
-        ]
+        return {
+          id,
+          result: code,
+        }
       }
       case 'eth_getStorageAt':
-        return [
-          {
-            id,
-            result: '0xabcd',
-          },
-        ]
+        return {
+          id,
+          result: '0xabcd',
+        }
+
       default:
-        throw new Error(`method ${method} not implemented`)
+        return {
+          id,
+          result: {
+            error: 'method not implemented',
+          },
+        }
     }
   }
+
   private getProofValues = async (params: [address: string, _: [], blockTag: bigint | string]) => {
     const [address, _slot, blockTag] = params
-    const account = (await import(`./accounts/${address}.json`)).default
-    return account[blockTag.toString() ?? 'latest']
+    try {
+      const account = (await import(`./accounts/${address}.json`)).default
+      return account[blockTag.toString() ?? 'latest']
+    } catch {
+      return {
+        '0x1': {
+          address,
+          balance: '0x0',
+          codeHash: '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470',
+          nonce: '0x0',
+          storageHash: '0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421',
+          storageProof: [],
+        },
+      }
+    }
   }
 
   private getBlockValues = async (params: [blockTag: string, _: boolean]) => {