@synthra-swap/sdk 0.1.4

package/dist/core/utils/sortedInsert.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortedInsert = void 0;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+// 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 {
+        const 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;
+        }
+        let lo = 0, hi = items.length;
+        while (lo < hi) {
+            const 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;
+//# sourceMappingURL=sortedInsert.js.map

package/dist/core/utils/sortedInsert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortedInsert.js","sourceRoot":"","sources":["../../../src/core/utils/sortedInsert.ts"],"names":[],"mappings":";;;;;;AAAA,oEAAsC;AAEtC,+GAA+G;AAC/G,sCAAsC;AACtC,SAAgB,YAAY,CAAI,KAAU,EAAE,GAAM,EAAE,OAAe,EAAE,UAAkC;IACrG,IAAA,wBAAS,EAAC,OAAO,GAAG,CAAC,EAAE,eAAe,CAAC,CAAA;IACvC,kHAAkH;IAClH,IAAA,wBAAS,EAAC,KAAK,CAAC,MAAM,IAAI,OAAO,EAAE,YAAY,CAAC,CAAA;IAEhD,+BAA+B;IAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACf,OAAO,IAAI,CAAA;KACZ;SAAM;QACL,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,KAAK,OAAO,CAAA;QACvC,mFAAmF;QACnF,IAAI,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3D,OAAO,GAAG,CAAA;SACX;QAED,IAAI,EAAE,GAAG,CAAC,EACR,EAAE,GAAG,KAAK,CAAC,MAAM,CAAA;QAEnB,OAAO,EAAE,GAAG,EAAE,EAAE;YACd,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAA;YAC3B,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;gBACpC,EAAE,GAAG,GAAG,GAAG,CAAC,CAAA;aACb;iBAAM;gBACL,EAAE,GAAG,GAAG,CAAA;aACT;SACF;QACD,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA;QACxB,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAG,CAAC,CAAC,CAAC,IAAI,CAAA;KACpC;AACH,CAAC;AA9BD,oCA8BC"}

package/dist/core/utils/sqrt.d.ts

@@ -0,0 +1,7 @@
+import JSBI from 'jsbi';
+export declare const MAX_SAFE_INTEGER: JSBI;
+/**
+ * Computes floor(sqrt(value))
+ * @param value the value for which to compute the square root, rounded down
+ */
+export declare function sqrt(value: JSBI): JSBI;

package/dist/core/utils/sqrt.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sqrt = exports.MAX_SAFE_INTEGER = void 0;
+const jsbi_1 = __importDefault(require("jsbi"));
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+exports.MAX_SAFE_INTEGER = jsbi_1.default.BigInt(Number.MAX_SAFE_INTEGER);
+const ZERO = jsbi_1.default.BigInt(0);
+const ONE = jsbi_1.default.BigInt(1);
+const TWO = jsbi_1.default.BigInt(2);
+/**
+ * Computes floor(sqrt(value))
+ * @param value the value for which to compute the square root, rounded down
+ */
+function sqrt(value) {
+    (0, tiny_invariant_1.default)(jsbi_1.default.greaterThanOrEqual(value, ZERO), 'NEGATIVE');
+    // rely on built in sqrt if possible
+    if (jsbi_1.default.lessThan(value, exports.MAX_SAFE_INTEGER)) {
+        return jsbi_1.default.BigInt(Math.floor(Math.sqrt(jsbi_1.default.toNumber(value))));
+    }
+    let z;
+    let x;
+    z = value;
+    x = jsbi_1.default.add(jsbi_1.default.divide(value, TWO), ONE);
+    while (jsbi_1.default.lessThan(x, z)) {
+        z = x;
+        x = jsbi_1.default.divide(jsbi_1.default.add(jsbi_1.default.divide(value, x), x), TWO);
+    }
+    return z;
+}
+exports.sqrt = sqrt;
+//# sourceMappingURL=sqrt.js.map

package/dist/core/utils/sqrt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqrt.js","sourceRoot":"","sources":["../../../src/core/utils/sqrt.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AACvB,oEAAsC;AAEzB,QAAA,gBAAgB,GAAG,cAAI,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;AAEpE,MAAM,IAAI,GAAG,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAC3B,MAAM,GAAG,GAAG,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAC1B,MAAM,GAAG,GAAG,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAE1B;;;GAGG;AACH,SAAgB,IAAI,CAAC,KAAW;IAC9B,IAAA,wBAAS,EAAC,cAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,CAAA;IAE3D,oCAAoC;IACpC,IAAI,cAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,wBAAgB,CAAC,EAAE;QAC1C,OAAO,cAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;KAChE;IAED,IAAI,CAAO,CAAA;IACX,IAAI,CAAO,CAAA;IACX,CAAC,GAAG,KAAK,CAAA;IACT,CAAC,GAAG,cAAI,CAAC,GAAG,CAAC,cAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IAC1C,OAAO,cAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;QAC1B,CAAC,GAAG,CAAC,CAAA;QACL,CAAC,GAAG,cAAI,CAAC,MAAM,CAAC,cAAI,CAAC,GAAG,CAAC,cAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;KACzD;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAjBD,oBAiBC"}

package/dist/core/utils/validateAndParseAddress.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Validates an address and returns the parsed (checksummed) version of that address
+ * @param address the unchecksummed hex address
+ */
+export declare function validateAndParseAddress(address: string): string;
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+export declare function checkValidAddress(address: string): string;

package/dist/core/utils/validateAndParseAddress.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkValidAddress = exports.validateAndParseAddress = void 0;
+const address_1 = require("@ethersproject/address");
+/**
+ * Validates an address and returns the parsed (checksummed) version of that address
+ * @param address the unchecksummed hex address
+ */
+function validateAndParseAddress(address) {
+    try {
+        return (0, address_1.getAddress)(address);
+    }
+    catch (error) {
+        throw new Error(`${address} is not a valid address.`);
+    }
+}
+exports.validateAndParseAddress = validateAndParseAddress;
+// Checks a string starts with 0x, is 42 characters long and contains only hex characters after 0x
+const startsWith0xLen42HexRegex = /^0x[0-9a-fA-F]{40}$/;
+/**
+ * Checks if an address is valid by checking 0x prefix, length === 42 and hex encoding.
+ * @param address the unchecksummed hex address
+ */
+function checkValidAddress(address) {
+    if (startsWith0xLen42HexRegex.test(address)) {
+        return address;
+    }
+    throw new Error(`${address} is not a valid address.`);
+}
+exports.checkValidAddress = checkValidAddress;
+//# sourceMappingURL=validateAndParseAddress.js.map

package/dist/core/utils/validateAndParseAddress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateAndParseAddress.js","sourceRoot":"","sources":["../../../src/core/utils/validateAndParseAddress.ts"],"names":[],"mappings":";;;AAAA,oDAAmD;AAEnD;;;GAGG;AACH,SAAgB,uBAAuB,CAAC,OAAe;IACrD,IAAI;QACF,OAAO,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAA;KAC3B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,0BAA0B,CAAC,CAAA;KACtD;AACH,CAAC;AAND,0DAMC;AAED,kGAAkG;AAClG,MAAM,yBAAyB,GAAG,qBAAqB,CAAA;AAEvD;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAC/C,IAAI,yBAAyB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;QAC3C,OAAO,OAAO,CAAA;KACf;IAED,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,0BAA0B,CAAC,CAAA;AACvD,CAAC;AAND,8CAMC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * as Core from './core';
+export * as V3 from './v3';
+export * as UniversalRouter from './universal-router';
+export * from './core';

package/dist/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UniversalRouter = exports.V3 = exports.Core = void 0;
+exports.Core = __importStar(require("./core"));
+exports.V3 = __importStar(require("./v3"));
+exports.UniversalRouter = __importStar(require("./universal-router"));
+__exportStar(require("./core"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA8B;AAC9B,2CAA0B;AAC1B,sEAAqD;AACrD,yCAAsB"}

package/dist/universal-router/entities/Command.d.ts

@@ -0,0 +1,12 @@
+import { RoutePlanner } from '../utils/routerCommands';
+export type TradeConfig = {
+    allowRevert: boolean;
+};
+export declare enum RouterTradeType {
+    UniswapTrade = "UniswapTrade",
+    UnwrapWETH = "UnwrapWETH"
+}
+export interface Command {
+    tradeType: RouterTradeType;
+    encode(planner: RoutePlanner, config: TradeConfig): void;
+}

package/dist/universal-router/entities/Command.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouterTradeType = void 0;
+var RouterTradeType;
+(function (RouterTradeType) {
+    RouterTradeType["UniswapTrade"] = "UniswapTrade";
+    RouterTradeType["UnwrapWETH"] = "UnwrapWETH";
+})(RouterTradeType = exports.RouterTradeType || (exports.RouterTradeType = {}));
+//# sourceMappingURL=Command.js.map

package/dist/universal-router/entities/Command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Command.js","sourceRoot":"","sources":["../../../src/universal-router/entities/Command.ts"],"names":[],"mappings":";;;AAMA,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gDAA6B,CAAA;IAC7B,4CAAyB,CAAA;AAC3B,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B"}

package/dist/universal-router/entities/index.d.ts

@@ -0,0 +1,3 @@
+export * from './trade';
+export * from './protocols';
+export * from './Command';

package/dist/universal-router/entities/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./trade"), exports);
+__exportStar(require("./protocols"), exports);
+__exportStar(require("./Command"), exports);
+//# sourceMappingURL=index.js.map

package/dist/universal-router/entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/universal-router/entities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,8CAA2B;AAC3B,4CAAyB"}

package/dist/universal-router/entities/protocols/index.d.ts

@@ -0,0 +1,2 @@
+export * from './uniswap';
+export * from './unwrapWETH';

package/dist/universal-router/entities/protocols/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./uniswap"), exports);
+__exportStar(require("./unwrapWETH"), exports);
+//# sourceMappingURL=index.js.map

package/dist/universal-router/entities/protocols/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/universal-router/entities/protocols/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,+CAA4B"}

package/dist/universal-router/entities/protocols/uniswap.d.ts

@@ -0,0 +1,32 @@
+import { RoutePlanner } from '../../utils/routerCommands';
+import { Permit2Permit } from '../../utils/inputTokens';
+import { Currency, TradeType, Percent } from '../../../core';
+import { Command, RouterTradeType, TradeConfig } from '../Command';
+import { SynthraTrade } from '../trade';
+import { BigNumberish } from 'ethers';
+export type FlatFeeOptions = {
+    amount: BigNumberish;
+    recipient: string;
+};
+export type SwapOptions = {
+    slippageTolerance: Percent;
+    recipient?: string;
+    deadlineOrPreviousBlockhash?: BigNumberish;
+    fee?: {
+        fee: Percent;
+        recipient: string;
+    };
+    useRouterBalance?: boolean;
+    inputTokenPermit?: Permit2Permit;
+    flatFee?: FlatFeeOptions;
+    safeMode?: boolean;
+};
+export declare class UniswapTrade implements Command {
+    trade: SynthraTrade<Currency, Currency, TradeType>;
+    options: SwapOptions;
+    readonly tradeType: RouterTradeType;
+    readonly payerIsUser: boolean;
+    constructor(trade: SynthraTrade<Currency, Currency, TradeType>, options: SwapOptions);
+    get inputRequiresWrap(): boolean;
+    encode(planner: RoutePlanner, _config: TradeConfig): void;
+}

package/dist/universal-router/entities/protocols/uniswap.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UniswapTrade = void 0;
+const routerCommands_1 = require("../../utils/routerCommands");
+const v3_1 = require("../../../v3");
+const core_1 = require("../../../core");
+const Command_1 = require("../Command");
+const constants_1 = require("../../utils/constants");
+const numbers_1 = require("../../utils/numbers");
+const ethers_1 = require("ethers");
+const REFUND_ETH_PRICE_IMPACT_THRESHOLD = new core_1.Percent(50, 100);
+class UniswapTrade {
+    constructor(trade, options) {
+        this.trade = trade;
+        this.options = options;
+        this.tradeType = Command_1.RouterTradeType.UniswapTrade;
+        if (!!options.fee && !!options.flatFee)
+            throw new Error('Only one fee option permitted');
+        if (this.inputRequiresWrap)
+            this.payerIsUser = false;
+        else if (this.options.useRouterBalance)
+            this.payerIsUser = false;
+        else
+            this.payerIsUser = true;
+    }
+    get inputRequiresWrap() {
+        return this.trade.inputAmount.currency.isNative;
+    }
+    encode(planner, _config) {
+        var _a;
+        // If the input currency is the native currency, we need to wrap it with the router as the recipient
+        if (this.inputRequiresWrap) {
+            planner.addCommand(routerCommands_1.CommandType.WRAP_ETH, [
+                constants_1.ROUTER_AS_RECIPIENT,
+                this.trade.maximumAmountIn(this.options.slippageTolerance).quotient.toString(),
+            ]);
+        }
+        // The overall recipient at the end of the trade, SENDER_AS_RECIPIENT uses the msg.sender
+        this.options.recipient = (_a = this.options.recipient) !== null && _a !== void 0 ? _a : constants_1.SENDER_AS_RECIPIENT;
+        // flag for whether we want to perform slippage check on aggregate output of multiple routes
+        //   1. when there are >2 exact input trades. this is only a heuristic,
+        //      as it's still more gas-expensive even in this case, but has benefits
+        //      in that the reversion probability is lower
+        const performAggregatedSlippageCheck = this.trade.tradeType === core_1.TradeType.EXACT_INPUT && this.trade.routes.length > 2;
+        const outputIsNative = this.trade.outputAmount.currency.isNative;
+        const routerMustCustody = performAggregatedSlippageCheck || outputIsNative || hasFeeOption(this.options);
+        for (const swap of this.trade.swaps) {
+            addV3Swap(planner, swap, this.trade.tradeType, this.options, this.payerIsUser, routerMustCustody);
+        }
+        let minimumAmountOut = ethers_1.BigNumber.from(this.trade.minimumAmountOut(this.options.slippageTolerance).quotient.toString());
+        // The router custodies for 3 reasons: to unwrap, to take a fee, and/or to do a slippage check
+        if (routerMustCustody) {
+            // If there is a fee, that percentage is sent to the fee recipient
+            // In the case where ETH is the output currency, the fee is taken in WETH (for gas reasons)
+            if (!!this.options.fee) {
+                const feeBips = (0, numbers_1.encodeFeeBips)(this.options.fee.fee);
+                planner.addCommand(routerCommands_1.CommandType.PAY_PORTION, [
+                    this.trade.outputAmount.currency.wrapped.address,
+                    this.options.fee.recipient,
+                    feeBips,
+                ]);
+                // If the trade is exact output, and a fee was taken, we must adjust the amount out to be the amount after the fee
+                // Otherwise we continue as expected with the trade's normal expected output
+                if (this.trade.tradeType === core_1.TradeType.EXACT_OUTPUT) {
+                    minimumAmountOut = minimumAmountOut.sub(minimumAmountOut.mul(feeBips).div(10000));
+                }
+            }
+            // If there is a flat fee, that absolute amount is sent to the fee recipient
+            // In the case where ETH is the output currency, the fee is taken in WETH (for gas reasons)
+            if (!!this.options.flatFee) {
+                const feeAmount = this.options.flatFee.amount;
+                if (minimumAmountOut.lt(feeAmount))
+                    throw new Error('Flat fee amount greater than minimumAmountOut');
+                planner.addCommand(routerCommands_1.CommandType.TRANSFER, [
+                    this.trade.outputAmount.currency.wrapped.address,
+                    this.options.flatFee.recipient,
+                    feeAmount,
+                ]);
+                // If the trade is exact output, and a fee was taken, we must adjust the amount out to be the amount after the fee
+                // Otherwise we continue as expected with the trade's normal expected output
+                if (this.trade.tradeType === core_1.TradeType.EXACT_OUTPUT) {
+                    minimumAmountOut = minimumAmountOut.sub(feeAmount);
+                }
+            }
+            // The remaining tokens that need to be sent to the user after the fee is taken will be caught
+            // by this if-else clause.
+            if (outputIsNative) {
+                planner.addCommand(routerCommands_1.CommandType.UNWRAP_WETH, [this.options.recipient, minimumAmountOut]);
+            }
+            else {
+                planner.addCommand(routerCommands_1.CommandType.SWEEP, [
+                    this.trade.outputAmount.currency.wrapped.address,
+                    this.options.recipient,
+                    minimumAmountOut,
+                ]);
+            }
+        }
+        if (this.inputRequiresWrap && (this.trade.tradeType === core_1.TradeType.EXACT_OUTPUT || riskOfPartialFill(this.trade))) {
+            // for exactOutput swaps that take native currency as input
+            // we need to send back the change to the user
+            planner.addCommand(routerCommands_1.CommandType.UNWRAP_WETH, [this.options.recipient, 0]);
+        }
+        if (this.options.safeMode)
+            planner.addCommand(routerCommands_1.CommandType.SWEEP, [constants_1.ETH_ADDRESS, this.options.recipient, 0]);
+    }
+}
+exports.UniswapTrade = UniswapTrade;
+// encode a V3 swap
+function addV3Swap(planner, { route, inputAmount, outputAmount }, tradeType, options, payerIsUser, routerMustCustody) {
+    const trade = v3_1.Trade.createUncheckedTrade({
+        route,
+        inputAmount,
+        outputAmount,
+        tradeType,
+    });
+    const path = (0, v3_1.encodeRouteToPath)(route, trade.tradeType === core_1.TradeType.EXACT_OUTPUT);
+    if (tradeType == core_1.TradeType.EXACT_INPUT) {
+        planner.addCommand(routerCommands_1.CommandType.V3_SWAP_EXACT_IN, [
+            routerMustCustody ? constants_1.ROUTER_AS_RECIPIENT : options.recipient,
+            trade.maximumAmountIn(options.slippageTolerance).quotient.toString(),
+            trade.minimumAmountOut(options.slippageTolerance).quotient.toString(),
+            path,
+            payerIsUser,
+        ]);
+    }
+    else if (tradeType == core_1.TradeType.EXACT_OUTPUT) {
+        planner.addCommand(routerCommands_1.CommandType.V3_SWAP_EXACT_OUT, [
+            routerMustCustody ? constants_1.ROUTER_AS_RECIPIENT : options.recipient,
+            trade.minimumAmountOut(options.slippageTolerance).quotient.toString(),
+            trade.maximumAmountIn(options.slippageTolerance).quotient.toString(),
+            path,
+            payerIsUser,
+        ]);
+    }
+}
+// if price impact is very high, there's a chance of hitting max/min prices resulting in a partial fill of the swap
+function riskOfPartialFill(trade) {
+    return trade.priceImpact.greaterThan(REFUND_ETH_PRICE_IMPACT_THRESHOLD);
+}
+function hasFeeOption(swapOptions) {
+    return !!swapOptions.fee || !!swapOptions.flatFee;
+}
+//# sourceMappingURL=uniswap.js.map

package/dist/universal-router/entities/protocols/uniswap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniswap.js","sourceRoot":"","sources":["../../../../src/universal-router/entities/protocols/uniswap.ts"],"names":[],"mappings":";;;AAAA,+DAAsE;AACtE,oCAAmF;AAEnF,wCAA4E;AAC5E,wCAAkE;AAElE,qDAA6F;AAC7F,iDAAmD;AACnD,mCAAgD;AAqBhD,MAAM,iCAAiC,GAAG,IAAI,cAAO,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;AAQ9D,MAAa,YAAY;IAIvB,YAAmB,KAAkD,EAAS,OAAoB;QAA/E,UAAK,GAAL,KAAK,CAA6C;QAAS,YAAO,GAAP,OAAO,CAAa;QAHzF,cAAS,GAAoB,yBAAe,CAAC,YAAY,CAAA;QAIhE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAExF,IAAI,IAAI,CAAC,iBAAiB;YAAE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;aAC/C,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB;YAAE,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;;YAC3D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;IAC9B,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAA;IACjD,CAAC;IAED,MAAM,CAAC,OAAqB,EAAE,OAAoB;;QAChD,oGAAoG;QACpG,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,QAAQ,EAAE;gBACvC,+BAAmB;gBACnB,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;aAC/E,CAAC,CAAA;SACH;QACD,yFAAyF;QACzF,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,SAAS,mCAAI,+BAAmB,CAAA;QAEtE,4FAA4F;QAC5F,uEAAuE;QACvE,4EAA4E;QAC5E,kDAAkD;QAClD,MAAM,8BAA8B,GAClC,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,gBAAS,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;QAChF,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAA;QAChE,MAAM,iBAAiB,GAAG,8BAA8B,IAAI,cAAc,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAExG,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,KAA8C,EAAE;YAC5E,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAA;SAClG;QAED,IAAI,gBAAgB,GAAc,kBAAS,CAAC,IAAI,CAC9C,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAChF,CAAA;QAED,8FAA8F;QAC9F,IAAI,iBAAiB,EAAE;YACrB,kEAAkE;YAClE,2FAA2F;YAC3F,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;gBACtB,MAAM,OAAO,GAAG,IAAA,uBAAa,EAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBACnD,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,WAAW,EAAE;oBAC1C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO;oBAChD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS;oBAC1B,OAAO;iBACR,CAAC,CAAA;gBAEF,kHAAkH;gBAClH,4EAA4E;gBAC5E,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,gBAAS,CAAC,YAAY,EAAE;oBACnD,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAA;iBAClF;aACF;YAED,4EAA4E;YAC5E,2FAA2F;YAC3F,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAA;gBAC7C,IAAI,gBAAgB,CAAC,EAAE,CAAC,SAAS,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;gBAEpG,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,QAAQ,EAAE;oBACvC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO;oBAChD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS;oBAC9B,SAAS;iBACV,CAAC,CAAA;gBAEF,kHAAkH;gBAClH,4EAA4E;gBAC5E,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,gBAAS,CAAC,YAAY,EAAE;oBACnD,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;iBACnD;aACF;YAED,8FAA8F;YAC9F,0BAA0B;YAC1B,IAAI,cAAc,EAAE;gBAClB,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAA;aACxF;iBAAM;gBACL,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,KAAK,EAAE;oBACpC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO;oBAChD,IAAI,CAAC,OAAO,CAAC,SAAS;oBACtB,gBAAgB;iBACjB,CAAC,CAAA;aACH;SACF;QAED,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,gBAAS,CAAC,YAAY,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE;YAChH,2DAA2D;YAC3D,8CAA8C;YAC9C,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAA;SACzE;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ;YAAE,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,KAAK,EAAE,CAAC,uBAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5G,CAAC;CACF;AAvGD,oCAuGC;AAED,mBAAmB;AACnB,SAAS,SAAS,CAChB,OAAqB,EACrB,EAAE,KAAK,EAAE,WAAW,EAAE,YAAY,EAAyB,EAC3D,SAAoB,EACpB,OAAoB,EACpB,WAAoB,EACpB,iBAA0B;IAE1B,MAAM,KAAK,GAAG,UAAO,CAAC,oBAAoB,CAAC;QACzC,KAAK;QACL,WAAW;QACX,YAAY;QACZ,SAAS;KACV,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,IAAA,sBAAiB,EAC5B,KAAK,EACL,KAAK,CAAC,SAAS,KAAK,gBAAS,CAAC,YAAY,CAC3C,CAAA;IACD,IAAI,SAAS,IAAI,gBAAS,CAAC,WAAW,EAAE;QACtC,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,gBAAgB,EAAE;YAC/C,iBAAiB,CAAC,CAAC,CAAC,+BAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS;YAC3D,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACpE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACrE,IAAI;YACJ,WAAW;SACZ,CAAC,CAAA;KACH;SAAM,IAAI,SAAS,IAAI,gBAAS,CAAC,YAAY,EAAE;QAC9C,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,iBAAiB,EAAE;YAChD,iBAAiB,CAAC,CAAC,CAAC,+BAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS;YAC3D,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACrE,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACpE,IAAI;YACJ,WAAW;SACZ,CAAC,CAAA;KACH;AACH,CAAC;AAED,mHAAmH;AACnH,SAAS,iBAAiB,CAAC,KAAkD;IAC3E,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAA;AACzE,CAAC;AAED,SAAS,YAAY,CAAC,WAAwB;IAC5C,OAAO,CAAC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,WAAW,CAAC,OAAO,CAAA;AACnD,CAAC"}

package/dist/universal-router/entities/protocols/unwrapWETH.d.ts

@@ -0,0 +1,12 @@
+import { BigNumberish } from 'ethers';
+import { RoutePlanner } from '../../utils/routerCommands';
+import { Permit2Permit } from '../../utils/inputTokens';
+import { Command, RouterTradeType, TradeConfig } from '../Command';
+export declare class UnwrapWETH implements Command {
+    readonly tradeType: RouterTradeType;
+    readonly permit2Data: Permit2Permit;
+    readonly wethAddress: string;
+    readonly amount: BigNumberish;
+    constructor(amount: BigNumberish, chainId: number, permit2?: Permit2Permit);
+    encode(planner: RoutePlanner, _: TradeConfig): void;
+}

package/dist/universal-router/entities/protocols/unwrapWETH.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnwrapWETH = void 0;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const routerCommands_1 = require("../../utils/routerCommands");
+const inputTokens_1 = require("../../utils/inputTokens");
+const Command_1 = require("../Command");
+const constants_1 = require("../../utils/constants");
+class UnwrapWETH {
+    constructor(amount, chainId, permit2) {
+        this.tradeType = Command_1.RouterTradeType.UnwrapWETH;
+        this.wethAddress = (0, constants_1.WETH_ADDRESS)(chainId);
+        this.amount = amount;
+        if (!!permit2) {
+            (0, tiny_invariant_1.default)(permit2.details.token.toLowerCase() === this.wethAddress.toLowerCase(), `must be permitting WETH address: ${this.wethAddress}`);
+            (0, tiny_invariant_1.default)(permit2.details.amount >= amount, `Did not permit enough WETH for unwrapWETH transaction`);
+            this.permit2Data = permit2;
+        }
+    }
+    encode(planner, _) {
+        (0, inputTokens_1.encodeInputTokenOptions)(planner, {
+            permit2Permit: this.permit2Data,
+            permit2TransferFrom: {
+                token: this.wethAddress,
+                amount: this.amount.toString(),
+            },
+        });
+        planner.addCommand(routerCommands_1.CommandType.UNWRAP_WETH, [constants_1.ROUTER_AS_RECIPIENT, this.amount]);
+    }
+}
+exports.UnwrapWETH = UnwrapWETH;
+//# sourceMappingURL=unwrapWETH.js.map

package/dist/universal-router/entities/protocols/unwrapWETH.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unwrapWETH.js","sourceRoot":"","sources":["../../../../src/universal-router/entities/protocols/unwrapWETH.ts"],"names":[],"mappings":";;;;;;AAAA,oEAAsC;AAEtC,+DAAsE;AACtE,yDAAgF;AAChF,wCAAkE;AAClE,qDAAyE;AAEzE,MAAa,UAAU;IAMrB,YAAY,MAAoB,EAAE,OAAe,EAAE,OAAuB;QALjE,cAAS,GAAoB,yBAAe,CAAC,UAAU,CAAA;QAM9D,IAAI,CAAC,WAAW,GAAG,IAAA,wBAAY,EAAC,OAAO,CAAC,CAAA;QACxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,CAAC,OAAO,EAAE;YACb,IAAA,wBAAS,EACP,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,EACtE,oCAAoC,IAAI,CAAC,WAAW,EAAE,CACvD,CAAA;YACD,IAAA,wBAAS,EAAC,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,MAAM,EAAE,uDAAuD,CAAC,CAAA;YACpG,IAAI,CAAC,WAAW,GAAG,OAAO,CAAA;SAC3B;IACH,CAAC;IAED,MAAM,CAAC,OAAqB,EAAE,CAAc;QAC1C,IAAA,qCAAuB,EAAC,OAAO,EAAE;YAC/B,aAAa,EAAE,IAAI,CAAC,WAAW;YAC/B,mBAAmB,EAAE;gBACnB,KAAK,EAAE,IAAI,CAAC,WAAW;gBACvB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;aAC/B;SACF,CAAC,CAAA;QACF,OAAO,CAAC,UAAU,CAAC,4BAAW,CAAC,WAAW,EAAE,CAAC,+BAAmB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACjF,CAAC;CACF;AA9BD,gCA8BC"}

package/dist/universal-router/entities/trade.d.ts

@@ -0,0 +1,41 @@
+import { Currency, CurrencyAmount, Percent, Price, TradeType } from '../../core';
+import { Route as V3Route } from '../../v3';
+export declare const ONE = 1;
+export declare const ZERO_PERCENT: Percent;
+export declare const ONE_HUNDRED_PERCENT: Percent;
+export declare enum Protocol {
+    V3 = "V3"
+}
+export type V3RouteWithAmounts<TInput extends Currency, TOutput extends Currency> = {
+    routev3: V3Route<TInput, TOutput>;
+    inputAmount: CurrencyAmount<TInput>;
+    outputAmount: CurrencyAmount<TOutput>;
+};
+export type SynthraTradeConstructorArgs<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> = {
+    v3Routes: V3RouteWithAmounts<TInput, TOutput>[];
+    tradeType: TTradeType;
+};
+export declare class SynthraTrade<TInput extends Currency, TOutput extends Currency, TTradeType extends TradeType> {
+    readonly routes: V3Route<TInput, TOutput>[];
+    readonly swaps: {
+        route: V3Route<TInput, TOutput>;
+        inputAmount: CurrencyAmount<TInput>;
+        outputAmount: CurrencyAmount<TOutput>;
+    }[];
+    readonly tradeType: TTradeType;
+    private _inputAmount?;
+    private _outputAmount?;
+    private _executionPrice?;
+    private _priceImpact?;
+    constructor({ v3Routes, tradeType }: SynthraTradeConstructorArgs<TInput, TOutput, TTradeType>);
+    get inputAmount(): CurrencyAmount<TInput>;
+    get outputAmount(): CurrencyAmount<TOutput>;
+    get executionPrice(): Price<TInput, TOutput>;
+    get inputTax(): Percent;
+    get outputTax(): Percent;
+    get priceImpact(): Percent;
+    minimumAmountOut(slippageTolerance: Percent, amountOut?: CurrencyAmount<TOutput>): CurrencyAmount<TOutput>;
+    maximumAmountIn(slippageTolerance: Percent, amountIn?: CurrencyAmount<TInput>): CurrencyAmount<TInput>;
+    worstExecutionPrice(slippageTolerance: Percent): Price<TInput, TOutput>;
+}
+export { SynthraTrade as Trade };