Adding Token Metadata Support to @solana/spl-token (#5667)

* added init, update and emit token metadata actions

* added init with rent transfer, remote key, update authority

* add updateTokenMetadata state

* fixed tokenMetadataUpdateFieldWithRentTransfer

* removed getEmittedTokenMetadata and made error more verbose

* split additional rent into new and update

* factored out generic functions for getting account len

* simplified functions

* undo order change to simplify diff

* clean up based on review comments

* Refactored to unroll rent calculations for update and new into separate functions

* added addTypeandLengthtoLen function

* tidying up & refactoring tests

---------

Co-authored-by: Joe <[email protected]>

Author: mistersimon

pnpm-lock.yaml

@@ -56,9 +56,11 @@
     "dependencies": {
         "@solana/buffer-layout": "^4.0.0",
         "@solana/buffer-layout-utils": "^0.2.0",
+        "@solana/spl-token-metadata": "^0.1.2",
         "buffer": "^6.0.3"
     },
     "devDependencies": {
+        "@solana/codecs-strings": "2.0.0-experimental.9741939",
         "@solana/spl-memo": "0.2.3",
         "@solana/web3.js": "^1.87.6",
         "@types/chai-as-promised": "^7.1.4",

token/js/package.json

@@ -1,6 +1,8 @@
+import type { AccountInfo, PublicKey } from '@solana/web3.js';
+
 import { ACCOUNT_SIZE } from '../state/account.js';
 import type { Mint } from '../state/mint.js';
-import { MINT_SIZE } from '../state/mint.js';
+import { MINT_SIZE, unpackMint } from '../state/mint.js';
 import { MULTISIG_SIZE } from '../state/multisig.js';
 import { ACCOUNT_TYPE_SIZE } from './accountType.js';
 import { CPI_GUARD_SIZE } from './cpiGuard/index.js';
@@ -14,6 +16,7 @@ import { NON_TRANSFERABLE_SIZE, NON_TRANSFERABLE_ACCOUNT_SIZE } from './nonTrans
 import { PERMANENT_DELEGATE_SIZE } from './permanentDelegate.js';
 import { TRANSFER_FEE_AMOUNT_SIZE, TRANSFER_FEE_CONFIG_SIZE } from './transferFee/index.js';
 import { TRANSFER_HOOK_ACCOUNT_SIZE, TRANSFER_HOOK_SIZE } from './transferHook/index.js';
+import { TOKEN_2022_PROGRAM_ID } from '../constants.js';
 
 // Sequence from https://github.com/solana-labs/solana-program-library/blob/master/token/program-2022/src/extension/mod.rs#L903
 export enum ExtensionType {
@@ -36,11 +39,16 @@ export enum ExtensionType {
     // ConfidentialTransferFee, // Not implemented yet
     // ConfidentialTransferFeeAmount, // Not implemented yet
     MetadataPointer = 18, // Remove number once above extensions implemented
+    TokenMetadata = 19, // Remove number once above extensions implemented
 }
 
 export const TYPE_SIZE = 2;
 export const LENGTH_SIZE = 2;
 
+function addTypeAndLengthToLen(len: number): number {
+    return len + TYPE_SIZE + LENGTH_SIZE;
+}
+
 // NOTE: All of these should eventually use their type's Span instead of these
 // constants.  This is provided for at least creation to work.
 export function getTypeLen(e: ExtensionType): number {
@@ -79,6 +87,8 @@ export function getTypeLen(e: ExtensionType): number {
             return TRANSFER_HOOK_SIZE;
         case ExtensionType.TransferHookAccount:
             return TRANSFER_HOOK_ACCOUNT_SIZE;
+        case ExtensionType.TokenMetadata:
+            throw Error(`Cannot get type length for variable extension type: ${e}`);
         default:
             throw Error(`Unknown extension type: ${e}`);
     }
@@ -95,6 +105,7 @@ export function isMintExtension(e: ExtensionType): boolean {
         case ExtensionType.PermanentDelegate:
         case ExtensionType.TransferHook:
         case ExtensionType.MetadataPointer:
+        case ExtensionType.TokenMetadata:
             return true;
         case ExtensionType.Uninitialized:
         case ExtensionType.TransferFeeAmount:
@@ -130,6 +141,7 @@ export function isAccountExtension(e: ExtensionType): boolean {
         case ExtensionType.PermanentDelegate:
         case ExtensionType.TransferHook:
         case ExtensionType.MetadataPointer:
+        case ExtensionType.TokenMetadata:
             return false;
         default:
             throw Error(`Unknown extension type: ${e}`);
@@ -154,6 +166,7 @@ export function getAccountTypeOfMintType(e: ExtensionType): ExtensionType {
         case ExtensionType.MemoTransfer:
         case ExtensionType.MintCloseAuthority:
         case ExtensionType.MetadataPointer:
+        case ExtensionType.TokenMetadata:
         case ExtensionType.Uninitialized:
         case ExtensionType.InterestBearingConfig:
         case ExtensionType.PermanentDelegate:
@@ -172,7 +185,7 @@ function getLen(extensionTypes: ExtensionType[], baseSize: number): number {
             ACCOUNT_TYPE_SIZE +
             extensionTypes
                 .filter((element, i) => i === extensionTypes.indexOf(element))
-                .map((element) => getTypeLen(element) + TYPE_SIZE + LENGTH_SIZE)
+                .map((element) => addTypeAndLengthToLen(getTypeLen(element)))
                 .reduce((a, b) => a + b);
         if (accountLength === MULTISIG_SIZE) {
             return accountLength + TYPE_SIZE;
@@ -192,10 +205,10 @@ export function getAccountLen(extensionTypes: ExtensionType[]): number {
 
 export function getExtensionData(extension: ExtensionType, tlvData: Buffer): Buffer | null {
     let extensionTypeIndex = 0;
-    while (extensionTypeIndex + TYPE_SIZE + LENGTH_SIZE <= tlvData.length) {
+    while (addTypeAndLengthToLen(extensionTypeIndex) <= tlvData.length) {
         const entryType = tlvData.readUInt16LE(extensionTypeIndex);
         const entryLength = tlvData.readUInt16LE(extensionTypeIndex + TYPE_SIZE);
-        const typeIndex = extensionTypeIndex + TYPE_SIZE + LENGTH_SIZE;
+        const typeIndex = addTypeAndLengthToLen(extensionTypeIndex);
         if (entryType == extension) {
             return tlvData.slice(typeIndex, typeIndex + entryLength);
         }
@@ -211,7 +224,7 @@ export function getExtensionTypes(tlvData: Buffer): ExtensionType[] {
         const entryType = tlvData.readUInt16LE(extensionTypeIndex);
         extensionTypes.push(entryType);
         const entryLength = tlvData.readUInt16LE(extensionTypeIndex + TYPE_SIZE);
-        extensionTypeIndex += TYPE_SIZE + LENGTH_SIZE + entryLength;
+        extensionTypeIndex += addTypeAndLengthToLen(entryLength);
     }
     return extensionTypes;
 }
@@ -221,3 +234,19 @@ export function getAccountLenForMint(mint: Mint): number {
     const accountExtensions = extensionTypes.map(getAccountTypeOfMintType);
     return getAccountLen(accountExtensions);
 }
+
+export function getNewAccountLenForExtensionLen(
+    info: AccountInfo<Buffer>,
+    address: PublicKey,
+    extensionType: ExtensionType,
+    extensionLen: number,
+    programId = TOKEN_2022_PROGRAM_ID
+): number {
+    const mint = unpackMint(address, info, programId);
+    const extensionData = getExtensionData(extensionType, mint.tlvData);
+
+    const currentExtensionLen = extensionData ? addTypeAndLengthToLen(extensionData.length) : 0;
+    const newExtensionLen = addTypeAndLengthToLen(extensionLen);
+
+    return info.data.length + newExtensionLen - currentExtensionLen;
+}

token/js/src/extensions/extensionType.ts

@@ -6,6 +6,7 @@ export * from './immutableOwner.js';
 export * from './interestBearingMint/index.js';
 export * from './memoTransfer/index.js';
 export * from './metadataPointer/index.js';
+export * from './tokenMetadata/index.js';
 export * from './mintCloseAuthority.js';
 export * from './nonTransferable.js';
 export * from './transferFee/index.js';