@1inch/solidity-utils 1.2.8 → 2.0.4

package/dist/src/utils.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countInstructions = exports.signMessage = exports.fixSignature = exports.trackReceivedTokenAndTx = exports.timeIncreaseTo = void 0;
+const util_1 = require("util");
+const prelude_1 = require("./prelude");
+async function timeIncreaseTo(seconds) {
+    const delay = 1000 - new Date().getMilliseconds();
+    await new Promise(resolve => setTimeout(resolve, delay));
+    await prelude_1.time.increaseTo(seconds);
+}
+exports.timeIncreaseTo = timeIncreaseTo;
+async function trackReceivedTokenAndTx(token, wallet, txPromise, ...args) {
+    const [balanceFunc, isETH] = 'balanceOf' in token
+        ? [() => token.balanceOf(wallet), false]
+        : [async () => (0, prelude_1.toBN)(await web3.eth.getBalance(wallet)), true];
+    const preBalance = await balanceFunc();
+    const txResult = await txPromise(...args);
+    const txFees = (wallet.toLowerCase() === txResult.receipt.from.toLowerCase() && isETH)
+        ? (0, prelude_1.toBN)(txResult.receipt.gasUsed).mul((0, prelude_1.toBN)(txResult.receipt.effectiveGasPrice))
+        : (0, prelude_1.toBN)('0');
+    const postBalance = await balanceFunc();
+    return [postBalance.sub(preBalance).add(txFees), txResult];
+}
+exports.trackReceivedTokenAndTx = trackReceivedTokenAndTx;
+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;
+}
+exports.fixSignature = fixSignature;
+// 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));
+}
+exports.signMessage = signMessage;
+async function countInstructions(txHash, instructions) {
+    if (!web3.currentProvider || typeof web3.currentProvider === 'string' || !web3.currentProvider.send) {
+        throw new Error('Unsupported provider');
+    }
+    const trace = await (0, util_1.promisify)(web3.currentProvider.send.bind(web3.currentProvider))({
+        jsonrpc: '2.0',
+        method: 'debug_traceTransaction',
+        params: [txHash, {}],
+        id: new Date().getTime(),
+    });
+    const str = JSON.stringify(trace);
+    return instructions.map(instr => {
+        return str.split('"' + instr.toUpperCase() + '"').length - 1;
+    });
+}
+exports.countInstructions = countInstructions;
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AAAA,+BAAiC;AACjC,uCAAkD;AAE3C,KAAK,UAAU,cAAc,CAAE,OAA6B;IAC/D,MAAM,KAAK,GAAG,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,eAAe,EAAE,CAAC;IAClD,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACzD,MAAM,cAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAJD,wCAIC;AASM,KAAK,UAAU,uBAAuB,CACzC,KAAiG,EACjG,MAAc,EACd,SAAkE,EAClE,GAAG,IAAO;IACV,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,GAClB,WAAW,IAAI,KAAK;QAChB,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;QACxC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,IAAA,cAAI,EAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1E,MAAM,UAAU,GAAG,MAAM,WAAW,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC;QAClF,CAAC,CAAC,IAAA,cAAI,EAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAA,cAAI,EAAC,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC9E,CAAC,CAAC,IAAA,cAAI,EAAC,GAAG,CAAC,CAAC;IAChB,MAAM,WAAW,GAAG,MAAM,WAAW,EAAE,CAAC;IACxC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAU,CAAC;AACxE,CAAC;AAhBD,0DAgBC;AAED,SAAgB,YAAY,CAAE,SAAiB;IAC3C,2EAA2E;IAC3E,2CAA2C;IAC3C,uFAAuF;IACvF,IAAI,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,EAAE;QACR,CAAC,IAAI,EAAE,CAAC;KACX;IACD,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;AAC1C,CAAC;AAVD,oCAUC;AAED,gFAAgF;AACzE,KAAK,UAAU,WAAW,CAAE,MAAc,EAAE,UAAU,GAAG,IAAI;IAChE,OAAO,YAAY,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,CAAC;AAFD,kCAEC;AAEM,KAAK,UAAU,iBAAiB,CAAE,MAAc,EAAE,YAAsB;IAC3E,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE;QACjG,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KAC3C;IACD,MAAM,KAAK,GAAG,MAAM,IAAA,gBAAS,EAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QAChF,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,wBAAwB;QAChC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC;QACpB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;KAC3B,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAElC,OAAO,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC5B,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACP,CAAC;AAhBD,8CAgBC"}

package/package.json

@@ -1,60 +1,87 @@
 {
   "name": "@1inch/solidity-utils",
-  "version": "1.2.8",
-  "main": "index.js",
+  "version": "2.0.4",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/1inch/solidity-utils.git"
   },
   "license": "MIT",
+  "scripts": {
+    "prebuild": "rimraf ./dist && cti src -b",
+    "build": "tsc -p tsconfig.publish.json",
+    "postbuild": "echo done",
+    "publishPackage": "yarn build && yarn publish",
+    "coverage": "hardhat coverage",
+    "lint": "yarn run lint:ts && yarn run lint:sol",
+    "lint:fix": "yarn run lint:ts:fix && yarn run lint:sol:fix",
+    "lint:ts": "eslint . --ext .ts",
+    "lint:ts:fix": "eslint . --fix --ext .ts",
+    "lint:sol": "solhint --max-warnings 0 \"contracts/**/*.sol\"",
+    "lint:sol:fix": "solhint --max-warnings 0 \"contracts/**/*.sol\" --fix",
+    "test": "hardhat test",
+    "typecheck": "tsc --noEmit --skipLibCheck",
+    "typechain": "hardhat typechain"
+  },
   "dependencies": {
-    "@openzeppelin/contracts": "^4.4.0",
-    "ethereumjs-wallet": "^1.0.2"
+    "@metamask/eth-sig-util": "^4.0.0",
+    "@openzeppelin/contracts": "4.5.0",
+    "@openzeppelin/test-helpers": "0.5.15",
+    "chai": "4.3.6",
+    "chai-as-promised": "7.1.1",
+    "ethereumjs-wallet": "1.0.2",
+    "hardhat": "2.8.4",
+    "web3-utils": "1.7.0"
   },
   "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"
+    "@nomiclabs/hardhat-etherscan": "3.0.1",
+    "@nomiclabs/hardhat-truffle5": "2.0.4",
+    "@nomiclabs/hardhat-web3": "2.0.0",
+    "@typechain/hardhat": "4.0.0",
+    "@typechain/truffle-v5": "7.0.0",
+    "@types/chai": "4.3.0",
+    "@types/chai-as-promised": "7.1.5",
+    "@types/mocha": "9.1.0",
+    "@types/node": "17.0.18",
+    "@typescript-eslint/eslint-plugin": "5.12.0",
+    "@typescript-eslint/parser": "5.12.0",
+    "chai-bn": "0.3.1",
+    "create-ts-index": "^1.14.0",
+    "cross-spawn": "7.0.3",
+    "dotenv": "16.0.0",
+    "eslint": "8.9.0",
+    "eslint-config-standard": "16.0.3",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "6.0.0",
+    "eslint-plugin-standard": "5.0.0",
+    "eslint-plugin-typescript": "0.14.0",
+    "hardhat-deploy": "0.10.5",
+    "hardhat-gas-reporter": "1.0.8",
+    "rimraf": "3.0.2",
+    "shx": "0.3.4",
+    "solc": "0.8.11",
+    "solhint": "3.3.7",
+    "solidity-coverage": "0.7.20",
+    "ts-node": "10.5.0",
+    "typechain": "7.0.0",
+    "typescript": "4.5.5"
   },
   "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 && shx mkdir -p dist/contracts/mocks && shx cp ./contracts/mocks/DaiLikePermitMock.sol dist/contracts/mocks/",
-    "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"
+  "description": "Solidity and TS utils",
+  "files": [
+    "./dist",
+    "./*.MD",
+    "contracts/*.sol",
+    "contracts/interfaces",
+    "contracts/libraries"
+  ]
 }

package/contracts/mocks/DaiLikePermitMock.sol

@@ -1,44 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.0;
-
-import "@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol";
-
-contract DaiLikePermitMock is ERC20Permit {
-	// bytes32 public constant PERMIT_TYPEHASH = keccak256("Permit(address holder,address spender,uint256 nonce,uint256 expiry,bool allowed)");
-    bytes32 public constant PERMIT_TYPEHASH = 0xea2aa0a1be11a07ed86d755c93467f4f82362b452371d1ba94d1715123511acb;
-    
-    constructor(
-        string memory name,
-        string memory symbol,
-        address initialAccount,
-        uint256 initialBalance
-    ) payable ERC20(name, symbol) ERC20Permit(name) {
-        _mint(initialAccount, initialBalance);
-    }
-
-    function permit(address holder, address spender, uint256 nonce, uint256 expiry, bool allowed, uint8 v, bytes32 r, bytes32 s) external
-    {
-        bytes32 digest =
-            keccak256(abi.encodePacked(
-                "\x19\x01",
-                this.DOMAIN_SEPARATOR(),
-                keccak256(abi.encode(PERMIT_TYPEHASH,
-                                     holder,
-                                     spender,
-                                     nonce,
-                                     expiry,
-                                     allowed))
-        ));
-
-        require(holder != address(0), "Dai/invalid-address-0");
-        require(holder == ecrecover(digest, v, r, s), "Dai/invalid-permit");
-        // solhint-disable-next-line not-rely-on-time
-        require(expiry == 0 || block.timestamp <= expiry, "Dai/permit-expired");
-        require(nonce == nonces(holder), "Dai/invalid-nonce");
-        _useNonce(holder);
-        uint wad = allowed ? type(uint128).max : 0;
-        _approve(holder, spender, wad);
-        emit Approval(holder, spender, wad);
-    }
-}

package/js/asserts.js

@@ -1,34 +0,0 @@
-const { expect } = require('chai');
-const { BN } = require('@openzeppelin/test-helpers');
-
-async function assertThrowsAsync (action, msg) {
-    try {
-        await action();
-    } catch (e) {
-        expect(e.message).to.contain(msg);
-        return;
-    }
-    throw new Error('Should have thrown an error but didn\'t');
-}
-
-function assertRoughlyEqualValues (expected, actual, relativeDiff) {
-    const expectedBN = new BN(expected);
-    const actualBN = new BN(actual);
-
-    let multiplerNumerator = relativeDiff;
-    let multiplerDenominator = new BN('1');
-    while (!Number.isInteger(multiplerNumerator)) {
-        multiplerDenominator = multiplerDenominator.mul(new BN('10'));
-        multiplerNumerator *= 10;
-    }
-    const diff = expectedBN.sub(actualBN).abs();
-    const treshold = expectedBN.mul(new BN(multiplerNumerator.toString())).div(multiplerDenominator);
-    if (!diff.lte(treshold)) {
-        expect(actualBN).to.be.bignumber.equal(expectedBN, `${actualBN} != ${expectedBN} with ${relativeDiff} precision`);
-    }
-}
-
-module.exports = {
-    assertThrowsAsync,
-    assertRoughlyEqualValues,
-};

package/js/permit.js

@@ -1,110 +0,0 @@
-const { constants } = require('@openzeppelin/test-helpers');
-const ethSigUtil = require('eth-sig-util');
-const { fromRpcSig } = require('ethereumjs-util');
-const { artifacts } = require('hardhat');
-const ERC20Permit = artifacts.require('@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol:ERC20Permit');
-const ERC20PermitLikeDai = artifacts.require('DaiLikePermitMock');
-
-const defaultDeadline = constants.MAX_UINT256;
-
-const EIP712Domain = [
-    { name: 'name', type: 'string' },
-    { name: 'version', type: 'string' },
-    { name: 'chainId', type: 'uint256' },
-    { name: 'verifyingContract', type: 'address' },
-];
-
-const Permit = [
-    { name: 'owner', type: 'address' },
-    { name: 'spender', type: 'address' },
-    { name: 'value', type: 'uint256' },
-    { name: 'nonce', type: 'uint256' },
-    { name: 'deadline', type: 'uint256' },
-];
-
-const DaiLikePermit = [
-    { name: 'holder', type: 'address' },
-    { name: 'spender', type: 'address' },
-    { name: 'nonce', type: 'uint256' },
-    { name: 'expiry', type: 'uint256' },
-    { name: 'allowed', type: 'bool' },
-];
-
-function trim0x (bigNumber) {
-    const s = bigNumber.toString();
-    if (s.startsWith('0x')) {
-        return s.substring(2);
-    }
-    return s;
-}
-
-function cutSelector (data) {
-    const hexPrefix = '0x';
-    return hexPrefix + data.substr(hexPrefix.length + 8);
-}
-
-function domainSeparator (name, version, chainId, verifyingContract) {
-    return '0x' + ethSigUtil.TypedDataUtils.hashStruct(
-        'EIP712Domain',
-        { name, version, chainId, verifyingContract },
-        { EIP712Domain },
-    ).toString('hex');
-}
-
-function buildData (name, version, chainId, verifyingContract, owner, spender, value, nonce, deadline = defaultDeadline) {
-    return {
-        primaryType: 'Permit',
-        types: { EIP712Domain, Permit },
-        domain: { name, version, chainId, verifyingContract },
-        message: { owner, spender, value, nonce, deadline },
-    };
-}
-
-function buildDataLikeDai (name, version, chainId, verifyingContract, holder, spender, nonce, allowed, expiry = defaultDeadline) {
-    return {
-        primaryType: 'Permit',
-        types: { EIP712Domain, Permit: DaiLikePermit },
-        domain: { name, version, chainId, verifyingContract },
-        message: { holder, spender, nonce, expiry, allowed },
-    };
-}
-
-async function getPermit (owner, ownerPrivateKey, token, tokenVersion, chainId, spender, value, deadline = defaultDeadline) {
-    const permitContract = await ERC20Permit.at(token.address);
-    const nonce = await permitContract.nonces(owner);
-    const name = await permitContract.name();
-    const data = buildData(name, tokenVersion, chainId, token.address, owner, spender, value, nonce, deadline);
-    const signature = ethSigUtil.signTypedMessage(Buffer.from(trim0x(ownerPrivateKey), 'hex'), { data });
-    const { v, r, s } = fromRpcSig(signature);
-    const permitCall = permitContract.contract.methods.permit(owner, spender, value, deadline, v, r, s).encodeABI();
-    return cutSelector(permitCall);
-}
-
-async function getPermitLikeDai (holder, holderPrivateKey, token, tokenVersion, chainId, spender, allowed, expiry = defaultDeadline) {
-    const permitContract = await ERC20PermitLikeDai.at(token.address);
-    const nonce = await permitContract.nonces(holder);
-    const name = await permitContract.name();
-    const data = buildDataLikeDai(name, tokenVersion, chainId, token.address, holder, spender, nonce, allowed, expiry);
-    const signature = ethSigUtil.signTypedMessage(Buffer.from(trim0x(holderPrivateKey), 'hex'), { data });
-    const { v, r, s } = fromRpcSig(signature);
-    const permitCall = permitContract.contract.methods.permit(holder, spender, nonce, expiry, allowed, v, r, s).encodeABI();
-    return cutSelector(permitCall);
-}
-
-function withTarget (target, data) {
-    return target.toString() + trim0x(data);
-}
-
-module.exports = {
-    defaultDeadline,
-    EIP712Domain,
-    Permit,
-    DaiLikePermit,
-    trim0x,
-    domainSeparator,
-    buildData,
-    buildDataLikeDai,
-    getPermit,
-    getPermitLikeDai,
-    withTarget,
-};

package/js/utils.js

@@ -1,68 +0,0 @@
-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/utils/contract.hbs

@@ -1,69 +0,0 @@
-# {{{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}}

package/utils/docify.utils.js

@@ -1,127 +0,0 @@
-#!/usr/bin/env node
-const SOLC_NPM_NAME = 'solc';
-const BASE_DIR = 'docgen';
-const SCRIPT_DIR = __dirname;
-const INPUT_DIR = 'contracts';
-const OUTPUT_DIR = `${BASE_DIR}/docs`;
-const HELPERS_PATH = `${SCRIPT_DIR}/solidity-docgen-helpers.js`;
-
-const fs = require('fs');
-const path = require('path');
-const spawn = require('cross-spawn');
-
-function getFileNameWithoutExtension (fileName) {
-    return fileName.substr(0, fileName.lastIndexOf('.'));
-}
-
-function runProcess (name, args) {
-    console.log(`running ${name} with args ${JSON.stringify(args)}`);
-    const result = spawn.sync(name, args, { stdio: ['inherit', 'inherit', 'pipe'] });
-    if (result.stderr.length > 0) {
-        throw new Error(result.stderr);
-    }
-}
-
-function getReadmes (targetPath) {
-    let result = [];
-    const readmePath = path.join(targetPath, 'README.md');
-    if (!fs.existsSync(readmePath)) {
-        const content = `# ${path.basename(targetPath)}\n`;
-        result.push({ path: readmePath, content });
-    }
-    const childDirs = fs.readdirSync(targetPath, { withFileTypes: true }).filter(item => item.isDirectory());
-    for (const dir of childDirs) {
-        result = result.concat(getReadmes(path.join(targetPath, dir.name)));
-    }
-    return result;
-}
-
-function generateReadmes (readmes) {
-    for (const readme of readmes) {
-        fs.writeFileSync(readme.path, readme.content);
-    }
-}
-
-function getSummary (targetPath) {
-    function getSummaryRoot (summaryTargetPath, indentation) {
-        function specialCaseRoot (item) {
-            if (item.indentation >= 0) {
-                return item;
-            }
-            return ({
-                name: 'Main Readme',
-                path: item.path,
-                indentation: 0,
-            });
-        }
-
-        const items = fs.readdirSync(summaryTargetPath, { withFileTypes: true });
-        let result = [specialCaseRoot({
-            name: path.basename(summaryTargetPath),
-            path: path.relative(targetPath, path.join(summaryTargetPath, 'README.md')).replaceAll('\\', '/'),
-            indentation: indentation - 1,
-        })];
-        for (const dir of items.filter(item => item.isDirectory())) {
-            result = result.concat(getSummaryRoot(path.join(summaryTargetPath, dir.name), indentation + 1));
-        }
-        result = result
-            .concat(items
-                .filter(item => !item.isDirectory() &&
-                    !item.name.endsWith('README.md') &&
-                    !item.name.endsWith('SUMMARY.md'))
-                .map(file => ({
-                    name: getFileNameWithoutExtension(file.name),
-                    path: path.relative(targetPath, path.join(summaryTargetPath, file.name)).replaceAll('\\', '/'),
-                    indentation,
-                })));
-        return result;
-    }
-
-    function generateContent (summaryTree) {
-        const lines = summaryTree.map(x => `${'\t'.repeat(x.indentation)}* [${x.name}](${x.path})`).join('\n');
-        return `# Table of contents\n\n${lines}`;
-    }
-
-    return generateContent(getSummaryRoot(targetPath, 0));
-}
-
-function generateSummary (targetPath, summary) {
-    fs.writeFileSync(path.join(targetPath, 'SUMMARY.md'), summary);
-}
-
-function generateGitbookFiles () {
-    fs.copyFileSync(path.join(BASE_DIR, 'README.md'), path.join(OUTPUT_DIR, 'README.md'));
-    const readmesToGenerate = getReadmes(OUTPUT_DIR);
-    const summary = getSummary(OUTPUT_DIR);
-
-    generateReadmes(readmesToGenerate);
-    generateSummary(OUTPUT_DIR, summary);
-}
-
-function removeUnwantedDocs () {
-    const unwantedDirs = ['mocks', 'tests'];
-    for (const unwantedDir of unwantedDirs) {
-        fs.rmSync(path.join(OUTPUT_DIR, unwantedDir), { force: true, recursive: true });
-    }
-}
-
-const solidityDocgenArgs = [
-    'solidity-docgen',
-    '-i',
-    INPUT_DIR,
-    '-o',
-    OUTPUT_DIR,
-    '--solc-module',
-    SOLC_NPM_NAME,
-    '--solc-settings',
-    JSON.stringify({ optimizer: { enabled: false } }),
-    '--templates',
-    SCRIPT_DIR,
-    '--helpers',
-    HELPERS_PATH,
-];
-
-fs.rmSync(OUTPUT_DIR, { force: true, recursive: true });
-runProcess('npx', solidityDocgenArgs);
-generateGitbookFiles();
-removeUnwantedDocs();

package/utils/solidity-docgen-helpers.js

@@ -1,24 +0,0 @@
-module.exports = {
-    removeNewlines (str) {
-        return str.replace(/\r?\n/g, ' ');
-    },
-    withoutFirstElement (arr) {
-        return arr.splice(1);
-    },
-    getRelativeDocPath (contractName, contractsDir, sources) {
-        function getRelativePath (contractPath) {
-            if (contractPath.startsWith(contractsDir)) {
-                return contractPath.substr(contractsDir.length + 1).replace('.sol', '.md');
-            }
-            if (contractPath.startsWith('@openzeppelin')) {
-                const regexMatch = contractPath.match(/@openzeppelin\/contracts\/(.+)\/([^/]+)\.sol/);
-                return `https://docs.openzeppelin.com/contracts/3.x/api/${regexMatch[1]}#${regexMatch[2]}`;
-            }
-            return null;
-        }
-
-        const sourcesKeys = Object.keys(sources);
-        const contractPath = sourcesKeys.find(x => x.includes(contractName));
-        return getRelativePath(contractPath);
-    },
-};