@1inch/solidity-utils 2.1.0 → 2.1.2

package/contracts/libraries/SafeERC20.sol

@@ -8,6 +8,7 @@ import "@openzeppelin/contracts/token/ERC20/extensions/draft-IERC20Permit.sol";
 import "../interfaces/IDaiLikePermit.sol";
 import "../libraries/RevertReasonForwarder.sol";
 
+/// @title Implements efficient safe methods for ERC20 interface.
 library SafeERC20 {
     error SafeTransferFailed();
     error SafeTransferFromFailed();
@@ -16,8 +17,13 @@ library SafeERC20 {
     error SafeDecreaseAllowanceFailed();
     error SafePermitBadLength();
 
-    // Ensures method do not revert or return boolean `true`, admits call to non-smart-contract
-    function safeTransferFrom(IERC20 token, address from, address to, uint256 amount) internal {
+    /// @dev Ensures method do not revert or return boolean `true`, admits call to non-smart-contract.
+    function safeTransferFrom(
+        IERC20 token,
+        address from,
+        address to,
+        uint256 amount
+    ) internal {
         bytes4 selector = token.transferFrom.selector;
         bool success;
         /// @solidity memory-safe-assembly
@@ -31,43 +37,67 @@ library SafeERC20 {
             success := call(gas(), token, 0, data, 100, 0x0, 0x20)
             if success {
                 switch returndatasize()
-                case 0 { success := gt(extcodesize(token), 0) }
-                default { success := and(gt(returndatasize(), 31), eq(mload(0), 1)) }
+                case 0 {
+                    success := gt(extcodesize(token), 0)
+                }
+                default {
+                    success := and(gt(returndatasize(), 31), eq(mload(0), 1))
+                }
             }
         }
         if (!success) revert SafeTransferFromFailed();
     }
 
-    // Ensures method do not revert or return boolean `true`, admits call to non-smart-contract
-    function safeTransfer(IERC20 token, address to, uint256 value) internal {
+    /// @dev Ensures method do not revert or return boolean `true`, admits call to non-smart-contract.
+    function safeTransfer(
+        IERC20 token,
+        address to,
+        uint256 value
+    ) internal {
         if (!_makeCall(token, token.transfer.selector, to, value)) {
             revert SafeTransferFailed();
         }
     }
 
-    // If `approve(from, to, amount)` fails, try to `approve(from, to, 0)` before retry
-    function forceApprove(IERC20 token, address spender, uint256 value) internal {
+    /// @dev If `approve(from, to, amount)` fails, try to `approve(from, to, 0)` before retry.
+    function forceApprove(
+        IERC20 token,
+        address spender,
+        uint256 value
+    ) internal {
         if (!_makeCall(token, token.approve.selector, spender, value)) {
-            if (!_makeCall(token, token.approve.selector, spender, 0) ||
-                !_makeCall(token, token.approve.selector, spender, value))
-            {
+            if (
+                !_makeCall(token, token.approve.selector, spender, 0) ||
+                !_makeCall(token, token.approve.selector, spender, value)
+            ) {
                 revert ForceApproveFailed();
             }
         }
     }
 
-    function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
+    /// @dev Allowance increase with safe math check.
+    function safeIncreaseAllowance(
+        IERC20 token,
+        address spender,
+        uint256 value
+    ) internal {
         uint256 allowance = token.allowance(address(this), spender);
         if (value > type(uint256).max - allowance) revert SafeIncreaseAllowanceFailed();
         forceApprove(token, spender, allowance + value);
     }
 
-    function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
+    /// @dev Allowance decrease with safe math check.
+    function safeDecreaseAllowance(
+        IERC20 token,
+        address spender,
+        uint256 value
+    ) internal {
         uint256 allowance = token.allowance(address(this), spender);
         if (value > allowance) revert SafeDecreaseAllowanceFailed();
         forceApprove(token, spender, allowance - value);
     }
 
+    /// @dev Calls either ERC20 or Dai `permit` for `token`, if unsuccessful forwards revert from external call.
     function safePermit(IERC20 token, bytes calldata permit) internal {
         bool success;
         if (permit.length == 32 * 7) {
@@ -80,7 +110,12 @@ library SafeERC20 {
         if (!success) RevertReasonForwarder.reRevert();
     }
 
-    function _makeCall(IERC20 token, bytes4 selector, address to, uint256 amount) private returns(bool success) {
+    function _makeCall(
+        IERC20 token,
+        bytes4 selector,
+        address to,
+        uint256 amount
+    ) private returns (bool success) {
         /// @solidity memory-safe-assembly
         assembly { // solhint-disable-line no-inline-assembly
             let data := mload(0x40)
@@ -91,13 +126,21 @@ library SafeERC20 {
             success := call(gas(), token, 0, data, 0x44, 0x0, 0x20)
             if success {
                 switch returndatasize()
-                case 0 { success := gt(extcodesize(token), 0) }
-                default { success := and(gt(returndatasize(), 31), eq(mload(0), 1)) }
+                case 0 {
+                    success := gt(extcodesize(token), 0)
+                }
+                default {
+                    success := and(gt(returndatasize(), 31), eq(mload(0), 1))
+                }
             }
         }
     }
 
-    function _makeCalldataCall(IERC20 token, bytes4 selector, bytes calldata args) private returns(bool success) {
+    function _makeCalldataCall(
+        IERC20 token,
+        bytes4 selector,
+        bytes calldata args
+    ) private returns (bool success) {
         /// @solidity memory-safe-assembly
         assembly { // solhint-disable-line no-inline-assembly
             let len := add(4, args.length)
@@ -108,8 +151,12 @@ library SafeERC20 {
             success := call(gas(), token, 0, data, len, 0x0, 0x20)
             if success {
                 switch returndatasize()
-                case 0 { success := gt(extcodesize(token), 0) }
-                default { success := and(gt(returndatasize(), 31), eq(mload(0), 1)) }
+                case 0 {
+                    success := gt(extcodesize(token), 0)
+                }
+                default {
+                    success := and(gt(returndatasize(), 31), eq(mload(0), 1))
+                }
             }
         }
     }

package/contracts/libraries/StringUtil.sol

@@ -13,6 +13,8 @@ library StringUtil {
         return toHex(abi.encodePacked(value));
     }
 
+    /// @dev this is the assembly adaptation of highly optimized toHex16 code from Mikhail Vladimirov
+    /// https://stackoverflow.com/a/69266989
     function toHex(bytes memory data) internal pure returns (string memory result) {
         /// @solidity memory-safe-assembly
         assembly { // solhint-disable-line no-inline-assembly
@@ -44,7 +46,7 @@ library StringUtil {
                             shr(4, add(output, 0x0606060606060606060606060606060606060606060606060606060606060606)),
                             0x0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F
                         ),
-                        7   // Change 7 to 39 for lower case output
+                        7 // Change 7 to 39 for lower case output
                     )
                 )
             }
@@ -52,11 +54,11 @@ library StringUtil {
             result := mload(0x40)
             let length := mload(data)
             let resultLength := shl(1, length)
-            let toPtr := add(result, 0x22)          // 32 bytes for length + 2 bytes for '0x'
-            mstore(0x40, add(toPtr, resultLength))  // move free memory pointer
-            mstore(add(result, 2), 0x3078)          // 0x3078 is right aligned so we write to `result + 2`
-                                                    // to store the last 2 bytes in the beginning of the string
-            mstore(result, add(resultLength, 2))    // extra 2 bytes for '0x'
+            let toPtr := add(result, 0x22) // 32 bytes for length + 2 bytes for '0x'
+            mstore(0x40, add(toPtr, resultLength)) // move free memory pointer
+            mstore(add(result, 2), 0x3078) // 0x3078 is right aligned so we write to `result + 2`
+            // to store the last 2 bytes in the beginning of the string
+            mstore(result, add(resultLength, 2)) // extra 2 bytes for '0x'
 
             for {
                 let fromPtr := add(data, 0x20)

package/contracts/libraries/UniERC20.sol

@@ -9,6 +9,7 @@ import "../interfaces/IERC20MetadataUppercase.sol";
 import "./SafeERC20.sol";
 import "./StringUtil.sol";
 
+/// @title Library, which allows usage of ETH as ERC20 and ERC20 itself. Uses SafeERC20 library for ERC20 interface.
 library UniERC20 {
     using SafeERC20 for IERC20;
 
@@ -23,10 +24,12 @@ library UniERC20 {
     IERC20 private constant _ETH_ADDRESS = IERC20(0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE);
     IERC20 private constant _ZERO_ADDRESS = IERC20(address(0));
 
+    /// @dev Returns true if `token` is ETH.
     function isETH(IERC20 token) internal pure returns (bool) {
         return (token == _ZERO_ADDRESS || token == _ETH_ADDRESS);
     }
 
+    /// @dev Returns `account` ERC20 `token` balance.
     function uniBalanceOf(IERC20 token, address account) internal view returns (uint256) {
         if (isETH(token)) {
             return account.balance;
@@ -35,8 +38,13 @@ library UniERC20 {
         }
     }
 
-    /// @dev note that this function does nothing in case of zero amount
-    function uniTransfer(IERC20 token, address payable to, uint256 amount) internal {
+    /// @dev `token` transfer `to` `amount`.
+    /// Note that this function does nothing in case of zero amount.
+    function uniTransfer(
+        IERC20 token,
+        address payable to,
+        uint256 amount
+    ) internal {
         if (amount > 0) {
             if (isETH(token)) {
                 if (address(this).balance < amount) revert InsufficientBalance();
@@ -49,8 +57,14 @@ library UniERC20 {
         }
     }
 
-    /// @dev note that this function does nothing in case of zero amount
-    function uniTransferFrom(IERC20 token, address payable from, address to, uint256 amount) internal {
+    /// @dev `token` transfer `from` `to` `amount`.
+    /// Note that this function does nothing in case of zero amount.
+    function uniTransferFrom(
+        IERC20 token,
+        address payable from,
+        address to,
+        uint256 amount
+    ) internal {
         if (amount > 0) {
             if (isETH(token)) {
                 if (msg.value < amount) revert NotEnoughValue();
@@ -70,47 +84,62 @@ library UniERC20 {
         }
     }
 
-    function uniSymbol(IERC20 token) internal view returns(string memory) {
+    /// @dev Returns `token` symbol from ERC20 metadata.
+    function uniSymbol(IERC20 token) internal view returns (string memory) {
         return _uniDecode(token, IERC20Metadata.symbol.selector, IERC20MetadataUppercase.SYMBOL.selector);
     }
 
-    function uniName(IERC20 token) internal view returns(string memory) {
+    /// @dev Returns `token` name from ERC20 metadata.
+    function uniName(IERC20 token) internal view returns (string memory) {
         return _uniDecode(token, IERC20Metadata.name.selector, IERC20MetadataUppercase.NAME.selector);
     }
 
-    function uniApprove(IERC20 token, address to, uint256 amount) internal {
+    /// @dev Reverts if `token` is ETH, otherwise performs ERC20 forceApprove.
+    function uniApprove(
+        IERC20 token,
+        address to,
+        uint256 amount
+    ) internal {
         if (isETH(token)) revert ApproveCalledOnETH();
 
         token.forceApprove(to, amount);
     }
 
-    /// 20K gas is provided to account for possible implementations of name/symbol
+    /// @dev 20K gas is provided to account for possible implementations of name/symbol
     /// (token implementation might be behind proxy or store the value in storage)
-    function _uniDecode(IERC20 token, bytes4 lowerCaseSelector, bytes4 upperCaseSelector) private view returns(string memory result) {
+    function _uniDecode(
+        IERC20 token,
+        bytes4 lowerCaseSelector,
+        bytes4 upperCaseSelector
+    ) private view returns (string memory result) {
         if (isETH(token)) {
             return "ETH";
         }
 
-        (bool success, bytes memory data) = address(token).staticcall{ gas: 20000 }(
+        (bool success, bytes memory data) = address(token).staticcall{gas: 20000}(
             abi.encodeWithSelector(lowerCaseSelector)
         );
         if (!success) {
-            (success, data) = address(token).staticcall{ gas: 20000 }(
-                abi.encodeWithSelector(upperCaseSelector)
-            );
+            (success, data) = address(token).staticcall{gas: 20000}(abi.encodeWithSelector(upperCaseSelector));
         }
 
         if (success && data.length >= 0x40) {
             (uint256 offset, uint256 len) = abi.decode(data, (uint256, uint256));
-            if (offset == 0x20 && len > 0 && data.length == 0x40 + len) {
+            /*
+                return data is padded up to 32 bytes with ABI encoder also sometimes
+                there is extra 32 bytes of zeros padded in the end:
+                https://github.com/ethereum/solidity/issues/10170
+                because of that we can't check for equality and instead check
+                that overall data length is greater or equal than string length + extra 64 bytes
+            */
+            if (offset == 0x20 && data.length >= 0x40 + len) {
                 /// @solidity memory-safe-assembly
                 assembly { // solhint-disable-line no-inline-assembly
-                    result := add(data, 0x20)
+                    result := add(data, 0x40)
                 }
                 return result;
             }
         }
-
         if (success && data.length == 32) {
             uint256 len = 0;
             while (len < data.length && data[len] >= 0x20 && data[len] <= 0x7E) {

package/contracts/mocks/TokenCustomDecimalsMock.sol

@@ -8,7 +8,12 @@ import "@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol";
 contract TokenCustomDecimalsMock is ERC20Permit, Ownable {
     uint8 internal immutable _decimals;
 
-    constructor(string memory name, string memory symbol, uint256 amount, uint8 decimals_) ERC20(name, symbol) ERC20Permit(name) {
+    constructor(
+        string memory name,
+        string memory symbol,
+        uint256 amount,
+        uint8 decimals_
+    ) ERC20(name, symbol) ERC20Permit(name) {
         _mint(msg.sender, amount);
         _decimals = decimals_;
     }
@@ -25,7 +30,7 @@ contract TokenCustomDecimalsMock is ERC20Permit, Ownable {
         return _decimals;
     }
 
-    function getChainId() external view returns(uint256) {
+    function getChainId() external view returns (uint256) {
         return block.chainid;
     }
 }

package/contracts/mocks/TokenMock.sol

@@ -6,7 +6,6 @@ pragma abicoder v1;
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
-
 contract TokenMock is ERC20, Ownable {
     // solhint-disable-next-line no-empty-blocks
     constructor(string memory name, string memory symbol) ERC20(name, symbol) {}

package/dist/src/hardhat.config.d.ts

@@ -0,0 +1,6 @@
+import '@typechain/hardhat';
+import '@nomicfoundation/hardhat-chai-matchers';
+import 'hardhat-gas-reporter';
+import { HardhatUserConfig } from 'hardhat/config';
+declare const config: HardhatUserConfig;
+export default config;

package/dist/src/hardhat.config.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("@typechain/hardhat");
+require("@nomicfoundation/hardhat-chai-matchers");
+require("hardhat-gas-reporter");
+require('solidity-coverage'); // require because no TS typings available
+const dotenv_1 = tslib_1.__importDefault(require("dotenv"));
+const hardhat_networks_1 = tslib_1.__importDefault(require("./hardhat.networks"));
+dotenv_1.default.config();
+const config = {
+    solidity: {
+        version: '0.8.15',
+        settings: {
+            optimizer: {
+                enabled: true,
+                runs: 1000000,
+            },
+        },
+    },
+    networks: hardhat_networks_1.default,
+    gasReporter: {
+        enabled: true,
+        currency: 'USD',
+    },
+    typechain: {
+        target: 'ethers-v5',
+    },
+};
+exports.default = config;
+//# sourceMappingURL=hardhat.config.js.map

package/dist/src/hardhat.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hardhat.config.js","sourceRoot":"","sources":["../../hardhat.config.ts"],"names":[],"mappings":";;;AAAA,8BAA4B;AAC5B,kDAAgD;AAChD,gCAA8B;AAC9B,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,0CAA0C;AACxE,4DAA4B;AAE5B,kFAA0C;AAE1C,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,MAAM,GAAsB;IAC9B,QAAQ,EAAE;QACN,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE;YACN,SAAS,EAAE;gBACP,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,OAAO;aAChB;SACJ;KACJ;IACD,QAAQ,EAAR,0BAAQ;IACR,WAAW,EAAE;QACT,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,KAAK;KAClB;IACD,SAAS,EAAE;QACP,MAAM,EAAE,WAAW;KACtB;CACJ,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/dist/src/hardhat.networks.d.ts

@@ -0,0 +1,3 @@
+import { NetworksUserConfig } from 'hardhat/types';
+declare const networks: NetworksUserConfig;
+export default networks;

package/dist/src/hardhat.networks.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const dotenv_1 = tslib_1.__importDefault(require("dotenv"));
+dotenv_1.default.config();
+const networks = {};
+function register(name, chainId, url, privateKey) {
+    if (url && privateKey) {
+        networks[name] = {
+            url,
+            chainId,
+            accounts: [privateKey],
+        };
+        console.log(`Network '${name}' registered`);
+    }
+    else {
+        console.log(`Network '${name}' not registered`);
+    }
+}
+register('mainnet', 1, process.env.MAINNET_RPC_URL, process.env.MAINNET_PRIVATE_KEY);
+register('bsc', 56, process.env.BSC_RPC_URL, process.env.BSC_PRIVATE_KEY);
+register('kovan', 42, process.env.KOVAN_RPC_URL, process.env.KOVAN_PRIVATE_KEY);
+register('optimistic', 10, process.env.OPTIMISTIC_RPC_URL, process.env.OPTIMISTIC_PRIVATE_KEY);
+register('kovan-optimistic', 69, process.env.KOVAN_OPTIMISTIC_RPC_URL, process.env.KOVAN_OPTIMISTIC_PRIVATE_KEY);
+register('matic', 137, process.env.MATIC_RPC_URL, process.env.MATIC_PRIVATE_KEY);
+register('arbitrum', 42161, process.env.ARBITRUM_RPC_URL, process.env.ARBITRUM_PRIVATE_KEY);
+register('ropsten', 3, process.env.ROPSTEN_RPC_URL, process.env.ROPSTEN_PRIVATE_KEY);
+register('xdai', 100, process.env.XDAI_RPC_URL, process.env.XDAI_PRIVATE_KEY);
+register('avax', 43114, process.env.AVAX_RPC_URL, process.env.AVAX_PRIVATE_KEY);
+exports.default = networks;
+//# sourceMappingURL=hardhat.networks.js.map

package/dist/src/hardhat.networks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hardhat.networks.js","sourceRoot":"","sources":["../../hardhat.networks.ts"],"names":[],"mappings":";;;AAAA,4DAA4B;AAG5B,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,QAAQ,GAAuB,EAAE,CAAC;AAExC,SAAS,QAAQ,CAAC,IAAY,EAAE,OAAe,EAAE,GAAY,EAAE,UAAmB;IAC9E,IAAI,GAAG,IAAI,UAAU,EAAE;QACnB,QAAQ,CAAC,IAAI,CAAC,GAAG;YACb,GAAG;YACH,OAAO;YACP,QAAQ,EAAE,CAAC,UAAU,CAAC;SACzB,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;KAC/C;SAAM;QACH,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,kBAAkB,CAAC,CAAC;KACnD;AACL,CAAC;AAED,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACrF,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;AAC1E,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;AAChF,QAAQ,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAC/F,QAAQ,CAAC,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;AACjH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;AACjF,QAAQ,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;AAC5F,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AACrF,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAC9E,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAEhF,kBAAe,QAAQ,CAAC"}

package/dist/src/src/asserts.d.ts

@@ -0,0 +1 @@
+export declare function assertRoughlyEqualValues(expected: string | number | bigint, actual: string | number | bigint, relativeDiff: number): void;

package/dist/src/src/asserts.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertRoughlyEqualValues = void 0;
+const prelude_1 = require("./prelude");
+function assertRoughlyEqualValues(expected, actual, relativeDiff) {
+    let expectedBN = BigInt(expected);
+    let actualBN = BigInt(actual);
+    (0, prelude_1.expect)(expectedBN * actualBN).to.be.gte(0, 'Values are of different sign');
+    if (expectedBN < 0)
+        expectedBN = -expectedBN;
+    if (actualBN < 0)
+        actualBN = -actualBN;
+    let multiplerNumerator = relativeDiff;
+    let multiplerDenominator = 1n;
+    while (!Number.isInteger(multiplerNumerator)) {
+        multiplerDenominator = multiplerDenominator * 10n;
+        multiplerNumerator *= 10;
+    }
+    const diff = expectedBN > actualBN ? expectedBN - actualBN : actualBN - expectedBN;
+    const treshold = (expectedBN * BigInt(multiplerNumerator)) / multiplerDenominator;
+    if (diff > treshold) {
+        (0, prelude_1.expect)(actualBN).to.be.equal(expectedBN, `${actual} != ${expected} with ${relativeDiff} precision`);
+    }
+}
+exports.assertRoughlyEqualValues = assertRoughlyEqualValues;
+//# sourceMappingURL=asserts.js.map

package/dist/src/src/asserts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asserts.js","sourceRoot":"","sources":["../../../src/asserts.ts"],"names":[],"mappings":";;;AAAA,uCAAmC;AAEnC,SAAgB,wBAAwB,CACpC,QAAkC,EAClC,MAAgC,EAChC,YAAoB;IAEpB,IAAI,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9B,IAAA,gBAAM,EAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,8BAA8B,CAAC,CAAC;IAE3E,IAAI,UAAU,GAAG,CAAC;QAAE,UAAU,GAAG,CAAC,UAAU,CAAC;IAC7C,IAAI,QAAQ,GAAG,CAAC;QAAE,QAAQ,GAAG,CAAC,QAAQ,CAAC;IAEvC,IAAI,kBAAkB,GAAG,YAAY,CAAC;IACtC,IAAI,oBAAoB,GAAG,EAAE,CAAC;IAC9B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE;QAC1C,oBAAoB,GAAG,oBAAoB,GAAG,GAAG,CAAC;QAClD,kBAAkB,IAAI,EAAE,CAAC;KAC5B;IACD,MAAM,IAAI,GAAG,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,GAAG,UAAU,CAAC;IACnF,MAAM,QAAQ,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC,GAAG,oBAAoB,CAAC;IAClF,IAAI,IAAI,GAAG,QAAQ,EAAE;QACjB,IAAA,gBAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,MAAM,OAAO,QAAQ,SAAS,YAAY,YAAY,CAAC,CAAC;KACvG;AACL,CAAC;AAvBD,4DAuBC"}

package/dist/src/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 → src/permit.d.ts}

@@ -1,8 +1,8 @@
-/// <reference types="node" />
-import { MessageTypes, SignTypedDataVersion, TypedMessage } from '@metamask/eth-sig-util';
-import { Token } from './utils';
+import { SignTypedDataVersion } from '@metamask/eth-sig-util';
+import { Contract } from 'ethers';
+import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers';
 export declare const TypedDataVersion = SignTypedDataVersion.V4;
-export declare const defaultDeadline: string;
+export declare const defaultDeadline: bigint;
 export declare const EIP712Domain: {
     name: string;
     type: string;
@@ -15,16 +15,11 @@ export declare const DaiLikePermit: {
     name: string;
     type: string;
 }[];
-export declare function trim0x(bigNumber: BN | string): string;
+export declare function trim0x(bigNumber: bigint | 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;
@@ -45,12 +40,7 @@ export declare function buildData(name: string, version: string, chainId: number
     };
 };
 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;
@@ -70,11 +60,6 @@ export declare function buildDataLikeDai(name: string, version: string, chainId:
         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: Buffer | 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;
+export declare function getPermit(owner: SignerWithAddress, permitContract: Contract, tokenVersion: string, chainId: number, spender: string, value: string, deadline?: string): Promise<string>;
+export declare function getPermitLikeDai(holder: SignerWithAddress, permitContract: Contract, tokenVersion: string, chainId: number, spender: string, allowed: boolean, expiry?: string): Promise<string>;
+export declare function withTarget(target: bigint | string, data: bigint | string): string;

package/dist/src/{permit.js → src/permit.js}

@@ -1,9 +1,9 @@
 "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;
+exports.withTarget = exports.getPermitLikeDai = exports.getPermit = 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");
+const utils_1 = require("ethers/lib/utils");
 exports.TypedDataVersion = eth_sig_util_1.SignTypedDataVersion.V4;
 exports.defaultDeadline = prelude_1.constants.MAX_UINT256;
 exports.EIP712Domain = [
@@ -40,55 +40,57 @@ function cutSelector(data) {
 }
 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');
+    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) {
+function buildData(name, version, chainId, verifyingContract, owner, spender, value, nonce, deadline = exports.defaultDeadline.toString()) {
     return {
-        primaryType: 'Permit',
-        types: { EIP712Domain: exports.EIP712Domain, Permit: exports.Permit },
+        types: { 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) {
+function buildDataLikeDai(name, version, chainId, verifyingContract, holder, spender, nonce, allowed, expiry = exports.defaultDeadline.toString()) {
     return {
-        primaryType: 'Permit',
-        types: { EIP712Domain: exports.EIP712Domain, Permit: exports.DaiLikePermit },
+        types: { Permit: exports.DaiLikePermit },
         domain: { name, version, chainId, verifyingContract },
         message: { holder, spender, nonce, expiry, allowed },
     };
 }
 exports.buildDataLikeDai = buildDataLikeDai;
-function signWithPk(privateKey, data) {
-    const buffer = Buffer.isBuffer(privateKey) ? privateKey : Buffer.from(trim0x(privateKey), 'hex');
-    return (0, eth_sig_util_1.signTypedData)({ privateKey: buffer, 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);
+async function getPermit(owner, permitContract, tokenVersion, chainId, spender, value, deadline = exports.defaultDeadline.toString()) {
+    const nonce = await permitContract.nonces(owner.address);
     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();
+    const data = buildData(name, tokenVersion, chainId, permitContract.address, owner.address, spender, value, nonce.toString(), deadline);
+    const signature = await owner._signTypedData(data.domain, data.types, data.message);
+    const { v, r, s } = (0, utils_1.splitSignature)(signature);
+    const permitCall = permitContract.interface.encodeFunctionData('permit', [
+        owner.address,
+        spender,
+        value,
+        deadline,
+        v,
+        r,
+        s,
+    ]);
     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);
+async function getPermitLikeDai(holder, permitContract, tokenVersion, chainId, spender, allowed, expiry = exports.defaultDeadline.toString()) {
+    const nonce = await permitContract.nonces(holder.address);
     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();
+    const data = buildDataLikeDai(name, tokenVersion, chainId, permitContract.address, holder.address, spender, nonce.toString(), allowed, expiry);
+    const signature = await holder._signTypedData(data.domain, data.types, data.message);
+    const { v, r, s } = (0, utils_1.splitSignature)(signature);
+    const permitCall = permitContract.interface.encodeFunctionData('permit(address,address,uint256,uint256,bool,uint8,bytes32,bytes32)', [holder.address, spender, nonce, expiry, allowed, v, r, s]);
     return cutSelector(permitCall);
 }
 exports.getPermitLikeDai = getPermitLikeDai;