@1inch/solidity-utils 1.3.0 → 2.0.3

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2019-2021 1inch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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,28 @@
+"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) {
+    const expectedBN = toBNExtended(expected);
+    const actualBN = toBNExtended(actual);
+    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, `${actualBN} != ${expectedBN} 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,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAEtC,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,QAAQ,OAAO,UAAU,SAAS,YAAY,YAAY,CAAC,CAAC;KACrH;AACL,CAAC;AAfD,4DAeC"}

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

@@ -0,0 +1,10 @@
+"use strict";
+// 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);
+//# 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,yDAA0B;AAC1B,wDAAyB;AACzB,yDAA0B;AAC1B,4DAA6B;AAC7B,uDAAwB"}

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.V3;
+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.V3;
+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;IAClC,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;AAhBD,8BAgBC;AAED,SAAgB,gBAAgB,CAAE,IAAY,EAC1C,OAAe,EACf,OAAe,EACf,iBAAyB,EACzB,MAAc,EACd,OAAe,EACf,KAAa,EACb,OAAgB,EAChB,SAAiB,uBAAe;IAChC,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;AAfD,4CAeC;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;IAC1B,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;AAhBD,8BAgBC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAClC,MAAc,EACd,gBAAwB,EACxB,cAAgC,EAChC,YAAoB,EACpB,OAAe,EACf,OAAe,EACf,OAAgB,EAAE,MAAM,GAAG,uBAAe;IAC1C,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;AAfD,4CAeC;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,19 @@
+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 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,31 @@
+"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 = (0, 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 = (0, 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',
+    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,0DAAuF;AAoCnF,0FApCW,gBAAS,OAoCX;AACT,+FArCsB,qBAAc,OAqCtB;AACd,uFAtCsC,aAAM,OAsCtC;AACN,uFAvC8C,aAAM,OAuC9C;AACN,uFAxCsD,aAAM,OAwCtD;AACN,uFAzC8D,aAAM,OAyC9D;AAxCV,mBAAiB;AACjB,qFAA8C;AAC9C,2CAAyC;AAgBrC,qFAhBK,iBAAI,OAgBL;AAdR,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,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/{js → dist/src}/profileEVM.js

@@ -1,27 +1,27 @@
-const { promisify } = require('util');
-const fs = require('fs').promises;
-
-const gasspectOptionsDefault = {
-    minOpGasCost: 300, // minimal gas cost of returned operations
-    args: false, // return operations arguments
+"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) {
+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') {
+        }
+        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 {
+        }
+        else {
             ops[i].args = [
                 '0x' + ops[i].stack[ops[i].stack.length - 2].substr(24),
-                '0x' + (ops[i].memory || []).join('').substr(
-                    2 * web3.utils.toBN(ops[i].stack[ops[i].stack.length - 3]).toNumber(),
-                    2 * web3.utils.toBN(ops[i].stack[ops[i].stack.length - 4]).toNumber(),
-                ),
+                '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';
@@ -31,14 +31,10 @@ function _normalizeOp (ops, i) {
     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 * web3.utils.toBN(ops[i].stack[ops[i].stack.length - 4]).toNumber(),
-                2 * web3.utils.toBN(ops[i].stack[ops[i].stack.length - 5]).toNumber(),
-            ),
+            '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';
         }
@@ -59,7 +55,6 @@ function _normalizeOp (ops, i) {
         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];
         }
@@ -71,70 +66,60 @@ function _normalizeOp (ops, i) {
         ops[i].res = ops[i + 1].stack[ops[i + 1].stack.length - 1];
     }
 }
-
-async function profileEVM (txHash, instruction, optionalTraceFile) {
-    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
+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.writeFile(optionalTraceFile, str);
-    }
-
-    if (Array.isArray(instruction)) {
-        return instruction.map(instr => {
-            return str.split('"' + instr.toUpperCase() + '"').length - 1;
-        });
+        await fs_1.promises.writeFile(optionalTraceFile, str);
     }
-
-    return str.split('"' + instruction.toUpperCase() + '"').length - 1;
+    return instruction.map(instr => {
+        return str.split('"' + instr.toUpperCase() + '"').length - 1;
+    });
 }
-
-async function gasspectEVM (txHash, options = gasspectOptionsDefault, optionalTraceFile) {
-    options = { ...gasspectOptionsDefault, ...options };
-
-    const trace = await promisify(web3.currentProvider.send.bind(web3.currentProvider))({
+exports.profileEVM = profileEVM;
+async function gasspectEVM(txHash, gasspectOptions = {}, optionalTraceFile) {
+    const options = { ...exports.gasspectOptionsDefault, ...gasspectOptions };
+    if (!web3.currentProvider) {
+        throw new Error('Provider not set');
+    }
+    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.result.structLogs;
-
+    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);
-
+        (options.args ? '(' + (op.args || []).join(',') + ')' : '') +
+        (options.res ? (op.res ? ':0x' + op.res : '') : '') +
+        ' = ' + op.gasCost);
     if (optionalTraceFile) {
-        await fs.writeFile(optionalTraceFile, JSON.stringify(result));
+        await fs_1.promises.writeFile(optionalTraceFile, JSON.stringify(result));
     }
-
     return result;
 }
-
-module.exports = {
-    profileEVM,
-    gasspectEVM,
-};
+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,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;KACvC;IAED,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;AA7CD,kCA6CC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="bn.js" />
+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, 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,56 @@
+"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 isETH = token.address === prelude_1.constants.ZERO_ADDRESS || token.address === '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
+    const preBalance = isETH ? (0, prelude_1.toBN)(await web3.eth.getBalance(wallet)) : await token.balanceOf(wallet);
+    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 = isETH ? (0, prelude_1.toBN)(await web3.eth.getBalance(wallet)) : await token.balanceOf(wallet);
+    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,KAAY,EACZ,MAAc,EACd,SAAkE,EAClE,GAAG,IAAO;IACV,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,KAAK,mBAAS,CAAC,YAAY,IAAI,KAAK,CAAC,OAAO,KAAK,4CAA4C,CAAC;IACzH,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,IAAA,cAAI,EAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACnG,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,KAAK,CAAC,CAAC,CAAC,IAAA,cAAI,EAAC,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACpG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAU,CAAC;AACxE,CAAC;AAbD,0DAaC;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.3.0",
-  "main": "index.js",
+  "version": "2.0.3",
+  "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",
-    "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/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,111 +0,0 @@
-const { constants } = require('@openzeppelin/test-helpers');
-const ethSigUtil = require('eth-sig-util');
-const { fromRpcSig } = require('ethereumjs-util');
-
-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 },
-    };
-}
-
-/*
- * @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 = defaultDeadline) {
-    const nonce = await permitContract.nonces(owner);
-    const name = await permitContract.name();
-    const data = buildData(name, tokenVersion, chainId, permitContract.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);
-}
-
-/*
- * @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 = defaultDeadline) {
-    const nonce = await permitContract.nonces(holder);
-    const name = await permitContract.name();
-    const data = buildDataLikeDai(name, tokenVersion, chainId, permitContract.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);
-    },
-};