@kittycorn-labs/v4-sdk 1.1.30 → 2.0.0

package/dist/esm/src/utils/v4Planner.js

@@ -0,0 +1,261 @@
+import invariant from 'tiny-invariant';
+import { defaultAbiCoder } from '@ethersproject/abi';
+import { Percent, TradeType } from '@kittycorn-labs/sdk-core';
+import { ADDRESS_ZERO, EMPTY_BYTES } from '../internalConstants.js';
+import { encodeRouteToPath } from './encodeRouteToPath.js';
+/**
+ * Actions
+ * @description Constants that define what action to perform
+ * Not all actions are supported yet.
+ * @enum {number}
+ */
+/**
+ * UniversalRouter version
+ * @description Version of the UniversalRouter contract
+ * @enum {string}
+ */
+export var URVersion;
+(function (URVersion) {
+    URVersion["V2_0"] = "2.0";
+    URVersion["V2_1_1"] = "2.1.1";
+    URVersion["V2_1_2"] = "2.1.2";
+    URVersion["V2_2_0"] = "2.2.0";
+})(URVersion || (URVersion = {}));
+export function isAtLeastV2_1_1(version) {
+    return !!version && version.localeCompare(URVersion.V2_1_1, undefined, { numeric: true }) >= 0;
+}
+export var Actions;
+(function (Actions) {
+    // pool actions
+    // liquidity actions
+    Actions[Actions["INCREASE_LIQUIDITY"] = 0] = "INCREASE_LIQUIDITY";
+    Actions[Actions["DECREASE_LIQUIDITY"] = 1] = "DECREASE_LIQUIDITY";
+    Actions[Actions["MINT_POSITION"] = 2] = "MINT_POSITION";
+    Actions[Actions["BURN_POSITION"] = 3] = "BURN_POSITION";
+    // for fee on transfer tokens
+    // INCREASE_LIQUIDITY_FROM_DELTAS = 0x04,
+    // MINT_POSITION_FROM_DELTAS = 0x05,
+    // swapping
+    Actions[Actions["SWAP_EXACT_IN_SINGLE"] = 6] = "SWAP_EXACT_IN_SINGLE";
+    Actions[Actions["SWAP_EXACT_IN"] = 7] = "SWAP_EXACT_IN";
+    Actions[Actions["SWAP_EXACT_OUT_SINGLE"] = 8] = "SWAP_EXACT_OUT_SINGLE";
+    Actions[Actions["SWAP_EXACT_OUT"] = 9] = "SWAP_EXACT_OUT";
+    // closing deltas on the pool manager
+    // settling
+    Actions[Actions["SETTLE"] = 11] = "SETTLE";
+    Actions[Actions["SETTLE_ALL"] = 12] = "SETTLE_ALL";
+    Actions[Actions["SETTLE_PAIR"] = 13] = "SETTLE_PAIR";
+    // taking
+    Actions[Actions["TAKE"] = 14] = "TAKE";
+    Actions[Actions["TAKE_ALL"] = 15] = "TAKE_ALL";
+    Actions[Actions["TAKE_PORTION"] = 16] = "TAKE_PORTION";
+    Actions[Actions["TAKE_PAIR"] = 17] = "TAKE_PAIR";
+    Actions[Actions["CLOSE_CURRENCY"] = 18] = "CLOSE_CURRENCY";
+    // CLEAR_OR_TAKE = 0x13,
+    Actions[Actions["SWEEP"] = 20] = "SWEEP";
+    // for wrapping/unwrapping native
+    // WRAP = 0x15,
+    Actions[Actions["UNWRAP"] = 22] = "UNWRAP";
+})(Actions || (Actions = {}));
+export var Subparser;
+(function (Subparser) {
+    Subparser[Subparser["V4SwapExactInSingle"] = 0] = "V4SwapExactInSingle";
+    Subparser[Subparser["V4SwapExactIn"] = 1] = "V4SwapExactIn";
+    Subparser[Subparser["V4SwapExactOutSingle"] = 2] = "V4SwapExactOutSingle";
+    Subparser[Subparser["V4SwapExactOut"] = 3] = "V4SwapExactOut";
+    Subparser[Subparser["PoolKey"] = 4] = "PoolKey";
+})(Subparser || (Subparser = {}));
+const POOL_KEY_STRUCT = '(address currency0,address currency1,uint24 fee,int24 tickSpacing,address hooks)';
+const PATH_KEY_STRUCT = '(address intermediateCurrency,uint256 fee,int24 tickSpacing,address hooks,bytes hookData)';
+// UR 2.0 swap structs (without minHopPriceX36)
+const SWAP_EXACT_IN_SINGLE_STRUCT_V2_0 = '(' + POOL_KEY_STRUCT + ' poolKey,bool zeroForOne,uint128 amountIn,uint128 amountOutMinimum,bytes hookData)';
+const SWAP_EXACT_IN_STRUCT_V2_0 = '(address currencyIn,' + PATH_KEY_STRUCT + '[] path,uint128 amountIn,uint128 amountOutMinimum)';
+const SWAP_EXACT_OUT_SINGLE_STRUCT_V2_0 = '(' + POOL_KEY_STRUCT + ' poolKey,bool zeroForOne,uint128 amountOut,uint128 amountInMaximum,bytes hookData)';
+const SWAP_EXACT_OUT_STRUCT_V2_0 = '(address currencyOut,' + PATH_KEY_STRUCT + '[] path,uint128 amountOut,uint128 amountInMaximum)';
+// UR 2.1.1 swap structs (with minHopPriceX36)
+const SWAP_EXACT_IN_SINGLE_STRUCT_V2_1_1 = '(' +
+    POOL_KEY_STRUCT +
+    ' poolKey,bool zeroForOne,uint128 amountIn,uint128 amountOutMinimum,uint256 minHopPriceX36,bytes hookData)';
+const SWAP_EXACT_IN_STRUCT_V2_1_1 = '(address currencyIn,' +
+    PATH_KEY_STRUCT +
+    '[] path,uint256[] minHopPriceX36,uint128 amountIn,uint128 amountOutMinimum)';
+const SWAP_EXACT_OUT_SINGLE_STRUCT_V2_1_1 = '(' +
+    POOL_KEY_STRUCT +
+    ' poolKey,bool zeroForOne,uint128 amountOut,uint128 amountInMaximum,uint256 minHopPriceX36,bytes hookData)';
+const SWAP_EXACT_OUT_STRUCT_V2_1_1 = '(address currencyOut,' +
+    PATH_KEY_STRUCT +
+    '[] path,uint256[] minHopPriceX36,uint128 amountOut,uint128 amountInMaximum)';
+// V4_BASE_ACTIONS_ABI_DEFINITION uses V2.0 structs (default, without minHopPriceX36)
+const SWAP_EXACT_IN_SINGLE_STRUCT = SWAP_EXACT_IN_SINGLE_STRUCT_V2_0;
+const SWAP_EXACT_IN_STRUCT = SWAP_EXACT_IN_STRUCT_V2_0;
+const SWAP_EXACT_OUT_SINGLE_STRUCT = SWAP_EXACT_OUT_SINGLE_STRUCT_V2_0;
+const SWAP_EXACT_OUT_STRUCT = SWAP_EXACT_OUT_STRUCT_V2_0;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const V4_BASE_ACTIONS_ABI_DEFINITION = {
+    // Liquidity commands
+    [Actions.INCREASE_LIQUIDITY]: [
+        { name: 'tokenId', type: 'uint256' },
+        { name: 'liquidity', type: 'uint256' },
+        { name: 'amount0Max', type: 'uint128' },
+        { name: 'amount1Max', type: 'uint128' },
+        { name: 'hookData', type: 'bytes' },
+    ],
+    [Actions.DECREASE_LIQUIDITY]: [
+        { name: 'tokenId', type: 'uint256' },
+        { name: 'liquidity', type: 'uint256' },
+        { name: 'amount0Min', type: 'uint128' },
+        { name: 'amount1Min', type: 'uint128' },
+        { name: 'hookData', type: 'bytes' },
+    ],
+    [Actions.MINT_POSITION]: [
+        { name: 'poolKey', type: POOL_KEY_STRUCT, subparser: Subparser.PoolKey },
+        { name: 'tickLower', type: 'int24' },
+        { name: 'tickUpper', type: 'int24' },
+        { name: 'liquidity', type: 'uint256' },
+        { name: 'amount0Max', type: 'uint128' },
+        { name: 'amount1Max', type: 'uint128' },
+        { name: 'owner', type: 'address' },
+        { name: 'hookData', type: 'bytes' },
+    ],
+    [Actions.BURN_POSITION]: [
+        { name: 'tokenId', type: 'uint256' },
+        { name: 'amount0Min', type: 'uint128' },
+        { name: 'amount1Min', type: 'uint128' },
+        { name: 'hookData', type: 'bytes' },
+    ],
+    // Swapping commands
+    [Actions.SWAP_EXACT_IN_SINGLE]: [
+        { name: 'swap', type: SWAP_EXACT_IN_SINGLE_STRUCT, subparser: Subparser.V4SwapExactInSingle },
+    ],
+    [Actions.SWAP_EXACT_IN]: [{ name: 'swap', type: SWAP_EXACT_IN_STRUCT, subparser: Subparser.V4SwapExactIn }],
+    [Actions.SWAP_EXACT_OUT_SINGLE]: [
+        { name: 'swap', type: SWAP_EXACT_OUT_SINGLE_STRUCT, subparser: Subparser.V4SwapExactOutSingle },
+    ],
+    [Actions.SWAP_EXACT_OUT]: [{ name: 'swap', type: SWAP_EXACT_OUT_STRUCT, subparser: Subparser.V4SwapExactOut }],
+    // Payments commands
+    [Actions.SETTLE]: [
+        { name: 'currency', type: 'address' },
+        { name: 'amount', type: 'uint256' },
+        { name: 'payerIsUser', type: 'bool' },
+    ],
+    [Actions.SETTLE_ALL]: [
+        { name: 'currency', type: 'address' },
+        { name: 'maxAmount', type: 'uint256' },
+    ],
+    [Actions.SETTLE_PAIR]: [
+        { name: 'currency0', type: 'address' },
+        { name: 'currency1', type: 'address' },
+    ],
+    [Actions.TAKE]: [
+        { name: 'currency', type: 'address' },
+        { name: 'recipient', type: 'address' },
+        { name: 'amount', type: 'uint256' },
+    ],
+    [Actions.TAKE_ALL]: [
+        { name: 'currency', type: 'address' },
+        { name: 'minAmount', type: 'uint256' },
+    ],
+    [Actions.TAKE_PORTION]: [
+        { name: 'currency', type: 'address' },
+        { name: 'recipient', type: 'address' },
+        { name: 'bips', type: 'uint256' },
+    ],
+    [Actions.TAKE_PAIR]: [
+        { name: 'currency0', type: 'address' },
+        { name: 'currency1', type: 'address' },
+        { name: 'recipient', type: 'address' },
+    ],
+    [Actions.CLOSE_CURRENCY]: [{ name: 'currency', type: 'address' }],
+    [Actions.SWEEP]: [
+        { name: 'currency', type: 'address' },
+        { name: 'recipient', type: 'address' },
+    ],
+    [Actions.UNWRAP]: [{ name: 'amount', type: 'uint256' }],
+};
+// UR 2.1.1 specific ABI definitions for swap actions (with minHopPriceX36)
+export const V4_SWAP_ACTIONS_V2_1_1 = {
+    [Actions.SWAP_EXACT_IN_SINGLE]: [
+        { name: 'swap', type: SWAP_EXACT_IN_SINGLE_STRUCT_V2_1_1, subparser: Subparser.V4SwapExactInSingle },
+    ],
+    [Actions.SWAP_EXACT_IN]: [{ name: 'swap', type: SWAP_EXACT_IN_STRUCT_V2_1_1, subparser: Subparser.V4SwapExactIn }],
+    [Actions.SWAP_EXACT_OUT_SINGLE]: [
+        { name: 'swap', type: SWAP_EXACT_OUT_SINGLE_STRUCT_V2_1_1, subparser: Subparser.V4SwapExactOutSingle },
+    ],
+    [Actions.SWAP_EXACT_OUT]: [{ name: 'swap', type: SWAP_EXACT_OUT_STRUCT_V2_1_1, subparser: Subparser.V4SwapExactOut }],
+};
+const FULL_DELTA_AMOUNT = 0;
+export class V4Planner {
+    constructor() {
+        this.actions = EMPTY_BYTES;
+        this.params = [];
+    }
+    addAction(type, parameters, urVersion = URVersion.V2_0) {
+        let command = createAction(type, parameters, urVersion);
+        this.params.push(command.encodedInput);
+        this.actions = this.actions.concat(command.action.toString(16).padStart(2, '0'));
+        return this;
+    }
+    addTrade(trade, slippageTolerance, minHopPriceX36, urVersion = URVersion.V2_0) {
+        const exactOutput = trade.tradeType === TradeType.EXACT_OUTPUT;
+        // exactInput we sometimes perform aggregated slippage checks, but not with exactOutput
+        if (exactOutput)
+            invariant(!!slippageTolerance, 'ExactOut requires slippageTolerance');
+        invariant(trade.swaps.length === 1, 'Only accepts Trades with 1 swap (must break swaps into individual trades)');
+        invariant(urVersion === URVersion.V2_0 || !(minHopPriceX36 === null || minHopPriceX36 === void 0 ? void 0 : minHopPriceX36.length) || minHopPriceX36.length === trade.route.pools.length, `minHopPriceX36 length (${minHopPriceX36 === null || minHopPriceX36 === void 0 ? void 0 : minHopPriceX36.length}) must equal route.pools.length (${trade.route.pools.length})`);
+        const actionType = exactOutput ? Actions.SWAP_EXACT_OUT : Actions.SWAP_EXACT_IN;
+        const currencyIn = currencyAddress(trade.route.pathInput);
+        const currencyOut = currencyAddress(trade.route.pathOutput);
+        const swapStruct = exactOutput
+            ? {
+                currencyOut,
+                path: encodeRouteToPath(trade.route, exactOutput),
+                ...(isAtLeastV2_1_1(urVersion) && { minHopPriceX36: minHopPriceX36 !== null && minHopPriceX36 !== void 0 ? minHopPriceX36 : [] }),
+                amountOut: trade.outputAmount.quotient.toString(),
+                amountInMaximum: trade.maximumAmountIn(slippageTolerance !== null && slippageTolerance !== void 0 ? slippageTolerance : new Percent(0)).quotient.toString(),
+            }
+            : {
+                currencyIn,
+                path: encodeRouteToPath(trade.route, exactOutput),
+                ...(isAtLeastV2_1_1(urVersion) && { minHopPriceX36: minHopPriceX36 !== null && minHopPriceX36 !== void 0 ? minHopPriceX36 : [] }),
+                amountIn: trade.inputAmount.quotient.toString(),
+                amountOutMinimum: slippageTolerance ? trade.minimumAmountOut(slippageTolerance).quotient.toString() : 0,
+            };
+        this.addSwapAction(actionType, [swapStruct], urVersion);
+        return this;
+    }
+    addSettle(currency, payerIsUser, amount) {
+        this.addAction(Actions.SETTLE, [currencyAddress(currency), amount !== null && amount !== void 0 ? amount : FULL_DELTA_AMOUNT, payerIsUser]);
+        return this;
+    }
+    addTake(currency, recipient, amount) {
+        const takeAmount = amount !== null && amount !== void 0 ? amount : FULL_DELTA_AMOUNT;
+        this.addAction(Actions.TAKE, [currencyAddress(currency), recipient, takeAmount]);
+        return this;
+    }
+    addUnwrap(amount) {
+        this.addAction(Actions.UNWRAP, [amount]);
+        return this;
+    }
+    finalize() {
+        return defaultAbiCoder.encode(['bytes', 'bytes[]'], [this.actions, this.params]);
+    }
+    addSwapAction(type, parameters, urVersion) {
+        // Use V2.1.1 ABI (with minHopPriceX36) for V2.1.1, otherwise default to V2.0 ABI (without minHopPriceX36)
+        const abiDef = isAtLeastV2_1_1(urVersion) ? V4_SWAP_ACTIONS_V2_1_1[type] : V4_BASE_ACTIONS_ABI_DEFINITION[type];
+        const encodedInput = defaultAbiCoder.encode(abiDef.map((v) => v.type), parameters);
+        this.params.push(encodedInput);
+        this.actions = this.actions.concat(type.toString(16).padStart(2, '0'));
+        return this;
+    }
+}
+function currencyAddress(currency) {
+    return currency.isNative ? ADDRESS_ZERO : currency.wrapped.address;
+}
+function createAction(action, parameters, urVersion = URVersion.V2_0) {
+    const abiDef = isAtLeastV2_1_1(urVersion) && action in V4_SWAP_ACTIONS_V2_1_1
+        ? V4_SWAP_ACTIONS_V2_1_1[action]
+        : V4_BASE_ACTIONS_ABI_DEFINITION[action];
+    const encodedInput = defaultAbiCoder.encode(abiDef.map((v) => v.type), parameters);
+    return { action, encodedInput };
+}
+//# sourceMappingURL=v4Planner.js.map

package/dist/esm/src/utils/v4Planner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v4Planner.js","sourceRoot":"","sources":["../../../../src/utils/v4Planner.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEpD,OAAO,EAAY,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEvE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD;;;;;GAKG;AACH;;;;GAIG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,yBAAY,CAAA;IACZ,6BAAgB,CAAA;IAChB,6BAAgB,CAAA;IAChB,6BAAgB,CAAA;AAClB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAED,MAAM,UAAU,eAAe,CAAC,OAAgB;IAC9C,OAAO,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,CAAA;AAChG,CAAC;AAED,MAAM,CAAN,IAAY,OAoCX;AApCD,WAAY,OAAO;IACjB,eAAe;IACf,oBAAoB;IACpB,iEAAyB,CAAA;IACzB,iEAAyB,CAAA;IACzB,uDAAoB,CAAA;IACpB,uDAAoB,CAAA;IAEpB,6BAA6B;IAC7B,yCAAyC;IACzC,oCAAoC;IAEpC,WAAW;IACX,qEAA2B,CAAA;IAC3B,uDAAoB,CAAA;IACpB,uEAA4B,CAAA;IAC5B,yDAAqB,CAAA;IAErB,qCAAqC;IACrC,WAAW;IACX,0CAAa,CAAA;IACb,kDAAiB,CAAA;IACjB,oDAAkB,CAAA;IAClB,SAAS;IACT,sCAAW,CAAA;IACX,8CAAe,CAAA;IACf,sDAAmB,CAAA;IACnB,gDAAgB,CAAA;IAEhB,0DAAqB,CAAA;IACrB,wBAAwB;IACxB,wCAAY,CAAA;IAEZ,iCAAiC;IACjC,eAAe;IACf,0CAAa,CAAA;AACf,CAAC,EApCW,OAAO,KAAP,OAAO,QAoClB;AAED,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,uEAAmB,CAAA;IACnB,2DAAa,CAAA;IACb,yEAAoB,CAAA;IACpB,6DAAc,CAAA;IACd,+CAAO,CAAA;AACT,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAQD,MAAM,eAAe,GAAG,kFAAkF,CAAA;AAE1G,MAAM,eAAe,GAAG,2FAA2F,CAAA;AAEnH,+CAA+C;AAC/C,MAAM,gCAAgC,GACpC,GAAG,GAAG,eAAe,GAAG,oFAAoF,CAAA;AAE9G,MAAM,yBAAyB,GAC7B,sBAAsB,GAAG,eAAe,GAAG,oDAAoD,CAAA;AAEjG,MAAM,iCAAiC,GACrC,GAAG,GAAG,eAAe,GAAG,oFAAoF,CAAA;AAE9G,MAAM,0BAA0B,GAC9B,uBAAuB,GAAG,eAAe,GAAG,oDAAoD,CAAA;AAElG,8CAA8C;AAC9C,MAAM,kCAAkC,GACtC,GAAG;IACH,eAAe;IACf,2GAA2G,CAAA;AAE7G,MAAM,2BAA2B,GAC/B,sBAAsB;IACtB,eAAe;IACf,6EAA6E,CAAA;AAE/E,MAAM,mCAAmC,GACvC,GAAG;IACH,eAAe;IACf,2GAA2G,CAAA;AAE7G,MAAM,4BAA4B,GAChC,uBAAuB;IACvB,eAAe;IACf,6EAA6E,CAAA;AAE/E,qFAAqF;AACrF,MAAM,2BAA2B,GAAG,gCAAgC,CAAA;AACpE,MAAM,oBAAoB,GAAG,yBAAyB,CAAA;AACtD,MAAM,4BAA4B,GAAG,iCAAiC,CAAA;AACtE,MAAM,qBAAqB,GAAG,0BAA0B,CAAA;AAExD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,8BAA8B,GAA+C;IACxF,qBAAqB;IACrB,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;QAC5B,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE;KACpC;IACD,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;QAC5B,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE;KACpC;IACD,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACvB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE;QACxE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;QACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;QACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;QAClC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE;KACpC;IACD,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACvB,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE;QACvC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE;KACpC;IAED,oBAAoB;IACpB,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE;QAC9B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,SAAS,EAAE,SAAS,CAAC,mBAAmB,EAAE;KAC9F;IACD,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,SAAS,CAAC,aAAa,EAAE,CAAC;IAC3G,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE;QAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,EAAE,SAAS,EAAE,SAAS,CAAC,oBAAoB,EAAE;KAChG;IACD,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,SAAS,EAAE,SAAS,CAAC,cAAc,EAAE,CAAC;IAE9G,oBAAoB;IACpB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAChB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;QACnC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE;KACtC;IACD,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACpB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;KACvC;IACD,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACrB,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;KACvC;IACD,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACd,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;KACpC;IACD,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAClB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;KACvC;IACD,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACtB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;KAClC;IACD,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QACnB,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;QACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;KACvC;IACD,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACjE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACf,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;KACvC;IACD,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;CACxD,CAAA;AAED,2EAA2E;AAC3E,MAAM,CAAC,MAAM,sBAAsB,GAA4C;IAC7E,CAAC,OAAO,CAAC,oBAAoB,CAAC,EAAE;QAC9B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kCAAkC,EAAE,SAAS,EAAE,SAAS,CAAC,mBAAmB,EAAE;KACrG;IACD,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,SAAS,EAAE,SAAS,CAAC,aAAa,EAAE,CAAC;IAClH,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE;QAC/B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,EAAE,SAAS,EAAE,SAAS,CAAC,oBAAoB,EAAE;KACvG;IACD,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,EAAE,SAAS,EAAE,SAAS,CAAC,cAAc,EAAE,CAAC;CACtH,CAAA;AAED,MAAM,iBAAiB,GAAG,CAAC,CAAA;AAE3B,MAAM,OAAO,SAAS;IAIpB;QACE,IAAI,CAAC,OAAO,GAAG,WAAW,CAAA;QAC1B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;IAClB,CAAC;IAED,SAAS,CAAC,IAAa,EAAE,UAAiB,EAAE,YAAuB,SAAS,CAAC,IAAI;QAC/E,IAAI,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;QACvD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QACtC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;QAChF,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ,CACN,KAA2C,EAC3C,iBAA2B,EAC3B,cAA4B,EAC5B,YAAuB,SAAS,CAAC,IAAI;QAErC,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,YAAY,CAAA;QAE9D,uFAAuF;QACvF,IAAI,WAAW;YAAE,SAAS,CAAC,CAAC,CAAC,iBAAiB,EAAE,qCAAqC,CAAC,CAAA;QACtF,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,2EAA2E,CAAC,CAAA;QAChH,SAAS,CACP,SAAS,KAAK,SAAS,CAAC,IAAI,IAAI,CAAC,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,CAAA,IAAI,cAAc,CAAC,MAAM,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAC7G,0BAA0B,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,oCAAoC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAChH,CAAA;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAA;QAE/E,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACzD,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAE3D,MAAM,UAAU,GAAG,WAAW;YAC5B,CAAC,CAAC;gBACE,WAAW;gBACX,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC;gBACjD,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,EAAE,CAAC;gBAC3E,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE;gBACjD,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE;aAChG;YACH,CAAC,CAAC;gBACE,UAAU;gBACV,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC;gBACjD,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,EAAE,EAAE,CAAC;gBAC3E,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,EAAE;gBAC/C,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;aACxG,CAAA;QAEL,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,CAAA;QACvD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,SAAS,CAAC,QAAkB,EAAE,WAAoB,EAAE,MAAkB;QACpE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,iBAAiB,EAAE,WAAW,CAAC,CAAC,CAAA;QACrG,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CAAC,QAAkB,EAAE,SAAiB,EAAE,MAAkB;QAC/D,MAAM,UAAU,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,iBAAiB,CAAA;QAC9C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAA;QAChF,OAAO,IAAI,CAAA;IACb,CAAC;IAED,SAAS,CAAC,MAAiB;QACzB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;QACxC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ;QACN,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IAClF,CAAC;IAEO,aAAa,CAAC,IAAa,EAAE,UAAiB,EAAE,SAAoB;QAC1E,0GAA0G;QAC1G,MAAM,MAAM,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAA;QAC/G,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CACzC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EACzB,UAAU,CACX,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;QACtE,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,SAAS,eAAe,CAAC,QAAkB;IACzC,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAA;AACpE,CAAC;AAOD,SAAS,YAAY,CAAC,MAAe,EAAE,UAAiB,EAAE,YAAuB,SAAS,CAAC,IAAI;IAC7F,MAAM,MAAM,GACV,eAAe,CAAC,SAAS,CAAC,IAAI,MAAM,IAAI,sBAAsB;QAC5D,CAAC,CAAC,sBAAsB,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAA;IAC5C,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,CACzC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EACzB,UAAU,CACX,CAAA;IACD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,CAAA;AACjC,CAAC"}

package/dist/esm/src/utils/v4PositionPlanner.d.ts

@@ -0,0 +1,13 @@
+import { V4Planner } from './v4Planner';
+import { Pool } from '../entities';
+import { BigintIsh, Currency } from '@kittycorn-labs/sdk-core';
+export declare class V4PositionPlanner extends V4Planner {
+    addMint(pool: Pool, tickLower: number, tickUpper: number, liquidity: BigintIsh, amount0Max: BigintIsh, amount1Max: BigintIsh, owner: string, hookData?: string): void;
+    addIncrease(tokenId: BigintIsh, liquidity: BigintIsh, amount0Max: BigintIsh, amount1Max: BigintIsh, hookData?: string): void;
+    addDecrease(tokenId: BigintIsh, liquidity: BigintIsh, amount0Min: BigintIsh, amount1Min: BigintIsh, hookData?: string): void;
+    addBurn(tokenId: BigintIsh, amount0Min: BigintIsh, amount1Min: BigintIsh, hookData?: string): void;
+    addSettlePair(currency0: Currency, currency1: Currency): void;
+    addCloseCurrency(currency: Currency): void;
+    addTakePair(currency0: Currency, currency1: Currency, recipient: string): void;
+    addSweep(currency: Currency, to: string): void;
+}

package/dist/esm/src/utils/v4PositionPlanner.js

@@ -0,0 +1,57 @@
+import { Actions, V4Planner } from './v4Planner.js';
+import { Pool } from '../entities/index.js';
+import { toAddress } from '../utils/currencyMap.js';
+import { EMPTY_BYTES } from '../internalConstants.js';
+// A wrapper around V4Planner to help handle PositionManager actions
+export class V4PositionPlanner extends V4Planner {
+    // MINT_POSITION
+    addMint(pool, tickLower, tickUpper, liquidity, amount0Max, amount1Max, owner, hookData = EMPTY_BYTES) {
+        const inputs = [
+            Pool.getPoolKey(pool.currency0, pool.currency1, pool.fee, pool.tickSpacing, pool.hooks),
+            tickLower,
+            tickUpper,
+            liquidity.toString(),
+            amount0Max.toString(),
+            amount1Max.toString(),
+            owner,
+            hookData,
+        ];
+        this.addAction(Actions.MINT_POSITION, inputs);
+    }
+    // INCREASE_LIQUIDITY
+    addIncrease(tokenId, liquidity, amount0Max, amount1Max, hookData = EMPTY_BYTES) {
+        const inputs = [tokenId.toString(), liquidity.toString(), amount0Max.toString(), amount1Max.toString(), hookData];
+        this.addAction(Actions.INCREASE_LIQUIDITY, inputs);
+    }
+    // DECREASE_LIQUIDITY
+    addDecrease(tokenId, liquidity, amount0Min, amount1Min, hookData = EMPTY_BYTES) {
+        const inputs = [tokenId.toString(), liquidity.toString(), amount0Min.toString(), amount1Min.toString(), hookData];
+        this.addAction(Actions.DECREASE_LIQUIDITY, inputs);
+    }
+    // BURN_POSITION
+    addBurn(tokenId, amount0Min, amount1Min, hookData = EMPTY_BYTES) {
+        const inputs = [tokenId.toString(), amount0Min.toString(), amount1Min.toString(), hookData];
+        this.addAction(Actions.BURN_POSITION, inputs);
+    }
+    // SETTLE_PAIR
+    addSettlePair(currency0, currency1) {
+        const inputs = [toAddress(currency0), toAddress(currency1)];
+        this.addAction(Actions.SETTLE_PAIR, inputs);
+    }
+    // CLOSE_CURRENCY
+    addCloseCurrency(currency) {
+        const inputs = [toAddress(currency)];
+        this.addAction(Actions.CLOSE_CURRENCY, inputs);
+    }
+    // TAKE_PAIR
+    addTakePair(currency0, currency1, recipient) {
+        const inputs = [toAddress(currency0), toAddress(currency1), recipient];
+        this.addAction(Actions.TAKE_PAIR, inputs);
+    }
+    // SWEEP
+    addSweep(currency, to) {
+        const inputs = [toAddress(currency), to];
+        this.addAction(Actions.SWEEP, inputs);
+    }
+}
+//# sourceMappingURL=v4PositionPlanner.js.map

package/dist/esm/src/utils/v4PositionPlanner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v4PositionPlanner.js","sourceRoot":"","sources":["../../../../src/utils/v4PositionPlanner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAElC,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAElD,oEAAoE;AACpE,MAAM,OAAO,iBAAkB,SAAQ,SAAS;IAC9C,gBAAgB;IAChB,OAAO,CACL,IAAU,EACV,SAAiB,EACjB,SAAiB,EACjB,SAAoB,EACpB,UAAqB,EACrB,UAAqB,EACrB,KAAa,EACb,WAAmB,WAAW;QAE9B,MAAM,MAAM,GAAG;YACb,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC;YACvF,SAAS;YACT,SAAS;YACT,SAAS,CAAC,QAAQ,EAAE;YACpB,UAAU,CAAC,QAAQ,EAAE;YACrB,UAAU,CAAC,QAAQ,EAAE;YACrB,KAAK;YACL,QAAQ;SACT,CAAA;QACD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;IAC/C,CAAC;IAED,qBAAqB;IACrB,WAAW,CACT,OAAkB,EAClB,SAAoB,EACpB,UAAqB,EACrB,UAAqB,EACrB,WAAmB,WAAW;QAE9B,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAA;QACjH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;IACpD,CAAC;IAED,qBAAqB;IACrB,WAAW,CACT,OAAkB,EAClB,SAAoB,EACpB,UAAqB,EACrB,UAAqB,EACrB,WAAmB,WAAW;QAE9B,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAA;QACjH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;IACpD,CAAC;IAED,gBAAgB;IAChB,OAAO,CAAC,OAAkB,EAAE,UAAqB,EAAE,UAAqB,EAAE,WAAmB,WAAW;QACtG,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,QAAQ,CAAC,CAAA;QAC3F,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAA;IAC/C,CAAC;IAED,cAAc;IACd,aAAa,CAAC,SAAmB,EAAE,SAAmB;QACpD,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,CAAA;QAC3D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;IAC7C,CAAC;IAED,iBAAiB;IACjB,gBAAgB,CAAC,QAAkB;QACjC,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QACpC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;IAChD,CAAC;IAED,YAAY;IACZ,WAAW,CAAC,SAAmB,EAAE,SAAmB,EAAE,SAAiB;QACrE,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAA;QACtE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IAC3C,CAAC;IAED,QAAQ;IACR,QAAQ,CAAC,QAAkB,EAAE,EAAU;QACrC,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;CACF"}

package/dist/types/src/PositionManager.d.ts

@@ -0,0 +1,170 @@
+import { BigintIsh, Percent, NativeCurrency } from '@kittycorn-labs/sdk-core';
+import { TypedDataDomain, TypedDataField } from '@ethersproject/abstract-signer';
+import { Position } from './entities/position';
+import { MethodParameters } from './utils/calldata';
+import { Interface } from '@ethersproject/abi';
+import { PoolKey } from './entities';
+export interface CommonOptions {
+    /**
+     * How much the pool price is allowed to move from the specified action.
+     */
+    slippageTolerance: Percent;
+    /**
+     * Optional data to pass to hooks
+     */
+    hookData?: string;
+    /**
+     * When the transaction expires, in epoch seconds.
+     */
+    deadline: BigintIsh;
+}
+export interface ModifyPositionSpecificOptions {
+    /**
+     * Indicates the ID of the position to increase liquidity for.
+     */
+    tokenId: BigintIsh;
+}
+export interface MintSpecificOptions {
+    /**
+     * The account that should receive the minted NFT.
+     */
+    recipient: string;
+    /**
+     * Creates pool if not initialized before mint.
+     */
+    createPool?: boolean;
+    /**
+     * Initial price to set on the pool if creating
+     */
+    sqrtPriceX96?: BigintIsh;
+    /**
+     * Whether the mint is part of a migration from V3 to V4.
+     */
+    migrate?: boolean;
+}
+/**
+ * Options for producing the calldata to add liquidity.
+ */
+export interface CommonAddLiquidityOptions {
+    /**
+     * Whether to spend ether. If true, one of the currencies must be the NATIVE currency.
+     */
+    useNative?: NativeCurrency;
+    /**
+     * The optional permit2 batch permit parameters for spending token0 and token1
+     */
+    batchPermit?: BatchPermitOptions;
+}
+/**
+ * Options for producing the calldata to exit a position.
+ */
+export interface RemoveLiquiditySpecificOptions {
+    /**
+     * The percentage of position liquidity to exit.
+     */
+    liquidityPercentage: Percent;
+    /**
+     * Whether the NFT should be burned if the entire position is being exited, by default false.
+     */
+    burnToken?: boolean;
+    /**
+     * The optional permit of the token ID being exited, in case the exit transaction is being sent by an account that does not own the NFT
+     */
+    permit?: NFTPermitOptions;
+}
+export interface CollectSpecificOptions {
+    /**
+     * Indicates the ID of the position to collect for.
+     */
+    tokenId: BigintIsh;
+    /**
+     * The account that should receive the tokens.
+     */
+    recipient: string;
+}
+export interface TransferOptions {
+    /**
+     * The account sending the NFT.
+     */
+    sender: string;
+    /**
+     * The account that should receive the NFT.
+     */
+    recipient: string;
+    /**
+     * The id of the token being sent.
+     */
+    tokenId: BigintIsh;
+}
+export interface PermitDetails {
+    token: string;
+    amount: BigintIsh;
+    expiration: BigintIsh;
+    nonce: BigintIsh;
+}
+export interface AllowanceTransferPermitSingle {
+    details: PermitDetails;
+    spender: string;
+    sigDeadline: BigintIsh;
+}
+export interface AllowanceTransferPermitBatch {
+    details: PermitDetails[];
+    spender: string;
+    sigDeadline: BigintIsh;
+}
+export interface BatchPermitOptions {
+    owner: string;
+    permitBatch: AllowanceTransferPermitBatch;
+    signature: string;
+}
+export interface NFTPermitValues {
+    spender: string;
+    tokenId: BigintIsh;
+    deadline: BigintIsh;
+    nonce: BigintIsh;
+}
+export interface NFTPermitOptions extends NFTPermitValues {
+    signature: string;
+}
+export interface NFTPermitData {
+    domain: TypedDataDomain;
+    types: Record<string, TypedDataField[]>;
+    values: NFTPermitValues;
+}
+export type MintOptions = CommonOptions & CommonAddLiquidityOptions & MintSpecificOptions;
+export type IncreaseLiquidityOptions = CommonOptions & CommonAddLiquidityOptions & ModifyPositionSpecificOptions;
+export type AddLiquidityOptions = MintOptions | IncreaseLiquidityOptions;
+export type RemoveLiquidityOptions = CommonOptions & RemoveLiquiditySpecificOptions & ModifyPositionSpecificOptions;
+export type CollectOptions = CommonOptions & CollectSpecificOptions;
+export declare abstract class V4PositionManager {
+    static INTERFACE: Interface;
+    /**
+     * Cannot be constructed.
+     */
+    private constructor();
+    /**
+     * Public methods to encode method parameters for different actions on the PositionManager contract
+     */
+    static createCallParameters(poolKey: PoolKey, sqrtPriceX96: BigintIsh): MethodParameters;
+    static addCallParameters(position: Position, options: AddLiquidityOptions): MethodParameters;
+    /**
+     * Produces the calldata for completely or partially exiting a position
+     * @param position The position to exit
+     * @param options Additional information necessary for generating the calldata
+     * @returns The call parameters
+     */
+    static removeCallParameters(position: Position, options: RemoveLiquidityOptions): MethodParameters;
+    /**
+     * Produces the calldata for collecting fees from a position
+     * @param position The position to collect fees from
+     * @param options Additional information necessary for generating the calldata
+     * @returns The call parameters
+     */
+    static collectCallParameters(position: Position, options: CollectOptions): MethodParameters;
+    private static encodeInitializePool;
+    static encodeModifyLiquidities(unlockData: string, deadline: BigintIsh): string;
+    static encodePermitBatch(owner: string, permitBatch: AllowanceTransferPermitBatch, signature: string): string;
+    static encodeERC721Permit(spender: string, tokenId: BigintIsh, deadline: BigintIsh, nonce: BigintIsh, signature: string): string;
+    static getPermitData(permit: NFTPermitValues, positionManagerAddress: string, chainId: number): NFTPermitData;
+}
+//# sourceMappingURL=PositionManager.d.ts.map

package/dist/types/src/PositionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PositionManager.d.ts","sourceRoot":"","sources":["../../../src/PositionManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,OAAO,EAA2B,cAAc,EAAE,MAAM,0BAA0B,CAAA;AACtG,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEhF,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAS,MAAM,kBAAkB,CAAA;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAiBpC,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAA;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,SAAS,CAAA;IACjB,UAAU,EAAE,SAAS,CAAA;IACrB,KAAK,EAAE,SAAS,CAAA;CACjB;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,aAAa,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,SAAS,CAAA;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,aAAa,EAAE,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,SAAS,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,4BAA4B,CAAA;IACzC,SAAS,EAAE,MAAM,CAAA;CAClB;AAWD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,SAAS,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;IACnB,KAAK,EAAE,SAAS,CAAA;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IACvC,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,yBAAyB,GAAG,mBAAmB,CAAA;AACzF,MAAM,MAAM,wBAAwB,GAAG,aAAa,GAAG,yBAAyB,GAAG,6BAA6B,CAAA;AAEhH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,wBAAwB,CAAA;AAExE,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,8BAA8B,GAAG,6BAA6B,CAAA;AAEnH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,sBAAsB,CAAA;AAenE,8BAAsB,iBAAiB;IACrC,OAAc,SAAS,EAAE,SAAS,CAAoC;IAEtE;;OAEG;IACH,OAAO;IAEP;;OAEG;WACW,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,GAAG,gBAAgB;WAOjF,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GAAG,gBAAgB;IAuGnG;;;;;OAKG;WACW,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,sBAAsB,GAAG,gBAAgB;IAmEzG;;;;;OAKG;WACW,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,GAAG,gBAAgB;IA0BlG,OAAO,CAAC,MAAM,CAAC,oBAAoB;WAQrB,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,GAAG,MAAM;WAKxE,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,4BAA4B,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;WAStG,kBAAkB,CAC9B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,SAAS,EAClB,QAAQ,EAAE,SAAS,EACnB,KAAK,EAAE,SAAS,EAChB,SAAS,EAAE,MAAM,GAChB,MAAM;WAWK,aAAa,CAAC,MAAM,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,aAAa;CAWrH"}

package/dist/types/src/actionConstants.d.ts

@@ -0,0 +1,2 @@
+export declare const MSG_SENDER = "0x0000000000000000000000000000000000000001";
+//# sourceMappingURL=actionConstants.d.ts.map

package/dist/types/src/actionConstants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionConstants.d.ts","sourceRoot":"","sources":["../../../src/actionConstants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,+CAA+C,CAAA"}

package/dist/types/src/entities/index.d.ts

@@ -0,0 +1,5 @@
+export * from './pool';
+export * from './route';
+export * from './trade';
+export * from './position';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/entities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA"}