@orca-so/whirlpools-core 2.0.0 → 3.0.0

package/dist/browser/orca_whirlpools_core_js_bindings.d.ts

@@ -1,15 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-/**
- * Check if the whirlpool is initialized with adaptive fee
- *
- * # Paramters
- * - `whirlpool`: The whirlpool state
- *
- * # Returns
- * - A boolean value indicating if the whirlpool is initialized with adaptive fee
- */
-export function isInitializedWithAdaptiveFee(whirlpool: WhirlpoolFacade): boolean;
 /**
  * Calculate the amount A delta between two sqrt_prices
  *
@@ -155,37 +145,6 @@ export function tryReverseApplySwapFee(amount: bigint, fee_rate: number): bigint
  * - `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 | null, transfer_fee_2?: TransferFee | null, transfer_fee_3?: TransferFee | null): CollectRewardsQuote;
-/**
- * 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.
  *
@@ -211,6 +170,7 @@ export function tickIndexToSqrtPrice(tick_index: number): bigint;
 /**
  * Derive the tick index from a sqrt price. The precision of this method is only guarranted
  * if tick is within the bounds of {max, min} tick-index.
+ * This function will make panic for zero sqrt price.
  *
  * # Parameters
  * - `sqrt_price` - A u128 integer representing the sqrt price
@@ -351,28 +311,43 @@ export function _ADAPTIVE_FEE_CONTROL_FACTOR_DENOMINATOR(): number;
 export function _MAX_REFERENCE_AGE(): bigint;
 export function _FEE_RATE_HARD_LIMIT(): 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;
-export function _INVALID_TICK_ARRAY_SEQUENCE(): string;
-export function _INVALID_ADAPTIVE_FEE_INFO(): 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;
 /**
  * Check if a position is in range.
  * When a position is in range it is earning fees and rewards
@@ -484,6 +459,32 @@ export function tickIndexToPrice(tick_index: number, decimals_a: number, decimal
  * * `i32` - The tick index
  */
 export function priceToTickIndex(price: number, decimals_a: number, decimals_b: number): 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 _INVALID_TICK_ARRAY_SEQUENCE(): string;
+export function _INVALID_ADAPTIVE_FEE_INFO(): string;
+/**
+ * Check if the whirlpool is initialized with adaptive fee
+ *
+ * # Paramters
+ * - `whirlpool`: The whirlpool state
+ *
+ * # Returns
+ * - A boolean value indicating if the whirlpool is initialized with adaptive fee
+ */
+export function isInitializedWithAdaptiveFee(whirlpool: WhirlpoolFacade): boolean;
 /**
  * Computes the exact input or output amount for a swap transaction.
  *
@@ -631,14 +632,22 @@ export function increaseLiquidityQuoteA(token_amount_a: bigint, slippage_toleran
  * - 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 | null, transfer_fee_b?: TransferFee | null): IncreaseLiquidityQuote;
-export interface TransferFee {
-    feeBps: number;
-    maxFee: bigint;
+export interface ExactOutSwapQuote {
+    tokenOut: bigint;
+    tokenEstIn: bigint;
+    tokenMaxIn: bigint;
+    tradeFee: bigint;
+    tradeFeeRateMin: number;
+    tradeFeeRateMax: number;
 }
 
-export interface CollectFeesQuote {
-    feeOwedA: bigint;
-    feeOwedB: bigint;
+export interface ExactInSwapQuote {
+    tokenIn: bigint;
+    tokenEstOut: bigint;
+    tokenMinOut: bigint;
+    tradeFee: bigint;
+    tradeFeeRateMin: number;
+    tradeFeeRateMax: number;
 }
 
 export interface IncreaseLiquidityQuote {
@@ -657,22 +666,22 @@ export interface DecreaseLiquidityQuote {
     tokenMinB: bigint;
 }
 
-export interface ExactOutSwapQuote {
-    tokenOut: bigint;
-    tokenEstIn: bigint;
-    tokenMaxIn: bigint;
-    tradeFee: bigint;
-    tradeFeeRateMin: number;
-    tradeFeeRateMax: number;
+export interface CollectRewardQuote {
+    rewardsOwed: bigint;
 }
 
-export interface ExactInSwapQuote {
-    tokenIn: bigint;
-    tokenEstOut: bigint;
-    tokenMinOut: bigint;
-    tradeFee: bigint;
-    tradeFeeRateMin: number;
-    tradeFeeRateMax: number;
+export interface CollectRewardsQuote {
+    rewards: CollectRewardQuote[];
+}
+
+export interface TransferFee {
+    feeBps: number;
+    maxFee: bigint;
+}
+
+export interface CollectFeesQuote {
+    feeOwedA: bigint;
+    feeOwedB: bigint;
 }
 
 export interface TickArrayFacade {
@@ -765,11 +774,3 @@ export interface OracleFacade {
     adaptiveFeeVariables: AdaptiveFeeVariablesFacade;
 }
 
-export interface CollectRewardQuote {
-    rewardsOwed: bigint;
-}
-
-export interface CollectRewardsQuote {
-    rewards: CollectRewardQuote[];
-}
-