@gmsol-labs/gmsol-sdk 0.8.0 → 0.9.0-alpha.1

package/index.d.ts

@@ -20,6 +20,16 @@ export function close_orders(args: CloseOrderArgs): TransactionGroup;
  * Build transactions for updating orders.
  */
 export function update_orders(args: UpdateOrderArgs): TransactionGroup;
+export function create_deposits_builder(deposits: CreateDepositParamsJs[], options: CreateDepositOptions): CreateDepositsBuilder;
+export function create_deposits(deposits: CreateDepositParamsJs[], options: CreateDepositOptions): TransactionGroup;
+export function create_withdrawals_builder(withdrawals: CreateWithdrawalParamsJs[], options: CreateWithdrawalOptions): CreateWithdrawalsBuilder;
+export function create_withdrawals(withdrawals: CreateWithdrawalParamsJs[], options: CreateWithdrawalOptions): TransactionGroup;
+export function create_shifts_builder(shifts: CreateShiftParamsJs[], options: CreateShiftOptions): CreateShiftsBuilder;
+export function create_shifts(shifts: CreateShiftParamsJs[], options: CreateShiftOptions): TransactionGroup;
+export function create_glv_deposits_builder(deposits: CreateGlvDepositParamsJs[], options: CreateGlvDepositOptions): CreateGlvDepositsBuilder;
+export function create_glv_deposits(deposits: CreateGlvDepositParamsJs[], options: CreateGlvDepositOptions): TransactionGroup;
+export function create_glv_withdrawals_builder(withdrawals: CreateGlvWithdrawalParamsJs[], options: CreateGlvWithdrawalOptions): CreateGlvWithdrawalsBuilder;
+export function create_glv_withdrawals(withdrawals: CreateGlvWithdrawalParamsJs[], options: CreateGlvWithdrawalOptions): TransactionGroup;
 /**
  * Apply `factor` to the `value`.
  */
@@ -56,6 +66,16 @@ export interface MarketStatusParams {
     prices: Prices;
 }
 
+/**
+ * Params for calculating max sellable avlue.
+ */
+export interface MaxSellableValueParams {
+    /**
+     * Prices.
+     */
+    prices: Prices;
+}
+
 /**
  * Parameters for creating empty position model.
  */
@@ -165,6 +185,125 @@ export interface UpdateOrderArgs {
     transaction_group?: TransactionGroupOptions;
 }
 
+export interface CreateDepositParamsJs {
+    market_token: StringPubkey;
+    receiver?: StringPubkey | undefined;
+    long_pay_token?: StringPubkey | undefined;
+    short_pay_token?: StringPubkey | undefined;
+    long_swap_path?: StringPubkey[] | undefined;
+    short_swap_path?: StringPubkey[] | undefined;
+    long_pay_amount?: bigint | undefined;
+    short_pay_amount?: bigint | undefined;
+    min_receive_amount?: bigint | undefined;
+    skip_unwrap_native_on_receive?: boolean | undefined;
+}
+
+export interface CreateDepositOptions {
+    recent_blockhash: string;
+    payer: StringPubkey;
+    program?: StoreProgram | undefined;
+    compute_unit_price_micro_lamports?: number | undefined;
+    compute_unit_min_priority_lamports?: number | undefined;
+    hints: Map<StringPubkey, CreateDepositHint>;
+    transaction_group?: TransactionGroupOptions;
+    skip_wrap_native_on_pay?: boolean | undefined;
+}
+
+export interface CreateWithdrawalParamsJs {
+    market_token: StringPubkey;
+    receiver?: StringPubkey | undefined;
+    long_receive_token?: StringPubkey | undefined;
+    short_receive_token?: StringPubkey | undefined;
+    long_swap_path?: StringPubkey[] | undefined;
+    short_swap_path?: StringPubkey[] | undefined;
+    market_token_amount?: bigint | undefined;
+    min_long_receive_amount?: bigint | undefined;
+    min_short_receive_amount?: bigint | undefined;
+    skip_unwrap_native_on_receive?: boolean | undefined;
+}
+
+export interface CreateWithdrawalOptions {
+    recent_blockhash: string;
+    payer: StringPubkey;
+    program?: StoreProgram | undefined;
+    compute_unit_price_micro_lamports?: number | undefined;
+    compute_unit_min_priority_lamports?: number | undefined;
+    hints: Map<StringPubkey, CreateWithdrawalHint>;
+    transaction_group?: TransactionGroupOptions;
+}
+
+export interface CreateShiftParamsJs {
+    from_market_token: StringPubkey;
+    to_market_token: StringPubkey;
+    receiver?: StringPubkey | undefined;
+    from_market_token_amount?: bigint | undefined;
+    min_to_market_token_amount?: bigint | undefined;
+    skip_to_market_token_ata_creation?: boolean | undefined;
+}
+
+export interface CreateShiftOptions {
+    recent_blockhash: string;
+    payer: StringPubkey;
+    program?: StoreProgram | undefined;
+    compute_unit_price_micro_lamports?: number | undefined;
+    compute_unit_min_priority_lamports?: number | undefined;
+    transaction_group?: TransactionGroupOptions;
+}
+
+export interface CreateGlvDepositParamsJs {
+    glv_token: StringPubkey;
+    market_token: StringPubkey;
+    receiver?: StringPubkey | undefined;
+    long_pay_token?: StringPubkey | undefined;
+    short_pay_token?: StringPubkey | undefined;
+    long_swap_path?: StringPubkey[] | undefined;
+    short_swap_path?: StringPubkey[] | undefined;
+    long_pay_amount?: bigint | undefined;
+    short_pay_amount?: bigint | undefined;
+    market_token_amount?: bigint | undefined;
+    min_market_token_amount?: bigint | undefined;
+    min_receive_amount?: bigint | undefined;
+    skip_unwrap_native_on_receive?: boolean | undefined;
+    skip_glv_token_ata_creation?: boolean | undefined;
+}
+
+export interface CreateGlvDepositOptions {
+    recent_blockhash: string;
+    payer: StringPubkey;
+    program?: StoreProgram | undefined;
+    compute_unit_price_micro_lamports?: number | undefined;
+    compute_unit_min_priority_lamports?: number | undefined;
+    hints: Map<StringPubkey, CreateGlvDepositHint>;
+    transaction_group?: TransactionGroupOptions;
+    skip_wrap_native_on_pay?: boolean | undefined;
+}
+
+export interface CreateGlvWithdrawalParamsJs {
+    glv_token: StringPubkey;
+    market_token: StringPubkey;
+    receiver?: StringPubkey | undefined;
+    long_receive_token?: StringPubkey | undefined;
+    short_receive_token?: StringPubkey | undefined;
+    long_swap_path?: StringPubkey[] | undefined;
+    short_swap_path?: StringPubkey[] | undefined;
+    glv_token_amount?: bigint | undefined;
+    min_long_receive_amount?: bigint | undefined;
+    min_short_receive_amount?: bigint | undefined;
+    skip_unwrap_native_on_receive?: boolean | undefined;
+    skip_long_receive_token_ata_creation?: boolean | undefined;
+    skip_short_receive_token_ata_creation?: boolean | undefined;
+}
+
+export interface CreateGlvWithdrawalOptions {
+    recent_blockhash: string;
+    payer: StringPubkey;
+    program?: StoreProgram | undefined;
+    compute_unit_price_micro_lamports?: number | undefined;
+    compute_unit_min_priority_lamports?: number | undefined;
+    hints: Map<StringPubkey, CreateGlvWithdrawalHint>;
+    transaction_group?: TransactionGroupOptions;
+}
+
 /**
  * A JS version transaction group options.
  */
@@ -189,6 +328,27 @@ export interface BuildTransactionOptions {
     compute_unit_min_priority_lamports?: number | undefined;
 }
 
+/**
+ * Arguments for deposit simulation.
+ */
+export interface SimulateDepositArgs {
+    params: CreateDepositParamsJs;
+}
+
+/**
+ * Arguments for GLV deposit simulation.
+ */
+export interface SimulateGlvDepositArgs {
+    params: CreateGlvDepositParamsJs;
+}
+
+/**
+ * Arguments for GLV withdrawal simulation.
+ */
+export interface SimulateGlvWithdrawalArgs {
+    params: CreateGlvWithdrawalParamsJs;
+}
+
 /**
  * Arguments for order simulation.
  */
@@ -233,6 +393,36 @@ export interface SwapOrderSimulationOutput {
     report: string[];
 }
 
+/**
+ * Arguments for shift simulation.
+ */
+export interface SimulateShiftArgs {
+    params: CreateShiftParamsJs;
+}
+
+/**
+ * Arguments for GLV status calculations.
+ */
+export interface GetGlvStatusArgs {
+    glv_token: StringPubkey;
+}
+
+/**
+ * Arguments for GLV status calculations.
+ */
+export interface GetGlvTokenValueArgs {
+    glv_token: StringPubkey;
+    amount: bigint;
+    maximize: boolean;
+}
+
+/**
+ * Arguments for withdrawal simulation.
+ */
+export interface SimulateWithdrawalArgs {
+    params: CreateWithdrawalParamsJs;
+}
+
 
 /**
  * A Base58-encoded string representing a public key.
@@ -306,6 +496,20 @@ export interface Prices {
     short_token: Value;
 }
 
+/**
+ * GLV Status.
+ */
+export interface GlvStatus {
+    /**
+     * The estimated max sellable value in the GLV.
+     */
+    max_sellable_value: bigint;
+    /**
+     * The estimated total GLV value.
+     */
+    total_value: Value;
+}
+
 /**
  * Position Status.
  */
@@ -1409,6 +1613,21 @@ export interface StoreProgram {
  */
 export type PnlFactorKind = "max_after_deposit" | "max_after_withdrawal" | "max_for_trader" | "for_adl" | "min_after_adl";
 
+export class CreateDepositsBuilder {
+  private constructor();
+  free(): void;
+  build_with_options(transaction_group?: TransactionGroupOptions | null, build?: BuildTransactionOptions | null): TransactionGroup;
+}
+export class CreateGlvDepositsBuilder {
+  private constructor();
+  free(): void;
+  build_with_options(transaction_group?: TransactionGroupOptions | null, build?: BuildTransactionOptions | null): TransactionGroup;
+}
+export class CreateGlvWithdrawalsBuilder {
+  private constructor();
+  free(): void;
+  build_with_options(transaction_group?: TransactionGroupOptions | null, build?: BuildTransactionOptions | null): TransactionGroup;
+}
 /**
  * Builder for create-order ixs.
  */
@@ -1424,6 +1643,35 @@ export class CreateOrdersBuilder {
    */
   merge(other: CreateOrdersBuilder): void;
 }
+export class CreateShiftsBuilder {
+  private constructor();
+  free(): void;
+  build_with_options(transaction_group?: TransactionGroupOptions | null, build?: BuildTransactionOptions | null): TransactionGroup;
+}
+export class CreateWithdrawalsBuilder {
+  private constructor();
+  free(): void;
+  build_with_options(transaction_group?: TransactionGroupOptions | null, build?: BuildTransactionOptions | null): TransactionGroup;
+}
+/**
+ * Simulation output for deposit.
+ */
+export class DepositSimulationOutput {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the deposit report.
+   */
+  report(): string;
+  /**
+   * Returns swap reports for the long token path.
+   */
+  long_swaps(): string[];
+  /**
+   * Returns swap reports for the short token path.
+   */
+  short_swaps(): string[];
+}
 /**
  * A (twisted) ElGamal encryption keypair.
  *
@@ -1447,6 +1695,118 @@ export class ElGamalPubkey {
   private constructor();
   free(): void;
 }
+/**
+ * Wrapper of [`Glv`].
+ */
+export class Glv {
+  private constructor();
+  free(): void;
+  /**
+   * Create from base64 encoded account data with options.
+   */
+  static decode_from_base64_with_options(data: string, no_discriminator?: boolean | null): Glv;
+  /**
+   * Create from base64 encoded account data with options.
+   */
+  static decode_with_options(data: Uint8Array, no_discriminator?: boolean | null): Glv;
+  /**
+   * Convert into [`JsGlvModel`].
+   */
+  to_model(supply: bigint): GlvModel;
+  /**
+   * Returns GLV token address.
+   */
+  glv_token_address(): string;
+  /**
+   * Returns long token address.
+   */
+  long_token_address(): string;
+  /**
+   * Returns short token address.
+   */
+  short_token_address(): string;
+  /**
+   * Create a clone of this market.
+   */
+  clone(): Glv;
+}
+/**
+ * Simulation output for GLV deposit.
+ */
+export class GlvDepositSimulationOutput {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the deposit report.
+   */
+  deposit_report(): string | undefined;
+  /**
+   * Returns swap reports for the long token path.
+   */
+  long_swaps(): string[];
+  /**
+   * Returns swap reports for the short token path.
+   */
+  short_swaps(): string[];
+  /**
+   * Returns the output GLV token amount.
+   */
+  output_amount(): bigint;
+}
+/**
+ * Wrapper of [`GlvModel`].
+ */
+export class GlvModel {
+  private constructor();
+  free(): void;
+  /**
+   * Returns current supply.
+   */
+  supply(): bigint;
+  /**
+   * Returns GLV token address.
+   */
+  glv_token_address(): string;
+  /**
+   * Returns long token address.
+   */
+  long_token_address(): string;
+  /**
+   * Returns short token address.
+   */
+  short_token_address(): string;
+  /**
+   * Create a clone of this market model.
+   */
+  clone(): GlvModel;
+}
+/**
+ * Simulation output for withdrawal.
+ */
+export class GlvWithdrawalSimulationOutput {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the withdraw report.
+   */
+  withdraw_report(): string;
+  /**
+   * Returns swap reports for the long token path.
+   */
+  long_swaps(): string[];
+  /**
+   * Returns swap reports for the short token path.
+   */
+  short_swaps(): string[];
+  /**
+   * Returns long token output amount.
+   */
+  long_output_amount(): bigint;
+  /**
+   * Returns short token output amount.
+   */
+  short_output_amount(): bigint;
+}
 /**
  * A hash; the 32-byte output of a hashing algorithm.
  *
@@ -1628,10 +1988,18 @@ export class MarketModel {
    * Get market token price.
    */
   market_token_price(params: MarketTokenPriceParams): bigint;
+  /**
+   * Calculates max sellable value.
+   */
+  max_sellable_value(params: MaxSellableValueParams): bigint;
   /**
    * Get market status.
    */
   status(params: MarketStatusParams): MarketStatus;
+  /**
+   * Returns current supply.
+   */
+  supply(): bigint;
   /**
    * Create an empty position model.
    */
@@ -1821,6 +2189,21 @@ export class Pubkey {
    */
   static findProgramAddress(seeds: any[], program_id: Pubkey): any;
 }
+/**
+ * Simulation output for shift.
+ */
+export class ShiftSimulationOutput {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the deposit report.
+   */
+  deposit_report(): string;
+  /**
+   * Returns the withdraw report.
+   */
+  withdraw_report(): string;
+}
 /**
  * A JS binding for [`Simulator`].
  */
@@ -1835,15 +2218,54 @@ export class Simulator {
    * Get price for the given token.
    */
   get_price(token: string): Value | undefined;
+  /**
+   * Get GLV by its GLV token.
+   */
+  get_glv(glv_token: string): GlvModel | undefined;
   /**
    * Upsert the prices for the given token.
    */
   insert_price(token: string, price: Value): void;
+  /**
+   * Upsert a GLV model.
+   */
+  insert_glv(glv: GlvModel): void;
+  /**
+   * Simulate an order execution.
+   */
   simulate_order(args: SimulateOrderArgs, position?: Position | null): OrderSimulationOutput;
+  /**
+   * Simulate a deposit execution.
+   */
+  simulate_deposit(args: SimulateDepositArgs): DepositSimulationOutput;
+  /**
+   * Simulate a withdrawal execution.
+   */
+  simulate_withdrawal(args: SimulateWithdrawalArgs): WithdrawalSimulationOutput;
+  /**
+   * Simulate a shift execution.
+   */
+  simulate_shift(args: SimulateShiftArgs): ShiftSimulationOutput;
+  /**
+   * Simulate a GLV deposit execution.
+   */
+  simulate_glv_deposit(args: SimulateGlvDepositArgs): GlvDepositSimulationOutput;
+  /**
+   * Simulate a GLV withdrawal execution.
+   */
+  simulate_glv_withdrawal(args: SimulateGlvWithdrawalArgs): GlvWithdrawalSimulationOutput;
   /**
    * Create a clone of this simulator.
    */
   clone(): Simulator;
+  /**
+   * Calculates GLV status.
+   */
+  get_glv_status(args: GetGlvStatusArgs): GlvStatus;
+  /**
+   * Calculates GLV token value.
+   */
+  get_glv_token_value(args: GetGlvTokenValueArgs): bigint;
 }
 /**
  * JS version of [`TradeEvent`].
@@ -1958,3 +2380,30 @@ export class User {
    */
   gt_minted_fee_value(): bigint;
 }
+/**
+ * Simulation output for withdrawal.
+ */
+export class WithdrawalSimulationOutput {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the withdraw report.
+   */
+  report(): string;
+  /**
+   * Returns swap reports for the long token path.
+   */
+  long_swaps(): string[];
+  /**
+   * Returns swap reports for the short token path.
+   */
+  short_swaps(): string[];
+  /**
+   * Returns long token output amount.
+   */
+  long_output_amount(): bigint;
+  /**
+   * Returns short token output amount.
+   */
+  short_output_amount(): bigint;
+}