@orca-so/whirlpools-core 1.0.2 → 1.0.4

package/dist/browser/orca_whirlpools_core_js_bindings.d.ts

@@ -1,112 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-export function _FEE_RATE_DENOMINATOR(): number;
-export function _TICK_ARRAY_SIZE(): number;
-export function _FULL_RANGE_ONLY_TICK_SPACING_THRESHOLD(): number;
-export function _MIN_TICK_INDEX(): number;
-export function _MAX_TICK_INDEX(): number;
-/**
- * Get the first unoccupied position in a bundle
- *
- * # Arguments
- * * `bundle` - The bundle to check
- *
- * # Returns
- * * `u32` - The first unoccupied position (None if full)
- */
-export function firstUnoccupiedPositionInBundle(bitmap: Uint8Array): number | undefined;
-/**
- * Check whether a position bundle is full
- * A position bundle can contain 256 positions
- *
- * # Arguments
- * * `bundle` - The bundle to check
- *
- * # Returns
- * * `bool` - Whether the bundle is full
- */
-export function isPositionBundleFull(bitmap: Uint8Array): boolean;
-/**
- * Check whether a position bundle is empty
- *
- * # Arguments
- * * `bundle` - The bundle to check
- *
- * # Returns
- * * `bool` - Whether the bundle is empty
- */
-export function isPositionBundleEmpty(bitmap: Uint8Array): boolean;
-/**
- * Convert a price into a sqrt priceX64
- * IMPORTANT: floating point operations can reduce the precision of the result.
- * Make sure to do these operations last and not to use the result for further calculations.
- *
- * # Parameters
- * * `price` - The price to convert
- * * `decimals_a` - The number of decimals of the base token
- * * `decimals_b` - The number of decimals of the quote token
- *
- * # Returns
- * * `u128` - The sqrt priceX64
- */
-export function priceToSqrtPrice(price: number, decimals_a: number, decimals_b: number): bigint;
-/**
- * Convert a sqrt priceX64 into a tick index
- * IMPORTANT: floating point operations can reduce the precision of the result.
- * Make sure to do these operations last and not to use the result for further calculations.
- *
- * # Parameters
- * * `sqrt_price` - The sqrt priceX64 to convert
- * * `decimals_a` - The number of decimals of the base token
- * * `decimals_b` - The number of decimals of the quote token
- *
- * # Returns
- * * `f64` - The decimal price
- */
-export function sqrtPriceToPrice(sqrt_price: bigint, decimals_a: number, decimals_b: number): number;
-/**
- * Invert a price
- * IMPORTANT: floating point operations can reduce the precision of the result.
- * Make sure to do these operations last and not to use the result for further calculations.
- *
- * # Parameters
- * * `price` - The price to invert
- * * `decimals_a` - The number of decimals of the base token
- * * `decimals_b` - The number of decimals of the quote token
- *
- * # Returns
- * * `f64` - The inverted price
- */
-export function invertPrice(price: number, decimals_a: number, decimals_b: number): number;
-/**
- * Convert a tick index into a price
- * IMPORTANT: floating point operations can reduce the precision of the result.
- * Make sure to do these operations last and not to use the result for further calculations.
- *
- * # Parameters
- * * `tick_index` - The tick index to convert
- * * `decimals_a` - The number of decimals of the base token
- * * `decimals_b` - The number of decimals of the quote token
- *
- * # Returns
- * * `f64` - The decimal price
- */
-export function tickIndexToPrice(tick_index: number, decimals_a: number, decimals_b: number): number;
-/**
- * Convert a price into a tick index
- * IMPORTANT: floating point operations can reduce the precision of the result.
- * Make sure to do these operations last and not to use the result for further calculations.
- *
- * # Parameters
- * * `price` - The price to convert
- * * `decimals_a` - The number of decimals of the base token
- * * `decimals_b` - The number of decimals of the quote token
- *
- * # Returns
- * * `i32` - The tick index
- */
-export function priceToTickIndex(price: number, decimals_a: number, decimals_b: number): number;
-export function _NUM_REWARDS(): number;
 /**
  * Get the first tick index in the tick array that contains the specified tick index.
  *
@@ -152,7 +45,7 @@ export function sqrtPriceToTickIndex(sqrt_price: bigint): number;
  * # Returns
  * - A i32 integer representing the previous initializable tick index
  */
-export function getInitializableTickIndex(tick_index: number, tick_spacing: number, round_up?: boolean): number;
+export function getInitializableTickIndex(tick_index: number, tick_spacing: number, round_up?: boolean | null): number;
 /**
  * Get the previous initializable tick index.
  *
@@ -266,6 +159,113 @@ export function isFullRangeOnly(tick_spacing: number): boolean;
  * - A u32 integer representing the tick index in the tick array
  */
 export function getTickIndexInArray(tick_index: number, tick_array_start_index: number, tick_spacing: number): number;
+export function _FEE_RATE_DENOMINATOR(): number;
+export function _TICK_ARRAY_SIZE(): number;
+export function _FULL_RANGE_ONLY_TICK_SPACING_THRESHOLD(): number;
+export function _MIN_TICK_INDEX(): number;
+export function _MAX_TICK_INDEX(): number;
+/**
+ * Get the first unoccupied position in a bundle
+ *
+ * # Arguments
+ * * `bundle` - The bundle to check
+ *
+ * # Returns
+ * * `u32` - The first unoccupied position (None if full)
+ */
+export function firstUnoccupiedPositionInBundle(bitmap: Uint8Array): number | undefined;
+/**
+ * Check whether a position bundle is full
+ * A position bundle can contain 256 positions
+ *
+ * # Arguments
+ * * `bundle` - The bundle to check
+ *
+ * # Returns
+ * * `bool` - Whether the bundle is full
+ */
+export function isPositionBundleFull(bitmap: Uint8Array): boolean;
+/**
+ * Check whether a position bundle is empty
+ *
+ * # Arguments
+ * * `bundle` - The bundle to check
+ *
+ * # Returns
+ * * `bool` - Whether the bundle is empty
+ */
+export function isPositionBundleEmpty(bitmap: Uint8Array): boolean;
+/**
+ * Convert a price into a sqrt priceX64
+ * IMPORTANT: floating point operations can reduce the precision of the result.
+ * Make sure to do these operations last and not to use the result for further calculations.
+ *
+ * # Parameters
+ * * `price` - The price to convert
+ * * `decimals_a` - The number of decimals of the base token
+ * * `decimals_b` - The number of decimals of the quote token
+ *
+ * # Returns
+ * * `u128` - The sqrt priceX64
+ */
+export function priceToSqrtPrice(price: number, decimals_a: number, decimals_b: number): bigint;
+/**
+ * Convert a sqrt priceX64 into a tick index
+ * IMPORTANT: floating point operations can reduce the precision of the result.
+ * Make sure to do these operations last and not to use the result for further calculations.
+ *
+ * # Parameters
+ * * `sqrt_price` - The sqrt priceX64 to convert
+ * * `decimals_a` - The number of decimals of the base token
+ * * `decimals_b` - The number of decimals of the quote token
+ *
+ * # Returns
+ * * `f64` - The decimal price
+ */
+export function sqrtPriceToPrice(sqrt_price: bigint, decimals_a: number, decimals_b: number): number;
+/**
+ * Invert a price
+ * IMPORTANT: floating point operations can reduce the precision of the result.
+ * Make sure to do these operations last and not to use the result for further calculations.
+ *
+ * # Parameters
+ * * `price` - The price to invert
+ * * `decimals_a` - The number of decimals of the base token
+ * * `decimals_b` - The number of decimals of the quote token
+ *
+ * # Returns
+ * * `f64` - The inverted price
+ */
+export function invertPrice(price: number, decimals_a: number, decimals_b: number): number;
+/**
+ * Convert a tick index into a price
+ * IMPORTANT: floating point operations can reduce the precision of the result.
+ * Make sure to do these operations last and not to use the result for further calculations.
+ *
+ * # Parameters
+ * * `tick_index` - The tick index to convert
+ * * `decimals_a` - The number of decimals of the base token
+ * * `decimals_b` - The number of decimals of the quote token
+ *
+ * # Returns
+ * * `f64` - The decimal price
+ */
+export function tickIndexToPrice(tick_index: number, decimals_a: number, decimals_b: number): number;
+/**
+ * Convert a price into a tick index
+ * IMPORTANT: floating point operations can reduce the precision of the result.
+ * Make sure to do these operations last and not to use the result for further calculations.
+ *
+ * # Parameters
+ * * `price` - The price to convert
+ * * `decimals_a` - The number of decimals of the base token
+ * * `decimals_b` - The number of decimals of the quote token
+ *
+ * # Returns
+ * * `i32` - The tick index
+ */
+export function priceToTickIndex(price: number, decimals_a: number, decimals_b: number): number;
+export function _NUM_REWARDS(): number;
 export function _POSITION_BUNDLE_SIZE(): number;
 export function _TICK_ARRAY_NOT_EVENLY_SPACED(): string;
 export function _TICK_INDEX_OUT_OF_BOUNDS(): string;
@@ -465,7 +465,7 @@ export function tryReverseApplySwapFee(amount: bigint, fee_rate: number): bigint
  * # Returns
  * The exact input or output amount for the swap transaction.
  */
-export function swapQuoteByInputToken(token_in: bigint, specified_token_a: boolean, slippage_tolerance_bps: number, whirlpool: WhirlpoolFacade, tick_arrays: TickArrayFacade[], transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): ExactInSwapQuote;
+export function swapQuoteByInputToken(token_in: bigint, specified_token_a: boolean, slippage_tolerance_bps: number, whirlpool: WhirlpoolFacade, tick_arrays: TickArrayFacade[], transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): ExactInSwapQuote;
 /**
  * Computes the exact input or output amount for a swap transaction.
  *
@@ -481,7 +481,7 @@ export function swapQuoteByInputToken(token_in: bigint, specified_token_a: boole
  * # Returns
  * The exact input or output amount for the swap transaction.
  */
-export function swapQuoteByOutputToken(token_out: bigint, specified_token_a: boolean, slippage_tolerance_bps: number, whirlpool: WhirlpoolFacade, tick_arrays: TickArrayFacade[], transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): ExactOutSwapQuote;
+export function swapQuoteByOutputToken(token_out: bigint, specified_token_a: boolean, slippage_tolerance_bps: number, whirlpool: WhirlpoolFacade, tick_arrays: TickArrayFacade[], transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): ExactOutSwapQuote;
 /**
  * Calculate fees owed for a position
  *
@@ -496,7 +496,7 @@ export function swapQuoteByOutputToken(token_out: bigint, specified_token_a: boo
  * # Returns
  * - `CollectFeesQuote`: The fees owed for token A and token B
  */
-export function collectFeesQuote(whirlpool: WhirlpoolFacade, position: PositionFacade, tick_lower: TickFacade, tick_upper: TickFacade, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): CollectFeesQuote;
+export function collectFeesQuote(whirlpool: WhirlpoolFacade, position: PositionFacade, tick_lower: TickFacade, tick_upper: TickFacade, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): CollectFeesQuote;
 /**
  * Calculate the quote for decreasing liquidity
  *
@@ -512,7 +512,7 @@ export function collectFeesQuote(whirlpool: WhirlpoolFacade, position: PositionF
  * # Returns
  * - A DecreaseLiquidityQuote struct containing the estimated token amounts
  */
-export function decreaseLiquidityQuote(liquidity_delta: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): DecreaseLiquidityQuote;
+export function decreaseLiquidityQuote(liquidity_delta: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): DecreaseLiquidityQuote;
 /**
  * Calculate the quote for decreasing liquidity given a token a amount
  *
@@ -528,7 +528,7 @@ export function decreaseLiquidityQuote(liquidity_delta: bigint, slippage_toleran
  * # Returns
  * - A DecreaseLiquidityQuote struct containing the estimated token amounts
  */
-export function decreaseLiquidityQuoteA(token_amount_a: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): DecreaseLiquidityQuote;
+export function decreaseLiquidityQuoteA(token_amount_a: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): DecreaseLiquidityQuote;
 /**
  * Calculate the quote for decreasing liquidity given a token b amount
  *
@@ -544,7 +544,7 @@ export function decreaseLiquidityQuoteA(token_amount_a: bigint, slippage_toleran
  * # Returns
  * - A DecreaseLiquidityQuote struct containing the estimated token amounts
  */
-export function decreaseLiquidityQuoteB(token_amount_b: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): DecreaseLiquidityQuote;
+export function decreaseLiquidityQuoteB(token_amount_b: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): DecreaseLiquidityQuote;
 /**
  * Calculate the quote for increasing liquidity
  *
@@ -560,7 +560,7 @@ export function decreaseLiquidityQuoteB(token_amount_b: bigint, slippage_toleran
  * # Returns
  * - An IncreaseLiquidityQuote struct containing the estimated token amounts
  */
-export function increaseLiquidityQuote(liquidity_delta: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): IncreaseLiquidityQuote;
+export function increaseLiquidityQuote(liquidity_delta: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): IncreaseLiquidityQuote;
 /**
  * Calculate the quote for increasing liquidity given a token a amount
  *
@@ -576,7 +576,7 @@ export function increaseLiquidityQuote(liquidity_delta: bigint, slippage_toleran
  * # Returns
  * - An IncreaseLiquidityQuote struct containing the estimated token amounts
  */
-export function increaseLiquidityQuoteA(token_amount_a: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): IncreaseLiquidityQuote;
+export function increaseLiquidityQuoteA(token_amount_a: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): IncreaseLiquidityQuote;
 /**
  * Calculate the quote for increasing liquidity given a token b amount
  *
@@ -592,7 +592,7 @@ export function increaseLiquidityQuoteA(token_amount_a: bigint, slippage_toleran
  * # Returns
  * - An IncreaseLiquidityQuote struct containing the estimated token amounts
  */
-export function increaseLiquidityQuoteB(token_amount_b: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee, transfer_fee_b?: TransferFee): IncreaseLiquidityQuote;
+export function increaseLiquidityQuoteB(token_amount_b: bigint, slippage_tolerance_bps: number, current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): IncreaseLiquidityQuote;
 /**
  * Calculate rewards owed for a position
  *
@@ -609,7 +609,7 @@ export function increaseLiquidityQuoteB(token_amount_b: bigint, slippage_toleran
  * # Returns
  * - `CollectRewardsQuote`: The rewards owed for the 3 reward tokens.
  */
-export function collectRewardsQuote(whirlpool: WhirlpoolFacade, position: PositionFacade, tick_lower: TickFacade, tick_upper: TickFacade, current_timestamp: bigint, transfer_fee_1?: TransferFee, transfer_fee_2?: TransferFee, transfer_fee_3?: TransferFee): CollectRewardsQuote;
+export function collectRewardsQuote(whirlpool: WhirlpoolFacade, position: PositionFacade, tick_lower: TickFacade, tick_upper: TickFacade, current_timestamp: bigint, transfer_fee_1?: TransferFee | null, transfer_fee_2?: TransferFee | null, transfer_fee_3?: TransferFee | null): CollectRewardsQuote;
 export interface TransferFee {
     feeBps: number;
     maxFee: bigint;
@@ -636,6 +636,14 @@ export interface CollectFeesQuote {
     feeOwedB: bigint;
 }
 
+export interface CollectRewardQuote {
+    rewardsOwed: bigint;
+}
+
+export interface CollectRewardsQuote {
+    rewards: CollectRewardQuote[];
+}
+
 export interface TickArrayFacade {
     startTickIndex: number;
     ticks: TickFacade[];
@@ -687,14 +695,6 @@ export interface WhirlpoolFacade {
     rewardInfos: WhirlpoolRewardInfoFacade[];
 }
 
-export interface CollectRewardQuote {
-    rewardsOwed: bigint;
-}
-
-export interface CollectRewardsQuote {
-    rewards: CollectRewardQuote[];
-}
-
 export interface PositionRewardInfoFacade {
     growthInsideCheckpoint: bigint;
     amountOwed: bigint;