@kamino-finance/klend-sdk 5.11.18 → 5.12.1

package/src/classes/types.ts

@@ -1,4 +1,4 @@
-import { TransactionInstruction } from '@solana/web3.js';
+import { PublicKey, TransactionInstruction } from '@solana/web3.js';
 import Decimal from 'decimal.js/decimal';
 
 /** the populateLUTIxs should be executed in a separate transaction as we cannot create and populate a lookup table in the same tx */
@@ -62,3 +62,17 @@ export type APYs = {
   netAPY: Decimal;
 };
 
+/**
+ * Some amount of a specific token type.
+ */
+export type TokenAmount = {
+  /**
+   * Token's mint key.
+   */
+  mint: PublicKey;
+
+  /**
+   * Amount, in lamports.
+   */
+  amount: Decimal;
+};

package/src/classes/utils.ts

@@ -332,6 +332,27 @@ export function assertNever(x: never): never {
   throw new Error('Unexpected object: ' + x);
 }
 
+export function orThrow(message: string): never {
+  throw new Error(message);
+}
+
+export function getSingleElement<T>(array: T[], message: string): T {
+  if (array.length !== 1) {
+    throw new Error(`${message} (found ${array.length})`);
+  }
+  return array[0];
+}
+
+/**
+ * Returns an integer {@link Decimal} nearest to the given one.
+ *
+ * NOTE: the `Decimal.round()` should actually be called `.trunc()` (by default, it uses floor rounding). In most cases,
+ * we prefer the traditional behavior (as `Math.round()`).
+ */
+export function roundNearest(decimal: Decimal): Decimal {
+  return decimal.toDecimalPlaces(0, Decimal.ROUND_HALF_CEIL);
+}
+
 /**
  * Fetch median slot duration in milliseconds from the last 10 epochs
  */

package/src/classes/vault.ts

@@ -316,11 +316,13 @@ export class KaminoVaultClient {
    * This method updates the vault reserve allocation cofnig for an exiting vault reserve, or adds a new reserve to the vault if it does not exist.
    * @param vault - vault to be updated
    * @param reserveAllocationConfig - new reserve allocation config
+   * @param [signer] - optional parameter to pass a different signer for the instruction. If not provided, the admin of the vault will be used
    * @returns - a struct with an instruction to update the reserve allocation and an optional list of instructions to update the lookup table for the allocation changes
    */
   async updateReserveAllocationIxs(
     vault: KaminoVault,
-    reserveAllocationConfig: ReserveAllocationConfig
+    reserveAllocationConfig: ReserveAllocationConfig,
+    signer?: PublicKey
   ): Promise<UpdateReserveAllocationIxs> {
     const vaultState: VaultState = await vault.getState(this.getConnection());
     const reserveState: Reserve = reserveAllocationConfig.getReserveState();
@@ -331,8 +333,9 @@ export class KaminoVaultClient {
       this._kaminoVaultProgramId
     );
 
+    const allocationSigner = signer ? signer : vaultState.vaultAdminAuthority;
     const updateReserveAllocationAccounts: UpdateReserveAllocationAccounts = {
-      signer: vaultState.vaultAdminAuthority,
+      signer: allocationSigner,
       vaultState: vault.address,
       baseVaultAuthority: vaultState.baseVaultAuthority,
       reserveCollateralMint: reserveState.collateral.mintPubkey,

package/src/client_kamino_manager.ts

@@ -1570,7 +1570,8 @@ function parseReserveConfigFromFile(reserveConfigFromFile: any): ReserveConfig {
     liquidationThresholdPct: reserveConfigFromFile.liquidationThresholdPct,
     minLiquidationBonusBps: reserveConfigFromFile.minLiquidationBonusBps,
     protocolLiquidationFeePct: reserveConfigFromFile.protocolLiquidationFeePct,
-    protocolTakeRatePct: reserveConfigFromFile.protocolLiquidationFeePct,
+    protocolOrderExecutionFeePct: reserveConfigFromFile.protocolOrderExecutionFeePct,
+    protocolTakeRatePct: reserveConfigFromFile.protocolTakeRatePct,
     assetTier: reserveConfigFromFile.assetTier,
     maxLiquidationBonusBps: reserveConfigFromFile.maxLiquidationBonusBps,
     badDebtLiquidationBonusBps: reserveConfigFromFile.badDebtLiquidationBonusBps,
@@ -1621,8 +1622,7 @@ function parseReserveConfigFromFile(reserveConfigFromFile: any): ReserveConfig {
     borrowLimitAgainstThisCollateralInElevationGroup: parseReserveBorrowLimitAgainstCollInEmode(reserveConfigFromFile),
     deleveragingBonusIncreaseBpsPerDay: new BN(reserveConfigFromFile.deleveragingBonusIncreaseBpsPerDay),
     reserved1: Array(1).fill(0),
-    reserved2: Array(2).fill(0),
-    reserved3: Array(8).fill(0),
+    reserved2: Array(9).fill(0),
   };
 
   return new ReserveConfig(reserveConfigFields);
@@ -1700,7 +1700,8 @@ function parseReserveConfigToFile(reserveConfig: ReserveConfig) {
     liquidationThresholdPct: reserveConfig.liquidationThresholdPct,
     minLiquidationBonusBps: reserveConfig.minLiquidationBonusBps,
     protocolLiquidationFeePct: reserveConfig.protocolLiquidationFeePct,
-    protocolTakeRatePct: reserveConfig.protocolLiquidationFeePct,
+    protocolOrderExecutionFeePct: reserveConfig.protocolOrderExecutionFeePct,
+    protocolTakeRatePct: reserveConfig.protocolTakeRatePct,
     assetTier: reserveConfig.assetTier,
     maxLiquidationBonusBps: reserveConfig.maxLiquidationBonusBps,
     badDebtLiquidationBonusBps: reserveConfig.badDebtLiquidationBonusBps,
@@ -1742,7 +1743,6 @@ function parseReserveConfigToFile(reserveConfig: ReserveConfig) {
       reserveConfig.borrowLimitAgainstThisCollateralInElevationGroup.map((entry) => entry.toString()),
     deleveragingBonusIncreaseBpsPerDay: reserveConfig.deleveragingBonusIncreaseBpsPerDay.toString(),
     reserved1: Array(2).fill(0),
-    reserved2: Array(2).fill(0),
-    reserved3: Array(8).fill(0),
+    reserved2: Array(9).fill(0),
   };
 }

package/src/idl.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.10.0",
+  "version": "1.11.0",
   "name": "kamino_lending",
   "instructions": [
     {
@@ -2900,6 +2900,38 @@
       ],
       "args": []
     },
+    {
+      "name": "setObligationOrder",
+      "accounts": [
+        {
+          "name": "owner",
+          "isMut": false,
+          "isSigner": true
+        },
+        {
+          "name": "obligation",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "lendingMarket",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "index",
+          "type": "u8"
+        },
+        {
+          "name": "order",
+          "type": {
+            "defined": "ObligationOrder"
+          }
+        }
+      ]
+    },
     {
       "name": "idlMissingTypes",
       "accounts": [
@@ -3165,8 +3197,7 @@
               "Whether the obligations on this market should be subject to auto-deleveraging after deposit",
               "or borrow limit is crossed.",
               "Besides this flag, the particular reserve's flag also needs to be enabled (logical `AND`).",
-              "**NOTE:** the manual \"target LTV\" deleveraging (enabled by the risk council for individual",
-              "obligations) is NOT affected by this flag."
+              "**NOTE:** this also affects the individual \"target LTV\" deleveraging."
             ],
             "type": "u8"
           },
@@ -3321,12 +3352,28 @@
             ],
             "type": "u64"
           },
+          {
+            "name": "obligationOrdersEnabled",
+            "docs": [
+              "Whether the obligation orders should be evaluated during liquidations."
+            ],
+            "type": "u8"
+          },
+          {
+            "name": "padding2",
+            "type": {
+              "array": [
+                "u8",
+                7
+              ]
+            }
+          },
           {
             "name": "padding1",
             "type": {
               "array": [
                 "u64",
-                170
+                169
               ]
             }
           }
@@ -3473,9 +3520,9 @@
             "type": "u8"
           },
           {
-            "name": "numOfObsoleteReserves",
+            "name": "numOfObsoleteDepositReserves",
             "docs": [
-              "The number of deprecated reserves the obligation has a deposit"
+              "The number of obsolete reserves the obligation has a deposit in"
             ],
             "type": "u8"
           },
@@ -3515,12 +3562,19 @@
             ],
             "type": "u8"
           },
+          {
+            "name": "numOfObsoleteBorrowReserves",
+            "docs": [
+              "The number of obsolete reserves the obligation has a borrow in"
+            ],
+            "type": "u8"
+          },
           {
             "name": "reserved",
             "type": {
               "array": [
                 "u8",
-                5
+                4
               ]
             }
           },
@@ -3536,12 +3590,27 @@
             ],
             "type": "u64"
           },
+          {
+            "name": "orders",
+            "docs": [
+              "Owner-defined, liquidator-executed orders applicable to this obligation.",
+              "Typical use-cases would be a stop-loss and a take-profit (possibly co-existing)."
+            ],
+            "type": {
+              "array": [
+                {
+                  "defined": "ObligationOrder"
+                },
+                2
+              ]
+            }
+          },
           {
             "name": "padding3",
             "type": {
               "array": [
                 "u64",
-                125
+                93
               ]
             }
           }
@@ -3840,7 +3909,7 @@
             "name": "UpdateFeesFlashLoanFee"
           },
           {
-            "name": "UpdateFeesReferralFeeBps"
+            "name": "DeprecatedUpdateFeesReferralFeeBps"
           },
           {
             "name": "UpdateDepositLimit"
@@ -3900,10 +3969,10 @@
             "name": "UpdateDepositWithdrawalCap"
           },
           {
-            "name": "UpdateDebtWithdrawalCapCurrentTotal"
+            "name": "DeprecatedUpdateDebtWithdrawalCapCurrentTotal"
           },
           {
-            "name": "UpdateDepositWithdrawalCapCurrentTotal"
+            "name": "DeprecatedUpdateDepositWithdrawalCapCurrentTotal"
           },
           {
             "name": "UpdateBadDebtLiquidationBonusBps"
@@ -3964,6 +4033,9 @@
           },
           {
             "name": "UpdateDeleveragingBonusIncreaseBpsPerDay"
+          },
+          {
+            "name": "UpdateProtocolOrderExecutionFee"
           }
         ]
       }
@@ -4112,6 +4184,9 @@
           },
           {
             "name": "UpdateInitialDepositAmount"
+          },
+          {
+            "name": "UpdateObligationOrdersEnabled"
           }
         ]
       }
@@ -4344,6 +4419,134 @@
         ]
       }
     },
+    {
+      "name": "ObligationOrder",
+      "docs": [
+        "A single obligation order.",
+        "See [Obligation::orders]."
+      ],
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "conditionThresholdSf",
+            "docs": [
+              "A threshold value used by the condition (scaled [Fraction]).",
+              "The exact meaning depends on the specific [Self::condition_type].",
+              "",
+              "Examples:",
+              "- when `condition_type == 2 (UserLtvBelow)`:",
+              "then a value of `0.455` here means that the order is active only when the obligation's",
+              "user LTV is less than `0.455` (i.e. < 45.5%).",
+              "- when `condition_type == 3 (DebtCollPriceRatioAbove)`:",
+              "assuming the obligation uses BTC collateral for SOL debt, then a value of `491.3` here",
+              "means that the order is active only when the BTC-SOL price is greater than `491.3` (i.e.",
+              "> 491.3 SOL per BTC)."
+            ],
+            "type": "u128"
+          },
+          {
+            "name": "opportunityParameterSf",
+            "docs": [
+              "A configuration parameter used by the opportunity (scaled [Fraction]).",
+              "The exact meaning depends on the specific [Self::opportunity_type].",
+              "",
+              "Examples:",
+              "- when `opportunity_type == 0 (DeleverageSingleDebtAmount)`:",
+              "Assuming the obligation uses BTC collateral for SOL debt, then a value of `1_234_000_000`",
+              "here means that a liquidator may repay up to 1234000000 lamports (i.e. 1.234 SOL) on this",
+              "obligation.",
+              "Note: the special value of [Fraction::MAX] is *not* allowed in this case.",
+              "- when `opportunity_type == 1 (DeleverageAllDebtAmount)`:",
+              "The only allowed value in this case is [Fraction::MAX] (to emphasize that *all* debt",
+              "should be repaid)."
+            ],
+            "type": "u128"
+          },
+          {
+            "name": "minExecutionBonusBps",
+            "docs": [
+              "A *minimum* additional fraction of collateral transferred to the liquidator, in bps.",
+              "",
+              "The minimum bonus is applied exactly when the [Self::condition_threshold_sf] is met, and",
+              "grows linearly towards the [Self::max_execution_bonus_bps].",
+              "",
+              "Example: a value of `50` here means 50bps == 0.5% bonus for an \"LTV > 65%\" order, when",
+              "executed precisely at the moment LTV exceeds 65%."
+            ],
+            "type": "u16"
+          },
+          {
+            "name": "maxExecutionBonusBps",
+            "docs": [
+              "A *maximum* additional fraction of collateral transferred to the liquidator, in bps.",
+              "",
+              "The maximum bonus is applied at the relevant \"extreme\" state of the obligation, i.e.:",
+              "- for a stop-loss condition, it is a point at which the obligation becomes liquidatable;",
+              "- for a take-profit condition, it is a point at which obligation has 0% LTV.",
+              "",
+              "In non-extreme states, the actual bonus value is interpolated linearly, starting from",
+              "[Self::min_execution_bonus_bps] (at the point specified by the order's condition).",
+              "",
+              "Example: a value of `300` here means 300bps == 3.0% bonus for a \"debt/coll price > 140\"",
+              "order, when executed at a higher price = 200, at which the obligation's LTV happens to",
+              "be equal to its liquidation LTV."
+            ],
+            "type": "u16"
+          },
+          {
+            "name": "conditionType",
+            "docs": [
+              "Serialized [ConditionType].",
+              "The entire order is void when this is zeroed (i.e. representing [ConditionType::Never]).",
+              "",
+              "Example: a value of `2` here denotes `UserLtvBelow` condition type. Of course, to",
+              "interpret this condition, we also need to take the [Self::condition_threshold_sf] into",
+              "account."
+            ],
+            "type": "u8"
+          },
+          {
+            "name": "opportunityType",
+            "docs": [
+              "Serialized [OpportunityType].",
+              "",
+              "Example: a value of `0` here denotes `DeleverageSingleDebtAmount` opportunity. Of course, to",
+              "interpret this opportunity, we also need to take the [Self::opportunity_parameter_sf] into",
+              "account."
+            ],
+            "type": "u8"
+          },
+          {
+            "name": "padding1",
+            "docs": [
+              "Internal 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."
+            ],
+            "type": {
+              "array": [
+                "u8",
+                10
+              ]
+            }
+          },
+          {
+            "name": "padding2",
+            "docs": [
+              "End padding.",
+              "The total size of a single instance is 8*u128 = 128 bytes."
+            ],
+            "type": {
+              "array": [
+                "u128",
+                5
+              ]
+            }
+          }
+        ]
+      }
+    },
     {
       "name": "AssetTier",
       "type": {
@@ -4486,26 +4689,24 @@
           {
             "name": "reserved2",
             "docs": [
-              "[DEPRECATED] Boost for side (debt or collateral)"
+              "[DEPRECATED] Space that used to hold 2 fields:",
+              "- Boost for side (debt or collateral)",
+              "- Reward points multiplier per obligation type",
+              "Can be re-used after making sure all underlying production account data is zeroed."
             ],
             "type": {
               "array": [
                 "u8",
-                2
+                9
               ]
             }
           },
           {
-            "name": "reserved3",
+            "name": "protocolOrderExecutionFeePct",
             "docs": [
-              "[DEPRECATED] Reward points multiplier per obligation type"
+              "Cut of the order execution bonus that the protocol receives, as a percentage"
             ],
-            "type": {
-              "array": [
-                "u8",
-                8
-              ]
-            }
+            "type": "u8"
           },
           {
             "name": "protocolTakeRatePct",
@@ -5619,8 +5820,8 @@
     },
     {
       "code": 6084,
-      "name": "ObligationInDeprecatedReserve",
-      "msg": "Obligation has a deposit in a deprecated reserve"
+      "name": "ObligationInObsoleteReserve",
+      "msg": "Obligation has a deposit or borrow in an obsolete reserve"
     },
     {
       "code": 6085,
@@ -5811,6 +6012,26 @@
       "code": 6122,
       "name": "InsufficientRepayAmount",
       "msg": "Liquidator provided repay amount lower than required by liquidation rules"
+    },
+    {
+      "code": 6123,
+      "name": "OrderIndexOutOfBounds",
+      "msg": "Obligation order of the given index cannot exist"
+    },
+    {
+      "code": 6124,
+      "name": "InvalidOrderConfiguration",
+      "msg": "Given order configuration has wrong parameters"
+    },
+    {
+      "code": 6125,
+      "name": "OrderConfigurationNotSupportedByObligation",
+      "msg": "Given order configuration cannot be used with the current state of the obligation"
+    },
+    {
+      "code": 6126,
+      "name": "OperationNotPermittedWithCurrentObligationOrders",
+      "msg": "Single debt, single collateral obligation orders have to be cancelled before changing the deposit/borrow count"
     }
   ]
 }

package/src/idl_codegen/accounts/LendingMarket.ts

@@ -25,8 +25,7 @@ export interface LendingMarketFields {
    * Whether the obligations on this market should be subject to auto-deleveraging after deposit
    * or borrow limit is crossed.
    * Besides this flag, the particular reserve's flag also needs to be enabled (logical `AND`).
-   * **NOTE:** the manual "target LTV" deleveraging (enabled by the risk council for individual
-   * obligations) is NOT affected by this flag.
+   * **NOTE:** this also affects the individual "target LTV" deleveraging.
    */
   autodeleverageEnabled: number
   borrowDisabled: number
@@ -73,6 +72,9 @@ export interface LendingMarketFields {
    * Note: this amount cannot be recovered, the ctoken associated are never minted
    */
   minInitialDepositAmount: BN
+  /** Whether the obligation orders should be evaluated during liquidations. */
+  obligationOrdersEnabled: number
+  padding2: Array<number>
   padding1: Array<BN>
 }
 
@@ -97,8 +99,7 @@ export interface LendingMarketJSON {
    * Whether the obligations on this market should be subject to auto-deleveraging after deposit
    * or borrow limit is crossed.
    * Besides this flag, the particular reserve's flag also needs to be enabled (logical `AND`).
-   * **NOTE:** the manual "target LTV" deleveraging (enabled by the risk council for individual
-   * obligations) is NOT affected by this flag.
+   * **NOTE:** this also affects the individual "target LTV" deleveraging.
    */
   autodeleverageEnabled: number
   borrowDisabled: number
@@ -145,6 +146,9 @@ export interface LendingMarketJSON {
    * Note: this amount cannot be recovered, the ctoken associated are never minted
    */
   minInitialDepositAmount: string
+  /** Whether the obligation orders should be evaluated during liquidations. */
+  obligationOrdersEnabled: number
+  padding2: Array<number>
   padding1: Array<string>
 }
 
@@ -169,8 +173,7 @@ export class LendingMarket {
    * Whether the obligations on this market should be subject to auto-deleveraging after deposit
    * or borrow limit is crossed.
    * Besides this flag, the particular reserve's flag also needs to be enabled (logical `AND`).
-   * **NOTE:** the manual "target LTV" deleveraging (enabled by the risk council for individual
-   * obligations) is NOT affected by this flag.
+   * **NOTE:** this also affects the individual "target LTV" deleveraging.
    */
   readonly autodeleverageEnabled: number
   readonly borrowDisabled: number
@@ -217,6 +220,9 @@ export class LendingMarket {
    * Note: this amount cannot be recovered, the ctoken associated are never minted
    */
   readonly minInitialDepositAmount: BN
+  /** Whether the obligation orders should be evaluated during liquidations. */
+  readonly obligationOrdersEnabled: number
+  readonly padding2: Array<number>
   readonly padding1: Array<BN>
 
   static readonly discriminator = Buffer.from([
@@ -250,7 +256,9 @@ export class LendingMarket {
     borsh.u64("minValueSkipLiquidationBfChecks"),
     borsh.u64("individualAutodeleverageMarginCallPeriodSecs"),
     borsh.u64("minInitialDepositAmount"),
-    borsh.array(borsh.u64(), 170, "padding1"),
+    borsh.u8("obligationOrdersEnabled"),
+    borsh.array(borsh.u8(), 7, "padding2"),
+    borsh.array(borsh.u64(), 169, "padding1"),
   ])
 
   constructor(fields: LendingMarketFields) {
@@ -288,6 +296,8 @@ export class LendingMarket {
     this.individualAutodeleverageMarginCallPeriodSecs =
       fields.individualAutodeleverageMarginCallPeriodSecs
     this.minInitialDepositAmount = fields.minInitialDepositAmount
+    this.obligationOrdersEnabled = fields.obligationOrdersEnabled
+    this.padding2 = fields.padding2
     this.padding1 = fields.padding1
   }
 
@@ -367,6 +377,8 @@ export class LendingMarket {
       individualAutodeleverageMarginCallPeriodSecs:
         dec.individualAutodeleverageMarginCallPeriodSecs,
       minInitialDepositAmount: dec.minInitialDepositAmount,
+      obligationOrdersEnabled: dec.obligationOrdersEnabled,
+      padding2: dec.padding2,
       padding1: dec.padding1,
     })
   }
@@ -406,6 +418,8 @@ export class LendingMarket {
       individualAutodeleverageMarginCallPeriodSecs:
         this.individualAutodeleverageMarginCallPeriodSecs.toString(),
       minInitialDepositAmount: this.minInitialDepositAmount.toString(),
+      obligationOrdersEnabled: this.obligationOrdersEnabled,
+      padding2: this.padding2,
       padding1: this.padding1.map((item) => item.toString()),
     }
   }
@@ -452,6 +466,8 @@ export class LendingMarket {
         obj.individualAutodeleverageMarginCallPeriodSecs
       ),
       minInitialDepositAmount: new BN(obj.minInitialDepositAmount),
+      obligationOrdersEnabled: obj.obligationOrdersEnabled,
+      padding2: obj.padding2,
       padding1: obj.padding1.map((item) => new BN(item)),
     })
   }