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

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

@@ -8,16 +8,18 @@ export interface ReserveConfigFields {
   /** Status of the reserve Active/Obsolete/Hidden */
   status: number
   /** Asset tier -> 0 - regular (collateral & debt), 1 - isolated collateral, 2 - isolated debt */
-  assetTier: number
+  paddingDeprecatedAssetTier: number
   /** Flat rate that goes to the host */
   hostFixedInterestRateBps: number
+  /** Starting bonus for deleveraging-related liquidations, in bps. */
+  minDeleveragingBonusBps: number
   /**
-   * [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.
+   * Boolean flag indicating whether the reserve can be used in the close lst position process.
+   * See handler_unstake_lst_collateral_start.rs for more information.
    */
-  reserved2: Array<number>
+  canUnstakeLstCollateral: number
+  /** Past reserved space - feel free to reuse. */
+  reserved1: Array<number>
   /** Cut of the order execution bonus that the protocol receives, as a percentage */
   protocolOrderExecutionFeePct: number
   /** Protocol take rate is the amount borrowed interest protocol receives, as a percentage */
@@ -76,7 +78,14 @@ export interface ReserveConfigFields {
    * obligations) is NOT affected by this flag.
    */
   autodeleverageEnabled: number
-  reserved1: Array<number>
+  /**
+   * Boolean flag indicating whether the reserve is locked for the proposer authority.
+   *
+   * Once the proposer have finished preparing the reserve, it must be locked to prevent
+   * further changes to the reserve configuration allowing review and voting on the proposal
+   * without alteration during the voting period.
+   */
+  proposerAuthorityLocked: number
   /**
    * Maximum amount liquidity of this reserve borrowed outside all elevation groups
    * - u64::MAX for inf
@@ -95,22 +104,49 @@ export interface ReserveConfigFields {
    * Only relevant when `autodeleverage_enabled == 1`, and must not be 0 in such case.
    */
   deleveragingBonusIncreaseBpsPerDay: BN
+  /**
+   * The timestamp at which all [Obligation::borrows] using this reserve become liquidatable
+   * (on the same terms as reserve-wide deleveraging).
+   * Inactive when zeroed (i.e. debt never matures).
+   *
+   * Note: this feature is independent of [Self::debt_term_seconds] - the liquidation mechanism
+   * is based directly on the timestamp defined here, on Reserve's level.
+   */
+  debtMaturityTimestamp: BN
+  /**
+   * The duration after which any debt coming from this Reserve must be repaid.
+   * Inactive when zeroed (i.e. funds can be borrowed indefinitely).
+   *
+   * Note: this feature is independent of [Self::debt_maturity_timestamp] - the liquidation
+   * mechanism is based on the [ObligationLiquidity::first_borrowed_at_timestamp].
+   */
+  debtTermSeconds: BN
+  /**
+   * Maximum number of lamports that can differ when comparing LTVs.
+   *
+   * For example, when doing deposit_and_withdraw we want to make sure that new_ltv <= old_ltv
+   * but for some tokens we want to have a little bit of margin in terms of lamports deposited.
+   * This is recommended to be 0 for most (if not all) reserves.
+   */
+  ltvLamportsMargin: BN
 }
 
 export interface ReserveConfigJSON {
   /** Status of the reserve Active/Obsolete/Hidden */
   status: number
   /** Asset tier -> 0 - regular (collateral & debt), 1 - isolated collateral, 2 - isolated debt */
-  assetTier: number
+  paddingDeprecatedAssetTier: number
   /** Flat rate that goes to the host */
   hostFixedInterestRateBps: number
+  /** Starting bonus for deleveraging-related liquidations, in bps. */
+  minDeleveragingBonusBps: number
   /**
-   * [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.
+   * Boolean flag indicating whether the reserve can be used in the close lst position process.
+   * See handler_unstake_lst_collateral_start.rs for more information.
    */
-  reserved2: Array<number>
+  canUnstakeLstCollateral: number
+  /** Past reserved space - feel free to reuse. */
+  reserved1: Array<number>
   /** Cut of the order execution bonus that the protocol receives, as a percentage */
   protocolOrderExecutionFeePct: number
   /** Protocol take rate is the amount borrowed interest protocol receives, as a percentage */
@@ -169,7 +205,14 @@ export interface ReserveConfigJSON {
    * obligations) is NOT affected by this flag.
    */
   autodeleverageEnabled: number
-  reserved1: Array<number>
+  /**
+   * Boolean flag indicating whether the reserve is locked for the proposer authority.
+   *
+   * Once the proposer have finished preparing the reserve, it must be locked to prevent
+   * further changes to the reserve configuration allowing review and voting on the proposal
+   * without alteration during the voting period.
+   */
+  proposerAuthorityLocked: number
   /**
    * Maximum amount liquidity of this reserve borrowed outside all elevation groups
    * - u64::MAX for inf
@@ -188,6 +231,31 @@ export interface ReserveConfigJSON {
    * Only relevant when `autodeleverage_enabled == 1`, and must not be 0 in such case.
    */
   deleveragingBonusIncreaseBpsPerDay: string
+  /**
+   * The timestamp at which all [Obligation::borrows] using this reserve become liquidatable
+   * (on the same terms as reserve-wide deleveraging).
+   * Inactive when zeroed (i.e. debt never matures).
+   *
+   * Note: this feature is independent of [Self::debt_term_seconds] - the liquidation mechanism
+   * is based directly on the timestamp defined here, on Reserve's level.
+   */
+  debtMaturityTimestamp: string
+  /**
+   * The duration after which any debt coming from this Reserve must be repaid.
+   * Inactive when zeroed (i.e. funds can be borrowed indefinitely).
+   *
+   * Note: this feature is independent of [Self::debt_maturity_timestamp] - the liquidation
+   * mechanism is based on the [ObligationLiquidity::first_borrowed_at_timestamp].
+   */
+  debtTermSeconds: string
+  /**
+   * Maximum number of lamports that can differ when comparing LTVs.
+   *
+   * For example, when doing deposit_and_withdraw we want to make sure that new_ltv <= old_ltv
+   * but for some tokens we want to have a little bit of margin in terms of lamports deposited.
+   * This is recommended to be 0 for most (if not all) reserves.
+   */
+  ltvLamportsMargin: string
 }
 
 /** Reserve configuration values */
@@ -195,16 +263,18 @@ export class ReserveConfig {
   /** Status of the reserve Active/Obsolete/Hidden */
   readonly status: number
   /** Asset tier -> 0 - regular (collateral & debt), 1 - isolated collateral, 2 - isolated debt */
-  readonly assetTier: number
+  readonly paddingDeprecatedAssetTier: number
   /** Flat rate that goes to the host */
   readonly hostFixedInterestRateBps: number
+  /** Starting bonus for deleveraging-related liquidations, in bps. */
+  readonly minDeleveragingBonusBps: number
   /**
-   * [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.
+   * Boolean flag indicating whether the reserve can be used in the close lst position process.
+   * See handler_unstake_lst_collateral_start.rs for more information.
    */
-  readonly reserved2: Array<number>
+  readonly canUnstakeLstCollateral: number
+  /** Past reserved space - feel free to reuse. */
+  readonly reserved1: Array<number>
   /** Cut of the order execution bonus that the protocol receives, as a percentage */
   readonly protocolOrderExecutionFeePct: number
   /** Protocol take rate is the amount borrowed interest protocol receives, as a percentage */
@@ -263,7 +333,14 @@ export class ReserveConfig {
    * obligations) is NOT affected by this flag.
    */
   readonly autodeleverageEnabled: number
-  readonly reserved1: Array<number>
+  /**
+   * Boolean flag indicating whether the reserve is locked for the proposer authority.
+   *
+   * Once the proposer have finished preparing the reserve, it must be locked to prevent
+   * further changes to the reserve configuration allowing review and voting on the proposal
+   * without alteration during the voting period.
+   */
+  readonly proposerAuthorityLocked: number
   /**
    * Maximum amount liquidity of this reserve borrowed outside all elevation groups
    * - u64::MAX for inf
@@ -282,12 +359,39 @@ export class ReserveConfig {
    * Only relevant when `autodeleverage_enabled == 1`, and must not be 0 in such case.
    */
   readonly deleveragingBonusIncreaseBpsPerDay: BN
+  /**
+   * The timestamp at which all [Obligation::borrows] using this reserve become liquidatable
+   * (on the same terms as reserve-wide deleveraging).
+   * Inactive when zeroed (i.e. debt never matures).
+   *
+   * Note: this feature is independent of [Self::debt_term_seconds] - the liquidation mechanism
+   * is based directly on the timestamp defined here, on Reserve's level.
+   */
+  readonly debtMaturityTimestamp: BN
+  /**
+   * The duration after which any debt coming from this Reserve must be repaid.
+   * Inactive when zeroed (i.e. funds can be borrowed indefinitely).
+   *
+   * Note: this feature is independent of [Self::debt_maturity_timestamp] - the liquidation
+   * mechanism is based on the [ObligationLiquidity::first_borrowed_at_timestamp].
+   */
+  readonly debtTermSeconds: BN
+  /**
+   * Maximum number of lamports that can differ when comparing LTVs.
+   *
+   * For example, when doing deposit_and_withdraw we want to make sure that new_ltv <= old_ltv
+   * but for some tokens we want to have a little bit of margin in terms of lamports deposited.
+   * This is recommended to be 0 for most (if not all) reserves.
+   */
+  readonly ltvLamportsMargin: BN
 
   constructor(fields: ReserveConfigFields) {
     this.status = fields.status
-    this.assetTier = fields.assetTier
+    this.paddingDeprecatedAssetTier = fields.paddingDeprecatedAssetTier
     this.hostFixedInterestRateBps = fields.hostFixedInterestRateBps
-    this.reserved2 = fields.reserved2
+    this.minDeleveragingBonusBps = fields.minDeleveragingBonusBps
+    this.canUnstakeLstCollateral = fields.canUnstakeLstCollateral
+    this.reserved1 = fields.reserved1
     this.protocolOrderExecutionFeePct = fields.protocolOrderExecutionFeePct
     this.protocolTakeRatePct = fields.protocolTakeRatePct
     this.protocolLiquidationFeePct = fields.protocolLiquidationFeePct
@@ -319,22 +423,27 @@ export class ReserveConfig {
     this.utilizationLimitBlockBorrowingAbovePct =
       fields.utilizationLimitBlockBorrowingAbovePct
     this.autodeleverageEnabled = fields.autodeleverageEnabled
-    this.reserved1 = fields.reserved1
+    this.proposerAuthorityLocked = fields.proposerAuthorityLocked
     this.borrowLimitOutsideElevationGroup =
       fields.borrowLimitOutsideElevationGroup
     this.borrowLimitAgainstThisCollateralInElevationGroup =
       fields.borrowLimitAgainstThisCollateralInElevationGroup
     this.deleveragingBonusIncreaseBpsPerDay =
       fields.deleveragingBonusIncreaseBpsPerDay
+    this.debtMaturityTimestamp = fields.debtMaturityTimestamp
+    this.debtTermSeconds = fields.debtTermSeconds
+    this.ltvLamportsMargin = fields.ltvLamportsMargin
   }
 
   static layout(property?: string) {
     return borsh.struct(
       [
         borsh.u8("status"),
-        borsh.u8("assetTier"),
+        borsh.u8("paddingDeprecatedAssetTier"),
         borsh.u16("hostFixedInterestRateBps"),
-        borsh.array(borsh.u8(), 9, "reserved2"),
+        borsh.u16("minDeleveragingBonusBps"),
+        borsh.u8("canUnstakeLstCollateral"),
+        borsh.array(borsh.u8(), 6, "reserved1"),
         borsh.u8("protocolOrderExecutionFeePct"),
         borsh.u8("protocolTakeRatePct"),
         borsh.u8("protocolLiquidationFeePct"),
@@ -357,7 +466,7 @@ export class ReserveConfig {
         borsh.u8("disableUsageAsCollOutsideEmode"),
         borsh.u8("utilizationLimitBlockBorrowingAbovePct"),
         borsh.u8("autodeleverageEnabled"),
-        borsh.array(borsh.u8(), 1, "reserved1"),
+        borsh.u8("proposerAuthorityLocked"),
         borsh.u64("borrowLimitOutsideElevationGroup"),
         borsh.array(
           borsh.u64(),
@@ -365,6 +474,9 @@ export class ReserveConfig {
           "borrowLimitAgainstThisCollateralInElevationGroup"
         ),
         borsh.u64("deleveragingBonusIncreaseBpsPerDay"),
+        borsh.u64("debtMaturityTimestamp"),
+        borsh.u64("debtTermSeconds"),
+        borsh.u64("ltvLamportsMargin"),
       ],
       property
     )
@@ -374,9 +486,11 @@ export class ReserveConfig {
   static fromDecoded(obj: any) {
     return new ReserveConfig({
       status: obj.status,
-      assetTier: obj.assetTier,
+      paddingDeprecatedAssetTier: obj.paddingDeprecatedAssetTier,
       hostFixedInterestRateBps: obj.hostFixedInterestRateBps,
-      reserved2: obj.reserved2,
+      minDeleveragingBonusBps: obj.minDeleveragingBonusBps,
+      canUnstakeLstCollateral: obj.canUnstakeLstCollateral,
+      reserved1: obj.reserved1,
       protocolOrderExecutionFeePct: obj.protocolOrderExecutionFeePct,
       protocolTakeRatePct: obj.protocolTakeRatePct,
       protocolLiquidationFeePct: obj.protocolLiquidationFeePct,
@@ -405,21 +519,26 @@ export class ReserveConfig {
       utilizationLimitBlockBorrowingAbovePct:
         obj.utilizationLimitBlockBorrowingAbovePct,
       autodeleverageEnabled: obj.autodeleverageEnabled,
-      reserved1: obj.reserved1,
+      proposerAuthorityLocked: obj.proposerAuthorityLocked,
       borrowLimitOutsideElevationGroup: obj.borrowLimitOutsideElevationGroup,
       borrowLimitAgainstThisCollateralInElevationGroup:
         obj.borrowLimitAgainstThisCollateralInElevationGroup,
       deleveragingBonusIncreaseBpsPerDay:
         obj.deleveragingBonusIncreaseBpsPerDay,
+      debtMaturityTimestamp: obj.debtMaturityTimestamp,
+      debtTermSeconds: obj.debtTermSeconds,
+      ltvLamportsMargin: obj.ltvLamportsMargin,
     })
   }
 
   static toEncodable(fields: ReserveConfigFields) {
     return {
       status: fields.status,
-      assetTier: fields.assetTier,
+      paddingDeprecatedAssetTier: fields.paddingDeprecatedAssetTier,
       hostFixedInterestRateBps: fields.hostFixedInterestRateBps,
-      reserved2: fields.reserved2,
+      minDeleveragingBonusBps: fields.minDeleveragingBonusBps,
+      canUnstakeLstCollateral: fields.canUnstakeLstCollateral,
+      reserved1: fields.reserved1,
       protocolOrderExecutionFeePct: fields.protocolOrderExecutionFeePct,
       protocolTakeRatePct: fields.protocolTakeRatePct,
       protocolLiquidationFeePct: fields.protocolLiquidationFeePct,
@@ -450,21 +569,26 @@ export class ReserveConfig {
       utilizationLimitBlockBorrowingAbovePct:
         fields.utilizationLimitBlockBorrowingAbovePct,
       autodeleverageEnabled: fields.autodeleverageEnabled,
-      reserved1: fields.reserved1,
+      proposerAuthorityLocked: fields.proposerAuthorityLocked,
       borrowLimitOutsideElevationGroup: fields.borrowLimitOutsideElevationGroup,
       borrowLimitAgainstThisCollateralInElevationGroup:
         fields.borrowLimitAgainstThisCollateralInElevationGroup,
       deleveragingBonusIncreaseBpsPerDay:
         fields.deleveragingBonusIncreaseBpsPerDay,
+      debtMaturityTimestamp: fields.debtMaturityTimestamp,
+      debtTermSeconds: fields.debtTermSeconds,
+      ltvLamportsMargin: fields.ltvLamportsMargin,
     }
   }
 
   toJSON(): ReserveConfigJSON {
     return {
       status: this.status,
-      assetTier: this.assetTier,
+      paddingDeprecatedAssetTier: this.paddingDeprecatedAssetTier,
       hostFixedInterestRateBps: this.hostFixedInterestRateBps,
-      reserved2: this.reserved2,
+      minDeleveragingBonusBps: this.minDeleveragingBonusBps,
+      canUnstakeLstCollateral: this.canUnstakeLstCollateral,
+      reserved1: this.reserved1,
       protocolOrderExecutionFeePct: this.protocolOrderExecutionFeePct,
       protocolTakeRatePct: this.protocolTakeRatePct,
       protocolLiquidationFeePct: this.protocolLiquidationFeePct,
@@ -490,7 +614,7 @@ export class ReserveConfig {
       utilizationLimitBlockBorrowingAbovePct:
         this.utilizationLimitBlockBorrowingAbovePct,
       autodeleverageEnabled: this.autodeleverageEnabled,
-      reserved1: this.reserved1,
+      proposerAuthorityLocked: this.proposerAuthorityLocked,
       borrowLimitOutsideElevationGroup:
         this.borrowLimitOutsideElevationGroup.toString(),
       borrowLimitAgainstThisCollateralInElevationGroup:
@@ -499,15 +623,20 @@ export class ReserveConfig {
         ),
       deleveragingBonusIncreaseBpsPerDay:
         this.deleveragingBonusIncreaseBpsPerDay.toString(),
+      debtMaturityTimestamp: this.debtMaturityTimestamp.toString(),
+      debtTermSeconds: this.debtTermSeconds.toString(),
+      ltvLamportsMargin: this.ltvLamportsMargin.toString(),
     }
   }
 
   static fromJSON(obj: ReserveConfigJSON): ReserveConfig {
     return new ReserveConfig({
       status: obj.status,
-      assetTier: obj.assetTier,
+      paddingDeprecatedAssetTier: obj.paddingDeprecatedAssetTier,
       hostFixedInterestRateBps: obj.hostFixedInterestRateBps,
-      reserved2: obj.reserved2,
+      minDeleveragingBonusBps: obj.minDeleveragingBonusBps,
+      canUnstakeLstCollateral: obj.canUnstakeLstCollateral,
+      reserved1: obj.reserved1,
       protocolOrderExecutionFeePct: obj.protocolOrderExecutionFeePct,
       protocolTakeRatePct: obj.protocolTakeRatePct,
       protocolLiquidationFeePct: obj.protocolLiquidationFeePct,
@@ -537,7 +666,7 @@ export class ReserveConfig {
       utilizationLimitBlockBorrowingAbovePct:
         obj.utilizationLimitBlockBorrowingAbovePct,
       autodeleverageEnabled: obj.autodeleverageEnabled,
-      reserved1: obj.reserved1,
+      proposerAuthorityLocked: obj.proposerAuthorityLocked,
       borrowLimitOutsideElevationGroup: new BN(
         obj.borrowLimitOutsideElevationGroup
       ),
@@ -548,6 +677,9 @@ export class ReserveConfig {
       deleveragingBonusIncreaseBpsPerDay: new BN(
         obj.deleveragingBonusIncreaseBpsPerDay
       ),
+      debtMaturityTimestamp: new BN(obj.debtMaturityTimestamp),
+      debtTermSeconds: new BN(obj.debtTermSeconds),
+      ltvLamportsMargin: new BN(obj.ltvLamportsMargin),
     })
   }
 

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

@@ -11,9 +11,9 @@ export interface ReserveFeesFields {
    * clarity:
    * 1% = (1 << 60) / 100 = 11529215046068470
    * 0.01% (1 basis point) = 115292150460685
-   * 0.00001% (Aave borrow fee) = 115292150461
+   * 0.00001% (Aave origination fee) = 115292150461
    */
-  borrowFeeSf: BN
+  originationFeeSf: BN
   /**
    * Fee for flash loan, expressed as scaled fraction.
    * 0.3% (Aave flash loan fee) = 0.003 * 2^60 = 3458764513820541
@@ -30,9 +30,9 @@ export interface ReserveFeesJSON {
    * clarity:
    * 1% = (1 << 60) / 100 = 11529215046068470
    * 0.01% (1 basis point) = 115292150460685
-   * 0.00001% (Aave borrow fee) = 115292150461
+   * 0.00001% (Aave origination fee) = 115292150461
    */
-  borrowFeeSf: string
+  originationFeeSf: string
   /**
    * Fee for flash loan, expressed as scaled fraction.
    * 0.3% (Aave flash loan fee) = 0.003 * 2^60 = 3458764513820541
@@ -56,9 +56,9 @@ export class ReserveFees {
    * clarity:
    * 1% = (1 << 60) / 100 = 11529215046068470
    * 0.01% (1 basis point) = 115292150460685
-   * 0.00001% (Aave borrow fee) = 115292150461
+   * 0.00001% (Aave origination fee) = 115292150461
    */
-  readonly borrowFeeSf: BN
+  readonly originationFeeSf: BN
   /**
    * Fee for flash loan, expressed as scaled fraction.
    * 0.3% (Aave flash loan fee) = 0.003 * 2^60 = 3458764513820541
@@ -68,7 +68,7 @@ export class ReserveFees {
   readonly padding: Array<number>
 
   constructor(fields: ReserveFeesFields) {
-    this.borrowFeeSf = fields.borrowFeeSf
+    this.originationFeeSf = fields.originationFeeSf
     this.flashLoanFeeSf = fields.flashLoanFeeSf
     this.padding = fields.padding
   }
@@ -76,7 +76,7 @@ export class ReserveFees {
   static layout(property?: string) {
     return borsh.struct(
       [
-        borsh.u64("borrowFeeSf"),
+        borsh.u64("originationFeeSf"),
         borsh.u64("flashLoanFeeSf"),
         borsh.array(borsh.u8(), 8, "padding"),
       ],
@@ -87,7 +87,7 @@ export class ReserveFees {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   static fromDecoded(obj: any) {
     return new ReserveFees({
-      borrowFeeSf: obj.borrowFeeSf,
+      originationFeeSf: obj.originationFeeSf,
       flashLoanFeeSf: obj.flashLoanFeeSf,
       padding: obj.padding,
     })
@@ -95,7 +95,7 @@ export class ReserveFees {
 
   static toEncodable(fields: ReserveFeesFields) {
     return {
-      borrowFeeSf: fields.borrowFeeSf,
+      originationFeeSf: fields.originationFeeSf,
       flashLoanFeeSf: fields.flashLoanFeeSf,
       padding: fields.padding,
     }
@@ -103,7 +103,7 @@ export class ReserveFees {
 
   toJSON(): ReserveFeesJSON {
     return {
-      borrowFeeSf: this.borrowFeeSf.toString(),
+      originationFeeSf: this.originationFeeSf.toString(),
       flashLoanFeeSf: this.flashLoanFeeSf.toString(),
       padding: this.padding,
     }
@@ -111,7 +111,7 @@ export class ReserveFees {
 
   static fromJSON(obj: ReserveFeesJSON): ReserveFees {
     return new ReserveFees({
-      borrowFeeSf: new BN(obj.borrowFeeSf),
+      originationFeeSf: new BN(obj.originationFeeSf),
       flashLoanFeeSf: new BN(obj.flashLoanFeeSf),
       padding: obj.padding,
     })

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),