@solana/web3.js 1.38.0 → 1.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.38.0",
+  "version": "1.40.0",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -79,7 +79,7 @@
     "@babel/preset-typescript": "^7.12.16",
     "@babel/register": "^7.12.13",
     "@commitlint/config-conventional": "^15.0.0",
-    "@commitlint/travis-cli": "^15.0.0",
+    "@commitlint/travis-cli": "^16.2.3",
     "@rollup/plugin-alias": "^3.1.2",
     "@rollup/plugin-babel": "^5.2.3",
     "@rollup/plugin-commonjs": "^21.0.0",
@@ -95,7 +95,7 @@
     "@types/express-serve-static-core": "^4.17.21",
     "@types/mocha": "^9.0.0",
     "@types/mz": "^2.7.3",
-    "@types/node": "^16.0.0",
+    "@types/node": "^17.0.24",
     "@types/secp256k1": "^4.0.1",
     "@types/sinon": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^4.14.2",

package/src/connection.ts

@@ -1,6 +1,6 @@
 import bs58 from 'bs58';
 import {Buffer} from 'buffer';
-import fetch from 'cross-fetch';
+import crossFetch from 'cross-fetch';
 import {
   type as pick,
   number,
@@ -814,9 +814,11 @@ function createRpcClient(
   url: string,
   useHttps: boolean,
   httpHeaders?: HttpHeaders,
+  customFetch?: typeof crossFetch,
   fetchMiddleware?: FetchMiddleware,
   disableRetryOnRateLimit?: boolean,
 ): RpcClient {
+  const fetch = customFetch ? customFetch : crossFetch;
   let agentManager: AgentManager | undefined;
   if (!process.env.BROWSER) {
     agentManager = new AgentManager(useHttps);
@@ -2108,6 +2110,8 @@ export type ConnectionConfig = {
   wsEndpoint?: string;
   /** Optional HTTP headers object */
   httpHeaders?: HttpHeaders;
+  /** Optional custom fetch function */
+  fetch?: typeof crossFetch;
   /** Optional fetch middleware callback */
   fetchMiddleware?: FetchMiddleware;
   /** Optional Disable retrying calls when server responds with HTTP 429 (Too Many Requests) */
@@ -2116,6 +2120,13 @@ export type ConnectionConfig = {
   confirmTransactionInitialTimeout?: number;
 };
 
+function createSubscriptionWarningMessage(id: number, label: string): string {
+  return (
+    'Ignored unsubscribe request because an active subscription ' +
+    `with id \`${id}\` for '${label}' events could not be found.`
+  );
+}
+
 /**
  * A connection to a fullnode JSON RPC endpoint
  */
@@ -2200,6 +2211,7 @@ export class Connection {
 
     let wsEndpoint;
     let httpHeaders;
+    let fetch;
     let fetchMiddleware;
     let disableRetryOnRateLimit;
     if (commitmentOrConfig && typeof commitmentOrConfig === 'string') {
@@ -2210,6 +2222,7 @@ export class Connection {
         commitmentOrConfig.confirmTransactionInitialTimeout;
       wsEndpoint = commitmentOrConfig.wsEndpoint;
       httpHeaders = commitmentOrConfig.httpHeaders;
+      fetch = commitmentOrConfig.fetch;
       fetchMiddleware = commitmentOrConfig.fetchMiddleware;
       disableRetryOnRateLimit = commitmentOrConfig.disableRetryOnRateLimit;
     }
@@ -2221,6 +2234,7 @@ export class Connection {
       url.toString(),
       useHttps,
       httpHeaders,
+      fetch,
       fetchMiddleware,
       disableRetryOnRateLimit,
     );
@@ -3397,6 +3411,34 @@ export class Connection {
     return res;
   }
 
+  /**
+   * Fetch transaction details for a batch of confirmed transactions.
+   * Similar to {@link getParsedTransactions} but returns a {@link TransactionResponse}.
+   */
+  async getTransactions(
+    signatures: TransactionSignature[],
+    commitment?: Finality,
+  ): Promise<(TransactionResponse | null)[]> {
+    const batch = signatures.map(signature => {
+      const args = this._buildArgsAtLeastConfirmed([signature], commitment);
+      return {
+        methodName: 'getTransaction',
+        args,
+      };
+    });
+
+    const unsafeRes = await this._rpcBatchRequest(batch);
+    const res = unsafeRes.map((unsafeRes: any) => {
+      const res = create(unsafeRes, GetTransactionRpcResult);
+      if ('error' in res) {
+        throw new Error('failed to get transactions: ' + res.error.message);
+      }
+      return res.result;
+    });
+
+    return res;
+  }
+
   /**
    * Fetch a list of Transactions and transaction statuses from the cluster
    * for a confirmed block.
@@ -3888,6 +3930,8 @@ export class Connection {
       transaction.instructions = transactionOrMessage.instructions;
     } else {
       transaction = Transaction.populate(transactionOrMessage);
+      // HACK: this function relies on mutating the populated transaction
+      transaction._message = transaction._json = undefined;
     }
 
     if (transaction.nonceInfo && signers) {
@@ -4344,7 +4388,7 @@ export class Connection {
       await this._unsubscribe(subInfo, 'accountUnsubscribe');
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown account change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'account change'));
     }
   }
 
@@ -4408,7 +4452,9 @@ export class Connection {
       await this._unsubscribe(subInfo, 'programUnsubscribe');
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown program account change id: ${id}`);
+      console.warn(
+        createSubscriptionWarningMessage(id, 'program account change'),
+      );
     }
   }
 
@@ -4437,13 +4483,14 @@ export class Connection {
    * @param id subscription id to deregister.
    */
   async removeOnLogsListener(id: number): Promise<void> {
-    if (!this._logsSubscriptions[id]) {
-      throw new Error(`Unknown logs id: ${id}`);
+    if (this._logsSubscriptions[id]) {
+      const subInfo = this._logsSubscriptions[id];
+      delete this._logsSubscriptions[id];
+      await this._unsubscribe(subInfo, 'logsUnsubscribe');
+      this._updateSubscriptions();
+    } else {
+      console.warn(createSubscriptionWarningMessage(id, 'logs'));
     }
-    const subInfo = this._logsSubscriptions[id];
-    delete this._logsSubscriptions[id];
-    await this._unsubscribe(subInfo, 'logsUnsubscribe');
-    this._updateSubscriptions();
   }
 
   /**
@@ -4502,7 +4549,7 @@ export class Connection {
       await this._unsubscribe(subInfo, 'slotUnsubscribe');
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown slot change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'slot change'));
     }
   }
 
@@ -4548,7 +4595,7 @@ export class Connection {
       await this._unsubscribe(subInfo, 'slotsUpdatesUnsubscribe');
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown slot update id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'slot update'));
     }
   }
 
@@ -4693,7 +4740,7 @@ export class Connection {
       await this._unsubscribe(subInfo, 'signatureUnsubscribe');
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown signature result id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'signature result'));
     }
   }
 
@@ -4738,7 +4785,7 @@ export class Connection {
       await this._unsubscribe(subInfo, 'rootUnsubscribe');
       this._updateSubscriptions();
     } else {
-      throw new Error(`Unknown root change id: ${id}`);
+      console.warn(createSubscriptionWarningMessage(id, 'root change'));
     }
   }
 }

package/src/publickey.ts

@@ -143,10 +143,10 @@ export class PublicKey extends Struct {
    * Derive a program address from seeds and a program ID.
    */
   /* eslint-disable require-await */
-  static async createProgramAddress(
+  static createProgramAddressSync(
     seeds: Array<Buffer | Uint8Array>,
     programId: PublicKey,
-  ): Promise<PublicKey> {
+  ): PublicKey {
     let buffer = Buffer.alloc(0);
     seeds.forEach(function (seed) {
       if (seed.length > MAX_SEED_LENGTH) {
@@ -167,6 +167,18 @@ export class PublicKey extends Struct {
     return new PublicKey(publicKeyBytes);
   }
 
+  /**
+   * Async version of createProgramAddressSync
+   * For backwards compatibility
+   */
+  /* eslint-disable require-await */
+  static async createProgramAddress(
+    seeds: Array<Buffer | Uint8Array>,
+    programId: PublicKey,
+  ): Promise<PublicKey> {
+    return this.createProgramAddressSync(seeds, programId);
+  }
+
   /**
    * Find a valid program address
    *
@@ -174,16 +186,16 @@ export class PublicKey extends Struct {
    * iterates a nonce until it finds one that when combined with the seeds
    * results in a valid program address.
    */
-  static async findProgramAddress(
+  static findProgramAddressSync(
     seeds: Array<Buffer | Uint8Array>,
     programId: PublicKey,
-  ): Promise<[PublicKey, number]> {
+  ): [PublicKey, number] {
     let nonce = 255;
     let address;
     while (nonce != 0) {
       try {
         const seedsWithNonce = seeds.concat(Buffer.from([nonce]));
-        address = await this.createProgramAddress(seedsWithNonce, programId);
+        address = this.createProgramAddressSync(seedsWithNonce, programId);
       } catch (err) {
         if (err instanceof TypeError) {
           throw err;
@@ -196,11 +208,23 @@ export class PublicKey extends Struct {
     throw new Error(`Unable to find a viable program address nonce`);
   }
 
+  /**
+   * Async version of findProgramAddressSync
+   * For backwards compatibility
+   */
+  static async findProgramAddress(
+    seeds: Array<Buffer | Uint8Array>,
+    programId: PublicKey,
+  ): Promise<[PublicKey, number]> {
+    return this.findProgramAddressSync(seeds, programId);
+  }
+
   /**
    * Check that a pubkey is on the ed25519 curve.
    */
-  static isOnCurve(pubkey: Uint8Array): boolean {
-    return is_on_curve(pubkey) == 1;
+  static isOnCurve(pubkeyData: PublicKeyInitData): boolean {
+    const pubkey = new PublicKey(pubkeyData);
+    return is_on_curve(pubkey.toBytes()) == 1;
   }
 }
 

package/src/stake-program.ts

@@ -601,8 +601,8 @@ export class StakeProgram {
    * Max space of a Stake account
    *
    * This is generated from the solana-stake-program StakeState struct as
-   * `std::mem::size_of::<StakeState>()`:
-   * https://docs.rs/solana-stake-program/1.4.4/solana_stake_program/stake_state/enum.StakeState.html
+   * `StakeState::size_of()`:
+   * https://docs.rs/solana-stake-program/latest/solana_stake_program/stake_state/enum.StakeState.html
    */
   static space: number = 200;
 

package/src/transaction.ts

@@ -66,6 +66,19 @@ export type SerializeConfig = {
   verifySignatures?: boolean;
 };
 
+/**
+ * @internal
+ */
+export interface TransactionInstructionJSON {
+  keys: {
+    pubkey: string;
+    isSigner: boolean;
+    isWritable: boolean;
+  }[];
+  programId: string;
+  data: number[];
+}
+
 /**
  * Transaction Instruction class
  */
@@ -93,6 +106,21 @@ export class TransactionInstruction {
       this.data = opts.data;
     }
   }
+
+  /**
+   * @internal
+   */
+  toJSON(): TransactionInstructionJSON {
+    return {
+      keys: this.keys.map(({pubkey, isSigner, isWritable}) => ({
+        pubkey: pubkey.toJSON(),
+        isSigner,
+        isWritable,
+      })),
+      programId: this.programId.toJSON(),
+      data: [...this.data],
+    };
+  }
 }
 
 /**
@@ -128,6 +156,20 @@ export type NonceInformation = {
   nonceInstruction: TransactionInstruction;
 };
 
+/**
+ * @internal
+ */
+export interface TransactionJSON {
+  recentBlockhash: string | null;
+  feePayer: string | null;
+  nonceInfo: {
+    nonce: string;
+    nonceInstruction: TransactionInstructionJSON;
+  } | null;
+  instructions: TransactionInstructionJSON[];
+  signers: string[];
+}
+
 /**
  * Transaction class
  */
@@ -169,6 +211,16 @@ export class Transaction {
    */
   nonceInfo?: NonceInformation;
 
+  /**
+   * @internal
+   */
+  _message?: Message;
+
+  /**
+   * @internal
+   */
+  _json?: TransactionJSON;
+
   /**
    * Construct an empty Transaction
    */
@@ -176,6 +228,26 @@ export class Transaction {
     opts && Object.assign(this, opts);
   }
 
+  /**
+   * @internal
+   */
+  toJSON(): TransactionJSON {
+    return {
+      recentBlockhash: this.recentBlockhash || null,
+      feePayer: this.feePayer ? this.feePayer.toJSON() : null,
+      nonceInfo: this.nonceInfo
+        ? {
+            nonce: this.nonceInfo.nonce,
+            nonceInstruction: this.nonceInfo.nonceInstruction.toJSON(),
+          }
+        : null,
+      instructions: this.instructions.map(instruction => instruction.toJSON()),
+      signers: this.signatures.map(({publicKey}) => {
+        return publicKey.toJSON();
+      }),
+    };
+  }
+
   /**
    * Add one or more instructions to this Transaction
    */
@@ -204,6 +276,15 @@ export class Transaction {
    * Compile transaction data
    */
   compileMessage(): Message {
+    if (this._message) {
+      if (JSON.stringify(this.toJSON()) !== JSON.stringify(this._json)) {
+        throw new Error(
+          'Transaction message mutated after being populated from Message',
+        );
+      }
+      return this._message;
+    }
+
     const {nonceInfo} = this;
     if (nonceInfo && this.instructions[0] != nonceInfo.nonceInstruction) {
       this.recentBlockhash = nonceInfo.nonce;
@@ -719,6 +800,9 @@ export class Transaction {
       );
     });
 
+    transaction._message = message;
+    transaction._json = transaction.toJSON();
+
     return transaction;
   }
 }