@kamino-finance/klend-sdk 7.4.0-beta.0 → 7.4.0-beta.2

package/src/@codegen/kvault/types/ObligationCollateral.ts

@@ -0,0 +1,129 @@
+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 ObligationCollateralFields {
+  /** Reserve collateral is deposited to */
+  depositReserve: Address
+  /** Amount of collateral deposited */
+  depositedAmount: BN
+  /** Collateral market value in quote currency (scaled fraction) */
+  marketValueSf: BN
+  /**
+   * Debt amount (lamport) taken against this collateral.
+   * (only meaningful if this obligation is part of an elevation group, otherwise 0)
+   * This is only indicative of the debt computed on the last refresh obligation.
+   * If the obligation have multiple collateral this value is the same for all of them.
+   */
+  borrowedAmountAgainstThisCollateralInElevationGroup: BN
+  padding: Array<BN>
+}
+
+export interface ObligationCollateralJSON {
+  /** Reserve collateral is deposited to */
+  depositReserve: string
+  /** Amount of collateral deposited */
+  depositedAmount: string
+  /** Collateral market value in quote currency (scaled fraction) */
+  marketValueSf: string
+  /**
+   * Debt amount (lamport) taken against this collateral.
+   * (only meaningful if this obligation is part of an elevation group, otherwise 0)
+   * This is only indicative of the debt computed on the last refresh obligation.
+   * If the obligation have multiple collateral this value is the same for all of them.
+   */
+  borrowedAmountAgainstThisCollateralInElevationGroup: string
+  padding: Array<string>
+}
+
+/** Obligation collateral state */
+export class ObligationCollateral {
+  /** Reserve collateral is deposited to */
+  readonly depositReserve: Address
+  /** Amount of collateral deposited */
+  readonly depositedAmount: BN
+  /** Collateral market value in quote currency (scaled fraction) */
+  readonly marketValueSf: BN
+  /**
+   * Debt amount (lamport) taken against this collateral.
+   * (only meaningful if this obligation is part of an elevation group, otherwise 0)
+   * This is only indicative of the debt computed on the last refresh obligation.
+   * If the obligation have multiple collateral this value is the same for all of them.
+   */
+  readonly borrowedAmountAgainstThisCollateralInElevationGroup: BN
+  readonly padding: Array<BN>
+
+  constructor(fields: ObligationCollateralFields) {
+    this.depositReserve = fields.depositReserve
+    this.depositedAmount = fields.depositedAmount
+    this.marketValueSf = fields.marketValueSf
+    this.borrowedAmountAgainstThisCollateralInElevationGroup =
+      fields.borrowedAmountAgainstThisCollateralInElevationGroup
+    this.padding = fields.padding
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borshAddress("depositReserve"),
+        borsh.u64("depositedAmount"),
+        borsh.u128("marketValueSf"),
+        borsh.u64("borrowedAmountAgainstThisCollateralInElevationGroup"),
+        borsh.array(borsh.u64(), 9, "padding"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new ObligationCollateral({
+      depositReserve: obj.depositReserve,
+      depositedAmount: obj.depositedAmount,
+      marketValueSf: obj.marketValueSf,
+      borrowedAmountAgainstThisCollateralInElevationGroup:
+        obj.borrowedAmountAgainstThisCollateralInElevationGroup,
+      padding: obj.padding,
+    })
+  }
+
+  static toEncodable(fields: ObligationCollateralFields) {
+    return {
+      depositReserve: fields.depositReserve,
+      depositedAmount: fields.depositedAmount,
+      marketValueSf: fields.marketValueSf,
+      borrowedAmountAgainstThisCollateralInElevationGroup:
+        fields.borrowedAmountAgainstThisCollateralInElevationGroup,
+      padding: fields.padding,
+    }
+  }
+
+  toJSON(): ObligationCollateralJSON {
+    return {
+      depositReserve: this.depositReserve,
+      depositedAmount: this.depositedAmount.toString(),
+      marketValueSf: this.marketValueSf.toString(),
+      borrowedAmountAgainstThisCollateralInElevationGroup:
+        this.borrowedAmountAgainstThisCollateralInElevationGroup.toString(),
+      padding: this.padding.map((item) => item.toString()),
+    }
+  }
+
+  static fromJSON(obj: ObligationCollateralJSON): ObligationCollateral {
+    return new ObligationCollateral({
+      depositReserve: address(obj.depositReserve),
+      depositedAmount: new BN(obj.depositedAmount),
+      marketValueSf: new BN(obj.marketValueSf),
+      borrowedAmountAgainstThisCollateralInElevationGroup: new BN(
+        obj.borrowedAmountAgainstThisCollateralInElevationGroup
+      ),
+      padding: obj.padding.map((item) => new BN(item)),
+    })
+  }
+
+  toEncodable() {
+    return ObligationCollateral.toEncodable(this)
+  }
+}

package/src/@codegen/kvault/types/ObligationLiquidity.ts

@@ -0,0 +1,226 @@
+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 ObligationLiquidityFields {
+  /** Reserve liquidity is borrowed from */
+  borrowReserve: Address
+  /** Borrow rate used for calculating interest (big scaled fraction) */
+  cumulativeBorrowRateBsf: types.BigFractionBytesFields
+  /**
+   * 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) */
+  marketValueSf: BN
+  /** Risk adjusted liquidity market value in quote currency - DEBUG ONLY - use market_value instead */
+  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>
+}
+
+export interface ObligationLiquidityJSON {
+  /** Reserve liquidity is borrowed from */
+  borrowReserve: string
+  /** Borrow rate used for calculating interest (big scaled fraction) */
+  cumulativeBorrowRateBsf: types.BigFractionBytesJSON
+  /**
+   * 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) */
+  marketValueSf: string
+  /** Risk adjusted liquidity market value in quote currency - DEBUG ONLY - use market_value instead */
+  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>
+}
+
+/** Obligation liquidity state */
+export class ObligationLiquidity {
+  /** Reserve liquidity is borrowed from */
+  readonly borrowReserve: Address
+  /** Borrow rate used for calculating interest (big scaled fraction) */
+  readonly cumulativeBorrowRateBsf: types.BigFractionBytes
+  /**
+   * 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) */
+  readonly marketValueSf: BN
+  /** Risk adjusted liquidity market value in quote currency - DEBUG ONLY - use market_value instead */
+  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) {
+    this.borrowReserve = fields.borrowReserve
+    this.cumulativeBorrowRateBsf = new types.BigFractionBytes({
+      ...fields.cumulativeBorrowRateBsf,
+    })
+    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
+  }
+
+  static layout(property?: string) {
+    return borsh.struct(
+      [
+        borshAddress("borrowReserve"),
+        types.BigFractionBytes.layout("cumulativeBorrowRateBsf"),
+        borsh.u64("firstBorrowedAtTimestamp"),
+        borsh.u128("borrowedAmountSf"),
+        borsh.u128("marketValueSf"),
+        borsh.u128("borrowFactorAdjustedMarketValueSf"),
+        borsh.u64("borrowedAmountOutsideElevationGroups"),
+        types.FixedTermBorrowRolloverConfig.layout(
+          "fixedTermBorrowRolloverConfig"
+        ),
+        borsh.array(borsh.u64(), 5, "padding2"),
+      ],
+      property
+    )
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static fromDecoded(obj: any) {
+    return new ObligationLiquidity({
+      borrowReserve: obj.borrowReserve,
+      cumulativeBorrowRateBsf: types.BigFractionBytes.fromDecoded(
+        obj.cumulativeBorrowRateBsf
+      ),
+      firstBorrowedAtTimestamp: obj.firstBorrowedAtTimestamp,
+      borrowedAmountSf: obj.borrowedAmountSf,
+      marketValueSf: obj.marketValueSf,
+      borrowFactorAdjustedMarketValueSf: obj.borrowFactorAdjustedMarketValueSf,
+      borrowedAmountOutsideElevationGroups:
+        obj.borrowedAmountOutsideElevationGroups,
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.fromDecoded(
+          obj.fixedTermBorrowRolloverConfig
+        ),
+      padding2: obj.padding2,
+    })
+  }
+
+  static toEncodable(fields: ObligationLiquidityFields) {
+    return {
+      borrowReserve: fields.borrowReserve,
+      cumulativeBorrowRateBsf: types.BigFractionBytes.toEncodable(
+        fields.cumulativeBorrowRateBsf
+      ),
+      firstBorrowedAtTimestamp: fields.firstBorrowedAtTimestamp,
+      borrowedAmountSf: fields.borrowedAmountSf,
+      marketValueSf: fields.marketValueSf,
+      borrowFactorAdjustedMarketValueSf:
+        fields.borrowFactorAdjustedMarketValueSf,
+      borrowedAmountOutsideElevationGroups:
+        fields.borrowedAmountOutsideElevationGroups,
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.toEncodable(
+          fields.fixedTermBorrowRolloverConfig
+        ),
+      padding2: fields.padding2,
+    }
+  }
+
+  toJSON(): ObligationLiquidityJSON {
+    return {
+      borrowReserve: this.borrowReserve,
+      cumulativeBorrowRateBsf: this.cumulativeBorrowRateBsf.toJSON(),
+      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()),
+    }
+  }
+
+  static fromJSON(obj: ObligationLiquidityJSON): ObligationLiquidity {
+    return new ObligationLiquidity({
+      borrowReserve: address(obj.borrowReserve),
+      cumulativeBorrowRateBsf: types.BigFractionBytes.fromJSON(
+        obj.cumulativeBorrowRateBsf
+      ),
+      firstBorrowedAtTimestamp: new BN(obj.firstBorrowedAtTimestamp),
+      borrowedAmountSf: new BN(obj.borrowedAmountSf),
+      marketValueSf: new BN(obj.marketValueSf),
+      borrowFactorAdjustedMarketValueSf: new BN(
+        obj.borrowFactorAdjustedMarketValueSf
+      ),
+      borrowedAmountOutsideElevationGroups: new BN(
+        obj.borrowedAmountOutsideElevationGroups
+      ),
+      fixedTermBorrowRolloverConfig:
+        types.FixedTermBorrowRolloverConfig.fromJSON(
+          obj.fixedTermBorrowRolloverConfig
+        ),
+      padding2: obj.padding2.map((item) => new BN(item)),
+    })
+  }
+
+  toEncodable() {
+    return ObligationLiquidity.toEncodable(this)
+  }
+}