@pioneer-platform/uniswap-client 0.0.21 → 0.0.24

package/lib/routing/clientSideSmartOrderRouter.d.ts

@@ -0,0 +1,5 @@
+import { ChainId } from '@uniswap/sdk-core';
+import { AlphaRouter, AlphaRouterConfig } from '@uniswap/smart-order-router';
+import { GetQuoteArgs, QuoteResult } from '../routing/types';
+export declare function getRouter(chainId: ChainId): AlphaRouter;
+export declare function getClientSideQuote({ tokenInAddress, tokenInChainId, tokenInDecimals, tokenInSymbol, tokenOutAddress, tokenOutChainId, tokenOutDecimals, tokenOutSymbol, amount, tradeType, }: GetQuoteArgs, router: AlphaRouter, config: Partial<AlphaRouterConfig>): Promise<QuoteResult>;

package/lib/routing/clientSideSmartOrderRouter.js

@@ -0,0 +1,136 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClientSideQuote = exports.getRouter = void 0;
+var sdk_core_1 = require("@uniswap/sdk-core");
+// This file is lazy-loaded, so the import of smart-order-router is intentional.
+// eslint-disable-next-line @typescript-eslint/no-restricted-imports
+var smart_order_router_1 = require("@uniswap/smart-order-router");
+var chains_1 = require("../constants/chains");
+var providers_1 = require("../constants/providers");
+var tokens_1 = require("../constants/tokens");
+var jsbi_1 = __importDefault(require("jsbi"));
+var types_1 = require("../routing/types");
+var transformSwapRouteToGetQuoteResult_1 = require("../utils/transformSwapRouteToGetQuoteResult");
+var CLIENT_SIDE_ROUTING_ALLOW_LIST = [
+    sdk_core_1.ChainId.MAINNET,
+    sdk_core_1.ChainId.OPTIMISM,
+    sdk_core_1.ChainId.OPTIMISM_GOERLI,
+    sdk_core_1.ChainId.ARBITRUM_ONE,
+    sdk_core_1.ChainId.ARBITRUM_GOERLI,
+    sdk_core_1.ChainId.POLYGON,
+    sdk_core_1.ChainId.POLYGON_MUMBAI,
+    sdk_core_1.ChainId.GOERLI,
+    sdk_core_1.ChainId.SEPOLIA,
+    sdk_core_1.ChainId.CELO_ALFAJORES,
+    sdk_core_1.ChainId.CELO,
+    sdk_core_1.ChainId.BNB,
+    sdk_core_1.ChainId.AVALANCHE,
+    sdk_core_1.ChainId.BASE,
+];
+var routers = new Map();
+function getRouter(chainId) {
+    var router = routers.get(chainId);
+    if (router)
+        return router;
+    var supportedChainId = (0, chains_1.asSupportedChain)(chainId);
+    if (supportedChainId && CLIENT_SIDE_ROUTING_ALLOW_LIST.includes(chainId)) {
+        var provider = providers_1.RPC_PROVIDERS[supportedChainId];
+        var router_1 = new smart_order_router_1.AlphaRouter({ chainId: chainId, provider: provider });
+        routers.set(chainId, router_1);
+        return router_1;
+    }
+    throw new Error("Router does not support this chain (chainId: ".concat(chainId, ")."));
+}
+exports.getRouter = getRouter;
+function getQuote(_a, router, routerConfig) {
+    var tradeType = _a.tradeType, tokenIn = _a.tokenIn, tokenOut = _a.tokenOut, amountRaw = _a.amount;
+    return __awaiter(this, void 0, void 0, function () {
+        var tokenInIsNative, tokenOutIsNative, currencyIn, currencyOut, baseCurrency, quoteCurrency, amount, swapRoute;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    tokenInIsNative = Object.values(types_1.SwapRouterNativeAssets).includes(tokenIn.address);
+                    tokenOutIsNative = Object.values(types_1.SwapRouterNativeAssets).includes(tokenOut.address);
+                    currencyIn = tokenInIsNative
+                        ? (0, tokens_1.nativeOnChain)(tokenIn.chainId)
+                        : new sdk_core_1.Token(tokenIn.chainId, tokenIn.address, tokenIn.decimals, tokenIn.symbol);
+                    currencyOut = tokenOutIsNative
+                        ? (0, tokens_1.nativeOnChain)(tokenOut.chainId)
+                        : new sdk_core_1.Token(tokenOut.chainId, tokenOut.address, tokenOut.decimals, tokenOut.symbol);
+                    baseCurrency = tradeType === sdk_core_1.TradeType.EXACT_INPUT ? currencyIn : currencyOut;
+                    quoteCurrency = tradeType === sdk_core_1.TradeType.EXACT_INPUT ? currencyOut : currencyIn;
+                    amount = sdk_core_1.CurrencyAmount.fromRawAmount(baseCurrency, jsbi_1.default.BigInt(amountRaw));
+                    return [4 /*yield*/, router.route(amount, quoteCurrency, tradeType, /*swapConfig=*/ undefined, routerConfig)];
+                case 1:
+                    swapRoute = _b.sent();
+                    if (!swapRoute) {
+                        return [2 /*return*/, { state: types_1.QuoteState.NOT_FOUND }];
+                    }
+                    return [2 /*return*/, (0, transformSwapRouteToGetQuoteResult_1.transformSwapRouteToGetQuoteResult)(tradeType, amount, swapRoute)];
+            }
+        });
+    });
+}
+function getClientSideQuote(_a, router, config) {
+    var tokenInAddress = _a.tokenInAddress, tokenInChainId = _a.tokenInChainId, tokenInDecimals = _a.tokenInDecimals, tokenInSymbol = _a.tokenInSymbol, tokenOutAddress = _a.tokenOutAddress, tokenOutChainId = _a.tokenOutChainId, tokenOutDecimals = _a.tokenOutDecimals, tokenOutSymbol = _a.tokenOutSymbol, amount = _a.amount, tradeType = _a.tradeType;
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_b) {
+            return [2 /*return*/, getQuote({
+                    tradeType: tradeType,
+                    tokenIn: {
+                        address: tokenInAddress,
+                        chainId: tokenInChainId,
+                        decimals: tokenInDecimals,
+                        symbol: tokenInSymbol,
+                    },
+                    tokenOut: {
+                        address: tokenOutAddress,
+                        chainId: tokenOutChainId,
+                        decimals: tokenOutDecimals,
+                        symbol: tokenOutSymbol,
+                    },
+                    amount: amount,
+                }, router, config)];
+        });
+    });
+}
+exports.getClientSideQuote = getClientSideQuote;

package/lib/routing/gas.d.ts

@@ -0,0 +1,5 @@
+import { Currency } from '@uniswap/sdk-core';
+import { SupportedInterfaceChain } from '../constants/chains';
+import { ApproveInfo, WrapInfo } from './types';
+export declare function getApproveInfo(account: string | undefined, currency: Currency, amount: string, usdCostPerGas?: number): Promise<ApproveInfo>;
+export declare function getWrapInfo(needsWrap: boolean, account: string | undefined, chainId: SupportedInterfaceChain, amount: string, usdCostPerGas?: number): Promise<WrapInfo>;

package/lib/routing/gas.js

@@ -0,0 +1,158 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWrapInfo = exports.getApproveInfo = void 0;
+var permit2_sdk_1 = require("@uniswap/permit2-sdk");
+var sdk_core_1 = require("@uniswap/sdk-core");
+var providers_1 = require("../constants/providers");
+var tokens_1 = require("../constants/tokens");
+var erc20_json_1 = __importDefault(require("../uniswap/src/abis/erc20.json"));
+var weth_json_1 = __importDefault(require("../uniswap/src/abis/weth.json"));
+var getContract_1 = require("../utils/contracts/getContract");
+// TODO(UniswapX): add fallback gas limits per chain? l2s have higher costs
+var WRAP_FALLBACK_GAS_LIMIT = 45000;
+var APPROVE_FALLBACK_GAS_LIMIT = 65000;
+function getApproveInfo(account, currency, amount, usdCostPerGas) {
+    return __awaiter(this, void 0, void 0, function () {
+        var provider, tokenContract, approveGasUseEstimate, allowance, _1, approveTx, _2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    // native currencies do not need token approvals
+                    if (currency.isNative)
+                        return [2 /*return*/, { needsApprove: false }
+                            // If any of these arguments aren't provided, then we cannot generate approval cost info
+                        ];
+                    // If any of these arguments aren't provided, then we cannot generate approval cost info
+                    if (!account || !usdCostPerGas)
+                        return [2 /*return*/, { needsApprove: false }
+                            // routing-api under estimates gas for Arbitrum swaps so it inflates cost per gas by a lot
+                            // so disable showing approves for Arbitrum until routing-api gives more accurate gas estimates
+                        ];
+                    // routing-api under estimates gas for Arbitrum swaps so it inflates cost per gas by a lot
+                    // so disable showing approves for Arbitrum until routing-api gives more accurate gas estimates
+                    if (currency.chainId === sdk_core_1.ChainId.ARBITRUM_ONE || currency.chainId === sdk_core_1.ChainId.ARBITRUM_GOERLI) {
+                        return [2 /*return*/, { needsApprove: false }];
+                    }
+                    provider = providers_1.RPC_PROVIDERS[currency.chainId];
+                    tokenContract = (0, getContract_1.getContract)(currency.address, erc20_json_1.default, provider);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, tokenContract.callStatic.allowance(account, permit2_sdk_1.PERMIT2_ADDRESS)];
+                case 2:
+                    allowance = _a.sent();
+                    if (!allowance.lt(amount))
+                        return [2 /*return*/, { needsApprove: false }];
+                    return [3 /*break*/, 4];
+                case 3:
+                    _1 = _a.sent();
+                    // If contract lookup fails (eg if Infura goes down), then don't show gas info for approving the token
+                    return [2 /*return*/, { needsApprove: false }];
+                case 4:
+                    _a.trys.push([4, 7, , 8]);
+                    return [4 /*yield*/, tokenContract.populateTransaction.approve(permit2_sdk_1.PERMIT2_ADDRESS, permit2_sdk_1.MaxUint256)];
+                case 5:
+                    approveTx = _a.sent();
+                    return [4 /*yield*/, provider.estimateGas(__assign({ from: account }, approveTx))];
+                case 6:
+                    approveGasUseEstimate = (_a.sent()).toNumber();
+                    return [3 /*break*/, 8];
+                case 7:
+                    _2 = _a.sent();
+                    // estimateGas will error if the account doesn't have sufficient token balance, but we should show an estimated cost anyway
+                    approveGasUseEstimate = APPROVE_FALLBACK_GAS_LIMIT;
+                    return [3 /*break*/, 8];
+                case 8: return [2 /*return*/, { needsApprove: true, approveGasEstimateUSD: approveGasUseEstimate * usdCostPerGas }];
+            }
+        });
+    });
+}
+exports.getApproveInfo = getApproveInfo;
+function getWrapInfo(needsWrap, account, chainId, amount, usdCostPerGas) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function () {
+        var provider, wethAddress, wrapGasUseEstimate, wethContract, wethTx, _3;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!needsWrap)
+                        return [2 /*return*/, { needsWrap: false }];
+                    provider = providers_1.RPC_PROVIDERS[chainId];
+                    wethAddress = (_a = tokens_1.WRAPPED_NATIVE_CURRENCY[chainId]) === null || _a === void 0 ? void 0 : _a.address;
+                    // If any of these arguments aren't provided, then we cannot generate wrap cost info
+                    if (!wethAddress || !usdCostPerGas)
+                        return [2 /*return*/, { needsWrap: false }];
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 4, , 5]);
+                    wethContract = (0, getContract_1.getContract)(wethAddress, weth_json_1.default, provider, account);
+                    return [4 /*yield*/, wethContract.populateTransaction.deposit({ value: amount })
+                        // estimateGas will error if the account doesn't have sufficient ETH balance, but we should show an estimated cost anyway
+                    ];
+                case 2:
+                    wethTx = _b.sent();
+                    return [4 /*yield*/, provider.estimateGas(__assign({ from: account }, wethTx))];
+                case 3:
+                    // estimateGas will error if the account doesn't have sufficient ETH balance, but we should show an estimated cost anyway
+                    wrapGasUseEstimate = (_b.sent()).toNumber();
+                    return [3 /*break*/, 5];
+                case 4:
+                    _3 = _b.sent();
+                    wrapGasUseEstimate = WRAP_FALLBACK_GAS_LIMIT;
+                    return [3 /*break*/, 5];
+                case 5: return [2 /*return*/, { needsWrap: true, wrapGasEstimateUSD: wrapGasUseEstimate * usdCostPerGas }];
+            }
+        });
+    });
+}
+exports.getWrapInfo = getWrapInfo;