@kamino-finance/klend-sdk/src/@codegen/klend/types/ObligationLiquidity.ts

Typescript SDK for interacting with the Kamino Lending (klend) protocol

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
  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
  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
  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.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"),
        borsh.array(borsh.u64(), 7, "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,
      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,
      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(),
      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
      ),
      padding2: obj.padding2.map((item) => new BN(item)),
    })
  }

  toEncodable() {
    return ObligationLiquidity.toEncodable(this)
  }
}