@openocean.finance/openocean-sdk 1.2.2 → 1.2.3

package/lib/v1/router.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Router = void 0;
+var constants_1 = require("./constants");
+var tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+var utils_1 = require("./utils");
+var entities_1 = require("./entities");
+function toHex(currencyAmount) {
+    return "0x".concat(currencyAmount.raw.toString(16));
+}
+var ZERO_HEX = '0x0';
+/**
+ * Represents the Uniswap V2 Router, and has static methods for helping execute trades.
+ */
+var Router = /** @class */ (function () {
+    /**
+     * Cannot be constructed.
+     */
+    function Router() {
+    }
+    /**
+     * Produces the on-chain method name to call and the hex encoded parameters to pass as arguments for a given trade.
+     * @param trade to produce call parameters for
+     * @param options options for the call parameters
+     */
+    Router.swapCallParameters = function (trade, options) {
+        var etherIn = trade.inputAmount.currency === entities_1.ETHER;
+        var etherOut = trade.outputAmount.currency === entities_1.ETHER;
+        // the router does not support both ether in and out
+        (0, tiny_invariant_1.default)(!(etherIn && etherOut), 'ETHER_IN_OUT');
+        (0, tiny_invariant_1.default)(options.ttl > 0, 'TTL');
+        var to = (0, utils_1.validateAndParseAddress)(options.recipient);
+        var amountIn = toHex(trade.maximumAmountIn(options.allowedSlippage));
+        var amountOut = toHex(trade.minimumAmountOut(options.allowedSlippage));
+        var path = trade.route.path.map(function (token) { return token.address; });
+        var deadline = "0x".concat((Math.floor(new Date().getTime() / 1000) + options.ttl).toString(16));
+        var useFeeOnTransfer = Boolean(options.feeOnTransfer);
+        var methodName;
+        var args;
+        var value;
+        switch (trade.tradeType) {
+            case constants_1.TradeType.EXACT_INPUT:
+                if (etherIn) {
+                    methodName = useFeeOnTransfer ? 'swapExactETHForTokensSupportingFeeOnTransferTokens' : 'swapExactETHForTokens';
+                    // (uint amountOutMin, address[] calldata path, address to, uint deadline)
+                    args = [amountOut, path, to, deadline];
+                    value = amountIn;
+                }
+                else if (etherOut) {
+                    methodName = useFeeOnTransfer ? 'swapExactTokensForETHSupportingFeeOnTransferTokens' : 'swapExactTokensForETH';
+                    // (uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
+                    args = [amountIn, amountOut, path, to, deadline];
+                    value = ZERO_HEX;
+                }
+                else {
+                    methodName = useFeeOnTransfer
+                        ? 'swapExactTokensForTokensSupportingFeeOnTransferTokens'
+                        : 'swapExactTokensForTokens';
+                    // (uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
+                    args = [amountIn, amountOut, path, to, deadline];
+                    value = ZERO_HEX;
+                }
+                break;
+            case constants_1.TradeType.EXACT_OUTPUT:
+                (0, tiny_invariant_1.default)(!useFeeOnTransfer, 'EXACT_OUT_FOT');
+                if (etherIn) {
+                    methodName = 'swapETHForExactTokens';
+                    // (uint amountOut, address[] calldata path, address to, uint deadline)
+                    args = [amountOut, path, to, deadline];
+                    value = amountIn;
+                }
+                else if (etherOut) {
+                    methodName = 'swapTokensForExactETH';
+                    // (uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
+                    args = [amountOut, amountIn, path, to, deadline];
+                    value = ZERO_HEX;
+                }
+                else {
+                    methodName = 'swapTokensForExactTokens';
+                    // (uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
+                    args = [amountOut, amountIn, path, to, deadline];
+                    value = ZERO_HEX;
+                }
+                break;
+        }
+        return {
+            methodName: methodName,
+            args: args,
+            value: value
+        };
+    };
+    return Router;
+}());
+exports.Router = Router;

package/lib/v1/utils.d.ts

@@ -0,0 +1,7 @@
+import JSBI from 'jsbi';
+import { BigintIsh, SolidityType } from './constants';
+export declare function validateSolidityTypeInstance(value: JSBI, solidityType: SolidityType): void;
+export declare function validateAndParseAddress(address: string): string;
+export declare function parseBigintIsh(bigintIsh: BigintIsh): JSBI;
+export declare function sqrt(y: JSBI): JSBI;
+export declare function sortedInsert<T>(items: T[], add: T, maxSize: number, comparator: (a: T, b: T) => number): T | null;

package/lib/v1/utils.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortedInsert = exports.sqrt = exports.parseBigintIsh = exports.validateAndParseAddress = exports.validateSolidityTypeInstance = void 0;
+var tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+var tiny_warning_1 = __importDefault(require("tiny-warning"));
+var jsbi_1 = __importDefault(require("jsbi"));
+var address_1 = require("@ethersproject/address");
+var constants_1 = require("./constants");
+function validateSolidityTypeInstance(value, solidityType) {
+    (0, tiny_invariant_1.default)(jsbi_1.default.greaterThanOrEqual(value, constants_1.ZERO), "".concat(value, " is not a ").concat(solidityType, "."));
+    (0, tiny_invariant_1.default)(jsbi_1.default.lessThanOrEqual(value, constants_1.SOLIDITY_TYPE_MAXIMA[solidityType]), "".concat(value, " is not a ").concat(solidityType, "."));
+}
+exports.validateSolidityTypeInstance = validateSolidityTypeInstance;
+// warns if addresses are not checksummed
+function validateAndParseAddress(address) {
+    try {
+        var checksummedAddress = (0, address_1.getAddress)(address);
+        (0, tiny_warning_1.default)(address === checksummedAddress, "".concat(address, " is not checksummed."));
+        return checksummedAddress;
+    }
+    catch (error) {
+        (0, tiny_invariant_1.default)(false, "".concat(address, " is not a valid address."));
+    }
+}
+exports.validateAndParseAddress = validateAndParseAddress;
+function parseBigintIsh(bigintIsh) {
+    return bigintIsh instanceof jsbi_1.default
+        ? bigintIsh
+        : typeof bigintIsh === 'bigint'
+            ? jsbi_1.default.BigInt(bigintIsh.toString())
+            : jsbi_1.default.BigInt(bigintIsh);
+}
+exports.parseBigintIsh = parseBigintIsh;
+// mock the on-chain sqrt function
+function sqrt(y) {
+    validateSolidityTypeInstance(y, constants_1.SolidityType.uint256);
+    var z = constants_1.ZERO;
+    var x;
+    if (jsbi_1.default.greaterThan(y, constants_1.THREE)) {
+        z = y;
+        x = jsbi_1.default.add(jsbi_1.default.divide(y, constants_1.TWO), constants_1.ONE);
+        while (jsbi_1.default.lessThan(x, z)) {
+            z = x;
+            x = jsbi_1.default.divide(jsbi_1.default.add(jsbi_1.default.divide(y, x), x), constants_1.TWO);
+        }
+    }
+    else if (jsbi_1.default.notEqual(y, constants_1.ZERO)) {
+        z = constants_1.ONE;
+    }
+    return z;
+}
+exports.sqrt = sqrt;
+// given an array of items sorted by `comparator`, insert an item into its sort index and constrain the size to
+// `maxSize` by removing the last item
+function sortedInsert(items, add, maxSize, comparator) {
+    (0, tiny_invariant_1.default)(maxSize > 0, 'MAX_SIZE_ZERO');
+    // this is an invariant because the interface cannot return multiple removed items if items.length exceeds maxSize
+    (0, tiny_invariant_1.default)(items.length <= maxSize, 'ITEMS_SIZE');
+    // short circuit first item add
+    if (items.length === 0) {
+        items.push(add);
+        return null;
+    }
+    else {
+        var isFull = items.length === maxSize;
+        // short circuit if full and the additional item does not come before the last item
+        if (isFull && comparator(items[items.length - 1], add) <= 0) {
+            return add;
+        }
+        var lo = 0, hi = items.length;
+        while (lo < hi) {
+            var mid = (lo + hi) >>> 1;
+            if (comparator(items[mid], add) <= 0) {
+                lo = mid + 1;
+            }
+            else {
+                hi = mid;
+            }
+        }
+        items.splice(lo, 0, add);
+        return isFull ? items.pop() : null;
+    }
+}
+exports.sortedInsert = sortedInsert;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openocean.finance/openocean-sdk",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Openocean sdk",
   "main": "lib/index.js",
   "scripts": {
@@ -50,6 +50,7 @@
     "@looksrare/sdk": "^0.12.1",
     "@openocean.finance/wallet": "^1.2.1",
     "@solana/buffer-layout": "^4.0.0",
+    "@uniswap/v2-core": "^1.0.1",
     "@walletconnect/web3-provider": "^1.7.8",
     "aptos": "^1.3.17",
     "bs58": "^4.0.1",
@@ -58,6 +59,7 @@
     "class-validator": "^0.13.2",
     "eth-sig-util": "^3.0.1",
     "fs": "^0.0.1-security",
+    "jsbi": "^4.3.0",
     "json-loader": "^0.5.7",
     "nifty-protocol": "^1.0.62",
     "node-polyfill-webpack-plugin": "^1.1.4",
@@ -65,6 +67,7 @@
     "path-browserify": "^1.0.1",
     "prompts": "^2.4.1",
     "reflect-metadata": "^0.1.13",
+    "tiny-warning": "^1.0.3",
     "vconsole": "^3.14.6",
     "web3": "^1.7.4",
     "yargs": "^17.0.1"

package/lib/index.js.LICENSE.txt

@@ -1,279 +0,0 @@
-/*
-object-assign
-(c) Sindre Sorhus
-@license MIT
-*/
-
-/*!
-   * mustache.js - Logic-less {{mustache}} templates with JavaScript
-   * http://github.com/janl/mustache.js
-   */
-
-/*!
- * Fast "async" scrypt implementation in JavaScript.
- * Copyright (c) 2013-2016 Dmitry Chestnykh | BSD License
- * https://github.com/dchest/scrypt-async-js
- */
-
-/*!
- * The buffer module from node.js, for the browser.
- *
- * @author   Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
- * @license  MIT
- */
-
-/*!
- * The buffer module from node.js, for the browser.
- *
- * @author   Feross Aboukhadijeh <https://feross.org>
- * @license  MIT
- */
-
-/*!
- * depd
- * Copyright(c) 2015 Douglas Christopher Wilson
- * MIT Licensed
- */
-
-/*!
- * http-errors
- * Copyright(c) 2014 Jonathan Ong
- * Copyright(c) 2016 Douglas Christopher Wilson
- * MIT Licensed
- */
-
-/*!
- * statuses
- * Copyright(c) 2014 Jonathan Ong
- * Copyright(c) 2016 Douglas Christopher Wilson
- * MIT Licensed
- */
-
-/*!
- * toidentifier
- * Copyright(c) 2016 Douglas Christopher Wilson
- * MIT Licensed
- */
-
-/*!
- * v2.1.4-104-gc868b3a
- * 
- */
-
-/*! *****************************************************************************
-Copyright (C) Microsoft. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-
-/*! @name pkcs7 @version 1.0.4 @license Apache-2.0 */
-
-/*! @ont-community/window-post-message-proxy v0.2.14 | (c) 2016 Microsoft Corporation MIT */
-
-/*! crc32.js (C) 2014-present SheetJS -- http://sheetjs.com */
-
-/*! https://mths.be/punycode v1.3.2 by @mathias */
-
-/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
-
-/*! noble-ed25519 - MIT License (c) 2019 Paul Miller (paulmillr.com) */
-
-/*! noble-hashes - MIT License (c) 2022 Paul Miller (paulmillr.com) */
-
-/*! noble-secp256k1 - MIT License (c) 2019 Paul Miller (paulmillr.com) */
-
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
-
-/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
-
-/*! scure-base - MIT License (c) 2022 Paul Miller (paulmillr.com) */
-
-/*! scure-bip39 - MIT License (c) 2022 Patricio Palladino, Paul Miller (paulmillr.com) */
-
-/*! websocket-as-promised v0.7.0 */
-
-/**
- * Support for translating between Uint8Array instances and JavaScript
- * native types.
- *
- * {@link module:Layout~Layout|Layout} is the basis of a class
- * hierarchy that associates property names with sequences of encoded
- * bytes.
- *
- * Layouts are supported for these scalar (numeric) types:
- * * {@link module:Layout~UInt|Unsigned integers in little-endian
- *   format} with {@link module:Layout.u8|8-bit}, {@link
- *   module:Layout.u16|16-bit}, {@link module:Layout.u24|24-bit},
- *   {@link module:Layout.u32|32-bit}, {@link
- *   module:Layout.u40|40-bit}, and {@link module:Layout.u48|48-bit}
- *   representation ranges;
- * * {@link module:Layout~UIntBE|Unsigned integers in big-endian
- *   format} with {@link module:Layout.u16be|16-bit}, {@link
- *   module:Layout.u24be|24-bit}, {@link module:Layout.u32be|32-bit},
- *   {@link module:Layout.u40be|40-bit}, and {@link
- *   module:Layout.u48be|48-bit} representation ranges;
- * * {@link module:Layout~Int|Signed integers in little-endian
- *   format} with {@link module:Layout.s8|8-bit}, {@link
- *   module:Layout.s16|16-bit}, {@link module:Layout.s24|24-bit},
- *   {@link module:Layout.s32|32-bit}, {@link
- *   module:Layout.s40|40-bit}, and {@link module:Layout.s48|48-bit}
- *   representation ranges;
- * * {@link module:Layout~IntBE|Signed integers in big-endian format}
- *   with {@link module:Layout.s16be|16-bit}, {@link
- *   module:Layout.s24be|24-bit}, {@link module:Layout.s32be|32-bit},
- *   {@link module:Layout.s40be|40-bit}, and {@link
- *   module:Layout.s48be|48-bit} representation ranges;
- * * 64-bit integral values that decode to an exact (if magnitude is
- *   less than 2^53) or nearby integral Number in {@link
- *   module:Layout.nu64|unsigned little-endian}, {@link
- *   module:Layout.nu64be|unsigned big-endian}, {@link
- *   module:Layout.ns64|signed little-endian}, and {@link
- *   module:Layout.ns64be|unsigned big-endian} encodings;
- * * 32-bit floating point values with {@link
- *   module:Layout.f32|little-endian} and {@link
- *   module:Layout.f32be|big-endian} representations;
- * * 64-bit floating point values with {@link
- *   module:Layout.f64|little-endian} and {@link
- *   module:Layout.f64be|big-endian} representations;
- * * {@link module:Layout.const|Constants} that take no space in the
- *   encoded expression.
- *
- * and for these aggregate types:
- * * {@link module:Layout.seq|Sequence}s of instances of a {@link
- *   module:Layout~Layout|Layout}, with JavaScript representation as
- *   an Array and constant or data-dependent {@link
- *   module:Layout~Sequence#count|length};
- * * {@link module:Layout.struct|Structure}s that aggregate a
- *   heterogeneous sequence of {@link module:Layout~Layout|Layout}
- *   instances, with JavaScript representation as an Object;
- * * {@link module:Layout.union|Union}s that support multiple {@link
- *   module:Layout~VariantLayout|variant layouts} over a fixed
- *   (padded) or variable (not padded) span of bytes, using an
- *   unsigned integer at the start of the data or a separate {@link
- *   module:Layout.unionLayoutDiscriminator|layout element} to
- *   determine which layout to use when interpreting the buffer
- *   contents;
- * * {@link module:Layout.bits|BitStructure}s that contain a sequence
- *   of individual {@link
- *   module:Layout~BitStructure#addField|BitField}s packed into an 8,
- *   16, 24, or 32-bit unsigned integer starting at the least- or
- *   most-significant bit;
- * * {@link module:Layout.cstr|C strings} of varying length;
- * * {@link module:Layout.blob|Blobs} of fixed- or variable-{@link
- *   module:Layout~Blob#length|length} raw data.
- *
- * All {@link module:Layout~Layout|Layout} instances are immutable
- * after construction, to prevent internal state from becoming
- * inconsistent.
- *
- * @local Layout
- * @local ExternalLayout
- * @local GreedyCount
- * @local OffsetLayout
- * @local UInt
- * @local UIntBE
- * @local Int
- * @local IntBE
- * @local NearUInt64
- * @local NearUInt64BE
- * @local NearInt64
- * @local NearInt64BE
- * @local Float
- * @local FloatBE
- * @local Double
- * @local DoubleBE
- * @local Sequence
- * @local Structure
- * @local UnionDiscriminator
- * @local UnionLayoutDiscriminator
- * @local Union
- * @local VariantLayout
- * @local BitStructure
- * @local BitField
- * @local Boolean
- * @local Blob
- * @local CString
- * @local Constant
- * @local bindConstructorLayout
- * @module Layout
- * @license MIT
- * @author Peter A. Bigot
- * @see {@link https://github.com/pabigot/buffer-layout|buffer-layout on GitHub}
- */
-
-/**
- * [js-sha256]{@link https://github.com/emn178/js-sha256}
- *
- * @version 0.9.0
- * @author Chen, Yi-Cyuan [emn178@gmail.com]
- * @copyright Chen, Yi-Cyuan 2014-2017
- * @license MIT
- */
-
-/**
- * [js-sha3]{@link https://github.com/emn178/js-sha3}
- *
- * @version 0.5.7
- * @author Chen, Yi-Cyuan [emn178@gmail.com]
- * @copyright Chen, Yi-Cyuan 2015-2016
- * @license MIT
- */
-
-/**
- * [js-sha3]{@link https://github.com/emn178/js-sha3}
- *
- * @version 0.7.0
- * @author Chen, Yi-Cyuan [emn178@gmail.com]
- * @copyright Chen, Yi-Cyuan 2015-2017
- * @license MIT
- */
-
-/**
- * [js-sha3]{@link https://github.com/emn178/js-sha3}
- *
- * @version 0.8.0
- * @author Chen, Yi-Cyuan [emn178@gmail.com]
- * @copyright Chen, Yi-Cyuan 2015-2018
- * @license MIT
- */
-
-/** @preserve
-	 * Counter block mode compatible with  Dr Brian Gladman fileenc.c
-	 * derived from CryptoJS.mode.CTR
-	 * Jan Hruby jhruby.web@gmail.com
-	 */
-
-/** @preserve
-	(c) 2012 by Cédric Mesnil. All rights reserved.
-
-	Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-	    - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-	    - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-	*/