@kamino-finance/klend-sdk 5.11.18 → 5.12.0

package/src/idl_codegen/accounts/Obligation.ts

@@ -35,8 +35,8 @@ export interface ObligationFields {
   borrowsAssetTiers: Array<number>
   /** The elevation group id the obligation opted into. */
   elevationGroup: number
-  /** The number of deprecated reserves the obligation has a deposit */
-  numOfObsoleteReserves: number
+  /** The number of obsolete reserves the obligation has a deposit in */
+  numOfObsoleteDepositReserves: number
   /** Marked = 1 if borrows array is not empty, 0 = borrows empty */
   hasDebt: number
   /** Wallet address of the referrer */
@@ -50,6 +50,8 @@ export interface ObligationFields {
   autodeleverageTargetLtvPct: number
   /** The lowest max LTV found amongst the collateral deposits */
   lowestReserveDepositMaxLtvPct: number
+  /** The number of obsolete reserves the obligation has a borrow in */
+  numOfObsoleteBorrowReserves: number
   reserved: Array<number>
   highestBorrowFactorPct: BN
   /**
@@ -57,6 +59,11 @@ export interface ObligationFields {
    * Zero if not currently subject to deleveraging.
    */
   autodeleverageMarginCallStartedTimestamp: BN
+  /**
+   * Owner-defined, liquidator-executed orders applicable to this obligation.
+   * Typical use-cases would be a stop-loss and a take-profit (possibly co-existing).
+   */
+  orders: Array<types.ObligationOrderFields>
   padding3: Array<BN>
 }
 
@@ -91,8 +98,8 @@ export interface ObligationJSON {
   borrowsAssetTiers: Array<number>
   /** The elevation group id the obligation opted into. */
   elevationGroup: number
-  /** The number of deprecated reserves the obligation has a deposit */
-  numOfObsoleteReserves: number
+  /** The number of obsolete reserves the obligation has a deposit in */
+  numOfObsoleteDepositReserves: number
   /** Marked = 1 if borrows array is not empty, 0 = borrows empty */
   hasDebt: number
   /** Wallet address of the referrer */
@@ -106,6 +113,8 @@ export interface ObligationJSON {
   autodeleverageTargetLtvPct: number
   /** The lowest max LTV found amongst the collateral deposits */
   lowestReserveDepositMaxLtvPct: number
+  /** The number of obsolete reserves the obligation has a borrow in */
+  numOfObsoleteBorrowReserves: number
   reserved: Array<number>
   highestBorrowFactorPct: string
   /**
@@ -113,6 +122,11 @@ export interface ObligationJSON {
    * Zero if not currently subject to deleveraging.
    */
   autodeleverageMarginCallStartedTimestamp: string
+  /**
+   * Owner-defined, liquidator-executed orders applicable to this obligation.
+   * Typical use-cases would be a stop-loss and a take-profit (possibly co-existing).
+   */
+  orders: Array<types.ObligationOrderJSON>
   padding3: Array<string>
 }
 
@@ -148,8 +162,8 @@ export class Obligation {
   readonly borrowsAssetTiers: Array<number>
   /** The elevation group id the obligation opted into. */
   readonly elevationGroup: number
-  /** The number of deprecated reserves the obligation has a deposit */
-  readonly numOfObsoleteReserves: number
+  /** The number of obsolete reserves the obligation has a deposit in */
+  readonly numOfObsoleteDepositReserves: number
   /** Marked = 1 if borrows array is not empty, 0 = borrows empty */
   readonly hasDebt: number
   /** Wallet address of the referrer */
@@ -163,6 +177,8 @@ export class Obligation {
   readonly autodeleverageTargetLtvPct: number
   /** The lowest max LTV found amongst the collateral deposits */
   readonly lowestReserveDepositMaxLtvPct: number
+  /** The number of obsolete reserves the obligation has a borrow in */
+  readonly numOfObsoleteBorrowReserves: number
   readonly reserved: Array<number>
   readonly highestBorrowFactorPct: BN
   /**
@@ -170,6 +186,11 @@ export class Obligation {
    * Zero if not currently subject to deleveraging.
    */
   readonly autodeleverageMarginCallStartedTimestamp: BN
+  /**
+   * Owner-defined, liquidator-executed orders applicable to this obligation.
+   * Typical use-cases would be a stop-loss and a take-profit (possibly co-existing).
+   */
+  readonly orders: Array<types.ObligationOrder>
   readonly padding3: Array<BN>
 
   static readonly discriminator = Buffer.from([
@@ -192,16 +213,18 @@ export class Obligation {
     borsh.array(borsh.u8(), 8, "depositsAssetTiers"),
     borsh.array(borsh.u8(), 5, "borrowsAssetTiers"),
     borsh.u8("elevationGroup"),
-    borsh.u8("numOfObsoleteReserves"),
+    borsh.u8("numOfObsoleteDepositReserves"),
     borsh.u8("hasDebt"),
     borsh.publicKey("referrer"),
     borsh.u8("borrowingDisabled"),
     borsh.u8("autodeleverageTargetLtvPct"),
     borsh.u8("lowestReserveDepositMaxLtvPct"),
-    borsh.array(borsh.u8(), 5, "reserved"),
+    borsh.u8("numOfObsoleteBorrowReserves"),
+    borsh.array(borsh.u8(), 4, "reserved"),
     borsh.u64("highestBorrowFactorPct"),
     borsh.u64("autodeleverageMarginCallStartedTimestamp"),
-    borsh.array(borsh.u64(), 125, "padding3"),
+    borsh.array(types.ObligationOrder.layout(), 2, "orders"),
+    borsh.array(borsh.u64(), 93, "padding3"),
   ])
 
   constructor(fields: ObligationFields) {
@@ -226,16 +249,20 @@ export class Obligation {
     this.depositsAssetTiers = fields.depositsAssetTiers
     this.borrowsAssetTiers = fields.borrowsAssetTiers
     this.elevationGroup = fields.elevationGroup
-    this.numOfObsoleteReserves = fields.numOfObsoleteReserves
+    this.numOfObsoleteDepositReserves = fields.numOfObsoleteDepositReserves
     this.hasDebt = fields.hasDebt
     this.referrer = fields.referrer
     this.borrowingDisabled = fields.borrowingDisabled
     this.autodeleverageTargetLtvPct = fields.autodeleverageTargetLtvPct
     this.lowestReserveDepositMaxLtvPct = fields.lowestReserveDepositMaxLtvPct
+    this.numOfObsoleteBorrowReserves = fields.numOfObsoleteBorrowReserves
     this.reserved = fields.reserved
     this.highestBorrowFactorPct = fields.highestBorrowFactorPct
     this.autodeleverageMarginCallStartedTimestamp =
       fields.autodeleverageMarginCallStartedTimestamp
+    this.orders = fields.orders.map(
+      (item) => new types.ObligationOrder({ ...item })
+    )
     this.padding3 = fields.padding3
   }
 
@@ -307,16 +334,22 @@ export class Obligation {
       depositsAssetTiers: dec.depositsAssetTiers,
       borrowsAssetTiers: dec.borrowsAssetTiers,
       elevationGroup: dec.elevationGroup,
-      numOfObsoleteReserves: dec.numOfObsoleteReserves,
+      numOfObsoleteDepositReserves: dec.numOfObsoleteDepositReserves,
       hasDebt: dec.hasDebt,
       referrer: dec.referrer,
       borrowingDisabled: dec.borrowingDisabled,
       autodeleverageTargetLtvPct: dec.autodeleverageTargetLtvPct,
       lowestReserveDepositMaxLtvPct: dec.lowestReserveDepositMaxLtvPct,
+      numOfObsoleteBorrowReserves: dec.numOfObsoleteBorrowReserves,
       reserved: dec.reserved,
       highestBorrowFactorPct: dec.highestBorrowFactorPct,
       autodeleverageMarginCallStartedTimestamp:
         dec.autodeleverageMarginCallStartedTimestamp,
+      orders: dec.orders.map(
+        (
+          item: any /* eslint-disable-line @typescript-eslint/no-explicit-any */
+        ) => types.ObligationOrder.fromDecoded(item)
+      ),
       padding3: dec.padding3,
     })
   }
@@ -340,16 +373,18 @@ export class Obligation {
       depositsAssetTiers: this.depositsAssetTiers,
       borrowsAssetTiers: this.borrowsAssetTiers,
       elevationGroup: this.elevationGroup,
-      numOfObsoleteReserves: this.numOfObsoleteReserves,
+      numOfObsoleteDepositReserves: this.numOfObsoleteDepositReserves,
       hasDebt: this.hasDebt,
       referrer: this.referrer.toString(),
       borrowingDisabled: this.borrowingDisabled,
       autodeleverageTargetLtvPct: this.autodeleverageTargetLtvPct,
       lowestReserveDepositMaxLtvPct: this.lowestReserveDepositMaxLtvPct,
+      numOfObsoleteBorrowReserves: this.numOfObsoleteBorrowReserves,
       reserved: this.reserved,
       highestBorrowFactorPct: this.highestBorrowFactorPct.toString(),
       autodeleverageMarginCallStartedTimestamp:
         this.autodeleverageMarginCallStartedTimestamp.toString(),
+      orders: this.orders.map((item) => item.toJSON()),
       padding3: this.padding3.map((item) => item.toString()),
     }
   }
@@ -379,17 +414,19 @@ export class Obligation {
       depositsAssetTiers: obj.depositsAssetTiers,
       borrowsAssetTiers: obj.borrowsAssetTiers,
       elevationGroup: obj.elevationGroup,
-      numOfObsoleteReserves: obj.numOfObsoleteReserves,
+      numOfObsoleteDepositReserves: obj.numOfObsoleteDepositReserves,
       hasDebt: obj.hasDebt,
       referrer: new PublicKey(obj.referrer),
       borrowingDisabled: obj.borrowingDisabled,
       autodeleverageTargetLtvPct: obj.autodeleverageTargetLtvPct,
       lowestReserveDepositMaxLtvPct: obj.lowestReserveDepositMaxLtvPct,
+      numOfObsoleteBorrowReserves: obj.numOfObsoleteBorrowReserves,
       reserved: obj.reserved,
       highestBorrowFactorPct: new BN(obj.highestBorrowFactorPct),
       autodeleverageMarginCallStartedTimestamp: new BN(
         obj.autodeleverageMarginCallStartedTimestamp
       ),
+      orders: obj.orders.map((item) => types.ObligationOrder.fromJSON(item)),
       padding3: obj.padding3.map((item) => new BN(item)),
     })
   }

package/src/idl_codegen/errors/custom.ts

@@ -83,7 +83,7 @@ export type CustomError =
   | ShortUrlNotAsciiAlphanumeric
   | ReserveObsolete
   | ElevationGroupAlreadyActivated
-  | ObligationInDeprecatedReserve
+  | ObligationInObsoleteReserve
   | ReferrerStateOwnerMismatch
   | UserMetadataOwnerAlreadySet
   | CollateralNonLiquidatable
@@ -122,6 +122,10 @@ export type CustomError =
   | FarmAccountsMissing
   | RepayTooSmallForFullLiquidation
   | InsufficientRepayAmount
+  | OrderIndexOutOfBounds
+  | InvalidOrderConfiguration
+  | OrderConfigurationNotSupportedByObligation
+  | OperationNotPermittedWithCurrentObligationOrders
 
 export class InvalidMarketAuthority extends Error {
   static readonly code = 6000
@@ -1080,14 +1084,14 @@ export class ElevationGroupAlreadyActivated extends Error {
   }
 }
 
-export class ObligationInDeprecatedReserve extends Error {
+export class ObligationInObsoleteReserve extends Error {
   static readonly code = 6084
   readonly code = 6084
-  readonly name = "ObligationInDeprecatedReserve"
-  readonly msg = "Obligation has a deposit in a deprecated reserve"
+  readonly name = "ObligationInObsoleteReserve"
+  readonly msg = "Obligation has a deposit or borrow in an obsolete reserve"
 
   constructor(readonly logs?: string[]) {
-    super("6084: Obligation has a deposit in a deprecated reserve")
+    super("6084: Obligation has a deposit or borrow in an obsolete reserve")
   }
 }
 
@@ -1548,6 +1552,56 @@ export class InsufficientRepayAmount extends Error {
   }
 }
 
+export class OrderIndexOutOfBounds extends Error {
+  static readonly code = 6123
+  readonly code = 6123
+  readonly name = "OrderIndexOutOfBounds"
+  readonly msg = "Obligation order of the given index cannot exist"
+
+  constructor(readonly logs?: string[]) {
+    super("6123: Obligation order of the given index cannot exist")
+  }
+}
+
+export class InvalidOrderConfiguration extends Error {
+  static readonly code = 6124
+  readonly code = 6124
+  readonly name = "InvalidOrderConfiguration"
+  readonly msg = "Given order configuration has wrong parameters"
+
+  constructor(readonly logs?: string[]) {
+    super("6124: Given order configuration has wrong parameters")
+  }
+}
+
+export class OrderConfigurationNotSupportedByObligation extends Error {
+  static readonly code = 6125
+  readonly code = 6125
+  readonly name = "OrderConfigurationNotSupportedByObligation"
+  readonly msg =
+    "Given order configuration cannot be used with the current state of the obligation"
+
+  constructor(readonly logs?: string[]) {
+    super(
+      "6125: Given order configuration cannot be used with the current state of the obligation"
+    )
+  }
+}
+
+export class OperationNotPermittedWithCurrentObligationOrders extends Error {
+  static readonly code = 6126
+  readonly code = 6126
+  readonly name = "OperationNotPermittedWithCurrentObligationOrders"
+  readonly msg =
+    "Single debt, single collateral obligation orders have to be cancelled before changing the deposit/borrow count"
+
+  constructor(readonly logs?: string[]) {
+    super(
+      "6126: Single debt, single collateral obligation orders have to be cancelled before changing the deposit/borrow count"
+    )
+  }
+}
+
 export function fromCode(code: number, logs?: string[]): CustomError | null {
   switch (code) {
     case 6000:
@@ -1719,7 +1773,7 @@ export function fromCode(code: number, logs?: string[]): CustomError | null {
     case 6083:
       return new ElevationGroupAlreadyActivated(logs)
     case 6084:
-      return new ObligationInDeprecatedReserve(logs)
+      return new ObligationInObsoleteReserve(logs)
     case 6085:
       return new ReferrerStateOwnerMismatch(logs)
     case 6086:
@@ -1796,6 +1850,14 @@ export function fromCode(code: number, logs?: string[]): CustomError | null {
       return new RepayTooSmallForFullLiquidation(logs)
     case 6122:
       return new InsufficientRepayAmount(logs)
+    case 6123:
+      return new OrderIndexOutOfBounds(logs)
+    case 6124:
+      return new InvalidOrderConfiguration(logs)
+    case 6125:
+      return new OrderConfigurationNotSupportedByObligation(logs)
+    case 6126:
+      return new OperationNotPermittedWithCurrentObligationOrders(logs)
   }
 
   return null

package/src/idl_codegen/instructions/index.ts

@@ -183,6 +183,11 @@ export type {
 } from "./initReferrerStateAndShortUrl"
 export { deleteReferrerStateAndShortUrl } from "./deleteReferrerStateAndShortUrl"
 export type { DeleteReferrerStateAndShortUrlAccounts } from "./deleteReferrerStateAndShortUrl"
+export { setObligationOrder } from "./setObligationOrder"
+export type {
+  SetObligationOrderArgs,
+  SetObligationOrderAccounts,
+} from "./setObligationOrder"
 export { idlMissingTypes } from "./idlMissingTypes"
 export type {
   IdlMissingTypesArgs,

package/src/idl_codegen/instructions/setObligationOrder.ts

@@ -0,0 +1,45 @@
+import { TransactionInstruction, PublicKey, AccountMeta } from "@solana/web3.js" // eslint-disable-line @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 * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
+import { PROGRAM_ID } from "../programId"
+
+export interface SetObligationOrderArgs {
+  index: number
+  order: types.ObligationOrderFields
+}
+
+export interface SetObligationOrderAccounts {
+  owner: PublicKey
+  obligation: PublicKey
+  lendingMarket: PublicKey
+}
+
+export const layout = borsh.struct([
+  borsh.u8("index"),
+  types.ObligationOrder.layout("order"),
+])
+
+export function setObligationOrder(
+  args: SetObligationOrderArgs,
+  accounts: SetObligationOrderAccounts,
+  programId: PublicKey = PROGRAM_ID
+) {
+  const keys: Array<AccountMeta> = [
+    { pubkey: accounts.owner, isSigner: true, isWritable: false },
+    { pubkey: accounts.obligation, isSigner: false, isWritable: true },
+    { pubkey: accounts.lendingMarket, isSigner: false, isWritable: false },
+  ]
+  const identifier = Buffer.from([81, 1, 99, 156, 211, 83, 78, 46])
+  const buffer = Buffer.alloc(1000)
+  const len = layout.encode(
+    {
+      index: args.index,
+      order: types.ObligationOrder.toEncodable(args.order),
+    },
+    buffer
+  )
+  const data = Buffer.concat([identifier, buffer]).slice(0, 8 + len)
+  const ix = new TransactionInstruction({ keys, programId, data })
+  return ix
+}