@kamino-finance/klend-sdk 7.4.0-beta.1 → 7.4.0-beta.3

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

@@ -0,0 +1,199 @@
+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 FixedTermBorrowRolloverConfigFields {
+  /**
+   * Whether the borrow can be permissionlessly prolonged under the following *joint* conditions:
+   *
+   * The reserve used to re-borrow the liquidity must have:
+   * A) the exact same maximum borrow rate as the current one,
+   * B) the exact same debt term as the current one,
+   * C) sufficient available liquidity (including no withdraw tickets waiting in its queue).
+   *
+   * The time left until the current debt term expires must be:
+   * D) less than [LendingMarket::fixed_rollover_window_duration_seconds].
+   *
+   * Note: the other settings are only effective when this one is `1`.
+   */
+  autoRolloverEnabled: number
+  /**
+   * When `1`, partially lifts the condition *B* from [Self::auto_rollover_enabled]: additionally
+   * allows to use a variable (indefinite) debt term if less than
+   * [LendingMarket::variable_rollover_window_duration_seconds] is left until expiration.
+   *
+   * Note: typically this flag should be used together with [Self::max_borrow_rate_bps] set to
+   * `u32::MAX` (to denote a variable-rate reserve).
+   */
+  openTermAllowed: number
+  /** Internal alignment padding (free to reuse). */
+  alignmentPadding: Array<number>
+  /**
+   * A customization setting that can lift the condition *A* from [Self::auto_rollover_enabled]:
+   * when not zeroed, the rollover may use a reserve with a maximum borrow rate equal or lower
+   * than the given one.
+   */
+  maxBorrowRateBps: number
+  /**
+   * A customization setting that can lift the condition *B* from [Self::auto_rollover_enabled]:
+   * when not zeroed, the rollover may use a reserve with a *fixed* debt term equal or longer
+   * than the given one.
+   */
+  minDebtTermSeconds: BN
+}
+
+export interface FixedTermBorrowRolloverConfigJSON {
+  /**
+   * Whether the borrow can be permissionlessly prolonged under the following *joint* conditions:
+   *
+   * The reserve used to re-borrow the liquidity must have:
+   * A) the exact same maximum borrow rate as the current one,
+   * B) the exact same debt term as the current one,
+   * C) sufficient available liquidity (including no withdraw tickets waiting in its queue).
+   *
+   * The time left until the current debt term expires must be:
+   * D) less than [LendingMarket::fixed_rollover_window_duration_seconds].
+   *
+   * Note: the other settings are only effective when this one is `1`.
+   */
+  autoRolloverEnabled: number
+  /**
+   * When `1`, partially lifts the condition *B* from [Self::auto_rollover_enabled]: additionally
+   * allows to use a variable (indefinite) debt term if less than
+   * [LendingMarket::variable_rollover_window_duration_seconds] is left until expiration.
+   *
+   * Note: typically this flag should be used together with [Self::max_borrow_rate_bps] set to
+   * `u32::MAX` (to denote a variable-rate reserve).
+   */
+  openTermAllowed: number
+  /** Internal alignment padding (free to reuse). */
+  alignmentPadding: Array<number>
+  /**
+   * A customization setting that can lift the condition *A* from [Self::auto_rollover_enabled]:
+   * when not zeroed, the rollover may use a reserve with a maximum borrow rate equal or lower
+   * than the given one.
+   */
+  maxBorrowRateBps: number
+  /**
+   * A customization setting that can lift the condition *B* from [Self::auto_rollover_enabled]:
+   * when not zeroed, the rollover may use a reserve with a *fixed* debt term equal or longer
+   * than the given one.
+   */
+  minDebtTermSeconds: string
+}
+
+/**
+ * Settings driving the auto-rollover of an [ObligationLiquidity] that uses a fixed-term [Reserve]
+ * and approaches the end of its [ReserveConfig::debt_term_seconds].
+ *
+ * By its nature (not a special case), the zeroed struct mean "no auto-rollover".
+ */
+export class FixedTermBorrowRolloverConfig {
+  /**
+   * Whether the borrow can be permissionlessly prolonged under the following *joint* conditions:
+   *
+   * The reserve used to re-borrow the liquidity must have:
+   * A) the exact same maximum borrow rate as the current one,
+   * B) the exact same debt term as the current one,
+   * C) sufficient available liquidity (including no withdraw tickets waiting in its queue).
+   *
+   * The time left until the current debt term expires must be:
+   * D) less than [LendingMarket::fixed_rollover_window_duration_seconds].
+   *
+   * Note: the other settings are only effective when this one is `1`.
+   */
+  readonly autoRolloverEnabled: number
+  /**
+   * When `1`, partially lifts the condition *B* from [Self::auto_rollover_enabled]: additionally
+   * allows to use a variable (indefinite) debt term if less than
+   * [LendingMarket::variable_rollover_window_duration_seconds] is left until expiration.
+   *
+   * Note: typically this flag should be used together with [Self::max_borrow_rate_bps] set to
+   * `u32::MAX` (to denote a variable-rate reserve).
+   */
+  readonly openTermAllowed: number
+  /** Internal alignment padding (free to reuse). */
+  readonly alignmentPadding: Array<number>
+  /**
+   * A customization setting that can lift the condition *A* from [Self::auto_rollover_enabled]:
+   * when not zeroed, the rollover may use a reserve with a maximum borrow rate equal or lower
+   * than the given one.
+   */
+  readonly maxBorrowRateBps: number
+  /**
+   * A customization setting that can lift the condition *B* from [Self::auto_rollover_enabled]:
+   * when not zeroed, the rollover may use a reserve with a *fixed* debt term equal or longer
+   * than the given one.
+   */
+  readonly minDebtTermSeconds: BN
+
+  constructor(fields: FixedTermBorrowRolloverConfigFields) {
+    this.autoRolloverEnabled = fields.autoRolloverEnabled
+    this.openTermAllowed = fields.openTermAllowed
+    this.alignmentPadding = fields.alignmentPadding
+    this.maxBorrowRateBps = fields.maxBorrowRateBps
+    this.minDebtTermSeconds = fields.minDebtTermSeconds
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borsh.u8("autoRolloverEnabled"),
+        borsh.u8("openTermAllowed"),
+        borsh.array(borsh.u8(), 2, "alignmentPadding"),
+        borsh.u32("maxBorrowRateBps"),
+        borsh.u64("minDebtTermSeconds"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new FixedTermBorrowRolloverConfig({
+      autoRolloverEnabled: obj.autoRolloverEnabled,
+      openTermAllowed: obj.openTermAllowed,
+      alignmentPadding: obj.alignmentPadding,
+      maxBorrowRateBps: obj.maxBorrowRateBps,
+      minDebtTermSeconds: obj.minDebtTermSeconds,
+    })
+  }
+
+  static toEncodable(fields: FixedTermBorrowRolloverConfigFields) {
+    return {
+      autoRolloverEnabled: fields.autoRolloverEnabled,
+      openTermAllowed: fields.openTermAllowed,
+      alignmentPadding: fields.alignmentPadding,
+      maxBorrowRateBps: fields.maxBorrowRateBps,
+      minDebtTermSeconds: fields.minDebtTermSeconds,
+    }
+  }
+
+  toJSON(): FixedTermBorrowRolloverConfigJSON {
+    return {
+      autoRolloverEnabled: this.autoRolloverEnabled,
+      openTermAllowed: this.openTermAllowed,
+      alignmentPadding: this.alignmentPadding,
+      maxBorrowRateBps: this.maxBorrowRateBps,
+      minDebtTermSeconds: this.minDebtTermSeconds.toString(),
+    }
+  }
+
+  static fromJSON(
+    obj: FixedTermBorrowRolloverConfigJSON
+  ): FixedTermBorrowRolloverConfig {
+    return new FixedTermBorrowRolloverConfig({
+      autoRolloverEnabled: obj.autoRolloverEnabled,
+      openTermAllowed: obj.openTermAllowed,
+      alignmentPadding: obj.alignmentPadding,
+      maxBorrowRateBps: obj.maxBorrowRateBps,
+      minDebtTermSeconds: new BN(obj.minDebtTermSeconds),
+    })
+  }
+
+  toEncodable() {
+    return FixedTermBorrowRolloverConfig.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) */
@@ -18,6 +28,11 @@ export interface ObligationLiquidityFields {
   borrowFactorAdjustedMarketValueSf: BN
   /** Amount of liquidity borrowed outside of an elevation group */
   borrowedAmountOutsideElevationGroups: BN
+  /**
+   * The user's auto-rollover opt-ins - only effective when this borrow is fixed-term (i.e. its
+   * reserve has a non-zero [ReserveConfig::debt_term_seconds]).
+   */
+  fixedTermBorrowRolloverConfig: types.FixedTermBorrowRolloverConfigFields
   padding2: Array<BN>
 }
 
@@ -26,7 +41,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) */
@@ -35,6 +60,11 @@ export interface ObligationLiquidityJSON {
   borrowFactorAdjustedMarketValueSf: string
   /** Amount of liquidity borrowed outside of an elevation group */
   borrowedAmountOutsideElevationGroups: string
+  /**
+   * The user's auto-rollover opt-ins - only effective when this borrow is fixed-term (i.e. its
+   * reserve has a non-zero [ReserveConfig::debt_term_seconds]).
+   */
+  fixedTermBorrowRolloverConfig: types.FixedTermBorrowRolloverConfigJSON
   padding2: Array<string>
 }
 
@@ -44,7 +74,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) */
@@ -53,6 +93,11 @@ export class ObligationLiquidity {
   readonly borrowFactorAdjustedMarketValueSf: BN
   /** Amount of liquidity borrowed outside of an elevation group */
   readonly borrowedAmountOutsideElevationGroups: BN
+  /**
+   * The user's auto-rollover opt-ins - only effective when this borrow is fixed-term (i.e. its
+   * reserve has a non-zero [ReserveConfig::debt_term_seconds]).
+   */
+  readonly fixedTermBorrowRolloverConfig: types.FixedTermBorrowRolloverConfig
   readonly padding2: Array<BN>
 
   constructor(fields: ObligationLiquidityFields) {
@@ -60,13 +105,17 @@ 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 =
       fields.borrowFactorAdjustedMarketValueSf
     this.borrowedAmountOutsideElevationGroups =
       fields.borrowedAmountOutsideElevationGroups
+    this.fixedTermBorrowRolloverConfig =
+      new types.FixedTermBorrowRolloverConfig({
+        ...fields.fixedTermBorrowRolloverConfig,
+      })
     this.padding2 = fields.padding2
   }
 
@@ -75,12 +124,15 @@ export class ObligationLiquidity {
       [
         borshAddress("borrowReserve"),
         types.BigFractionBytes.layout("cumulativeBorrowRateBsf"),
-        borsh.u64("padding"),
+        borsh.u64("firstBorrowedAtTimestamp"),
         borsh.u128("borrowedAmountSf"),
         borsh.u128("marketValueSf"),
         borsh.u128("borrowFactorAdjustedMarketValueSf"),
         borsh.u64("borrowedAmountOutsideElevationGroups"),
-        borsh.array(borsh.u64(), 7, "padding2"),
+        types.FixedTermBorrowRolloverConfig.layout(
+          "fixedTermBorrowRolloverConfig"
+        ),
+        borsh.array(borsh.u64(), 5, "padding2"),
       ],
       property
     )
@@ -93,12 +145,16 @@ export class ObligationLiquidity {
       cumulativeBorrowRateBsf: types.BigFractionBytes.fromDecoded(
         obj.cumulativeBorrowRateBsf
       ),
-      padding: obj.padding,
+      firstBorrowedAtTimestamp: obj.firstBorrowedAtTimestamp,
       borrowedAmountSf: obj.borrowedAmountSf,
       marketValueSf: obj.marketValueSf,
       borrowFactorAdjustedMarketValueSf: obj.borrowFactorAdjustedMarketValueSf,
       borrowedAmountOutsideElevationGroups:
         obj.borrowedAmountOutsideElevationGroups,
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.fromDecoded(
+          obj.fixedTermBorrowRolloverConfig
+        ),
       padding2: obj.padding2,
     })
   }
@@ -109,13 +165,17 @@ export class ObligationLiquidity {
       cumulativeBorrowRateBsf: types.BigFractionBytes.toEncodable(
         fields.cumulativeBorrowRateBsf
       ),
-      padding: fields.padding,
+      firstBorrowedAtTimestamp: fields.firstBorrowedAtTimestamp,
       borrowedAmountSf: fields.borrowedAmountSf,
       marketValueSf: fields.marketValueSf,
       borrowFactorAdjustedMarketValueSf:
         fields.borrowFactorAdjustedMarketValueSf,
       borrowedAmountOutsideElevationGroups:
         fields.borrowedAmountOutsideElevationGroups,
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.toEncodable(
+          fields.fixedTermBorrowRolloverConfig
+        ),
       padding2: fields.padding2,
     }
   }
@@ -124,13 +184,15 @@ 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:
         this.borrowFactorAdjustedMarketValueSf.toString(),
       borrowedAmountOutsideElevationGroups:
         this.borrowedAmountOutsideElevationGroups.toString(),
+      fixedTermBorrowRolloverConfig:
+        this.fixedTermBorrowRolloverConfig.toJSON(),
       padding2: this.padding2.map((item) => item.toString()),
     }
   }
@@ -141,7 +203,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(
@@ -150,6 +212,10 @@ export class ObligationLiquidity {
       borrowedAmountOutsideElevationGroups: new BN(
         obj.borrowedAmountOutsideElevationGroups
       ),
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.fromJSON(
+          obj.fixedTermBorrowRolloverConfig
+        ),
       padding2: obj.padding2.map((item) => new BN(item)),
     })
   }

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.
    */

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

@@ -0,0 +1,91 @@
+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 NoneJSON {
+  kind: "None"
+}
+
+export class None {
+  static readonly discriminator = 0
+  static readonly kind = "None"
+  readonly discriminator = 0
+  readonly kind = "None"
+
+  toJSON(): NoneJSON {
+    return {
+      kind: "None",
+    }
+  }
+
+  toEncodable() {
+    return {
+      None: {},
+    }
+  }
+}
+
+export interface KlendQueueAccountingHandlerOnKvaultJSON {
+  kind: "KlendQueueAccountingHandlerOnKvault"
+}
+
+export class KlendQueueAccountingHandlerOnKvault {
+  static readonly discriminator = 1
+  static readonly kind = "KlendQueueAccountingHandlerOnKvault"
+  readonly discriminator = 1
+  readonly kind = "KlendQueueAccountingHandlerOnKvault"
+
+  toJSON(): KlendQueueAccountingHandlerOnKvaultJSON {
+    return {
+      kind: "KlendQueueAccountingHandlerOnKvault",
+    }
+  }
+
+  toEncodable() {
+    return {
+      KlendQueueAccountingHandlerOnKvault: {},
+    }
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function fromDecoded(obj: any): types.ProgressCallbackTypeKind {
+  if (typeof obj !== "object") {
+    throw new Error("Invalid enum object")
+  }
+
+  if ("None" in obj) {
+    return new None()
+  }
+  if ("KlendQueueAccountingHandlerOnKvault" in obj) {
+    return new KlendQueueAccountingHandlerOnKvault()
+  }
+
+  throw new Error("Invalid enum object")
+}
+
+export function fromJSON(
+  obj: types.ProgressCallbackTypeJSON
+): types.ProgressCallbackTypeKind {
+  switch (obj.kind) {
+    case "None": {
+      return new None()
+    }
+    case "KlendQueueAccountingHandlerOnKvault": {
+      return new KlendQueueAccountingHandlerOnKvault()
+    }
+  }
+}
+
+export function layout(property?: string) {
+  const ret = borsh.rustEnum([
+    borsh.struct([], "None"),
+    borsh.struct([], "KlendQueueAccountingHandlerOnKvault"),
+  ])
+  if (property !== undefined) {
+    return ret.replicate(property)
+  }
+  return ret
+}