@pancakeswap/v3-sdk 3.7.12 → 3.8.0

package/dist/abi/V3PoolAbi.d.ts

@@ -0,0 +1,46 @@
+export declare const v3PoolAbi: readonly [{
+    readonly inputs: readonly [];
+    readonly name: "liquidity";
+    readonly outputs: readonly [{
+        readonly internalType: "uint128";
+        readonly name: "";
+        readonly type: "uint128";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "slot0";
+    readonly outputs: readonly [{
+        readonly internalType: "uint160";
+        readonly name: "sqrtPriceX96";
+        readonly type: "uint160";
+    }, {
+        readonly internalType: "int24";
+        readonly name: "tick";
+        readonly type: "int24";
+    }, {
+        readonly internalType: "uint16";
+        readonly name: "observationIndex";
+        readonly type: "uint16";
+    }, {
+        readonly internalType: "uint16";
+        readonly name: "observationCardinality";
+        readonly type: "uint16";
+    }, {
+        readonly internalType: "uint16";
+        readonly name: "observationCardinalityNext";
+        readonly type: "uint16";
+    }, {
+        readonly internalType: "uint32";
+        readonly name: "feeProtocol";
+        readonly type: "uint32";
+    }, {
+        readonly internalType: "bool";
+        readonly name: "unlocked";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+//# sourceMappingURL=V3PoolAbi.d.ts.map

package/dist/abi/V3PoolAbi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"V3PoolAbi.d.ts","sourceRoot":"","sources":["../../src/abi/V3PoolAbi.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmDZ,CAAA"}

package/dist/entities/pool.d.ts

@@ -67,6 +67,13 @@ export declare class Pool {
      * @returns The input amount and the pool with updated state
      */
     getInputAmount(outputAmount: CurrencyAmount<Token>, sqrtPriceLimitX96?: bigint): 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
+     */
+    getInputAmountByExactOut(outputAmount: CurrencyAmount<Token>, sqrtPriceLimitX96?: bigint): Promise<[CurrencyAmount<Token>, Pool]>;
     /**
      * Executes a swap
      * @param zeroForOne Whether the amount in is token0 or token1

package/dist/entities/pool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pool.d.ts","sourceRoot":"","sources":["../../src/entities/pool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAG1E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,EAAE,SAAS,EAAqC,MAAM,cAAc,CAAA;AAM3E,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAClD,OAAO,EAAsB,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAkBzE;;GAEG;AACH,qBAAa,IAAI;IACf,SAAgB,MAAM,EAAE,KAAK,CAAA;IAE7B,SAAgB,MAAM,EAAE,KAAK,CAAA;IAE7B,SAAgB,GAAG,EAAE,SAAS,CAAA;IAE9B,SAAgB,YAAY,EAAE,MAAM,CAAA;IAEpC,SAAgB,SAAS,EAAE,MAAM,CAAA;IAEjC,SAAgB,WAAW,EAAE,MAAM,CAAA;IAEnC,SAAgB,gBAAgB,EAAE,gBAAgB,CAAA;IAE3C,WAAW,CAAC,EAAE,MAAM,CAAA;IAE3B,OAAO,CAAC,YAAY,CAAC,CAAqB;IAE1C,OAAO,CAAC,YAAY,CAAC,CAAqB;WAE5B,UAAU,CACtB,MAAM,EAAE,KAAK,EACb,MAAM,EAAE,KAAK,EACb,GAAG,EAAE,SAAS,EACd,0BAA0B,CAAC,EAAE,IAAI,EACjC,uBAAuB,CAAC,EAAE,OAAO,GAChC,KAAK,MAAM,EAAE;IAUhB;;;;;;;;;OASG;gBAED,MAAM,EAAE,KAAK,EACb,MAAM,EAAE,KAAK,EACb,GAAG,EAAE,SAAS,EACd,YAAY,EAAE,SAAS,EACvB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,gBAAgB,GAAG,CAAC,IAAI,GAAG,mBAAmB,CAAC,EAAkC;IAsB1F;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAI3C;;OAEG;IACH,IAAW,WAAW,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAK5C;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAK5C;IAED;;;;OAIG;IACI,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC;IAKjD;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;;;;OAKG;IACU,eAAe,CAC1B,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,EAClC,iBAAiB,CAAC,EAAE,MAAM,GACzB,OAAO,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAkBzC;;;;;OAKG;IACU,cAAc,CACzB,YAAY,EAAE,cAAc,CAAC,KAAK,CAAC,EACnC,iBAAiB,CAAC,EAAE,MAAM,GACzB,OAAO,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAmBzC;;;;;;;;;OASG;YACW,IAAI;IAsGlB,IAAW,WAAW,IAAI,MAAM,CAE/B;CACF"}
+{"version":3,"file":"pool.d.ts","sourceRoot":"","sources":["../../src/entities/pool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AAG1E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,EAAE,SAAS,EAAqC,MAAM,cAAc,CAAA;AAM3E,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAClD,OAAO,EAAsB,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAkBzE;;GAEG;AACH,qBAAa,IAAI;IACf,SAAgB,MAAM,EAAE,KAAK,CAAA;IAE7B,SAAgB,MAAM,EAAE,KAAK,CAAA;IAE7B,SAAgB,GAAG,EAAE,SAAS,CAAA;IAE9B,SAAgB,YAAY,EAAE,MAAM,CAAA;IAEpC,SAAgB,SAAS,EAAE,MAAM,CAAA;IAEjC,SAAgB,WAAW,EAAE,MAAM,CAAA;IAEnC,SAAgB,gBAAgB,EAAE,gBAAgB,CAAA;IAE3C,WAAW,CAAC,EAAE,MAAM,CAAA;IAE3B,OAAO,CAAC,YAAY,CAAC,CAAqB;IAE1C,OAAO,CAAC,YAAY,CAAC,CAAqB;WAE5B,UAAU,CACtB,MAAM,EAAE,KAAK,EACb,MAAM,EAAE,KAAK,EACb,GAAG,EAAE,SAAS,EACd,0BAA0B,CAAC,EAAE,IAAI,EACjC,uBAAuB,CAAC,EAAE,OAAO,GAChC,KAAK,MAAM,EAAE;IAUhB;;;;;;;;;OASG;gBAED,MAAM,EAAE,KAAK,EACb,MAAM,EAAE,KAAK,EACb,GAAG,EAAE,SAAS,EACd,YAAY,EAAE,SAAS,EACvB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,MAAM,EACnB,KAAK,GAAE,gBAAgB,GAAG,CAAC,IAAI,GAAG,mBAAmB,CAAC,EAAkC;IAsB1F;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAI3C;;OAEG;IACH,IAAW,WAAW,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAK5C;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAK5C;IAED;;;;OAIG;IACI,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC;IAKjD;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;;;;OAKG;IACU,eAAe,CAC1B,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,EAClC,iBAAiB,CAAC,EAAE,MAAM,GACzB,OAAO,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAkBzC;;;;;OAKG;IACU,cAAc,CACzB,YAAY,EAAE,cAAc,CAAC,KAAK,CAAC,EACnC,iBAAiB,CAAC,EAAE,MAAM,GACzB,OAAO,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAmBzC;;;;;OAKG;IACU,wBAAwB,CACnC,YAAY,EAAE,cAAc,CAAC,KAAK,CAAC,EACnC,iBAAiB,CAAC,EAAE,MAAM,GACzB,OAAO,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAsBzC;;;;;;;;;OASG;YACW,IAAI;IAsGlB,IAAW,WAAW,IAAI,MAAM,CAE/B;CACF"}

package/dist/index.d.ts

@@ -17,5 +17,6 @@ export * from './abi/Quoter';
 export * from './abi/QuoterV2';
 export * from './abi/SelfPermit';
 export * from './abi/SwapRouter';
+export * from './abi/V3PoolAbi';
 export * from './abi/V3Staker';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AAEvB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,8BAA8B,CAAA;AAC5C,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAG5B,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AAEvB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,8BAA8B,CAAA;AAC5C,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAG5B,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA"}

package/dist/index.js

@@ -704,6 +704,29 @@ var Pool = class {
       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 getInputAmountByExactOut(outputAmount, sqrtPriceLimitX96) {
+    invariant9__default.default(outputAmount.currency.isToken && this.involvesToken(outputAmount.currency), "TOKEN");
+    const zeroForOne = outputAmount.currency.equals(this.token1);
+    const {
+      amountSpecifiedRemaining,
+      amountCalculated: inputAmount,
+      sqrtRatioX96,
+      liquidity,
+      tickCurrent
+    } = await this.swap(zeroForOne, outputAmount.quotient * NEGATIVE_ONE, sqrtPriceLimitX96);
+    invariant9__default.default(amountSpecifiedRemaining === 0n, "INSUFFICIENT_LIQUIDITY");
+    const inputToken = zeroForOne ? this.token0 : this.token1;
+    return [
+      sdk.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
@@ -6546,6 +6569,60 @@ var pancakeV3PoolABI = [
   }
 ];
 
+// src/abi/V3PoolAbi.ts
+var v3PoolAbi = [
+  {
+    inputs: [],
+    name: "liquidity",
+    outputs: [{ internalType: "uint128", name: "", type: "uint128" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [],
+    name: "slot0",
+    outputs: [
+      {
+        internalType: "uint160",
+        name: "sqrtPriceX96",
+        type: "uint160"
+      },
+      {
+        internalType: "int24",
+        name: "tick",
+        type: "int24"
+      },
+      {
+        internalType: "uint16",
+        name: "observationIndex",
+        type: "uint16"
+      },
+      {
+        internalType: "uint16",
+        name: "observationCardinality",
+        type: "uint16"
+      },
+      {
+        internalType: "uint16",
+        name: "observationCardinalityNext",
+        type: "uint16"
+      },
+      {
+        internalType: "uint32",
+        name: "feeProtocol",
+        type: "uint32"
+      },
+      {
+        internalType: "bool",
+        name: "unlocked",
+        type: "bool"
+      }
+    ],
+    stateMutability: "view",
+    type: "function"
+  }
+];
+
 exports.ADDRESS_ZERO = ADDRESS_ZERO;
 exports.DEPLOYER_ADDRESSES = DEPLOYER_ADDRESSES;
 exports.FACTORY_ADDRESSES = FACTORY_ADDRESSES;
@@ -6615,4 +6692,5 @@ exports.swapRouterABI = swapRouterABI;
 exports.tickToPrice = tickToPrice;
 exports.toHex = toHex;
 exports.tradeComparator = tradeComparator;
+exports.v3PoolAbi = v3PoolAbi;
 exports.v3StakerABI = v3StakerABI;

package/dist/index.mjs

@@ -698,6 +698,29 @@ var Pool = class {
       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 getInputAmountByExactOut(outputAmount, sqrtPriceLimitX96) {
+    invariant9(outputAmount.currency.isToken && this.involvesToken(outputAmount.currency), "TOKEN");
+    const zeroForOne = outputAmount.currency.equals(this.token1);
+    const {
+      amountSpecifiedRemaining,
+      amountCalculated: inputAmount,
+      sqrtRatioX96,
+      liquidity,
+      tickCurrent
+    } = await this.swap(zeroForOne, outputAmount.quotient * NEGATIVE_ONE, sqrtPriceLimitX96);
+    invariant9(amountSpecifiedRemaining === 0n, "INSUFFICIENT_LIQUIDITY");
+    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
@@ -6540,4 +6563,58 @@ var pancakeV3PoolABI = [
   }
 ];
 
-export { ADDRESS_ZERO, DEPLOYER_ADDRESSES, FACTORY_ADDRESSES, FeeAmount, FeeCalculator, FullMath, LiquidityMath, MasterChefV3, MaxUint128, Multicall, NFT_POSITION_MANAGER_ADDRESSES, NoTickDataProvider, NonfungiblePositionManager, POOL_INIT_CODE_HASHES, Payments, Pool, Position, PositionLibrary, PositionMath, Route, SelfPermit, SqrtPriceMath, Staker, SwapMath, SwapQuoter, SwapRouter, TICK_SPACINGS, Tick, TickLibrary, TickList, TickListDataProvider, TickMath, Trade, computePoolAddress, encodeRouteToPath, encodeSqrtRatioX96, getAmountsAtNewPrice, getAmountsByLiquidityAndPrice, getAverageLiquidity, getDependentAmount, getEstimatedLPFee, getEstimatedLPFeeByAmounts, getEstimatedLPFeeByAmountsWithProtocolFee, getEstimatedLPFeeWithProtocolFee, getLiquidityByAmountsAndPrice, getLiquidityBySingleAmount, getLiquidityFromSqrtRatioX96, getLiquidityFromTick, isMint, isPoolTickInRange, isSorted, masterChefV3ABI, maxLiquidityForAmounts, mostSignificantBit, nearestUsableTick, nonfungiblePositionManagerABI, pancakeV3PoolABI, parseProtocolFees, peripheryPaymentsWithFeeABI, priceToClosestTick, quoterABI, quoterV2ABI, selfPermitABI, sqrtRatioX96ToPrice, subIn256, swapRouterABI, tickToPrice, toHex, tradeComparator, v3StakerABI };
+// src/abi/V3PoolAbi.ts
+var v3PoolAbi = [
+  {
+    inputs: [],
+    name: "liquidity",
+    outputs: [{ internalType: "uint128", name: "", type: "uint128" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [],
+    name: "slot0",
+    outputs: [
+      {
+        internalType: "uint160",
+        name: "sqrtPriceX96",
+        type: "uint160"
+      },
+      {
+        internalType: "int24",
+        name: "tick",
+        type: "int24"
+      },
+      {
+        internalType: "uint16",
+        name: "observationIndex",
+        type: "uint16"
+      },
+      {
+        internalType: "uint16",
+        name: "observationCardinality",
+        type: "uint16"
+      },
+      {
+        internalType: "uint16",
+        name: "observationCardinalityNext",
+        type: "uint16"
+      },
+      {
+        internalType: "uint32",
+        name: "feeProtocol",
+        type: "uint32"
+      },
+      {
+        internalType: "bool",
+        name: "unlocked",
+        type: "bool"
+      }
+    ],
+    stateMutability: "view",
+    type: "function"
+  }
+];
+
+export { ADDRESS_ZERO, DEPLOYER_ADDRESSES, FACTORY_ADDRESSES, FeeAmount, FeeCalculator, FullMath, LiquidityMath, MasterChefV3, MaxUint128, Multicall, NFT_POSITION_MANAGER_ADDRESSES, NoTickDataProvider, NonfungiblePositionManager, POOL_INIT_CODE_HASHES, Payments, Pool, Position, PositionLibrary, PositionMath, Route, SelfPermit, SqrtPriceMath, Staker, SwapMath, SwapQuoter, SwapRouter, TICK_SPACINGS, Tick, TickLibrary, TickList, TickListDataProvider, TickMath, Trade, computePoolAddress, encodeRouteToPath, encodeSqrtRatioX96, getAmountsAtNewPrice, getAmountsByLiquidityAndPrice, getAverageLiquidity, getDependentAmount, getEstimatedLPFee, getEstimatedLPFeeByAmounts, getEstimatedLPFeeByAmountsWithProtocolFee, getEstimatedLPFeeWithProtocolFee, getLiquidityByAmountsAndPrice, getLiquidityBySingleAmount, getLiquidityFromSqrtRatioX96, getLiquidityFromTick, isMint, isPoolTickInRange, isSorted, masterChefV3ABI, maxLiquidityForAmounts, mostSignificantBit, nearestUsableTick, nonfungiblePositionManagerABI, pancakeV3PoolABI, parseProtocolFees, peripheryPaymentsWithFeeABI, priceToClosestTick, quoterABI, quoterV2ABI, selfPermitABI, sqrtRatioX96ToPrice, subIn256, swapRouterABI, tickToPrice, toHex, tradeComparator, v3PoolAbi, v3StakerABI };

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.7.12",
+  "version": "3.8.0",
   "description": "⚒️ An SDK for building applications on top of Pancakeswap V3",
   "files": [
     "dist"