@solana/web3.js 1.35.0 → 1.37.0

package/module.flow.js

@@ -1,7 +1,7 @@
 /**
  * Flowtype definitions for index
  * Generated by Flowgen from a Typescript Definition
- * Flowgen v1.16.0
+ * Flowgen v1.17.0
  */
 
 declare module "@solana/web3.js" {
@@ -570,6 +570,11 @@ declare module "@solana/web3.js" {
      */
     serializeMessage(): Buffer;
 
+    /**
+     * Get the estimated fee associated with a transaction
+     */
+    getEstimatedFee(connection: Connection): Promise<number>;
+
     /**
      * Specify the public keys which will be used to sign the Transaction.
      * The first signer will be used as the transaction fee payer account.
@@ -1027,7 +1032,7 @@ declare module "@solana/web3.js" {
   declare export type SimulatedTransactionResponse = {
     err: TransactionError | string | null,
     logs: Array<string> | null,
-    accounts?: SimulatedTransactionAccountInfo[] | null,
+    accounts?: (SimulatedTransactionAccountInfo | null)[] | null,
     unitsConsumed?: number,
     ...
   };
@@ -1498,6 +1503,61 @@ declare module "@solana/web3.js" {
     ...
   };
 
+  /**
+   * recent block production information
+   */
+  declare export type BlockProduction = $ReadOnly<{
+    /**
+     * a dictionary of validator identities, as base-58 encoded strings. Value is a two element array containing the number of leader slots and the number of blocks produced
+     */
+    byIdentity: $ReadOnly<{ [key: string]: $ReadOnlyArray<number>, ... }>,
+
+    /**
+     * Block production slot range
+     */
+    range: $ReadOnly<{
+      /**
+       * first slot of the block production information (inclusive)
+       */
+      firstSlot: number,
+
+      /**
+       * last slot of block production information (inclusive)
+       */
+      lastSlot: number,
+      ...
+    }>,
+    ...
+  }>;
+  declare export type GetBlockProductionConfig = {
+    /**
+     * Optional commitment level
+     */
+    commitment?: Commitment,
+
+    /**
+     * Slot range to return block production for. If parameter not provided, defaults to current epoch.
+     */
+    range?: {
+      /**
+       * first slot to return block production information for (inclusive)
+       */
+      firstSlot: number,
+
+      /**
+       * last slot to return block production information for (inclusive). If parameter not provided, defaults to the highest slot
+       */
+      lastSlot?: number,
+      ...
+    },
+
+    /**
+     * Only return results for this validator identity (base-58 encoded)
+     */
+    identity?: string,
+    ...
+  };
+
   /**
    * A performance sample
    */
@@ -2115,7 +2175,7 @@ declare module "@solana/web3.js" {
     fetchMiddleware?: FetchMiddleware,
 
     /**
-     * Optional Disable retring calls when server responds with HTTP 429 (Too Many Requests)
+     * Optional Disable retrying calls when server responds with HTTP 429 (Too Many Requests)
      */
     disableRetryOnRateLimit?: boolean,
 
@@ -2145,6 +2205,11 @@ declare module "@solana/web3.js" {
      */
     commitment: Commitment | void;
 
+    /**
+     * The RPC endpoint
+     */
+    rpcEndpoint: string;
+
     /**
      * Fetch the balance for the specified public key, return with context
      */
@@ -2281,13 +2346,21 @@ account: AccountInfo<ParsedAccountData>,...
       commitment?: Commitment
     ): Promise<AccountInfo<Buffer> | null>;
 
+    /**
+     * Fetch all the account info for multiple accounts specified by an array of public keys, return with context
+     */
+    getMultipleAccountsInfoAndContext(
+      publicKeys: PublicKey[],
+      commitment?: Commitment
+    ): Promise<RpcResponseAndContext<(AccountInfo<Buffer> | null)[]>>;
+
     /**
      * Fetch all the account info for multiple accounts specified by an array of public keys
      */
     getMultipleAccountsInfo(
       publicKeys: PublicKey[],
-      configOrCommitment?: GetMultipleAccountsConfig | Commitment
-    ): Promise<(AccountInfo<Buffer | ParsedAccountData> | null)[]>;
+      commitment?: Commitment
+    ): Promise<(AccountInfo<Buffer> | null)[]>;
 
     /**
      * Returns epoch activation information for a stake account that has been delegated
@@ -2536,6 +2609,10 @@ lastValidBlockHeight: number,...
         ...
       }
     ): Promise<BlockResponse | null>;
+    getBlockHeight(commitment?: Commitment): Promise<number>;
+    getBlockProduction(
+      configOrCommitment?: GetBlockProductionConfig | Commitment
+    ): Promise<RpcResponseAndContext<BlockProduction>>;
 
     /**
      * Fetch a confirmed or finalized transaction from the cluster.
@@ -3258,14 +3335,14 @@ lastValidBlockHeight: number,...
    * An enumeration of valid StakeInstructionType's
    */
   declare export type StakeInstructionType =
-    | "AuthorizeWithSeed"
     | "Authorize"
+    | "AuthorizeWithSeed"
     | "Deactivate"
     | "Delegate"
     | "Initialize"
+    | "Merge"
     | "Split"
-    | "Withdraw"
-    | "Merge";
+    | "Withdraw";
 
   /**
    * Stake authorization type
@@ -4055,28 +4132,28 @@ lastValidBlockHeight: number,...
   /**
    * History of how many credits earned by the end of each epoch
    */
-  declare export type EpochCredits = {
+  declare export type EpochCredits = $ReadOnly<{
     epoch: number,
     credits: number,
     prevCredits: number,
     ...
-  };
-  declare export type AuthorizedVoter = {
+  }>;
+  declare export type AuthorizedVoter = $ReadOnly<{
     epoch: number,
     authorizedVoter: PublicKey,
     ...
-  };
-  declare export type PriorVoter = {
+  }>;
+  declare export type PriorVoter = $ReadOnly<{
     authorizedPubkey: PublicKey,
     epochOfLastAuthorizedSwitch: number,
     targetEpoch: number,
     ...
-  };
-  declare export type BlockTimestamp = {
+  }>;
+  declare export type BlockTimestamp = $ReadOnly<{
     slot: number,
-    timetamp: number,
+    timestamp: number,
     ...
-  };
+  }>;
 
   /**
    * VoteAccount class

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.35.0",
+  "version": "1.37.0",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -20,7 +20,7 @@
     "access": "public"
   },
   "browser": {
-    "./lib/index.cjs.js": "./lib/index.browser.esm.js",
+    "./lib/index.cjs.js": "./lib/index.browser.cjs.js",
     "./lib/index.esm.js": "./lib/index.browser.esm.js"
   },
   "main": "lib/index.cjs.js",
@@ -48,7 +48,8 @@
     "type:gen": "./scripts/typegen.sh",
     "lint": "set -ex; npm run pretty; eslint . --ext .js,.ts",
     "lint:fix": "npm run pretty:fix && eslint . --fix --ext .js,.ts",
-    "ok": "run-s lint test doc",
+    "type:check": "tsc -p tsconfig.json --noEmit",
+    "ok": "run-s lint test doc type:check",
     "pretty": "prettier --check '{,{src,test}/**/}*.{j,t}s'",
     "pretty:fix": "prettier --write '{,{src,test}/**/}*.{j,t}s'",
     "re": "semantic-release --repository-url git@github.com:solana-labs/solana-web3.js.git",
@@ -60,9 +61,9 @@
   "dependencies": {
     "@babel/runtime": "^7.12.5",
     "@ethersproject/sha2": "^5.5.0",
-    "@solana/buffer-layout": "^3.0.0",
+    "@solana/buffer-layout": "^4.0.0",
     "bn.js": "^5.0.0",
-    "borsh": "^0.4.0",
+    "borsh": "^0.7.0",
     "bs58": "^4.0.1",
     "buffer": "6.0.1",
     "cross-fetch": "^3.1.4",

package/src/connection.ts

@@ -1,7 +1,6 @@
 import bs58 from 'bs58';
 import {Buffer} from 'buffer';
 import fetch from 'cross-fetch';
-import type {Response} from 'cross-fetch';
 import {
   type as pick,
   number,
@@ -469,7 +468,7 @@ export type SimulatedTransactionAccountInfo = {
 export type SimulatedTransactionResponse = {
   err: TransactionError | string | null;
   logs: Array<string> | null;
-  accounts?: SimulatedTransactionAccountInfo[] | null;
+  accounts?: (SimulatedTransactionAccountInfo | null)[] | null;
   unitsConsumed?: number;
 };
 
@@ -480,13 +479,15 @@ const SimulatedTransactionResponseStruct = jsonRpcResultAndContext(
     accounts: optional(
       nullable(
         array(
-          pick({
-            executable: boolean(),
-            owner: string(),
-            lamports: number(),
-            data: array(string()),
-            rentEpoch: optional(number()),
-          }),
+          nullable(
+            pick({
+              executable: boolean(),
+              owner: string(),
+              lamports: number(),
+              data: array(string()),
+              rentEpoch: optional(number()),
+            }),
+          ),
         ),
       ),
     ),
@@ -753,6 +754,48 @@ export type BlockSignatures = {
   blockTime: number | null;
 };
 
+/**
+ * recent block production information
+ */
+export type BlockProduction = Readonly<{
+  /** a dictionary of validator identities, as base-58 encoded strings. Value is a two element array containing the number of leader slots and the number of blocks produced */
+  byIdentity: Readonly<Record<string, ReadonlyArray<number>>>;
+  /** Block production slot range */
+  range: Readonly<{
+    /** first slot of the block production information (inclusive) */
+    firstSlot: number;
+    /** last slot of block production information (inclusive) */
+    lastSlot: number;
+  }>;
+}>;
+
+export type GetBlockProductionConfig = {
+  /** Optional commitment level */
+  commitment?: Commitment;
+  /** Slot range to return block production for. If parameter not provided, defaults to current epoch. */
+  range?: {
+    /** first slot to return block production information for (inclusive) */
+    firstSlot: number;
+    /** last slot to return block production information for (inclusive). If parameter not provided, defaults to the highest slot */
+    lastSlot?: number;
+  };
+  /** Only return results for this validator identity (base-58 encoded) */
+  identity?: string;
+};
+
+/**
+ * Expected JSON RPC response for the "getBlockProduction" message
+ */
+const BlockProductionResponseStruct = jsonRpcResultAndContext(
+  pick({
+    byIdentity: record(string(), array(number())),
+    range: pick({
+      firstSlot: number(),
+      lastSlot: number(),
+    }),
+  }),
+);
+
 /**
  * A performance sample
  */
@@ -2067,7 +2110,7 @@ export type ConnectionConfig = {
   httpHeaders?: HttpHeaders;
   /** Optional fetch middleware callback */
   fetchMiddleware?: FetchMiddleware;
-  /** Optional Disable retring calls when server responds with HTTP 429 (Too Many Requests) */
+  /** Optional Disable retrying calls when server responds with HTTP 429 (Too Many Requests) */
   disableRetryOnRateLimit?: boolean;
   /** time to allow for the server to initially process a transaction (in milliseconds) */
   confirmTransactionInitialTimeout?: number;
@@ -2228,6 +2271,13 @@ export class Connection {
     return this._commitment;
   }
 
+  /**
+   * The RPC endpoint
+   */
+  get rpcEndpoint(): string {
+    return this._rpcEndpoint;
+  }
+
   /**
    * Fetch the balance for the specified public key, return with context
    */
@@ -2550,38 +2600,39 @@ export class Connection {
   }
 
   /**
-   * Fetch all the account info for multiple accounts specified by an array of public keys
+   * Fetch all the account info for multiple accounts specified by an array of public keys, return with context
    */
-  async getMultipleAccountsInfo(
+  async getMultipleAccountsInfoAndContext(
     publicKeys: PublicKey[],
-    configOrCommitment?: GetMultipleAccountsConfig | Commitment,
-  ): Promise<(AccountInfo<Buffer | ParsedAccountData> | null)[]> {
+    commitment?: Commitment,
+  ): Promise<RpcResponseAndContext<(AccountInfo<Buffer> | null)[]>> {
     const keys = publicKeys.map(key => key.toBase58());
-
-    let commitment;
-    let encoding: 'base64' | 'jsonParsed' = 'base64';
-    if (configOrCommitment) {
-      if (typeof configOrCommitment === 'string') {
-        commitment = configOrCommitment;
-        encoding = 'base64';
-      } else {
-        commitment = configOrCommitment.commitment;
-        encoding = configOrCommitment.encoding || 'base64';
-      }
-    }
-
-    const args = this._buildArgs([keys], commitment, encoding);
+    const args = this._buildArgs([keys], commitment, 'base64');
     const unsafeRes = await this._rpcRequest('getMultipleAccounts', args);
     const res = create(
       unsafeRes,
-      jsonRpcResultAndContext(array(nullable(ParsedAccountInfoResult))),
+      jsonRpcResultAndContext(array(nullable(AccountInfoResult))),
     );
     if ('error' in res) {
       throw new Error(
         'failed to get info for accounts ' + keys + ': ' + res.error.message,
       );
     }
-    return res.result.value;
+    return res.result;
+  }
+
+  /**
+   * Fetch all the account info for multiple accounts specified by an array of public keys
+   */
+  async getMultipleAccountsInfo(
+    publicKeys: PublicKey[],
+    commitment?: Commitment,
+  ): Promise<(AccountInfo<Buffer> | null)[]> {
+    const res = await this.getMultipleAccountsInfoAndContext(
+      publicKeys,
+      commitment,
+    );
+    return res.value;
   }
 
   /**
@@ -3221,6 +3272,51 @@ export class Connection {
     };
   }
 
+  /*
+   * Returns the current block height of the node
+   */
+  async getBlockHeight(commitment?: Commitment): Promise<number> {
+    const args = this._buildArgs([], commitment);
+    const unsafeRes = await this._rpcRequest('getBlockHeight', args);
+    const res = create(unsafeRes, jsonRpcResult(number()));
+    if ('error' in res) {
+      throw new Error(
+        'failed to get block height information: ' + res.error.message,
+      );
+    }
+
+    return res.result;
+  }
+
+  /*
+   * Returns recent block production information from the current or previous epoch
+   */
+  async getBlockProduction(
+    configOrCommitment?: GetBlockProductionConfig | Commitment,
+  ): Promise<RpcResponseAndContext<BlockProduction>> {
+    let extra: Omit<GetBlockProductionConfig, 'commitment'> | undefined;
+    let commitment: Commitment | undefined;
+
+    if (typeof configOrCommitment === 'string') {
+      commitment = configOrCommitment;
+    } else if (configOrCommitment) {
+      const {commitment: c, ...rest} = configOrCommitment;
+      commitment = c;
+      extra = rest;
+    }
+
+    const args = this._buildArgs([], commitment, 'base64', extra);
+    const unsafeRes = await this._rpcRequest('getBlockProduction', args);
+    const res = create(unsafeRes, BlockProductionResponseStruct);
+    if ('error' in res) {
+      throw new Error(
+        'failed to get block production information: ' + res.error.message,
+      );
+    }
+
+    return res.result;
+  }
+
   /**
    * Fetch a confirmed or finalized transaction from the cluster.
    */

package/src/ed25519-program.ts

@@ -30,7 +30,19 @@ export type CreateEd25519InstructionWithPrivateKeyParams = {
   instructionIndex?: number;
 };
 
-const ED25519_INSTRUCTION_LAYOUT = BufferLayout.struct([
+const ED25519_INSTRUCTION_LAYOUT = BufferLayout.struct<
+  Readonly<{
+    messageDataOffset: number;
+    messageDataSize: number;
+    messageInstructionIndex: number;
+    numSignatures: number;
+    padding: number;
+    publicKeyInstructionIndex: number;
+    publicKeyOffset: number;
+    signatureInstructionIndex: number;
+    signatureOffset: number;
+  }>
+>([
   BufferLayout.u8('numSignatures'),
   BufferLayout.u8('padding'),
   BufferLayout.u16('signatureOffset'),
@@ -82,17 +94,22 @@ export class Ed25519Program {
 
     const instructionData = Buffer.alloc(messageDataOffset + message.length);
 
+    const index =
+      instructionIndex == null
+        ? 0xffff // An index of `u16::MAX` makes it default to the current instruction.
+        : instructionIndex;
+
     ED25519_INSTRUCTION_LAYOUT.encode(
       {
         numSignatures,
         padding: 0,
         signatureOffset,
-        signatureInstructionIndex: instructionIndex,
+        signatureInstructionIndex: index,
         publicKeyOffset,
-        publicKeyInstructionIndex: instructionIndex,
+        publicKeyInstructionIndex: index,
         messageDataOffset,
         messageDataSize: message.length,
-        messageInstructionIndex: instructionIndex,
+        messageInstructionIndex: index,
       },
       instructionData,
     );

package/src/instruction.ts

@@ -3,21 +3,28 @@ import * as BufferLayout from '@solana/buffer-layout';
 
 import * as Layout from './layout';
 
+export interface IInstructionInputData {
+  readonly instruction: number;
+}
+
 /**
  * @internal
  */
-export type InstructionType = {
+export type InstructionType<TInputData extends IInstructionInputData> = {
   /** The Instruction index (from solana upstream program) */
   index: number;
   /** The BufferLayout to use to build data */
-  layout: BufferLayout.Layout;
+  layout: BufferLayout.Layout<TInputData>;
 };
 
 /**
  * Populate a buffer of instruction data using an InstructionType
  * @internal
  */
-export function encodeData(type: InstructionType, fields?: any): Buffer {
+export function encodeData<TInputData extends IInstructionInputData>(
+  type: InstructionType<TInputData>,
+  fields?: any,
+): Buffer {
   const allocLength =
     type.layout.span >= 0 ? type.layout.span : Layout.getAlloc(type, fields);
   const data = Buffer.alloc(allocLength);
@@ -30,8 +37,11 @@ export function encodeData(type: InstructionType, fields?: any): Buffer {
  * Decode instruction data buffer using an InstructionType
  * @internal
  */
-export function decodeData(type: InstructionType, buffer: Buffer): any {
-  let data;
+export function decodeData<TInputData extends IInstructionInputData>(
+  type: InstructionType<TInputData>,
+  buffer: Buffer,
+): TInputData {
+  let data: TInputData;
   try {
     data = type.layout.decode(buffer);
   } catch (err) {

package/src/layout.ts

@@ -4,24 +4,47 @@ import * as BufferLayout from '@solana/buffer-layout';
 /**
  * Layout for a public key
  */
-export const publicKey = (
-  property: string = 'publicKey',
-): BufferLayout.Layout => {
+export const publicKey = (property: string = 'publicKey') => {
   return BufferLayout.blob(32, property);
 };
 
 /**
  * Layout for a 64bit unsigned value
  */
-export const uint64 = (property: string = 'uint64'): BufferLayout.Layout => {
+export const uint64 = (property: string = 'uint64') => {
   return BufferLayout.blob(8, property);
 };
 
+interface IRustStringShim
+  extends Omit<
+    BufferLayout.Structure<
+      Readonly<{
+        length: number;
+        lengthPadding: number;
+        chars: Uint8Array;
+      }>
+    >,
+    'decode' | 'encode' | 'replicate'
+  > {
+  alloc: (str: string) => number;
+  decode: (b: Uint8Array, offset?: number) => string;
+  encode: (str: string, b: Uint8Array, offset?: number) => number;
+  replicate: (property: string) => this;
+}
+
 /**
  * Layout for a Rust String type
  */
-export const rustString = (property: string = 'string') => {
-  const rsl = BufferLayout.struct(
+export const rustString = (
+  property: string = 'string',
+): BufferLayout.Layout<string> => {
+  const rsl = BufferLayout.struct<
+    Readonly<{
+      length?: number;
+      lengthPadding?: number;
+      chars: Uint8Array;
+    }>
+  >(
     [
       BufferLayout.u32('length'),
       BufferLayout.u32('lengthPadding'),
@@ -32,19 +55,21 @@ export const rustString = (property: string = 'string') => {
   const _decode = rsl.decode.bind(rsl);
   const _encode = rsl.encode.bind(rsl);
 
-  rsl.decode = (buffer: any, offset: any) => {
-    const data = _decode(buffer, offset);
-    return data['chars'].toString('utf8');
+  const rslShim = rsl as unknown as IRustStringShim;
+
+  rslShim.decode = (b: Uint8Array, offset?: number) => {
+    const data = _decode(b, offset);
+    return data['chars'].toString();
   };
 
-  rsl.encode = (str: any, buffer: any, offset: any) => {
+  rslShim.encode = (str: string, b: Uint8Array, offset?: number) => {
     const data = {
       chars: Buffer.from(str, 'utf8'),
     };
-    return _encode(data, buffer, offset);
+    return _encode(data, b, offset);
   };
 
-  (rsl as any).alloc = (str: any) => {
+  rslShim.alloc = (str: string) => {
     return (
       BufferLayout.u32().span +
       BufferLayout.u32().span +
@@ -52,24 +77,32 @@ export const rustString = (property: string = 'string') => {
     );
   };
 
-  return rsl;
+  return rslShim;
 };
 
 /**
  * Layout for an Authorized object
  */
 export const authorized = (property: string = 'authorized') => {
-  return BufferLayout.struct(
-    [publicKey('staker'), publicKey('withdrawer')],
-    property,
-  );
+  return BufferLayout.struct<
+    Readonly<{
+      staker: Uint8Array;
+      withdrawer: Uint8Array;
+    }>
+  >([publicKey('staker'), publicKey('withdrawer')], property);
 };
 
 /**
  * Layout for a Lockup object
  */
 export const lockup = (property: string = 'lockup') => {
-  return BufferLayout.struct(
+  return BufferLayout.struct<
+    Readonly<{
+      custodian: Uint8Array;
+      epoch: number;
+      unixTimestamp: number;
+    }>
+  >(
     [
       BufferLayout.ns64('unixTimestamp'),
       BufferLayout.ns64('epoch'),
@@ -83,7 +116,14 @@ export const lockup = (property: string = 'lockup') => {
  *  Layout for a VoteInit object
  */
 export const voteInit = (property: string = 'voteInit') => {
-  return BufferLayout.struct(
+  return BufferLayout.struct<
+    Readonly<{
+      authorizedVoter: Uint8Array;
+      authorizedWithdrawer: Uint8Array;
+      commission: number;
+      nodePubkey: Uint8Array;
+    }>
+  >(
     [
       publicKey('nodePubkey'),
       publicKey('authorizedVoter'),