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

package/src/@codegen/klend/types/BorrowOrder.ts

@@ -0,0 +1,267 @@
+import { address, Address } from "@solana/kit" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh"
+import { borshAddress } from "../utils"
+
+export interface BorrowOrderFields {
+  /**
+   * The asset to be borrowed.
+   * The reserves used for [Obligation::borrows] *must* all provide exactly this asset.
+   */
+  debtLiquidityMint: Address
+  /** The amount of debt that still needs to be filled, in lamports. */
+  remainingDebtAmount: BN
+  /**
+   * The token account owned by the [Obligation::owner] and holding [Self::debt_liquidity_mint],
+   * where the filled funds should be transferred to.
+   */
+  filledDebtDestination: Address
+  /**
+   * The minimum allowed debt term that the obligation owner agrees to.
+   * The reserves used to fill this order *cannot* define their debt term *lower* than this.
+   *
+   * If zeroed, then only indefinite-term reserves may be used.
+   */
+  minDebtTermSeconds: BN
+  /** The time until which the borrow order can still be filled. */
+  fillableUntilTimestamp: BN
+  /**
+   * The time at which this order was placed.
+   * Currently, this is only a piece of metadata.
+   */
+  placedAtTimestamp: BN
+  /**
+   * The time at which this order was most-recently updated (including: created).
+   * Currently, this is only a piece of metadata.
+   */
+  lastUpdatedAtTimestamp: BN
+  /**
+   * The amount of debt that was originally requested when this order was most-recently updated.
+   * In other words: this field holds a value of [Self::remaining_debt_amount] captured at
+   * [Self::last_updated_at_timestamp].
+   * Currently, this is only a piece of metadata.
+   */
+  requestedDebtAmount: BN
+  /**
+   * The maximum borrow rate that the obligation owner agrees to.
+   * The reserves used for [Obligation::borrows] *cannot* define their maximum borrow rate
+   * *higher* than this.
+   */
+  maxBorrowRateBps: number
+  /** Alignment padding. */
+  padding1: Array<number>
+  /** End padding. */
+  endPadding: Array<BN>
+}
+
+export interface BorrowOrderJSON {
+  /**
+   * The asset to be borrowed.
+   * The reserves used for [Obligation::borrows] *must* all provide exactly this asset.
+   */
+  debtLiquidityMint: string
+  /** The amount of debt that still needs to be filled, in lamports. */
+  remainingDebtAmount: string
+  /**
+   * The token account owned by the [Obligation::owner] and holding [Self::debt_liquidity_mint],
+   * where the filled funds should be transferred to.
+   */
+  filledDebtDestination: string
+  /**
+   * The minimum allowed debt term that the obligation owner agrees to.
+   * The reserves used to fill this order *cannot* define their debt term *lower* than this.
+   *
+   * If zeroed, then only indefinite-term reserves may be used.
+   */
+  minDebtTermSeconds: string
+  /** The time until which the borrow order can still be filled. */
+  fillableUntilTimestamp: string
+  /**
+   * The time at which this order was placed.
+   * Currently, this is only a piece of metadata.
+   */
+  placedAtTimestamp: string
+  /**
+   * The time at which this order was most-recently updated (including: created).
+   * Currently, this is only a piece of metadata.
+   */
+  lastUpdatedAtTimestamp: string
+  /**
+   * The amount of debt that was originally requested when this order was most-recently updated.
+   * In other words: this field holds a value of [Self::remaining_debt_amount] captured at
+   * [Self::last_updated_at_timestamp].
+   * Currently, this is only a piece of metadata.
+   */
+  requestedDebtAmount: string
+  /**
+   * The maximum borrow rate that the obligation owner agrees to.
+   * The reserves used for [Obligation::borrows] *cannot* define their maximum borrow rate
+   * *higher* than this.
+   */
+  maxBorrowRateBps: number
+  /** Alignment padding. */
+  padding1: Array<number>
+  /** End padding. */
+  endPadding: Array<string>
+}
+
+/**
+ * A borrow order.
+ *
+ * When the [Obligation::borrow_order] is populated (i.e. non-zeroed) on an Obligation, then the
+ * permissionless "fill" operations may borrow liquidity to the owner according to this
+ * specification.
+ */
+export class BorrowOrder {
+  /**
+   * The asset to be borrowed.
+   * The reserves used for [Obligation::borrows] *must* all provide exactly this asset.
+   */
+  readonly debtLiquidityMint: Address
+  /** The amount of debt that still needs to be filled, in lamports. */
+  readonly remainingDebtAmount: BN
+  /**
+   * The token account owned by the [Obligation::owner] and holding [Self::debt_liquidity_mint],
+   * where the filled funds should be transferred to.
+   */
+  readonly filledDebtDestination: Address
+  /**
+   * The minimum allowed debt term that the obligation owner agrees to.
+   * The reserves used to fill this order *cannot* define their debt term *lower* than this.
+   *
+   * If zeroed, then only indefinite-term reserves may be used.
+   */
+  readonly minDebtTermSeconds: BN
+  /** The time until which the borrow order can still be filled. */
+  readonly fillableUntilTimestamp: BN
+  /**
+   * The time at which this order was placed.
+   * Currently, this is only a piece of metadata.
+   */
+  readonly placedAtTimestamp: BN
+  /**
+   * The time at which this order was most-recently updated (including: created).
+   * Currently, this is only a piece of metadata.
+   */
+  readonly lastUpdatedAtTimestamp: BN
+  /**
+   * The amount of debt that was originally requested when this order was most-recently updated.
+   * In other words: this field holds a value of [Self::remaining_debt_amount] captured at
+   * [Self::last_updated_at_timestamp].
+   * Currently, this is only a piece of metadata.
+   */
+  readonly requestedDebtAmount: BN
+  /**
+   * The maximum borrow rate that the obligation owner agrees to.
+   * The reserves used for [Obligation::borrows] *cannot* define their maximum borrow rate
+   * *higher* than this.
+   */
+  readonly maxBorrowRateBps: number
+  /** Alignment padding. */
+  readonly padding1: Array<number>
+  /** End padding. */
+  readonly endPadding: Array<BN>
+
+  constructor(fields: BorrowOrderFields) {
+    this.debtLiquidityMint = fields.debtLiquidityMint
+    this.remainingDebtAmount = fields.remainingDebtAmount
+    this.filledDebtDestination = fields.filledDebtDestination
+    this.minDebtTermSeconds = fields.minDebtTermSeconds
+    this.fillableUntilTimestamp = fields.fillableUntilTimestamp
+    this.placedAtTimestamp = fields.placedAtTimestamp
+    this.lastUpdatedAtTimestamp = fields.lastUpdatedAtTimestamp
+    this.requestedDebtAmount = fields.requestedDebtAmount
+    this.maxBorrowRateBps = fields.maxBorrowRateBps
+    this.padding1 = fields.padding1
+    this.endPadding = fields.endPadding
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borshAddress("debtLiquidityMint"),
+        borsh.u64("remainingDebtAmount"),
+        borshAddress("filledDebtDestination"),
+        borsh.u64("minDebtTermSeconds"),
+        borsh.u64("fillableUntilTimestamp"),
+        borsh.u64("placedAtTimestamp"),
+        borsh.u64("lastUpdatedAtTimestamp"),
+        borsh.u64("requestedDebtAmount"),
+        borsh.u32("maxBorrowRateBps"),
+        borsh.array(borsh.u8(), 4, "padding1"),
+        borsh.array(borsh.u64(), 5, "endPadding"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new BorrowOrder({
+      debtLiquidityMint: obj.debtLiquidityMint,
+      remainingDebtAmount: obj.remainingDebtAmount,
+      filledDebtDestination: obj.filledDebtDestination,
+      minDebtTermSeconds: obj.minDebtTermSeconds,
+      fillableUntilTimestamp: obj.fillableUntilTimestamp,
+      placedAtTimestamp: obj.placedAtTimestamp,
+      lastUpdatedAtTimestamp: obj.lastUpdatedAtTimestamp,
+      requestedDebtAmount: obj.requestedDebtAmount,
+      maxBorrowRateBps: obj.maxBorrowRateBps,
+      padding1: obj.padding1,
+      endPadding: obj.endPadding,
+    })
+  }
+
+  static toEncodable(fields: BorrowOrderFields) {
+    return {
+      debtLiquidityMint: fields.debtLiquidityMint,
+      remainingDebtAmount: fields.remainingDebtAmount,
+      filledDebtDestination: fields.filledDebtDestination,
+      minDebtTermSeconds: fields.minDebtTermSeconds,
+      fillableUntilTimestamp: fields.fillableUntilTimestamp,
+      placedAtTimestamp: fields.placedAtTimestamp,
+      lastUpdatedAtTimestamp: fields.lastUpdatedAtTimestamp,
+      requestedDebtAmount: fields.requestedDebtAmount,
+      maxBorrowRateBps: fields.maxBorrowRateBps,
+      padding1: fields.padding1,
+      endPadding: fields.endPadding,
+    }
+  }
+
+  toJSON(): BorrowOrderJSON {
+    return {
+      debtLiquidityMint: this.debtLiquidityMint,
+      remainingDebtAmount: this.remainingDebtAmount.toString(),
+      filledDebtDestination: this.filledDebtDestination,
+      minDebtTermSeconds: this.minDebtTermSeconds.toString(),
+      fillableUntilTimestamp: this.fillableUntilTimestamp.toString(),
+      placedAtTimestamp: this.placedAtTimestamp.toString(),
+      lastUpdatedAtTimestamp: this.lastUpdatedAtTimestamp.toString(),
+      requestedDebtAmount: this.requestedDebtAmount.toString(),
+      maxBorrowRateBps: this.maxBorrowRateBps,
+      padding1: this.padding1,
+      endPadding: this.endPadding.map((item) => item.toString()),
+    }
+  }
+
+  static fromJSON(obj: BorrowOrderJSON): BorrowOrder {
+    return new BorrowOrder({
+      debtLiquidityMint: address(obj.debtLiquidityMint),
+      remainingDebtAmount: new BN(obj.remainingDebtAmount),
+      filledDebtDestination: address(obj.filledDebtDestination),
+      minDebtTermSeconds: new BN(obj.minDebtTermSeconds),
+      fillableUntilTimestamp: new BN(obj.fillableUntilTimestamp),
+      placedAtTimestamp: new BN(obj.placedAtTimestamp),
+      lastUpdatedAtTimestamp: new BN(obj.lastUpdatedAtTimestamp),
+      requestedDebtAmount: new BN(obj.requestedDebtAmount),
+      maxBorrowRateBps: obj.maxBorrowRateBps,
+      padding1: obj.padding1,
+      endPadding: obj.endPadding.map((item) => new BN(item)),
+    })
+  }
+
+  toEncodable() {
+    return BorrowOrder.toEncodable(this)
+  }
+}

package/src/@codegen/klend/types/BorrowOrderConfigArgs.ts

@@ -0,0 +1,87 @@
+import { address, Address } from "@solana/kit" // eslint-disable-line @typescript-eslint/no-unused-vars
+import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import * as borsh from "@coral-xyz/borsh"
+import { borshAddress } from "../utils"
+
+export interface BorrowOrderConfigArgsFields {
+  remainingDebtAmount: BN
+  maxBorrowRateBps: number
+  minDebtTermSeconds: BN
+  fillableUntilTimestamp: BN
+}
+
+export interface BorrowOrderConfigArgsJSON {
+  remainingDebtAmount: string
+  maxBorrowRateBps: number
+  minDebtTermSeconds: string
+  fillableUntilTimestamp: string
+}
+
+/** A subset of [BorrowOrderConfig] excluding the accounts passed via [SetBorrowOrder]. */
+export class BorrowOrderConfigArgs {
+  readonly remainingDebtAmount: BN
+  readonly maxBorrowRateBps: number
+  readonly minDebtTermSeconds: BN
+  readonly fillableUntilTimestamp: BN
+
+  constructor(fields: BorrowOrderConfigArgsFields) {
+    this.remainingDebtAmount = fields.remainingDebtAmount
+    this.maxBorrowRateBps = fields.maxBorrowRateBps
+    this.minDebtTermSeconds = fields.minDebtTermSeconds
+    this.fillableUntilTimestamp = fields.fillableUntilTimestamp
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borsh.u64("remainingDebtAmount"),
+        borsh.u32("maxBorrowRateBps"),
+        borsh.u64("minDebtTermSeconds"),
+        borsh.u64("fillableUntilTimestamp"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new BorrowOrderConfigArgs({
+      remainingDebtAmount: obj.remainingDebtAmount,
+      maxBorrowRateBps: obj.maxBorrowRateBps,
+      minDebtTermSeconds: obj.minDebtTermSeconds,
+      fillableUntilTimestamp: obj.fillableUntilTimestamp,
+    })
+  }
+
+  static toEncodable(fields: BorrowOrderConfigArgsFields) {
+    return {
+      remainingDebtAmount: fields.remainingDebtAmount,
+      maxBorrowRateBps: fields.maxBorrowRateBps,
+      minDebtTermSeconds: fields.minDebtTermSeconds,
+      fillableUntilTimestamp: fields.fillableUntilTimestamp,
+    }
+  }
+
+  toJSON(): BorrowOrderConfigArgsJSON {
+    return {
+      remainingDebtAmount: this.remainingDebtAmount.toString(),
+      maxBorrowRateBps: this.maxBorrowRateBps,
+      minDebtTermSeconds: this.minDebtTermSeconds.toString(),
+      fillableUntilTimestamp: this.fillableUntilTimestamp.toString(),
+    }
+  }
+
+  static fromJSON(obj: BorrowOrderConfigArgsJSON): BorrowOrderConfigArgs {
+    return new BorrowOrderConfigArgs({
+      remainingDebtAmount: new BN(obj.remainingDebtAmount),
+      maxBorrowRateBps: obj.maxBorrowRateBps,
+      minDebtTermSeconds: new BN(obj.minDebtTermSeconds),
+      fillableUntilTimestamp: new BN(obj.fillableUntilTimestamp),
+    })
+  }
+
+  toEncodable() {
+    return BorrowOrderConfigArgs.toEncodable(this)
+  }
+}

package/src/@codegen/klend/types/ObligationLiquidity.ts

@@ -9,7 +9,17 @@ export interface ObligationLiquidityFields {
   borrowReserve: Address
   /** Borrow rate used for calculating interest (big scaled fraction) */
   cumulativeBorrowRateBsf: types.BigFractionBytesFields
-  padding: BN
+  /**
+   * The timestamp at which this debt was taken.
+   * More specifically: when the *first* borrow operation from this reserve happened.
+   * This means that:
+   * - adding debt of the same reserve does *not* change this timestamp,
+   * - repaying the entire debt of this reserve *does* reset this timestamp.
+   *
+   * Note: this field is *not* only metadata: it is used in the logic, e.g. for enforcing the
+   * fixed-term borrows (i.e. those induced by [ReserveConfig::debt_term_seconds]).
+   */
+  firstBorrowedAtTimestamp: BN
   /** Amount of liquidity borrowed plus interest (scaled fraction) */
   borrowedAmountSf: BN
   /** Liquidity market value in quote currency (scaled fraction) */
@@ -26,7 +36,17 @@ export interface ObligationLiquidityJSON {
   borrowReserve: string
   /** Borrow rate used for calculating interest (big scaled fraction) */
   cumulativeBorrowRateBsf: types.BigFractionBytesJSON
-  padding: string
+  /**
+   * The timestamp at which this debt was taken.
+   * More specifically: when the *first* borrow operation from this reserve happened.
+   * This means that:
+   * - adding debt of the same reserve does *not* change this timestamp,
+   * - repaying the entire debt of this reserve *does* reset this timestamp.
+   *
+   * Note: this field is *not* only metadata: it is used in the logic, e.g. for enforcing the
+   * fixed-term borrows (i.e. those induced by [ReserveConfig::debt_term_seconds]).
+   */
+  firstBorrowedAtTimestamp: string
   /** Amount of liquidity borrowed plus interest (scaled fraction) */
   borrowedAmountSf: string
   /** Liquidity market value in quote currency (scaled fraction) */
@@ -44,7 +64,17 @@ export class ObligationLiquidity {
   readonly borrowReserve: Address
   /** Borrow rate used for calculating interest (big scaled fraction) */
   readonly cumulativeBorrowRateBsf: types.BigFractionBytes
-  readonly padding: BN
+  /**
+   * The timestamp at which this debt was taken.
+   * More specifically: when the *first* borrow operation from this reserve happened.
+   * This means that:
+   * - adding debt of the same reserve does *not* change this timestamp,
+   * - repaying the entire debt of this reserve *does* reset this timestamp.
+   *
+   * Note: this field is *not* only metadata: it is used in the logic, e.g. for enforcing the
+   * fixed-term borrows (i.e. those induced by [ReserveConfig::debt_term_seconds]).
+   */
+  readonly firstBorrowedAtTimestamp: BN
   /** Amount of liquidity borrowed plus interest (scaled fraction) */
   readonly borrowedAmountSf: BN
   /** Liquidity market value in quote currency (scaled fraction) */
@@ -60,7 +90,7 @@ export class ObligationLiquidity {
     this.cumulativeBorrowRateBsf = new types.BigFractionBytes({
       ...fields.cumulativeBorrowRateBsf,
     })
-    this.padding = fields.padding
+    this.firstBorrowedAtTimestamp = fields.firstBorrowedAtTimestamp
     this.borrowedAmountSf = fields.borrowedAmountSf
     this.marketValueSf = fields.marketValueSf
     this.borrowFactorAdjustedMarketValueSf =
@@ -75,7 +105,7 @@ export class ObligationLiquidity {
       [
         borshAddress("borrowReserve"),
         types.BigFractionBytes.layout("cumulativeBorrowRateBsf"),
-        borsh.u64("padding"),
+        borsh.u64("firstBorrowedAtTimestamp"),
         borsh.u128("borrowedAmountSf"),
         borsh.u128("marketValueSf"),
         borsh.u128("borrowFactorAdjustedMarketValueSf"),
@@ -93,7 +123,7 @@ export class ObligationLiquidity {
       cumulativeBorrowRateBsf: types.BigFractionBytes.fromDecoded(
         obj.cumulativeBorrowRateBsf
       ),
-      padding: obj.padding,
+      firstBorrowedAtTimestamp: obj.firstBorrowedAtTimestamp,
       borrowedAmountSf: obj.borrowedAmountSf,
       marketValueSf: obj.marketValueSf,
       borrowFactorAdjustedMarketValueSf: obj.borrowFactorAdjustedMarketValueSf,
@@ -109,7 +139,7 @@ export class ObligationLiquidity {
       cumulativeBorrowRateBsf: types.BigFractionBytes.toEncodable(
         fields.cumulativeBorrowRateBsf
       ),
-      padding: fields.padding,
+      firstBorrowedAtTimestamp: fields.firstBorrowedAtTimestamp,
       borrowedAmountSf: fields.borrowedAmountSf,
       marketValueSf: fields.marketValueSf,
       borrowFactorAdjustedMarketValueSf:
@@ -124,7 +154,7 @@ export class ObligationLiquidity {
     return {
       borrowReserve: this.borrowReserve,
       cumulativeBorrowRateBsf: this.cumulativeBorrowRateBsf.toJSON(),
-      padding: this.padding.toString(),
+      firstBorrowedAtTimestamp: this.firstBorrowedAtTimestamp.toString(),
       borrowedAmountSf: this.borrowedAmountSf.toString(),
       marketValueSf: this.marketValueSf.toString(),
       borrowFactorAdjustedMarketValueSf:
@@ -141,7 +171,7 @@ export class ObligationLiquidity {
       cumulativeBorrowRateBsf: types.BigFractionBytes.fromJSON(
         obj.cumulativeBorrowRateBsf
       ),
-      padding: new BN(obj.padding),
+      firstBorrowedAtTimestamp: new BN(obj.firstBorrowedAtTimestamp),
       borrowedAmountSf: new BN(obj.borrowedAmountSf),
       marketValueSf: new BN(obj.marketValueSf),
       borrowFactorAdjustedMarketValueSf: new BN(

package/src/@codegen/klend/types/ObligationOrder.ts

@@ -77,7 +77,7 @@ export interface ObligationOrderFields {
    */
   opportunityType: number
   /**
-   * Internal padding.
+   * Alignment padding.
    * The fields above take up 2+2+1+1 bytes = 48 bits, which means we need 80 bits = 10 bytes to
    * align with `u128`s.
    */
@@ -162,7 +162,7 @@ export interface ObligationOrderJSON {
    */
   opportunityType: number
   /**
-   * Internal padding.
+   * Alignment padding.
    * The fields above take up 2+2+1+1 bytes = 48 bits, which means we need 80 bits = 10 bytes to
    * align with `u128`s.
    */
@@ -176,7 +176,7 @@ export interface ObligationOrderJSON {
 
 /**
  * A single obligation order.
- * See [Obligation::orders].
+ * See [Obligation::obligation_orders].
  */
 export class ObligationOrder {
   /**
@@ -251,7 +251,7 @@ export class ObligationOrder {
    */
   readonly opportunityType: number
   /**
-   * Internal padding.
+   * Alignment padding.
    * The fields above take up 2+2+1+1 bytes = 48 bits, which means we need 80 bits = 10 bytes to
    * align with `u128`s.
    */