@centurion_project/v3-sdk 3.30.0-ctn.0

package/dist/cjs/src/utils/v3swap.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v3Swap = void 0;
+const tslib_1 = require("tslib");
+const swapMath_1 = require("./swapMath");
+const liquidityMath_1 = require("./liquidityMath");
+const jsbi_1 = tslib_1.__importDefault(require("jsbi"));
+const tiny_invariant_1 = tslib_1.__importDefault(require("tiny-invariant"));
+const tickMath_1 = require("./tickMath");
+const internalConstants_1 = require("../internalConstants");
+async function v3Swap(fee, sqrtRatioX96, tickCurrent, liquidity, tickSpacing, tickDataProvider, zeroForOne, amountSpecified, sqrtPriceLimitX96) {
+    if (!sqrtPriceLimitX96)
+        sqrtPriceLimitX96 = zeroForOne
+            ? jsbi_1.default.add(tickMath_1.TickMath.MIN_SQRT_RATIO, internalConstants_1.ONE)
+            : jsbi_1.default.subtract(tickMath_1.TickMath.MAX_SQRT_RATIO, internalConstants_1.ONE);
+    if (zeroForOne) {
+        (0, tiny_invariant_1.default)(jsbi_1.default.greaterThan(sqrtPriceLimitX96, tickMath_1.TickMath.MIN_SQRT_RATIO), 'RATIO_MIN');
+        (0, tiny_invariant_1.default)(jsbi_1.default.lessThan(sqrtPriceLimitX96, sqrtRatioX96), 'RATIO_CURRENT');
+    }
+    else {
+        (0, tiny_invariant_1.default)(jsbi_1.default.lessThan(sqrtPriceLimitX96, tickMath_1.TickMath.MAX_SQRT_RATIO), 'RATIO_MAX');
+        (0, tiny_invariant_1.default)(jsbi_1.default.greaterThan(sqrtPriceLimitX96, sqrtRatioX96), 'RATIO_CURRENT');
+    }
+    const exactInput = jsbi_1.default.greaterThanOrEqual(amountSpecified, internalConstants_1.ZERO);
+    // keep track of swap state
+    const state = {
+        amountSpecifiedRemaining: amountSpecified,
+        amountCalculated: internalConstants_1.ZERO,
+        sqrtPriceX96: sqrtRatioX96,
+        tick: tickCurrent,
+        liquidity: liquidity,
+    };
+    // start swap while loop
+    while (jsbi_1.default.notEqual(state.amountSpecifiedRemaining, internalConstants_1.ZERO) && state.sqrtPriceX96 !== sqrtPriceLimitX96) {
+        let step = {};
+        step.sqrtPriceStartX96 = state.sqrtPriceX96;
+        [step.tickNext, step.initialized] = await tickDataProvider.nextInitializedTickWithinOneWord(state.tick, zeroForOne, tickSpacing);
+        if (step.tickNext < tickMath_1.TickMath.MIN_TICK) {
+            step.tickNext = tickMath_1.TickMath.MIN_TICK;
+        }
+        else if (step.tickNext > tickMath_1.TickMath.MAX_TICK) {
+            step.tickNext = tickMath_1.TickMath.MAX_TICK;
+        }
+        step.sqrtPriceNextX96 = tickMath_1.TickMath.getSqrtRatioAtTick(step.tickNext);
+        [state.sqrtPriceX96, step.amountIn, step.amountOut, step.feeAmount] = swapMath_1.SwapMath.computeSwapStep(state.sqrtPriceX96, (zeroForOne
+            ? jsbi_1.default.lessThan(step.sqrtPriceNextX96, sqrtPriceLimitX96)
+            : jsbi_1.default.greaterThan(step.sqrtPriceNextX96, sqrtPriceLimitX96))
+            ? sqrtPriceLimitX96
+            : step.sqrtPriceNextX96, state.liquidity, state.amountSpecifiedRemaining, fee);
+        if (exactInput) {
+            state.amountSpecifiedRemaining = jsbi_1.default.subtract(state.amountSpecifiedRemaining, jsbi_1.default.add(step.amountIn, step.feeAmount));
+            state.amountCalculated = jsbi_1.default.subtract(state.amountCalculated, step.amountOut);
+        }
+        else {
+            state.amountSpecifiedRemaining = jsbi_1.default.add(state.amountSpecifiedRemaining, step.amountOut);
+            state.amountCalculated = jsbi_1.default.add(state.amountCalculated, jsbi_1.default.add(step.amountIn, step.feeAmount));
+        }
+        // TODO
+        if (jsbi_1.default.equal(state.sqrtPriceX96, step.sqrtPriceNextX96)) {
+            // if the tick is initialized, run the tick transition
+            if (step.initialized) {
+                let liquidityNet = jsbi_1.default.BigInt((await tickDataProvider.getTick(step.tickNext)).liquidityNet);
+                // if we're moving leftward, we interpret liquidityNet as the opposite sign
+                // safe because liquidityNet cannot be type(int128).min
+                if (zeroForOne)
+                    liquidityNet = jsbi_1.default.multiply(liquidityNet, internalConstants_1.NEGATIVE_ONE);
+                state.liquidity = liquidityMath_1.LiquidityMath.addDelta(state.liquidity, liquidityNet);
+            }
+            state.tick = zeroForOne ? step.tickNext - 1 : step.tickNext;
+        }
+        else if (jsbi_1.default.notEqual(state.sqrtPriceX96, step.sqrtPriceStartX96)) {
+            // updated comparison function
+            // recompute unless we're on a lower tick boundary (i.e. already transitioned ticks), and haven't moved
+            state.tick = tickMath_1.TickMath.getTickAtSqrtRatio(state.sqrtPriceX96);
+        }
+    }
+    return {
+        amountCalculated: state.amountCalculated,
+        sqrtRatioX96: state.sqrtPriceX96,
+        liquidity: state.liquidity,
+        tickCurrent: state.tick,
+    };
+}
+exports.v3Swap = v3Swap;
+//# sourceMappingURL=v3swap.js.map

package/dist/cjs/src/utils/v3swap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v3swap.js","sourceRoot":"","sources":["../../../../src/utils/v3swap.ts"],"names":[],"mappings":";;;;AAAA,yCAAqC;AACrC,mDAA+C;AAC/C,wDAAuB;AACvB,4EAAsC;AACtC,yCAAqC;AACrC,4DAA8D;AAavD,KAAK,UAAU,MAAM,CAC1B,GAAS,EACT,YAAkB,EAClB,WAAmB,EACnB,SAAe,EACf,WAAmB,EACnB,gBAAkC,EAClC,UAAmB,EACnB,eAAqB,EACrB,iBAAwB;IAExB,IAAI,CAAC,iBAAiB;QACpB,iBAAiB,GAAG,UAAU;YAC5B,CAAC,CAAC,cAAI,CAAC,GAAG,CAAC,mBAAQ,CAAC,cAAc,EAAE,uBAAG,CAAC;YACxC,CAAC,CAAC,cAAI,CAAC,QAAQ,CAAC,mBAAQ,CAAC,cAAc,EAAE,uBAAG,CAAC,CAAA;IAEjD,IAAI,UAAU,EAAE;QACd,IAAA,wBAAS,EAAC,cAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,mBAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,CAAA;QACpF,IAAA,wBAAS,EAAC,cAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,EAAE,eAAe,CAAC,CAAA;KAC3E;SAAM;QACL,IAAA,wBAAS,EAAC,cAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,mBAAQ,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,CAAA;QACjF,IAAA,wBAAS,EAAC,cAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,YAAY,CAAC,EAAE,eAAe,CAAC,CAAA;KAC9E;IAED,MAAM,UAAU,GAAG,cAAI,CAAC,kBAAkB,CAAC,eAAe,EAAE,wBAAI,CAAC,CAAA;IAEjE,2BAA2B;IAE3B,MAAM,KAAK,GAAG;QACZ,wBAAwB,EAAE,eAAe;QACzC,gBAAgB,EAAE,wBAAI;QACtB,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,SAAS;KACrB,CAAA;IAED,wBAAwB;IACxB,OAAO,cAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,wBAAwB,EAAE,wBAAI,CAAC,IAAI,KAAK,CAAC,YAAY,KAAK,iBAAiB,EAAE;QACtG,IAAI,IAAI,GAA8B,EAAE,CAAA;QACxC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,YAAY,CAK1C;QAAA,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,MAAM,gBAAgB,CAAC,gCAAgC,CAC1F,KAAK,CAAC,IAAI,EACV,UAAU,EACV,WAAW,CACZ,CAAA;QAED,IAAI,IAAI,CAAC,QAAQ,GAAG,mBAAQ,CAAC,QAAQ,EAAE;YACrC,IAAI,CAAC,QAAQ,GAAG,mBAAQ,CAAC,QAAQ,CAAA;SAClC;aAAM,IAAI,IAAI,CAAC,QAAQ,GAAG,mBAAQ,CAAC,QAAQ,EAAE;YAC5C,IAAI,CAAC,QAAQ,GAAG,mBAAQ,CAAC,QAAQ,CAAA;SAClC;QAED,IAAI,CAAC,gBAAgB,GAAG,mBAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CACjE;QAAA,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,mBAAQ,CAAC,eAAe,CAC7F,KAAK,CAAC,YAAY,EAClB,CACE,UAAU;YACR,CAAC,CAAC,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;YACzD,CAAC,CAAC,cAAI,CAAC,WAAW,CAAC,IAAI,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CAC/D;YACC,CAAC,CAAC,iBAAiB;YACnB,CAAC,CAAC,IAAI,CAAC,gBAAgB,EACzB,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,wBAAwB,EAC9B,GAAG,CACJ,CAAA;QAED,IAAI,UAAU,EAAE;YACd,KAAK,CAAC,wBAAwB,GAAG,cAAI,CAAC,QAAQ,CAC5C,KAAK,CAAC,wBAAwB,EAC9B,cAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CACxC,CAAA;YACD,KAAK,CAAC,gBAAgB,GAAG,cAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;SAC/E;aAAM;YACL,KAAK,CAAC,wBAAwB,GAAG,cAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;YACzF,KAAK,CAAC,gBAAgB,GAAG,cAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,cAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;SACnG;QAED,OAAO;QACP,IAAI,cAAI,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,CAAC,EAAE;YACzD,sDAAsD;YACtD,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,IAAI,YAAY,GAAG,cAAI,CAAC,MAAM,CAAC,CAAC,MAAM,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;gBAC5F,2EAA2E;gBAC3E,uDAAuD;gBACvD,IAAI,UAAU;oBAAE,YAAY,GAAG,cAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,gCAAY,CAAC,CAAA;gBAExE,KAAK,CAAC,SAAS,GAAG,6BAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;aACxE;YAED,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;SAC5D;aAAM,IAAI,cAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,iBAAiB,CAAC,EAAE;YACpE,8BAA8B;YAC9B,uGAAuG;YACvG,KAAK,CAAC,IAAI,GAAG,mBAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;SAC7D;KACF;IAED,OAAO;QACL,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;QACxC,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,KAAK,CAAC,IAAI;KACxB,CAAA;AACH,CAAC;AA5GD,wBA4GC"}

package/dist/esm/src/constants.d.ts

@@ -0,0 +1,23 @@
+import { ChainId } from '@centurion_project/sdk-core';
+export declare const FACTORY_ADDRESS = "0x1F98431c8aD98523631AE4a59f267346ea31F984";
+export declare const ADDRESS_ZERO = "0x0000000000000000000000000000000000000000";
+export declare const POOL_INIT_CODE_HASH = "0xe34f199b19b2b4f47f68442619d555527d244f78a3297ea89325f843f87b8b54";
+export declare function poolInitCodeHash(chainId?: ChainId): string;
+/**
+ * The default factory enabled fee amounts, denominated in hundredths of bips.
+ */
+export declare enum FeeAmount {
+    LOWEST = 100,
+    LOW_200 = 200,
+    LOW_300 = 300,
+    LOW_400 = 400,
+    LOW = 500,
+    MEDIUM = 3000,
+    HIGH = 10000
+}
+/**
+ * The default factory tick spacings by fee amount.
+ */
+export declare const TICK_SPACINGS: {
+    [amount in FeeAmount]: number;
+};

package/dist/esm/src/constants.js

@@ -0,0 +1,40 @@
+import { ChainId } from '@centurion_project/sdk-core';
+export const FACTORY_ADDRESS = '0x1F98431c8aD98523631AE4a59f267346ea31F984';
+export const ADDRESS_ZERO = '0x0000000000000000000000000000000000000000';
+// @deprecated please use poolInitCodeHash(chainId: ChainId)
+export const POOL_INIT_CODE_HASH = '0xe34f199b19b2b4f47f68442619d555527d244f78a3297ea89325f843f87b8b54';
+export function poolInitCodeHash(chainId) {
+    switch (chainId) {
+        case ChainId.ZKSYNC:
+            return '0x010013f177ea1fcbc4520f9a3ca7cd2d1d77959e05aa66484027cb38e712aeed';
+        default:
+            return POOL_INIT_CODE_HASH;
+    }
+}
+/**
+ * The default factory enabled fee amounts, denominated in hundredths of bips.
+ */
+export var FeeAmount;
+(function (FeeAmount) {
+    FeeAmount[FeeAmount["LOWEST"] = 100] = "LOWEST";
+    FeeAmount[FeeAmount["LOW_200"] = 200] = "LOW_200";
+    FeeAmount[FeeAmount["LOW_300"] = 300] = "LOW_300";
+    FeeAmount[FeeAmount["LOW_400"] = 400] = "LOW_400";
+    FeeAmount[FeeAmount["LOW"] = 500] = "LOW";
+    FeeAmount[FeeAmount["MEDIUM"] = 3000] = "MEDIUM";
+    FeeAmount[FeeAmount["HIGH"] = 10000] = "HIGH";
+})(FeeAmount || (FeeAmount = {}));
+/**
+ * The default factory tick spacings by fee amount.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const TICK_SPACINGS = {
+    [FeeAmount.LOWEST]: 1,
+    [FeeAmount.LOW_200]: 4,
+    [FeeAmount.LOW_300]: 6,
+    [FeeAmount.LOW_400]: 8,
+    [FeeAmount.LOW]: 10,
+    [FeeAmount.MEDIUM]: 60,
+    [FeeAmount.HIGH]: 200,
+};
+//# sourceMappingURL=constants.js.map

package/dist/esm/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAA;AAErD,MAAM,CAAC,MAAM,eAAe,GAAG,4CAA4C,CAAA;AAE3E,MAAM,CAAC,MAAM,YAAY,GAAG,4CAA4C,CAAA;AAExE,4DAA4D;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,oEAAoE,CAAA;AAEvG,MAAM,UAAU,gBAAgB,CAAC,OAAiB;IAChD,QAAQ,OAAO,EAAE;QACf,KAAK,OAAO,CAAC,MAAM;YACjB,OAAO,oEAAoE,CAAA;QAC7E;YACE,OAAO,mBAAmB,CAAA;KAC7B;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,+CAAY,CAAA;IACZ,iDAAa,CAAA;IACb,iDAAa,CAAA;IACb,iDAAa,CAAA;IACb,yCAAS,CAAA;IACT,gDAAa,CAAA;IACb,6CAAY,CAAA;AACd,CAAC,EARW,SAAS,KAAT,SAAS,QAQpB;AAED;;GAEG;AACH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,aAAa,GAAsC;IAC9D,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IACrB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IACtB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IACtB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE;IACnB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE;IACtB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG;CACtB,CAAA"}

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

@@ -0,0 +1,7 @@
+export * from './pool';
+export * from './position';
+export * from './route';
+export * from './tick';
+export * from './trade';
+export * from './tickDataProvider';
+export * from './tickListDataProvider';

package/dist/esm/src/entities/index.js

@@ -0,0 +1,8 @@
+export * from './pool';
+export * from './position';
+export * from './route';
+export * from './tick';
+export * from './trade';
+export * from './tickDataProvider';
+export * from './tickListDataProvider';
+//# sourceMappingURL=index.js.map

package/dist/esm/src/entities/index.js.map

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

package/dist/esm/src/entities/pool.d.ts

@@ -0,0 +1,81 @@
+import { BigintIsh, CurrencyAmount, Price, Token } from '@centurion_project/sdk-core';
+import JSBI from 'jsbi';
+import { FeeAmount } from '../constants';
+import { Tick, TickConstructorArgs } from './tick';
+import { TickDataProvider } from './tickDataProvider';
+/**
+ * Represents a V3 pool
+ */
+export declare class Pool {
+    readonly token0: Token;
+    readonly token1: Token;
+    readonly fee: FeeAmount;
+    readonly sqrtRatioX96: JSBI;
+    readonly liquidity: JSBI;
+    readonly tickCurrent: number;
+    readonly tickDataProvider: TickDataProvider;
+    private _token0Price?;
+    private _token1Price?;
+    static getAddress(tokenA: Token, tokenB: Token, fee: FeeAmount, initCodeHashManualOverride?: string, factoryAddressOverride?: string): string;
+    /**
+     * Construct a pool
+     * @param tokenA One of the tokens in the pool
+     * @param tokenB The other token in the pool
+     * @param fee The fee in hundredths of a bips of the input amount of every swap that is collected by the pool
+     * @param sqrtRatioX96 The sqrt of the current ratio of amounts of token1 to token0
+     * @param liquidity The current value of in range liquidity
+     * @param tickCurrent The current tick of the pool
+     * @param ticks The current state of the pool ticks or a data provider that can return tick data
+     */
+    constructor(tokenA: Token, tokenB: Token, fee: FeeAmount, sqrtRatioX96: BigintIsh, liquidity: BigintIsh, tickCurrent: number, ticks?: TickDataProvider | (Tick | TickConstructorArgs)[]);
+    /**
+     * Returns true if the token is either token0 or token1
+     * @param token The token to check
+     * @returns True if token is either token0 or token
+     */
+    involvesToken(token: Token): boolean;
+    /**
+     * Returns the current mid price of the pool in terms of token0, i.e. the ratio of token1 over token0
+     */
+    get token0Price(): Price<Token, Token>;
+    /**
+     * Returns the current mid price of the pool in terms of token1, i.e. the ratio of token0 over token1
+     */
+    get token1Price(): Price<Token, Token>;
+    /**
+     * Return the price of the given token in terms of the other token in the pool.
+     * @param token The token to return price of
+     * @returns The price of the given token, in terms of the other.
+     */
+    priceOf(token: Token): Price<Token, Token>;
+    /**
+     * Returns the chain ID of the tokens in the pool.
+     */
+    get chainId(): number;
+    /**
+     * Given an input amount of a token, return the computed output amount, and a pool with state updated after the trade
+     * @param inputAmount The input amount for which to quote the output amount
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit
+     * @returns The output amount and the pool with updated state
+     */
+    getOutputAmount(inputAmount: CurrencyAmount<Token>, sqrtPriceLimitX96?: JSBI): Promise<[CurrencyAmount<Token>, Pool]>;
+    /**
+     * Given a desired output amount of a token, return the computed input amount and a pool with state updated after the trade
+     * @param outputAmount the output amount for which to quote the input amount
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap
+     * @returns The input amount and the pool with updated state
+     */
+    getInputAmount(outputAmount: CurrencyAmount<Token>, sqrtPriceLimitX96?: JSBI): Promise<[CurrencyAmount<Token>, Pool]>;
+    /**
+     * Executes a swap
+     * @param zeroForOne Whether the amount in is token0 or token1
+     * @param amountSpecified The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap
+     * @returns amountCalculated
+     * @returns sqrtRatioX96
+     * @returns liquidity
+     * @returns tickCurrent
+     */
+    private swap;
+    get tickSpacing(): number;
+}

package/dist/esm/src/entities/pool.js

@@ -0,0 +1,137 @@
+import { CurrencyAmount, Price } from '@centurion_project/sdk-core';
+import JSBI from 'jsbi';
+import invariant from 'tiny-invariant';
+import { FACTORY_ADDRESS, TICK_SPACINGS } from '../constants';
+import { NEGATIVE_ONE, Q192 } from '../internalConstants';
+import { computePoolAddress } from '../utils/computePoolAddress';
+import { v3Swap } from '../utils/v3swap';
+import { TickMath } from '../utils/tickMath';
+import { NoTickDataProvider } from './tickDataProvider';
+import { TickListDataProvider } from './tickListDataProvider';
+/**
+ * By default, pools will not allow operations that require ticks.
+ */
+const NO_TICK_DATA_PROVIDER_DEFAULT = new NoTickDataProvider();
+/**
+ * Represents a V3 pool
+ */
+export class Pool {
+    static getAddress(tokenA, tokenB, fee, initCodeHashManualOverride, factoryAddressOverride) {
+        return computePoolAddress({
+            factoryAddress: factoryAddressOverride !== null && factoryAddressOverride !== void 0 ? factoryAddressOverride : FACTORY_ADDRESS,
+            fee,
+            tokenA,
+            tokenB,
+            initCodeHashManualOverride,
+        });
+    }
+    /**
+     * Construct a pool
+     * @param tokenA One of the tokens in the pool
+     * @param tokenB The other token in the pool
+     * @param fee The fee in hundredths of a bips of the input amount of every swap that is collected by the pool
+     * @param sqrtRatioX96 The sqrt of the current ratio of amounts of token1 to token0
+     * @param liquidity The current value of in range liquidity
+     * @param tickCurrent The current tick of the pool
+     * @param ticks The current state of the pool ticks or a data provider that can return tick data
+     */
+    constructor(tokenA, tokenB, fee, sqrtRatioX96, liquidity, tickCurrent, ticks = NO_TICK_DATA_PROVIDER_DEFAULT) {
+        invariant(Number.isInteger(fee) && fee < 1000000, 'FEE');
+        const tickCurrentSqrtRatioX96 = TickMath.getSqrtRatioAtTick(tickCurrent);
+        const nextTickSqrtRatioX96 = TickMath.getSqrtRatioAtTick(tickCurrent + 1);
+        invariant(JSBI.greaterThanOrEqual(JSBI.BigInt(sqrtRatioX96), tickCurrentSqrtRatioX96) &&
+            JSBI.lessThanOrEqual(JSBI.BigInt(sqrtRatioX96), nextTickSqrtRatioX96), 'PRICE_BOUNDS');
+        [this.token0, this.token1] = tokenA.sortsBefore(tokenB) ? [tokenA, tokenB] : [tokenB, tokenA];
+        this.fee = fee;
+        this.sqrtRatioX96 = JSBI.BigInt(sqrtRatioX96);
+        this.liquidity = JSBI.BigInt(liquidity);
+        this.tickCurrent = tickCurrent;
+        this.tickDataProvider = Array.isArray(ticks) ? new TickListDataProvider(ticks, TICK_SPACINGS[fee]) : ticks;
+    }
+    /**
+     * Returns true if the token is either token0 or token1
+     * @param token The token to check
+     * @returns True if token is either token0 or token
+     */
+    involvesToken(token) {
+        return token.equals(this.token0) || token.equals(this.token1);
+    }
+    /**
+     * Returns the current mid price of the pool in terms of token0, i.e. the ratio of token1 over token0
+     */
+    get token0Price() {
+        var _a;
+        return ((_a = this._token0Price) !== null && _a !== void 0 ? _a : (this._token0Price = new Price(this.token0, this.token1, Q192, JSBI.multiply(this.sqrtRatioX96, this.sqrtRatioX96))));
+    }
+    /**
+     * Returns the current mid price of the pool in terms of token1, i.e. the ratio of token0 over token1
+     */
+    get token1Price() {
+        var _a;
+        return ((_a = this._token1Price) !== null && _a !== void 0 ? _a : (this._token1Price = new Price(this.token1, this.token0, JSBI.multiply(this.sqrtRatioX96, this.sqrtRatioX96), Q192)));
+    }
+    /**
+     * Return the price of the given token in terms of the other token in the pool.
+     * @param token The token to return price of
+     * @returns The price of the given token, in terms of the other.
+     */
+    priceOf(token) {
+        invariant(this.involvesToken(token), 'TOKEN');
+        return token.equals(this.token0) ? this.token0Price : this.token1Price;
+    }
+    /**
+     * Returns the chain ID of the tokens in the pool.
+     */
+    get chainId() {
+        return this.token0.chainId;
+    }
+    /**
+     * Given an input amount of a token, return the computed output amount, and a pool with state updated after the trade
+     * @param inputAmount The input amount for which to quote the output amount
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit
+     * @returns The output amount and the pool with updated state
+     */
+    async getOutputAmount(inputAmount, sqrtPriceLimitX96) {
+        invariant(this.involvesToken(inputAmount.currency), 'TOKEN');
+        const zeroForOne = inputAmount.currency.equals(this.token0);
+        const { amountCalculated: outputAmount, sqrtRatioX96, liquidity, tickCurrent, } = await this.swap(zeroForOne, inputAmount.quotient, sqrtPriceLimitX96);
+        const outputToken = zeroForOne ? this.token1 : this.token0;
+        return [
+            CurrencyAmount.fromRawAmount(outputToken, JSBI.multiply(outputAmount, NEGATIVE_ONE)),
+            new Pool(this.token0, this.token1, this.fee, sqrtRatioX96, liquidity, tickCurrent, this.tickDataProvider),
+        ];
+    }
+    /**
+     * Given a desired output amount of a token, return the computed input amount and a pool with state updated after the trade
+     * @param outputAmount the output amount for which to quote the input amount
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap
+     * @returns The input amount and the pool with updated state
+     */
+    async getInputAmount(outputAmount, sqrtPriceLimitX96) {
+        invariant(outputAmount.currency.isToken && this.involvesToken(outputAmount.currency), 'TOKEN');
+        const zeroForOne = outputAmount.currency.equals(this.token1);
+        const { amountCalculated: inputAmount, sqrtRatioX96, liquidity, tickCurrent, } = await this.swap(zeroForOne, JSBI.multiply(outputAmount.quotient, NEGATIVE_ONE), sqrtPriceLimitX96);
+        const inputToken = zeroForOne ? this.token0 : this.token1;
+        return [
+            CurrencyAmount.fromRawAmount(inputToken, inputAmount),
+            new Pool(this.token0, this.token1, this.fee, sqrtRatioX96, liquidity, tickCurrent, this.tickDataProvider),
+        ];
+    }
+    /**
+     * Executes a swap
+     * @param zeroForOne Whether the amount in is token0 or token1
+     * @param amountSpecified The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)
+     * @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this value after the swap. If one for zero, the price cannot be greater than this value after the swap
+     * @returns amountCalculated
+     * @returns sqrtRatioX96
+     * @returns liquidity
+     * @returns tickCurrent
+     */
+    async swap(zeroForOne, amountSpecified, sqrtPriceLimitX96) {
+        return v3Swap(JSBI.BigInt(this.fee), this.sqrtRatioX96, this.tickCurrent, this.liquidity, this.tickSpacing, this.tickDataProvider, zeroForOne, amountSpecified, sqrtPriceLimitX96);
+    }
+    get tickSpacing() {
+        return TICK_SPACINGS[this.fee];
+    }
+}
+//# sourceMappingURL=pool.js.map

package/dist/esm/src/entities/pool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool.js","sourceRoot":"","sources":["../../../../src/entities/pool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,cAAc,EAAE,KAAK,EAAS,MAAM,6BAA6B,CAAA;AACrF,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,SAAS,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,eAAe,EAAa,aAAa,EAAE,MAAM,cAAc,CAAA;AACxE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,kBAAkB,EAAoB,MAAM,oBAAoB,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D;;GAEG;AACH,MAAM,6BAA6B,GAAG,IAAI,kBAAkB,EAAE,CAAA;AAE9D;;GAEG;AACH,MAAM,OAAO,IAAI;IAYR,MAAM,CAAC,UAAU,CACtB,MAAa,EACb,MAAa,EACb,GAAc,EACd,0BAAmC,EACnC,sBAA+B;QAE/B,OAAO,kBAAkB,CAAC;YACxB,cAAc,EAAE,sBAAsB,aAAtB,sBAAsB,cAAtB,sBAAsB,GAAI,eAAe;YACzD,GAAG;YACH,MAAM;YACN,MAAM;YACN,0BAA0B;SAC3B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,YACE,MAAa,EACb,MAAa,EACb,GAAc,EACd,YAAuB,EACvB,SAAoB,EACpB,WAAmB,EACnB,QAA2D,6BAA6B;QAExF,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,OAAS,EAAE,KAAK,CAAC,CAAA;QAE1D,MAAM,uBAAuB,GAAG,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;QACxE,MAAM,oBAAoB,GAAG,QAAQ,CAAC,kBAAkB,CAAC,WAAW,GAAG,CAAC,CAAC,CAAA;QACzE,SAAS,CACP,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAC;YACzE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC,EACvE,cAAc,CACf,CAEA;QAAA,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC9F,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACvC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5G,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,KAAY;QAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC/D,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;;QACpB,OAAO,CACL,MAAA,IAAI,CAAC,YAAY,mCACjB,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,KAAK,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,MAAM,EACX,IAAI,EACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CACpD,CAAC,CACH,CAAA;IACH,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;;QACpB,OAAO,CACL,MAAA,IAAI,CAAC,YAAY,mCACjB,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,KAAK,CAC5B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,EACnD,IAAI,CACL,CAAC,CACH,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,KAAY;QACzB,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAA;QAC7C,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAA;IACxE,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAC1B,WAAkC,EAClC,iBAAwB;QAExB,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAA;QAE5D,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE3D,MAAM,EACJ,gBAAgB,EAAE,YAAY,EAC9B,YAAY,EACZ,SAAS,EACT,WAAW,GACZ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAA;QACxE,MAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;QAC1D,OAAO;YACL,cAAc,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;YACpF,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC;SAC1G,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACzB,YAAmC,EACnC,iBAAwB;QAExB,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAA;QAE9F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE5D,MAAM,EACJ,gBAAgB,EAAE,WAAW,EAC7B,YAAY,EACZ,SAAS,EACT,WAAW,GACZ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,iBAAiB,CAAC,CAAA;QACtG,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;QACzD,OAAO;YACL,cAAc,CAAC,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC;YACrD,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC;SAC1G,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACK,KAAK,CAAC,IAAI,CAChB,UAAmB,EACnB,eAAqB,EACrB,iBAAwB;QAExB,OAAO,MAAM,CACX,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EACrB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,gBAAgB,EACrB,UAAU,EACV,eAAe,EACf,iBAAiB,CAClB,CAAA;IACH,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChC,CAAC;CACF"}

package/dist/esm/src/entities/position.d.ts

@@ -0,0 +1,131 @@
+import { BigintIsh, Percent, Price, CurrencyAmount, Token } from '@centurion_project/sdk-core';
+import JSBI from 'jsbi';
+import { Pool } from './pool';
+interface PositionConstructorArgs {
+    pool: Pool;
+    tickLower: number;
+    tickUpper: number;
+    liquidity: BigintIsh;
+}
+/**
+ * Represents a position on a Uniswap 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 {};