@solana/web3.js 1.36.0 → 1.37.0

package/src/secp256k1-program.ts

@@ -46,7 +46,21 @@ export type CreateSecp256k1InstructionWithPrivateKeyParams = {
   instructionIndex?: number;
 };
 
-const SECP256K1_INSTRUCTION_LAYOUT = BufferLayout.struct([
+const SECP256K1_INSTRUCTION_LAYOUT = BufferLayout.struct<
+  Readonly<{
+    ethAddress: Uint8Array;
+    ethAddressInstructionIndex: number;
+    ethAddressOffset: number;
+    messageDataOffset: number;
+    messageDataSize: number;
+    messageInstructionIndex: number;
+    numSignatures: number;
+    recoveryId: number;
+    signature: Uint8Array;
+    signatureInstructionIndex: number;
+    signatureOffset: number;
+  }>
+>([
   BufferLayout.u8('numSignatures'),
   BufferLayout.u16('signatureOffset'),
   BufferLayout.u8('signatureInstructionIndex'),

package/src/stake-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 {PublicKey} from './publickey';
 import {SystemProgram} from './system-program';
@@ -40,6 +45,11 @@ export class Authorized {
   }
 }
 
+type AuthorizedRaw = Readonly<{
+  staker: Uint8Array;
+  withdrawer: Uint8Array;
+}>;
+
 /**
  * Stake account lockup info
  */
@@ -66,6 +76,12 @@ export class Lockup {
   static default: Lockup = new Lockup(0, 0, PublicKey.default);
 }
 
+type LockupRaw = Readonly<{
+  custodian: Uint8Array;
+  epoch: number;
+  unixTimestamp: number;
+}>;
+
 /**
  * Create stake account transaction params
  */
@@ -429,25 +445,63 @@ export class StakeInstruction {
  * An enumeration of valid StakeInstructionType's
  */
 export type StakeInstructionType =
-  | 'AuthorizeWithSeed'
+  // FIXME
+  // It would be preferable for this type to be `keyof StakeInstructionInputData`
+  // but Typedoc does not transpile `keyof` expressions.
+  // See https://github.com/TypeStrong/typedoc/issues/1894
   | 'Authorize'
+  | 'AuthorizeWithSeed'
   | 'Deactivate'
   | 'Delegate'
   | 'Initialize'
+  | 'Merge'
   | 'Split'
-  | 'Withdraw'
-  | 'Merge';
+  | 'Withdraw';
+
+type StakeInstructionInputData = {
+  Authorize: IInstructionInputData &
+    Readonly<{
+      newAuthorized: Uint8Array;
+      stakeAuthorizationType: number;
+    }>;
+  AuthorizeWithSeed: IInstructionInputData &
+    Readonly<{
+      authorityOwner: Uint8Array;
+      authoritySeed: string;
+      instruction: number;
+      newAuthorized: Uint8Array;
+      stakeAuthorizationType: number;
+    }>;
+  Deactivate: IInstructionInputData;
+  Delegate: IInstructionInputData;
+  Initialize: IInstructionInputData &
+    Readonly<{
+      authorized: AuthorizedRaw;
+      lockup: LockupRaw;
+    }>;
+  Merge: IInstructionInputData;
+  Split: IInstructionInputData &
+    Readonly<{
+      lamports: number;
+    }>;
+  Withdraw: IInstructionInputData &
+    Readonly<{
+      lamports: number;
+    }>;
+};
 
 /**
  * An enumeration of valid stake InstructionType's
  * @internal
  */
-export const STAKE_INSTRUCTION_LAYOUTS: {
-  [type in StakeInstructionType]: InstructionType;
-} = Object.freeze({
+export const STAKE_INSTRUCTION_LAYOUTS = Object.freeze<{
+  [Instruction in StakeInstructionType]: InstructionType<
+    StakeInstructionInputData[Instruction]
+  >;
+}>({
   Initialize: {
     index: 0,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<StakeInstructionInputData['Initialize']>([
       BufferLayout.u32('instruction'),
       Layout.authorized(),
       Layout.lockup(),
@@ -455,7 +509,7 @@ export const STAKE_INSTRUCTION_LAYOUTS: {
   },
   Authorize: {
     index: 1,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<StakeInstructionInputData['Authorize']>([
       BufferLayout.u32('instruction'),
       Layout.publicKey('newAuthorized'),
       BufferLayout.u32('stakeAuthorizationType'),
@@ -463,39 +517,47 @@ export const STAKE_INSTRUCTION_LAYOUTS: {
   },
   Delegate: {
     index: 2,
-    layout: BufferLayout.struct([BufferLayout.u32('instruction')]),
+    layout: BufferLayout.struct<StakeInstructionInputData['Delegate']>([
+      BufferLayout.u32('instruction'),
+    ]),
   },
   Split: {
     index: 3,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<StakeInstructionInputData['Split']>([
       BufferLayout.u32('instruction'),
       BufferLayout.ns64('lamports'),
     ]),
   },
   Withdraw: {
     index: 4,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<StakeInstructionInputData['Withdraw']>([
       BufferLayout.u32('instruction'),
       BufferLayout.ns64('lamports'),
     ]),
   },
   Deactivate: {
     index: 5,
-    layout: BufferLayout.struct([BufferLayout.u32('instruction')]),
+    layout: BufferLayout.struct<StakeInstructionInputData['Deactivate']>([
+      BufferLayout.u32('instruction'),
+    ]),
   },
   Merge: {
     index: 7,
-    layout: BufferLayout.struct([BufferLayout.u32('instruction')]),
+    layout: BufferLayout.struct<StakeInstructionInputData['Merge']>([
+      BufferLayout.u32('instruction'),
+    ]),
   },
   AuthorizeWithSeed: {
     index: 8,
-    layout: BufferLayout.struct([
-      BufferLayout.u32('instruction'),
-      Layout.publicKey('newAuthorized'),
-      BufferLayout.u32('stakeAuthorizationType'),
-      Layout.rustString('authoritySeed'),
-      Layout.publicKey('authorityOwner'),
-    ]),
+    layout: BufferLayout.struct<StakeInstructionInputData['AuthorizeWithSeed']>(
+      [
+        BufferLayout.u32('instruction'),
+        Layout.publicKey('newAuthorized'),
+        BufferLayout.u32('stakeAuthorizationType'),
+        Layout.rustString('authoritySeed'),
+        Layout.publicKey('authorityOwner'),
+      ],
+    ),
   },
 });
 

package/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: {
-  [type in SystemInstructionType]: InstructionType;
-} = Object.freeze({
+export const SYSTEM_INSTRUCTION_LAYOUTS = Object.freeze<{
+  [Instruction in SystemInstructionType]: InstructionType<
+    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([
-      BufferLayout.u32('instruction'),
-      BufferLayout.ns64('lamports'),
-    ]),
+    layout: BufferLayout.struct<
+      SystemInstructionInputData['WithdrawNonceAccount']
+    >([BufferLayout.u32('instruction'), BufferLayout.ns64('lamports')]),
   },
   InitializeNonceAccount: {
     index: 6,
-    layout: BufferLayout.struct([
-      BufferLayout.u32('instruction'),
-      Layout.publicKey('authorized'),
-    ]),
+    layout: BufferLayout.struct<
+      SystemInstructionInputData['InitializeNonceAccount']
+    >([BufferLayout.u32('instruction'), Layout.publicKey('authorized')]),
   },
   AuthorizeNonceAccount: {
     index: 7,
-    layout: BufferLayout.struct([
-      BufferLayout.u32('instruction'),
-      Layout.publicKey('authorized'),
-    ]),
+    layout: BufferLayout.struct<
+      SystemInstructionInputData['AuthorizeNonceAccount']
+    >([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([
-      BufferLayout.u32('instruction'),
-      Layout.publicKey('base'),
-      Layout.rustString('seed'),
-      BufferLayout.ns64('space'),
-      Layout.publicKey('programId'),
-    ]),
+    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([
-      BufferLayout.u32('instruction'),
-      BufferLayout.ns64('lamports'),
-      Layout.rustString('seed'),
-      Layout.publicKey('programId'),
-    ]),
+    layout: BufferLayout.struct<SystemInstructionInputData['TransferWithSeed']>(
+      [
+        BufferLayout.u32('instruction'),
+        BufferLayout.ns64('lamports'),
+        Layout.rustString('seed'),
+        Layout.publicKey('programId'),
+      ],
+    ),
   },
 });
 

package/src/transaction.ts

@@ -2,6 +2,7 @@ import nacl from 'tweetnacl';
 import bs58 from 'bs58';
 import {Buffer} from 'buffer';
 
+import {Connection} from './connection';
 import {Message} from './message';
 import {PublicKey} from './publickey';
 import * as shortvec from './util/shortvec-encoding';
@@ -405,6 +406,13 @@ export class Transaction {
     return this._compile().serialize();
   }
 
+  /**
+   * Get the estimated fee associated with a transaction
+   */
+  async getEstimatedFee(connection: Connection): Promise<number> {
+    return (await connection.getFeeForMessage(this.compileMessage())).value;
+  }
+
   /**
    * Specify the public keys which will be used to sign the Transaction.
    * The first signer will be used as the transaction fee payer account.

package/src/vote-account.ts

@@ -17,39 +17,69 @@ export type Lockout = {
 /**
  * History of how many credits earned by the end of each epoch
  */
-export type EpochCredits = {
+export type EpochCredits = Readonly<{
   epoch: number;
   credits: number;
   prevCredits: number;
-};
+}>;
 
-export type AuthorizedVoter = {
+export type AuthorizedVoter = Readonly<{
   epoch: number;
   authorizedVoter: PublicKey;
-};
+}>;
 
-export type PriorVoter = {
+type AuthorizedVoterRaw = Readonly<{
+  authorizedVoter: Uint8Array;
+  epoch: number;
+}>;
+
+type PriorVoters = Readonly<{
+  buf: PriorVoterRaw[];
+  idx: number;
+  isEmpty: number;
+}>;
+
+export type PriorVoter = Readonly<{
   authorizedPubkey: PublicKey;
   epochOfLastAuthorizedSwitch: number;
   targetEpoch: number;
-};
+}>;
 
-export type BlockTimestamp = {
+type PriorVoterRaw = Readonly<{
+  authorizedPubkey: Uint8Array;
+  epochOfLastAuthorizedSwitch: number;
+  targetEpoch: number;
+}>;
+
+export type BlockTimestamp = Readonly<{
   slot: number;
-  timetamp: number;
-};
+  timestamp: number;
+}>;
+
+type VoteAccountData = Readonly<{
+  authorizedVoters: AuthorizedVoterRaw[];
+  authorizedWithdrawer: Uint8Array;
+  commission: number;
+  epochCredits: EpochCredits[];
+  lastTimestamp: BlockTimestamp;
+  nodePubkey: Uint8Array;
+  priorVoters: PriorVoters;
+  rootSlot: number;
+  rootSlotValid: number;
+  votes: Lockout[];
+}>;
 
 /**
  * See https://github.com/solana-labs/solana/blob/8a12ed029cfa38d4a45400916c2463fb82bbec8c/programs/vote_api/src/vote_state.rs#L68-L88
  *
  * @internal
  */
-const VoteAccountLayout = BufferLayout.struct([
+const VoteAccountLayout = BufferLayout.struct<VoteAccountData>([
   Layout.publicKey('nodePubkey'),
   Layout.publicKey('authorizedWithdrawer'),
   BufferLayout.u8('commission'),
   BufferLayout.nu64(), // votes.length
-  BufferLayout.seq(
+  BufferLayout.seq<Lockout>(
     BufferLayout.struct([
       BufferLayout.nu64('slot'),
       BufferLayout.u32('confirmationCount'),
@@ -60,7 +90,7 @@ const VoteAccountLayout = BufferLayout.struct([
   BufferLayout.u8('rootSlotValid'),
   BufferLayout.nu64('rootSlot'),
   BufferLayout.nu64(), // authorizedVoters.length
-  BufferLayout.seq(
+  BufferLayout.seq<AuthorizedVoterRaw>(
     BufferLayout.struct([
       BufferLayout.nu64('epoch'),
       Layout.publicKey('authorizedVoter'),
@@ -68,7 +98,7 @@ const VoteAccountLayout = BufferLayout.struct([
     BufferLayout.offset(BufferLayout.u32(), -8),
     'authorizedVoters',
   ),
-  BufferLayout.struct(
+  BufferLayout.struct<PriorVoters>(
     [
       BufferLayout.seq(
         BufferLayout.struct([
@@ -85,7 +115,7 @@ const VoteAccountLayout = BufferLayout.struct([
     'priorVoters',
   ),
   BufferLayout.nu64(), // epochCredits.length
-  BufferLayout.seq(
+  BufferLayout.seq<EpochCredits>(
     BufferLayout.struct([
       BufferLayout.nu64('epoch'),
       BufferLayout.nu64('credits'),
@@ -94,7 +124,7 @@ const VoteAccountLayout = BufferLayout.struct([
     BufferLayout.offset(BufferLayout.u32(), -8),
     'epochCredits',
   ),
-  BufferLayout.struct(
+  BufferLayout.struct<BlockTimestamp>(
     [BufferLayout.nu64('slot'), BufferLayout.nu64('timestamp')],
     'lastTimestamp',
   ),
@@ -172,7 +202,10 @@ export class VoteAccount {
   }
 }
 
-function parseAuthorizedVoter({epoch, authorizedVoter}: AuthorizedVoter) {
+function parseAuthorizedVoter({
+  authorizedVoter,
+  epoch,
+}: AuthorizedVoterRaw): AuthorizedVoter {
   return {
     epoch,
     authorizedVoter: new PublicKey(authorizedVoter),
@@ -183,7 +216,7 @@ function parsePriorVoters({
   authorizedPubkey,
   epochOfLastAuthorizedSwitch,
   targetEpoch,
-}: PriorVoter) {
+}: PriorVoterRaw): PriorVoter {
   return {
     authorizedPubkey: new PublicKey(authorizedPubkey),
     epochOfLastAuthorizedSwitch,
@@ -191,18 +224,13 @@ function parsePriorVoters({
   };
 }
 
-function getPriorVoters({
-  buf,
-  idx,
-  isEmpty,
-}: {
-  buf: PriorVoter[];
-  idx: number;
-  isEmpty: boolean;
-}): PriorVoter[] {
+function getPriorVoters({buf, idx, isEmpty}: PriorVoters): PriorVoter[] {
   if (isEmpty) {
     return [];
   }
 
-  return [...buf.slice(idx + 1).map(parsePriorVoters), ...buf.slice(0, idx)];
+  return [
+    ...buf.slice(idx + 1).map(parsePriorVoters),
+    ...buf.slice(0, idx).map(parsePriorVoters),
+  ];
 }

package/src/vote-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 {PublicKey} from './publickey';
 import {SystemProgram} from './system-program';
@@ -202,23 +207,45 @@ export class VoteInstruction {
  * An enumeration of valid VoteInstructionType's
  */
 export type VoteInstructionType =
-  | 'Authorize'
-  | 'InitializeAccount'
-  | 'Withdraw';
+  // FIXME
+  // It would be preferable for this type to be `keyof VoteInstructionInputData`
+  // but Typedoc does not transpile `keyof` expressions.
+  // See https://github.com/TypeStrong/typedoc/issues/1894
+  'Authorize' | 'InitializeAccount' | 'Withdraw';
+
+type VoteInstructionInputData = {
+  Authorize: IInstructionInputData & {
+    newAuthorized: Uint8Array;
+    voteAuthorizationType: number;
+  };
+  InitializeAccount: IInstructionInputData & {
+    voteInit: Readonly<{
+      authorizedVoter: Uint8Array;
+      authorizedWithdrawer: Uint8Array;
+      commission: number;
+      nodePubkey: Uint8Array;
+    }>;
+  };
+  Withdraw: IInstructionInputData & {
+    lamports: number;
+  };
+};
 
-const VOTE_INSTRUCTION_LAYOUTS: {
-  [type in VoteInstructionType]: InstructionType;
-} = Object.freeze({
+const VOTE_INSTRUCTION_LAYOUTS = Object.freeze<{
+  [Instruction in VoteInstructionType]: InstructionType<
+    VoteInstructionInputData[Instruction]
+  >;
+}>({
   InitializeAccount: {
     index: 0,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<VoteInstructionInputData['InitializeAccount']>([
       BufferLayout.u32('instruction'),
       Layout.voteInit(),
     ]),
   },
   Authorize: {
     index: 1,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<VoteInstructionInputData['Authorize']>([
       BufferLayout.u32('instruction'),
       Layout.publicKey('newAuthorized'),
       BufferLayout.u32('voteAuthorizationType'),
@@ -226,7 +253,7 @@ const VOTE_INSTRUCTION_LAYOUTS: {
   },
   Withdraw: {
     index: 3,
-    layout: BufferLayout.struct([
+    layout: BufferLayout.struct<VoteInstructionInputData['Withdraw']>([
       BufferLayout.u32('instruction'),
       BufferLayout.ns64('lamports'),
     ]),