token-js: Allow (Signer | PublicKey)[] instead of Signer[] when possible (#3967)

mPaella · web-flow · commit befea2c0a8fa · 2023-01-10T20:59:44.000+01:00
* Allow PublicKey[] | Signer[] instead of Signer[] when possible

* Change Signer[] | PublicKey[] to (Signer | PublicKey)[]
diff --git a/token/js/src/extensions/cpiGuard/instructions.ts b/token/js/src/extensions/cpiGuard/instructions.ts
@@ -3,6 +3,7 @@ import type { PublicKey, Signer } from '@solana/web3.js';
 import { TransactionInstruction } from '@solana/web3.js';
 import { programSupportsExtensions, TOKEN_2022_PROGRAM_ID } from '../../constants.js';
 import { TokenUnsupportedInstructionError } from '../../errors.js';
+import { addSigners } from '../../instructions/internal.js';
 import { TokenInstruction } from '../../instructions/types.js';
 
 export enum CpiGuardInstruction {
@@ -32,7 +33,7 @@ export const cpiGuardInstructionData = struct<CpiGuardInstructionData>([u8('inst
 export function createEnableCpiGuardInstruction(
     account: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     return createCpiGuardInstruction(CpiGuardInstruction.Enable, account, authority, multiSigners, programId);
@@ -51,7 +52,7 @@ export function createEnableCpiGuardInstruction(
 export function createDisableCpiGuardInstruction(
     account: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     return createCpiGuardInstruction(CpiGuardInstruction.Disable, account, authority, multiSigners, programId);
@@ -61,17 +62,13 @@ function createCpiGuardInstruction(
     cpiGuardInstruction: CpiGuardInstruction,
     account: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[],
+    multiSigners: (Signer | PublicKey)[],
     programId: PublicKey
 ): TransactionInstruction {
     if (!programSupportsExtensions(programId)) {
         throw new TokenUnsupportedInstructionError();
     }
-    const keys = [{ pubkey: account, isSigner: false, isWritable: true }];
-    keys.push({ pubkey: authority, isSigner: !multiSigners.length, isWritable: false });
-    for (const signer of multiSigners) {
-        keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
-    }
+    const keys = addSigners([{ pubkey: account, isSigner: false, isWritable: true }], authority, multiSigners);
 
     const data = Buffer.alloc(cpiGuardInstructionData.span);
     cpiGuardInstructionData.encode(
diff --git a/token/js/src/extensions/defaultAccountState/instructions.ts b/token/js/src/extensions/defaultAccountState/instructions.ts
@@ -3,6 +3,7 @@ import type { PublicKey, Signer } from '@solana/web3.js';
 import { TransactionInstruction } from '@solana/web3.js';
 import { programSupportsExtensions, TOKEN_2022_PROGRAM_ID } from '../../constants.js';
 import { TokenUnsupportedInstructionError } from '../../errors.js';
+import { addSigners } from '../../instructions/internal.js';
 import { TokenInstruction } from '../../instructions/types.js';
 import type { AccountState } from '../../state/account.js';
 
@@ -71,18 +72,14 @@ export function createUpdateDefaultAccountStateInstruction(
     mint: PublicKey,
     accountState: AccountState,
     freezeAuthority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     if (!programSupportsExtensions(programId)) {
         throw new TokenUnsupportedInstructionError();
     }
-    const keys = [{ pubkey: mint, isSigner: false, isWritable: true }];
-    keys.push({ pubkey: freezeAuthority, isSigner: !multiSigners.length, isWritable: false });
-    for (const signer of multiSigners) {
-        keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
-    }
 
+    const keys = addSigners([{ pubkey: mint, isSigner: false, isWritable: true }], freezeAuthority, multiSigners);
     const data = Buffer.alloc(defaultAccountStateInstructionData.span);
     defaultAccountStateInstructionData.encode(
         {
diff --git a/token/js/src/extensions/interestBearingMint/instructions.ts b/token/js/src/extensions/interestBearingMint/instructions.ts
@@ -83,7 +83,7 @@ export function createUpdateRateInterestBearingMintInstruction(
     mint: PublicKey,
     rateAuthority: PublicKey,
     rate: number,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ) {
     const keys = addSigners(
diff --git a/token/js/src/extensions/memoTransfer/instructions.ts b/token/js/src/extensions/memoTransfer/instructions.ts
@@ -3,6 +3,7 @@ import type { PublicKey, Signer } from '@solana/web3.js';
 import { TransactionInstruction } from '@solana/web3.js';
 import { programSupportsExtensions, TOKEN_2022_PROGRAM_ID } from '../../constants.js';
 import { TokenUnsupportedInstructionError } from '../../errors.js';
+import { addSigners } from '../../instructions/internal.js';
 import { TokenInstruction } from '../../instructions/types.js';
 
 export enum MemoTransferInstruction {
@@ -35,7 +36,7 @@ export const memoTransferInstructionData = struct<MemoTransferInstructionData>([
 export function createEnableRequiredMemoTransfersInstruction(
     account: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     return createMemoTransferInstruction(MemoTransferInstruction.Enable, account, authority, multiSigners, programId);
@@ -54,7 +55,7 @@ export function createEnableRequiredMemoTransfersInstruction(
 export function createDisableRequiredMemoTransfersInstruction(
     account: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     return createMemoTransferInstruction(MemoTransferInstruction.Disable, account, authority, multiSigners, programId);
@@ -64,18 +65,14 @@ function createMemoTransferInstruction(
     memoTransferInstruction: MemoTransferInstruction,
     account: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[],
+    multiSigners: (Signer | PublicKey)[],
     programId: PublicKey
 ): TransactionInstruction {
     if (!programSupportsExtensions(programId)) {
         throw new TokenUnsupportedInstructionError();
     }
-    const keys = [{ pubkey: account, isSigner: false, isWritable: true }];
-    keys.push({ pubkey: authority, isSigner: !multiSigners.length, isWritable: false });
-    for (const signer of multiSigners) {
-        keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
-    }
 
+    const keys = addSigners([{ pubkey: account, isSigner: false, isWritable: true }], authority, multiSigners);
     const data = Buffer.alloc(memoTransferInstructionData.span);
     memoTransferInstructionData.encode(
         {
diff --git a/token/js/src/extensions/transferFee/instructions.ts b/token/js/src/extensions/transferFee/instructions.ts
@@ -10,6 +10,7 @@ import {
     TokenInvalidInstructionTypeError,
     TokenUnsupportedInstructionError,
 } from '../../errors.js';
+import { addSigners } from '../../instructions/internal.js';
 import { TokenInstruction } from '../../instructions/types.js';
 
 export enum TransferFeeInstruction {
@@ -237,7 +238,7 @@ export function createTransferCheckedWithFeeInstruction(
     amount: bigint,
     decimals: number,
     fee: bigint,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     if (!programSupportsExtensions(programId)) {
@@ -254,14 +255,15 @@ export function createTransferCheckedWithFeeInstruction(
         },
         data
     );
-    const keys: AccountMeta[] = [];
-    keys.push({ pubkey: source, isSigner: false, isWritable: true });
-    keys.push({ pubkey: mint, isSigner: false, isWritable: false });
-    keys.push({ pubkey: destination, isSigner: false, isWritable: true });
-    keys.push({ pubkey: authority, isSigner: !multiSigners.length, isWritable: false });
-    for (const signer of multiSigners) {
-        keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
-    }
+    const keys = addSigners(
+        [
+            { pubkey: source, isSigner: false, isWritable: true },
+            { pubkey: mint, isSigner: false, isWritable: false },
+            { pubkey: destination, isSigner: false, isWritable: true },
+        ],
+        authority,
+        multiSigners
+    );
     return new TransactionInstruction({ keys, programId, data });
 }
 
@@ -403,7 +405,7 @@ export function createWithdrawWithheldTokensFromMintInstruction(
     mint: PublicKey,
     destination: PublicKey,
     authority: PublicKey,
-    signers: Signer[] = [],
+    signers: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     if (!programSupportsExtensions(programId)) {
@@ -417,15 +419,14 @@ export function createWithdrawWithheldTokensFromMintInstruction(
         },
         data
     );
-    const keys: AccountMeta[] = [];
-    keys.push(
-        { pubkey: mint, isSigner: false, isWritable: true },
-        { pubkey: destination, isSigner: false, isWritable: true },
-        { pubkey: authority, isSigner: !signers.length, isWritable: false }
+    const keys = addSigners(
+        [
+            { pubkey: mint, isSigner: false, isWritable: true },
+            { pubkey: destination, isSigner: false, isWritable: true },
+        ],
+        authority,
+        signers
     );
-    for (const signer of signers) {
-        keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
-    }
     return new TransactionInstruction({ keys, programId, data });
 }
 
@@ -557,7 +558,7 @@ export function createWithdrawWithheldTokensFromAccountsInstruction(
     mint: PublicKey,
     destination: PublicKey,
     authority: PublicKey,
-    signers: Signer[],
+    signers: (Signer | PublicKey)[],
     sources: PublicKey[],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
@@ -573,15 +574,14 @@ export function createWithdrawWithheldTokensFromAccountsInstruction(
         },
         data
     );
-    const keys: AccountMeta[] = [];
-    keys.push(
-        { pubkey: mint, isSigner: false, isWritable: true },
-        { pubkey: destination, isSigner: false, isWritable: true },
-        { pubkey: authority, isSigner: !signers.length, isWritable: false }
+    const keys = addSigners(
+        [
+            { pubkey: mint, isSigner: false, isWritable: true },
+            { pubkey: destination, isSigner: false, isWritable: true },
+        ],
+        authority,
+        signers
     );
-    for (const signer of signers) {
-        keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
-    }
     for (const source of sources) {
         keys.push({ pubkey: source, isSigner: false, isWritable: true });
     }
diff --git a/token/js/src/instructions/approve.ts b/token/js/src/instructions/approve.ts
@@ -38,7 +38,7 @@ export function createApproveInstruction(
     delegate: PublicKey,
     owner: PublicKey,
     amount: number | bigint,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/approveChecked.ts b/token/js/src/instructions/approveChecked.ts
@@ -47,7 +47,7 @@ export function createApproveCheckedInstruction(
     owner: PublicKey,
     amount: number | bigint,
     decimals: number,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/burn.ts b/token/js/src/instructions/burn.ts
@@ -38,7 +38,7 @@ export function createBurnInstruction(
     mint: PublicKey,
     owner: PublicKey,
     amount: number | bigint,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/burnChecked.ts b/token/js/src/instructions/burnChecked.ts
@@ -45,7 +45,7 @@ export function createBurnCheckedInstruction(
     owner: PublicKey,
     amount: number | bigint,
     decimals: number,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/closeAccount.ts b/token/js/src/instructions/closeAccount.ts
@@ -34,7 +34,7 @@ export function createCloseAccountInstruction(
     account: PublicKey,
     destination: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/freezeAccount.ts b/token/js/src/instructions/freezeAccount.ts
@@ -34,7 +34,7 @@ export function createFreezeAccountInstruction(
     account: PublicKey,
     mint: PublicKey,
     authority: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/initializeMultisig.ts b/token/js/src/instructions/initializeMultisig.ts
@@ -1,13 +1,14 @@
 import { struct, u8 } from '@solana/buffer-layout';
-import type { AccountMeta, PublicKey } from '@solana/web3.js';
-import { SYSVAR_RENT_PUBKEY, TransactionInstruction } from '@solana/web3.js';
+import type { AccountMeta, Signer } from '@solana/web3.js';
+import { PublicKey, SYSVAR_RENT_PUBKEY, TransactionInstruction } from '@solana/web3.js';
 import { TOKEN_PROGRAM_ID } from '../constants.js';
 import {
     TokenInvalidInstructionDataError,
     TokenInvalidInstructionKeysError,
     TokenInvalidInstructionProgramError,
     TokenInvalidInstructionTypeError,
 } from '../errors.js';
+import { addSigners } from './internal.js';
 import { TokenInstruction } from './types.js';
 
 /** TODO: docs */
@@ -34,7 +35,7 @@ export const initializeMultisigInstructionData = struct<InitializeMultisigInstru
  */
 export function createInitializeMultisigInstruction(
     account: PublicKey,
-    signers: PublicKey[],
+    signers: (Signer | PublicKey)[],
     m: number,
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
@@ -43,7 +44,11 @@ export function createInitializeMultisigInstruction(
         { pubkey: SYSVAR_RENT_PUBKEY, isSigner: false, isWritable: false },
     ];
     for (const signer of signers) {
-        keys.push({ pubkey: signer, isSigner: false, isWritable: false });
+        keys.push({
+            pubkey: signer instanceof PublicKey ? signer : signer.publicKey,
+            isSigner: false,
+            isWritable: false,
+        });
     }
 
     const data = Buffer.alloc(initializeMultisigInstructionData.span);
diff --git a/token/js/src/instructions/internal.ts b/token/js/src/instructions/internal.ts
@@ -1,11 +1,20 @@
-import type { AccountMeta, PublicKey, Signer } from '@solana/web3.js';
+import type { AccountMeta, Signer } from '@solana/web3.js';
+import { PublicKey } from '@solana/web3.js';
 
 /** @internal */
-export function addSigners(keys: AccountMeta[], ownerOrAuthority: PublicKey, multiSigners: Signer[]): AccountMeta[] {
+export function addSigners(
+    keys: AccountMeta[],
+    ownerOrAuthority: PublicKey,
+    multiSigners: (Signer | PublicKey)[]
+): AccountMeta[] {
     if (multiSigners.length) {
         keys.push({ pubkey: ownerOrAuthority, isSigner: false, isWritable: false });
         for (const signer of multiSigners) {
-            keys.push({ pubkey: signer.publicKey, isSigner: true, isWritable: false });
+            keys.push({
+                pubkey: signer instanceof PublicKey ? signer : signer.publicKey,
+                isSigner: true,
+                isWritable: false,
+            });
         }
     } else {
         keys.push({ pubkey: ownerOrAuthority, isSigner: true, isWritable: false });
diff --git a/token/js/src/instructions/mintTo.ts b/token/js/src/instructions/mintTo.ts
@@ -38,7 +38,7 @@ export function createMintToInstruction(
     destination: PublicKey,
     authority: PublicKey,
     amount: number | bigint,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/mintToChecked.ts b/token/js/src/instructions/mintToChecked.ts
@@ -45,7 +45,7 @@ export function createMintToCheckedInstruction(
     authority: PublicKey,
     amount: number | bigint,
     decimals: number,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners(
diff --git a/token/js/src/instructions/reallocate.ts b/token/js/src/instructions/reallocate.ts
@@ -30,7 +30,7 @@ export function createReallocateInstruction(
     payer: PublicKey,
     extensionTypes: ExtensionType[],
     owner: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_2022_PROGRAM_ID
 ): TransactionInstruction {
     if (!programSupportsExtensions(programId)) {
diff --git a/token/js/src/instructions/revoke.ts b/token/js/src/instructions/revoke.ts
@@ -32,7 +32,7 @@ export const revokeInstructionData = struct<RevokeInstructionData>([u8('instruct
 export function createRevokeInstruction(
     account: PublicKey,
     owner: PublicKey,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners([{ pubkey: account, isSigner: false, isWritable: true }], owner, multiSigners);
diff --git a/token/js/src/instructions/setAuthority.ts b/token/js/src/instructions/setAuthority.ts
@@ -53,7 +53,7 @@ export function createSetAuthorityInstruction(
     currentAuthority: PublicKey,
     authorityType: AuthorityType,
     newAuthority: PublicKey | null,
-    multiSigners: Signer[] = [],
+    multiSigners: (Signer | PublicKey)[] = [],
     programId = TOKEN_PROGRAM_ID
 ): TransactionInstruction {
     const keys = addSigners([{ pubkey: account, isSigner: false, isWritable: true }], currentAuthority, multiSigners);
diff --git a/token/js/src/instructions/thawAccount.ts b/token/js/src/instructions/thawAccount.ts
diff --git a/token/js/src/instructions/transfer.ts b/token/js/src/instructions/transfer.ts
diff --git a/token/js/src/instructions/transferChecked.ts b/token/js/src/instructions/transferChecked.ts
