@kamino-finance/klend-sdk 5.13.2 → 5.13.5

package/src/classes/vault_types.ts

@@ -8,6 +8,7 @@ export type InitVaultIxs = {
   createLUTIx: TransactionInstruction;
   populateLUTIxs: TransactionInstruction[];
   cleanupIxs: TransactionInstruction[];
+  initSharesMetadataIx: TransactionInstruction;
 };
 
 export type AcceptVaultOwnershipIxs = {

package/src/client_kamino_manager.ts

@@ -252,10 +252,12 @@ async function main() {
       `--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(`--name`, 'The onchain name of the strat')
+    .requiredOption('--name <string>', 'The onchain name of the strat')
+    .requiredOption('--tokenName <string>', 'The name of the token in the vault')
+    .requiredOption('--extraTokenName <string>', 'The extra string appended to the token symbol')
     .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 ({ mint, mode, name, staging, multisig }) => {
+    .action(async ({ mint, mode, name, tokenName, extraTokenName, staging, multisig }) => {
       const env = initializeClient(mode === 'multisig', staging);
       const tokenMint = new PublicKey(mint);
 
@@ -279,6 +281,8 @@ async function main() {
         performanceFeeRatePercentage: new Decimal(0.0),
         managementFeeRatePercentage: new Decimal(0.0),
         name,
+        vaultTokenSymbol: tokenName,
+        vaultTokenName: extraTokenName,
       });
 
       const { vault: vaultKp, initVaultIxs: instructions } = await kaminoManager.createVaultIxs(kaminoVaultConfig);
@@ -286,7 +290,7 @@ async function main() {
       const _createVaultSig = await processTxn(
         env.client,
         env.payer,
-        [...instructions.initVaultIxs, instructions.createLUTIx],
+        [...instructions.initVaultIxs, instructions.createLUTIx, instructions.initSharesMetadataIx],
         mode,
         2500,
         [vaultKp]
@@ -294,9 +298,37 @@ async function main() {
       await sleep(2000);
       const _populateLUTSig = await processTxn(env.client, env.payer, instructions.populateLUTIxs, mode, 2500, []);
 
+      const _setSharesMetadataSig = await processTxn(
+        env.client,
+        env.payer,
+        [instructions.initSharesMetadataIx],
+        mode,
+        2500,
+        []
+      );
       mode === 'execute' && console.log('Vault created:', vaultKp.publicKey.toBase58());
     });
 
+  commands
+    .command('set-shares-metadata')
+    .requiredOption('--vault <string>', 'Vault address')
+    .requiredOption('--symbol <string>', 'The symbol of the kVault token')
+    .requiredOption('--extraName <string>', 'The name of the kVault token, appended to the symbol')
+    .action(async ({ vault, symbol, extraName }) => {
+      const env = initializeClient(false, false);
+      const kVault = new KaminoVault(new PublicKey(vault));
+
+      const kaminoManager = new KaminoManager(
+        env.connection,
+        DEFAULT_RECENT_SLOT_DURATION_MS,
+        env.kLendProgramId,
+        env.kVaultProgramId
+      );
+      const ix = await kaminoManager.getSetSharesMetadataIx(kVault, symbol, extraName);
+
+      await processTxn(env.client, env.payer, [ix], 'execute', 2500, []);
+    });
+
   commands
     .command('update-vault-pending-admin')
     .requiredOption('--vault <string>', 'Vault address')
@@ -1054,12 +1086,15 @@ async function main() {
         vaultState.sharesMintDecimals.toString()
       );
 
+      const vaultOverview = await kaminoManager.getVaultOverview(vaultState, new Decimal(1.0), slot);
+
       console.log('farm', vaultState.vaultFarm.toString());
       console.log('vault token mint', vaultState.tokenMint.toBase58());
       console.log('Name: ', kaminoManager.getDecodedVaultName(kaminoVault.state!));
       console.log('Shares issued: ', sharesIssued);
       printHoldings(holdings);
       console.log(`Tokens per share for vault ${vaultAddress.toBase58()}: ${tokensPerShare}`);
+      console.log('vaultOverview', vaultOverview);
     });
 
   commands.command('get-oracle-mappings').action(async () => {

package/src/utils/metadata.ts

@@ -0,0 +1,115 @@
+import { Connection, PublicKey, SystemProgram, SYSVAR_RENT_PUBKEY, TransactionInstruction } from '@solana/web3.js';
+import {
+  getKVaultSharesMetadataPda,
+  initializeSharesMetadata,
+  InitializeSharesMetadataAccounts,
+  InitializeSharesMetadataArgs,
+  METADATA_PROGRAM_ID,
+  updateSharesMetadata,
+  UpdateSharesMetadataAccounts,
+  UpdateSharesMetadataArgs,
+} from '../lib';
+
+export function resolveMetadata(
+  kTokenMint: PublicKey,
+  extra: string,
+  inputToken?: string,
+  inputName?: string,
+  inputSymbol?: string,
+  inputUri?: string
+): { name: string; symbol: string; uri: string } {
+  let name;
+  let symbol;
+  if (inputToken) {
+    const { name: resolvedName, symbol: resolvedSymbol } = resolveMetadataFromToken(inputToken, extra);
+    name = inputName ?? resolvedName;
+    symbol = inputSymbol ?? resolvedSymbol;
+  } else {
+    if (!inputSymbol) {
+      throw Error('Symbol required');
+    }
+    if (!inputName) {
+      throw Error('Name required');
+    }
+    name = inputName;
+    symbol = inputSymbol;
+  }
+  const uri = inputUri ?? resolveMetadataUriFromMint(kTokenMint);
+
+  return { name, symbol, uri };
+}
+
+export function resolveMetadataFromToken(token: string, extra: string): { name: string; symbol: string } {
+  console.log('token', token);
+  console.log('extra', extra);
+  const name = `kVault ${token} ${extra}`;
+  const symbol = `kV${token.toUpperCase()}`;
+  return { name, symbol };
+}
+
+export function resolveMetadataUriFromMint(mint: PublicKey): string {
+  return `https://api.kamino.finance/kvault-tokens/${mint.toBase58()}/metadata`;
+}
+
+export async function getInitializeKVaultSharesMetadataIx(
+  connection: Connection,
+  vaultAdmin: PublicKey,
+  vault: PublicKey,
+  sharesMint: PublicKey,
+  baseVaultAuthority: PublicKey,
+  name: string,
+  symbol: string,
+  uri: string
+): Promise<TransactionInstruction> {
+  const [sharesMintMetadata] = getKVaultSharesMetadataPda(sharesMint);
+
+  const args: InitializeSharesMetadataArgs = {
+    name,
+    symbol,
+    uri,
+  };
+
+  const accounts: InitializeSharesMetadataAccounts = {
+    vaultAdminAuthority: vaultAdmin,
+    vaultState: vault,
+    sharesMint,
+    baseVaultAuthority,
+    sharesMetadata: sharesMintMetadata,
+    systemProgram: SystemProgram.programId,
+    rent: SYSVAR_RENT_PUBKEY,
+    metadataProgram: METADATA_PROGRAM_ID,
+  };
+
+  const ix = initializeSharesMetadata(args, accounts);
+  return ix;
+}
+
+export async function getUpdateSharesMetadataIx(
+  connection: Connection,
+  vaultAdmin: PublicKey,
+  vault: PublicKey,
+  sharesMint: PublicKey,
+  baseVaultAuthority: PublicKey,
+  name: string,
+  symbol: string,
+  uri: string
+): Promise<TransactionInstruction> {
+  const [sharesMintMetadata] = getKVaultSharesMetadataPda(sharesMint);
+
+  const args: UpdateSharesMetadataArgs = {
+    name,
+    symbol,
+    uri,
+  };
+
+  const accounts: UpdateSharesMetadataAccounts = {
+    vaultAdminAuthority: vaultAdmin,
+    vaultState: vault,
+    baseVaultAuthority,
+    sharesMetadata: sharesMintMetadata,
+    metadataProgram: METADATA_PROGRAM_ID,
+  };
+
+  const ix = updateSharesMetadata(args, accounts);
+  return ix;
+}

package/src/utils/seeds.ts

@@ -1,6 +1,7 @@
 import { PublicKey } from '@solana/web3.js';
 import { PROGRAM_ID } from '../idl_codegen/programId';
 import { farmsId } from '@kamino-finance/farms-sdk';
+import { METADATA_PROGRAM_ID, METADATA_SEED } from '../classes/vault';
 
 /**
  * Lending market authority seed
@@ -204,3 +205,15 @@ export function obligationFarmStatePda(farm: PublicKey, obligation: PublicKey) {
     farmsId
   )[0];
 }
+
+/**
+ * Returns the PDA for the kVault shares metadata
+ * @param mint
+ * @returns [pda, bump]
+ */
+export function getKVaultSharesMetadataPda(mint: PublicKey): [PublicKey, number] {
+  return PublicKey.findProgramAddressSync(
+    [Buffer.from(METADATA_SEED), METADATA_PROGRAM_ID.toBuffer(), mint.toBuffer()],
+    METADATA_PROGRAM_ID
+  );
+}