@kittycorn-labs/v4-sdk 1.1.30 → 2.0.0

package/dist/{entities → cjs/src/entities}/position.d.ts

@@ -1,144 +1,144 @@
-import { BigintIsh, Percent, Price, CurrencyAmount, Currency } from '@kittycorn-labs/sdk-core';
-import JSBI from 'jsbi';
-import { Pool } from './pool';
-import { AllowanceTransferPermitBatch } from '../PositionManager';
-interface PositionConstructorArgs {
-    pool: Pool;
-    liquidity: BigintIsh;
-    tickLower: number;
-    tickUpper: number;
-}
-/**
- * Represents a position on a Uniswap V4 Pool
- * @dev Similar to the V3 implementation
- * - using Currency instead of Token
- * - keep in mind that Pool and liquidity must be fetched from the pool manager
- */
-export declare class Position {
-    readonly pool: Pool;
-    readonly tickLower: number;
-    readonly tickUpper: number;
-    readonly liquidity: JSBI;
-    private _token0Amount;
-    private _token1Amount;
-    private _mintAmounts;
-    /**
-     * Constructs a position for a given pool with the given liquidity
-     * @param pool For which pool the liquidity is assigned
-     * @param liquidity The amount of liquidity that is in the position
-     * @param tickLower The lower tick of the position
-     * @param tickUpper The upper tick of the position
-     */
-    constructor({ pool, liquidity, tickLower, tickUpper }: PositionConstructorArgs);
-    /**
-     * Returns the price of token0 at the lower tick
-     */
-    get token0PriceLower(): Price<Currency, Currency>;
-    /**
-     * Returns the price of token0 at the upper tick
-     */
-    get token0PriceUpper(): Price<Currency, Currency>;
-    /**
-     * Returns the amount of token0 that this position's liquidity could be burned for at the current pool price
-     */
-    get amount0(): CurrencyAmount<Currency>;
-    /**
-     * Returns the amount of token1 that this position's liquidity could be burned for at the current pool price
-     */
-    get amount1(): CurrencyAmount<Currency>;
-    /**
-     * Returns the lower and upper sqrt ratios if the price 'slips' up to slippage tolerance percentage
-     * @param slippageTolerance The amount by which the price can 'slip' before the transaction will revert
-     * @returns The sqrt ratios after slippage
-     */
-    private ratiosAfterSlippage;
-    /**
-     * Returns the maximum amount of token0 and token1 that must be sent in order to safely mint the amount of liquidity held by the position
-     * with the given slippage tolerance
-     * @param slippageTolerance Tolerance of unfavorable slippage from the current price
-     * @returns The amounts, with slippage
-     * @dev In v4, minting and increasing is protected by maximum amounts of token0 and token1.
-     */
-    mintAmountsWithSlippage(slippageTolerance: Percent): Readonly<{
-        amount0: JSBI;
-        amount1: JSBI;
-    }>;
-    /**
-     * Returns the minimum amounts that should be requested in order to safely burn the amount of liquidity held by the
-     * position with the given slippage tolerance
-     * @param slippageTolerance tolerance of unfavorable slippage from the current price
-     * @returns The amounts, with slippage
-     */
-    burnAmountsWithSlippage(slippageTolerance: Percent): Readonly<{
-        amount0: JSBI;
-        amount1: JSBI;
-    }>;
-    /**
-     * Returns the minimum amounts that must be sent in order to mint the amount of liquidity held by the position at
-     * the current price for the pool
-     */
-    get mintAmounts(): Readonly<{
-        amount0: JSBI;
-        amount1: JSBI;
-    }>;
-    /**
-     * Returns the AllowanceTransferPermitBatch for adding liquidity to a position
-     * @param slippageTolerance The amount by which the price can 'slip' before the transaction will revert
-     * @param spender The spender of the permit (should usually be the PositionManager)
-     * @param nonce A valid permit2 nonce
-     * @param deadline The deadline for the permit
-     */
-    permitBatchData(slippageTolerance: Percent, spender: string, nonce: BigintIsh, deadline: BigintIsh): AllowanceTransferPermitBatch;
-    /**
-     * Computes the maximum amount of liquidity received for a given amount of token0, token1,
-     * and the prices at the tick boundaries.
-     * @param pool The pool for which the position should be created
-     * @param tickLower The lower tick of the position
-     * @param tickUpper The upper tick of the position
-     * @param amount0 token0 amountzw
-     * @param amount1 token1 amount
-     * @param useFullPrecision If false, liquidity will be maximized according to what the router can calculate,
-     * not what core can theoretically support
-     * @returns The amount of liquidity for the position
-     */
-    static fromAmounts({ pool, tickLower, tickUpper, amount0, amount1, useFullPrecision, }: {
-        pool: Pool;
-        tickLower: number;
-        tickUpper: number;
-        amount0: BigintIsh;
-        amount1: BigintIsh;
-        useFullPrecision: boolean;
-    }): Position;
-    /**
-     * Computes a position with the maximum amount of liquidity received for a given amount of token0, assuming an unlimited amount of token1
-     * @param pool The pool for which the position is created
-     * @param tickLower The lower tick
-     * @param tickUpper The upper tick
-     * @param amount0 The desired amount of token0
-     * @param useFullPrecision If true, liquidity will be maximized according to what the router can calculate,
-     * not what core can theoretically support
-     * @returns The position
-     */
-    static fromAmount0({ pool, tickLower, tickUpper, amount0, useFullPrecision, }: {
-        pool: Pool;
-        tickLower: number;
-        tickUpper: number;
-        amount0: BigintIsh;
-        useFullPrecision: boolean;
-    }): Position;
-    /**
-     * Computes a position with the maximum amount of liquidity received for a given amount of token1, assuming an unlimited amount of token0
-     * @param pool The pool for which the position is created
-     * @param tickLower The lower tick
-     * @param tickUpper The upper tick
-     * @param amount1 The desired amount of token1
-     * @returns The position
-     */
-    static fromAmount1({ pool, tickLower, tickUpper, amount1, }: {
-        pool: Pool;
-        tickLower: number;
-        tickUpper: number;
-        amount1: BigintIsh;
-    }): Position;
-}
-export {};
+import { BigintIsh, Percent, Price, CurrencyAmount, Currency } from '@kittycorn-labs/sdk-core';
+import JSBI from 'jsbi';
+import { Pool } from './pool';
+import { AllowanceTransferPermitBatch } from '../PositionManager';
+interface PositionConstructorArgs {
+    pool: Pool;
+    liquidity: BigintIsh;
+    tickLower: number;
+    tickUpper: number;
+}
+/**
+ * Represents a position on a Uniswap V4 Pool
+ * @dev Similar to the V3 implementation
+ * - using Currency instead of Token
+ * - keep in mind that Pool and liquidity must be fetched from the pool manager
+ */
+export declare class Position {
+    readonly pool: Pool;
+    readonly tickLower: number;
+    readonly tickUpper: number;
+    readonly liquidity: JSBI;
+    private _token0Amount;
+    private _token1Amount;
+    private _mintAmounts;
+    /**
+     * Constructs a position for a given pool with the given liquidity
+     * @param pool For which pool the liquidity is assigned
+     * @param liquidity The amount of liquidity that is in the position
+     * @param tickLower The lower tick of the position
+     * @param tickUpper The upper tick of the position
+     */
+    constructor({ pool, liquidity, tickLower, tickUpper }: PositionConstructorArgs);
+    /**
+     * Returns the price of token0 at the lower tick
+     */
+    get token0PriceLower(): Price<Currency, Currency>;
+    /**
+     * Returns the price of token0 at the upper tick
+     */
+    get token0PriceUpper(): Price<Currency, Currency>;
+    /**
+     * Returns the amount of token0 that this position's liquidity could be burned for at the current pool price
+     */
+    get amount0(): CurrencyAmount<Currency>;
+    /**
+     * Returns the amount of token1 that this position's liquidity could be burned for at the current pool price
+     */
+    get amount1(): CurrencyAmount<Currency>;
+    /**
+     * Returns the lower and upper sqrt ratios if the price 'slips' up to slippage tolerance percentage
+     * @param slippageTolerance The amount by which the price can 'slip' before the transaction will revert
+     * @returns The sqrt ratios after slippage
+     */
+    private ratiosAfterSlippage;
+    /**
+     * Returns the maximum amount of token0 and token1 that must be sent in order to safely mint the amount of liquidity held by the position
+     * with the given slippage tolerance
+     * @param slippageTolerance Tolerance of unfavorable slippage from the current price
+     * @returns The amounts, with slippage
+     * @dev In v4, minting and increasing is protected by maximum amounts of token0 and token1.
+     */
+    mintAmountsWithSlippage(slippageTolerance: Percent): Readonly<{
+        amount0: JSBI;
+        amount1: JSBI;
+    }>;
+    /**
+     * Returns the minimum amounts that should be requested in order to safely burn the amount of liquidity held by the
+     * position with the given slippage tolerance
+     * @param slippageTolerance tolerance of unfavorable slippage from the current price
+     * @returns The amounts, with slippage
+     */
+    burnAmountsWithSlippage(slippageTolerance: Percent): Readonly<{
+        amount0: JSBI;
+        amount1: JSBI;
+    }>;
+    /**
+     * Returns the minimum amounts that must be sent in order to mint the amount of liquidity held by the position at
+     * the current price for the pool
+     */
+    get mintAmounts(): Readonly<{
+        amount0: JSBI;
+        amount1: JSBI;
+    }>;
+    /**
+     * Returns the AllowanceTransferPermitBatch for adding liquidity to a position
+     * @param slippageTolerance The amount by which the price can 'slip' before the transaction will revert
+     * @param spender The spender of the permit (should usually be the PositionManager)
+     * @param nonce A valid permit2 nonce
+     * @param deadline The deadline for the permit
+     */
+    permitBatchData(slippageTolerance: Percent, spender: string, nonce: BigintIsh, deadline: BigintIsh): AllowanceTransferPermitBatch;
+    /**
+     * Computes the maximum amount of liquidity received for a given amount of token0, token1,
+     * and the prices at the tick boundaries.
+     * @param pool The pool for which the position should be created
+     * @param tickLower The lower tick of the position
+     * @param tickUpper The upper tick of the position
+     * @param amount0 token0 amountzw
+     * @param amount1 token1 amount
+     * @param useFullPrecision If false, liquidity will be maximized according to what the router can calculate,
+     * not what core can theoretically support
+     * @returns The amount of liquidity for the position
+     */
+    static fromAmounts({ pool, tickLower, tickUpper, amount0, amount1, useFullPrecision, }: {
+        pool: Pool;
+        tickLower: number;
+        tickUpper: number;
+        amount0: BigintIsh;
+        amount1: BigintIsh;
+        useFullPrecision: boolean;
+    }): Position;
+    /**
+     * Computes a position with the maximum amount of liquidity received for a given amount of token0, assuming an unlimited amount of token1
+     * @param pool The pool for which the position is created
+     * @param tickLower The lower tick
+     * @param tickUpper The upper tick
+     * @param amount0 The desired amount of token0
+     * @param useFullPrecision If true, liquidity will be maximized according to what the router can calculate,
+     * not what core can theoretically support
+     * @returns The position
+     */
+    static fromAmount0({ pool, tickLower, tickUpper, amount0, useFullPrecision, }: {
+        pool: Pool;
+        tickLower: number;
+        tickUpper: number;
+        amount0: BigintIsh;
+        useFullPrecision: boolean;
+    }): Position;
+    /**
+     * Computes a position with the maximum amount of liquidity received for a given amount of token1, assuming an unlimited amount of token0
+     * @param pool The pool for which the position is created
+     * @param tickLower The lower tick
+     * @param tickUpper The upper tick
+     * @param amount1 The desired amount of token1
+     * @returns The position
+     */
+    static fromAmount1({ pool, tickLower, tickUpper, amount1, }: {
+        pool: Pool;
+        tickLower: number;
+        tickUpper: number;
+        amount1: BigintIsh;
+    }): Position;
+}
+export {};

package/dist/cjs/src/entities/position.js

@@ -0,0 +1,273 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Position = void 0;
+const tslib_1 = require("tslib");
+const sdk_core_1 = require("@kittycorn-labs/sdk-core");
+const jsbi_1 = tslib_1.__importDefault(require("jsbi"));
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const pool_1 = require("./pool");
+const v3_sdk_1 = require("@kittycorn-labs/v3-sdk");
+const internalConstants_1 = require("../internalConstants");
+const priceTickConversions_1 = require("../utils/priceTickConversions");
+/**
+ * Represents a position on a Uniswap V4 Pool
+ * @dev Similar to the V3 implementation
+ * - using Currency instead of Token
+ * - keep in mind that Pool and liquidity must be fetched from the pool manager
+ */
+class Position {
+    /**
+     * Constructs a position for a given pool with the given liquidity
+     * @param pool For which pool the liquidity is assigned
+     * @param liquidity The amount of liquidity that is in the position
+     * @param tickLower The lower tick of the position
+     * @param tickUpper The upper tick of the position
+     */
+    constructor({ pool, liquidity, tickLower, tickUpper }) {
+        // cached resuts for the getters
+        this._token0Amount = null;
+        this._token1Amount = null;
+        this._mintAmounts = null;
+        (0, tiny_invariant_1.default)(tickLower < tickUpper, 'TICK_ORDER');
+        (0, tiny_invariant_1.default)(tickLower >= v3_sdk_1.TickMath.MIN_TICK && tickLower % pool.tickSpacing === 0, 'TICK_LOWER');
+        (0, tiny_invariant_1.default)(tickUpper <= v3_sdk_1.TickMath.MAX_TICK && tickUpper % pool.tickSpacing === 0, 'TICK_UPPER');
+        this.pool = pool;
+        this.tickLower = tickLower;
+        this.tickUpper = tickUpper;
+        this.liquidity = jsbi_1.default.BigInt(liquidity);
+    }
+    /**
+     * Returns the price of token0 at the lower tick
+     */
+    get token0PriceLower() {
+        return (0, priceTickConversions_1.tickToPrice)(this.pool.currency0, this.pool.currency1, this.tickLower);
+    }
+    /**
+     * Returns the price of token0 at the upper tick
+     */
+    get token0PriceUpper() {
+        return (0, priceTickConversions_1.tickToPrice)(this.pool.currency0, this.pool.currency1, this.tickUpper);
+    }
+    /**
+     * Returns the amount of token0 that this position's liquidity could be burned for at the current pool price
+     */
+    get amount0() {
+        if (!this._token0Amount) {
+            if (this.pool.tickCurrent < this.tickLower) {
+                this._token0Amount = sdk_core_1.CurrencyAmount.fromRawAmount(this.pool.currency0, v3_sdk_1.SqrtPriceMath.getAmount0Delta(v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickLower), v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, false));
+            }
+            else if (this.pool.tickCurrent < this.tickUpper) {
+                this._token0Amount = sdk_core_1.CurrencyAmount.fromRawAmount(this.pool.currency0, v3_sdk_1.SqrtPriceMath.getAmount0Delta(this.pool.sqrtRatioX96, v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, false));
+            }
+            else {
+                this._token0Amount = sdk_core_1.CurrencyAmount.fromRawAmount(this.pool.currency0, internalConstants_1.ZERO);
+            }
+        }
+        return this._token0Amount;
+    }
+    /**
+     * Returns the amount of token1 that this position's liquidity could be burned for at the current pool price
+     */
+    get amount1() {
+        if (!this._token1Amount) {
+            if (this.pool.tickCurrent < this.tickLower) {
+                this._token1Amount = sdk_core_1.CurrencyAmount.fromRawAmount(this.pool.currency1, internalConstants_1.ZERO);
+            }
+            else if (this.pool.tickCurrent < this.tickUpper) {
+                this._token1Amount = sdk_core_1.CurrencyAmount.fromRawAmount(this.pool.currency1, v3_sdk_1.SqrtPriceMath.getAmount1Delta(v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickLower), this.pool.sqrtRatioX96, this.liquidity, false));
+            }
+            else {
+                this._token1Amount = sdk_core_1.CurrencyAmount.fromRawAmount(this.pool.currency1, v3_sdk_1.SqrtPriceMath.getAmount1Delta(v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickLower), v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, false));
+            }
+        }
+        return this._token1Amount;
+    }
+    /**
+     * Returns the lower and upper sqrt ratios if the price 'slips' up to slippage tolerance percentage
+     * @param slippageTolerance The amount by which the price can 'slip' before the transaction will revert
+     * @returns The sqrt ratios after slippage
+     */
+    ratiosAfterSlippage(slippageTolerance) {
+        const priceLower = this.pool.token0Price.asFraction.multiply(new sdk_core_1.Percent(1).subtract(slippageTolerance));
+        const priceUpper = this.pool.token0Price.asFraction.multiply(slippageTolerance.add(1));
+        let sqrtRatioX96Lower = (0, v3_sdk_1.encodeSqrtRatioX96)(priceLower.numerator, priceLower.denominator);
+        if (jsbi_1.default.lessThanOrEqual(sqrtRatioX96Lower, v3_sdk_1.TickMath.MIN_SQRT_RATIO)) {
+            sqrtRatioX96Lower = jsbi_1.default.add(v3_sdk_1.TickMath.MIN_SQRT_RATIO, jsbi_1.default.BigInt(1));
+        }
+        let sqrtRatioX96Upper = (0, v3_sdk_1.encodeSqrtRatioX96)(priceUpper.numerator, priceUpper.denominator);
+        if (jsbi_1.default.greaterThanOrEqual(sqrtRatioX96Upper, v3_sdk_1.TickMath.MAX_SQRT_RATIO)) {
+            sqrtRatioX96Upper = jsbi_1.default.subtract(v3_sdk_1.TickMath.MAX_SQRT_RATIO, jsbi_1.default.BigInt(1));
+        }
+        return {
+            sqrtRatioX96Lower,
+            sqrtRatioX96Upper,
+        };
+    }
+    /**
+     * Returns the maximum amount of token0 and token1 that must be sent in order to safely mint the amount of liquidity held by the position
+     * with the given slippage tolerance
+     * @param slippageTolerance Tolerance of unfavorable slippage from the current price
+     * @returns The amounts, with slippage
+     * @dev In v4, minting and increasing is protected by maximum amounts of token0 and token1.
+     */
+    mintAmountsWithSlippage(slippageTolerance) {
+        // get lower/upper prices
+        // these represent the lowest and highest prices that the pool is allowed to "slip" to
+        const { sqrtRatioX96Upper, sqrtRatioX96Lower } = this.ratiosAfterSlippage(slippageTolerance);
+        // construct counterfactual pools from the lower bounded price and the upper bounded price
+        const poolLower = new pool_1.Pool(this.pool.token0, this.pool.token1, this.pool.fee, this.pool.tickSpacing, this.pool.hooks, sqrtRatioX96Lower, 0 /* liquidity doesn't matter */, v3_sdk_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Lower));
+        const poolUpper = new pool_1.Pool(this.pool.token0, this.pool.token1, this.pool.fee, this.pool.tickSpacing, this.pool.hooks, sqrtRatioX96Upper, 0 /* liquidity doesn't matter */, v3_sdk_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Upper));
+        // Note: Slippage derivation in v4 is different from v3.
+        // When creating a position (minting) or adding to a position (increasing) slippage is bounded by the MAXIMUM amount in in token0 and token1.
+        // The largest amount of token1 will happen when the price slips up, so we use the poolUpper to get amount1.
+        // The largest amount of token0 will happen when the price slips down, so we use the poolLower to get amount0.
+        // Ie...We want the larger amounts, which occurs at the upper price for amount1...
+        const { amount1 } = new Position({
+            pool: poolUpper,
+            liquidity: this.liquidity,
+            tickLower: this.tickLower,
+            tickUpper: this.tickUpper,
+        }).mintAmounts;
+        // ...and the lower for amount0
+        const { amount0 } = new Position({
+            pool: poolLower,
+            liquidity: this.liquidity,
+            tickLower: this.tickLower,
+            tickUpper: this.tickUpper,
+        }).mintAmounts;
+        return { amount0, amount1 };
+    }
+    /**
+     * Returns the minimum amounts that should be requested in order to safely burn the amount of liquidity held by the
+     * position with the given slippage tolerance
+     * @param slippageTolerance tolerance of unfavorable slippage from the current price
+     * @returns The amounts, with slippage
+     */
+    burnAmountsWithSlippage(slippageTolerance) {
+        // get lower/upper prices
+        const { sqrtRatioX96Upper, sqrtRatioX96Lower } = this.ratiosAfterSlippage(slippageTolerance);
+        // construct counterfactual pools
+        const poolLower = new pool_1.Pool(this.pool.currency0, this.pool.currency1, this.pool.fee, this.pool.tickSpacing, this.pool.hooks, sqrtRatioX96Lower, 0 /* liquidity doesn't matter */, v3_sdk_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Lower));
+        const poolUpper = new pool_1.Pool(this.pool.currency0, this.pool.currency1, this.pool.fee, this.pool.tickSpacing, this.pool.hooks, sqrtRatioX96Upper, 0 /* liquidity doesn't matter */, v3_sdk_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Upper));
+        // we want the smaller amounts...
+        // ...which occurs at the upper price for amount0...
+        const amount0 = new Position({
+            pool: poolUpper,
+            liquidity: this.liquidity,
+            tickLower: this.tickLower,
+            tickUpper: this.tickUpper,
+        }).amount0;
+        // ...and the lower for amount1
+        const amount1 = new Position({
+            pool: poolLower,
+            liquidity: this.liquidity,
+            tickLower: this.tickLower,
+            tickUpper: this.tickUpper,
+        }).amount1;
+        return { amount0: amount0.quotient, amount1: amount1.quotient };
+    }
+    /**
+     * Returns the minimum amounts that must be sent in order to mint the amount of liquidity held by the position at
+     * the current price for the pool
+     */
+    get mintAmounts() {
+        if (this._mintAmounts === null) {
+            if (this.pool.tickCurrent < this.tickLower) {
+                return {
+                    amount0: v3_sdk_1.SqrtPriceMath.getAmount0Delta(v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickLower), v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, true),
+                    amount1: internalConstants_1.ZERO,
+                };
+            }
+            else if (this.pool.tickCurrent < this.tickUpper) {
+                return {
+                    amount0: v3_sdk_1.SqrtPriceMath.getAmount0Delta(this.pool.sqrtRatioX96, v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, true),
+                    amount1: v3_sdk_1.SqrtPriceMath.getAmount1Delta(v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickLower), this.pool.sqrtRatioX96, this.liquidity, true),
+                };
+            }
+            else {
+                return {
+                    amount0: internalConstants_1.ZERO,
+                    amount1: v3_sdk_1.SqrtPriceMath.getAmount1Delta(v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickLower), v3_sdk_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, true),
+                };
+            }
+        }
+        return this._mintAmounts;
+    }
+    /**
+     * Returns the AllowanceTransferPermitBatch for adding liquidity to a position
+     * @param slippageTolerance The amount by which the price can 'slip' before the transaction will revert
+     * @param spender The spender of the permit (should usually be the PositionManager)
+     * @param nonce A valid permit2 nonce
+     * @param deadline The deadline for the permit
+     */
+    permitBatchData(slippageTolerance, spender, nonce, deadline) {
+        const { amount0, amount1 } = this.mintAmountsWithSlippage(slippageTolerance);
+        return {
+            details: [
+                {
+                    token: this.pool.currency0.wrapped.address,
+                    amount: amount0,
+                    expiration: deadline,
+                    nonce: nonce,
+                },
+                {
+                    token: this.pool.currency1.wrapped.address,
+                    amount: amount1,
+                    expiration: deadline,
+                    nonce: nonce,
+                },
+            ],
+            spender,
+            sigDeadline: deadline,
+        };
+    }
+    /**
+     * Computes the maximum amount of liquidity received for a given amount of token0, token1,
+     * and the prices at the tick boundaries.
+     * @param pool The pool for which the position should be created
+     * @param tickLower The lower tick of the position
+     * @param tickUpper The upper tick of the position
+     * @param amount0 token0 amountzw
+     * @param amount1 token1 amount
+     * @param useFullPrecision If false, liquidity will be maximized according to what the router can calculate,
+     * not what core can theoretically support
+     * @returns The amount of liquidity for the position
+     */
+    static fromAmounts({ pool, tickLower, tickUpper, amount0, amount1, useFullPrecision, }) {
+        const sqrtRatioAX96 = v3_sdk_1.TickMath.getSqrtRatioAtTick(tickLower);
+        const sqrtRatioBX96 = v3_sdk_1.TickMath.getSqrtRatioAtTick(tickUpper);
+        return new Position({
+            pool,
+            tickLower,
+            tickUpper,
+            liquidity: (0, v3_sdk_1.maxLiquidityForAmounts)(pool.sqrtRatioX96, sqrtRatioAX96, sqrtRatioBX96, amount0, amount1, useFullPrecision),
+        });
+    }
+    /**
+     * Computes a position with the maximum amount of liquidity received for a given amount of token0, assuming an unlimited amount of token1
+     * @param pool The pool for which the position is created
+     * @param tickLower The lower tick
+     * @param tickUpper The upper tick
+     * @param amount0 The desired amount of token0
+     * @param useFullPrecision If true, liquidity will be maximized according to what the router can calculate,
+     * not what core can theoretically support
+     * @returns The position
+     */
+    static fromAmount0({ pool, tickLower, tickUpper, amount0, useFullPrecision, }) {
+        return Position.fromAmounts({ pool, tickLower, tickUpper, amount0, amount1: sdk_core_1.MaxUint256, useFullPrecision });
+    }
+    /**
+     * Computes a position with the maximum amount of liquidity received for a given amount of token1, assuming an unlimited amount of token0
+     * @param pool The pool for which the position is created
+     * @param tickLower The lower tick
+     * @param tickUpper The upper tick
+     * @param amount1 The desired amount of token1
+     * @returns The position
+     */
+    static fromAmount1({ pool, tickLower, tickUpper, amount1, }) {
+        // this function always uses full precision,
+        return Position.fromAmounts({ pool, tickLower, tickUpper, amount0: sdk_core_1.MaxUint256, amount1, useFullPrecision: true });
+    }
+}
+exports.Position = Position;
+//# sourceMappingURL=position.js.map

package/dist/cjs/src/entities/position.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../../src/entities/position.ts"],"names":[],"mappings":";;;;AAAA,uDAA0G;AAC1G,wDAAuB;AACvB,4EAAsC;AACtC,iCAA6B;AAC7B,mDAA4G;AAC5G,4DAA2C;AAC3C,wEAA2D;AAU3D;;;;;GAKG;AACH,MAAa,QAAQ;IAWnB;;;;;;OAMG;IACH,YAAmB,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAA2B;QAZrF,gCAAgC;QACxB,kBAAa,GAAoC,IAAI,CAAA;QACrD,kBAAa,GAAoC,IAAI,CAAA;QACrD,iBAAY,GAAsD,IAAI,CAAA;QAU5E,IAAA,wBAAS,EAAC,SAAS,GAAG,SAAS,EAAE,YAAY,CAAC,CAAA;QAC9C,IAAA,wBAAS,EAAC,SAAS,IAAI,iBAAQ,CAAC,QAAQ,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,KAAK,CAAC,EAAE,YAAY,CAAC,CAAA;QAC7F,IAAA,wBAAS,EAAC,SAAS,IAAI,iBAAQ,CAAC,QAAQ,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,KAAK,CAAC,EAAE,YAAY,CAAC,CAAA;QAE7F,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,cAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAA,kCAAW,EAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC9E,CAAC;IAED;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAA,kCAAW,EAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC9E,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBAC1C,IAAI,CAAC,aAAa,GAAG,yBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,sBAAa,CAAC,eAAe,CAC3B,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,KAAK,CACN,CACF,CAAA;aACF;iBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBACjD,IAAI,CAAC,aAAa,GAAG,yBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,sBAAa,CAAC,eAAe,CAC3B,IAAI,CAAC,IAAI,CAAC,YAAY,EACtB,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,KAAK,CACN,CACF,CAAA;aACF;iBAAM;gBACL,IAAI,CAAC,aAAa,GAAG,yBAAc,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,wBAAI,CAAC,CAAA;aAC7E;SACF;QACD,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBAC1C,IAAI,CAAC,aAAa,GAAG,yBAAc,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,wBAAI,CAAC,CAAA;aAC7E;iBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBACjD,IAAI,CAAC,aAAa,GAAG,yBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,sBAAa,CAAC,eAAe,CAC3B,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,IAAI,CAAC,YAAY,EACtB,IAAI,CAAC,SAAS,EACd,KAAK,CACN,CACF,CAAA;aACF;iBAAM;gBACL,IAAI,CAAC,aAAa,GAAG,yBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,sBAAa,CAAC,eAAe,CAC3B,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,KAAK,CACN,CACF,CAAA;aACF;SACF;QACD,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;;;OAIG;IACK,mBAAmB,CAAC,iBAA0B;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,kBAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAA;QACxG,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QACtF,IAAI,iBAAiB,GAAG,IAAA,2BAAkB,EAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;QACxF,IAAI,cAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,iBAAQ,CAAC,cAAc,CAAC,EAAE;YACpE,iBAAiB,GAAG,cAAI,CAAC,GAAG,CAAC,iBAAQ,CAAC,cAAc,EAAE,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SACtE;QACD,IAAI,iBAAiB,GAAG,IAAA,2BAAkB,EAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;QACxF,IAAI,cAAI,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,iBAAQ,CAAC,cAAc,CAAC,EAAE;YACvE,iBAAiB,GAAG,cAAI,CAAC,QAAQ,CAAC,iBAAQ,CAAC,cAAc,EAAE,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SAC3E;QACD,OAAO;YACL,iBAAiB;YACjB,iBAAiB;SAClB,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACI,uBAAuB,CAAC,iBAA0B;QACvD,yBAAyB;QACzB,sFAAsF;QACtF,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;QAE5F,0FAA0F;QAC1F,MAAM,SAAS,GAAG,IAAI,WAAI,CACxB,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,GAAG,EACb,IAAI,CAAC,IAAI,CAAC,WAAW,EACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,iBAAQ,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAC/C,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,WAAI,CACxB,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,GAAG,EACb,IAAI,CAAC,IAAI,CAAC,WAAW,EACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,iBAAQ,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAC/C,CAAA;QAED,wDAAwD;QACxD,6IAA6I;QAC7I,4GAA4G;QAC5G,8GAA8G;QAC9G,kFAAkF;QAClF,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,QAAQ,CAAC;YAC/B,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC,WAAW,CAAA;QACd,+BAA+B;QAC/B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,QAAQ,CAAC;YAC/B,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC,WAAW,CAAA;QAEd,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,iBAA0B;QACvD,yBAAyB;QACzB,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;QAE5F,iCAAiC;QACjC,MAAM,SAAS,GAAG,IAAI,WAAI,CACxB,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,IAAI,CAAC,IAAI,CAAC,GAAG,EACb,IAAI,CAAC,IAAI,CAAC,WAAW,EACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,iBAAQ,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAC/C,CAAA;QACD,MAAM,SAAS,GAAG,IAAI,WAAI,CACxB,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,IAAI,CAAC,IAAI,CAAC,SAAS,EACnB,IAAI,CAAC,IAAI,CAAC,GAAG,EACb,IAAI,CAAC,IAAI,CAAC,WAAW,EACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EACf,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,iBAAQ,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAC/C,CAAA;QAED,iCAAiC;QACjC,oDAAoD;QACpD,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC;YAC3B,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC,OAAO,CAAA;QACV,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC;YAC3B,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC,OAAO,CAAA;QAEV,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACjE,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,IAAI,IAAI,CAAC,YAAY,KAAK,IAAI,EAAE;YAC9B,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBAC1C,OAAO;oBACL,OAAO,EAAE,sBAAa,CAAC,eAAe,CACpC,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,IAAI,CACL;oBACD,OAAO,EAAE,wBAAI;iBACd,CAAA;aACF;iBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBACjD,OAAO;oBACL,OAAO,EAAE,sBAAa,CAAC,eAAe,CACpC,IAAI,CAAC,IAAI,CAAC,YAAY,EACtB,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,IAAI,CACL;oBACD,OAAO,EAAE,sBAAa,CAAC,eAAe,CACpC,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,IAAI,CAAC,YAAY,EACtB,IAAI,CAAC,SAAS,EACd,IAAI,CACL;iBACF,CAAA;aACF;iBAAM;gBACL,OAAO;oBACL,OAAO,EAAE,wBAAI;oBACb,OAAO,EAAE,sBAAa,CAAC,eAAe,CACpC,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,iBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,IAAI,CACL;iBACF,CAAA;aACF;SACF;QACD,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CACpB,iBAA0B,EAC1B,OAAe,EACf,KAAgB,EAChB,QAAmB;QAEnB,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAA;QAC5E,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO;oBAC1C,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,QAAQ;oBACpB,KAAK,EAAE,KAAK;iBACb;gBACD;oBACE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO;oBAC1C,MAAM,EAAE,OAAO;oBACf,UAAU,EAAE,QAAQ;oBACpB,KAAK,EAAE,KAAK;iBACb;aACF;YACD,OAAO;YACP,WAAW,EAAE,QAAQ;SACtB,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,WAAW,CAAC,EACxB,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,EACP,OAAO,EACP,gBAAgB,GAQjB;QACC,MAAM,aAAa,GAAG,iBAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC5D,MAAM,aAAa,GAAG,iBAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC5D,OAAO,IAAI,QAAQ,CAAC;YAClB,IAAI;YACJ,SAAS;YACT,SAAS;YACT,SAAS,EAAE,IAAA,+BAAsB,EAC/B,IAAI,CAAC,YAAY,EACjB,aAAa,EACb,aAAa,EACb,OAAO,EACP,OAAO,EACP,gBAAgB,CACjB;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,WAAW,CAAC,EACxB,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,EACP,gBAAgB,GAOjB;QACC,OAAO,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,qBAAU,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAC7G,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,EACxB,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,GAMR;QACC,4CAA4C;QAC5C,OAAO,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,qBAAU,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAA;IACnH,CAAC;CACF;AAxZD,4BAwZC"}

package/dist/{entities → cjs/src/entities}/route.d.ts

@@ -1,28 +1,28 @@
-import { Currency, Price } from '@kittycorn-labs/sdk-core';
-import { Pool } from './pool';
-/**
- * Represents a list of pools through which a swap can occur
- * @template TInput The input currency
- * @template TOutput The output currency
- */
-export declare class Route<TInput extends Currency, TOutput extends Currency> {
-    readonly pools: Pool[];
-    readonly currencyPath: Currency[];
-    readonly input: TInput;
-    readonly output: TOutput;
-    readonly pathInput: Currency;
-    readonly pathOutput: Currency;
-    private _midPrice;
-    /**
-     * Creates an instance of route.
-     * @param pools An array of `Pool` objects, ordered by the route the swap will take
-     * @param input The input currency
-     * @param output The output currency
-     */
-    constructor(pools: Pool[], input: TInput, output: TOutput);
-    get chainId(): number;
-    /**
-     * Returns the mid price of the route
-     */
-    get midPrice(): Price<TInput, TOutput>;
-}
+import { Currency, Price } from '@kittycorn-labs/sdk-core';
+import { Pool } from './pool';
+/**
+ * Represents a list of pools through which a swap can occur
+ * @template TInput The input currency
+ * @template TOutput The output currency
+ */
+export declare class Route<TInput extends Currency, TOutput extends Currency> {
+    readonly pools: Pool[];
+    readonly currencyPath: Currency[];
+    readonly input: TInput;
+    readonly output: TOutput;
+    readonly pathInput: Currency;
+    readonly pathOutput: Currency;
+    private _midPrice;
+    /**
+     * Creates an instance of route.
+     * @param pools An array of `Pool` objects, ordered by the route the swap will take
+     * @param input The input currency
+     * @param output The output currency
+     */
+    constructor(pools: Pool[], input: TInput, output: TOutput);
+    get chainId(): number;
+    /**
+     * Returns the mid price of the route
+     */
+    get midPrice(): Price<TInput, TOutput>;
+}