@1inch/solidity-utils 2.0.11-test5 → 2.0.12

package/contracts/EthReceiver.sol

@@ -4,8 +4,10 @@ pragma solidity ^0.8.0;
 pragma abicoder v1;
 
 abstract contract EthReceiver {
+    error EthDepositRejected();
+
     receive() external payable {
         // solhint-disable-next-line avoid-tx-origin
-        require(msg.sender != tx.origin, "ETH deposit rejected");
+        if (msg.sender == tx.origin) revert EthDepositRejected();
     }
 }

package/contracts/GasChecker.sol

@@ -3,17 +3,13 @@
 pragma solidity ^0.8.0;
 pragma abicoder v1;
 
-import "@openzeppelin/contracts/utils/Strings.sol";
-
 contract GasChecker {
-    using Strings for uint256;
+    error GasCostDiffers(uint256 expected, uint256 actual);
 
-    modifier checkGasCost(uint256 expectedGasCost) {
+    modifier checkGasCost(uint256 expected) {
         uint256 gas = gasleft();
         _;
-        gas -= gasleft();
-        if (expectedGasCost > 0) {
-            require (gas == expectedGasCost, string(abi.encodePacked("Gas cost differs: expected ", expectedGasCost.toString(), ", actual: ", gas.toString())));
-        }
+        unchecked { gas -= gasleft(); }
+        if (expected > 0 && gas != expected) revert GasCostDiffers(expected, gas);
     }
 }

package/contracts/OnlyWethReceiver.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+pragma abicoder v1;
+
+abstract contract OnlyWethReceiver {
+    error EthDepositRejected();
+
+    // solhint-disable-next-line var-name-mixedcase
+    address internal immutable _WETH;
+
+    constructor(address weth) {
+        _WETH = weth;
+    }
+
+    receive() external payable {
+        // solhint-disable-next-line avoid-tx-origin
+        if (msg.sender != _WETH) revert EthDepositRejected();
+    }
+}

package/contracts/Permitable.sol

@@ -8,7 +8,6 @@ import "./interfaces/IDaiLikePermit.sol";
 
 contract Permitable {
     error BadPermitLength();
-    error PermitFailed();
 
     function _permit(address token, bytes calldata permit) internal virtual {
         if (permit.length > 0) {
@@ -23,7 +22,13 @@ contract Permitable {
             } else {
                 revert BadPermitLength();
             }
-            if (!success) revert PermitFailed();
+            if (!success) {
+                // bubble up revert reason from permit call
+                assembly {  // solhint-disable-line no-inline-assembly
+                    returndatacopy(0, 0, returndatasize())
+                    revert(0, returndatasize())
+                }
+            }
         }
     }
 }

package/contracts/libraries/AddressArray.sol

@@ -35,33 +35,39 @@ library AddressArray {
         if (len > output.length) revert OutputArrayTooSmall();
         if (len > 0) {
             output[0] = address(uint160(lengthAndFirst));
-            for (uint i = 1; i < len; i++) {
-                output[i] = address(uint160(self._raw[i]));
+            unchecked {
+                for (uint i = 1; i < len; i++) {
+                    output[i] = address(uint160(self._raw[i]));
+                }
             }
         }
         return output;
     }
 
     function push(Data storage self, address account) internal returns(uint256) {
-        uint256 lengthAndFirst = self._raw[0];
-        uint256 len = lengthAndFirst >> 160;
-        if (len == 0) {
-            self._raw[0] = (1 << 160) + uint160(account);
-        }
-        else {
-            self._raw[0] = lengthAndFirst + (1 << 160);
-            self._raw[len] = uint160(account);
+        unchecked {
+            uint256 lengthAndFirst = self._raw[0];
+            uint256 len = lengthAndFirst >> 160;
+            if (len == 0) {
+                self._raw[0] = (1 << 160) + uint160(account);
+            }
+            else {
+                self._raw[0] = lengthAndFirst + (1 << 160);
+                self._raw[len] = uint160(account);
+            }
+            return len + 1;
         }
-        return len + 1;
     }
 
     function pop(Data storage self) internal {
-        uint256 lengthAndFirst = self._raw[0];
-        uint256 len = lengthAndFirst >> 160;
-        if (len == 0) revert PopFromEmptyArray();
-        self._raw[len - 1] = 0;
-        if (len > 1) {
-            self._raw[0] = lengthAndFirst - (1 << 160);
+        unchecked {
+            uint256 lengthAndFirst = self._raw[0];
+            uint256 len = lengthAndFirst >> 160;
+            if (len == 0) revert PopFromEmptyArray();
+            self._raw[len - 1] = 0;
+            if (len > 1) {
+                self._raw[0] = lengthAndFirst - (1 << 160);
+            }
         }
     }
 

package/contracts/libraries/AddressSet.sol

@@ -39,9 +39,11 @@ library AddressSet {
             return false;
         }
         if (index < s.items.length()) {
-            address lastItem = s.items.at(s.items.length() - 1);
-            s.items.set(index - 1, lastItem);
-            s.lookup[lastItem] = index;
+            unchecked {
+                address lastItem = s.items.at(s.items.length() - 1);
+                s.items.set(index - 1, lastItem);
+                s.lookup[lastItem] = index;
+            }
         }
         s.items.pop();
         delete s.lookup[item];

package/contracts/libraries/RevertReasonParser.sol

@@ -16,6 +16,8 @@ library RevertReasonParser {
     using StringUtil for uint256;
     using StringUtil for bytes;
 
+    error InvalidRevertReason();
+
     bytes4 constant private _ERROR_SELECTOR = bytes4(keccak256("Error(string)"));
     bytes4 constant private _PANIC_SELECTOR = bytes4(keccak256("Panic(uint256)"));
 
@@ -42,8 +44,8 @@ library RevertReasonParser {
                 because of that we can't check for equality and instead check
                 that string length + extra 68 bytes is less than overall data length
             */
-            require(data.length >= 68 + bytes(reason).length, "Invalid revert reason");
-            return string(abi.encodePacked(prefix, "Error(", reason, ")"));
+            if (data.length < 68 + bytes(reason).length) revert InvalidRevertReason();
+            return string.concat(prefix, "Error(", reason, ")");
         }
         // 36 = 4-byte selector + 32 bytes integer
         else if (selector == _PANIC_SELECTOR && data.length == 36) {
@@ -53,8 +55,8 @@ library RevertReasonParser {
                 // 36 = 32 bytes data length + 4-byte selector
                 code := mload(add(data, 36))
             }
-            return string(abi.encodePacked(prefix, "Panic(", code.toHex(), ")"));
+            return string.concat(prefix, "Panic(", code.toHex(), ")");
         }
-        return string(abi.encodePacked(prefix, "Unknown(", data.toHex(), ")"));
+        return string.concat(prefix, "Unknown(", data.toHex(), ")");
     }
 }

package/contracts/libraries/UniERC20.sol

@@ -13,6 +13,10 @@ library UniERC20 {
     using SafeMath for uint256;
     using SafeERC20 for IERC20;
 
+    error NotEnoughValue();
+    error FromIsNotSender();
+    error ToIsNotThis();
+
     IERC20 private constant _ETH_ADDRESS = IERC20(0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE);
     IERC20 private constant _ZERO_ADDRESS = IERC20(address(0));
 
@@ -41,9 +45,9 @@ library UniERC20 {
     function uniTransferFrom(IERC20 token, address payable from, address to, uint256 amount) internal {
         if (amount > 0) {
             if (isETH(token)) {
-                require(msg.value >= amount, "UniERC20: not enough value");
-                require(from == msg.sender, "from is not msg.sender");
-                require(to == address(this), "to is not this");
+                if (msg.value < amount) revert NotEnoughValue();
+                if (from != msg.sender) revert FromIsNotSender();
+                if (to != address(this)) revert ToIsNotThis();
                 if (msg.value > amount) {
                     // Return remainder if exist
                     from.transfer(msg.value.sub(amount));
@@ -91,7 +95,7 @@ library UniERC20 {
         if (success && data.length >= 96) {
             (uint256 offset, uint256 len) = abi.decode(data, (uint256, uint256));
             if (offset == 0x20 && len > 0 && len <= 256) {
-                return string(abi.decode(data, (bytes)));
+                return abi.decode(data, (string));
             }
         }
 
@@ -103,8 +107,10 @@ library UniERC20 {
 
             if (len > 0) {
                 bytes memory result = new bytes(len);
-                for (uint i = 0; i < len; i++) {
-                    result[i] = data[i];
+                unchecked {
+                    for (uint i = 0; i < len; i++) {
+                        result[i] = data[i];
+                    }
                 }
                 return string(result);
             }

package/dist/src/asserts.d.ts

@@ -0,0 +1,3 @@
+import BN from 'bn.js';
+export declare function toBNExtended(value: string | number | BN): BN;
+export declare function assertRoughlyEqualValues(expected: string | number | BN, actual: string | number | BN, relativeDiff: number): void;

package/dist/src/asserts.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertRoughlyEqualValues = exports.toBNExtended = void 0;
+const prelude_1 = require("./prelude");
+function toBNExtended(value) {
+    if (typeof value === 'string' || typeof value === 'number') {
+        return (0, prelude_1.toBN)(value);
+    }
+    return value;
+}
+exports.toBNExtended = toBNExtended;
+function assertRoughlyEqualValues(expected, actual, relativeDiff) {
+    let expectedBN = toBNExtended(expected);
+    let actualBN = toBNExtended(actual);
+    if (expectedBN.isNeg() !== actualBN.isNeg()) {
+        (0, prelude_1.expect)(actualBN).to.be.bignumber.equal(expectedBN, 'Values are of different sign');
+    }
+    expectedBN = expectedBN.abs();
+    actualBN = actualBN.abs();
+    let multiplerNumerator = relativeDiff;
+    let multiplerDenominator = (0, prelude_1.toBN)('1');
+    while (!Number.isInteger(multiplerNumerator)) {
+        multiplerDenominator = multiplerDenominator.mul((0, prelude_1.toBN)('10'));
+        multiplerNumerator *= 10;
+    }
+    const diff = expectedBN.sub(actualBN).abs();
+    const treshold = expectedBN.mul((0, prelude_1.toBN)(multiplerNumerator.toString())).div(multiplerDenominator);
+    if (!diff.lte(treshold)) {
+        (0, prelude_1.expect)(actualBN).to.be.bignumber.equal(expectedBN, `${actual} != ${expected} with ${relativeDiff} precision`);
+    }
+}
+exports.assertRoughlyEqualValues = assertRoughlyEqualValues;
+//# sourceMappingURL=asserts.js.map

package/dist/src/asserts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asserts.js","sourceRoot":"","sources":["../../src/asserts.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AAGzC,SAAgB,YAAY,CAAE,KAA2B;IACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACxD,OAAO,IAAA,cAAI,EAAC,KAAK,CAAC,CAAC;KACtB;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AALD,oCAKC;AAED,SAAgB,wBAAwB,CAAE,QAA8B,EAAE,MAA4B,EAAE,YAAoB;IACxH,IAAI,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxC,IAAI,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,UAAU,CAAC,KAAK,EAAE,KAAK,QAAQ,CAAC,KAAK,EAAE,EAAE;QACzC,IAAA,gBAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,8BAA8B,CAAC,CAAC;KACtF;IAED,UAAU,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC;IAC9B,QAAQ,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;IAE1B,IAAI,kBAAkB,GAAG,YAAY,CAAC;IACtC,IAAI,oBAAoB,GAAG,IAAA,cAAI,EAAC,GAAG,CAAC,CAAC;IACrC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE;QAC1C,oBAAoB,GAAG,oBAAoB,CAAC,GAAG,CAAC,IAAA,cAAI,EAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,kBAAkB,IAAI,EAAE,CAAC;KAC5B;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC;IAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,IAAA,cAAI,EAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC/F,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;QACrB,IAAA,gBAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,MAAM,OAAO,QAAQ,SAAS,YAAY,YAAY,CAAC,CAAC;KACjH;AACL,CAAC;AArBD,4DAqBC"}

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+export * from './asserts';
+export * from './permit';
+export * from './prelude';
+export * from './profileEVM';
+export * from './utils';

package/dist/src/index.js

@@ -2,9 +2,9 @@
 // created from 'create-ts-index'
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./asserts"), exports);
-(0, tslib_1.__exportStar)(require("./permit"), exports);
-(0, tslib_1.__exportStar)(require("./prelude"), exports);
-(0, tslib_1.__exportStar)(require("./profileEVM"), exports);
-(0, tslib_1.__exportStar)(require("./utils"), exports);
+tslib_1.__exportStar(require("./asserts"), exports);
+tslib_1.__exportStar(require("./permit"), exports);
+tslib_1.__exportStar(require("./prelude"), exports);
+tslib_1.__exportStar(require("./profileEVM"), exports);
+tslib_1.__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;AAEjC,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,uDAA6B;AAC7B,kDAAwB"}

package/dist/src/permit.d.ts

@@ -0,0 +1,79 @@
+import { MessageTypes, SignTypedDataVersion, TypedMessage } from '@metamask/eth-sig-util';
+import { Token } from './utils';
+export declare const TypedDataVersion = SignTypedDataVersion.V4;
+export declare const defaultDeadline: string;
+export declare const EIP712Domain: {
+    name: string;
+    type: string;
+}[];
+export declare const Permit: {
+    name: string;
+    type: string;
+}[];
+export declare const DaiLikePermit: {
+    name: string;
+    type: string;
+}[];
+export declare function trim0x(bigNumber: BN | string): string;
+export declare function cutSelector(data: string): string;
+export declare function domainSeparator(name: string, version: string, chainId: string, verifyingContract: string): string;
+export declare function buildData(name: string, version: string, chainId: number, verifyingContract: string, owner: string, spender: string, value: string, nonce: string, deadline?: string): {
+    readonly primaryType: "Permit";
+    readonly types: {
+        readonly EIP712Domain: {
+            name: string;
+            type: string;
+        }[];
+        readonly Permit: {
+            name: string;
+            type: string;
+        }[];
+    };
+    readonly domain: {
+        readonly name: string;
+        readonly version: string;
+        readonly chainId: number;
+        readonly verifyingContract: string;
+    };
+    readonly message: {
+        readonly owner: string;
+        readonly spender: string;
+        readonly value: string;
+        readonly nonce: string;
+        readonly deadline: string;
+    };
+};
+export declare function buildDataLikeDai(name: string, version: string, chainId: number, verifyingContract: string, holder: string, spender: string, nonce: string, allowed: boolean, expiry?: string): {
+    readonly primaryType: "Permit";
+    readonly types: {
+        readonly EIP712Domain: {
+            name: string;
+            type: string;
+        }[];
+        readonly Permit: {
+            name: string;
+            type: string;
+        }[];
+    };
+    readonly domain: {
+        readonly name: string;
+        readonly version: string;
+        readonly chainId: number;
+        readonly verifyingContract: string;
+    };
+    readonly message: {
+        readonly holder: string;
+        readonly spender: string;
+        readonly nonce: string;
+        readonly expiry: string;
+        readonly allowed: boolean;
+    };
+};
+export interface PermittableToken extends Token {
+    nonces(owner: string, txDetails?: Truffle.TransactionDetails): Promise<BN>;
+    name(txDetails?: Truffle.TransactionDetails): Promise<string>;
+}
+export declare function signWithPk<T extends MessageTypes>(privateKey: string, data: TypedMessage<T>): string;
+export declare function getPermit(owner: string, ownerPrivateKey: string, permitContract: PermittableToken, tokenVersion: string, chainId: number, spender: string, value: string, deadline?: string): Promise<string>;
+export declare function getPermitLikeDai(holder: string, holderPrivateKey: string, permitContract: PermittableToken, tokenVersion: string, chainId: number, spender: string, allowed: boolean, expiry?: string): Promise<string>;
+export declare function withTarget(target: BN | string, data: BN | string): string;

package/dist/src/permit.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withTarget = exports.getPermitLikeDai = exports.getPermit = exports.signWithPk = exports.buildDataLikeDai = exports.buildData = exports.domainSeparator = exports.cutSelector = exports.trim0x = exports.DaiLikePermit = exports.Permit = exports.EIP712Domain = exports.defaultDeadline = exports.TypedDataVersion = void 0;
+const eth_sig_util_1 = require("@metamask/eth-sig-util");
+const ethereumjs_util_1 = require("ethereumjs-util");
+const prelude_1 = require("./prelude");
+exports.TypedDataVersion = eth_sig_util_1.SignTypedDataVersion.V4;
+exports.defaultDeadline = prelude_1.constants.MAX_UINT256;
+exports.EIP712Domain = [
+    { name: 'name', type: 'string' },
+    { name: 'version', type: 'string' },
+    { name: 'chainId', type: 'uint256' },
+    { name: 'verifyingContract', type: 'address' },
+];
+exports.Permit = [
+    { name: 'owner', type: 'address' },
+    { name: 'spender', type: 'address' },
+    { name: 'value', type: 'uint256' },
+    { name: 'nonce', type: 'uint256' },
+    { name: 'deadline', type: 'uint256' },
+];
+exports.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;
+}
+exports.trim0x = trim0x;
+function cutSelector(data) {
+    const hexPrefix = '0x';
+    return hexPrefix + data.substr(hexPrefix.length + 8);
+}
+exports.cutSelector = cutSelector;
+function domainSeparator(name, version, chainId, verifyingContract) {
+    return '0x' + eth_sig_util_1.TypedDataUtils.hashStruct('EIP712Domain', { name, version, chainId, verifyingContract }, { EIP712Domain: exports.EIP712Domain }, exports.TypedDataVersion).toString('hex');
+}
+exports.domainSeparator = domainSeparator;
+function buildData(name, version, chainId, verifyingContract, owner, spender, value, nonce, deadline = exports.defaultDeadline) {
+    return {
+        primaryType: 'Permit',
+        types: { EIP712Domain: exports.EIP712Domain, Permit: exports.Permit },
+        domain: { name, version, chainId, verifyingContract },
+        message: { owner, spender, value, nonce, deadline },
+    };
+}
+exports.buildData = buildData;
+function buildDataLikeDai(name, version, chainId, verifyingContract, holder, spender, nonce, allowed, expiry = exports.defaultDeadline) {
+    return {
+        primaryType: 'Permit',
+        types: { EIP712Domain: exports.EIP712Domain, Permit: exports.DaiLikePermit },
+        domain: { name, version, chainId, verifyingContract },
+        message: { holder, spender, nonce, expiry, allowed },
+    };
+}
+exports.buildDataLikeDai = buildDataLikeDai;
+function signWithPk(privateKey, data) {
+    return (0, eth_sig_util_1.signTypedData)({ privateKey: Buffer.from(trim0x(privateKey), 'hex'), data, version: exports.TypedDataVersion });
+}
+exports.signWithPk = signWithPk;
+/*
+ * @param permitContract The contract object with ERC20Permit type and token address for which the permit creating.
+ */
+async function getPermit(owner, ownerPrivateKey, permitContract, tokenVersion, chainId, spender, value, deadline = exports.defaultDeadline) {
+    const nonce = await permitContract.nonces(owner);
+    const name = await permitContract.name();
+    const data = buildData(name, tokenVersion, chainId, permitContract.address, owner, spender, value, nonce.toString(), deadline);
+    const signature = signWithPk(ownerPrivateKey, data);
+    const { v, r, s } = (0, ethereumjs_util_1.fromRpcSig)(signature);
+    const permitCall = permitContract.contract.methods.permit(owner, spender, value, deadline, v, r, s).encodeABI();
+    return cutSelector(permitCall);
+}
+exports.getPermit = getPermit;
+/*
+ * @param permitContract The contract object with ERC20PermitLikeDai type and token address for which the permit creating.
+ */
+async function getPermitLikeDai(holder, holderPrivateKey, permitContract, tokenVersion, chainId, spender, allowed, expiry = exports.defaultDeadline) {
+    const nonce = await permitContract.nonces(holder);
+    const name = await permitContract.name();
+    const data = buildDataLikeDai(name, tokenVersion, chainId, permitContract.address, holder, spender, nonce.toString(), allowed, expiry);
+    const signature = signWithPk(holderPrivateKey, data);
+    const { v, r, s } = (0, ethereumjs_util_1.fromRpcSig)(signature);
+    const permitCall = permitContract.contract.methods.permit(holder, spender, nonce, expiry, allowed, v, r, s).encodeABI();
+    return cutSelector(permitCall);
+}
+exports.getPermitLikeDai = getPermitLikeDai;
+function withTarget(target, data) {
+    return target.toString() + trim0x(data);
+}
+exports.withTarget = withTarget;
+//# sourceMappingURL=permit.js.map

package/dist/src/permit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permit.js","sourceRoot":"","sources":["../../src/permit.ts"],"names":[],"mappings":";;;AAAA,yDAAyH;AACzH,qDAA6C;AAE7C,uCAAsC;AAGzB,QAAA,gBAAgB,GAAG,mCAAoB,CAAC,EAAE,CAAC;AAC3C,QAAA,eAAe,GAAG,mBAAS,CAAC,WAAW,CAAC;AAExC,QAAA,YAAY,GAAG;IACxB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE;IAChC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;IACnC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;CACjD,CAAC;AAEW,QAAA,MAAM,GAAG;IAClB,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IAClC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IAClC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IAClC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;CACxC,CAAC;AAEW,QAAA,aAAa,GAAG;IACzB,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;IACnC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;IACpC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;IAClC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;IACnC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE;CACpC,CAAC;AAEF,SAAgB,MAAM,CAAE,SAAsB;IAC1C,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;IAC/B,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACpB,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;KACzB;IACD,OAAO,CAAC,CAAC;AACb,CAAC;AAND,wBAMC;AAED,SAAgB,WAAW,CAAE,IAAY;IACrC,MAAM,SAAS,GAAG,IAAI,CAAC;IACvB,OAAO,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACzD,CAAC;AAHD,kCAGC;AAED,SAAgB,eAAe,CAAE,IAAY,EAAE,OAAe,EAAE,OAAe,EAAE,iBAAyB;IACtG,OAAO,IAAI,GAAG,6BAAc,CAAC,UAAU,CACnC,cAAc,EACd,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,EAC7C,EAAE,YAAY,EAAZ,oBAAY,EAAE,EAChB,wBAAgB,CACnB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC;AAPD,0CAOC;AAED,SAAgB,SAAS,CACrB,IAAY,EACZ,OAAe,EACf,OAAe,EACf,iBAAyB,EACzB,KAAa,EACb,OAAe,EACf,KAAa,EACb,KAAa,EACb,WAAmB,uBAAe;IAElC,OAAO;QACH,WAAW,EAAE,QAAQ;QACrB,KAAK,EAAE,EAAE,YAAY,EAAZ,oBAAY,EAAE,MAAM,EAAN,cAAM,EAAE;QAC/B,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE;QACrD,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE;KAC7C,CAAC;AACf,CAAC;AAjBD,8BAiBC;AAED,SAAgB,gBAAgB,CAC5B,IAAY,EACZ,OAAe,EACf,OAAe,EACf,iBAAyB,EACzB,MAAc,EACd,OAAe,EACf,KAAa,EACb,OAAgB,EAChB,SAAiB,uBAAe;IAEhC,OAAO;QACH,WAAW,EAAE,QAAQ;QACrB,KAAK,EAAE,EAAE,YAAY,EAAZ,oBAAY,EAAE,MAAM,EAAE,qBAAa,EAAE;QAC9C,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE;QACrD,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;KAC9C,CAAC;AACf,CAAC;AAjBD,4CAiBC;AAOD,SAAgB,UAAU,CAA0B,UAAkB,EAAE,IAAqB;IACzF,OAAO,IAAA,4BAAa,EAAC,EAAE,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,wBAAgB,EAAE,CAAC,CAAC;AAClH,CAAC;AAFD,gCAEC;AAED;;GAEG;AACI,KAAK,UAAU,SAAS,CAC3B,KAAa,EACb,eAAuB,EACvB,cAAgC,EAChC,YAAoB,EACpB,OAAe,EACf,OAAe,EACf,KAAa,EACb,QAAQ,GAAG,uBAAe;IAE1B,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC/H,MAAM,SAAS,GAAG,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACpD,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,IAAA,4BAAU,EAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IAChH,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACnC,CAAC;AAjBD,8BAiBC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAClC,MAAc,EACd,gBAAwB,EACxB,cAAgC,EAChC,YAAoB,EACpB,OAAe,EACf,OAAe,EACf,OAAgB,EAChB,MAAM,GAAG,uBAAe;IAExB,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACvI,MAAM,SAAS,GAAG,UAAU,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;IACrD,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,IAAA,4BAAU,EAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IACxH,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACnC,CAAC;AAjBD,4CAiBC;AAED,SAAgB,UAAU,CAAE,MAAmB,EAAE,IAAiB;IAC9D,OAAO,MAAM,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAFD,gCAEC"}

package/dist/src/prelude.d.ts

@@ -0,0 +1,20 @@
+import { Assertion, AssertionError, assert, expect, config, should } from 'chai';
+import 'chai-bn';
+import { toBN } from 'web3-utils';
+import BN from 'bn.js';
+export declare const constants: {
+    readonly ZERO_ADDRESS: "0x0000000000000000000000000000000000000000";
+    readonly EEE_ADDRESS: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
+    readonly ZERO_BYTES32: "0x0000000000000000000000000000000000000000000000000000000000000000";
+    readonly MAX_UINT256: string;
+    readonly MAX_INT256: string;
+    readonly MIN_INT256: string;
+};
+export { toBN, };
+export declare type Time = {
+    increaseTo: (target: string | number | BN) => Promise<BN>;
+    latest: () => Promise<BN>;
+};
+export declare const time: Time;
+export declare function ether(n: string): BN;
+export { Assertion, AssertionError, assert, expect, config, should, };

package/dist/src/prelude.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.should = exports.config = exports.expect = exports.assert = exports.AssertionError = exports.Assertion = exports.ether = exports.time = exports.toBN = exports.constants = void 0;
+const tslib_1 = require("tslib");
+const chai_1 = tslib_1.__importStar(require("chai"));
+Object.defineProperty(exports, "Assertion", { enumerable: true, get: function () { return chai_1.Assertion; } });
+Object.defineProperty(exports, "AssertionError", { enumerable: true, get: function () { return chai_1.AssertionError; } });
+Object.defineProperty(exports, "assert", { enumerable: true, get: function () { return chai_1.assert; } });
+Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return chai_1.expect; } });
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return chai_1.config; } });
+Object.defineProperty(exports, "should", { enumerable: true, get: function () { return chai_1.should; } });
+require("chai-bn");
+const chai_as_promised_1 = tslib_1.__importDefault(require("chai-as-promised"));
+const web3_utils_1 = require("web3-utils");
+Object.defineProperty(exports, "toBN", { enumerable: true, get: function () { return web3_utils_1.toBN; } });
+chai_1.default.use(chai_as_promised_1.default);
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { time: timeImpl } = require('@openzeppelin/test-helpers');
+exports.constants = {
+    ZERO_ADDRESS: '0x0000000000000000000000000000000000000000',
+    EEE_ADDRESS: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE',
+    ZERO_BYTES32: '0x0000000000000000000000000000000000000000000000000000000000000000',
+    MAX_UINT256: (0, web3_utils_1.toBN)('2').pow((0, web3_utils_1.toBN)('256')).sub((0, web3_utils_1.toBN)('1')).toString(),
+    MAX_INT256: (0, web3_utils_1.toBN)('2').pow((0, web3_utils_1.toBN)('255')).sub((0, web3_utils_1.toBN)('1')).toString(),
+    MIN_INT256: (0, web3_utils_1.toBN)('2').pow((0, web3_utils_1.toBN)('255')).mul((0, web3_utils_1.toBN)('-1')).toString(),
+};
+exports.time = timeImpl;
+function ether(n) {
+    return (0, web3_utils_1.toBN)((0, web3_utils_1.toWei)(n, 'ether'));
+}
+exports.ether = ether;
+//# sourceMappingURL=prelude.js.map

package/dist/src/prelude.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prelude.js","sourceRoot":"","sources":["../../src/prelude.ts"],"names":[],"mappings":";;;;AAAA,qDAAuF;AAqCnF,0FArCW,gBAAS,OAqCX;AACT,+FAtCsB,qBAAc,OAsCtB;AACd,uFAvCsC,aAAM,OAuCtC;AACN,uFAxC8C,aAAM,OAwC9C;AACN,uFAzCsD,aAAM,OAyCtD;AACN,uFA1C8D,aAAM,OA0C9D;AAzCV,mBAAiB;AACjB,gFAA8C;AAC9C,2CAAyC;AAiBrC,qFAjBK,iBAAI,OAiBL;AAfR,cAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AACzB,8DAA8D;AAC9D,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAEpD,QAAA,SAAS,GAAG;IACrB,YAAY,EAAE,4CAA4C;IAC1D,WAAW,EAAE,4CAA4C;IACzD,YAAY,EAAE,oEAAoE;IAClF,WAAW,EAAE,IAAA,iBAAI,EAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAA,iBAAI,EAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAA,iBAAI,EAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;IACjE,UAAU,EAAE,IAAA,iBAAI,EAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAA,iBAAI,EAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAA,iBAAI,EAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;IAChE,UAAU,EAAE,IAAA,iBAAI,EAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAA,iBAAI,EAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAA,iBAAI,EAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC3D,CAAC;AAaE,QAAA,IAAI,GAAS,QAAQ,CAAC;AAEnC,SAAgB,KAAK,CAAE,CAAS;IAC5B,OAAO,IAAA,iBAAI,EAAC,IAAA,kBAAK,EAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AACnC,CAAC;AAFD,sBAEC"}

package/dist/src/profileEVM.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import { PathLike, promises as fs } from 'fs';
+export declare const gasspectOptionsDefault: {
+    minOpGasCost: number;
+    args: boolean;
+    res: boolean;
+};
+export declare function profileEVM(txHash: string, instruction: string[], optionalTraceFile?: PathLike | fs.FileHandle): Promise<number[]>;
+export declare function gasspectEVM(txHash: string, gasspectOptions?: Record<string, unknown>, optionalTraceFile?: PathLike | fs.FileHandle): Promise<string[]>;

package/dist/src/profileEVM.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gasspectEVM = exports.profileEVM = exports.gasspectOptionsDefault = void 0;
+const util_1 = require("util");
+const fs_1 = require("fs");
+const prelude_1 = require("./prelude");
+exports.gasspectOptionsDefault = {
+    minOpGasCost: 300,
+    args: false,
+    res: false, // return operations results
+};
+function _normalizeOp(ops, i) {
+    if (ops[i].op === 'STATICCALL') {
+        ops[i].gasCost = ops[i].gasCost - ops[i + 1].gas;
+        if (ops[i].stack.length > 8 && ops[i].stack[ops[i].stack.length - 8] === '0000000000000000000000000000000000000000000000000000000000000001') {
+            ops[i].op = 'STATICCALL-ECRECOVER';
+        }
+        else if (ops[i].stack.length > 8 && ops[i].stack[ops[i].stack.length - 8] <= '00000000000000000000000000000000000000000000000000000000000000FF') {
+            ops[i].op = 'STATICCALL-' + ops[i].stack[ops[i].stack.length - 8].substr(62, 2);
+        }
+        else {
+            ops[i].args = [
+                '0x' + ops[i].stack[ops[i].stack.length - 2].substr(24),
+                '0x' + (ops[i].memory || []).join('').substr(2 * (0, prelude_1.toBN)(ops[i].stack[ops[i].stack.length - 3]).toNumber(), 2 * (0, prelude_1.toBN)(ops[i].stack[ops[i].stack.length - 4]).toNumber()),
+            ];
+            if (ops[i].gasCost === 100) {
+                ops[i].op += '_R';
+            }
+        }
+    }
+    if (['CALL', 'DELEGATECALL', 'CALLCODE'].indexOf(ops[i].op) !== -1) {
+        ops[i].args = [
+            '0x' + ops[i].stack[ops[i].stack.length - 2].substr(24),
+            '0x' + (ops[i].memory || []).join('').substr(2 * (0, prelude_1.toBN)(ops[i].stack[ops[i].stack.length - 4]).toNumber(), 2 * (0, prelude_1.toBN)(ops[i].stack[ops[i].stack.length - 5]).toNumber()),
+        ];
+        ops[i].gasCost = ops[i].gasCost - ops[i + 1].gas;
+        ops[i].res = ops[i + 1].stack[ops[i + 1].stack.length - 1];
+        if (ops[i].gasCost === 100) {
+            ops[i].op += '_R';
+        }
+    }
+    if (['RETURN', 'REVERT', 'INVALID'].indexOf(ops[i].op) !== -1) {
+        ops[i].gasCost = 3;
+    }
+    if (['SSTORE', 'SLOAD'].indexOf(ops[i].op) !== -1) {
+        ops[i].args = [
+            '0x' + ops[i].stack[ops[i].stack.length - 1],
+        ];
+        if (ops[i].op === 'SSTORE') {
+            ops[i].args.push('0x' + ops[i].stack[ops[i].stack.length - 2]);
+        }
+        if (ops[i].gasCost === 100) {
+            ops[i].op += '_R';
+        }
+        if (ops[i].gasCost === 20000) {
+            ops[i].op += '_I';
+        }
+        if (ops[i].op.startsWith('SLOAD')) {
+            ops[i].res = ops[i + 1].stack[ops[i + 1].stack.length - 1];
+        }
+    }
+    if (ops[i].op === 'EXTCODESIZE') {
+        ops[i].args = [
+            '0x' + ops[i].stack[ops[i].stack.length - 1].substr(24),
+        ];
+        ops[i].res = ops[i + 1].stack[ops[i + 1].stack.length - 1];
+    }
+}
+async function profileEVM(txHash, instruction, optionalTraceFile) {
+    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);
+    if (optionalTraceFile) {
+        await fs_1.promises.writeFile(optionalTraceFile, str);
+    }
+    return instruction.map(instr => {
+        return str.split('"' + instr.toUpperCase() + '"').length - 1;
+    });
+}
+exports.profileEVM = profileEVM;
+async function gasspectEVM(txHash, gasspectOptions = {}, optionalTraceFile) {
+    const options = { ...exports.gasspectOptionsDefault, ...gasspectOptions };
+    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 ops = trace === null || trace === void 0 ? void 0 : trace.result.structLogs;
+    const traceAddress = [0, -1];
+    for (const [i, op] of ops.entries()) {
+        op.traceAddress = traceAddress.slice(0, traceAddress.length - 1);
+        _normalizeOp(ops, i);
+        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 > options.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_1.promises.writeFile(optionalTraceFile, JSON.stringify(result));
+    }
+    return result;
+}
+exports.gasspectEVM = gasspectEVM;
+//# sourceMappingURL=profileEVM.js.map

package/dist/src/profileEVM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profileEVM.js","sourceRoot":"","sources":["../../src/profileEVM.ts"],"names":[],"mappings":";;;AAAA,+BAAiC;AACjC,2BAA8C;AAC9C,uCAAiC;AAEpB,QAAA,sBAAsB,GAAG;IAClC,YAAY,EAAE,GAAG;IACjB,IAAI,EAAE,KAAK;IACX,GAAG,EAAE,KAAK,EAAE,4BAA4B;CAC3C,CAAC;AAcF,SAAS,YAAY,CAAE,GAAS,EAAE,CAAS;IACvC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,YAAY,EAAE;QAC5B,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAEjD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,kEAAkE,EAAE;YACzI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,sBAAsB,CAAC;SACtC;aAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,kEAAkE,EAAE;YAC/I,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SACnF;aAAM;YACH,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;gBACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvD,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CACxC,CAAC,GAAG,IAAA,cAAI,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAC1D,CAAC,GAAG,IAAA,cAAI,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAC7D;aACJ,CAAC;YACF,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE;gBACxB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;aACrB;SACJ;KACJ;IACD,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE;QAChE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;YACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CACxC,CAAC,GAAG,IAAA,cAAI,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,EAC1D,CAAC,GAAG,IAAA,cAAI,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAC7D;SACJ,CAAC;QACF,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACjD,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE3D,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE;YACxB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;SACrB;KACJ;IACD,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE;QAC3D,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;KACtB;IACD,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE;QAC/C,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;YACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;SAC/C,CAAC;QACF,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,EAAE;YACxB,GAAG,CAAC,CAAC,CAAC,CAAC,IAAK,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;SACnE;QACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE;YACxB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;SACrB;QACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,EAAE;YAC1B,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC;SACrB;QAED,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC/B,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SAC9D;KACJ;IACD,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,EAAE;QAC7B,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG;YACV,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;SAC1D,CAAC;QACF,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KAC9D;AACL,CAAC;AAEM,KAAK,UAAU,UAAU,CAAE,MAAc,EAAE,WAAqB,EAAE,iBAA4C;IACjH,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;IAED,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,IAAI,iBAAiB,EAAE;QACnB,MAAM,aAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;KAC9C;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC3B,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;AArBD,gCAqBC;AAEM,KAAK,UAAU,WAAW,CAAE,MAAc,EAAE,kBAA2C,EAAE,EAAE,iBAA4C;IAC1I,MAAM,OAAO,GAAG,EAAE,GAAG,8BAAsB,EAAE,GAAG,eAAe,EAAE,CAAC;IAElE,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;IAED,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,GAAS,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,CAAC,UAAU,CAAC;IAE3C,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7B,KAAK,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE;QACjC,EAAE,CAAC,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACjE,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAErB,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE;YACpC,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;YAC3C,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACzB;QAED,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE;YACpC,YAAY,CAAC,GAAG,EAAE,CAAC;SACtB;KACJ;IAED,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,EAAE;QAChG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;IAExC,IAAI,iBAAiB,EAAE;QACnB,MAAM,aAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;KACjE;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAzCD,kCAyCC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="bn.js" />
+import { constants } from './prelude';
+export declare function timeIncreaseTo(seconds: number | string | BN): Promise<void>;
+export interface Token extends Truffle.ContractInstance {
+    balanceOf(account: string, txDetails?: Truffle.TransactionDetails): Promise<BN>;
+}
+export declare function trackReceivedTokenAndTx<T extends unknown[], U extends Truffle.AnyEvent>(token: Token | {
+    address: typeof constants.ZERO_ADDRESS;
+} | {
+    address: typeof constants.EEE_ADDRESS;
+}, wallet: string, txPromise: (...args: T) => Promise<Truffle.TransactionResponse<U>>, ...args: T): Promise<readonly [import("bn.js"), Truffle.TransactionResponse<U>]>;
+export declare function fixSignature(signature: string): string;
+export declare function signMessage(signer: string, messageHex?: string): Promise<string>;
+export declare function countInstructions(txHash: string, instructions: string[]): Promise<number[]>;

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;IAEV,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;AAjBD,0DAiBC;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,6 +1,6 @@
 {
   "name": "@1inch/solidity-utils",
-  "version": "2.0.11-test5",
+  "version": "2.0.12",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -20,7 +20,8 @@
     "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",
+    "test": "hardhat test --parallel",
+    "test:ci": "hardhat test",
     "typecheck": "tsc --noEmit --skipLibCheck",
     "typechain": "hardhat typechain"
   },
@@ -33,41 +34,38 @@
     "chai-as-promised": "7.1.1",
     "chai-bn": "0.3.1",
     "ethereumjs-util": "7.1.4",
-    "web3-utils": "1.7.0"
+    "web3-utils": "1.7.1"
   },
   "devDependencies": {
-    "@nomiclabs/hardhat-etherscan": "3.0.1",
-    "@nomiclabs/hardhat-truffle5": "2.0.4",
+    "@nomiclabs/hardhat-truffle5": "2.0.5",
     "@nomiclabs/hardhat-web3": "2.0.0",
-    "@typechain/hardhat": "4.0.0",
+    "@typechain/hardhat": "6.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",
+    "@types/node": "17.0.23",
+    "@typescript-eslint/eslint-plugin": "5.18.0",
+    "@typescript-eslint/parser": "5.18.0",
     "create-ts-index": "^1.14.0",
     "cross-spawn": "7.0.3",
     "dotenv": "16.0.0",
-    "eslint": "8.9.0",
+    "eslint": "8.12.0",
     "eslint-config-standard": "16.0.3",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "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": "2.8.4",
-    "hardhat-deploy": "0.10.5",
+    "hardhat": "2.9.3",
     "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",
+    "ts-node": "10.7.0",
     "typechain": "7.0.0",
-    "typescript": "4.5.5"
+    "typescript": "4.6.3"
   },
   "bin": {
     "solidity-utils-docify": "utils/docify.utils.js"

package/utils/contract.hbs

@@ -0,0 +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}}

package/utils/solidity-docgen-helpers.js

@@ -0,0 +1,31 @@
+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){
+                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));
+
+        if (!contractPath){
+            console.log('WARNING: file ' + contractName + '.sol not found in source files.');
+        }
+        
+        return getRelativePath(contractPath);
+    },
+};