sol-dbg 0.1.6 → 0.2.2

package/dist/utils/test_runner.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VMTestRunner = exports.ResultKind = void 0;
+const block_1 = require("@ethereumjs/block");
+const util_1 = require("@ethereumjs/util");
+const solc_typed_ast_1 = require("solc-typed-ast");
+const misc_1 = require("./misc");
+const common_1 = require("@ethereumjs/common");
+var ResultKind;
+(function (ResultKind) {
+    ResultKind["ContractCreated"] = "contract_created";
+    ResultKind["ValueReturned"] = "value_returned";
+    ResultKind["Revert"] = "revert";
+    ResultKind["FoundryFail"] = "foundry_fail";
+})(ResultKind || (exports.ResultKind = ResultKind = {}));
+/**
+ * Helper class to re-play harvey test cases on a in-memory VmProxy
+ */
+class VMTestRunner {
+    get vm() {
+        return this._vm;
+    }
+    constructor(vm) {
+        this._stateRootBeforeTx = new Map();
+        this._vm = vm;
+        this._txs = [];
+        this._results = [];
+        this._txToBlock = new Map();
+    }
+    async runTestCase(testCaseJSON) {
+        await this.setupInitialState(testCaseJSON.initialState);
+        for (let i = 0; i < testCaseJSON.steps.length; i++) {
+            const tx = await this.harveyStepToTransaction(testCaseJSON.steps[i]);
+            const block = this.harveyStepToBlock(testCaseJSON.steps[i]);
+            const res = await this._runTxInt(tx, block);
+            this._results.push(res);
+        }
+    }
+    async setupInitialState(initialState) {
+        const state = this.vm.stateManager;
+        await state.checkpoint();
+        for (const addressStr of Object.keys(initialState.accounts)) {
+            const { nonce, balance, code, storage } = initialState.accounts[addressStr];
+            const address = util_1.Address.fromString(addressStr);
+            const codeBuf = Buffer.from(code.slice(2), "hex");
+            const acct = new util_1.Account();
+            acct.nonce = BigInt(nonce);
+            acct.balance = BigInt(balance);
+            state.putAccount(address, acct);
+            for (const [key, val] of Object.entries(storage)) {
+                const keyBuf = (0, misc_1.hexStrToBuf32)(key.slice(2));
+                const valBuf = (0, misc_1.hexStrToBuf32)(val.slice(2));
+                await state.putContractStorage(address, keyBuf, valBuf);
+            }
+            await state.putContractCode(address, codeBuf);
+        }
+        await state.commit();
+        await state.flush();
+    }
+    async harveyStepToTransaction(step) {
+        const senderAddress = util_1.Address.fromString(step.origin);
+        const senderAccount = await this.vm.stateManager.getAccount(senderAddress);
+        const senderNonce = senderAccount.nonce;
+        const txData = {
+            value: step.value,
+            gasLimit: step.gasLimit,
+            gasPrice: 8,
+            data: step.input,
+            nonce: senderNonce
+        };
+        if (step.address !== misc_1.ZERO_ADDRESS_STRING) {
+            txData.to = step.address;
+        }
+        return (0, misc_1.makeFakeTransaction)(txData, step.origin, this._vm._common);
+    }
+    harveyStepToBlock(step) {
+        return block_1.Block.fromBlockData({
+            header: {
+                coinbase: step.origin,
+                difficulty: this.vm._common.hardfork() === common_1.Hardfork.Shanghai ? 0 : step.blockDifficulty,
+                gasLimit: step.blockGasLimit,
+                number: step.blockNumber,
+                timestamp: step.blockTime
+            }
+        }, {
+            common: this.vm._common
+        });
+    }
+    async _runTxInt(tx, block) {
+        const txHash = tx.hash().toString("hex");
+        this._txs.push(tx);
+        this._stateRootBeforeTx.set(txHash, this.vm.stateManager.copy());
+        this._txToBlock.set(txHash, block);
+        const res = this.vm.runTx({
+            tx,
+            block,
+            skipBalance: true,
+            skipNonce: true,
+            skipBlockGasLimitValidation: true
+        });
+        await this.vm.stateManager.flush();
+        return res;
+    }
+    get txs() {
+        return this._txs;
+    }
+    get results() {
+        return this._results;
+    }
+    getStateBeforeTx(tx) {
+        const txHash = tx.hash().toString("hex");
+        const res = this._stateRootBeforeTx.get(txHash);
+        (0, solc_typed_ast_1.assert)(res !== undefined, `Unable to find state before tx ${txHash}`);
+        return res;
+    }
+    getBlock(tx) {
+        const txHash = tx.hash().toString("hex");
+        const res = this._txToBlock.get(txHash);
+        (0, solc_typed_ast_1.assert)(res !== undefined, `Unable to find block for tx ${txHash}`);
+        return res;
+    }
+}
+exports.VMTestRunner = VMTestRunner;
+//# sourceMappingURL=test_runner.js.map

package/dist/utils/test_runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test_runner.js","sourceRoot":"","sources":["../../src/utils/test_runner.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAG1C,2CAAoD;AAEpD,mDAAwC;AAExC,iCAAiF;AACjF,+CAA8C;AAoC9C,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,kDAAoC,CAAA;IACpC,8CAAgC,CAAA;IAChC,+BAAiB,CAAA;IACjB,0CAA4B,CAAA;AAChC,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAmCD;;GAEG;AACH,MAAa,YAAY;IAOrB,IAAI,EAAE;QACF,OAAO,IAAI,CAAC,GAAG,CAAC;IACpB,CAAC;IAED,YAAY,EAAM;QANV,uBAAkB,GAAG,IAAI,GAAG,EAAwB,CAAC;QAOzD,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,YAA0B;QACxC,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAExD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAChD,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACrE,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YAE5C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC3B;IACL,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,YAA0B;QACtD,MAAM,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC;QAEnC,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;QAEzB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE;YACzD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAE5E,MAAM,OAAO,GAAG,cAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAElD,MAAM,IAAI,GAAG,IAAI,cAAO,EAAE,CAAC;YAE3B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAE/B,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAEhC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC9C,MAAM,MAAM,GAAG,IAAA,oBAAa,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3C,MAAM,MAAM,GAAG,IAAA,oBAAa,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE3C,MAAM,KAAK,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;aAC3D;YAED,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACjD;QAED,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,IAAkB;QAC5C,MAAM,aAAa,GAAG,cAAO,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC;QAExC,MAAM,MAAM,GAAW;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,CAAC;YACX,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,KAAK,EAAE,WAAW;SACrB,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,KAAK,0BAAmB,EAAE;YACtC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;SAC5B;QAED,OAAO,IAAA,0BAAmB,EAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC;IAED,iBAAiB,CAAC,IAAkB;QAChC,OAAO,aAAK,CAAC,aAAa,CACtB;YACI,MAAM,EAAE;gBACJ,QAAQ,EAAE,IAAI,CAAC,MAAM;gBACrB,UAAU,EACN,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,iBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe;gBAC/E,QAAQ,EAAE,IAAI,CAAC,aAAa;gBAC5B,MAAM,EAAE,IAAI,CAAC,WAAW;gBACxB,SAAS,EAAE,IAAI,CAAC,SAAS;aAC5B;SACJ,EACD;YACI,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,OAAO;SAC1B,CACJ,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,EAAe,EAAE,KAAY;QACjD,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAEzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEnB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAEnC,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;YACtB,EAAE;YACF,KAAK;YACL,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,IAAI;YACf,2BAA2B,EAAE,IAAI;SACpC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAEnC,OAAO,GAAG,CAAC;IACf,CAAC;IAED,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,gBAAgB,CAAC,EAAe;QAC5B,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEhD,IAAA,uBAAM,EAAC,GAAG,KAAK,SAAS,EAAE,kCAAkC,MAAM,EAAE,CAAC,CAAC;QAEtE,OAAO,GAAG,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,EAAe;QACpB,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAExC,IAAA,uBAAM,EAAC,GAAG,KAAK,SAAS,EAAE,+BAA+B,MAAM,EAAE,CAAC,CAAC;QAEnE,OAAO,GAAG,CAAC;IACf,CAAC;CACJ;AAjJD,oCAiJC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sol-dbg",
-    "version": "0.1.6",
+    "version": "0.2.2",
     "description": "Small (experimental) Solidity-level debugger built around EthereumJS",
     "keywords": [],
     "files": [
@@ -19,14 +19,15 @@
         "prepare": "npm run build"
     },
     "dependencies": {
-        "@ethereumjs/block": "^3.6.3",
-        "@ethereumjs/common": "^2.6.5",
-        "@ethereumjs/tx": "^3.5.2",
-        "@ethereumjs/vm": "^5.9.3",
-        "@remix-project/remix-simulator": "0.2.14",
-        "ethereum-cryptography": "2.0.0",
+        "@ethereumjs/block": "4.3.0",
+        "@ethereumjs/common": "3.2.0",
+        "@ethereumjs/tx": "4.2.0",
+        "@ethereumjs/vm": "6.5.0",
+        "@ethereumjs/evm": "1.4.0",
+        "@ethereumjs/statemanager": "1.1.0",
         "cbor": "^8.1.0",
         "ethereumjs-util": "^7.1.5",
+        "ethereum-cryptography": "2.0.0",
         "solc-typed-ast": "^14.0.2",
         "src-location": "^1.1.0",
         "web3-eth-abi": "^1.9.0"
@@ -36,22 +37,22 @@
         "@types/fs-extra": "^11.0.1",
         "@types/lru-cache": "^5.1.1",
         "@types/mocha": "^10.0.1",
-        "@types/node": "^16.18.24",
-        "@typescript-eslint/eslint-plugin": "^5.59.0",
-        "@typescript-eslint/parser": "^5.59.0",
-        "eslint": "^8.38.0",
+        "@types/node": "^16.18.25",
+        "@typescript-eslint/eslint-plugin": "^5.59.2",
+        "@typescript-eslint/parser": "^5.59.2",
+        "eslint": "^8.40.0",
         "eslint-config-prettier": "^8.8.0",
         "eslint-plugin-prettier": "^4.2.1",
         "expect": "^29.5.0",
         "fs-extra": "^11.1.1",
         "mocha": "^10.2.0",
         "nyc": "^15.1.0",
-        "prettier": "^2.8.7",
+        "prettier": "^2.8.8",
         "ts-node": "^10.9.1",
         "typescript": "^5.0.4"
     },
     "homepage": "https://github.com/ConsenSys/sol-dbg",
     "bugs": "https://github.com/ConsenSys/sol-dbg/issues",
     "repository": "https://github.com/ConsenSys/sol-dbg",
-    "license": "See LICENCE file."
+    "license": "Apache-2.0"
 }