@synthra-swap/sdk 0.1.4

package/dist/v3/entities/position.d.ts

@@ -0,0 +1,131 @@
+import { BigintIsh, Percent, Price, CurrencyAmount, Token } from '../../core';
+import JSBI from 'jsbi';
+import { Pool } from './pool';
+interface PositionConstructorArgs {
+    pool: Pool;
+    tickLower: number;
+    tickUpper: number;
+    liquidity: BigintIsh;
+}
+/**
+ * Represents a position on a Synthra V3 pool.
+ */
+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<Token, Token>;
+    /**
+     * Returns the price of token0 at the upper tick
+     */
+    get token0PriceUpper(): Price<Token, Token>;
+    /**
+     * Returns the amount of token0 that this position's liquidity could be burned for at the current pool price
+     */
+    get amount0(): CurrencyAmount<Token>;
+    /**
+     * Returns the amount of token1 that this position's liquidity could be burned for at the current pool price
+     */
+    get amount1(): CurrencyAmount<Token>;
+    /**
+     * 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 minimum amounts 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
+     */
+    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;
+    }>;
+    /**
+     * 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 amount
+     * @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/v3/entities/position.js

@@ -0,0 +1,250 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Position = void 0;
+const core_1 = require("../../core");
+const jsbi_1 = __importDefault(require("jsbi"));
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const internalConstants_1 = require("../internalConstants");
+const maxLiquidityForAmounts_1 = require("../utils/maxLiquidityForAmounts");
+const priceTickConversions_1 = require("../utils/priceTickConversions");
+const sqrtPriceMath_1 = require("../utils/sqrtPriceMath");
+const tickMath_1 = require("../utils/tickMath");
+const encodeSqrtRatioX96_1 = require("../utils/encodeSqrtRatioX96");
+const pool_1 = require("./pool");
+/**
+ * Represents a position on a Synthra V3 pool.
+ */
+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 >= tickMath_1.TickMath.MIN_TICK && tickLower % pool.tickSpacing === 0, 'TICK_LOWER');
+        (0, tiny_invariant_1.default)(tickUpper <= tickMath_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.token0, this.pool.token1, this.tickLower);
+    }
+    /**
+     * Returns the price of token0 at the upper tick
+     */
+    get token0PriceUpper() {
+        return (0, priceTickConversions_1.tickToPrice)(this.pool.token0, this.pool.token1, 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 === null) {
+            if (this.pool.tickCurrent < this.tickLower) {
+                this._token0Amount = core_1.CurrencyAmount.fromRawAmount(this.pool.token0, sqrtPriceMath_1.SqrtPriceMath.getAmount0Delta(tickMath_1.TickMath.getSqrtRatioAtTick(this.tickLower), tickMath_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, false));
+            }
+            else if (this.pool.tickCurrent < this.tickUpper) {
+                this._token0Amount = core_1.CurrencyAmount.fromRawAmount(this.pool.token0, sqrtPriceMath_1.SqrtPriceMath.getAmount0Delta(this.pool.sqrtRatioX96, tickMath_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, false));
+            }
+            else {
+                this._token0Amount = core_1.CurrencyAmount.fromRawAmount(this.pool.token0, 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 === null) {
+            if (this.pool.tickCurrent < this.tickLower) {
+                this._token1Amount = core_1.CurrencyAmount.fromRawAmount(this.pool.token1, internalConstants_1.ZERO);
+            }
+            else if (this.pool.tickCurrent < this.tickUpper) {
+                this._token1Amount = core_1.CurrencyAmount.fromRawAmount(this.pool.token1, sqrtPriceMath_1.SqrtPriceMath.getAmount1Delta(tickMath_1.TickMath.getSqrtRatioAtTick(this.tickLower), this.pool.sqrtRatioX96, this.liquidity, false));
+            }
+            else {
+                this._token1Amount = core_1.CurrencyAmount.fromRawAmount(this.pool.token1, sqrtPriceMath_1.SqrtPriceMath.getAmount1Delta(tickMath_1.TickMath.getSqrtRatioAtTick(this.tickLower), tickMath_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 core_1.Percent(1).subtract(slippageTolerance));
+        const priceUpper = this.pool.token0Price.asFraction.multiply(slippageTolerance.add(1));
+        let sqrtRatioX96Lower = (0, encodeSqrtRatioX96_1.encodeSqrtRatioX96)(priceLower.numerator, priceLower.denominator);
+        if (jsbi_1.default.lessThanOrEqual(sqrtRatioX96Lower, tickMath_1.TickMath.MIN_SQRT_RATIO)) {
+            sqrtRatioX96Lower = jsbi_1.default.add(tickMath_1.TickMath.MIN_SQRT_RATIO, jsbi_1.default.BigInt(1));
+        }
+        let sqrtRatioX96Upper = (0, encodeSqrtRatioX96_1.encodeSqrtRatioX96)(priceUpper.numerator, priceUpper.denominator);
+        if (jsbi_1.default.greaterThanOrEqual(sqrtRatioX96Upper, tickMath_1.TickMath.MAX_SQRT_RATIO)) {
+            sqrtRatioX96Upper = jsbi_1.default.subtract(tickMath_1.TickMath.MAX_SQRT_RATIO, jsbi_1.default.BigInt(1));
+        }
+        return {
+            sqrtRatioX96Lower,
+            sqrtRatioX96Upper
+        };
+    }
+    /**
+     * Returns the minimum amounts 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
+     */
+    mintAmountsWithSlippage(slippageTolerance) {
+        // get lower/upper prices
+        const { sqrtRatioX96Upper, sqrtRatioX96Lower } = this.ratiosAfterSlippage(slippageTolerance);
+        // construct counterfactual pools
+        const poolLower = new pool_1.Pool(this.pool.token0, this.pool.token1, this.pool.fee, sqrtRatioX96Lower, 0 /* liquidity doesn't matter */, tickMath_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Lower));
+        const poolUpper = new pool_1.Pool(this.pool.token0, this.pool.token1, this.pool.fee, sqrtRatioX96Upper, 0 /* liquidity doesn't matter */, tickMath_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Upper));
+        // because the router is imprecise, we need to calculate the position that will be created (assuming no slippage)
+        const positionThatWillBeCreated = Position.fromAmounts({
+            pool: this.pool,
+            tickLower: this.tickLower,
+            tickUpper: this.tickUpper,
+            ...this.mintAmounts,
+            useFullPrecision: false
+        });
+        // we want the smaller amounts...
+        // ...which occurs at the upper price for amount0...
+        const { amount0 } = new Position({
+            pool: poolUpper,
+            liquidity: positionThatWillBeCreated.liquidity,
+            tickLower: this.tickLower,
+            tickUpper: this.tickUpper
+        }).mintAmounts;
+        // ...and the lower for amount1
+        const { amount1 } = new Position({
+            pool: poolLower,
+            liquidity: positionThatWillBeCreated.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.token0, this.pool.token1, this.pool.fee, sqrtRatioX96Lower, 0 /* liquidity doesn't matter */, tickMath_1.TickMath.getTickAtSqrtRatio(sqrtRatioX96Lower));
+        const poolUpper = new pool_1.Pool(this.pool.token0, this.pool.token1, this.pool.fee, sqrtRatioX96Upper, 0 /* liquidity doesn't matter */, tickMath_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: sqrtPriceMath_1.SqrtPriceMath.getAmount0Delta(tickMath_1.TickMath.getSqrtRatioAtTick(this.tickLower), tickMath_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, true),
+                    amount1: internalConstants_1.ZERO
+                };
+            }
+            else if (this.pool.tickCurrent < this.tickUpper) {
+                return {
+                    amount0: sqrtPriceMath_1.SqrtPriceMath.getAmount0Delta(this.pool.sqrtRatioX96, tickMath_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, true),
+                    amount1: sqrtPriceMath_1.SqrtPriceMath.getAmount1Delta(tickMath_1.TickMath.getSqrtRatioAtTick(this.tickLower), this.pool.sqrtRatioX96, this.liquidity, true)
+                };
+            }
+            else {
+                return {
+                    amount0: internalConstants_1.ZERO,
+                    amount1: sqrtPriceMath_1.SqrtPriceMath.getAmount1Delta(tickMath_1.TickMath.getSqrtRatioAtTick(this.tickLower), tickMath_1.TickMath.getSqrtRatioAtTick(this.tickUpper), this.liquidity, true)
+                };
+            }
+        }
+        return this._mintAmounts;
+    }
+    /**
+     * 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 amount
+     * @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 = tickMath_1.TickMath.getSqrtRatioAtTick(tickLower);
+        const sqrtRatioBX96 = tickMath_1.TickMath.getSqrtRatioAtTick(tickUpper);
+        return new Position({
+            pool,
+            tickLower,
+            tickUpper,
+            liquidity: (0, maxLiquidityForAmounts_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: 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: core_1.MaxUint256, amount1, useFullPrecision: true });
+    }
+}
+exports.Position = Position;
+//# sourceMappingURL=position.js.map

package/dist/v3/entities/position.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../src/v3/entities/position.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAyF;AACzF,gDAAuB;AACvB,oEAAsC;AACtC,4DAA2C;AAC3C,4EAAwE;AACxE,wEAA2D;AAC3D,0DAAsD;AACtD,gDAA4C;AAC5C,oEAAgE;AAChE,iCAA6B;AAS7B;;GAEG;AACH,MAAa,QAAQ;IAWnB;;;;;;OAMG;IACH,YAAmB,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAA2B;QAZrF,gCAAgC;QACxB,kBAAa,GAAiC,IAAI,CAAA;QAClD,kBAAa,GAAiC,IAAI,CAAA;QAClD,iBAAY,GAAsD,IAAI,CAAA;QAU5E,IAAA,wBAAS,EAAC,SAAS,GAAG,SAAS,EAAE,YAAY,CAAC,CAAA;QAC9C,IAAA,wBAAS,EAAC,SAAS,IAAI,mBAAQ,CAAC,QAAQ,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,KAAK,CAAC,EAAE,YAAY,CAAC,CAAA;QAC7F,IAAA,wBAAS,EAAC,SAAS,IAAI,mBAAQ,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,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACxE,CAAC;IAED;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAA,kCAAW,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACxE,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE;YAC/B,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBAC1C,IAAI,CAAC,aAAa,GAAG,qBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,6BAAa,CAAC,eAAe,CAC3B,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,mBAAQ,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,qBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,6BAAa,CAAC,eAAe,CAC3B,IAAI,CAAC,IAAI,CAAC,YAAY,EACtB,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,KAAK,CACN,CACF,CAAA;aACF;iBAAM;gBACL,IAAI,CAAC,aAAa,GAAG,qBAAc,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,wBAAI,CAAC,CAAA;aAC1E;SACF;QACD,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE;YAC/B,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBAC1C,IAAI,CAAC,aAAa,GAAG,qBAAc,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,wBAAI,CAAC,CAAA;aAC1E;iBAAM,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE;gBACjD,IAAI,CAAC,aAAa,GAAG,qBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,6BAAa,CAAC,eAAe,CAC3B,mBAAQ,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,qBAAc,CAAC,aAAa,CAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,6BAAa,CAAC,eAAe,CAC3B,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,mBAAQ,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,cAAO,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,uCAAkB,EAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;QACxF,IAAI,cAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,mBAAQ,CAAC,cAAc,CAAC,EAAE;YACpE,iBAAiB,GAAG,cAAI,CAAC,GAAG,CAAC,mBAAQ,CAAC,cAAc,EAAE,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SACtE;QACD,IAAI,iBAAiB,GAAG,IAAA,uCAAkB,EAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;QACxF,IAAI,cAAI,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,mBAAQ,CAAC,cAAc,CAAC,EAAE;YACvE,iBAAiB,GAAG,cAAI,CAAC,QAAQ,CAAC,mBAAQ,CAAC,cAAc,EAAE,cAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;SAC3E;QACD,OAAO;YACL,iBAAiB;YACjB,iBAAiB;SAClB,CAAA;IACH,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,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,GAAG,EACb,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,mBAAQ,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,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,mBAAQ,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAC/C,CAAA;QAED,iHAAiH;QACjH,MAAM,yBAAyB,GAAG,QAAQ,CAAC,WAAW,CAAC;YACrD,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,GAAG,IAAI,CAAC,WAAW;YACnB,gBAAgB,EAAE,KAAK;SACxB,CAAC,CAAA;QAEF,iCAAiC;QACjC,oDAAoD;QACpD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,QAAQ,CAAC;YAC/B,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,yBAAyB,CAAC,SAAS;YAC9C,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,yBAAyB,CAAC,SAAS;YAC9C,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,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAChB,IAAI,CAAC,IAAI,CAAC,GAAG,EACb,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,mBAAQ,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,iBAAiB,EACjB,CAAC,CAAC,8BAA8B,EAChC,mBAAQ,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,6BAAa,CAAC,eAAe,CACpC,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,mBAAQ,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,6BAAa,CAAC,eAAe,CACpC,IAAI,CAAC,IAAI,CAAC,YAAY,EACtB,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,IAAI,CAAC,SAAS,EACd,IAAI,CACL;oBACD,OAAO,EAAE,6BAAa,CAAC,eAAe,CACpC,mBAAQ,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,6BAAa,CAAC,eAAe,CACpC,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAC3C,mBAAQ,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;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,WAAW,CAAC,EACxB,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,EACP,OAAO,EACP,gBAAgB,EAQjB;QACC,MAAM,aAAa,GAAG,mBAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC5D,MAAM,aAAa,GAAG,mBAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAA;QAC5D,OAAO,IAAI,QAAQ,CAAC;YAClB,IAAI;YACJ,SAAS;YACT,SAAS;YACT,SAAS,EAAE,IAAA,+CAAsB,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,EAOjB;QACC,OAAO,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAU,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAC7G,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW,CAAC,EACxB,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,EAMR;QACC,4CAA4C;QAC5C,OAAO,QAAQ,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAU,EAAE,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAA;IACnH,CAAC;CACF;AAlXD,4BAkXC"}

package/dist/v3/entities/route.d.ts

@@ -0,0 +1,26 @@
+import { Currency, Price, Token } from '../../core';
+import { Pool } from './pool';
+/**
+ * Represents a list of pools through which a swap can occur
+ * @template TInput The input token
+ * @template TOutput The output token
+ */
+export declare class Route<TInput extends Currency, TOutput extends Currency> {
+    readonly pools: Pool[];
+    readonly tokenPath: Token[];
+    readonly input: TInput;
+    readonly output: TOutput;
+    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 token
+     * @param output The output token
+     */
+    constructor(pools: Pool[], input: TInput, output: TOutput);
+    get chainId(): number;
+    /**
+     * Returns the mid price of the route
+     */
+    get midPrice(): Price<TInput, TOutput>;
+}

package/dist/v3/entities/route.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Route = void 0;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const core_1 = require("../../core");
+/**
+ * Represents a list of pools through which a swap can occur
+ * @template TInput The input token
+ * @template TOutput The output token
+ */
+class Route {
+    /**
+     * Creates an instance of route.
+     * @param pools An array of `Pool` objects, ordered by the route the swap will take
+     * @param input The input token
+     * @param output The output token
+     */
+    constructor(pools, input, output) {
+        this._midPrice = null;
+        (0, tiny_invariant_1.default)(pools.length > 0, 'POOLS');
+        const chainId = pools[0].chainId;
+        const allOnSameChain = pools.every(pool => pool.chainId === chainId);
+        (0, tiny_invariant_1.default)(allOnSameChain, 'CHAIN_IDS');
+        const wrappedInput = input.wrapped;
+        (0, tiny_invariant_1.default)(pools[0].involvesToken(wrappedInput), 'INPUT');
+        (0, tiny_invariant_1.default)(pools[pools.length - 1].involvesToken(output.wrapped), 'OUTPUT');
+        /**
+         * Normalizes token0-token1 order and selects the next token/fee step to add to the path
+         * */
+        const tokenPath = [wrappedInput];
+        for (const [i, pool] of pools.entries()) {
+            const currentInputToken = tokenPath[i];
+            (0, tiny_invariant_1.default)(currentInputToken.equals(pool.token0) || currentInputToken.equals(pool.token1), 'PATH');
+            const nextToken = currentInputToken.equals(pool.token0) ? pool.token1 : pool.token0;
+            tokenPath.push(nextToken);
+        }
+        this.pools = pools;
+        this.tokenPath = tokenPath;
+        this.input = input;
+        this.output = (output !== null && output !== void 0 ? output : tokenPath[tokenPath.length - 1]);
+    }
+    get chainId() {
+        return this.pools[0].chainId;
+    }
+    /**
+     * Returns the mid price of the route
+     */
+    get midPrice() {
+        if (this._midPrice !== null)
+            return this._midPrice;
+        const price = this.pools.slice(1).reduce(({ nextInput, price }, pool) => {
+            return nextInput.equals(pool.token0)
+                ? {
+                    nextInput: pool.token1,
+                    price: price.multiply(pool.token0Price)
+                }
+                : {
+                    nextInput: pool.token0,
+                    price: price.multiply(pool.token1Price)
+                };
+        }, this.pools[0].token0.equals(this.input.wrapped)
+            ? {
+                nextInput: this.pools[0].token1,
+                price: this.pools[0].token0Price
+            }
+            : {
+                nextInput: this.pools[0].token0,
+                price: this.pools[0].token1Price
+            }).price;
+        return (this._midPrice = new core_1.Price(this.input, this.output, price.denominator, price.numerator));
+    }
+}
+exports.Route = Route;
+//# sourceMappingURL=route.js.map

package/dist/v3/entities/route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../src/v3/entities/route.ts"],"names":[],"mappings":";;;;;;AAAA,oEAAsC;AAEtC,qCAAmD;AAGnD;;;;GAIG;AACH,MAAa,KAAK;IAQhB;;;;;OAKG;IACH,YAAmB,KAAa,EAAE,KAAa,EAAE,MAAe;QARxD,cAAS,GAAkC,IAAI,CAAA;QASrD,IAAA,wBAAS,EAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;QAEpC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;QAChC,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,OAAO,CAAC,CAAA;QACpE,IAAA,wBAAS,EAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAEtC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAA;QAClC,IAAA,wBAAS,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,CAAA;QAExD,IAAA,wBAAS,EAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAA;QAE1E;;aAEK;QACL,MAAM,SAAS,GAAY,CAAC,YAAY,CAAC,CAAA;QACzC,KAAK,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE;YACvC,MAAM,iBAAiB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YACtC,IAAA,wBAAS,EAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAA;YACjG,MAAM,SAAS,GAAG,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;YACnF,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;SAC1B;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAY,CAAA;IACtE,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,SAAS,CAAA;QAElD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CACtC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE;YAC7B,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;gBAClC,CAAC,CAAC;oBACE,SAAS,EAAE,IAAI,CAAC,MAAM;oBACtB,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;iBACxC;gBACH,CAAC,CAAC;oBACE,SAAS,EAAE,IAAI,CAAC,MAAM;oBACtB,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;iBACxC,CAAA;QACP,CAAC,EACD,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;YAC7C,CAAC,CAAC;gBACE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;gBAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW;aACjC;YACH,CAAC,CAAC;gBACE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM;gBAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW;aACjC,CACN,CAAC,KAAK,CAAA;QAEP,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,YAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAA;IAClG,CAAC;CACF;AA9ED,sBA8EC"}

package/dist/v3/entities/tick.d.ts

@@ -0,0 +1,13 @@
+import JSBI from 'jsbi';
+import { BigintIsh } from '../../core';
+export interface TickConstructorArgs {
+    index: number;
+    liquidityGross: BigintIsh;
+    liquidityNet: BigintIsh;
+}
+export declare class Tick {
+    readonly index: number;
+    readonly liquidityGross: JSBI;
+    readonly liquidityNet: JSBI;
+    constructor({ index, liquidityGross, liquidityNet }: TickConstructorArgs);
+}

package/dist/v3/entities/tick.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tick = void 0;
+const jsbi_1 = __importDefault(require("jsbi"));
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const utils_1 = require("../utils");
+class Tick {
+    constructor({ index, liquidityGross, liquidityNet }) {
+        (0, tiny_invariant_1.default)(index >= utils_1.TickMath.MIN_TICK && index <= utils_1.TickMath.MAX_TICK, 'TICK');
+        this.index = index;
+        this.liquidityGross = jsbi_1.default.BigInt(liquidityGross);
+        this.liquidityNet = jsbi_1.default.BigInt(liquidityNet);
+    }
+}
+exports.Tick = Tick;
+//# sourceMappingURL=tick.js.map

package/dist/v3/entities/tick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tick.js","sourceRoot":"","sources":["../../../src/v3/entities/tick.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AACvB,oEAAsC;AAEtC,oCAAmC;AAQnC,MAAa,IAAI;IAKf,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,YAAY,EAAuB;QACtE,IAAA,wBAAS,EAAC,KAAK,IAAI,gBAAQ,CAAC,QAAQ,IAAI,KAAK,IAAI,gBAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC3E,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,cAAc,GAAG,cAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;QACjD,IAAI,CAAC,YAAY,GAAG,cAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;IAC/C,CAAC;CACF;AAXD,oBAWC"}

package/dist/v3/entities/tickDataProvider.d.ts

@@ -0,0 +1,31 @@
+import { BigintIsh } from '../../core';
+/**
+ * Provides information about ticks
+ */
+export interface TickDataProvider {
+    /**
+     * Return information corresponding to a specific tick
+     * @param tick the tick to load
+     */
+    getTick(tick: number): Promise<{
+        liquidityNet: BigintIsh;
+    }>;
+    /**
+     * Return the next tick that is initialized within a single word
+     * @param tick The current tick
+     * @param lte Whether the next tick should be lte the current tick
+     * @param tickSpacing The tick spacing of the pool
+     */
+    nextInitializedTickWithinOneWord(tick: number, lte: boolean, tickSpacing: number): Promise<[number, boolean]>;
+}
+/**
+ * This tick data provider does not know how to fetch any tick data. It throws whenever it is required. Useful if you
+ * do not need to load tick data for your use case.
+ */
+export declare class NoTickDataProvider implements TickDataProvider {
+    private static ERROR_MESSAGE;
+    getTick(_tick: number): Promise<{
+        liquidityNet: BigintIsh;
+    }>;
+    nextInitializedTickWithinOneWord(_tick: number, _lte: boolean, _tickSpacing: number): Promise<[number, boolean]>;
+}

package/dist/v3/entities/tickDataProvider.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoTickDataProvider = void 0;
+/**
+ * This tick data provider does not know how to fetch any tick data. It throws whenever it is required. Useful if you
+ * do not need to load tick data for your use case.
+ */
+class NoTickDataProvider {
+    async getTick(_tick) {
+        throw new Error(NoTickDataProvider.ERROR_MESSAGE);
+    }
+    async nextInitializedTickWithinOneWord(_tick, _lte, _tickSpacing) {
+        throw new Error(NoTickDataProvider.ERROR_MESSAGE);
+    }
+}
+exports.NoTickDataProvider = NoTickDataProvider;
+NoTickDataProvider.ERROR_MESSAGE = 'No tick data provider was given';
+//# sourceMappingURL=tickDataProvider.js.map

package/dist/v3/entities/tickDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickDataProvider.js","sourceRoot":"","sources":["../../../src/v3/entities/tickDataProvider.ts"],"names":[],"mappings":";;;AAqBA;;;GAGG;AACH,MAAa,kBAAkB;IAE7B,KAAK,CAAC,OAAO,CAAC,KAAa;QACzB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAA;IACnD,CAAC;IAED,KAAK,CAAC,gCAAgC,CACpC,KAAa,EACb,IAAa,EACb,YAAoB;QAEpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAA;IACnD,CAAC;;AAZH,gDAaC;AAZgB,gCAAa,GAAG,iCAAiC,CAAA"}

package/dist/v3/entities/tickListDataProvider.d.ts

@@ -0,0 +1,15 @@
+import { BigintIsh } from '../../core';
+import { Tick, TickConstructorArgs } from './tick';
+import { TickDataProvider } from './tickDataProvider';
+/**
+ * A data provider for ticks that is backed by an in-memory array of ticks.
+ */
+export declare class TickListDataProvider implements TickDataProvider {
+    private ticks;
+    constructor(ticks: (Tick | TickConstructorArgs)[], tickSpacing: number);
+    getTick(tick: number): Promise<{
+        liquidityNet: BigintIsh;
+        liquidityGross: BigintIsh;
+    }>;
+    nextInitializedTickWithinOneWord(tick: number, lte: boolean, tickSpacing: number): Promise<[number, boolean]>;
+}

package/dist/v3/entities/tickListDataProvider.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TickListDataProvider = void 0;
+const tickList_1 = require("../utils/tickList");
+const tick_1 = require("./tick");
+/**
+ * A data provider for ticks that is backed by an in-memory array of ticks.
+ */
+class TickListDataProvider {
+    constructor(ticks, tickSpacing) {
+        const ticksMapped = ticks.map(t => (t instanceof tick_1.Tick ? t : new tick_1.Tick(t)));
+        tickList_1.TickList.validateList(ticksMapped, tickSpacing);
+        this.ticks = ticksMapped;
+    }
+    async getTick(tick) {
+        return tickList_1.TickList.getTick(this.ticks, tick);
+    }
+    async nextInitializedTickWithinOneWord(tick, lte, tickSpacing) {
+        return tickList_1.TickList.nextInitializedTickWithinOneWord(this.ticks, tick, lte, tickSpacing);
+    }
+}
+exports.TickListDataProvider = TickListDataProvider;
+//# sourceMappingURL=tickListDataProvider.js.map

package/dist/v3/entities/tickListDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tickListDataProvider.js","sourceRoot":"","sources":["../../../src/v3/entities/tickListDataProvider.ts"],"names":[],"mappings":";;;AACA,gDAA4C;AAC5C,iCAAkD;AAGlD;;GAEG;AACH,MAAa,oBAAoB;IAG/B,YAAY,KAAqC,EAAE,WAAmB;QACpE,MAAM,WAAW,GAAW,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,WAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,WAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACjF,mBAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;QAC/C,IAAI,CAAC,KAAK,GAAG,WAAW,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,OAAO,mBAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,gCAAgC,CAAC,IAAY,EAAE,GAAY,EAAE,WAAmB;QACpF,OAAO,mBAAQ,CAAC,gCAAgC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,CAAA;IACtF,CAAC;CACF;AAhBD,oDAgBC"}