@pancakeswap/v3-sdk 3.9.1 → 3.9.3

package/dist/index.js

@@ -858,10 +858,15 @@ function encodeSqrtRatioX96(amount1, amount0) {
 function tickToPrice(baseToken, quoteToken, tick) {
   const sqrtRatioX96 = TickMath.getSqrtRatioAtTick(tick);
   const ratioX192 = sqrtRatioX96 * sqrtRatioX96;
-  return baseToken.sortsBefore(quoteToken) ? new swapSdkCore.Price(baseToken, quoteToken, Q192, ratioX192) : new swapSdkCore.Price(baseToken, quoteToken, ratioX192, Q192);
+  return swapSdkCore.isCurrencySorted(baseToken, quoteToken) ? new swapSdkCore.Price(baseToken, quoteToken, Q192, ratioX192) : new swapSdkCore.Price(baseToken, quoteToken, ratioX192, Q192);
+}
+function tickToPriceV2(baseToken, quoteToken, tick) {
+  const sqrtRatioX96 = TickMath.getSqrtRatioAtTick(tick);
+  const ratioX192 = sqrtRatioX96 * sqrtRatioX96;
+  return swapSdkCore.sortCurrencies([baseToken, quoteToken])[0] === baseToken ? new swapSdkCore.Price(baseToken, quoteToken, Q192, ratioX192) : new swapSdkCore.Price(baseToken, quoteToken, ratioX192, Q192);
 }
 function priceToClosestTick(price) {
-  const sorted = price.baseCurrency.sortsBefore(price.quoteCurrency);
+  const sorted = swapSdkCore.isCurrencySorted(price.baseCurrency, price.quoteCurrency);
   const sqrtRatioX96 = sorted ? encodeSqrtRatioX96(price.numerator, price.denominator) : encodeSqrtRatioX96(price.denominator, price.numerator);
   let tick = TickMath.getTickAtSqrtRatio(sqrtRatioX96);
   const nextTickPrice = tickToPrice(price.baseCurrency, price.quoteCurrency, tick + 1);
@@ -1777,6 +1782,8 @@ function nearestUsableTick(tick, tickSpacing) {
   invariant9__default.default(Number.isInteger(tick) && Number.isInteger(tickSpacing), "INTEGERS");
   invariant9__default.default(tickSpacing > 0, "TICK_SPACING");
   invariant9__default.default(tick >= TickMath.MIN_TICK && tick <= TickMath.MAX_TICK, "TICK_BOUND");
+  if (tickSpacing === 1)
+    return tick;
   const rounded = Math.round(tick / tickSpacing) * tickSpacing;
   if (rounded < TickMath.MIN_TICK)
     return rounded + tickSpacing;
@@ -6858,6 +6865,9 @@ exports.isMint = isMint;
 exports.isPoolTickInRange = isPoolTickInRange;
 exports.isSorted = isSorted;
 exports.masterChefV3ABI = masterChefV3ABI;
+exports.maxLiquidityForAmount0Imprecise = maxLiquidityForAmount0Imprecise;
+exports.maxLiquidityForAmount0Precise = maxLiquidityForAmount0Precise;
+exports.maxLiquidityForAmount1 = maxLiquidityForAmount1;
 exports.maxLiquidityForAmounts = maxLiquidityForAmounts;
 exports.mostSignificantBit = mostSignificantBit;
 exports.nearestUsableTick = nearestUsableTick;
@@ -6874,6 +6884,7 @@ exports.subIn256 = subIn256;
 exports.swap = swap;
 exports.swapRouterABI = swapRouterABI;
 exports.tickToPrice = tickToPrice;
+exports.tickToPriceV2 = tickToPriceV2;
 exports.toHex = toHex;
 exports.tradeComparator = tradeComparator;
 exports.v3PoolAbi = v3PoolAbi;

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { Price, CurrencyAmount, Percent as Percent$1, MaxUint256 as MaxUint256$1, TradeType, Fraction, sortedInsert, validateAndParseAddress, ZERO as ZERO$2, ONE as ONE$1 } from '@pancakeswap/sdk';
 import invariant9 from 'tiny-invariant';
 import { ChainId } from '@pancakeswap/chains';
-import { Percent, MaxUint256, sqrt, Price as Price$1, sortCurrencies, CurrencyAmount as CurrencyAmount$1, Fraction as Fraction$1, ZERO as ZERO$1, TradeType as TradeType$1 } from '@pancakeswap/swap-sdk-core';
+import { Percent, MaxUint256, sqrt, isCurrencySorted, Price as Price$1, sortCurrencies, CurrencyAmount as CurrencyAmount$1, Fraction as Fraction$1, ZERO as ZERO$1, TradeType as TradeType$1 } from '@pancakeswap/swap-sdk-core';
 import { keccak256, encodeAbiParameters, parseAbiParameters, encodePacked, encodeFunctionData, toBytes, getAddress, pad, isBytes, slice, concat } from 'viem';
 
 // src/entities/pool.ts
@@ -852,10 +852,15 @@ function encodeSqrtRatioX96(amount1, amount0) {
 function tickToPrice(baseToken, quoteToken, tick) {
   const sqrtRatioX96 = TickMath.getSqrtRatioAtTick(tick);
   const ratioX192 = sqrtRatioX96 * sqrtRatioX96;
-  return baseToken.sortsBefore(quoteToken) ? new Price$1(baseToken, quoteToken, Q192, ratioX192) : new Price$1(baseToken, quoteToken, ratioX192, Q192);
+  return isCurrencySorted(baseToken, quoteToken) ? new Price$1(baseToken, quoteToken, Q192, ratioX192) : new Price$1(baseToken, quoteToken, ratioX192, Q192);
+}
+function tickToPriceV2(baseToken, quoteToken, tick) {
+  const sqrtRatioX96 = TickMath.getSqrtRatioAtTick(tick);
+  const ratioX192 = sqrtRatioX96 * sqrtRatioX96;
+  return sortCurrencies([baseToken, quoteToken])[0] === baseToken ? new Price$1(baseToken, quoteToken, Q192, ratioX192) : new Price$1(baseToken, quoteToken, ratioX192, Q192);
 }
 function priceToClosestTick(price) {
-  const sorted = price.baseCurrency.sortsBefore(price.quoteCurrency);
+  const sorted = isCurrencySorted(price.baseCurrency, price.quoteCurrency);
   const sqrtRatioX96 = sorted ? encodeSqrtRatioX96(price.numerator, price.denominator) : encodeSqrtRatioX96(price.denominator, price.numerator);
   let tick = TickMath.getTickAtSqrtRatio(sqrtRatioX96);
   const nextTickPrice = tickToPrice(price.baseCurrency, price.quoteCurrency, tick + 1);
@@ -1771,6 +1776,8 @@ function nearestUsableTick(tick, tickSpacing) {
   invariant9(Number.isInteger(tick) && Number.isInteger(tickSpacing), "INTEGERS");
   invariant9(tickSpacing > 0, "TICK_SPACING");
   invariant9(tick >= TickMath.MIN_TICK && tick <= TickMath.MAX_TICK, "TICK_BOUND");
+  if (tickSpacing === 1)
+    return tick;
   const rounded = Math.round(tick / tickSpacing) * tickSpacing;
   if (rounded < TickMath.MIN_TICK)
     return rounded + tickSpacing;
@@ -6791,4 +6798,4 @@ var v3PoolAbi = [
   }
 ];
 
-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, getCurrency0Price, getCurrency1Price, getDependentAmount, getEstimatedLPFee, getEstimatedLPFeeByAmounts, getEstimatedLPFeeByAmountsWithProtocolFee, getEstimatedLPFeeWithProtocolFee, getInputAmount, getLiquidityByAmountsAndPrice, getLiquidityBySingleAmount, getLiquidityFromSqrtRatioX96, getLiquidityFromTick, getOutputAmount, getPool, getPriceOfCurrency, getPriceOfCurrency0, getPriceOfCurrency1, hasInvolvedCurrency, isMint, isPoolTickInRange, isSorted, masterChefV3ABI, maxLiquidityForAmounts, mostSignificantBit, nearestUsableTick, nonfungiblePositionManagerABI, pancakeV3PoolABI, parseProtocolFees, peripheryPaymentsWithFeeABI, priceToClosestTick, quoterABI, quoterV2ABI, selfPermitABI, sqrtRatioX96ToPrice, subIn256, swap, swapRouterABI, tickToPrice, toHex, tradeComparator, v3PoolAbi, v3StakerABI };
+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, getCurrency0Price, getCurrency1Price, getDependentAmount, getEstimatedLPFee, getEstimatedLPFeeByAmounts, getEstimatedLPFeeByAmountsWithProtocolFee, getEstimatedLPFeeWithProtocolFee, getInputAmount, getLiquidityByAmountsAndPrice, getLiquidityBySingleAmount, getLiquidityFromSqrtRatioX96, getLiquidityFromTick, getOutputAmount, getPool, getPriceOfCurrency, getPriceOfCurrency0, getPriceOfCurrency1, hasInvolvedCurrency, isMint, isPoolTickInRange, isSorted, masterChefV3ABI, maxLiquidityForAmount0Imprecise, maxLiquidityForAmount0Precise, maxLiquidityForAmount1, maxLiquidityForAmounts, mostSignificantBit, nearestUsableTick, nonfungiblePositionManagerABI, pancakeV3PoolABI, parseProtocolFees, peripheryPaymentsWithFeeABI, priceToClosestTick, quoterABI, quoterV2ABI, selfPermitABI, sqrtRatioX96ToPrice, subIn256, swap, swapRouterABI, tickToPrice, tickToPriceV2, toHex, tradeComparator, v3PoolAbi, v3StakerABI };

package/dist/utils/maxLiquidityForAmounts.d.ts

@@ -1,4 +1,33 @@
 import { BigintIsh } from '@pancakeswap/sdk';
+/**
+ * Returns an imprecise maximum amount of liquidity received for a given amount of token 0.
+ * This function is available to accommodate LiquidityAmounts#getLiquidityForAmount0 in the v3 periphery,
+ * which could be more precise by at least 32 bits by dividing by Q64 instead of Q96 in the intermediate step,
+ * and shifting the subtracted ratio left by 32 bits. This imprecise calculation will likely be replaced in a future
+ * v3 router contract.
+ * @param sqrtRatioAX96 The price at the lower boundary
+ * @param sqrtRatioBX96 The price at the upper boundary
+ * @param amount0 The token0 amount
+ * @returns liquidity for amount0, imprecise
+ */
+export declare function maxLiquidityForAmount0Imprecise(sqrtRatioAX96: bigint, sqrtRatioBX96: bigint, amount0: BigintIsh): bigint;
+/**
+ * Returns a precise maximum amount of liquidity received for a given amount of token 0 by dividing by Q64 instead of Q96 in the intermediate step,
+ * and shifting the subtracted ratio left by 32 bits.
+ * @param sqrtRatioAX96 The price at the lower boundary
+ * @param sqrtRatioBX96 The price at the upper boundary
+ * @param amount0 The token0 amount
+ * @returns liquidity for amount0, precise
+ */
+export declare function maxLiquidityForAmount0Precise(sqrtRatioAX96: bigint, sqrtRatioBX96: bigint, amount0: BigintIsh): bigint;
+/**
+ * Computes the maximum amount of liquidity received for a given amount of token1
+ * @param sqrtRatioAX96 The price at the lower tick boundary
+ * @param sqrtRatioBX96 The price at the upper tick boundary
+ * @param amount1 The token1 amount
+ * @returns liquidity for amount1
+ */
+export declare function maxLiquidityForAmount1(sqrtRatioAX96: bigint, sqrtRatioBX96: bigint, amount1: BigintIsh): bigint;
 /**
  * Computes the maximum amount of liquidity received for a given amount of token0, token1,
  * and the prices at the tick boundaries.

package/dist/utils/maxLiquidityForAmounts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"maxLiquidityForAmounts.d.ts","sourceRoot":"","sources":["../../src/utils/maxLiquidityForAmounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAuD5C;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,mBAAmB,EAAE,MAAM,EAC3B,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,SAAS,EAClB,gBAAgB,EAAE,OAAO,GACxB,MAAM,CAgBR"}
+{"version":3,"file":"maxLiquidityForAmounts.d.ts","sourceRoot":"","sources":["../../src/utils/maxLiquidityForAmounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAG5C;;;;;;;;;;GAUG;AACH,wBAAgB,+BAA+B,CAC7C,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,SAAS,GACjB,MAAM,CAMR;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAC3C,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,SAAS,GACjB,MAAM,CASR;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,GAAG,MAAM,CAK/G;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,mBAAmB,EAAE,MAAM,EAC3B,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,SAAS,EAClB,OAAO,EAAE,SAAS,EAClB,gBAAgB,EAAE,OAAO,GACxB,MAAM,CAgBR"}

package/dist/utils/nearestUsableTick.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nearestUsableTick.d.ts","sourceRoot":"","sources":["../../src/utils/nearestUsableTick.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAQlE"}
+{"version":3,"file":"nearestUsableTick.d.ts","sourceRoot":"","sources":["../../src/utils/nearestUsableTick.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UASlE"}

package/dist/utils/priceTickConversions.d.ts

@@ -1,4 +1,4 @@
-import { Price, Token } from '@pancakeswap/swap-sdk-core';
+import { Currency, Price, Token } from '@pancakeswap/swap-sdk-core';
 /**
  * Returns a price object corresponding to the input tick and the base/quote token
  * Inputs must be tokens because the address order is used to interpret the price represented by the tick
@@ -6,11 +6,19 @@ import { Price, Token } from '@pancakeswap/swap-sdk-core';
  * @param quoteToken the quote token of the price
  * @param tick the tick for which to return the price
  */
-export declare function tickToPrice(baseToken: Token, quoteToken: Token, tick: number): Price<Token, Token>;
+export declare function tickToPrice<TBase extends Currency | Token, TQuote extends Currency | Token>(baseToken: TBase, quoteToken: TQuote, tick: number): Price<TBase, TQuote>;
+/**
+ * Returns a price object corresponding to the input tick and the base/quote token
+ * Inputs must be tokens because the address order is used to interpret the price represented by the tick
+ * @param baseToken the base token of the price
+ * @param quoteToken the quote token of the price
+ * @param tick the tick for which to return the price
+ */
+export declare function tickToPriceV2(baseToken: Currency, quoteToken: Currency, tick: number): Price<Currency, Currency>;
 /**
  * Returns the first tick for which the given price is greater than or equal to the tick price
  * @param price for which to return the closest tick that represents a price less than or equal to the input price,
  * i.e. the price of the returned tick is less than or equal to the input price
  */
-export declare function priceToClosestTick(price: Price<Token, Token>): number;
+export declare function priceToClosestTick(price: Price<Currency, Currency>): number;
 //# sourceMappingURL=priceTickConversions.d.ts.map

package/dist/utils/priceTickConversions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"priceTickConversions.d.ts","sourceRoot":"","sources":["../../src/utils/priceTickConversions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAKzD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAQlG;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,MAAM,CAiBrE"}
+{"version":3,"file":"priceTickConversions.d.ts","sourceRoot":"","sources":["../../src/utils/priceTickConversions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,KAAK,EAAkB,KAAK,EAAE,MAAM,4BAA4B,CAAA;AAIrG;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,SAAS,QAAQ,GAAG,KAAK,EAAE,MAAM,SAAS,QAAQ,GAAG,KAAK,EACzF,SAAS,EAAE,KAAK,EAChB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAQtB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAQhH;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,CAiB3E"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.9.1",
+  "version": "3.9.3",
   "description": "⚒️ An SDK for building applications on top of Pancakeswap V3",
   "files": [
     "dist"
@@ -24,13 +24,13 @@
     "tiny-warning": "^1.0.3",
     "toformat": "^2.0.0",
     "viem": "^2.22.23",
-    "@pancakeswap/chains": "0.5.1",
-    "@pancakeswap/sdk": "5.8.12",
-    "@pancakeswap/swap-sdk-core": "1.3.0"
+    "@pancakeswap/chains": "0.5.2",
+    "@pancakeswap/sdk": "5.8.14",
+    "@pancakeswap/swap-sdk-core": "1.4.0"
   },
   "devDependencies": {
     "tsup": "^6.7.0",
-    "@pancakeswap/utils": "6.0.11"
+    "@pancakeswap/utils": "6.1.1"
   },
   "engines": {
     "node": ">=10"