@orca-so/whirlpools-core 1.0.0 → 1.0.2

package/dist/browser/orca_whirlpools_core_js_bindings.d.ts

@@ -1,62 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * 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;
-export function _POSITION_BUNDLE_SIZE(): number;
-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;
-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;
@@ -93,6 +36,77 @@ export function isPositionBundleFull(bitmap: Uint8Array): boolean;
  * * `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.
  *
@@ -252,6 +266,62 @@ 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 _POSITION_BUNDLE_SIZE(): number;
+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
+ *
+ * # 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;
 /**
  * Calculate the amount A delta between two sqrt_prices
  *
@@ -412,76 +482,6 @@ 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
  *
@@ -615,6 +615,27 @@ export interface TransferFee {
     maxFee: bigint;
 }
 
+export interface IncreaseLiquidityQuote {
+    liquidityDelta: bigint;
+    tokenEstA: bigint;
+    tokenEstB: bigint;
+    tokenMaxA: bigint;
+    tokenMaxB: bigint;
+}
+
+export interface DecreaseLiquidityQuote {
+    liquidityDelta: bigint;
+    tokenEstA: bigint;
+    tokenEstB: bigint;
+    tokenMinA: bigint;
+    tokenMinB: bigint;
+}
+
+export interface CollectFeesQuote {
+    feeOwedA: bigint;
+    feeOwedB: bigint;
+}
+
 export interface TickArrayFacade {
     startTickIndex: number;
     ticks: TickFacade[];
@@ -634,22 +655,6 @@ export interface TickRange {
     tickUpperIndex: number;
 }
 
-export interface IncreaseLiquidityQuote {
-    liquidityDelta: bigint;
-    tokenEstA: bigint;
-    tokenEstB: bigint;
-    tokenMaxA: bigint;
-    tokenMaxB: bigint;
-}
-
-export interface DecreaseLiquidityQuote {
-    liquidityDelta: bigint;
-    tokenEstA: bigint;
-    tokenEstB: bigint;
-    tokenMinA: bigint;
-    tokenMinB: bigint;
-}
-
 export interface ExactOutSwapQuote {
     tokenOut: bigint;
     tokenEstIn: bigint;
@@ -664,9 +669,22 @@ export interface ExactInSwapQuote {
     tradeFee: bigint;
 }
 
-export interface CollectFeesQuote {
-    feeOwedA: bigint;
-    feeOwedB: 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 CollectRewardQuote {
@@ -700,21 +718,3 @@ export interface PositionRatio {
     ratioB: number;
 }
 
-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[];
-}
-