@kamino-finance/klend-sdk 7.1.2 → 7.1.4-beta.0

package/src/@codegen/klend/accounts/WithdrawTicket.ts

@@ -0,0 +1,256 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  address,
+  Address,
+  fetchEncodedAccount,
+  fetchEncodedAccounts,
+  GetAccountInfoApi,
+  GetMultipleAccountsApi,
+  Rpc,
+} from "@solana/kit"
+/* eslint-enable @typescript-eslint/no-unused-vars */
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { borshAddress } from "../utils" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface WithdrawTicketFields {
+  /** This ticket's place in the queue; the same as used for PDA derivation. */
+  sequenceNumber: BN
+  /** The funds' owner (the user who called the `enqueue_to_withdraw` handler). */
+  owner: Address
+  /** The reserve to withdraw from. */
+  reserve: Address
+  /**
+   * The token account to which the finally-available liquidity should be transferred (by the
+   * `withdraw_queued_liquidity` handler).
+   */
+  userDestinationLiquidityTa: Address
+  /** The amount of collateral still waiting to be withdrawn using this ticket. */
+  queuedCollateralAmount: BN
+  /**
+   * The timestamp at which the queue was entered.
+   *
+   * This is currently only a piece of metadata, not used by the logic.
+   */
+  createdAtTimestamp: BN
+  /**
+   * Whether the ticket has been found to be invalid (e.g. the [Self::user_destination_liquidity]
+   * has been repurposed) by the `withdraw_queued_liquidity` handler.
+   * To be specific: valid = `0`, invalid = `1`.
+   *
+   * An invalid ticket cannot be made valid again, and can only be passed to the
+   * `recover_invalid_ticket_collateral` handler.
+   */
+  invalid: number
+  /** Inner padding, for alignment. */
+  alignmentPadding: Array<number>
+  /** Trailing padding, for future developments. */
+  endPadding: Array<BN>
+}
+
+export interface WithdrawTicketJSON {
+  /** This ticket's place in the queue; the same as used for PDA derivation. */
+  sequenceNumber: string
+  /** The funds' owner (the user who called the `enqueue_to_withdraw` handler). */
+  owner: string
+  /** The reserve to withdraw from. */
+  reserve: string
+  /**
+   * The token account to which the finally-available liquidity should be transferred (by the
+   * `withdraw_queued_liquidity` handler).
+   */
+  userDestinationLiquidityTa: string
+  /** The amount of collateral still waiting to be withdrawn using this ticket. */
+  queuedCollateralAmount: string
+  /**
+   * The timestamp at which the queue was entered.
+   *
+   * This is currently only a piece of metadata, not used by the logic.
+   */
+  createdAtTimestamp: string
+  /**
+   * Whether the ticket has been found to be invalid (e.g. the [Self::user_destination_liquidity]
+   * has been repurposed) by the `withdraw_queued_liquidity` handler.
+   * To be specific: valid = `0`, invalid = `1`.
+   *
+   * An invalid ticket cannot be made valid again, and can only be passed to the
+   * `recover_invalid_ticket_collateral` handler.
+   */
+  invalid: number
+  /** Inner padding, for alignment. */
+  alignmentPadding: Array<number>
+  /** Trailing padding, for future developments. */
+  endPadding: Array<string>
+}
+
+/**
+ * A finite-lifecycle account representing a specific depositor's place in the withdraw queue of
+ * a specific reserve.
+ *
+ * The lifecycle:
+ * 1. The depositor holding ctokens wants to withdraw funds from the reserve, and finds out that
+ * the required amount is not available (due to high utilization).
+ * 2. The depositor calls the `enqueue_to_withdraw` handler.
+ * 3. The handler transfers the depositor's ctokens to the reserve's internal "pending" vault.
+ * 4. The handler initializes a new [WithdrawTicket] account, with the next available sequence
+ * number.
+ * 5. The depositor waits until his ticket is the next expected one for actual withdraw, and until
+ * the reserve has enough liquidity.
+ * 6. Anyone (the depositor or a bot) calls the permissionless `withdraw_queued_liquidity`
+ * handler. If the ticket became invalid (e.g. destination account no longer exists), then the
+ * depositor can call the `recover_invalid_ticket_collateral` handler instead.
+ * 7. The handler transfers the liquidity amount according to the current exchange rate.
+ * 8. The handler closes the ticket account.
+ */
+export class WithdrawTicket {
+  /** This ticket's place in the queue; the same as used for PDA derivation. */
+  readonly sequenceNumber: BN
+  /** The funds' owner (the user who called the `enqueue_to_withdraw` handler). */
+  readonly owner: Address
+  /** The reserve to withdraw from. */
+  readonly reserve: Address
+  /**
+   * The token account to which the finally-available liquidity should be transferred (by the
+   * `withdraw_queued_liquidity` handler).
+   */
+  readonly userDestinationLiquidityTa: Address
+  /** The amount of collateral still waiting to be withdrawn using this ticket. */
+  readonly queuedCollateralAmount: BN
+  /**
+   * The timestamp at which the queue was entered.
+   *
+   * This is currently only a piece of metadata, not used by the logic.
+   */
+  readonly createdAtTimestamp: BN
+  /**
+   * Whether the ticket has been found to be invalid (e.g. the [Self::user_destination_liquidity]
+   * has been repurposed) by the `withdraw_queued_liquidity` handler.
+   * To be specific: valid = `0`, invalid = `1`.
+   *
+   * An invalid ticket cannot be made valid again, and can only be passed to the
+   * `recover_invalid_ticket_collateral` handler.
+   */
+  readonly invalid: number
+  /** Inner padding, for alignment. */
+  readonly alignmentPadding: Array<number>
+  /** Trailing padding, for future developments. */
+  readonly endPadding: Array<BN>
+
+  static readonly discriminator = Buffer.from([
+    237, 23, 164, 58, 53, 248, 240, 94,
+  ])
+
+  static readonly layout = borsh.struct<WithdrawTicket>([
+    borsh.u64("sequenceNumber"),
+    borshAddress("owner"),
+    borshAddress("reserve"),
+    borshAddress("userDestinationLiquidityTa"),
+    borsh.u64("queuedCollateralAmount"),
+    borsh.u64("createdAtTimestamp"),
+    borsh.u8("invalid"),
+    borsh.array(borsh.u8(), 7, "alignmentPadding"),
+    borsh.array(borsh.u64(), 48, "endPadding"),
+  ])
+
+  constructor(fields: WithdrawTicketFields) {
+    this.sequenceNumber = fields.sequenceNumber
+    this.owner = fields.owner
+    this.reserve = fields.reserve
+    this.userDestinationLiquidityTa = fields.userDestinationLiquidityTa
+    this.queuedCollateralAmount = fields.queuedCollateralAmount
+    this.createdAtTimestamp = fields.createdAtTimestamp
+    this.invalid = fields.invalid
+    this.alignmentPadding = fields.alignmentPadding
+    this.endPadding = fields.endPadding
+  }
+
+  static async fetch(
+    rpc: Rpc<GetAccountInfoApi>,
+    address: Address,
+    programId: Address = PROGRAM_ID
+  ): Promise<WithdrawTicket | null> {
+    const info = await fetchEncodedAccount(rpc, address)
+
+    if (!info.exists) {
+      return null
+    }
+    if (info.programAddress !== programId) {
+      throw new Error(
+        `WithdrawTicketFields account ${address} belongs to wrong program ${info.programAddress}, expected ${programId}`
+      )
+    }
+
+    return this.decode(Buffer.from(info.data))
+  }
+
+  static async fetchMultiple(
+    rpc: Rpc<GetMultipleAccountsApi>,
+    addresses: Address[],
+    programId: Address = PROGRAM_ID
+  ): Promise<Array<WithdrawTicket | null>> {
+    const infos = await fetchEncodedAccounts(rpc, addresses)
+
+    return infos.map((info) => {
+      if (!info.exists) {
+        return null
+      }
+      if (info.programAddress !== programId) {
+        throw new Error(
+          `WithdrawTicketFields account ${info.address} belongs to wrong program ${info.programAddress}, expected ${programId}`
+        )
+      }
+
+      return this.decode(Buffer.from(info.data))
+    })
+  }
+
+  static decode(data: Buffer): WithdrawTicket {
+    if (!data.slice(0, 8).equals(WithdrawTicket.discriminator)) {
+      throw new Error("invalid account discriminator")
+    }
+
+    const dec = WithdrawTicket.layout.decode(data.slice(8))
+
+    return new WithdrawTicket({
+      sequenceNumber: dec.sequenceNumber,
+      owner: dec.owner,
+      reserve: dec.reserve,
+      userDestinationLiquidityTa: dec.userDestinationLiquidityTa,
+      queuedCollateralAmount: dec.queuedCollateralAmount,
+      createdAtTimestamp: dec.createdAtTimestamp,
+      invalid: dec.invalid,
+      alignmentPadding: dec.alignmentPadding,
+      endPadding: dec.endPadding,
+    })
+  }
+
+  toJSON(): WithdrawTicketJSON {
+    return {
+      sequenceNumber: this.sequenceNumber.toString(),
+      owner: this.owner,
+      reserve: this.reserve,
+      userDestinationLiquidityTa: this.userDestinationLiquidityTa,
+      queuedCollateralAmount: this.queuedCollateralAmount.toString(),
+      createdAtTimestamp: this.createdAtTimestamp.toString(),
+      invalid: this.invalid,
+      alignmentPadding: this.alignmentPadding,
+      endPadding: this.endPadding.map((item) => item.toString()),
+    }
+  }
+
+  static fromJSON(obj: WithdrawTicketJSON): WithdrawTicket {
+    return new WithdrawTicket({
+      sequenceNumber: new BN(obj.sequenceNumber),
+      owner: address(obj.owner),
+      reserve: address(obj.reserve),
+      userDestinationLiquidityTa: address(obj.userDestinationLiquidityTa),
+      queuedCollateralAmount: new BN(obj.queuedCollateralAmount),
+      createdAtTimestamp: new BN(obj.createdAtTimestamp),
+      invalid: obj.invalid,
+      alignmentPadding: obj.alignmentPadding,
+      endPadding: obj.endPadding.map((item) => new BN(item)),
+    })
+  }
+}

package/src/@codegen/klend/accounts/index.ts

@@ -19,3 +19,9 @@ export { UserMetadata } from "./UserMetadata"
 export type { UserMetadataFields, UserMetadataJSON } from "./UserMetadata"
 export { Reserve } from "./Reserve"
 export type { ReserveFields, ReserveJSON } from "./Reserve"
+export { WithdrawTicket } from "./WithdrawTicket"
+export type { WithdrawTicketFields, WithdrawTicketJSON } from "./WithdrawTicket"
+export { PoolState } from "./PoolState"
+export type { PoolStateFields, PoolStateJSON } from "./PoolState"
+export { UnstakeTicket } from "./UnstakeTicket"
+export type { UnstakeTicketFields, UnstakeTicketJSON } from "./UnstakeTicket"