@orca-so/whirlpools-core 0.3.2 → 0.4.0

package/dist/browser/orca_whirlpools_core_js_bindings.d.ts

@@ -1,36 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * 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;
 /**
  * Get the first tick index in the tick array that contains the specified tick index.
  *
@@ -191,26 +160,57 @@ export function isFullRangeOnly(tick_spacing: number): boolean;
  */
 export function getTickIndexInArray(tick_index: number, tick_array_start_index: number, tick_spacing: number): number;
 export function _POSITION_BUNDLE_SIZE(): number;
-export function _TICK_ARRAY_NOT_EVENLY_SPACED(): number;
-export function _TICK_INDEX_OUT_OF_BOUNDS(): number;
-export function _INVALID_TICK_INDEX(): number;
-export function _ARITHMETIC_OVERFLOW(): number;
-export function _AMOUNT_EXCEEDS_MAX_U64(): number;
-export function _SQRT_PRICE_OUT_OF_BOUNDS(): number;
-export function _TICK_SEQUENCE_EMPTY(): number;
-export function _SQRT_PRICE_LIMIT_OUT_OF_BOUNDS(): number;
-export function _INVALID_SQRT_PRICE_LIMIT_DIRECTION(): number;
-export function _ZERO_TRADABLE_AMOUNT(): number;
-export function _INVALID_TIMESTAMP(): number;
-export function _INVALID_TRANSFER_FEE(): number;
-export function _INVALID_SLIPPAGE_TOLERANCE(): number;
-export function _TICK_INDEX_NOT_IN_ARRAY(): number;
 export function _NUM_REWARDS(): 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;
+export function _TICK_ARRAY_NOT_EVENLY_SPACED(): string;
+export function _TICK_INDEX_OUT_OF_BOUNDS(): string;
+export function _INVALID_TICK_INDEX(): string;
+export function _ARITHMETIC_OVERFLOW(): string;
+export function _AMOUNT_EXCEEDS_MAX_U64(): string;
+export function _SQRT_PRICE_OUT_OF_BOUNDS(): string;
+export function _TICK_SEQUENCE_EMPTY(): string;
+export function _SQRT_PRICE_LIMIT_OUT_OF_BOUNDS(): string;
+export function _INVALID_SQRT_PRICE_LIMIT_DIRECTION(): string;
+export function _ZERO_TRADABLE_AMOUNT(): string;
+export function _INVALID_TIMESTAMP(): string;
+export function _INVALID_TRANSFER_FEE(): string;
+export function _INVALID_SLIPPAGE_TOLERANCE(): string;
+export function _TICK_INDEX_NOT_IN_ARRAY(): string;
 /**
  * Check if a position is in range.
  * When a position is in range it is earning fees and rewards
@@ -252,76 +252,6 @@ export function positionStatus(current_sqrt_price: bigint, tick_index_1: number,
  * - A PositionRatio struct containing the ratio of token_a and token_b
  */
 export function positionRatio(current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number): PositionRatio;
-/**
- * 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;
 /**
  * Calculate the amount A delta between two sqrt_prices
  *
@@ -482,6 +412,76 @@ export function swapQuoteByInputToken(token_in: bigint, specified_token_a: boole
  * 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;
+/**
+ * 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;
 /**
  * Calculate fees owed for a position
  *
@@ -610,6 +610,25 @@ export function increaseLiquidityQuoteB(token_amount_b: bigint, slippage_toleran
  * - `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 interface ExactOutSwapQuote {
+    tokenOut: bigint;
+    tokenEstIn: bigint;
+    tokenMaxIn: bigint;
+    tradeFee: bigint;
+}
+
+export interface ExactInSwapQuote {
+    tokenIn: bigint;
+    tokenEstOut: bigint;
+    tokenMinOut: bigint;
+    tradeFee: bigint;
+}
+
+export interface TransferFee {
+    feeBps: number;
+    maxFee: bigint;
+}
+
 export interface PositionRewardInfoFacade {
     growthInsideCheckpoint: bigint;
     amountOwed: bigint;
@@ -633,39 +652,31 @@ export interface PositionRatio {
     ratioB: number;
 }
 
-export interface IncreaseLiquidityQuote {
-    liquidityDelta: bigint;
-    tokenEstA: bigint;
-    tokenEstB: bigint;
-    tokenMaxA: bigint;
-    tokenMaxB: bigint;
+export interface TickArrayFacade {
+    startTickIndex: number;
+    ticks: TickFacade[];
 }
 
-export interface DecreaseLiquidityQuote {
-    liquidityDelta: bigint;
-    tokenEstA: bigint;
-    tokenEstB: bigint;
-    tokenMinA: bigint;
-    tokenMinB: bigint;
+export interface TickFacade {
+    initialized: boolean;
+    liquidityNet: bigint;
+    liquidityGross: bigint;
+    feeGrowthOutsideA: bigint;
+    feeGrowthOutsideB: bigint;
+    rewardGrowthsOutside: bigint[];
 }
 
-export interface CollectFeesQuote {
-    feeOwedA: bigint;
-    feeOwedB: bigint;
+export interface TickRange {
+    tickLowerIndex: number;
+    tickUpperIndex: number;
 }
 
-export interface ExactOutSwapQuote {
-    tokenOut: bigint;
-    tokenEstIn: bigint;
-    tokenMaxIn: bigint;
-    tradeFee: bigint;
+export interface CollectRewardQuote {
+    rewardsOwed: bigint;
 }
 
-export interface ExactInSwapQuote {
-    tokenIn: bigint;
-    tokenEstOut: bigint;
-    tokenMinOut: bigint;
-    tradeFee: bigint;
+export interface CollectRewardsQuote {
+    rewards: CollectRewardQuote[];
 }
 
 export interface WhirlpoolRewardInfoFacade {
@@ -686,35 +697,24 @@ export interface WhirlpoolFacade {
     rewardInfos: WhirlpoolRewardInfoFacade[];
 }
 
-export interface TransferFee {
-    feeBps: number;
-    maxFee: bigint;
-}
-
-export interface TickArrayFacade {
-    startTickIndex: number;
-    ticks: TickFacade[];
-}
-
-export interface TickFacade {
-    initialized: boolean;
-    liquidityNet: bigint;
-    liquidityGross: bigint;
-    feeGrowthOutsideA: bigint;
-    feeGrowthOutsideB: bigint;
-    rewardGrowthsOutside: bigint[];
-}
-
-export interface TickRange {
-    tickLowerIndex: number;
-    tickUpperIndex: number;
+export interface IncreaseLiquidityQuote {
+    liquidityDelta: bigint;
+    tokenEstA: bigint;
+    tokenEstB: bigint;
+    tokenMaxA: bigint;
+    tokenMaxB: bigint;
 }
 
-export interface CollectRewardQuote {
-    rewardsOwed: bigint;
+export interface DecreaseLiquidityQuote {
+    liquidityDelta: bigint;
+    tokenEstA: bigint;
+    tokenEstB: bigint;
+    tokenMinA: bigint;
+    tokenMinB: bigint;
 }
 
-export interface CollectRewardsQuote {
-    rewards: CollectRewardQuote[];
+export interface CollectFeesQuote {
+    feeOwedA: bigint;
+    feeOwedB: bigint;
 }