stake-pool-js: implement bindings for token metadata instructions (#5103)

joncinque · AlexanderRay · web-flow · commit 013cc2298520 · 2023-08-24T18:16:05.000+02:00
* stake-pool-js: implement bindings for token metadata instructions

- revert changes

- add token metadata

- remove MINIMUM_RESERVE_LAMPORTS

* Support dynamic instruction layouts for metadata

* Fix merge error

* Fixup tests

---------

Co-authored-by: Alexander Ray &lt;a.ray@mfactory.ch&gt;
diff --git a/stake-pool/js/src/constants.ts b/stake-pool/js/src/constants.ts
@@ -1,6 +1,12 @@
 import { Buffer } from 'buffer';
 import { LAMPORTS_PER_SOL, PublicKey } from '@solana/web3.js';
 
+// Public key that identifies the metadata program.
+export const METADATA_PROGRAM_ID = new PublicKey('metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s');
+export const METADATA_MAX_NAME_LENGTH = 32;
+export const METADATA_MAX_SYMBOL_LENGTH = 10;
+export const METADATA_MAX_URI_LENGTH = 200;
+
 // Public key that identifies the SPL Stake Pool program.
 export const STAKE_POOL_PROGRAM_ID = new PublicKey('SPoo1Ku8WFXoNDMHPsrGSTSG1Y47rzgn41SLUNakuHy');
 
diff --git a/stake-pool/js/src/index.ts b/stake-pool/js/src/index.ts
@@ -28,6 +28,7 @@ import {
   lamportsToSol,
   solToLamports,
   findEphemeralStakeProgramAddress,
+  findMetadataAddress,
 } from './utils';
 import { StakePoolInstruction } from './instructions';
 import {
@@ -1109,3 +1110,80 @@ export async function redelegate(props: RedelegateProps) {
     instructions,
   };
 }
+
+/**
+ * Creates instructions required to create pool token metadata.
+ */
+export async function createPoolTokenMetadata(
+  connection: Connection,
+  stakePoolAddress: PublicKey,
+  payer: PublicKey,
+  name: string,
+  symbol: string,
+  uri: string,
+) {
+  const stakePool = await getStakePoolAccount(connection, stakePoolAddress);
+
+  const withdrawAuthority = await findWithdrawAuthorityProgramAddress(
+    STAKE_POOL_PROGRAM_ID,
+    stakePoolAddress,
+  );
+  const tokenMetadata = findMetadataAddress(stakePool.account.data.poolMint);
+  const manager = stakePool.account.data.manager;
+
+  const instructions: TransactionInstruction[] = [];
+  instructions.push(
+    StakePoolInstruction.createTokenMetadata({
+      stakePool: stakePoolAddress,
+      poolMint: stakePool.account.data.poolMint,
+      payer,
+      manager,
+      tokenMetadata,
+      withdrawAuthority,
+      name,
+      symbol,
+      uri,
+    }),
+  );
+
+  return {
+    instructions,
+  };
+}
+
+/**
+ * Creates instructions required to update pool token metadata.
+ */
+export async function updatePoolTokenMetadata(
+  connection: Connection,
+  stakePoolAddress: PublicKey,
+  name: string,
+  symbol: string,
+  uri: string,
+) {
+  const stakePool = await getStakePoolAccount(connection, stakePoolAddress);
+
+  const withdrawAuthority = await findWithdrawAuthorityProgramAddress(
+    STAKE_POOL_PROGRAM_ID,
+    stakePoolAddress,
+  );
+
+  const tokenMetadata = findMetadataAddress(stakePool.account.data.poolMint);
+
+  const instructions: TransactionInstruction[] = [];
+  instructions.push(
+    StakePoolInstruction.updateTokenMetadata({
+      stakePool: stakePoolAddress,
+      manager: stakePool.account.data.manager,
+      tokenMetadata,
+      withdrawAuthority,
+      name,
+      symbol,
+      uri,
+    }),
+  );
+
+  return {
+    instructions,
+  };
+}
diff --git a/stake-pool/js/src/instructions.ts b/stake-pool/js/src/instructions.ts
@@ -10,9 +10,15 @@ import {
 } from '@solana/web3.js';
 import * as BufferLayout from '@solana/buffer-layout';
 import { TOKEN_PROGRAM_ID } from '@solana/spl-token';
-import { STAKE_POOL_PROGRAM_ID } from './constants';
 import { InstructionType, encodeData, decodeData } from './utils';
 import BN from 'bn.js';
+import {
+  METADATA_MAX_NAME_LENGTH,
+  METADATA_MAX_SYMBOL_LENGTH,
+  METADATA_MAX_URI_LENGTH,
+  METADATA_PROGRAM_ID,
+  STAKE_POOL_PROGRAM_ID,
+} from './constants';
 
 /**
  * An enumeration of valid StakePoolInstructionType's
@@ -31,6 +37,8 @@ export type StakePoolInstructionType =
   | 'DecreaseAdditionalValidatorStake'
   | 'Redelegate';
 
+// 'UpdateTokenMetadata' and 'CreateTokenMetadata' have dynamic layouts
+
 const MOVE_STAKE_LAYOUT = BufferLayout.struct<any>([
   BufferLayout.u8('instruction'),
   BufferLayout.ns64('lamports'),
@@ -43,6 +51,38 @@ const UPDATE_VALIDATOR_LIST_BALANCE_LAYOUT = BufferLayout.struct<any>([
   BufferLayout.u8('noMerge'),
 ]);
 
+export function tokenMetadataLayout(
+  instruction: number,
+  nameLength: number,
+  symbolLength: number,
+  uriLength: number,
+) {
+  if (nameLength > METADATA_MAX_NAME_LENGTH) {
+    throw 'maximum token name length is 32 characters';
+  }
+
+  if (symbolLength > METADATA_MAX_SYMBOL_LENGTH) {
+    throw 'maximum token symbol length is 10 characters';
+  }
+
+  if (uriLength > METADATA_MAX_URI_LENGTH) {
+    throw 'maximum token uri length is 200 characters';
+  }
+
+  return {
+    index: instruction,
+    layout: BufferLayout.struct<any>([
+      BufferLayout.u8('instruction'),
+      BufferLayout.u32('nameLen'),
+      BufferLayout.blob(nameLength, 'name'),
+      BufferLayout.u32('symbolLen'),
+      BufferLayout.blob(symbolLength, 'symbol'),
+      BufferLayout.u32('uriLen'),
+      BufferLayout.blob(uriLength, 'uri'),
+    ]),
+  };
+}
+
 /**
  * An enumeration of valid stake InstructionType's
  * @internal
@@ -303,6 +343,28 @@ export type RedelegateParams = {
   destinationTransientStakeSeed: number | BN;
 };
 
+export type CreateTokenMetadataParams = {
+  stakePool: PublicKey;
+  manager: PublicKey;
+  tokenMetadata: PublicKey;
+  withdrawAuthority: PublicKey;
+  poolMint: PublicKey;
+  payer: PublicKey;
+  name: string;
+  symbol: string;
+  uri: string;
+};
+
+export type UpdateTokenMetadataParams = {
+  stakePool: PublicKey;
+  manager: PublicKey;
+  tokenMetadata: PublicKey;
+  withdrawAuthority: PublicKey;
+  name: string;
+  symbol: string;
+  uri: string;
+};
+
 /**
  * Stake Pool Instruction class
  */
@@ -823,6 +885,84 @@ export class StakePoolInstruction {
     });
   }
 
+  /**
+   * Creates an instruction to create metadata
+   * using the mpl token metadata program for the pool token
+   */
+  static createTokenMetadata(params: CreateTokenMetadataParams): TransactionInstruction {
+    const {
+      stakePool,
+      withdrawAuthority,
+      tokenMetadata,
+      manager,
+      payer,
+      poolMint,
+      name,
+      symbol,
+      uri,
+    } = params;
+
+    const keys = [
+      { pubkey: stakePool, isSigner: false, isWritable: false },
+      { pubkey: manager, isSigner: true, isWritable: false },
+      { pubkey: withdrawAuthority, isSigner: false, isWritable: false },
+      { pubkey: poolMint, isSigner: false, isWritable: false },
+      { pubkey: payer, isSigner: true, isWritable: true },
+      { pubkey: tokenMetadata, isSigner: false, isWritable: true },
+      { pubkey: METADATA_PROGRAM_ID, isSigner: false, isWritable: false },
+      { pubkey: SystemProgram.programId, isSigner: false, isWritable: false },
+      { pubkey: SYSVAR_RENT_PUBKEY, isSigner: false, isWritable: false },
+    ];
+
+    const type = tokenMetadataLayout(17, name.length, symbol.length, uri.length);
+    const data = encodeData(type, {
+      nameLen: name.length,
+      name: Buffer.from(name),
+      symbolLen: symbol.length,
+      symbol: Buffer.from(symbol),
+      uriLen: uri.length,
+      uri: Buffer.from(uri),
+    });
+
+    return new TransactionInstruction({
+      programId: STAKE_POOL_PROGRAM_ID,
+      keys,
+      data,
+    });
+  }
+
+  /**
+   * Creates an instruction to update metadata
+   * in the mpl token metadata program account for the pool token
+   */
+  static updateTokenMetadata(params: UpdateTokenMetadataParams): TransactionInstruction {
+    const { stakePool, withdrawAuthority, tokenMetadata, manager, name, symbol, uri } = params;
+
+    const keys = [
+      { pubkey: stakePool, isSigner: false, isWritable: false },
+      { pubkey: manager, isSigner: true, isWritable: false },
+      { pubkey: withdrawAuthority, isSigner: false, isWritable: false },
+      { pubkey: tokenMetadata, isSigner: false, isWritable: true },
+      { pubkey: METADATA_PROGRAM_ID, isSigner: false, isWritable: false },
+    ];
+
+    const type = tokenMetadataLayout(18, name.length, symbol.length, uri.length);
+    const data = encodeData(type, {
+      nameLen: name.length,
+      name: Buffer.from(name),
+      symbolLen: symbol.length,
+      symbol: Buffer.from(symbol),
+      uriLen: uri.length,
+      uri: Buffer.from(uri),
+    });
+
+    return new TransactionInstruction({
+      programId: STAKE_POOL_PROGRAM_ID,
+      keys,
+      data,
+    });
+  }
+
   /**
    * Decode a deposit stake pool instruction and retrieve the instruction params.
    */
diff --git a/stake-pool/js/src/utils/program-address.ts b/stake-pool/js/src/utils/program-address.ts
@@ -1,7 +1,11 @@
 import { PublicKey } from '@solana/web3.js';
 import BN from 'bn.js';
 import { Buffer } from 'buffer';
-import { EPHEMERAL_STAKE_SEED_PREFIX, TRANSIENT_STAKE_SEED_PREFIX } from '../constants';
+import {
+  METADATA_PROGRAM_ID,
+  EPHEMERAL_STAKE_SEED_PREFIX,
+  TRANSIENT_STAKE_SEED_PREFIX,
+} from '../constants';
 
 /**
  * Generates the withdraw authority program address for the stake pool
@@ -67,3 +71,14 @@ export async function findEphemeralStakeProgramAddress(
   );
   return publicKey;
 }
+
+/**
+ * Generates the metadata program address for the stake pool
+ */
+export function findMetadataAddress(stakePoolMintAddress: PublicKey) {
+  const [publicKey] = PublicKey.findProgramAddressSync(
+    [Buffer.from('metadata'), METADATA_PROGRAM_ID.toBuffer(), stakePoolMintAddress.toBuffer()],
+    METADATA_PROGRAM_ID,
+  );
+  return publicKey;
+}
diff --git a/stake-pool/js/test/instructions.test.ts b/stake-pool/js/test/instructions.test.ts
@@ -26,6 +26,9 @@ import {
   withdrawStake,
   redelegate,
   getStakeAccount,
+  createPoolTokenMetadata,
+  updatePoolTokenMetadata,
+  tokenMetadataLayout,
 } from '../src';
 
 import { decodeData } from '../src/utils';
@@ -351,4 +354,45 @@ describe('StakePoolProgram', () => {
       expect(decodedData.ephemeralStakeSeed).toBe(data.ephemeralStakeSeed);
     });
   });
+  describe('createPoolTokenMetadata', () => {
+    it('should create pool token metadata', async () => {
+      connection.getAccountInfo = jest.fn(async (pubKey: PublicKey) => {
+        if (pubKey == stakePoolAddress) {
+          return stakePoolAccount;
+        }
+        return null;
+      });
+      const name = 'test';
+      const symbol = 'TEST';
+      const uri = 'https://example.com';
+
+      const payer = new PublicKey(0);
+      const res = await createPoolTokenMetadata(
+        connection,
+        stakePoolAddress,
+        payer,
+        name,
+        symbol,
+        uri,
+      );
+
+      const type = tokenMetadataLayout(17, name.length, symbol.length, uri.length);
+      const data = decodeData(type, res.instructions[0].data);
+      expect(Buffer.from(data.name).toString()).toBe(name);
+      expect(Buffer.from(data.symbol).toString()).toBe(symbol);
+      expect(Buffer.from(data.uri).toString()).toBe(uri);
+    });
+
+    it('should update pool token metadata', async () => {
+      const name = 'test';
+      const symbol = 'TEST';
+      const uri = 'https://example.com';
+      const res = await updatePoolTokenMetadata(connection, stakePoolAddress, name, symbol, uri);
+      const type = tokenMetadataLayout(18, name.length, symbol.length, uri.length);
+      const data = decodeData(type, res.instructions[0].data);
+      expect(Buffer.from(data.name).toString()).toBe(name);
+      expect(Buffer.from(data.symbol).toString()).toBe(symbol);
+      expect(Buffer.from(data.uri).toString()).toBe(uri);
+    });
+  });
 });
