feat: add support for debug_storageRangeAt RPC (trufflesuite#755)

contractshark · Apr 15, 2021 · fb874f1 · fb874f1
1 parent 59a20c3
commit fb874f1
Show file tree

Hide file tree

Showing 10 changed files with 986 additions and 123 deletions.
diff --git a/src/chains/ethereum/ethereum/src/api.ts b/src/chains/ethereum/ethereum/src/api.ts
@@ -332,13 +332,6 @@ export default class EthereumApi implements types.Api {
     const blockProm = this.#blockchain.blocks.getRaw(blockNumber);
 
     const trie = this.#blockchain.trie.copy();
-    const getFromTrie = (address: Buffer): Promise<Buffer> =>
-      new Promise((resolve, reject) => {
-        trie.get(address, (err, data) => {
-          if (err) return void reject(err);
-          resolve(data);
-        });
-      });
     const block = await blockProm;
     if (!block) throw new Error("header not found");
 
@@ -351,7 +344,10 @@ export default class EthereumApi implements types.Api {
     const blockStateRoot = headerData[3];
     trie.root = blockStateRoot;
 
-    const addressDataPromise = getFromTrie(Address.from(address).toBuffer());
+    const addressDataPromise = this.#blockchain.getFromTrie(
+      trie,
+      Address.from(address).toBuffer()
+    );
 
     const posBuff = Quantity.from(position).toBuffer();
     const length = posBuff.length;
@@ -1087,13 +1083,6 @@ export default class EthereumApi implements types.Api {
     const blockProm = blockchain.blocks.getRaw(blockNumber);
 
     const trie = blockchain.trie.copy();
-    const getFromTrie = (address: Buffer): Promise<Buffer> =>
-      new Promise((resolve, reject) => {
-        trie.get(address, (err: Error, data: Buffer) => {
-          if (err) return void reject(err);
-          resolve(data);
-        });
-      });
     const block = await blockProm;
     if (!block) throw new Error("header not found");
 
@@ -1106,7 +1095,10 @@ export default class EthereumApi implements types.Api {
     const blockStateRoot = headerData[3];
     trie.root = blockStateRoot;
 
-    const addressDataPromise = getFromTrie(Address.from(address).toBuffer());
+    const addressDataPromise = this.#blockchain.getFromTrie(
+      trie,
+      Address.from(address).toBuffer()
+    );
 
     const addressData = await addressDataPromise;
     // An address's codeHash is stored in the 4th rlp entry
@@ -1144,13 +1136,6 @@ export default class EthereumApi implements types.Api {
     const blockProm = this.#blockchain.blocks.getRaw(blockNumber);
 
     const trie = this.#blockchain.trie.copy();
-    const getFromTrie = (address: Buffer): Promise<Buffer> =>
-      new Promise((resolve, reject) => {
-        trie.get(address, (err, data) => {
-          if (err) return void reject(err);
-          resolve(data);
-        });
-      });
     const block = await blockProm;
     if (!block) throw new Error("header not found");
 
@@ -1163,7 +1148,10 @@ export default class EthereumApi implements types.Api {
     const blockStateRoot = headerData[3];
     trie.root = blockStateRoot;
 
-    const addressDataPromise = getFromTrie(Address.from(address).toBuffer());
+    const addressDataPromise = this.#blockchain.getFromTrie(
+      trie,
+      Address.from(address).toBuffer()
+    );
 
     const posBuff = Quantity.from(position).toBuffer();
     const length = posBuff.length;
@@ -1189,7 +1177,7 @@ export default class EthereumApi implements types.Api {
       Buffer /*stateRoot*/,
       Buffer /*codeHash*/
     ])[2];
-    const value = await getFromTrie(paddedPosBuff);
+    const value = await this.#blockchain.getFromTrie(trie, paddedPosBuff);
     return Data.from(rlpDecode(value));
   }
 
@@ -1907,6 +1895,35 @@ export default class EthereumApi implements types.Api {
     return this.#blockchain.traceTransaction(transactionHash, options || {});
   }
 
+  /**
+   * Attempts to replay the transaction as it was executed on the network and
+   * return storage data given a starting key and max number of entries to return.
+   *
+   * @param blockHash DATA, 32 Bytes - hash of a block
+   * @param txIndex QUANTITY - integer of the transaction index position
+   * @param contractAddress DATA, 20 Bytes - address of the contract
+   * @param startKey DATA - hash of the start key for grabbing storage entries
+   * @param maxResult integer of maximum number of storage entries to return
+   * @returns returns a storage object with the keys being keccak-256 hashes of the storage keys,
+   * and the values being the raw, unhashed key and value for that specific storage slot. Also
+   * returns a next key which is the keccak-256 hash of the next key in storage for continuous downloading.
+   */
+  async debug_storageRangeAt(
+    blockHash: string | Buffer,
+    transactionIndex: number,
+    contractAddress: string,
+    keyStart: string | Buffer,
+    maxResult: number
+  ) {
+    return this.#blockchain.storageRangeAt(
+      blockHash,
+      transactionIndex,
+      contractAddress,
+      keyStart,
+      maxResult
+    );
+  }
+
   //#endregion
 
   //#region personal