fix: add TypeScript buffer type to system-program.ts

web3.js/src/system-program.ts

@@ -1,6 +1,11 @@
 import * as BufferLayout from '@solana/buffer-layout';
 
-import {encodeData, decodeData, InstructionType} from './instruction';
+import {
+  encodeData,
+  decodeData,
+  InstructionType,
+  IInstructionInputData,
+} from './instruction';
 import * as Layout from './layout';
 import {NONCE_ACCOUNT_LENGTH} from './nonce-account';
 import {PublicKey} from './publickey';
@@ -517,6 +522,10 @@ export class SystemInstruction {
  * An enumeration of valid SystemInstructionType's
  */
 export type SystemInstructionType =
+  // FIXME
+  // It would be preferable for this type to be `keyof SystemInstructionInputData`
+  // but Typedoc does not transpile `keyof` expressions.
+  // See https://github.com/TypeStrong/typedoc/issues/1894
   | 'AdvanceNonceAccount'
   | 'Allocate'
   | 'AllocateWithSeed'
@@ -530,16 +539,68 @@ export type SystemInstructionType =
   | 'TransferWithSeed'
   | 'WithdrawNonceAccount';
 
+type SystemInstructionInputData = {
+  AdvanceNonceAccount: IInstructionInputData;
+  Allocate: IInstructionInputData & {
+    space: number;
+  };
+  AllocateWithSeed: IInstructionInputData & {
+    base: Uint8Array;
+    programId: Uint8Array;
+    seed: string;
+    space: number;
+  };
+  Assign: IInstructionInputData & {
+    programId: Uint8Array;
+  };
+  AssignWithSeed: IInstructionInputData & {
+    base: Uint8Array;
+    seed: string;
+    programId: Uint8Array;
+  };
+  AuthorizeNonceAccount: IInstructionInputData & {
+    authorized: Uint8Array;
+  };
+  Create: IInstructionInputData & {
+    lamports: number;
+    programId: Uint8Array;
+    space: number;
+  };
+  CreateWithSeed: IInstructionInputData & {
+    base: Uint8Array;
+    lamports: number;
+    programId: Uint8Array;
+    seed: string;
+    space: number;
+  };
+  InitializeNonceAccount: IInstructionInputData & {
+    authorized: Uint8Array;
+  };
+  Transfer: IInstructionInputData & {
+    lamports: number;
+  };
+  TransferWithSeed: IInstructionInputData & {
+    lamports: number;
+    programId: Uint8Array;
+    seed: string;
+  };
+  WithdrawNonceAccount: IInstructionInputData & {
+    lamports: number;
+  };
+};
+
 /**
  * An enumeration of valid system InstructionType's
  * @internal
  */
-export const SYSTEM_INSTRUCTION_LAYOUTS: {
+export const SYSTEM_INSTRUCTION_LAYOUTS = Object.freeze<{
-  [type in SystemInstructionType]: InstructionType;
+  [Instruction in SystemInstructionType]: InstructionType<
-} = Object.freeze({
+    SystemInstructionInputData[Instruction]
+  >;
+}>({
   Create: {
     index: 0,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['Create']>([
       BufferLayout.u32('instruction'),
       BufferLayout.ns64('lamports'),
       BufferLayout.ns64('space'),
@@ -548,21 +609,21 @@ export const SYSTEM_INSTRUCTION_LAYOUTS: {
   },
   Assign: {
     index: 1,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['Assign']>([
       BufferLayout.u32('instruction'),
       Layout.publicKey('programId'),
     ]),
   },
   Transfer: {
     index: 2,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['Transfer']>([
       BufferLayout.u32('instruction'),
       BufferLayout.ns64('lamports'),
     ]),
   },
   CreateWithSeed: {
     index: 3,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['CreateWithSeed']>([
       BufferLayout.u32('instruction'),
       Layout.publicKey('base'),
       Layout.rustString('seed'),
@@ -573,49 +634,50 @@ export const SYSTEM_INSTRUCTION_LAYOUTS: {
   },
   AdvanceNonceAccount: {
     index: 4,
-    layout: BufferLayout.struct([BufferLayout.u32('instruction')]),
+    layout: BufferLayout.struct<
+      SystemInstructionInputData['AdvanceNonceAccount']
+    >([BufferLayout.u32('instruction')]),
   },
   WithdrawNonceAccount: {
     index: 5,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<
-      BufferLayout.u32('instruction'),
+      SystemInstructionInputData['WithdrawNonceAccount']
-      BufferLayout.ns64('lamports'),
+    >([BufferLayout.u32('instruction'), BufferLayout.ns64('lamports')]),
-    ]),
   },
   InitializeNonceAccount: {
     index: 6,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<
-      BufferLayout.u32('instruction'),
+      SystemInstructionInputData['InitializeNonceAccount']
-      Layout.publicKey('authorized'),
+    >([BufferLayout.u32('instruction'), Layout.publicKey('authorized')]),
-    ]),
   },
   AuthorizeNonceAccount: {
     index: 7,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<
-      BufferLayout.u32('instruction'),
+      SystemInstructionInputData['AuthorizeNonceAccount']
-      Layout.publicKey('authorized'),
+    >([BufferLayout.u32('instruction'), Layout.publicKey('authorized')]),
-    ]),
   },
   Allocate: {
     index: 8,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['Allocate']>([
       BufferLayout.u32('instruction'),
       BufferLayout.ns64('space'),
     ]),
   },
   AllocateWithSeed: {
     index: 9,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['AllocateWithSeed']>(
+      [
         BufferLayout.u32('instruction'),
         Layout.publicKey('base'),
         Layout.rustString('seed'),
         BufferLayout.ns64('space'),
         Layout.publicKey('programId'),
-    ]),
+      ],
+    ),
   },
   AssignWithSeed: {
     index: 10,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['AssignWithSeed']>([
       BufferLayout.u32('instruction'),
       Layout.publicKey('base'),
       Layout.rustString('seed'),
@@ -624,12 +686,14 @@ export const SYSTEM_INSTRUCTION_LAYOUTS: {
   },
   TransferWithSeed: {
     index: 11,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<SystemInstructionInputData['TransferWithSeed']>(
+      [
         BufferLayout.u32('instruction'),
         BufferLayout.ns64('lamports'),
         Layout.rustString('seed'),
         Layout.publicKey('programId'),
-    ]),
+      ],
+    ),
   },
 });