@carrot-protocol/clend-rpc 0.0.1-mrgn-fork1-dev-7be6ef2

package/src/state.ts

@@ -0,0 +1,512 @@
+import { web3, BN } from "@coral-xyz/anchor";
+import { bigNumberToWrappedI80F48 } from "./utils";
+
+/**
+ * Clend Group account interface
+ * Represents a lending pool group
+ */
+export interface ClendGroup {
+  // Pubkey (32 bytes)
+  admin: web3.PublicKey;
+  // u64 (8 bytes)
+  flags: number;
+  // Padding for future use (503 bytes)
+  padding: number[];
+}
+
+/**
+ * Bank account interface
+ * Represents a token bank within a lending pool
+ */
+export interface Bank {
+  // The pubkey of the bank
+  // not on chain
+  key: web3.PublicKey;
+
+  // The mint of the token for this bank
+  mint: web3.PublicKey;
+  // The number of decimals for the mint
+  mintDecimals: number;
+  // The clend group this bank belongs to
+  group: web3.PublicKey;
+  // The value of each asset share
+  assetShareValue: WrappedI80F48;
+  // The value of each liability share
+  liabilityShareValue: WrappedI80F48;
+  // The vault holding deposited tokens
+  liquidityVault: web3.PublicKey;
+  // The bump seed for the liquidity vault PDA
+  liquidityVaultBump: number;
+  // The bump seed for the liquidity vault authority PDA
+  liquidityVaultAuthorityBump: number;
+  // The vault holding insurance funds
+  insuranceVault: web3.PublicKey;
+  // The bump seed for the insurance vault PDA
+  insuranceVaultBump: number;
+  // The bump seed for the insurance vault authority PDA
+  insuranceVaultAuthorityBump: number;
+  // Fees collected and pending withdraw for the insurance vault
+  collectedInsuranceFeesOutstanding: WrappedI80F48;
+  // The vault holding collected fees
+  feeVault: web3.PublicKey;
+  // The bump seed for the fee vault PDA
+  feeVaultBump: number;
+  // The bump seed for the fee vault authority PDA
+  feeVaultAuthorityBump: number;
+  // Fees collected and pending withdraw for the fee vault
+  collectedGroupFeesOutstanding: WrappedI80F48;
+  // Total amount of liability shares
+  totalLiabilityShares: WrappedI80F48;
+  // Total amount of asset shares
+  totalAssetShares: WrappedI80F48;
+  // Last time the bank was updated
+  lastUpdate: BN;
+  // Bank configuration
+  config: BankConfig;
+  // Bank flags
+  flags: BN;
+  // Emissions APR
+  emissionsRate: BN;
+  // Remaining emissions
+  emissionsRemaining: WrappedI80F48;
+  // The mint for emissions
+  emissionsMint: web3.PublicKey;
+  // Fees collected and pending withdraw for the global fee wallet
+  collectedProgramFeesOutstanding: WrappedI80F48;
+}
+
+/**
+ * Bank configuration interface
+ * Represents the configuration settings for a bank
+ */
+export interface BankConfig {
+  // Asset weight for initial margin requirements
+  assetWeightInit: WrappedI80F48;
+  // Asset weight for maintenance margin requirements
+  assetWeightMaint: WrappedI80F48;
+  // Liability weight for initial margin requirements
+  liabilityWeightInit: WrappedI80F48;
+  // Liability weight for maintenance margin requirements
+  liabilityWeightMaint: WrappedI80F48;
+  // Maximum deposit limit
+  depositLimit: BN;
+  // Interest rate configuration
+  interestRateConfig: InterestRateConfig;
+  // Bank operational state
+  operationalState: BankOperationalState;
+  // Oracle setup configuration
+  oracleSetup: number;
+  // Oracle keys array
+  oracleKeys: web3.PublicKey[];
+  // Maximum borrow limit
+  borrowLimit: BN;
+  // Risk tier classification
+  riskTier: RiskTier;
+  // Asset tag classification
+  assetTag: AssetTag;
+  // USD denominated limit for calculating asset value for initialization margin requirements
+  totalAssetValueInitLimit: BN;
+  // Time window in seconds for the oracle price feed to be considered live
+  oracleMaxAge: number;
+}
+
+/**
+ * Interest rate configuration interface
+ */
+export interface InterestRateConfig {
+  // Optimal utilization rate
+  optimalUtilizationRate: WrappedI80F48;
+  // Plateau interest rate
+  plateauInterestRate: WrappedI80F48;
+  // Maximum interest rate
+  maxInterestRate: WrappedI80F48;
+  // Insurance fee fixed APR
+  insuranceFeeFixedApr: WrappedI80F48;
+  // Insurance interest rate fee
+  insuranceIrFee: WrappedI80F48;
+  // Protocol fixed fee APR
+  protocolFixedFeeApr: WrappedI80F48;
+  // Protocol interest rate fee
+  protocolIrFee: WrappedI80F48;
+  // Protocol origination fee
+  protocolOriginationFee: WrappedI80F48;
+}
+
+/**
+ * Clend Account interface
+ * Represents a user's lending/borrowing account
+ */
+export interface ClendAccount {
+  // The owner of this account
+  authority: web3.PublicKey;
+  // The clend group this account belongs to
+  group: web3.PublicKey;
+
+  // The lending account for this clend account
+  lendingAccount: LendingAccount;
+
+  // Account flags
+  accountFlags: number;
+}
+
+/**
+ * Lending account interface
+ * Represents a user's lending account
+ */
+export interface LendingAccount {
+  balances: Balance[];
+}
+
+/**
+ * Balance interface
+ * Represents a user's balance in a specific bank
+ */
+export interface Balance {
+  active: boolean;
+  bankPk: web3.PublicKey;
+  bankAssetTag: number;
+  assetShares: WrappedI80F48;
+  liabilityShares: WrappedI80F48;
+  emissionsOutstanding: WrappedI80F48;
+  lastUpdate: BN;
+}
+
+/**
+ * Fee State interface
+ * Represents global fee configuration
+ */
+export interface FeeState {
+  key: web3.PublicKey;
+
+  // Authority that can modify fee settings
+  globalFeeAdmin: web3.PublicKey;
+  // Wallet to receive fees
+  globalFeeWallet: web3.PublicKey;
+  // Flat fee in SOL for bank initialization
+  bankInitFlatSolFee: number;
+
+  // Fixed fee amount
+  programFeeFixed: BN;
+  // Fee rate as a percentage
+  programFeeRate: BN;
+}
+
+/**
+ * Oracle Price interface
+ * Represents price data from an oracle
+ */
+export interface OraclePrice {
+  // Price value
+  price: BN;
+  // Confidence interval
+  confidence: BN;
+  // Timestamp of the price
+  timestamp: BN;
+  // Status of the price (valid, stale, etc.)
+  status: number;
+  // Type of oracle
+  oracleType: number;
+}
+
+/**
+ * Wrapped I80F48 interface
+ * Represents a wrapped I80F48 value
+ */
+export interface WrappedI80F48 {
+  value: number[];
+}
+
+export enum BankOperationalState {
+  Paused = 0,
+  Operational = 1,
+  ReduceOnly = 2,
+}
+
+export enum RiskTier {
+  Collateral = 0,
+  Isolated = 1,
+}
+
+export enum AssetTag {
+  Default = 0, // Regular asset that can be comingled with any other regular asset or SOL
+  Sol = 1, // Can be comingled with either DEFAULT or STAKED positions, but not both
+  Staked = 2, // Can only deposit other STAKED assets or SOL and can only borrow SOL
+}
+
+export enum OracleSetup {
+  None = 0,
+  PythLegacy = 1,
+  PythPushOracle = 2,
+  StakedWithPythPush = 3,
+}
+
+export type InterestRateConfigCompact = {
+  optimalUtilizationRate: WrappedI80F48;
+  plateauInterestRate: WrappedI80F48;
+  maxInterestRate: WrappedI80F48;
+  insuranceFeeFixedApr: WrappedI80F48;
+  insuranceIrFee: WrappedI80F48;
+  protocolFixedFeeApr: WrappedI80F48;
+  protocolIrFee: WrappedI80F48;
+  protocolOriginationFee: WrappedI80F48;
+};
+
+export type BankConfigCompact = {
+  // WrappedI80F48 fields: 4 * 16 = 64 bytes
+  assetWeightInit: WrappedI80F48;
+  // WrappedI80F48 fields: 4 * 16 = 64 bytes
+  assetWeightMaint: WrappedI80F48;
+  // WrappedI80F48 fields: 4 * 16 = 64 bytes
+  liabilityWeightInit: WrappedI80F48;
+  // WrappedI80F48 fields: 4 * 16 = 64 bytes
+  liabilityWeightMaint: WrappedI80F48;
+  // u64 (8 bytes)
+  depositLimit: BN;
+  //// InterestRateConfigCompact (8 * 8 = 64 bytes)
+  //interestRateConfig: InterestRateConfigCompact;
+  // BankOperationalState (1 byte)
+  operationalState: BankOperationalState;
+  // u64 (8 bytes)
+  borrowLimit: BN;
+  // RiskTier (1 byte)
+  riskTier: RiskTier;
+  // u8 (1 byte)
+  assetTag: number;
+  // 8 bytes
+  totalAssetValueInitLimit: BN;
+  // u16 (2 bytes)
+  oracleMaxAge: number;
+};
+
+// Total size breakdown:
+// - WrappedI80F48 fields: 4 * 16 = 64 bytes
+// - BN fields: 4 * 8 = 32 bytes
+// - RiskTier: 1 byte
+// - totalAssetValueInitLimit: 8 bytes
+// - interestRateConfig: 64 bytes
+// - operationalState: 1 byte
+// - assetTag: 1 byte
+// - stakeRateBps: 2 bytes
+// - depositFee: 8 bytes
+// - borrowFee: 8 bytes
+// - oracleMaxAge: 2 bytes
+// - _padding_0: [[u64; 2]; 27] = 27 * 2 * 8 = 432 bytes
+// Total: 784 bytes
+
+export type BankConfigOpt = {
+  assetWeightInit: WrappedI80F48;
+  assetWeightMaint: WrappedI80F48;
+  liabilityWeightInit: WrappedI80F48;
+  liabilityWeightMaint: WrappedI80F48;
+  depositLimit: BN;
+  borrowLimit: BN;
+  operationalState: BankOperationalState;
+  interestRateConfig: InterestRateConfigOpt;
+  riskTier: RiskTier;
+  assetTag: number;
+  totalAssetValueInitLimit: BN;
+  oracleMaxAge: number;
+  permissionlessBadDebtSettlement: boolean;
+  freezeSettings: boolean;
+};
+
+export type InterestRateConfigOpt = {
+  optimalUtilizationRate: WrappedI80F48 | null;
+  plateauInterestRate: WrappedI80F48 | null;
+  maxInterestRate: WrappedI80F48 | null;
+  insuranceFeeFixedApr: WrappedI80F48 | null;
+  insuranceIrFee: WrappedI80F48 | null;
+  protocolFixedFeeApr: WrappedI80F48 | null;
+  protocolIrFee: WrappedI80F48 | null;
+  protocolOriginationFee: WrappedI80F48 | null;
+};
+
+export function newInterestRateConfigCompact({
+  optimalUtilizationRate,
+  plateauInterestRate,
+  maxInterestRate,
+  insuranceFeeFixedApr,
+  insuranceIrFee,
+  protocolFixedFeeApr,
+  protocolIrFee,
+  protocolOriginationFee,
+}: {
+  optimalUtilizationRate: number;
+  plateauInterestRate: number;
+  maxInterestRate: number;
+  insuranceFeeFixedApr: number;
+  insuranceIrFee: number;
+  protocolFixedFeeApr: number;
+  protocolIrFee: number;
+  protocolOriginationFee: number;
+}): InterestRateConfigCompact {
+  return {
+    optimalUtilizationRate: bigNumberToWrappedI80F48(optimalUtilizationRate),
+    plateauInterestRate: bigNumberToWrappedI80F48(plateauInterestRate),
+    maxInterestRate: bigNumberToWrappedI80F48(maxInterestRate),
+    insuranceFeeFixedApr: bigNumberToWrappedI80F48(insuranceFeeFixedApr),
+    insuranceIrFee: bigNumberToWrappedI80F48(insuranceIrFee),
+    protocolFixedFeeApr: bigNumberToWrappedI80F48(protocolFixedFeeApr),
+    protocolIrFee: bigNumberToWrappedI80F48(protocolIrFee),
+    protocolOriginationFee: bigNumberToWrappedI80F48(protocolOriginationFee),
+  };
+}
+
+export function newInterestRateConfigOpt({
+  optimalUtilizationRate,
+  plateauInterestRate,
+  maxInterestRate,
+  insuranceFeeFixedApr,
+  insuranceIrFee,
+  protocolFixedFeeApr,
+  protocolIrFee,
+  protocolOriginationFee,
+}: {
+  optimalUtilizationRate: number | null;
+  plateauInterestRate: number | null;
+  maxInterestRate: number | null;
+  insuranceFeeFixedApr: number | null;
+  insuranceIrFee: number | null;
+  protocolFixedFeeApr: number | null;
+  protocolIrFee: number | null;
+  protocolOriginationFee: number | null;
+}): InterestRateConfigOpt {
+  return {
+    optimalUtilizationRate: optimalUtilizationRate
+      ? bigNumberToWrappedI80F48(optimalUtilizationRate)
+      : null,
+    plateauInterestRate: plateauInterestRate
+      ? bigNumberToWrappedI80F48(plateauInterestRate)
+      : null,
+    maxInterestRate: maxInterestRate
+      ? bigNumberToWrappedI80F48(maxInterestRate)
+      : null,
+    insuranceFeeFixedApr: insuranceFeeFixedApr
+      ? bigNumberToWrappedI80F48(insuranceFeeFixedApr)
+      : null,
+    insuranceIrFee: insuranceIrFee
+      ? bigNumberToWrappedI80F48(insuranceIrFee)
+      : null,
+    protocolFixedFeeApr: protocolFixedFeeApr
+      ? bigNumberToWrappedI80F48(protocolFixedFeeApr)
+      : null,
+    protocolIrFee: protocolIrFee
+      ? bigNumberToWrappedI80F48(protocolIrFee)
+      : null,
+    protocolOriginationFee: protocolOriginationFee
+      ? bigNumberToWrappedI80F48(protocolOriginationFee)
+      : null,
+  };
+}
+
+export function newBankConfigCompact({
+  assetWeightInit,
+  assetWeightMaint,
+  liabilityWeightInit,
+  liabilityWeightMaint,
+  depositLimit,
+  borrowLimit,
+  riskTier,
+  totalAssetValueInitLimit,
+  operationalState,
+  assetTag,
+  oracleMaxAge,
+}: {
+  assetWeightInit: number;
+  assetWeightMaint: number;
+  liabilityWeightInit: number;
+  liabilityWeightMaint: number;
+  depositLimit: BN;
+  borrowLimit: BN;
+  riskTier: RiskTier;
+  totalAssetValueInitLimit: BN;
+  operationalState: BankOperationalState;
+  assetTag: number;
+  oracleMaxAge: number;
+}): BankConfigCompact {
+  const bc: BankConfigCompact = {
+    assetWeightInit: bigNumberToWrappedI80F48(assetWeightInit),
+    assetWeightMaint: bigNumberToWrappedI80F48(assetWeightMaint),
+    liabilityWeightInit: bigNumberToWrappedI80F48(liabilityWeightInit),
+    liabilityWeightMaint: bigNumberToWrappedI80F48(liabilityWeightMaint),
+    depositLimit,
+    borrowLimit,
+    riskTier,
+    totalAssetValueInitLimit,
+    operationalState,
+    assetTag,
+    oracleMaxAge,
+  };
+  return bc;
+}
+
+export function newClendAccountBalance({
+  active,
+  bankPk,
+  bankAssetTag,
+  assetShares,
+  liabilityShares,
+  emissionsOutstanding,
+  lastUpdate,
+}: {
+  active: boolean;
+  bankPk: web3.PublicKey;
+  bankAssetTag: number;
+  assetShares: WrappedI80F48;
+  liabilityShares: WrappedI80F48;
+  emissionsOutstanding: WrappedI80F48;
+  lastUpdate: BN;
+}): Balance {
+  return {
+    active,
+    bankPk,
+    bankAssetTag,
+    assetShares,
+    liabilityShares,
+    emissionsOutstanding,
+    lastUpdate,
+  };
+}
+
+// Token mints
+export const JLP_MINT = new web3.PublicKey(
+  "27G8MtK7VtTcCHkpASjSDdkWWYfoqT6ggEuKidVJidD4",
+);
+export const USDC_MINT = new web3.PublicKey(
+  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
+);
+
+// Oracle addresses
+export const JLP_ORACLE = new web3.PublicKey(
+  "2TTGSRSezqFzeLUH8JwRUbtN66XLLaymfYsWRTMjfiMw",
+);
+export const USDC_ORACLE = new web3.PublicKey(
+  "Dpw1EAVrSB1ibxiDQyTAW6Zip3J4Btk2x4SgApQCeFbX",
+);
+
+// Token decimals
+export const TOKEN_DECIMALS = {
+  USDC: 6,
+  JLP: 6,
+};
+
+// Token programs
+export const TOKEN_PROGRAMS = {
+  USDC: new web3.PublicKey("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"),
+  JLP: new web3.PublicKey("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"),
+};
+
+// Map of mint addresses to their corresponding oracle addresses
+export const ORACLE_MAP: Map<string, string> = new Map([
+  [JLP_MINT.toString(), JLP_ORACLE.toString()],
+  [USDC_MINT.toString(), USDC_ORACLE.toString()],
+]);
+
+// Helper function to get oracle for a mint
+export function getOracle(mint: web3.PublicKey): web3.PublicKey {
+  const oracleStr = ORACLE_MAP.get(mint.toString());
+  if (!oracleStr) {
+    throw new Error(`No oracle found for mint ${mint.toString()}`);
+  }
+  return new web3.PublicKey(oracleStr);
+}