@kamino-finance/klend-sdk 5.13.1 → 5.13.4

package/dist/classes/vault.js

@@ -3,9 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReserveAllocationConfig = exports.KaminoVaultConfig = exports.KaminoVault = exports.KaminoVaultClient = exports.INITIAL_DEPOSIT_LAMPORTS = exports.kaminoVaultStagingId = exports.kaminoVaultId = void 0;
+exports.ReserveAllocationConfig = exports.KaminoVaultConfig = exports.KaminoVault = exports.KaminoVaultClient = exports.INITIAL_DEPOSIT_LAMPORTS = exports.METADATA_PROGRAM_ID = exports.METADATA_SEED = exports.kaminoVaultStagingId = exports.kaminoVaultId = void 0;
 exports.getCTokenVaultPda = getCTokenVaultPda;
 exports.getEventAuthorityPda = getEventAuthorityPda;
+exports.printHoldings = printHoldings;
 const anchor_1 = require("@coral-xyz/anchor");
 const web3_js_1 = require("@solana/web3.js");
 const spl_token_1 = require("@solana/spl-token");
@@ -27,7 +28,7 @@ const CreationParameters_1 = require("@kamino-finance/kliquidity-sdk/dist/utils/
 const dist_1 = require("@kamino-finance/farms-sdk/dist");
 const lookupTable_1 = require("../utils/lookupTable");
 const farm_utils_1 = require("./farm_utils");
-const types_utils_1 = require("./types_utils");
+const metadata_1 = require("../utils/metadata");
 exports.kaminoVaultId = new web3_js_1.PublicKey('KvauGMspG5k6rtzrqqn7WNn3oZdyKqLKwK2XWQ8FLjd');
 exports.kaminoVaultStagingId = new web3_js_1.PublicKey('stKvQfwRsQiKnLtMNVLHKS3exFJmZFsgfzBPWHECUYK');
 const TOKEN_VAULT_SEED = 'token_vault';
@@ -35,6 +36,8 @@ const CTOKEN_VAULT_SEED = 'ctoken_vault';
 const BASE_VAULT_AUTHORITY_SEED = 'authority';
 const SHARES_SEED = 'shares';
 const EVENT_AUTHORITY_SEED = '__event_authority';
+exports.METADATA_SEED = 'metadata';
+exports.METADATA_PROGRAM_ID = new web3_js_1.PublicKey('metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s');
 exports.INITIAL_DEPOSIT_LAMPORTS = 1000;
 /**
  * KaminoVaultClient is a class that provides a high-level interface to interact with the Kamino Vault program.
@@ -79,7 +82,7 @@ class KaminoVaultClient {
         const sharesIssued = new decimal_js_1.default(vault.sharesIssued.toString()).div(new decimal_js_1.default(vault.sharesMintDecimals.toString()));
         console.log('Name: ', vaultName);
         console.log('Shares issued: ', sharesIssued);
-        (0, types_utils_1.printHoldings)(holdings);
+        printHoldings(holdings);
         console.log('Tokens per share: ', tokensPerShare);
     }
     /**
@@ -144,30 +147,47 @@ class KaminoVaultClient {
         ];
         const insertIntoLUTIxs = await this.insertIntoLookupTableIxs(vaultConfig.admin, lut, accountsToBeInserted, []);
         const setLUTIx = this.updateUninitialisedVaultConfigIx(vaultConfig.admin, vaultState.publicKey, new types_1.VaultConfigField.LookupTable(), lut.toString());
-        const ixns = [createVaultIx, initVaultIx, setLUTIx];
+        const ixs = [createVaultIx, initVaultIx, setLUTIx];
         if (vaultConfig.getPerformanceFeeBps() > 0) {
             const setPerformanceFeeIx = this.updateUninitialisedVaultConfigIx(vaultConfig.admin, vaultState.publicKey, new types_1.VaultConfigField.PerformanceFeeBps(), vaultConfig.getPerformanceFeeBps().toString());
-            ixns.push(setPerformanceFeeIx);
+            ixs.push(setPerformanceFeeIx);
         }
         if (vaultConfig.getManagementFeeBps() > 0) {
             const setManagementFeeIx = this.updateUninitialisedVaultConfigIx(vaultConfig.admin, vaultState.publicKey, new types_1.VaultConfigField.ManagementFeeBps(), vaultConfig.getManagementFeeBps().toString());
-            ixns.push(setManagementFeeIx);
+            ixs.push(setManagementFeeIx);
         }
         if (vaultConfig.name && vaultConfig.name.length > 0) {
             const setNameIx = this.updateUninitialisedVaultConfigIx(vaultConfig.admin, vaultState.publicKey, new types_1.VaultConfigField.Name(), vaultConfig.name);
-            ixns.push(setNameIx);
+            ixs.push(setNameIx);
         }
+        const metadataIx = await this.getSetSharesMetadataIx(this.getConnection(), vaultConfig.admin, vaultState.publicKey, sharesMint, baseVaultAuthority, vaultConfig.vaultTokenSymbol, vaultConfig.vaultTokenName);
         return {
             vault: vaultState,
             initVaultIxs: {
                 createAtaIfNeededIxs: prerequisiteIxs,
-                initVaultIxs: ixns,
+                initVaultIxs: ixs,
                 createLUTIx,
                 populateLUTIxs: insertIntoLUTIxs,
                 cleanupIxs,
+                initSharesMetadataIx: metadataIx,
             },
         };
     }
+    /**
+     * This method creates an instruction to set the shares metadata for a vault
+     * @param vault - the vault to set the shares metadata for
+     * @param tokenName - the name of the token in the vault (symbol; e.g. "USDC" which becomes "kVUSDC")
+     * @param extraName - the extra string appended to the prefix("Kamino Vault USDC <extraName>")
+     * @returns - an instruction to set the shares metadata for the vault
+     */
+    async getSetSharesMetadataIx(connection, vaultAdmin, vault, sharesMint, baseVaultAuthority, tokenName, extraName) {
+        const [sharesMintMetadata] = (0, utils_2.getKVaultSharesMetadataPda)(sharesMint);
+        const { name, symbol, uri } = (0, metadata_1.resolveMetadata)(sharesMint, extraName, tokenName);
+        const ix = (await connection.getAccountInfo(sharesMintMetadata)) === null
+            ? await (0, metadata_1.getInitializeKVaultSharesMetadataIx)(connection, vaultAdmin, vault, sharesMint, baseVaultAuthority, name, symbol, uri)
+            : await (0, metadata_1.getUpdateSharesMetadataIx)(connection, vaultAdmin, vault, sharesMint, baseVaultAuthority, name, symbol, uri);
+        return ix;
+    }
     /**
      * This method updates the vault reserve allocation cofnig for an exiting vault reserve, or adds a new reserve to the vault if it does not exist.
      * @param vault - vault to be updated
@@ -441,7 +461,7 @@ class KaminoVaultClient {
             });
         }
         const reserveStates = await lib_1.Reserve.fetchMultiple(this.getConnection(), reservesToWithdraw, this._kaminoLendProgramId);
-        const withdrawIxns = await Promise.all(reservesToWithdraw.map(async (reserve, index) => {
+        const withdrawIxs = await Promise.all(reservesToWithdraw.map(async (reserve, index) => {
             if (reserveStates[index] === null) {
                 throw new Error(`Reserve ${reserve.toBase58()} not found`);
             }
@@ -449,7 +469,7 @@ class KaminoVaultClient {
             const marketAddress = reserveState.lendingMarket;
             return this.withdrawPendingFeesIx(vault, vaultState, marketAddress, { address: reserve, state: reserveState }, adminTokenAta);
         }));
-        return [createAtaIx, ...withdrawIxns];
+        return [createAtaIx, ...withdrawIxs];
     }
     // async closeVaultIx(vault: KaminoVault): Promise<TransactionInstruction> {
     //   const vaultState: VaultState = await vault.getState(this.getConnection());
@@ -472,8 +492,8 @@ class KaminoVaultClient {
         const vaultState = await vault.getState(this.getConnection());
         const tokenProgramID = vaultState.tokenProgram;
         const userTokenAta = (0, lib_1.getAssociatedTokenAddress)(vaultState.tokenMint, user, true, tokenProgramID);
-        const createAtasIxns = [];
-        const closeAtasIxns = [];
+        const createAtasIxs = [];
+        const closeAtasIxs = [];
         if (vaultState.tokenMint.equals(spl_token_1.NATIVE_MINT)) {
             const [{ ata: wsolAta, createAtaIx: createWsolAtaIxn }] = (0, utils_2.createAtasIdempotent)(user, [
                 {
@@ -481,17 +501,17 @@ class KaminoVaultClient {
                     tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
                 },
             ]);
-            createAtasIxns.push(createWsolAtaIxn);
-            const transferWsolIxns = (0, lib_1.getTransferWsolIxns)(user, wsolAta, (0, utils_1.numberToLamportsDecimal)(tokenAmount, vaultState.tokenMintDecimals.toNumber()).ceil());
-            createAtasIxns.push(...transferWsolIxns);
+            createAtasIxs.push(createWsolAtaIxn);
+            const transferWsolIxs = (0, lib_1.getTransferWsolIxs)(user, wsolAta, (0, utils_1.numberToLamportsDecimal)(tokenAmount, vaultState.tokenMintDecimals.toNumber()).ceil());
+            createAtasIxs.push(...transferWsolIxs);
         }
-        const [{ ata: userSharesAta, createAtaIx: createSharesAtaIxns }] = (0, utils_2.createAtasIdempotent)(user, [
+        const [{ ata: userSharesAta, createAtaIx: createSharesAtaIxs }] = (0, utils_2.createAtasIdempotent)(user, [
             {
                 mint: vaultState.sharesMint,
                 tokenProgram: spl_token_1.TOKEN_PROGRAM_ID,
             },
         ]);
-        createAtasIxns.push(createSharesAtaIxns);
+        createAtasIxs.push(createSharesAtaIxs);
         const eventAuthority = getEventAuthorityPda(this._kaminoVaultProgramId);
         const depoistAccounts = {
             user: user,
@@ -531,7 +551,7 @@ class KaminoVaultClient {
         depositIx.keys = depositIx.keys.concat(vaultReservesAccountMetas);
         depositIx.keys = depositIx.keys.concat(vaultReservesLendingMarkets);
         const depositIxs = {
-            depositIxs: [...createAtasIxns, depositIx, ...closeAtasIxns],
+            depositIxs: [...createAtasIxs, depositIx, ...closeAtasIxs],
             stakeInFarmIfNeededIxs: [],
         };
         // if there is no farm, we can return the deposit instructions, otherwise include the stake ix in the response
@@ -591,16 +611,16 @@ class KaminoVaultClient {
         // if the vault has allocations withdraw otherwise wtihdraw from available ix
         const vaultAllocation = vaultState.vaultAllocationStrategy.find((allocation) => !allocation.reserve.equals(web3_js_1.PublicKey.default));
         if (vaultAllocation) {
-            const withdrawFromVaultIxs = await this.wihdrdrawWithReserveIxns(user, kaminoVault, shareAmount, slot, vaultReservesMap);
+            const withdrawFromVaultIxs = await this.wihdrdrawWithReserveIxs(user, kaminoVault, shareAmount, slot, vaultReservesMap);
             withdrawIxs.withdrawIxs = withdrawFromVaultIxs;
         }
         else {
-            const withdrawFromVaultIxs = await this.withdrawFromAvailableIxns(user, kaminoVault, shareAmount);
+            const withdrawFromVaultIxs = await this.withdrawFromAvailableIxs(user, kaminoVault, shareAmount);
             withdrawIxs.withdrawIxs = withdrawFromVaultIxs;
         }
         return withdrawIxs;
     }
-    async withdrawFromAvailableIxns(user, vault, shareAmount) {
+    async withdrawFromAvailableIxs(user, vault, shareAmount) {
         const vaultState = await vault.getState(this.getConnection());
         const kaminoVault = new KaminoVault(vault.address, vaultState, vault.programId);
         const userSharesAta = (0, lib_1.getAssociatedTokenAddress)(vaultState.sharesMint, user);
@@ -614,7 +634,7 @@ class KaminoVaultClient {
         const withdrawFromAvailableIxn = await this.withdrawFromAvailableIx(user, kaminoVault, vaultState, userSharesAta, userTokenAta, shareLamportsToWithdraw);
         return [createAtaIx, withdrawFromAvailableIxn];
     }
-    async wihdrdrawWithReserveIxns(user, vault, shareAmount, slot, vaultReservesMap) {
+    async wihdrdrawWithReserveIxs(user, vault, shareAmount, slot, vaultReservesMap) {
         const vaultState = await vault.getState(this.getConnection());
         const vaultReservesState = vaultReservesMap ? vaultReservesMap : await this.loadVaultReserves(vaultState);
         const userSharesAta = (0, lib_1.getAssociatedTokenAddress)(vaultState.sharesMint, user);
@@ -661,8 +681,8 @@ class KaminoVaultClient {
                 }
             });
         }
-        const withdrawIxns = [];
-        withdrawIxns.push(createAtaIx);
+        const withdrawIxs = [];
+        withdrawIxs.push(createAtaIx);
         for (let reserveIndex = 0; reserveIndex < reserveWithSharesAmountToWithdraw.length; reserveIndex++) {
             const reserveWithTokens = reserveWithSharesAmountToWithdraw[reserveIndex];
             const reserveState = vaultReservesState.get(reserveWithTokens.reserve);
@@ -677,9 +697,9 @@ class KaminoVaultClient {
                 sharesToWithdraw = reserveWithTokens.shares;
             }
             const withdrawFromReserveIx = this.withdrawIx(user, vault, vaultState, marketAddress, { address: reserveWithTokens.reserve, state: reserveState.state }, userSharesAta, userTokenAta, sharesToWithdraw, vaultReservesState);
-            withdrawIxns.push(withdrawFromReserveIx);
+            withdrawIxs.push(withdrawFromReserveIx);
         }
-        return withdrawIxns;
+        return withdrawIxs;
     }
     /**
      * This will trigger invest by balancing, based on weights, the reserve allocations of the vault. It can either withdraw or deposit into reserves to balance them. This is a function that should be cranked
@@ -731,7 +751,7 @@ class KaminoVaultClient {
                 }
             }
         }
-        const investIxnsPromises = [];
+        const investIxsPromises = [];
         // invest first the reserves from which we disinvest, then the other ones
         for (const reserve of reservesToDisinvestFrom) {
             const reserveState = allReservesStateMap.get(reserve);
@@ -742,7 +762,7 @@ class KaminoVaultClient {
                 address: reserve,
                 state: reserveState.state,
             }, allReservesStateMap, false);
-            investIxnsPromises.push(investIxsPromise);
+            investIxsPromises.push(investIxsPromise);
         }
         for (const reserve of reservesToInvestInto) {
             const reserveState = allReservesStateMap.get(reserve);
@@ -753,12 +773,12 @@ class KaminoVaultClient {
                 address: reserve,
                 state: reserveState.state,
             }, allReservesStateMap, false);
-            investIxnsPromises.push(investIxsPromise);
+            investIxsPromises.push(investIxsPromise);
         }
-        let investIxns = [];
-        investIxns.push(createAtaIx);
-        investIxns = await Promise.all(investIxnsPromises).then((ixns) => ixns.flat());
-        return investIxns;
+        let investIxs = [];
+        investIxs.push(createAtaIx);
+        investIxs = await Promise.all(investIxsPromises).then((ixs) => ixs.flat());
+        return investIxs;
     }
     // todo: make sure we also check the ata of the investor for the vault token exists
     /**
@@ -1006,22 +1026,22 @@ class KaminoVaultClient {
         let lut = vaultState.vaultLookupTable;
         if (lut.equals(web3_js_1.PublicKey.default)) {
             const recentSlot = await this.getConnection().getSlot();
-            const [ixn, address] = (0, lookupTable_1.initLookupTableIx)(vaultState.vaultAdminAuthority, recentSlot);
-            setupLUTIfNeededIxs.push(ixn);
+            const [ix, address] = (0, lookupTable_1.initLookupTableIx)(vaultState.vaultAdminAuthority, recentSlot);
+            setupLUTIfNeededIxs.push(ix);
             lut = address;
             // set the new LUT for the vault
             const updateVaultConfigIxs = await this.updateVaultConfigIxs(vault, new types_1.VaultConfigField.LookupTable(), lut.toString());
             setupLUTIfNeededIxs.push(updateVaultConfigIxs.updateVaultConfigIx);
         }
-        const ixns = [];
+        const ixs = [];
         let overridenExistentAccounts = undefined;
         if (vaultState.vaultLookupTable.equals(web3_js_1.PublicKey.default)) {
             overridenExistentAccounts = [];
         }
-        ixns.push(...(await this.insertIntoLookupTableIxs(vaultState.vaultAdminAuthority, lut, allAccountsToBeInserted, overridenExistentAccounts)));
+        ixs.push(...(await this.insertIntoLookupTableIxs(vaultState.vaultAdminAuthority, lut, allAccountsToBeInserted, overridenExistentAccounts)));
         return {
             setupLUTIfNeededIxs,
-            syncLUTIxs: ixns,
+            syncLUTIxs: ixs,
         };
     }
     getReserveAccountsToInsertInLut(reserveState) {
@@ -1057,18 +1077,18 @@ class KaminoVaultClient {
         // deduplicate missing accounts and remove default accounts and convert it back to an array
         const missingAccountsList = new utils_2.PublicKeySet(missingAccounts).toArray();
         const chunkSize = 20;
-        const ixns = [];
+        const ixs = [];
         for (let i = 0; i < missingAccountsList.length; i += chunkSize) {
             const chunk = missingAccountsList.slice(i, i + chunkSize);
-            const ixn = web3_js_1.AddressLookupTableProgram.extendLookupTable({
+            const ix = web3_js_1.AddressLookupTableProgram.extendLookupTable({
                 lookupTable,
                 authority: payer,
                 payer,
                 addresses: chunk,
             });
-            ixns.push(ixn);
+            ixs.push(ix);
         }
-        return ixns;
+        return ixs;
     }
     /** Read the total holdings of a vault and the reserve weights and returns a map from each reserve to how many tokens should be deposited.
      * @param vaultState - the vault state to calculate the allocation for
@@ -1499,6 +1519,7 @@ class KaminoVaultClient {
                 .map((filteredReserve) => {
                 const reserveAsCollateral = {
                     mint: filteredReserve.getLiquidityMint(),
+                    address: filteredReserve.address,
                     liquidationLTVPct: new decimal_js_1.default(filteredReserve.state.config.liquidationThresholdPct),
                 };
                 marketOverview.reservesAsCollateral.push(reserveAsCollateral);
@@ -1873,8 +1894,12 @@ class KaminoVaultConfig {
     performanceFeeRatePercentage;
     /** The management fee rate of the vault, as percents, expressed as a decimal */
     managementFeeRatePercentage;
-    /** The name to be stored on cain for the vault (max 40 characters). */
+    /** The name to be stored on chain for the vault (max 40 characters). */
     name;
+    /** The symbol of the vault token to be stored (max 5 characters). E.g. USDC for a vault using USDC as token. */
+    vaultTokenSymbol;
+    /** The name of the vault token to be stored (max 10 characters), after the prefix `Kamino Vault <vaultTokenSymbol>`. E.g. USDC Vault for a vault using USDC as token. */
+    vaultTokenName;
     constructor(args) {
         this.admin = args.admin;
         this.tokenMint = args.tokenMint;
@@ -1882,6 +1907,8 @@ class KaminoVaultConfig {
         this.managementFeeRatePercentage = args.managementFeeRatePercentage;
         this.tokenMintProgramId = args.tokenMintProgramId;
         this.name = args.name;
+        this.vaultTokenSymbol = args.vaultTokenSymbol;
+        this.vaultTokenName = args.vaultTokenName;
     }
     getPerformanceFeeBps() {
         return this.performanceFeeRatePercentage.mul(100).toNumber();
@@ -1917,4 +1944,12 @@ function getCTokenVaultPda(vaultAddress, reserveAddress, kaminoVaultProgramId) {
 function getEventAuthorityPda(kaminoVaultProgramId) {
     return web3_js_1.PublicKey.findProgramAddressSync([Buffer.from(EVENT_AUTHORITY_SEED)], kaminoVaultProgramId)[0];
 }
+function printHoldings(holdings) {
+    console.log('Holdings:');
+    console.log('  Available:', holdings.available.toString());
+    console.log('  Invested:', holdings.invested.toString());
+    console.log('  Total AUM including fees:', holdings.totalAUMIncludingFees.toString());
+    console.log('  Pending fees:', holdings.pendingFees.toString());
+    console.log('  Invested in reserves:', (0, utils_1.pubkeyHashMapToJson)(holdings.investedInReserves));
+}
 //# sourceMappingURL=vault.js.map