@orca-so/whirlpools-core 0.4.2 → 1.0.0

package/dist/browser/orca_whirlpools_core_js_bindings.d.ts

@@ -1,5 +1,98 @@
 /* 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;
+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;
 /**
  * Get the first tick index in the tick array that contains the specified tick index.
  *
@@ -159,99 +252,6 @@ 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 _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
- *
- * # 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
  *
@@ -610,20 +610,6 @@ 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;
@@ -648,6 +634,41 @@ 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;
+    tokenMaxIn: bigint;
+    tradeFee: bigint;
+}
+
+export interface ExactInSwapQuote {
+    tokenIn: bigint;
+    tokenEstOut: bigint;
+    tokenMinOut: bigint;
+    tradeFee: bigint;
+}
+
+export interface CollectFeesQuote {
+    feeOwedA: bigint;
+    feeOwedB: bigint;
+}
+
 export interface CollectRewardQuote {
     rewardsOwed: bigint;
 }
@@ -697,24 +718,3 @@ export interface WhirlpoolFacade {
     rewardInfos: WhirlpoolRewardInfoFacade[];
 }
 
-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;
-}
-