@solana/web3.js 1.77.3 → 1.78.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.77.3",
+  "version": "1.78.1",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -54,7 +54,7 @@
     "test:unit:node": "cross-env NODE_ENV=test TS_NODE_COMPILER_OPTIONS='{ \"module\": \"commonjs\", \"target\": \"es2019\" }' ts-mocha --require esm './test/**/*.test.ts'"
   },
   "dependencies": {
-    "@babel/runtime": "^7.12.5",
+    "@babel/runtime": "^7.22.6",
     "@noble/curves": "^1.0.0",
     "@noble/hashes": "^1.3.0",
     "@solana/buffer-layout": "^4.0.0",
@@ -66,65 +66,66 @@
     "buffer": "6.0.3",
     "fast-stable-stringify": "^1.0.0",
     "jayson": "^4.1.0",
-    "node-fetch": "^2.6.7",
+    "node-fetch": "^2.6.12",
     "rpc-websockets": "^7.5.1",
     "superstruct": "^0.14.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.13",
+    "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-class-properties": "^7.12.1",
+    "@babel/plugin-proposal-private-methods": "^7.18.6",
     "@babel/plugin-transform-runtime": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
+    "@babel/preset-env": "^7.22.4",
     "@babel/preset-typescript": "^7.12.16",
     "@rollup/plugin-alias": "^4.0.3",
     "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-multi-entry": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-node-resolve": "^15.1.0",
     "@rollup/plugin-replace": "^5.0.2",
-    "@rollup/plugin-terser": "^0.4.0",
-    "@solana/spl-token": "^0.3.7",
+    "@rollup/plugin-terser": "^0.4.3",
+    "@solana/spl-token": "^0.3.8",
     "@types/bn.js": "^5.1.0",
     "@types/bs58": "^4.0.1",
-    "@types/chai": "^4.2.15",
+    "@types/chai": "^4.3.5",
     "@types/chai-as-promised": "^7.1.3",
     "@types/express-serve-static-core": "^4.17.35",
-    "@types/mocha": "^10.0.0",
-    "@types/mz": "^2.7.3",
-    "@types/node": "^18.11.10",
+    "@types/mocha": "^10.0.1",
+    "@types/mz": "^2.7.4",
+    "@types/node": "^20.4.4",
     "@types/node-fetch": "2",
     "@types/sinon": "^10.0.0",
     "@types/sinon-chai": "^3.2.8",
-    "@typescript-eslint/eslint-plugin": "^5.57.1",
-    "@typescript-eslint/parser": "^5.57.1",
-    "chai": "^4.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "cross-env": "7.0.3",
-    "eslint": "^8.37.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.45.0",
+    "eslint-config-prettier": "^8.9.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-mocha": "^10.1.0",
     "eslint-plugin-prettier": "^4.2.1",
     "esm": "^3.2.25",
-    "mocha": "^10.1.0",
-    "mockttp": "^3.7.5",
+    "mocha": "^10.2.0",
+    "mockttp": "^3.9.1",
     "mz": "^2.7.0",
     "node-abort-controller": "^3.0.1",
     "prettier": "^2.8.8",
     "rimraf": "5.0.1",
-    "rollup": "^3.20.2",
+    "rollup": "^3.26.2",
     "rollup-plugin-dts": "^5.3.0",
     "rollup-plugin-node-polyfills": "^0.2.1",
-    "semantic-release": "^19.0.3",
-    "sinon": "^15.0.1",
+    "semantic-release": "^21.0.7",
+    "sinon": "^15.1.0",
     "sinon-chai": "^3.7.0",
     "start-server-and-test": "^2.0.0",
     "ts-mocha": "^10.0.0",
-    "ts-node": "^10.0.0",
+    "ts-node": "^10.9.1",
     "tsconfig": "workspace:*",
     "tslib": "^2.5.2",
-    "typedoc": "^0.23.28",
-    "typescript": "^5.0.3"
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.6"
   }
 }

package/src/connection.ts

@@ -31,7 +31,7 @@ import {JSONRPCError} from 'jayson';
 
 import {EpochSchedule} from './epoch-schedule';
 import {SendTransactionError, SolanaJSONRPCError} from './errors';
-import fetchImpl, {Response} from './fetch-impl';
+import fetchImpl from './fetch-impl';
 import {DurableNonce, NonceAccount} from './nonce-account';
 import {PublicKey} from './publickey';
 import {Signer} from './keypair';
@@ -623,6 +623,16 @@ export type GetLatestBlockhashConfig = {
   minContextSlot?: number;
 };
 
+/**
+ * Configuration object for changing `isBlockhashValid` query behavior
+ */
+export type IsBlockhashValidConfig = {
+  /** The level of commitment desired */
+  commitment?: Commitment;
+  /** The minimum slot that the request can be evaluated at */
+  minContextSlot?: number;
+};
+
 /**
  * Configuration object for changing `getSlot` query behavior
  */
@@ -2561,6 +2571,11 @@ const GetLatestBlockhashRpcResult = jsonRpcResultAndContext(
   }),
 );
 
+/**
+ * Expected JSON RPC response for the "isBlockhashValid" message
+ */
+const IsBlockhashValidRpcResult = jsonRpcResultAndContext(boolean());
+
 const PerfSampleResult = pick({
   slot: number(),
   numTransactions: number(),
@@ -4601,6 +4616,31 @@ export class Connection {
     return res.result;
   }
 
+  /**
+   * Returns whether a blockhash is still valid or not
+   */
+  async isBlockhashValid(
+    blockhash: Blockhash,
+    rawConfig?: IsBlockhashValidConfig,
+  ): Promise<RpcResponseAndContext<boolean>> {
+    const {commitment, config} = extractCommitmentFromConfig(rawConfig);
+    const args = this._buildArgs(
+      [blockhash],
+      commitment,
+      undefined /* encoding */,
+      config,
+    );
+    const unsafeRes = await this._rpcRequest('isBlockhashValid', args);
+    const res = create(unsafeRes, IsBlockhashValidRpcResult);
+    if ('error' in res) {
+      throw new SolanaJSONRPCError(
+        res.error,
+        'failed to determine if the blockhash `' + blockhash + '`is valid',
+      );
+    }
+    return res.result;
+  }
+
   /**
    * Fetch the node version
    */

package/src/fetch-impl.ts

@@ -1,13 +1,16 @@
 import * as nodeFetch from 'node-fetch';
 
-export * from 'node-fetch';
-export default async function (
-  input: nodeFetch.RequestInfo,
-  init?: nodeFetch.RequestInit,
-): Promise<nodeFetch.Response> {
-  const processedInput =
-    typeof input === 'string' && input.slice(0, 2) === '//'
-      ? 'https:' + input
-      : input;
-  return await nodeFetch.default(processedInput, init);
-}
+export default (typeof globalThis.fetch === 'function'
+  ? // The Fetch API is supported experimentally in Node 17.5+ and natively in Node 18+.
+    globalThis.fetch
+  : // Otherwise use the polyfill.
+    async function (
+      input: nodeFetch.RequestInfo,
+      init?: nodeFetch.RequestInit,
+    ): Promise<nodeFetch.Response> {
+      const processedInput =
+        typeof input === 'string' && input.slice(0, 2) === '//'
+          ? 'https:' + input
+          : input;
+      return await nodeFetch.default(processedInput, init);
+    }) as typeof globalThis.fetch;

package/src/keypair.ts

@@ -19,7 +19,7 @@ export class Keypair {
    * Create a new keypair instance.
    * Generate random keypair if no {@link Ed25519Keypair} is provided.
    *
-   * @param keypair ed25519 keypair
+   * @param {Ed25519Keypair} keypair ed25519 keypair
    */
   constructor(keypair?: Ed25519Keypair) {
     this._keypair = keypair ?? generateKeypair();
@@ -27,6 +27,8 @@ export class Keypair {
 
   /**
    * Generate a new random keypair
+   *
+   * @returns {Keypair} Keypair
    */
   static generate(): Keypair {
     return new Keypair(generateKeypair());
@@ -42,7 +44,9 @@ export class Keypair {
    * @throws error if the provided secret key is invalid and validation is not skipped.
    *
    * @param secretKey secret key byte array
-   * @param options: skip secret key validation
+   * @param options skip secret key validation
+   *
+   * @returns {Keypair} Keypair
    */
   static fromSecretKey(
     secretKey: Uint8Array,
@@ -68,6 +72,8 @@ export class Keypair {
    * Generate a keypair from a 32 byte seed.
    *
    * @param seed seed byte array
+   *
+   * @returns {Keypair} Keypair
    */
   static fromSeed(seed: Uint8Array): Keypair {
     const publicKey = getPublicKey(seed);
@@ -79,6 +85,8 @@ export class Keypair {
 
   /**
    * The public key for this keypair
+   *
+   * @returns {PublicKey} PublicKey
    */
   get publicKey(): PublicKey {
     return new PublicKey(this._keypair.publicKey);
@@ -86,6 +94,7 @@ export class Keypair {
 
   /**
    * The raw secret key for this keypair
+   * @returns {Uint8Array} Secret key in an array of Uint8 bytes
    */
   get secretKey(): Uint8Array {
     return new Uint8Array(this._keypair.secretKey);

package/src/transaction/legacy.ts

@@ -209,6 +209,8 @@ export class Transaction {
 
   /**
    * The first (payer) Transaction signature
+   *
+   * @returns {Buffer | null} Buffer of payer's signature
    */
   get signature(): Buffer | null {
     if (this.signatures.length > 0) {
@@ -335,6 +337,8 @@ export class Transaction {
 
   /**
    * Add one or more instructions to this Transaction
+   *
+   * @param {Array< Transaction | TransactionInstruction | TransactionInstructionCtorFields >} items - Instructions to add to the Transaction
    */
   add(
     ...items: Array<
@@ -464,7 +468,7 @@ export class Transaction {
         ignorePunctuation: false,
         numeric: false,
         caseFirst: 'lower',
-      };
+      } as Intl.CollatorOptions;
       return x.pubkey
         .toBase58()
         .localeCompare(y.pubkey.toBase58(), 'en', options);
@@ -594,6 +598,10 @@ export class Transaction {
 
   /**
    * Get the estimated fee associated with a transaction
+   *
+   * @param {Connection} connection Connection to RPC Endpoint.
+   *
+   * @returns {Promise<number | null>} The estimated fee for the transaction
    */
   async getEstimatedFee(connection: Connection): Promise<number | null> {
     return (await connection.getFeeForMessage(this.compileMessage())).value;
@@ -641,6 +649,8 @@ export class Transaction {
    * rejected.
    *
    * The Transaction must be assigned a valid `recentBlockhash` before invoking this method
+   *
+   * @param {Array<Signer>} signers Array of signers that will sign the transaction
    */
   sign(...signers: Array<Signer>) {
     if (signers.length === 0) {
@@ -675,6 +685,8 @@ export class Transaction {
    * instructions.
    *
    * All the caveats from the `sign` method apply to `partialSign`
+   *
+   * @param {Array<Signer>} signers Array of signers that will sign the transaction
    */
   partialSign(...signers: Array<Signer>) {
     if (signers.length === 0) {
@@ -713,6 +725,9 @@ export class Transaction {
    * Add an externally created signature to a transaction. The public key
    * must correspond to either the fee payer or a signer account in the transaction
    * instructions.
+   *
+   * @param {PublicKey} pubkey Public key that will be added to the transaction.
+   * @param {Buffer} signature An externally created signature to add to the transaction.
    */
   addSignature(pubkey: PublicKey, signature: Buffer) {
     this._compile(); // Ensure signatures array is populated
@@ -739,6 +754,8 @@ export class Transaction {
    * Verify signatures of a Transaction
    * Optional parameter specifies if we're expecting a fully signed Transaction or a partially signed one.
    * If no boolean is provided, we expect a fully signed Transaction by default.
+   *
+   * @param {boolean} [requireAllSignatures=true] Require a fully signed Transaction
    */
   verifySignatures(requireAllSignatures?: boolean): boolean {
     return this._verifySignatures(
@@ -770,6 +787,10 @@ export class Transaction {
 
   /**
    * Serialize the Transaction in the wire format.
+   *
+   * @param {Buffer} [config] Config of transaction.
+   *
+   * @returns {Buffer} Signature of transaction in wire format.
    */
   serialize(config?: SerializeConfig): Buffer {
     const {requireAllSignatures, verifySignatures} = Object.assign(
@@ -849,6 +870,10 @@ export class Transaction {
 
   /**
    * Parse a wire transaction into a Transaction object.
+   *
+   * @param {Buffer | Uint8Array | Array<number>} buffer Signature of wire Transaction
+   *
+   * @returns {Transaction} Transaction associated with the signature
    */
   static from(buffer: Buffer | Uint8Array | Array<number>): Transaction {
     // Slice up wire data
@@ -867,6 +892,11 @@ export class Transaction {
 
   /**
    * Populate Transaction object from message and signatures
+   *
+   * @param {Message} message Message of transaction
+   * @param {Array<string>} signatures List of signatures to assign to the transaction
+   *
+   * @returns {Transaction} The populated Transaction
    */
   static populate(
     message: Message,

package/src/utils/cluster.ts

@@ -15,6 +15,10 @@ export type Cluster = 'devnet' | 'testnet' | 'mainnet-beta';
 
 /**
  * Retrieves the RPC API URL for the specified cluster
+ * @param {Cluster} [cluster="devnet"] - The cluster name of the RPC API URL to use. Possible options: 'devnet' | 'testnet' | 'mainnet-beta'
+ * @param {boolean} [tls="http"] - Use TLS when connecting to cluster.
+ *
+ * @returns {string} URL string of the RPC endpoint
  */
 export function clusterApiUrl(cluster?: Cluster, tls?: boolean): string {
   const key = tls === false ? 'http' : 'https';