@orca-so/whirlpools-core 0.2.0 → 0.2.2

package/dist/browser/orca_whirlpools_core_js_bindings.d.ts

@@ -1,154 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-export function _POSITION_BUNDLE_SIZE(): 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;
-/**
- * Check if a position is in range.
- * When a position is in range it is earning fees and rewards
- *
- * # Parameters
- * - `sqrt_price` - A u128 integer representing the sqrt price of the pool
- * - `tick_index_1` - A i32 integer representing the first tick index of the position
- * - `tick_index_2` - A i32 integer representing the second tick index of the position
- *
- * # Returns
- * - A boolean value indicating if the position is in range
- */
-export function isPositionInRange(current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number): boolean;
-/**
- * Calculate the status of a position
- * The status can be one of three values:
- * - InRange: The position is in range
- * - BelowRange: The position is below the range
- * - AboveRange: The position is above the range
- *
- * # Parameters
- * - `sqrt_price` - A u128 integer representing the sqrt price of the pool
- * - `tick_index_1` - A i32 integer representing the first tick index of the position
- * - `tick_index_2` - A i32 integer representing the second tick index of the position
- *
- * # Returns
- * - A PositionStatus enum value indicating the status of the position
- */
-export function positionStatus(current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number): PositionStatus;
-/**
- * Calculate the token_a / token_b ratio of a (ficticious) position
- *
- * # Parameters
- * - `sqrt_price` - A u128 integer representing the sqrt price of the pool
- * - `tick_index_1` - A i32 integer representing the first tick index of the position
- * - `tick_index_2` - A i32 integer representing the second tick index of the position
- *
- * # Returns
- * - 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;
 /**
  * Get the first tick index in the tick array that contains the specified tick index.
  *
@@ -305,9 +156,41 @@ export function isFullRangeOnly(tick_spacing: number): boolean;
  * - `tick_spacing` - A u16 integer representing the tick spacing
  *
  * # Returns
- * - A i32 integer representing the tick index in the tick array
+ * - 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;
+/**
+ * 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 _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;
@@ -321,6 +204,124 @@ 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;
+/**
+ * Check if a position is in range.
+ * When a position is in range it is earning fees and rewards
+ *
+ * # Parameters
+ * - `sqrt_price` - A u128 integer representing the sqrt price of the pool
+ * - `tick_index_1` - A i32 integer representing the first tick index of the position
+ * - `tick_index_2` - A i32 integer representing the second tick index of the position
+ *
+ * # Returns
+ * - A boolean value indicating if the position is in range
+ */
+export function isPositionInRange(current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number): boolean;
+/**
+ * Calculate the status of a position
+ * The status can be one of three values:
+ * - InRange: The position is in range
+ * - BelowRange: The position is below the range
+ * - AboveRange: The position is above the range
+ *
+ * # Parameters
+ * - `sqrt_price` - A u128 integer representing the sqrt price of the pool
+ * - `tick_index_1` - A i32 integer representing the first tick index of the position
+ * - `tick_index_2` - A i32 integer representing the second tick index of the position
+ *
+ * # Returns
+ * - A PositionStatus enum value indicating the status of the position
+ */
+export function positionStatus(current_sqrt_price: bigint, tick_index_1: number, tick_index_2: number): PositionStatus;
+/**
+ * Calculate the token_a / token_b ratio of a (ficticious) position
+ *
+ * # Parameters
+ * - `sqrt_price` - A u128 integer representing the sqrt price of the pool
+ * - `tick_index_1` - A i32 integer representing the first tick index of the position
+ * - `tick_index_2` - A i32 integer representing the second tick index of the position
+ *
+ * # Returns
+ * - 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
  *
@@ -653,38 +654,6 @@ export interface CollectFeesQuote {
     feeOwedB: bigint;
 }
 
-export interface ExactOutSwapQuote {
-    tokenOut: bigint;
-    tokenEstIn: bigint;
-    tokenMaxIn: bigint;
-    tradeFee: bigint;
-}
-
-export interface ExactInSwapQuote {
-    tokenIn: bigint;
-    tokenEstOut: bigint;
-    tokenMinOut: bigint;
-    tradeFee: bigint;
-}
-
-export interface WhirlpoolRewardInfoFacade {
-    emissionsPerSecondX64: bigint;
-    growthGlobalX64: bigint;
-}
-
-export interface WhirlpoolFacade {
-    tickSpacing: number;
-    feeRate: number;
-    protocolFeeRate: number;
-    liquidity: bigint;
-    sqrtPrice: bigint;
-    tickCurrentIndex: number;
-    feeGrowthGlobalA: bigint;
-    feeGrowthGlobalB: bigint;
-    rewardLastUpdatedTimestamp: bigint;
-    rewardInfos: WhirlpoolRewardInfoFacade[];
-}
-
 export interface TransferFee {
     feeBps: number;
     maxFee: bigint;
@@ -717,3 +686,35 @@ export interface CollectRewardsQuote {
     rewards: CollectRewardQuote[];
 }
 
+export interface ExactOutSwapQuote {
+    tokenOut: bigint;
+    tokenEstIn: bigint;
+    tokenMaxIn: bigint;
+    tradeFee: bigint;
+}
+
+export interface ExactInSwapQuote {
+    tokenIn: bigint;
+    tokenEstOut: bigint;
+    tokenMinOut: bigint;
+    tradeFee: bigint;
+}
+
+export interface WhirlpoolRewardInfoFacade {
+    emissionsPerSecondX64: bigint;
+    growthGlobalX64: bigint;
+}
+
+export interface WhirlpoolFacade {
+    tickSpacing: number;
+    feeRate: number;
+    protocolFeeRate: number;
+    liquidity: bigint;
+    sqrtPrice: bigint;
+    tickCurrentIndex: number;
+    feeGrowthGlobalA: bigint;
+    feeGrowthGlobalB: bigint;
+    rewardLastUpdatedTimestamp: bigint;
+    rewardInfos: WhirlpoolRewardInfoFacade[];
+}
+