@crypticdot/defituna-core 3.4.5 → 3.4.7

package/dist/browser/defituna_core_js_bindings.d.ts

@@ -263,28 +263,154 @@ 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 function tryGetLiquidityFromA(token_delta_a: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint): bigint;
-export function tryGetTokenAFromLiquidity(liquidity_delta: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint, round_up: boolean): bigint;
-export function tryGetLiquidityFromB(token_delta_b: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint): bigint;
-export function tryGetTokenBFromLiquidity(liquidity_delta: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint, round_up: boolean): bigint;
-export function tryGetAmountsFromLiquidity(liquidity_delta: bigint, current_sqrt_price: bigint, tick_lower_index: number, tick_upper_index: number, round_up: boolean): TokenPair;
-export function tryGetLiquidityFromAmounts(sqrt_price: bigint, sqrt_price_a_x64: bigint, sqrt_price_b_x64: bigint, amount_a: bigint, amount_b: bigint): bigint;
 /**
- * Calculate fees owed for a position
+ * Get the first unoccupied position in a bundle
  *
- * # Paramters
- * - `fusion_pool`: The fusion_pool state
- * - `position`: The position state
- * - `tick_lower`: The lower tick state
- * - `tick_upper`: The upper tick state
- * - `transfer_fee_a`: The transfer fee for token A
- * - `transfer_fee_b`: The transfer fee for token B
+ * # Arguments
+ * * `bundle` - The bundle to check
  *
  * # Returns
- * - `CollectFeesQuote`: The fees owed for token A and token B
+ * * `u32` - The first unoccupied position (None if full)
  */
-export function collectFeesQuote(fusion_pool: FusionPoolFacade, position: PositionFacade, tick_lower: TickFacade, tick_upper: TickFacade, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): CollectFeesQuote;
-export function limitOrderFee(fusion_pool: FusionPoolFacade): number;
+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 positionRatioX64(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;
+export function getLiquidityFromAmountA(amount_a: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint): bigint;
+export function getLiquidityFromAmountB(amount_b: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint): bigint;
+export function getAmountAFromLiquidity(liquidity: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint, round_up: boolean): bigint;
+export function getAmountBFromLiquidity(liquidity: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint, round_up: boolean): bigint;
+export function getAmountsFromLiquidity(liquidity: bigint, sqrt_price: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint, round_up: boolean): TokenPair;
+export function getLiquidityFromAmounts(sqrt_price: bigint, sqrt_price_lower: bigint, sqrt_price_upper: bigint, amount_a: bigint, amount_b: bigint): bigint;
 /**
  * Calculate the amount A delta between two sqrt_prices
  *
@@ -442,147 +568,21 @@ export function limitOrderQuoteByOutputToken(amount_out: bigint, a_to_b_order: b
 export function limitOrderRewardByOutputToken(amount_out: bigint, fee_rate: number, protocol_fee_rate: number): bigint;
 export function decreaseLimitOrderQuote(fusion_pool: FusionPoolFacade, limit_order: LimitOrderFacade, tick: TickFacade, amount: bigint, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): LimitOrderDecreaseQuote;
 /**
- * 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 positionRatioX64(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.
+ * Calculate fees owed for a position
  *
- * # 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
+ * # Paramters
+ * - `fusion_pool`: The fusion_pool state
+ * - `position`: The position state
+ * - `tick_lower`: The lower tick state
+ * - `tick_upper`: The upper tick state
+ * - `transfer_fee_a`: The transfer fee for token A
+ * - `transfer_fee_b`: The transfer fee for token B
  *
  * # Returns
- * * `i32` - The tick index
+ * - `CollectFeesQuote`: The fees owed for token A and token B
  */
-export function priceToTickIndex(price: number, decimals_a: number, decimals_b: number): number;
+export function collectFeesQuote(fusion_pool: FusionPoolFacade, position: PositionFacade, tick_lower: TickFacade, tick_upper: TickFacade, transfer_fee_a?: TransferFee | null, transfer_fee_b?: TransferFee | null): CollectFeesQuote;
+export function limitOrderFee(fusion_pool: FusionPoolFacade): number;
 export function _TICK_ARRAY_NOT_EVENLY_SPACED(): string;
 export function _TICK_INDEX_OUT_OF_BOUNDS(): string;
 export function _INVALID_TICK_INDEX(): string;
@@ -593,6 +593,7 @@ 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 _INVALID_RANGE_BOUNDS(): string;
 export function _ZERO_TRADABLE_AMOUNT(): string;
 export function _INVALID_TIMESTAMP(): string;
 export function _INVALID_TRANSFER_FEE(): string;
@@ -734,20 +735,44 @@ export function _JUPITER_SWAP_INSTRUCTIONS_REQUEST_ERROR(): string;
  * Initialize Javascript logging and panic handler
  */
 export function solana_program_init(): void;
-export interface ExactOutSwapQuote {
-    tokenOut: bigint;
-    tokenEstIn: bigint;
-    tokenMaxIn: bigint;
-    tradeFee: bigint;
-    nextSqrtPrice: bigint;
+export interface LimitOrderDecreaseQuote {
+    amountOutA: bigint;
+    amountOutB: bigint;
+    rewardA: bigint;
+    rewardB: bigint;
 }
 
-export interface ExactInSwapQuote {
-    tokenIn: bigint;
-    tokenEstOut: bigint;
-    tokenMinOut: bigint;
-    tradeFee: bigint;
-    nextSqrtPrice: bigint;
+export interface LimitOrderFacade {
+    tickIndex: number;
+    amount: bigint;
+    aToB: boolean;
+    age: bigint;
+}
+
+export interface TransferFee {
+    feeBps: number;
+    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 FusionPoolFacade {
@@ -767,35 +792,11 @@ export interface FusionPoolFacade {
     olpFeeOwedB: bigint;
 }
 
-export interface CollectFeesQuote {
-    feeOwedA: bigint;
-    feeOwedB: bigint;
-}
-
 export interface TokenPair {
     a: bigint;
     b: bigint;
 }
 
-export interface LimitOrderDecreaseQuote {
-    amountOutA: bigint;
-    amountOutB: bigint;
-    rewardA: bigint;
-    rewardB: bigint;
-}
-
-export interface LimitOrderFacade {
-    tickIndex: number;
-    amount: bigint;
-    aToB: boolean;
-    age: bigint;
-}
-
-export interface TransferFee {
-    feeBps: number;
-    maxFee: bigint;
-}
-
 export interface PositionFacade {
     liquidity: bigint;
     tickLowerIndex: number;
@@ -813,20 +814,20 @@ export interface PositionRatio {
     ratioB: bigint;
 }
 
-export interface IncreaseLiquidityQuote {
-    liquidityDelta: bigint;
-    tokenEstA: bigint;
-    tokenEstB: bigint;
-    tokenMaxA: bigint;
-    tokenMaxB: bigint;
+export interface ExactOutSwapQuote {
+    tokenOut: bigint;
+    tokenEstIn: bigint;
+    tokenMaxIn: bigint;
+    tradeFee: bigint;
+    nextSqrtPrice: bigint;
 }
 
-export interface DecreaseLiquidityQuote {
-    liquidityDelta: bigint;
-    tokenEstA: bigint;
-    tokenEstB: bigint;
-    tokenMinA: bigint;
-    tokenMinB: bigint;
+export interface ExactInSwapQuote {
+    tokenIn: bigint;
+    tokenEstOut: bigint;
+    tokenMinOut: bigint;
+    tradeFee: bigint;
+    nextSqrtPrice: bigint;
 }
 
 export interface TickArrayFacade {