@solana/web3.js 1.4.1 → 1.5.1

package/module.flow.js

@@ -594,6 +594,15 @@ declare module "@solana/web3.js" {
     | "root"
     | "max";
 
+  /**
+   * A subset of Commitment levels, which are at least optimistically confirmed
+   * <pre>
+   *   'confirmed': Query the most recent block which has reached 1 confirmation by the cluster
+   *   'finalized': Query the most recent block which has been finalized by the cluster
+   * </pre>
+   */
+  declare export type Finality = "confirmed" | "finalized";
+
   /**
    * Filter for largest accounts query
    * <pre>
@@ -1947,34 +1956,41 @@ feeCalculator: FeeCalculator,...
      * Fetch a list of Transactions and transaction statuses from the cluster
      * for a confirmed block
      */
-    getConfirmedBlock(slot: number): Promise<ConfirmedBlock>;
+    getConfirmedBlock(
+      slot: number,
+      commitment?: Finality
+    ): Promise<ConfirmedBlock>;
 
     /**
      * Fetch a list of Signatures from the cluster for a confirmed block, excluding rewards
      */
     getConfirmedBlockSignatures(
-      slot: number
+      slot: number,
+      commitment?: Finality
     ): Promise<ConfirmedBlockSignatures>;
 
     /**
      * Fetch a transaction details for a confirmed transaction
      */
     getConfirmedTransaction(
-      signature: TransactionSignature
+      signature: TransactionSignature,
+      commitment?: Finality
     ): Promise<ConfirmedTransaction | null>;
 
     /**
      * Fetch parsed transaction details for a confirmed transaction
      */
     getParsedConfirmedTransaction(
-      signature: TransactionSignature
+      signature: TransactionSignature,
+      commitment?: Finality
     ): Promise<ParsedConfirmedTransaction | null>;
 
     /**
      * Fetch parsed transaction details for a batch of confirmed transactions
      */
     getParsedConfirmedTransactions(
-      signatures: TransactionSignature[]
+      signatures: TransactionSignature[],
+      commitment?: Finality
     ): Promise<(ParsedConfirmedTransaction | null)[]>;
 
     /**
@@ -1999,7 +2015,8 @@ feeCalculator: FeeCalculator,...
      */
     getConfirmedSignaturesForAddress2(
       address: PublicKey,
-      options?: ConfirmedSignaturesForAddress2Options
+      options?: ConfirmedSignaturesForAddress2Options,
+      commitment?: Finality
     ): Promise<Array<ConfirmedSignatureInfo>>;
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "description": "Solana Javascript API",
   "keywords": [
     "api",
@@ -77,7 +77,7 @@
     "@types/node": "^14.14.26",
     "@types/node-fetch": "^2.5.8",
     "@types/secp256k1": "^4.0.1",
-    "@types/sinon": "^9.0.11",
+    "@types/sinon": "^10.0.0",
     "@typescript-eslint/eslint-plugin": "^4.14.2",
     "@typescript-eslint/parser": "^4.14.2",
     "chai": "^4.3.0",
@@ -100,7 +100,7 @@
     "nyc": "^15.1.0",
     "prettier": "^2.0.0",
     "rimraf": "3.0.2",
-    "rollup": "2.44.0",
+    "rollup": "2.45.2",
     "rollup-plugin-dts": "^3.0.1",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "rollup-plugin-terser": "^7.0.2",

package/src/connection.ts

@@ -219,6 +219,15 @@ export type Commitment =
   | 'root' // Deprecated as of v1.5.5
   | 'max'; // Deprecated as of v1.5.5
 
+/**
+ * A subset of Commitment levels, which are at least optimistically confirmed
+ * <pre>
+ *   'confirmed': Query the most recent block which has reached 1 confirmation by the cluster
+ *   'finalized': Query the most recent block which has been finalized by the cluster
+ * </pre>
+ */
+export type Finality = 'confirmed' | 'finalized';
+
 /**
  * Filter for largest accounts query
  * <pre>
@@ -2587,8 +2596,12 @@ export class Connection {
    * Fetch a list of Transactions and transaction statuses from the cluster
    * for a confirmed block
    */
-  async getConfirmedBlock(slot: number): Promise<ConfirmedBlock> {
-    const unsafeRes = await this._rpcRequest('getConfirmedBlock', [slot]);
+  async getConfirmedBlock(
+    slot: number,
+    commitment?: Finality,
+  ): Promise<ConfirmedBlock> {
+    const args = this._buildArgsAtLeastConfirmed([slot], commitment);
+    const unsafeRes = await this._rpcRequest('getConfirmedBlock', args);
     const res = create(unsafeRes, GetConfirmedBlockRpcResult);
     if ('error' in res) {
       throw new Error('failed to get confirmed block: ' + res.error.message);
@@ -2605,11 +2618,18 @@ export class Connection {
    */
   async getConfirmedBlockSignatures(
     slot: number,
+    commitment?: Finality,
   ): Promise<ConfirmedBlockSignatures> {
-    const unsafeRes = await this._rpcRequest('getConfirmedBlock', [
-      slot,
-      {transactionDetails: 'signatures', rewards: false},
-    ]);
+    const args = this._buildArgsAtLeastConfirmed(
+      [slot],
+      commitment,
+      undefined,
+      {
+        transactionDetails: 'signatures',
+        rewards: false,
+      },
+    );
+    const unsafeRes = await this._rpcRequest('getConfirmedBlock', args);
     const res = create(unsafeRes, GetConfirmedBlockSignaturesRpcResult);
     if ('error' in res) {
       throw new Error('failed to get confirmed block: ' + res.error.message);
@@ -2626,10 +2646,10 @@ export class Connection {
    */
   async getConfirmedTransaction(
     signature: TransactionSignature,
+    commitment?: Finality,
   ): Promise<ConfirmedTransaction | null> {
-    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', [
-      signature,
-    ]);
+    const args = this._buildArgsAtLeastConfirmed([signature], commitment);
+    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', args);
     const res = create(unsafeRes, GetConfirmedTransactionRpcResult);
     if ('error' in res) {
       throw new Error(
@@ -2644,11 +2664,14 @@ export class Connection {
    */
   async getParsedConfirmedTransaction(
     signature: TransactionSignature,
+    commitment?: Finality,
   ): Promise<ParsedConfirmedTransaction | null> {
-    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', [
-      signature,
+    const args = this._buildArgsAtLeastConfirmed(
+      [signature],
+      commitment,
       'jsonParsed',
-    ]);
+    );
+    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', args);
     const res = create(unsafeRes, GetParsedConfirmedTransactionRpcResult);
     if ('error' in res) {
       throw new Error(
@@ -2663,11 +2686,17 @@ export class Connection {
    */
   async getParsedConfirmedTransactions(
     signatures: TransactionSignature[],
+    commitment?: Finality,
   ): Promise<(ParsedConfirmedTransaction | null)[]> {
     const batch = signatures.map(signature => {
+      const args = this._buildArgsAtLeastConfirmed(
+        [signature],
+        commitment,
+        'jsonParsed',
+      );
       return {
         methodName: 'getConfirmedTransaction',
-        args: [signature, 'jsonParsed'],
+        args,
       };
     });
 
@@ -2709,7 +2738,10 @@ export class Connection {
       }
 
       try {
-        const block = await this.getConfirmedBlockSignatures(startSlot);
+        const block = await this.getConfirmedBlockSignatures(
+          startSlot,
+          'finalized',
+        );
         if (block.signatures.length > 0) {
           options.until = block.signatures[
             block.signatures.length - 1
@@ -2765,10 +2797,17 @@ export class Connection {
   async getConfirmedSignaturesForAddress2(
     address: PublicKey,
     options?: ConfirmedSignaturesForAddress2Options,
+    commitment?: Finality,
   ): Promise<Array<ConfirmedSignatureInfo>> {
+    const args = this._buildArgsAtLeastConfirmed(
+      [address.toBase58()],
+      commitment,
+      undefined,
+      options,
+    );
     const unsafeRes = await this._rpcRequest(
       'getConfirmedSignaturesForAddress2',
-      [address.toBase58(), options],
+      args,
     );
     const res = create(unsafeRes, GetConfirmedSignaturesForAddress2RpcResult);
     if ('error' in res) {
@@ -3476,6 +3515,26 @@ export class Connection {
     return args;
   }
 
+  /**
+   * @internal
+   */
+  _buildArgsAtLeastConfirmed(
+    args: Array<any>,
+    override?: Finality,
+    encoding?: 'jsonParsed' | 'base64',
+    extra?: any,
+  ): Array<any> {
+    const commitment = override || this._commitment;
+    if (commitment && !['confirmed', 'finalized'].includes(commitment)) {
+      throw new Error(
+        'Using Connection with default commitment: `' +
+          this._commitment +
+          '`, but method requires at least `confirmed`',
+      );
+    }
+    return this._buildArgs(args, override, encoding, extra);
+  }
+
   /**
    * @internal
    */