@1inch/solidity-utils 1.2.0 → 1.2.4

package/js/profileEVM.js

@@ -1,84 +1,88 @@
-const { promisify } = require('util');
-const fs = require('fs').promises;
-
-function _normalizeOp (op) {
-    if (op.op === 'STATICCALL') {
-        if (op.stack.length > 8 && op.stack[op.stack.length - 8] === '0000000000000000000000000000000000000000000000000000000000000001') {
-            op.gasCost = 700 + 3000;
-            op.op = 'STATICCALL-ECRECOVER';
-        } else if (op.stack.length > 8 && op.stack[op.stack.length - 8] <= '00000000000000000000000000000000000000000000000000000000000000FF') {
-            op.gasCost = 700;
-            op.op = 'STATICCALL-' + op.stack[op.stack.length - 8].substr(62, 2);
-        } else {
-            op.gasCost = 700;
-        }
-    }
-    if (['CALL', 'DELEGATECALL', 'CALLCODE'].indexOf(op.op) !== -1) {
-        op.gasCost = 700;
-    }
-    if (['RETURN', 'REVERT', 'INVALID'].indexOf(op.op) !== -1) {
-        op.gasCost = 3;
-    }
-}
-
-async function profileEVM (txHash, instruction, optionalTraceFile) {
-    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
-        jsonrpc: '2.0',
-        method: 'debug_traceTransaction',
-        params: [txHash, {}],
-        id: new Date().getTime(),
-    });
-
-    const str = JSON.stringify(trace);
-
-    if (optionalTraceFile) {
-        await fs.writeFile(optionalTraceFile, str);
-    }
-
-    if (Array.isArray(instruction)) {
-        return instruction.map(instr => {
-            return str.split('"' + instr.toUpperCase() + '"').length - 1;
-        });
-    }
-
-    return str.split('"' + instruction.toUpperCase() + '"').length - 1;
-}
-
-async function gasspectEVM (txHash, optionalTraceFile) {
-    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
-        jsonrpc: '2.0',
-        method: 'debug_traceTransaction',
-        params: [txHash, {}],
-        id: new Date().getTime(),
-    });
-
-    const ops = trace.result.structLogs;
-
-    const traceAddress = [0, -1];
-    for (const op of ops) {
-        op.traceAddress = traceAddress.slice(0, traceAddress.length - 1);
-        _normalizeOp(op);
-
-        if (op.depth + 2 > traceAddress.length) {
-            traceAddress[traceAddress.length - 1] += 1;
-            traceAddress.push(-1);
-        }
-
-        if (op.depth + 2 < traceAddress.length) {
-            traceAddress.pop();
-        }
-    }
-
-    const result = ops.filter(op => op.gasCost > 300).map(op => op.traceAddress.join('-') + '-' + op.op + ' = ' + op.gasCost);
-
-    if (optionalTraceFile) {
-        await fs.writeFile(optionalTraceFile, JSON.stringify(result));
-    }
-
-    return result;
-}
-
-module.exports = {
-    profileEVM,
-    gasspectEVM,
-};
+const { promisify } = require('util');
+const fs = require('fs').promises;
+
+function _normalizeOp (op) {
+    if (op.op === 'STATICCALL') {
+        if (op.stack.length > 8 && op.stack[op.stack.length - 8] === '0000000000000000000000000000000000000000000000000000000000000001') {
+            op.gasCost = 700 + 3000;
+            op.op = 'STATICCALL-ECRECOVER';
+        } else if (op.stack.length > 8 && op.stack[op.stack.length - 8] <= '00000000000000000000000000000000000000000000000000000000000000FF') {
+            op.gasCost = 700;
+            op.op = 'STATICCALL-' + op.stack[op.stack.length - 8].substr(62, 2);
+        } else {
+            op.gasCost = 700;
+        }
+    }
+    if (['CALL', 'DELEGATECALL', 'CALLCODE'].indexOf(op.op) !== -1) {
+        op.gasCost = 700;
+    }
+    if (['RETURN', 'REVERT', 'INVALID'].indexOf(op.op) !== -1) {
+        op.gasCost = 3;
+    }
+}
+
+async function profileEVM (txHash, instruction, optionalTraceFile) {
+    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
+        jsonrpc: '2.0',
+        method: 'debug_traceTransaction',
+        params: [txHash, {}],
+        id: new Date().getTime(),
+    });
+
+    const str = JSON.stringify(trace);
+
+    if (optionalTraceFile) {
+        await fs.writeFile(optionalTraceFile, str);
+    }
+
+    if (Array.isArray(instruction)) {
+        return instruction.map(instr => {
+            return str.split('"' + instr.toUpperCase() + '"').length - 1;
+        });
+    }
+
+    return str.split('"' + instruction.toUpperCase() + '"').length - 1;
+}
+
+async function gasspectEVM (txHash, options = {}, optionalTraceFile) {
+    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
+        jsonrpc: '2.0',
+        method: 'debug_traceTransaction',
+        params: [txHash, {}],
+        id: new Date().getTime(),
+    });
+
+    const ops = trace.result.structLogs;
+
+    const traceAddress = [0, -1];
+    for (const op of ops) {
+        op.traceAddress = traceAddress.slice(0, traceAddress.length - 1);
+        _normalizeOp(op);
+
+        if (op.depth + 2 > traceAddress.length) {
+            traceAddress[traceAddress.length - 1] += 1;
+            traceAddress.push(-1);
+        }
+
+        if (op.depth + 2 < traceAddress.length) {
+            traceAddress.pop();
+        }
+    }
+
+    const minOpGasCost = options.minOpGasCost ? options.minOpGasCost : 300;
+    const result = ops.filter(op => op.gasCost > minOpGasCost).map(op => op.traceAddress.join('-') + '-' + op.op +
+                        (options.args ? '(' + (op.args || []).join(',') + ')' : '') +
+                        (options.res ? (op.res ? ':0x' + op.res : '') : '') +
+                        ' = ' + op.gasCost);
+
+    if (optionalTraceFile) {
+        await fs.writeFile(optionalTraceFile, JSON.stringify(result));
+    }
+
+    return result;
+}
+
+module.exports = {
+    profileEVM,
+    gasspectEVM,
+};

package/js/utils.js

@@ -1,68 +1,68 @@
-const { constants, time } = require('@openzeppelin/test-helpers');
-const { promisify } = require('util');
-
-async function timeIncreaseTo (seconds) {
-    const delay = 1000 - new Date().getMilliseconds();
-    await new Promise(resolve => setTimeout(resolve, delay));
-    await time.increaseTo(seconds);
-}
-
-async function trackReceivedToken (token, wallet, txPromise, ...args) {
-    return (await trackReceivedTokenAndTx(token, wallet, txPromise, ...args))[0];
-}
-
-async function trackReceivedTokenAndTx (token, wallet, txPromise, ...args) {
-    const isETH = token.address === constants.ZERO_ADDRESS || token.address === '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
-    const preBalance = web3.utils.toBN(isETH ? await web3.eth.getBalance(wallet) : await token.balanceOf(wallet));
-    const txResult = await txPromise(...args);
-    const txFees = (wallet.toLowerCase() === txResult.receipt.from.toLowerCase() && isETH)
-        ? web3.utils.toBN(txResult.receipt.gasUsed).mul(web3.utils.toBN(txResult.receipt.effectiveGasPrice))
-        : web3.utils.toBN('0');
-    const postBalance = web3.utils.toBN(isETH ? await web3.eth.getBalance(wallet) : await token.balanceOf(wallet));
-    return [postBalance.sub(preBalance).add(txFees), txResult];
-}
-
-function fixSignature (signature) {
-    // in geth its always 27/28, in ganache its 0/1. Change to 27/28 to prevent
-    // signature malleability if version is 0/1
-    // see https://github.com/ethereum/go-ethereum/blob/v1.8.23/internal/ethapi/api.go#L465
-    let v = parseInt(signature.slice(130, 132), 16);
-    if (v < 27) {
-        v += 27;
-    }
-    const vHex = v.toString(16);
-    return signature.slice(0, 130) + vHex;
-}
-
-// signs message in node (ganache auto-applies "Ethereum Signed Message" prefix)
-async function signMessage (signer, messageHex = '0x') {
-    return fixSignature(await web3.eth.sign(messageHex, signer));
-}
-
-async function countInstructions (txHash, instruction) {
-    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
-        jsonrpc: '2.0',
-        method: 'debug_traceTransaction',
-        params: [txHash, {}],
-        id: new Date().getTime(),
-    });
-
-    const str = JSON.stringify(trace);
-
-    if (Array.isArray(instruction)) {
-        return instruction.map(instr => {
-            return str.split('"' + instr.toUpperCase() + '"').length - 1;
-        });
-    }
-
-    return str.split('"' + instruction.toUpperCase() + '"').length - 1;
-}
-
-module.exports = {
-    timeIncreaseTo,
-    trackReceivedToken,
-    trackReceivedTokenAndTx,
-    fixSignature,
-    signMessage,
-    countInstructions,
-};
+const { constants, time } = require('@openzeppelin/test-helpers');
+const { promisify } = require('util');
+
+async function timeIncreaseTo (seconds) {
+    const delay = 1000 - new Date().getMilliseconds();
+    await new Promise(resolve => setTimeout(resolve, delay));
+    await time.increaseTo(seconds);
+}
+
+async function trackReceivedToken (token, wallet, txPromise, ...args) {
+    return (await trackReceivedTokenAndTx(token, wallet, txPromise, ...args))[0];
+}
+
+async function trackReceivedTokenAndTx (token, wallet, txPromise, ...args) {
+    const isETH = token.address === constants.ZERO_ADDRESS || token.address === '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
+    const preBalance = web3.utils.toBN(isETH ? await web3.eth.getBalance(wallet) : await token.balanceOf(wallet));
+    const txResult = await txPromise(...args);
+    const txFees = (wallet.toLowerCase() === txResult.receipt.from.toLowerCase() && isETH)
+        ? web3.utils.toBN(txResult.receipt.gasUsed).mul(web3.utils.toBN(txResult.receipt.effectiveGasPrice))
+        : web3.utils.toBN('0');
+    const postBalance = web3.utils.toBN(isETH ? await web3.eth.getBalance(wallet) : await token.balanceOf(wallet));
+    return [postBalance.sub(preBalance).add(txFees), txResult];
+}
+
+function fixSignature (signature) {
+    // in geth its always 27/28, in ganache its 0/1. Change to 27/28 to prevent
+    // signature malleability if version is 0/1
+    // see https://github.com/ethereum/go-ethereum/blob/v1.8.23/internal/ethapi/api.go#L465
+    let v = parseInt(signature.slice(130, 132), 16);
+    if (v < 27) {
+        v += 27;
+    }
+    const vHex = v.toString(16);
+    return signature.slice(0, 130) + vHex;
+}
+
+// signs message in node (ganache auto-applies "Ethereum Signed Message" prefix)
+async function signMessage (signer, messageHex = '0x') {
+    return fixSignature(await web3.eth.sign(messageHex, signer));
+}
+
+async function countInstructions (txHash, instruction) {
+    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
+        jsonrpc: '2.0',
+        method: 'debug_traceTransaction',
+        params: [txHash, {}],
+        id: new Date().getTime(),
+    });
+
+    const str = JSON.stringify(trace);
+
+    if (Array.isArray(instruction)) {
+        return instruction.map(instr => {
+            return str.split('"' + instr.toUpperCase() + '"').length - 1;
+        });
+    }
+
+    return str.split('"' + instruction.toUpperCase() + '"').length - 1;
+}
+
+module.exports = {
+    timeIncreaseTo,
+    trackReceivedToken,
+    trackReceivedTokenAndTx,
+    fixSignature,
+    signMessage,
+    countInstructions,
+};

package/package.json

@@ -1,59 +1,60 @@
-{
-  "name": "@1inch/solidity-utils",
-  "version": "1.2.0",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/1inch/solidity-utils.git"
-  },
-  "license": "MIT",
-  "dependencies": {
-    "@openzeppelin/contracts": "^4.3.2"
-  },
-  "devDependencies": {
-    "@nomiclabs/hardhat-etherscan": "^2.1.6",
-    "@nomiclabs/hardhat-truffle5": "^2.0.0",
-    "@nomiclabs/hardhat-web3": "^2.0.0",
-    "@openzeppelin/test-helpers": "^0.5.13",
-    "chai": "^4.3.4",
-    "cross-spawn": "^7.0.3",
-    "dotenv": "^10.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-standard": "^5.0.0",
-    "hardhat": "^2.6.4",
-    "hardhat-deploy": "^0.9.2",
-    "hardhat-gas-reporter": "^1.0.4",
-    "rimraf": "^3.0.2",
-    "shx": "^0.3.3",
-    "solc": "^0.8.9",
-    "solhint": "^3.3.6",
-    "solidity-coverage": "^0.7.17"
-  },
-  "bin": {
-    "solidity-utils-docify": "utils/docify.utils.js"
-  },
-  "scripts": {
-    "build": "rimraf ./dist && mkdir dist && shx cp -R js ./dist/js && shx cp -R utils ./dist/utils && shx cp package.json ./dist",
-    "coverage": "hardhat coverage",
-    "lint": "yarn run lint:js && yarn run lint:sol",
-    "lint:fix": "yarn run lint:js:fix && yarn run lint:sol:fix",
-    "lint:js": "eslint .",
-    "lint:js:fix": "eslint . --fix",
-    "lint:sol": "solhint --max-warnings 0 \"contracts/**/*.sol\"",
-    "lint:sol:fix": "solhint --max-warnings 0 \"contracts/**/*.sol\" --fix",
-    "test": "hardhat test"
-  },
-  "bugs": {
-    "url": "https://github.com/1inch/solidity-utils/issues"
-  },
-  "homepage": "https://github.com/1inch/solidity-utils#readme",
-  "directories": {
-    "test": "test"
-  },
-  "author": "1inch",
-  "description": ""
-}
+{
+  "name": "@1inch/solidity-utils",
+  "version": "1.2.4",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/1inch/solidity-utils.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@openzeppelin/contracts": "^4.4.0",
+    "ethereumjs-wallet": "^1.0.2"
+  },
+  "devDependencies": {
+    "@nomiclabs/hardhat-etherscan": "^2.1.8",
+    "@nomiclabs/hardhat-truffle5": "^2.0.0",
+    "@nomiclabs/hardhat-web3": "^2.0.0",
+    "@openzeppelin/test-helpers": "^0.5.15",
+    "chai": "^4.3.4",
+    "cross-spawn": "^7.0.3",
+    "dotenv": "^10.0.0",
+    "eslint": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.1",
+    "eslint-plugin-standard": "^5.0.0",
+    "hardhat": "^2.7.0",
+    "hardhat-deploy": "^0.9.14",
+    "hardhat-gas-reporter": "^1.0.6",
+    "rimraf": "^3.0.2",
+    "shx": "^0.3.3",
+    "solc": "^0.8.10",
+    "solhint": "^3.3.6",
+    "solidity-coverage": "^0.7.17"
+  },
+  "bin": {
+    "solidity-utils-docify": "utils/docify.utils.js"
+  },
+  "scripts": {
+    "build": "rimraf ./dist && mkdir dist && shx cp -R js ./dist/js && shx cp -R utils ./dist/utils && shx cp package.json ./dist && shx cp README.md ./dist && shx cp -R ./contracts ./dist/contracts && shx rm -rf dist/contracts/mocks dist/contracts/tests",
+    "coverage": "hardhat coverage",
+    "lint": "yarn run lint:js && yarn run lint:sol",
+    "lint:fix": "yarn run lint:js:fix && yarn run lint:sol:fix",
+    "lint:js": "eslint .",
+    "lint:js:fix": "eslint . --fix",
+    "lint:sol": "solhint --max-warnings 0 \"contracts/**/*.sol\"",
+    "lint:sol:fix": "solhint --max-warnings 0 \"contracts/**/*.sol\" --fix",
+    "test": "hardhat test"
+  },
+  "bugs": {
+    "url": "https://github.com/1inch/solidity-utils/issues"
+  },
+  "homepage": "https://github.com/1inch/solidity-utils#readme",
+  "directories": {
+    "test": "test"
+  },
+  "author": "1inch",
+  "description": "Solidity and JS utils"
+}

package/utils/contract.hbs

@@ -1,69 +1,69 @@
-# {{{name}}}
-
-
-{{{natspec.title}}}
-{{{natspec.userdoc}}}
-{{{natspec.devdoc}}}
-
-{{#if (withoutFirstElement inheritance)}}
-## Derives
-{{/if}}
-{{#each (withoutFirstElement inheritance)}}
-{{#if (getRelativeDocPath name source.contractsDir source.solcOutput.sources)}}
-- [{{name}}]({{getRelativeDocPath name source.contractsDir source.solcOutput.sources}})
-{{else}}
-- {{name}}
-{{/if}}
-{{/each}}
-
-{{#if ownFunctions}}
-## Functions
-{{/if}}
-{{#ownFunctions}}
-### {{name}}
-```solidity
-function {{name}}(
-  {{#args}}
-  {{type}} {{name}}{{#if @last}}{{else}},{{/if}}
-  {{/args}}
-) {{visibility}}{{#if outputs}} returns ({{outputs}}){{/if}}
-```
-{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
-{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
-{{#if args}}
-#### Parameters:
-| Name | Type | Description                                                          |
-| :--- | :--- | :------------------------------------------------------------------- |
-{{#args}}
-|`{{name}}` | {{type}} | {{#with (lookup ../natspec.params @index)~}} {{ removeNewlines description }} {{/with}}
-{{/args}}{{/if}}
-{{#if natspec.returns}}
-#### Return Values:
-| Name                           | Type          | Description                                                                  |
-| :----------------------------- | :------------ | :--------------------------------------------------------------------------- |
-{{#natspec.returns}}
-|`{{param}}`| {{#lookup ../outputs.types @index}}{{/lookup}} | {{{removeNewlines description}}}
-{{/natspec.returns}}{{/if}}
-{{/ownFunctions}}
-{{#if ownEvents}}
-## Events
-{{/if}}
-{{#ownEvents}}
-### {{name}}
-```solidity
-event {{name}}(
-  {{#args}}
-  {{type}} {{name}}{{#if @last}}{{else}},{{/if}}
-  {{/args}}
-)
-```
-{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
-{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
-{{#if args}}
-#### Parameters:
-| Name | Type | Description                                                          |
-| :--- | :--- | :------------------------------------------------------------------- |
-{{#args}}
-|`{{name}}` | {{type}} | {{#with (lookup ../natspec.params @index)~}} {{ removeNewlines description }} {{/with}}
-{{/args}}{{/if}}
-{{/ownEvents}}
+# {{{name}}}
+
+
+{{{natspec.title}}}
+{{{natspec.userdoc}}}
+{{{natspec.devdoc}}}
+
+{{#if (withoutFirstElement inheritance)}}
+## Derives
+{{/if}}
+{{#each (withoutFirstElement inheritance)}}
+{{#if (getRelativeDocPath name source.contractsDir source.solcOutput.sources)}}
+- [{{name}}]({{getRelativeDocPath name source.contractsDir source.solcOutput.sources}})
+{{else}}
+- {{name}}
+{{/if}}
+{{/each}}
+
+{{#if ownFunctions}}
+## Functions
+{{/if}}
+{{#ownFunctions}}
+### {{name}}
+```solidity
+function {{name}}(
+  {{#args}}
+  {{type}} {{name}}{{#if @last}}{{else}},{{/if}}
+  {{/args}}
+) {{visibility}}{{#if outputs}} returns ({{outputs}}){{/if}}
+```
+{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
+{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
+{{#if args}}
+#### Parameters:
+| Name | Type | Description                                                          |
+| :--- | :--- | :------------------------------------------------------------------- |
+{{#args}}
+|`{{name}}` | {{type}} | {{#with (lookup ../natspec.params @index)~}} {{ removeNewlines description }} {{/with}}
+{{/args}}{{/if}}
+{{#if natspec.returns}}
+#### Return Values:
+| Name                           | Type          | Description                                                                  |
+| :----------------------------- | :------------ | :--------------------------------------------------------------------------- |
+{{#natspec.returns}}
+|`{{param}}`| {{#lookup ../outputs.types @index}}{{/lookup}} | {{{removeNewlines description}}}
+{{/natspec.returns}}{{/if}}
+{{/ownFunctions}}
+{{#if ownEvents}}
+## Events
+{{/if}}
+{{#ownEvents}}
+### {{name}}
+```solidity
+event {{name}}(
+  {{#args}}
+  {{type}} {{name}}{{#if @last}}{{else}},{{/if}}
+  {{/args}}
+)
+```
+{{#if natspec.userdoc}}{{natspec.userdoc}}{{/if}}
+{{#if natspec.devdoc}}{{natspec.devdoc}}{{/if}}
+{{#if args}}
+#### Parameters:
+| Name | Type | Description                                                          |
+| :--- | :--- | :------------------------------------------------------------------- |
+{{#args}}
+|`{{name}}` | {{type}} | {{#with (lookup ../natspec.params @index)~}} {{ removeNewlines description }} {{/with}}
+{{/args}}{{/if}}
+{{/ownEvents}}