fix: Use COptionPubkeyLayout for all COption fields (#6173)

* fix: Use COptionPubkeyLayout for all COption fields

* add test for null close authority

* token js: init mint tests

---------

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

Author: qiweiii

token/js/src/instructions/initializeMint.ts

@@ -1,7 +1,7 @@
 import { struct, u8 } from '@solana/buffer-layout';
 import { publicKey } from '@solana/buffer-layout-utils';
-import type { AccountMeta } from '@solana/web3.js';
-import { PublicKey, SYSVAR_RENT_PUBKEY, TransactionInstruction } from '@solana/web3.js';
+import type { AccountMeta, PublicKey } from '@solana/web3.js';
+import { SYSVAR_RENT_PUBKEY, TransactionInstruction } from '@solana/web3.js';
 import { TOKEN_PROGRAM_ID } from '../constants.js';
 import {
     TokenInvalidInstructionDataError,
@@ -10,23 +10,22 @@ import {
     TokenInvalidInstructionTypeError,
 } from '../errors.js';
 import { TokenInstruction } from './types.js';
+import { COptionPublicKeyLayout } from '../serialization.js';
 
 /** TODO: docs */
 export interface InitializeMintInstructionData {
     instruction: TokenInstruction.InitializeMint;
     decimals: number;
     mintAuthority: PublicKey;
-    freezeAuthorityOption: 1 | 0;
-    freezeAuthority: PublicKey;
+    freezeAuthority: PublicKey | null;
 }
 
 /** TODO: docs */
 export const initializeMintInstructionData = struct<InitializeMintInstructionData>([
     u8('instruction'),
     u8('decimals'),
     publicKey('mintAuthority'),
-    u8('freezeAuthorityOption'),
-    publicKey('freezeAuthority'),
+    new COptionPublicKeyLayout('freezeAuthority'),
 ]);
 
 /**
@@ -58,8 +57,7 @@ export function createInitializeMintInstruction(
             instruction: TokenInstruction.InitializeMint,
             decimals,
             mintAuthority,
-            freezeAuthorityOption: freezeAuthority ? 1 : 0,
-            freezeAuthority: freezeAuthority || new PublicKey(0),
+            freezeAuthority,
         },
         data
     );
@@ -143,8 +141,7 @@ export function decodeInitializeMintInstructionUnchecked({
     keys: [mint, rent],
     data,
 }: TransactionInstruction): DecodedInitializeMintInstructionUnchecked {
-    const { instruction, decimals, mintAuthority, freezeAuthorityOption, freezeAuthority } =
-        initializeMintInstructionData.decode(data);
+    const { instruction, decimals, mintAuthority, freezeAuthority } = initializeMintInstructionData.decode(data);
 
     return {
         programId,
@@ -156,7 +153,7 @@ export function decodeInitializeMintInstructionUnchecked({
             instruction,
             decimals,
             mintAuthority,
-            freezeAuthority: freezeAuthorityOption ? freezeAuthority : null,
+            freezeAuthority,
         },
     };
 }

token/js/src/instructions/initializeMint2.ts

@@ -1,7 +1,7 @@
 import { struct, u8 } from '@solana/buffer-layout';
 import { publicKey } from '@solana/buffer-layout-utils';
-import type { AccountMeta } from '@solana/web3.js';
-import { PublicKey, TransactionInstruction } from '@solana/web3.js';
+import type { AccountMeta, PublicKey } from '@solana/web3.js';
+import { TransactionInstruction } from '@solana/web3.js';
 import { TOKEN_PROGRAM_ID } from '../constants.js';
 import {
     TokenInvalidInstructionDataError,
@@ -10,23 +10,22 @@ import {
     TokenInvalidInstructionTypeError,
 } from '../errors.js';
 import { TokenInstruction } from './types.js';
+import { COptionPublicKeyLayout } from '../serialization.js';
 
 /** TODO: docs */
 export interface InitializeMint2InstructionData {
     instruction: TokenInstruction.InitializeMint2;
     decimals: number;
     mintAuthority: PublicKey;
-    freezeAuthorityOption: 1 | 0;
-    freezeAuthority: PublicKey;
+    freezeAuthority: PublicKey | null;
 }
 
 /** TODO: docs */
 export const initializeMint2InstructionData = struct<InitializeMint2InstructionData>([
     u8('instruction'),
     u8('decimals'),
     publicKey('mintAuthority'),
-    u8('freezeAuthorityOption'),
-    publicKey('freezeAuthority'),
+    new COptionPublicKeyLayout('freezeAuthority'),
 ]);
 
 /**
@@ -55,8 +54,7 @@ export function createInitializeMint2Instruction(
             instruction: TokenInstruction.InitializeMint2,
             decimals,
             mintAuthority,
-            freezeAuthorityOption: freezeAuthority ? 1 : 0,
-            freezeAuthority: freezeAuthority || new PublicKey(0),
+            freezeAuthority,
         },
         data
     );
@@ -135,8 +133,7 @@ export function decodeInitializeMint2InstructionUnchecked({
     keys: [mint],
     data,
 }: TransactionInstruction): DecodedInitializeMint2InstructionUnchecked {
-    const { instruction, decimals, mintAuthority, freezeAuthorityOption, freezeAuthority } =
-        initializeMint2InstructionData.decode(data);
+    const { instruction, decimals, mintAuthority, freezeAuthority } = initializeMint2InstructionData.decode(data);
 
     return {
         programId,
@@ -147,7 +144,7 @@ export function decodeInitializeMint2InstructionUnchecked({
             instruction,
             decimals,
             mintAuthority,
-            freezeAuthority: freezeAuthorityOption ? freezeAuthority : null,
+            freezeAuthority,
         },
     };
 }

token/js/src/instructions/initializeMintCloseAuthority.ts

@@ -1,7 +1,6 @@
 import { struct, u8 } from '@solana/buffer-layout';
-import { publicKey } from '@solana/buffer-layout-utils';
-import type { AccountMeta } from '@solana/web3.js';
-import { PublicKey, TransactionInstruction } from '@solana/web3.js';
+import type { AccountMeta, PublicKey } from '@solana/web3.js';
+import { TransactionInstruction } from '@solana/web3.js';
 import { programSupportsExtensions } from '../constants.js';
 import {
     TokenInvalidInstructionDataError,
@@ -11,19 +10,18 @@ import {
     TokenUnsupportedInstructionError,
 } from '../errors.js';
 import { TokenInstruction } from './types.js';
+import { COptionPublicKeyLayout } from '../serialization.js';
 
 /** TODO: docs */
 export interface InitializeMintCloseAuthorityInstructionData {
     instruction: TokenInstruction.InitializeMintCloseAuthority;
-    closeAuthorityOption: 1 | 0;
-    closeAuthority: PublicKey;
+    closeAuthority: PublicKey | null;
 }
 
 /** TODO: docs */
 export const initializeMintCloseAuthorityInstructionData = struct<InitializeMintCloseAuthorityInstructionData>([
     u8('instruction'),
-    u8('closeAuthorityOption'),
-    publicKey('closeAuthority'),
+    new COptionPublicKeyLayout('closeAuthority'),
 ]);
 
 /**
@@ -49,8 +47,7 @@ export function createInitializeMintCloseAuthorityInstruction(
     initializeMintCloseAuthorityInstructionData.encode(
         {
             instruction: TokenInstruction.InitializeMintCloseAuthority,
-            closeAuthorityOption: closeAuthority ? 1 : 0,
-            closeAuthority: closeAuthority || new PublicKey(0),
+            closeAuthority,
         },
         data
     );
@@ -127,8 +124,7 @@ export function decodeInitializeMintCloseAuthorityInstructionUnchecked({
     keys: [mint],
     data,
 }: TransactionInstruction): DecodedInitializeMintCloseAuthorityInstructionUnchecked {
-    const { instruction, closeAuthorityOption, closeAuthority } =
-        initializeMintCloseAuthorityInstructionData.decode(data);
+    const { instruction, closeAuthority } = initializeMintCloseAuthorityInstructionData.decode(data);
 
     return {
         programId,
@@ -137,7 +133,7 @@ export function decodeInitializeMintCloseAuthorityInstructionUnchecked({
         },
         data: {
             instruction,
-            closeAuthority: closeAuthorityOption ? closeAuthority : null,
+            closeAuthority,
         },
     };
 }

token/js/src/instructions/setAuthority.ts

@@ -1,7 +1,7 @@
 import { struct, u8 } from '@solana/buffer-layout';
 import { publicKey } from '@solana/buffer-layout-utils';
-import type { AccountMeta, Signer } from '@solana/web3.js';
-import { PublicKey, TransactionInstruction } from '@solana/web3.js';
+import type { AccountMeta, Signer, PublicKey } from '@solana/web3.js';
+import { TransactionInstruction } from '@solana/web3.js';
 import { TOKEN_PROGRAM_ID } from '../constants.js';
 import {
     TokenInvalidInstructionDataError,
@@ -11,6 +11,7 @@ import {
 } from '../errors.js';
 import { addSigners } from './internal.js';
 import { TokenInstruction } from './types.js';
+import { COptionPublicKeyLayout } from '../serialization.js';
 
 /** Authority types defined by the program */
 export enum AuthorityType {
@@ -33,16 +34,14 @@ export enum AuthorityType {
 export interface SetAuthorityInstructionData {
     instruction: TokenInstruction.SetAuthority;
     authorityType: AuthorityType;
-    newAuthorityOption: 1 | 0;
-    newAuthority: PublicKey;
+    newAuthority: PublicKey | null;
 }
 
 /** TODO: docs */
 export const setAuthorityInstructionData = struct<SetAuthorityInstructionData>([
     u8('instruction'),
     u8('authorityType'),
-    u8('newAuthorityOption'),
-    publicKey('newAuthority'),
+    new COptionPublicKeyLayout('newAuthority'),
 ]);
 
 /**
@@ -72,8 +71,7 @@ export function createSetAuthorityInstruction(
         {
             instruction: TokenInstruction.SetAuthority,
             authorityType,
-            newAuthorityOption: newAuthority ? 1 : 0,
-            newAuthority: newAuthority || new PublicKey(0),
+            newAuthority,
         },
         data
     );
@@ -158,7 +156,7 @@ export function decodeSetAuthorityInstructionUnchecked({
     keys: [account, currentAuthority, ...multiSigners],
     data,
 }: TransactionInstruction): DecodedSetAuthorityInstructionUnchecked {
-    const { instruction, authorityType, newAuthorityOption, newAuthority } = setAuthorityInstructionData.decode(data);
+    const { instruction, authorityType, newAuthority } = setAuthorityInstructionData.decode(data);
 
     return {
         programId,
@@ -170,7 +168,7 @@ export function decodeSetAuthorityInstructionUnchecked({
         data: {
             instruction,
             authorityType,
-            newAuthority: newAuthorityOption ? newAuthority : null,
+            newAuthority,
         },
     };
 }