@kamino-finance/klend-sdk 7.4.0-beta.2 → 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

@@ -28,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>
 }
 
@@ -55,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>
 }
 
@@ -83,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) {
@@ -97,6 +112,10 @@ export class ObligationLiquidity {
       fields.borrowFactorAdjustedMarketValueSf
     this.borrowedAmountOutsideElevationGroups =
       fields.borrowedAmountOutsideElevationGroups
+    this.fixedTermBorrowRolloverConfig =
+      new types.FixedTermBorrowRolloverConfig({
+        ...fields.fixedTermBorrowRolloverConfig,
+      })
     this.padding2 = fields.padding2
   }
 
@@ -110,7 +129,10 @@ export class ObligationLiquidity {
         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
     )
@@ -129,6 +151,10 @@ export class ObligationLiquidity {
       borrowFactorAdjustedMarketValueSf: obj.borrowFactorAdjustedMarketValueSf,
       borrowedAmountOutsideElevationGroups:
         obj.borrowedAmountOutsideElevationGroups,
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.fromDecoded(
+          obj.fixedTermBorrowRolloverConfig
+        ),
       padding2: obj.padding2,
     })
   }
@@ -146,6 +172,10 @@ export class ObligationLiquidity {
         fields.borrowFactorAdjustedMarketValueSf,
       borrowedAmountOutsideElevationGroups:
         fields.borrowedAmountOutsideElevationGroups,
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.toEncodable(
+          fields.fixedTermBorrowRolloverConfig
+        ),
       padding2: fields.padding2,
     }
   }
@@ -161,6 +191,8 @@ export class ObligationLiquidity {
         this.borrowFactorAdjustedMarketValueSf.toString(),
       borrowedAmountOutsideElevationGroups:
         this.borrowedAmountOutsideElevationGroups.toString(),
+      fixedTermBorrowRolloverConfig:
+        this.fixedTermBorrowRolloverConfig.toJSON(),
       padding2: this.padding2.map((item) => item.toString()),
     }
   }
@@ -180,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/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
+}

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

@@ -11,8 +11,14 @@ export interface ReserveLiquidityFields {
   supplyVault: Address
   /** Reserve liquidity fee collection address */
   feeVault: Address
-  /** Reserve liquidity available */
-  availableAmount: BN
+  /**
+   * Total reserve liquidity available.
+   *
+   * Note: not all of this liquidity can be freely used for any purpose. Production code should
+   * use the specialized getters - see e.g. [Reserve::total_available_liquidity_amount()],
+   * [Reserve::freely_available_liquidity_amount()].
+   */
+  totalAvailableAmount: BN
   /** Reserve liquidity borrowed (scaled fraction) */
   borrowedAmountSf: BN
   /** Reserve liquidity market price in quote currency (scaled fraction) */
@@ -54,8 +60,14 @@ export interface ReserveLiquidityJSON {
   supplyVault: string
   /** Reserve liquidity fee collection address */
   feeVault: string
-  /** Reserve liquidity available */
-  availableAmount: string
+  /**
+   * Total reserve liquidity available.
+   *
+   * Note: not all of this liquidity can be freely used for any purpose. Production code should
+   * use the specialized getters - see e.g. [Reserve::total_available_liquidity_amount()],
+   * [Reserve::freely_available_liquidity_amount()].
+   */
+  totalAvailableAmount: string
   /** Reserve liquidity borrowed (scaled fraction) */
   borrowedAmountSf: string
   /** Reserve liquidity market price in quote currency (scaled fraction) */
@@ -98,8 +110,14 @@ export class ReserveLiquidity {
   readonly supplyVault: Address
   /** Reserve liquidity fee collection address */
   readonly feeVault: Address
-  /** Reserve liquidity available */
-  readonly availableAmount: BN
+  /**
+   * Total reserve liquidity available.
+   *
+   * Note: not all of this liquidity can be freely used for any purpose. Production code should
+   * use the specialized getters - see e.g. [Reserve::total_available_liquidity_amount()],
+   * [Reserve::freely_available_liquidity_amount()].
+   */
+  readonly totalAvailableAmount: BN
   /** Reserve liquidity borrowed (scaled fraction) */
   readonly borrowedAmountSf: BN
   /** Reserve liquidity market price in quote currency (scaled fraction) */
@@ -137,7 +155,7 @@ export class ReserveLiquidity {
     this.mintPubkey = fields.mintPubkey
     this.supplyVault = fields.supplyVault
     this.feeVault = fields.feeVault
-    this.availableAmount = fields.availableAmount
+    this.totalAvailableAmount = fields.totalAvailableAmount
     this.borrowedAmountSf = fields.borrowedAmountSf
     this.marketPriceSf = fields.marketPriceSf
     this.marketPriceLastUpdatedTs = fields.marketPriceLastUpdatedTs
@@ -162,7 +180,7 @@ export class ReserveLiquidity {
         borshAddress("mintPubkey"),
         borshAddress("supplyVault"),
         borshAddress("feeVault"),
-        borsh.u64("availableAmount"),
+        borsh.u64("totalAvailableAmount"),
         borsh.u128("borrowedAmountSf"),
         borsh.u128("marketPriceSf"),
         borsh.u64("marketPriceLastUpdatedTs"),
@@ -188,7 +206,7 @@ export class ReserveLiquidity {
       mintPubkey: obj.mintPubkey,
       supplyVault: obj.supplyVault,
       feeVault: obj.feeVault,
-      availableAmount: obj.availableAmount,
+      totalAvailableAmount: obj.totalAvailableAmount,
       borrowedAmountSf: obj.borrowedAmountSf,
       marketPriceSf: obj.marketPriceSf,
       marketPriceLastUpdatedTs: obj.marketPriceLastUpdatedTs,
@@ -213,7 +231,7 @@ export class ReserveLiquidity {
       mintPubkey: fields.mintPubkey,
       supplyVault: fields.supplyVault,
       feeVault: fields.feeVault,
-      availableAmount: fields.availableAmount,
+      totalAvailableAmount: fields.totalAvailableAmount,
       borrowedAmountSf: fields.borrowedAmountSf,
       marketPriceSf: fields.marketPriceSf,
       marketPriceLastUpdatedTs: fields.marketPriceLastUpdatedTs,
@@ -238,7 +256,7 @@ export class ReserveLiquidity {
       mintPubkey: this.mintPubkey,
       supplyVault: this.supplyVault,
       feeVault: this.feeVault,
-      availableAmount: this.availableAmount.toString(),
+      totalAvailableAmount: this.totalAvailableAmount.toString(),
       borrowedAmountSf: this.borrowedAmountSf.toString(),
       marketPriceSf: this.marketPriceSf.toString(),
       marketPriceLastUpdatedTs: this.marketPriceLastUpdatedTs.toString(),
@@ -262,7 +280,7 @@ export class ReserveLiquidity {
       mintPubkey: address(obj.mintPubkey),
       supplyVault: address(obj.supplyVault),
       feeVault: address(obj.feeVault),
-      availableAmount: new BN(obj.availableAmount),
+      totalAvailableAmount: new BN(obj.totalAvailableAmount),
       borrowedAmountSf: new BN(obj.borrowedAmountSf),
       marketPriceSf: new BN(obj.marketPriceSf),
       marketPriceLastUpdatedTs: new BN(obj.marketPriceLastUpdatedTs),

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

@@ -556,25 +556,25 @@ export class UpdateBorrowRateCurve {
   }
 }
 
-export interface UpdateEntireReserveConfigJSON {
-  kind: "UpdateEntireReserveConfig"
+export interface DeprecatedUpdateEntireReserveConfigJSON {
+  kind: "DeprecatedUpdateEntireReserveConfig"
 }
 
-export class UpdateEntireReserveConfig {
+export class DeprecatedUpdateEntireReserveConfig {
   static readonly discriminator = 24
-  static readonly kind = "UpdateEntireReserveConfig"
+  static readonly kind = "DeprecatedUpdateEntireReserveConfig"
   readonly discriminator = 24
-  readonly kind = "UpdateEntireReserveConfig"
+  readonly kind = "DeprecatedUpdateEntireReserveConfig"
 
-  toJSON(): UpdateEntireReserveConfigJSON {
+  toJSON(): DeprecatedUpdateEntireReserveConfigJSON {
     return {
-      kind: "UpdateEntireReserveConfig",
+      kind: "DeprecatedUpdateEntireReserveConfig",
     }
   }
 
   toEncodable() {
     return {
-      UpdateEntireReserveConfig: {},
+      DeprecatedUpdateEntireReserveConfig: {},
     }
   }
 }
@@ -1347,8 +1347,8 @@ export function fromDecoded(obj: any): types.UpdateConfigModeKind {
   if ("UpdateBorrowRateCurve" in obj) {
     return new UpdateBorrowRateCurve()
   }
-  if ("UpdateEntireReserveConfig" in obj) {
-    return new UpdateEntireReserveConfig()
+  if ("DeprecatedUpdateEntireReserveConfig" in obj) {
+    return new DeprecatedUpdateEntireReserveConfig()
   }
   if ("UpdateDebtWithdrawalCap" in obj) {
     return new UpdateDebtWithdrawalCap()
@@ -1520,8 +1520,8 @@ export function fromJSON(
     case "UpdateBorrowRateCurve": {
       return new UpdateBorrowRateCurve()
     }
-    case "UpdateEntireReserveConfig": {
-      return new UpdateEntireReserveConfig()
+    case "DeprecatedUpdateEntireReserveConfig": {
+      return new DeprecatedUpdateEntireReserveConfig()
     }
     case "UpdateDebtWithdrawalCap": {
       return new UpdateDebtWithdrawalCap()
@@ -1642,7 +1642,7 @@ export function layout(property?: string) {
     borsh.struct([], "UpdateSwitchboardFeed"),
     borsh.struct([], "UpdateSwitchboardTwapFeed"),
     borsh.struct([], "UpdateBorrowRateCurve"),
-    borsh.struct([], "UpdateEntireReserveConfig"),
+    borsh.struct([], "DeprecatedUpdateEntireReserveConfig"),
     borsh.struct([], "UpdateDebtWithdrawalCap"),
     borsh.struct([], "UpdateDepositWithdrawalCap"),
     borsh.struct([], "DeprecatedUpdateDebtWithdrawalCapCurrentTotal"),