Support InitializeAccount3 in token js (#3233)

Author: kunaljaydesai

token/js/src/instructions/decode.ts

@@ -10,6 +10,7 @@ import { decodeCloseAccountInstruction, DecodedCloseAccountInstruction } from '.
 import { DecodedFreezeAccountInstruction, decodeFreezeAccountInstruction } from './freezeAccount';
 import { DecodedInitializeAccountInstruction, decodeInitializeAccountInstruction } from './initializeAccount';
 import { DecodedInitializeAccount2Instruction, decodeInitializeAccount2Instruction } from './initializeAccount2';
+import { DecodedInitializeAccount3Instruction, decodeInitializeAccount3Instruction } from './initializeAccount3';
 import { DecodedInitializeMintInstruction, decodeInitializeMintInstruction } from './initializeMint';
 import { DecodedInitializeMultisigInstruction, decodeInitializeMultisigInstruction } from './initializeMultisig';
 import { DecodedMintToInstruction, decodeMintToInstruction } from './mintTo';
@@ -42,7 +43,7 @@ export type DecodedInstruction =
     | DecodedBurnCheckedInstruction
     | DecodedInitializeAccount2Instruction
     | DecodedSyncNativeInstruction
-    // | DecodedInitializeAccount3Instruction
+    | DecodedInitializeAccount3Instruction
     // | DecodedInitializeMultisig2Instruction
     // | DecodedInitializeMint2Instruction
     // TODO: implement ^ and remove `never`
@@ -77,7 +78,8 @@ export function decodeInstruction(
         return decodeInitializeAccount2Instruction(instruction, programId);
     if (type === TokenInstruction.SyncNative) return decodeSyncNativeInstruction(instruction, programId);
     // TODO: implement
-    if (type === TokenInstruction.InitializeAccount3) throw new TokenInvalidInstructionTypeError();
+    if (type === TokenInstruction.InitializeAccount3)
+        return decodeInitializeAccount3Instruction(instruction, programId);
     // TODO: implement
     if (type === TokenInstruction.InitializeMultisig2) throw new TokenInvalidInstructionTypeError();
     // TODO: implement
@@ -184,12 +186,12 @@ export function isSyncNativeInstruction(decoded: DecodedInstruction): decoded is
     return decoded.data.instruction === TokenInstruction.SyncNative;
 }
 
-/** TODO: docs, implement */
-// export function isInitializeAccount3Instruction(
-//     decoded: DecodedInstruction
-// ): decoded is DecodedInitializeAccount3Instruction {
-//     return decoded.data.instruction === TokenInstruction.InitializeAccount3;
-// }
+/** TODO: docs */
+export function isInitializeAccount3Instruction(
+    decoded: DecodedInstruction
+): decoded is DecodedInitializeAccount3Instruction {
+    return decoded.data.instruction === TokenInstruction.InitializeAccount3;
+}
 
 /** TODO: docs, implement */
 // export function isInitializeMultisig2Instruction(

token/js/src/instructions/initializeAccount3.ts

@@ -1 +1,129 @@
-export {}; // TODO: implement
+import { TokenInstruction } from './types';
+import { struct, u8 } from '@solana/buffer-layout';
+import { publicKey } from '@solana/buffer-layout-utils';
+import { AccountMeta, PublicKey, SYSVAR_RENT_PUBKEY, TransactionInstruction } from '@solana/web3.js';
+import { TOKEN_PROGRAM_ID } from '../constants';
+import {
+    TokenInvalidInstructionDataError,
+    TokenInvalidInstructionKeysError,
+    TokenInvalidInstructionProgramError,
+    TokenInvalidInstructionTypeError,
+} from '../errors';
+
+export interface InitializeAccount3InstructionData {
+    instruction: TokenInstruction.InitializeAccount3;
+    owner: PublicKey;
+}
+
+export const initializeAccount3InstructionData = struct<InitializeAccount3InstructionData>([
+    u8('instruction'),
+    publicKey('owner'),
+]);
+
+/**
+ * Construct an InitializeAccount3 instruction
+ *
+ * @param account   New token account
+ * @param mint      Mint account
+ * @param owner     New account's owner/multisignature
+ * @param programId SPL Token program account
+ *
+ * @return Instruction to add to a transaction
+ */
+export function createInitializeAccount3Instruction(
+    account: PublicKey,
+    mint: PublicKey,
+    owner: PublicKey,
+    programId = TOKEN_PROGRAM_ID
+): TransactionInstruction {
+    const keys = [
+        { pubkey: account, isSigner: false, isWritable: true },
+        { pubkey: mint, isSigner: false, isWritable: false },
+    ];
+    const data = Buffer.alloc(initializeAccount3InstructionData.span);
+    initializeAccount3InstructionData.encode({ instruction: TokenInstruction.InitializeAccount3, owner }, data);
+    return new TransactionInstruction({ keys, programId, data });
+}
+
+/** A decoded, valid InitializeAccount3 instruction */
+export interface DecodedInitializeAccount3Instruction {
+    programId: PublicKey;
+    keys: {
+        account: AccountMeta;
+        mint: AccountMeta;
+    };
+    data: {
+        instruction: TokenInstruction.InitializeAccount3;
+        owner: PublicKey;
+    };
+}
+
+/**
+ * Decode an InitializeAccount3 instruction and validate it
+ *
+ * @param instruction Transaction instruction to decode
+ * @param programId   SPL Token program account
+ *
+ * @return Decoded, valid instruction
+ */
+export function decodeInitializeAccount3Instruction(
+    instruction: TransactionInstruction,
+    programId = TOKEN_PROGRAM_ID
+): DecodedInitializeAccount3Instruction {
+    if (!instruction.programId.equals(programId)) throw new TokenInvalidInstructionProgramError();
+    if (instruction.data.length !== initializeAccount3InstructionData.span)
+        throw new TokenInvalidInstructionDataError();
+
+    const {
+        keys: { account, mint },
+        data,
+    } = decodeInitializeAccount3InstructionUnchecked(instruction);
+    if (data.instruction !== TokenInstruction.InitializeAccount3) throw new TokenInvalidInstructionTypeError();
+    if (!account || !mint) throw new TokenInvalidInstructionKeysError();
+
+    // TODO: key checks?
+
+    return {
+        programId,
+        keys: {
+            account,
+            mint,
+        },
+        data,
+    };
+}
+
+/** A decoded, non-validated InitializeAccount3 instruction */
+export interface DecodedInitializeAccount3InstructionUnchecked {
+    programId: PublicKey;
+    keys: {
+        account: AccountMeta | undefined;
+        mint: AccountMeta | undefined;
+    };
+    data: {
+        instruction: number;
+        owner: PublicKey;
+    };
+}
+
+/**
+ * Decode an InitializeAccount3 instruction without validating it
+ *
+ * @param instruction Transaction instruction to decode
+ *
+ * @return Decoded, non-validated instruction
+ */
+export function decodeInitializeAccount3InstructionUnchecked({
+    programId,
+    keys: [account, mint],
+    data,
+}: TransactionInstruction): DecodedInitializeAccount3InstructionUnchecked {
+    return {
+        programId,
+        keys: {
+            account,
+            mint,
+        },
+        data: initializeAccount3InstructionData.decode(data),
+    };
+}

token/js/test/unit/index.test.ts

@@ -15,6 +15,7 @@ import {
     ExtensionType,
     getAssociatedTokenAddressSync,
     createInitializeAccount2Instruction,
+    createInitializeAccount3Instruction,
 } from '../../src';
 
 chai.use(chaiAsPromised);
@@ -54,6 +55,16 @@ describe('spl-token instructions', () => {
         expect(ix.programId).to.eql(TOKEN_PROGRAM_ID);
         expect(ix.keys).to.have.length(3);
     });
+
+    it('InitializeAccount3', () => {
+        const ix = createInitializeAccount3Instruction(
+            Keypair.generate().publicKey,
+            Keypair.generate().publicKey,
+            Keypair.generate().publicKey
+        );
+        expect(ix.programId).to.eql(TOKEN_PROGRAM_ID);
+        expect(ix.keys).to.have.length(2);
+    });
 });
 
 describe('spl-token-2022 instructions', () => {