@kamino-finance/klend-sdk 6.0.0 → 6.0.2-beta.0

package/src/classes/manager.ts

@@ -12,6 +12,7 @@ import {
   GetProgramAccountsMemcmpFilter,
   ProgramDerivedAddress,
   Base58EncodedBytes,
+  getBase58Decoder,
 } from '@solana/kit';
 import {
   KaminoVault,
@@ -70,7 +71,6 @@ import BN from 'bn.js';
 import { ReserveConfig, UpdateLendingMarketMode, UpdateLendingMarketModeKind } from '../@codegen/klend/types';
 import Decimal from 'decimal.js';
 import { VaultState } from '../@codegen/kvault/accounts';
-import bs58 from 'bs58';
 import { getProgramAccounts } from '../utils/rpc';
 import { VaultConfigField, VaultConfigFieldKind } from '../@codegen/kvault/types';
 import {
@@ -86,7 +86,7 @@ import {
   WithdrawAndBlockReserveIxs,
   WithdrawIxs,
 } from './vault_types';
-import { FarmState } from '@kamino-finance/farms-sdk/dist';
+import { FarmIncentives, Farms, FarmState } from '@kamino-finance/farms-sdk/dist';
 import { getSquadsMultisigAdminsAndThreshold, walletIsSquadsMultisig, WalletType } from '../utils/multisig';
 import { decodeVaultState } from '../utils/vault';
 import { noopSigner } from '../utils/signer';
@@ -95,6 +95,9 @@ import { SYSVAR_RENT_ADDRESS } from '@solana/sysvars';
 import { TOKEN_PROGRAM_ADDRESS } from '@solana-program/token';
 import type { AccountInfoBase, AccountInfoWithJsonData, AccountInfoWithPubkey } from '@solana/rpc-types';
 import { arrayElementConfigItems, ConfigUpdater } from './configItems';
+import { getFarmIncentives, ReserveIncentives } from '@kamino-finance/farms-sdk/dist/utils/apy';
+
+const base58Decoder = getBase58Decoder();
 
 /**
  * KaminoManager is a class that provides a high-level interface to interact with the Kamino Lend and Kamino Vault programs, in order to create and manage a market, as well as vaults
@@ -768,7 +771,7 @@ export class KaminoManager {
       {
         memcmp: {
           offset: 0n,
-          bytes: bs58.encode(VaultState.discriminator) as Base58EncodedBytes,
+          bytes: base58Decoder.decode(VaultState.discriminator) as Base58EncodedBytes,
           encoding: 'base58',
         },
       },
@@ -1065,7 +1068,7 @@ export class KaminoManager {
   }
 
   /**
-   * This will compute the PDA that is used as delegatee in Farms program to compute the user state PDA
+   * This will compute the PDA that is used as delegatee in Farms program to compute the user state PDA for vault depositor investing in vault with reserve having a supply farm
    */
   computeUserFarmStateForUserInVault(
     farmsProgramId: Address,
@@ -1076,6 +1079,88 @@ export class KaminoManager {
     return this._vaultClient.computeUserFarmStateDelegateePDAForUserInVault(farmsProgramId, reserve, vault, user);
   }
 
+  /**
+   * Read the APY of the farm built on top of the vault (farm in vaultState.vaultFarm)
+   * @param vault - the vault to read the farm APY for
+   * @param vaultTokenPrice - the price of the vault token in USD (e.g. 1.0 for USDC)
+   * @param [slot] - the slot to read the farm APY for. Optional. If not provided, the function will read the current slot
+   * @returns the APY of the farm built on top of the vault
+   */
+  async getVaultFarmRewardsAPY(vault: KaminoVault, vaultTokenPrice: Decimal, slot?: Slot): Promise<FarmIncentives> {
+    return this._vaultClient.getVaultRewardsAPY(vault, vaultTokenPrice, slot);
+  }
+
+  /**
+   * This will return the APY of the reserve farms (debt and supply)
+   * @param reserve - the reserve to get the farms APY for
+   * @param reserveTokenPrice - the price of the reserve token in USD (e.g. 1.0 for USDC)
+   * @param [reserveState] - the reserve state. Optional. If not provided, the function will fetch the reserve state
+   * @param [kaminoMarket] - the kamino market. Optional. If not provided, the function will fetch the kamino market
+   * @returns the APY of the farm built on top of the reserve
+   */
+  async getReserveFarmRewardsAPY(
+    reserve: Address,
+    reserveTokenPrice: Decimal,
+    reserveState?: Reserve,
+    kaminoMarket?: KaminoMarket
+  ): Promise<ReserveIncentives> {
+    const reserveIncentives: ReserveIncentives = {
+      collateralFarmIncentives: null,
+      debtFarmIncentives: null,
+    };
+
+    console.log("this._kaminoLendProgramId", this._kaminoLendProgramId.toString());
+    const reserveAccount = reserveState
+      ? reserveState
+      : await Reserve.fetch(this._rpc, reserve, this._kaminoLendProgramId);
+    if (!reserveAccount) {
+      throw new Error(`Reserve ${reserve} not found`);
+    }
+
+    let market = kaminoMarket;
+    if (!market) {
+      const fetckedMarket = await KaminoMarket.load(this._rpc, reserveAccount.lendingMarket, 450);
+      if (!fetckedMarket) {
+        throw new Error(`Market ${reserveAccount.lendingMarket} not found`);
+      }
+      market = fetckedMarket;
+    }
+
+    const kaminoReserve = market.getReserveByAddress(reserve);
+    if (!kaminoReserve) {
+      throw new Error(`Strategy state not found for strategy: ${reserve}`);
+    }
+
+    const farmCollateral = kaminoReserve.state.farmCollateral;
+    const farmDebt = kaminoReserve.state.farmDebt;
+
+    const stakedTokenMintDecimals = kaminoReserve.getMintDecimals();
+    const reserveCtokenPrice = reserveTokenPrice.div(kaminoReserve.getCollateralExchangeRate());
+
+    const farmsClient = new Farms(this._rpc);
+    if (farmCollateral !== DEFAULT_PUBLIC_KEY) {
+      const farmIncentivesCollateral = await getFarmIncentives(
+        farmsClient,
+        farmCollateral,
+        reserveCtokenPrice,
+        6 // all cTokens have 6 decimals
+      );
+      reserveIncentives.collateralFarmIncentives = farmIncentivesCollateral;
+    }
+
+    if (farmDebt !== DEFAULT_PUBLIC_KEY) {
+      const farmIncentivesDebt = await getFarmIncentives(
+        farmsClient,
+        farmDebt,
+        reserveTokenPrice,
+        stakedTokenMintDecimals
+      );
+      reserveIncentives.debtFarmIncentives = farmIncentivesDebt;
+    }
+
+    return reserveIncentives;
+  }
+
   /**
    * This will load the onchain state for all the reserves that the vault has allocations for
    * @param vaultState - the vault state to load reserves for

package/src/classes/market.ts

@@ -4,8 +4,8 @@ import {
   Base58EncodedBytes,
   Commitment,
   GetAccountInfoApi,
-  getAddressEncoder,
   GetBalanceApi,
+  getBase58Decoder,
   GetMinimumBalanceForRentExemptionApi,
   GetMultipleAccountsApi,
   GetProgramAccountsApi,
@@ -40,8 +40,6 @@ import {
   userMetadataPda,
   VanillaObligation,
 } from '../utils';
-import base58 from 'bs58';
-import bs58 from 'bs58';
 import BN from 'bn.js';
 import Decimal from 'decimal.js';
 import { FarmState } from '@kamino-finance/farms-sdk';
@@ -63,7 +61,7 @@ export type KaminoMarketRpcApi = GetAccountInfoApi &
   GetTokenAccountBalanceApi &
   GetBalanceApi;
 
-const addressEncoder = getAddressEncoder();
+const base58Decoder = getBase58Decoder();
 
 export interface ReserveRewardInfo {
   rewardsPerSecond: Decimal; // not lamport
@@ -614,7 +612,7 @@ export class KaminoMarket {
       filters.push({
         memcmp: {
           offset: 8n,
-          bytes: base58.encode(new BN(tag).toBuffer()) as Base58EncodedBytes,
+          bytes: base58Decoder.decode(new BN(tag).toBuffer()) as Base58EncodedBytes,
           encoding: 'base58',
         },
       });
@@ -688,7 +686,7 @@ export class KaminoMarket {
       filters.push({
         memcmp: {
           offset: 8n,
-          bytes: base58.encode(new BN(tag).toBuffer()) as Base58EncodedBytes,
+          bytes: base58Decoder.decode(new BN(tag).toBuffer()) as Base58EncodedBytes,
           encoding: 'base58',
         },
       });
@@ -754,7 +752,7 @@ export class KaminoMarket {
             {
               memcmp: {
                 offset: 8n,
-                bytes: base58.encode(new BN(tag).toBuffer()) as Base58EncodedBytes,
+                bytes: base58Decoder.decode(new BN(tag).toBuffer()) as Base58EncodedBytes,
                 encoding: 'base58',
               },
             },
@@ -886,7 +884,7 @@ export class KaminoMarket {
             {
               memcmp: {
                 offset: 0n,
-                bytes: bs58.encode(Obligation.discriminator) as Base58EncodedBytes,
+                bytes: base58Decoder.decode(Obligation.discriminator) as Base58EncodedBytes,
                 encoding: 'base58',
               },
             },
@@ -1046,7 +1044,7 @@ export class KaminoMarket {
             {
               memcmp: {
                 offset: 8n,
-                bytes: base58.encode(new BN(tag).toBuffer()) as Base58EncodedBytes,
+                bytes: base58Decoder.decode(new BN(tag).toBuffer()) as Base58EncodedBytes,
                 encoding: 'base58',
               },
             },
@@ -1215,21 +1213,12 @@ export class KaminoMarket {
     return referrerFeesCumulativeForMints;
   }
 
-  async getReferrerUrl(baseUrl: string, referrer: Address) {
-    return baseUrl + this.encodeReferrer(referrer);
+  getReferrerUrl(baseUrl: string, referrer: Address) {
+    return `${baseUrl}${referrer.toString()}`;
   }
 
-  async getReferrerFromUrl(baseUrl: string, url: string) {
-    return this.decodeReferrer(url.split(baseUrl)[1]);
-  }
-
-  async encodeReferrer(referrer: Address) {
-    return bs58.encode(Buffer.from(addressEncoder.encode(referrer)));
-  }
-
-  async decodeReferrer(encoded_referrer: string) {
-    const referrer_buffer = bs58.decode(encoded_referrer);
-    return address(referrer_buffer.toString());
+  getReferrerFromUrl(baseUrl: string, url: string) {
+    return address(url.split(baseUrl)[1]);
   }
 
   /**

package/src/classes/vault.ts

@@ -9,6 +9,7 @@ import {
   generateKeyPairSigner,
   GetAccountInfoApi,
   getAddressEncoder,
+  getBase58Decoder,
   GetProgramAccountsDatasizeFilter,
   GetProgramAccountsMemcmpFilter,
   getProgramDerivedAddress,
@@ -81,7 +82,6 @@ import {
   U64_MAX,
   VAULT_INITIAL_DEPOSIT,
 } from '../utils';
-import bs58 from 'bs58';
 import { getAccountOwner, getProgramAccounts } from '../utils/rpc';
 import {
   AcceptVaultOwnershipIxs,
@@ -98,7 +98,7 @@ import {
 } from './vault_types';
 import { batchFetch, collToLamportsDecimal, ZERO } from '@kamino-finance/kliquidity-sdk';
 import { FullBPSDecimal } from '@kamino-finance/kliquidity-sdk/dist/utils/CreationParameters';
-import { FarmState } from '@kamino-finance/farms-sdk/dist';
+import { FarmIncentives, FarmState } from '@kamino-finance/farms-sdk/dist';
 import { getAccountsInLut, initLookupTableIx } from '../utils/lookupTable';
 import {
   getFarmStakeIxs,
@@ -120,6 +120,7 @@ import { SYSVAR_INSTRUCTIONS_ADDRESS, SYSVAR_RENT_ADDRESS } from '@solana/sysvar
 import { noopSigner } from '../utils/signer';
 import { getExtendLookupTableInstruction } from '@solana-program/address-lookup-table';
 import { Farms } from '@kamino-finance/farms-sdk';
+import { getFarmIncentives } from '@kamino-finance/farms-sdk/dist/utils/apy';
 
 export const kaminoVaultId = address('KvauGMspG5k6rtzrqqn7WNn3oZdyKqLKwK2XWQ8FLjd');
 export const kaminoVaultStagingId = address('stKvQfwRsQiKnLtMNVLHKS3exFJmZFsgfzBPWHECUYK');
@@ -136,6 +137,7 @@ export const METADATA_PROGRAM_ID: Address = address('metaqbxxUerdq28cj1RbAWkYQm3
 export const INITIAL_DEPOSIT_LAMPORTS = 1000;
 
 const addressEncoder = getAddressEncoder();
+const base58Decoder = getBase58Decoder();
 
 /**
  * KaminoVaultClient is a class that provides a high-level interface to interact with the Kamino Vault program.
@@ -2043,7 +2045,7 @@ export class KaminoVaultClient {
       {
         memcmp: {
           offset: 0n,
-          bytes: bs58.encode(VaultState.discriminator) as Base58EncodedBytes,
+          bytes: base58Decoder.decode(VaultState.discriminator) as Base58EncodedBytes,
           encoding: 'base58',
         },
       },
@@ -2065,7 +2067,7 @@ export class KaminoVaultClient {
       {
         memcmp: {
           offset: 0n,
-          bytes: bs58.encode(VaultState.discriminator) as Base58EncodedBytes,
+          bytes: base58Decoder.decode(VaultState.discriminator) as Base58EncodedBytes,
           encoding: 'base58',
         },
       },
@@ -2917,6 +2919,9 @@ export class KaminoVaultClient {
     };
   }
 
+  /**
+   * This will compute the PDA that is used as delegatee in Farms program to compute the user state PDA for vault depositor investing in vault with reserve having a supply farm
+   */
   computeUserFarmStateDelegateePDAForUserInVault(
     farmsProgramId: Address,
     vault: Address,
@@ -2929,6 +2934,30 @@ export class KaminoVaultClient {
     });
   }
 
+  /**
+   * Read the APY of the farm built on top of the vault (farm in vaultState.vaultFarm)
+   * @param vault - the vault to read the farm APY for
+   * @param vaultTokenPrice - the price of the vault token in USD (e.g. 1.0 for USDC)
+   * @param [slot] - the slot to read the farm APY for. Optional. If not provided, the function will read the current slot
+   * @returns the APY of the farm built on top of the vault
+   */
+  async getVaultRewardsAPY(vault: KaminoVault, vaultTokenPrice: Decimal, slot?: Slot): Promise<FarmIncentives> {
+    const vaultState = await vault.getState(this.getConnection());
+    if (vaultState.vaultFarm === DEFAULT_PUBLIC_KEY) {
+      return {
+        incentivesStats: [],
+        totalIncentivesApy: 0,
+      };
+    }
+
+    const tokensPerShare = await this.getTokensPerShareSingleVault(vault, slot);
+    const sharePrice = tokensPerShare.mul(vaultTokenPrice);
+    const stakedTokenMintDecimals = vaultState.sharesMintDecimals.toNumber();
+
+    const farmsClient = new Farms(this.getConnection());
+    return getFarmIncentives(farmsClient, vaultState.vaultFarm, sharePrice, stakedTokenMintDecimals);
+  }
+
   private appendRemainingAccountsForVaultReserves(
     ix: IInstruction,
     vaultReserves: Address[],

package/src/client/tx/multisig.ts

@@ -4,6 +4,7 @@ import {
   appendTransactionMessageInstructions,
   compileTransactionMessage,
   createTransactionMessage,
+  getBase58Decoder,
   getCompiledTransactionMessageEncoder,
   IInstruction,
   pipe,
@@ -13,9 +14,10 @@ import {
 } from '@solana/kit';
 import { INVALID_BUT_SUFFICIENT_FOR_COMPILATION_BLOCKHASH } from './simulate';
 import { AddressLookupTable } from '@solana-program/address-lookup-table';
-import bs58 from 'bs58';
 import { removeComputeBudgetProgramInstructions } from './priorityFee';
 
+const base58Decoder = getBase58Decoder();
+
 export async function printMultisigTx(
   payer: TransactionSigner,
   ixs: IInstruction[],
@@ -40,6 +42,6 @@ export async function printMultisigTx(
   const compiled = compileTransactionMessage(transactionMessage);
   const encodedMessageBytes = getCompiledTransactionMessageEncoder().encode(compiled);
 
-  const base58EncodedMessage = bs58.encode(Uint8Array.from(encodedMessageBytes));
+  const base58EncodedMessage = base58Decoder.decode(encodedMessageBytes);
   console.log('Base58 encoded tx:', base58EncodedMessage);
 }

package/src/manager/client_kamino_manager.ts

@@ -1310,6 +1310,37 @@ async function main() {
       console.log('vaultOverview', vaultOverview);
     });
 
+  commands
+    .command('get-vault-farm-apy')
+    .requiredOption('--vault <string>', 'Vault address')
+    .requiredOption('--token-price <number>', 'Vault token price in USD')
+    .option(`--staging`, 'If true, will use the staging programs')
+    .action(async ({ vault, tokenPrice, staging }) => {
+      const env = await initEnv(staging);
+      const slotDuration = await getMedianSlotDurationInMsFromLastEpochs();
+
+      const kaminoManager = new KaminoManager(env.c.rpc, slotDuration, env.klendProgramId, env.kvaultProgramId);
+
+      const kaminoVault = new KaminoVault(address(vault));
+      const farmAPY = await kaminoManager.getVaultFarmRewardsAPY(kaminoVault, new Decimal(tokenPrice));
+      console.log('farmAPY', farmAPY);
+    });
+
+  commands
+    .command('get-reserve-farms-apy')
+    .requiredOption('--reserve <string>', 'Reserve address')
+    .requiredOption('--token-price <number>', 'Reserve token price in USD')
+    .option(`--staging`, 'If true, will use the staging programs')
+    .action(async ({ reserve, tokenPrice, staging }) => {
+      const env = await initEnv(staging);
+      const slotDuration = await getMedianSlotDurationInMsFromLastEpochs();
+
+      const kaminoManager = new KaminoManager(env.c.rpc, slotDuration, address("KLend2g3cP87fffoy8q1mQqGKjrxjC8boSyAYavgmjD"), env.kvaultProgramId);
+
+      const farmAPY = await kaminoManager.getReserveFarmRewardsAPY(address(reserve), new Decimal(tokenPrice));
+      console.log('farmAPY', farmAPY);
+    });
+
   commands
     .command('get-vault-allocation-distribution')
     .requiredOption('--vault <string>', 'Vault address')

package/src/manager/tx/multisig.ts

@@ -4,6 +4,7 @@ import {
   appendTransactionMessageInstructions,
   compileTransactionMessage,
   createTransactionMessage,
+  getBase58Decoder,
   getCompiledTransactionMessageEncoder,
   IInstruction,
   pipe,
@@ -13,9 +14,10 @@ import {
 } from '@solana/kit';
 import { INVALID_BUT_SUFFICIENT_FOR_COMPILATION_BLOCKHASH } from './simulate';
 import { AddressLookupTable } from '@solana-program/address-lookup-table';
-import bs58 from 'bs58';
 import { removeComputeBudgetProgramInstructions } from './priorityFee';
 
+const base58Decoder = getBase58Decoder();
+
 export async function printMultisigTx(
   payer: TransactionSigner,
   ixs: IInstruction[],
@@ -40,6 +42,6 @@ export async function printMultisigTx(
   const compiled = compileTransactionMessage(transactionMessage);
   const encodedMessageBytes = getCompiledTransactionMessageEncoder().encode(compiled);
 
-  const base58EncodedMessage = bs58.encode(Uint8Array.from(encodedMessageBytes));
+  const base58EncodedMessage = base58Decoder.decode(encodedMessageBytes);
   console.log('Base58 encoded tx:', base58EncodedMessage);
 }

package/src/utils/accountListing.ts

@@ -1,7 +1,8 @@
-import { Address, Base58EncodedBytes, GetProgramAccountsApi, Rpc } from '@solana/kit';
+import { Address, Base58EncodedBytes, getBase58Decoder, GetProgramAccountsApi, Rpc } from '@solana/kit';
 import { LendingMarket, Obligation, Reserve } from '../@codegen/klend/accounts';
 import { PROGRAM_ID } from '../@codegen/klend/programId';
-import bs58 from 'bs58';
+
+const base58Decoder = getBase58Decoder();
 
 export async function* getAllObligationAccounts(
   connection: Rpc<GetProgramAccountsApi>
@@ -17,14 +18,14 @@ export async function* getAllObligationAccounts(
           {
             memcmp: {
               offset: 0n,
-              bytes: bs58.encode(Obligation.discriminator) as Base58EncodedBytes,
+              bytes: base58Decoder.decode(Obligation.discriminator) as Base58EncodedBytes,
               encoding: 'base58',
             },
           },
           {
             memcmp: {
               offset: 64n,
-              bytes: bs58.encode([i]) as Base58EncodedBytes, // ...via sharding by userId's first byte (just as a source of randomness)
+              bytes: base58Decoder.decode(Buffer.from([i])) as Base58EncodedBytes, // ...via sharding by userId's first byte (just as a source of randomness)
               encoding: 'base58',
             },
           },
@@ -51,7 +52,7 @@ export async function* getAllReserveAccounts(
         {
           memcmp: {
             offset: 0n,
-            bytes: bs58.encode(Reserve.discriminator) as Base58EncodedBytes,
+            bytes: base58Decoder.decode(Reserve.discriminator) as Base58EncodedBytes,
             encoding: 'base58',
           },
         },
@@ -78,7 +79,7 @@ export async function* getAllLendingMarketAccounts(
         {
           memcmp: {
             offset: 0n,
-            bytes: bs58.encode(LendingMarket.discriminator) as Base58EncodedBytes,
+            bytes: base58Decoder.decode(LendingMarket.discriminator) as Base58EncodedBytes,
             encoding: 'base58',
           },
         },

package/src/utils/managerTypes.ts

@@ -252,6 +252,7 @@ export type AssetReserveConfigParams = {
   maxAgePriceSeconds: number;
   maxAgeTwapSeconds: number;
   borrowRateCurve: BorrowRateCurve;
+  hostFixedInterestRateBps: number;
 };
 
 export const DefaultConfigParams: AssetReserveConfigParams = {
@@ -276,6 +277,7 @@ export const DefaultConfigParams: AssetReserveConfigParams = {
   } as BorrowRateCurveFields),
   maxAgePriceSeconds: 180,
   maxAgeTwapSeconds: 240,
+  hostFixedInterestRateBps: 0,
 };
 
 export const encodeTokenName = (tokenName: string): number[] => {
@@ -359,7 +361,7 @@ function buildReserveConfig(fields: {
     deleveragingThresholdDecreaseBpsPerDay: new BN(24),
     disableUsageAsCollOutsideEmode: 0,
     utilizationLimitBlockBorrowingAbovePct: 0,
-    hostFixedInterestRateBps: 0,
+    hostFixedInterestRateBps: fields.configParams.hostFixedInterestRateBps,
     autodeleverageEnabled: 0,
     borrowLimitOutsideElevationGroup: new BN(
       numberToLamportsDecimal(fields.borrowLimitOutsideElevationGroup ?? new Decimal(0), fields.mintDecimals)