@kamino-finance/klend-sdk 5.10.6 → 5.10.8

package/src/classes/vault.ts

@@ -53,7 +53,13 @@ import {
 import { VaultConfigField, VaultConfigFieldKind } from '../idl_codegen_kamino_vault/types';
 import { VaultState } from '../idl_codegen_kamino_vault/accounts';
 import Decimal from 'decimal.js';
-import { bpsToPct, getTokenBalanceFromAccountInfoLamports, numberToLamportsDecimal, parseTokenSymbol } from './utils';
+import {
+  bpsToPct,
+  decodeVaultName,
+  getTokenBalanceFromAccountInfoLamports,
+  numberToLamportsDecimal,
+  parseTokenSymbol,
+} from './utils';
 import { deposit } from '../idl_codegen_kamino_vault/instructions';
 import { withdraw } from '../idl_codegen_kamino_vault/instructions';
 import { PROGRAM_ID } from '../idl_codegen/programId';
@@ -83,6 +89,7 @@ import {
   getSharesInFarmUserPosition,
   getUserSharesInFarm,
 } from './farm_utils';
+import { printHoldings } from './types_utils';
 
 export const kaminoVaultId = new PublicKey('kvauTFR8qm1dhniz6pYuBZkuene3Hfrs1VQhVRgCNrr');
 export const kaminoVaultStagingId = new PublicKey('STkvh7ostar39Fwr4uZKASs1RNNuYMFMTsE77FiRsL2');
@@ -125,6 +132,36 @@ export class KaminoVaultClient {
     return;
   }
 
+  /**
+   * Prints a vault in a human readable form
+   * @param vaultPubkey - the address of the vault
+   * @param [vaultState] - optional parameter to pass the vault state directly; this will save a network call
+   * @returns - void; prints the vault to the console
+   */
+  async printVault(vaultPubkey: PublicKey, vaultState?: VaultState) {
+    const vault = vaultState ? vaultState : await VaultState.fetch(this.getConnection(), vaultPubkey);
+
+    if (!vault) {
+      console.log(`Vault ${vaultPubkey.toString()} not found`);
+      return;
+    }
+
+    const kaminoVault = new KaminoVault(vaultPubkey, vault, this._kaminoVaultProgramId);
+    const vaultName = this.decodeVaultName(vault.name);
+    const slot = await this.getConnection().getSlot('confirmed');
+    const tokensPerShare = await this.getTokensPerShareSingleVault(kaminoVault, slot);
+    const holdings = await this.getVaultHoldings(vault);
+
+    const sharesIssued = new Decimal(vault.sharesIssued.toString()!).div(
+      new Decimal(vault.sharesMintDecimals.toString())
+    );
+
+    console.log('Name: ', vaultName);
+    console.log('Shares issued: ', sharesIssued);
+    printHoldings(holdings);
+    console.log('Tokens per share: ', tokensPerShare);
+  }
+
   /**
    * This method will create a vault with a given config. The config can be changed later on, but it is recommended to set it up correctly from the start
    * @param vaultConfig - the config object used to create a vault
@@ -1058,11 +1095,7 @@ export class KaminoVaultClient {
 
   /**Convert an u8 array to a string */
   decodeVaultName(token: number[]): string {
-    const maxArray = new Uint8Array(token);
-    let s: string = new TextDecoder().decode(maxArray);
-    // Remove trailing zeros and spaces
-    s = s.replace(/[\0 ]+$/, '');
-    return s;
+    return decodeVaultName(token);
   }
 
   private withdrawIxn(
@@ -1491,15 +1524,15 @@ export class KaminoVaultClient {
   }
 
   /**
-   * This method calculates the token per shar value. This will always change based on interest earned from the vault, but calculating it requires a bunch of rpc requests. Caching this for a short duration would be optimal
+   * This method calculates the token per share value. This will always change based on interest earned from the vault, but calculating it requires a bunch of rpc requests. Caching this for a short duration would be optimal
    * @param vault - vault to calculate tokensPerShare for
-   * @param slot - current slot, used to estimate the interest earned in the different reserves with allocation from the vault
+   * @param [slot] - the slot at which we retrieve the tokens per share. Optional. If not provided, the function will fetch the current slot
    * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
    * @returns - token per share value
    */
   async getTokensPerShareSingleVault(
     vault: KaminoVault,
-    slot: number,
+    slot?: number,
     vaultReservesMap?: PubkeyHashMap<PublicKey, KaminoReserve>
   ): Promise<Decimal> {
     const vaultState = await vault.getState(this.getConnection());
@@ -1514,11 +1547,7 @@ export class KaminoVaultClient {
       vaultState.sharesMintDecimals.toString()
     );
 
-    const holdings = await this.getVaultHoldings(
-      vaultState,
-      await this.getConnection().getSlot('confirmed'),
-      vaultReservesState
-    );
+    const holdings = await this.getVaultHoldings(vaultState, slot, vaultReservesState);
 
     return holdings.total.div(sharesDecimal);
   }
@@ -1759,7 +1788,7 @@ export class KaminoVaultClient {
   /**
    * This will retrieve all the tokens that can be used as collateral by the users who borrow the token in the vault alongside details about the min and max loan to value ratio
    * @param vaultState - the vault state to load reserves for
-   * @param slot - current slot
+   * @param [slot] - the slot for which to retrieve the vault collaterals for. Optional. If not provided the function will fetch the current slot
    * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
    * @param [kaminoMarkets] - a list of all the kamino markets. Optional. If provided the function will be significantly faster as it will not have to fetch the markets
    * @returns a hashmap from each reserve pubkey to the market overview of the collaterals that can be used and the min and max loan to value ratio in that market
@@ -1831,13 +1860,13 @@ export class KaminoVaultClient {
   /**
    * This will return an VaultHoldings object which contains the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve
    * @param vault - the kamino vault to get available liquidity to withdraw for
-   * @param slot - current slot
-   * @param vaultReserves - a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
+   * @param [slot] - the slot for which to calculate the holdings. Optional. If not provided the function will fetch the current slot
+   * @param [vaultReserves] - a hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
    * @returns an VaultHoldings object representing the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve
    */
   async getVaultHoldings(
     vault: VaultState,
-    slot: number,
+    slot?: number,
     vaultReserves?: PubkeyHashMap<PublicKey, KaminoReserve>
   ): Promise<VaultHoldings> {
     const vaultHoldings: VaultHoldings = {
@@ -1860,7 +1889,12 @@ export class KaminoVaultClient {
         throw new Error(`Reserve ${allocationStrategy.reserve.toBase58()} not found`);
       }
 
-      const reserveCollExchangeRate = reserve.getEstimatedCollateralExchangeRate(slot, 0);
+      let reserveCollExchangeRate: Decimal;
+      if (slot) {
+        reserveCollExchangeRate = reserve.getEstimatedCollateralExchangeRate(slot, 0);
+      } else {
+        reserveCollExchangeRate = reserve.getCollateralExchangeRate();
+      }
       const reserveAllocationLiquidityAmount = new Decimal(allocationStrategy.ctokenAllocation.toString()).div(
         reserveCollExchangeRate
       );
@@ -1883,17 +1917,18 @@ export class KaminoVaultClient {
   }
 
   /**
-   * This will return an VaultHoldingsWithUSDValue object which contains an holdings field representing the amount available (uninvested) in vault, total amount invested in reseves and a breakdown of the amount invested in each reserve and additional fields for the total USD value of the available and invested amounts
+   * This will return an VaultOverview object that encapsulates all the information about the vault, including the holdings, reserves details, theoretical APY, utilization ratio and total borrowed amount
    * @param vault - the kamino vault to get available liquidity to withdraw for
-   * @param slot - current slot
    * @param price - the price of the token in the vault (e.g. USDC)
+   * @param [slot] - the slot for which to retrieve the vault overview for. Optional. If not provided the function will fetch the current slot
    * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
-   * @returns an VaultHoldingsWithUSDValue object with details about the tokens available and invested in the vault, denominated in tokens and USD
+   * @param [kaminoMarkets] - a list of all kamino markets. Optional. If provided the function will be significantly faster as it will not have to fetch the markets
+   * @returns an VaultOverview object with details about the tokens available and invested in the vault, denominated in tokens and USD
    */
   async getVaultHoldingsWithPrice(
     vault: VaultState,
-    slot: number,
     price: Decimal,
+    slot?: number,
     vaultReservesMap?: PubkeyHashMap<PublicKey, KaminoReserve>
   ): Promise<VaultHoldingsWithUSDValue> {
     const holdings = await this.getVaultHoldings(vault, slot, vaultReservesMap);
@@ -1914,16 +1949,16 @@ export class KaminoVaultClient {
   /**
    * This will return an VaultOverview object that encapsulates all the information about the vault, including the holdings, reserves details, theoretical APY, utilization ratio and total borrowed amount
    * @param vault - the kamino vault to get available liquidity to withdraw for
-   * @param slot - current slot
    * @param price - the price of the token in the vault (e.g. USDC)
+   * @param [slot] - the slot for which to retrieve the vault overview for. Optional. If not provided the function will fetch the current slot
    * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
    * @param [kaminoMarkets] - a list of all kamino markets. Optional. If provided the function will be significantly faster as it will not have to fetch the markets
    * @returns an VaultOverview object with details about the tokens available and invested in the vault, denominated in tokens and USD
    */
   async getVaultOverview(
     vault: VaultState,
-    slot: number,
     price: Decimal,
+    slot?: number,
     vaultReservesMap?: PubkeyHashMap<PublicKey, KaminoReserve>,
     kaminoMarkets?: KaminoMarket[]
   ): Promise<VaultOverview> {
@@ -1931,14 +1966,26 @@ export class KaminoVaultClient {
 
     const vaultHoldingsWithUSDValuePromise = await this.getVaultHoldingsWithPrice(
       vault,
-      slot,
       price,
+      slot,
+      vaultReservesState
+    );
+
+    const currentSlot = slot ? slot : await this.getConnection().getSlot();
+
+    const vaultTheoreticalAPYPromise = await this.getVaultTheoreticalAPY(vault, currentSlot, vaultReservesState);
+    const totalInvestedAndBorrowedPromise = await this.getTotalBorrowedAndInvested(
+      vault,
+      currentSlot,
       vaultReservesState
     );
-    const vaultTheoreticalAPYPromise = await this.getVaultTheoreticalAPY(vault, slot, vaultReservesState);
-    const totalInvestedAndBorrowedPromise = await this.getTotalBorrowedAndInvested(vault, slot, vaultReservesState);
-    const vaultCollateralsPromise = await this.getVaultCollaterals(vault, slot, vaultReservesState, kaminoMarkets);
-    const reservesOverviewPromise = await this.getVaultReservesDetails(vault, slot, vaultReservesState);
+    const vaultCollateralsPromise = await this.getVaultCollaterals(
+      vault,
+      currentSlot,
+      vaultReservesState,
+      kaminoMarkets
+    );
+    const reservesOverviewPromise = await this.getVaultReservesDetails(vault, currentSlot, vaultReservesState);
 
     // all the async part of the functions above just read the vaultReservesState which is read beforehand, so excepting vaultCollateralsPromise they should do no additional network calls
     const [
@@ -2115,26 +2162,31 @@ export class KaminoVaultClient {
    * @param vaultState the kamino vault state to get simulated holdings and earnings for
    * @param [vaultReservesMap] - hashmap from each reserve pubkey to the reserve state. Optional. If provided the function will be significantly faster as it will not have to fetch the reserves
    * @param [currentSlot] - the current slot. Optional. If not provided it will fetch the current slot
+   * @param [previousTotalAUM] - the previous AUM of the vault to compute the earned interest relative to this value. Optional. If not provided the function will estimate the total AUM at the slot of the last state update on chain
    * @returns a struct of simulated vault holdings and earned interest
    */
   async calculateSimulatedHoldingsWithInterest(
     vaultState: VaultState,
     vaultReservesMap?: PubkeyHashMap<PublicKey, KaminoReserve>,
-    currentSlot?: number
+    currentSlot?: number,
+    previousTotalAUM?: Decimal
   ): Promise<SimulatedVaultHoldingsWithEarnedInterest> {
-    const latestUpdateTs = vaultState.lastFeeChargeTimestamp.toNumber();
-    const lastUpdateSlot = latestUpdateTs / this.recentSlotDurationMs;
+    let prevAUM: Decimal;
 
-    const slot = currentSlot ? currentSlot : await this.getConnection().getSlot('confirmed');
+    if (previousTotalAUM) {
+      prevAUM = previousTotalAUM;
+    } else {
+      const latestUpdateTs = vaultState.lastFeeChargeTimestamp.toNumber();
+      const lastUpdateSlot = latestUpdateTs / this.recentSlotDurationMs;
 
-    const lastUpdateHoldingsPromise = this.getVaultHoldings(vaultState, lastUpdateSlot, vaultReservesMap);
-    const currentHoldingsPromise = this.getVaultHoldings(vaultState, slot, vaultReservesMap);
-    const [lastUpdateHoldings, currentHoldings] = await Promise.all([
-      lastUpdateHoldingsPromise,
-      currentHoldingsPromise,
-    ]);
+      const lastUpdateHoldings = await this.getVaultHoldings(vaultState, lastUpdateSlot, vaultReservesMap);
+      prevAUM = lastUpdateHoldings.total;
+    }
+
+    const slot = currentSlot ? currentSlot : await this.getConnection().getSlot('confirmed');
 
-    const earnedInterest = currentHoldings.total.sub(lastUpdateHoldings.total);
+    const currentHoldings = await this.getVaultHoldings(vaultState, slot, vaultReservesMap);
+    const earnedInterest = currentHoldings.total.sub(prevAUM);
 
     return {
       holdings: currentHoldings,

package/src/client_kamino_manager.ts

@@ -53,6 +53,7 @@ import {
   PerformanceFeeBps,
 } from './idl_codegen_kamino_vault/types/VaultConfigField';
 import { getAccountOwner } from './utils/rpc';
+import { printHoldings } from './classes/types_utils';
 
 dotenv.config({
   path: `.env${process.env.ENV ? '.' + process.env.ENV : ''}`,
@@ -293,6 +294,42 @@ async function main() {
       mode === 'execute' && console.log('Pending admin updated:', updateVaultPendingAdminSig);
     });
 
+  commands
+    .command('update-vault-config')
+    .requiredOption('--vault <string>', 'Vault address')
+    .requiredOption('--field <string>', 'The field to update')
+    .requiredOption('--value <string>', 'The value to update the field to')
+    .requiredOption(
+      `--mode <string>`,
+      'simulate - to print txn simulation, inspect - to get txn simulation in explorer, execute - execute txn, multisig - to get bs58 txn for multisig usage'
+    )
+    .option(`--staging`, 'If true, will use the staging programs')
+    .option(`--multisig <string>`, 'If using multisig mode this is required, otherwise will be ignored')
+    .action(async ({ vault, field, value, mode, staging, multisig }) => {
+      const env = initializeClient(mode === 'multisig', staging);
+      const vaultAddress = new PublicKey(vault);
+
+      if (mode === 'multisig' && !multisig) {
+        throw new Error('If using multisig mode, multisig is required');
+      }
+
+      const kaminoManager = new KaminoManager(env.connection, env.kLendProgramId, env.kVaultProgramId);
+
+      const kaminoVault = new KaminoVault(vaultAddress, undefined, env.kVaultProgramId);
+      const instructions = await kaminoManager.updateVaultConfigIxs(kaminoVault, field, value);
+
+      const updateVaultPendingAdminSig = await processTxn(
+        env.client,
+        env.payer,
+        [instructions.updateVaultConfigIx, ...instructions.updateLUTIxs],
+        mode,
+        2500,
+        []
+      );
+
+      mode === 'execute' && console.log('Pending admin updated:', updateVaultPendingAdminSig);
+    });
+
   commands
     .command('update-vault-mgmt-fee')
     .requiredOption('--vault <string>', 'Vault address')
@@ -796,8 +833,8 @@ async function main() {
       const vaultState = await new KaminoVault(vaultAddress, undefined, env.kVaultProgramId).getState(env.connection);
       const vaultOverview = await kaminoManager.getVaultOverview(
         vaultState,
-        await env.connection.getSlot('confirmed'),
-        new Decimal(1.0)
+        new Decimal(1.0),
+        await env.connection.getSlot('confirmed')
       );
 
       console.log('vaultOverview', vaultOverview);
@@ -890,8 +927,11 @@ async function main() {
       const sharesIssued = new Decimal(vaultState.sharesIssued.toString()!).div(
         new Decimal(vaultState.sharesMintDecimals.toString())
       );
+
+      console.log('farm', vaultState.vaultFarm.toString());
+      console.log('Name: ', kaminoManager.getDecodedVaultName(kaminoVault.state!));
       console.log('Shares issued: ', sharesIssued);
-      console.log('Holdings: ', holdings);
+      printHoldings(holdings);
       console.log(`Tokens per share for vault ${vaultAddress.toBase58()}: ${tokensPerShare}`);
     });
 
@@ -937,7 +977,6 @@ async function main() {
       const simulatedHoldings = await kaminoManager.calculateSimulatedHoldingsWithInterest(vaultState);
 
       console.log('Simulated holdings with interest', simulatedHoldings);
-
       const simulatedFees = await kaminoManager.calculateSimulatedFees(vaultState, simulatedHoldings);
 
       console.log('Simulated fees', simulatedFees);

package/src/lending_operations/index.ts

@@ -1,2 +1,3 @@
 export * from './repay_with_collateral_operations';
+export * from './swap_collateral_operations';
 export * from './repay_with_collateral_calcs';

package/src/lending_operations/repay_with_collateral_operations.ts

@@ -3,8 +3,8 @@ import {
   getFlashLoanInstructions,
   SwapInputs,
   SwapQuote,
-  SwapQuoteIxs,
-  SwapQuoteIxsProvider,
+  SwapIxs,
+  SwapIxsProvider,
   SwapQuoteProvider,
 } from '../leverage';
 import {
@@ -23,10 +23,10 @@ export type RepayWithCollIxsResponse<QuoteResponse> = {
   ixs: TransactionInstruction[];
   lookupTables: AddressLookupTableAccount[];
   swapInputs: SwapInputs;
-  initialInputs: InitialInputs<QuoteResponse>;
+  initialInputs: RepayWithCollInitialInputs<QuoteResponse>;
 };
 
-export type InitialInputs<QuoteResponse> = {
+export type RepayWithCollInitialInputs<QuoteResponse> = {
   debtRepayAmountLamports: Decimal;
   flashRepayAmountLamports: Decimal;
   /**
@@ -69,15 +69,15 @@ export async function getRepayWithCollSwapInputs<QuoteResponse>({
   scopeRefresh,
 }: RepayWithCollSwapInputsProps<QuoteResponse>): Promise<{
   swapInputs: SwapInputs;
-  initialInputs: InitialInputs<QuoteResponse>;
+  initialInputs: RepayWithCollInitialInputs<QuoteResponse>;
 }> {
   const collReserve = kaminoMarket.getReserveByMint(collTokenMint);
   const debtReserve = kaminoMarket.getReserveByMint(debtTokenMint);
   if (!collReserve) {
-    throw new Error(`Collateral reserve with mint ${collReserve} not found in market ${kaminoMarket.getAddress()}`);
+    throw new Error(`Collateral reserve with mint ${collTokenMint} not found in market ${kaminoMarket.getAddress()}`);
   }
   if (!debtReserve) {
-    throw new Error(`Debt reserve with mint ${debtReserve} not found in market ${kaminoMarket.getAddress()}`);
+    throw new Error(`Debt reserve with mint ${debtTokenMint} not found in market ${kaminoMarket.getAddress()}`);
   }
 
   const {
@@ -172,7 +172,7 @@ export async function getRepayWithCollSwapInputs<QuoteResponse>({
 }
 
 interface RepayWithCollIxsProps<QuoteResponse> extends RepayWithCollSwapInputsProps<QuoteResponse> {
-  swapper: SwapQuoteIxsProvider<QuoteResponse>;
+  swapper: SwapIxsProvider<QuoteResponse>;
   logger?: (msg: string, ...extra: any[]) => void;
 }
 
@@ -263,7 +263,7 @@ async function buildRepayWithCollateralIxs(
   currentSlot: number,
   budgetAndPriorityFeeIxs: TransactionInstruction[] | undefined,
   scopeRefresh: ScopeRefresh | undefined,
-  swapQuoteIxs: SwapQuoteIxs,
+  swapQuoteIxs: SwapIxs,
   isClosingPosition: boolean,
   debtRepayAmountLamports: Decimal,
   collWithdrawLamports: Decimal
@@ -288,6 +288,7 @@ async function buildRepayWithCollateralIxs(
     reserve: debtReserve,
     amountLamports: debtRepayAmountLamports,
     destinationAta: debtTokenAta,
+    // TODO(referrals): once we support referrals, we will have to replace the placeholder args below:
     referrerAccount: market.programId,
     referrerTokenState: market.programId,
     programId: market.programId,