feat: update commitment variants (#15253)

* feat: update commitment variants

* fix: make pretty

* fix: deprecate, but leave in commitment types

Author: oJshua

module.d.ts

@@ -77,11 +77,14 @@ declare module '@solana/web3.js' {
   };
 
   export type Commitment =
-    | 'max'
-    | 'recent'
-    | 'root'
-    | 'single'
-    | 'singleGossip';
+    | 'processed'
+    | 'confirmed'
+    | 'finalized'
+    | 'recent' // Deprecated as of v1.5.5
+    | 'single' // Deprecated as of v1.5.5
+    | 'singleGossip' // Deprecated as of v1.5.5
+    | 'root' // Deprecated as of v1.5.5
+    | 'max'; // Deprecated as of v1.5.5
 
   export type LargestAccountsFilter = 'circulating' | 'nonCirculating';
 

module.flow.js

@@ -90,11 +90,14 @@ declare module '@solana/web3.js' {
   };
 
   declare export type Commitment =
-    | 'max'
-    | 'recent'
-    | 'root'
-    | 'single'
-    | 'singleGossip';
+    | 'processed'
+    | 'confirmed'
+    | 'finalized'
+    | 'recent' // Deprecated as of v1.5.5
+    | 'single' // Deprecated as of v1.5.5
+    | 'singleGossip' // Deprecated as of v1.5.5
+    | 'root' // Deprecated as of v1.5.5
+    | 'max'; // Deprecated as of v1.5.5
 
   declare export type LargestAccountsFilter = 'circulating' | 'nonCirculating';
 

src/connection.js

@@ -145,16 +145,22 @@ function notificationResultAndContext(resultDescription: any) {
 /**
  * The level of commitment desired when querying state
  * <pre>
- *   'max':    Query the most recent block which has been finalized by the cluster
- *   'recent': Query the most recent block which has reached 1 confirmation by the connected node
- *   'root':   Query the most recent block which has been rooted by the connected node
- *   'single': Query the most recent block which has reached 1 confirmation by the cluster
- *   'singleGossip': Query the most recent block which has reached 1 confirmation according to votes seen in gossip
+ *   'processed': Query the most recent block which has reached 1 confirmation by the connected node
+ *   '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>
  *
- * @typedef {'max' | 'recent' | 'root' | 'single' | 'singleGossip'} Commitment
+ * @typedef {'processed' | 'confirmed' | 'finalized'} Commitment
  */
-export type Commitment = 'max' | 'recent' | 'root' | 'single' | 'singleGossip';
+export type Commitment =
+  | 'processed'
+  | 'confirmed'
+  | 'finalized'
+  | 'recent' // Deprecated as of v1.5.5
+  | 'single' // Deprecated as of v1.5.5
+  | 'singleGossip' // Deprecated as of v1.5.5
+  | 'root' // Deprecated as of v1.5.5
+  | 'max'; // Deprecated as of v1.5.5
 
 /**
  * Filter for largest accounts query
@@ -2291,13 +2297,16 @@ export class Connection {
 
     let timeoutMs = 60 * 1000;
     switch (subscriptionCommitment) {
+      case 'processed':
       case 'recent':
       case 'single':
+      case 'confirmed':
       case 'singleGossip': {
         timeoutMs = 30 * 1000;
         break;
       }
       // exhaust enums to ensure full coverage
+      case 'finalized':
       case 'max':
       case 'root':
     }
@@ -2876,7 +2885,7 @@ export class Connection {
     try {
       const startTime = Date.now();
       for (let i = 0; i < 50; i++) {
-        const {blockhash} = await this.getRecentBlockhash('max');
+        const {blockhash} = await this.getRecentBlockhash('finalized');
 
         if (this._blockhashInfo.recentBlockhash != blockhash) {
           this._blockhashInfo = {

src/loader.js

@@ -68,7 +68,7 @@ export class Loader {
       // Fetch program account info to check if it has already been created
       const programInfo = await connection.getAccountInfo(
         program.publicKey,
-        'singleGossip',
+        'confirmed',
       );
 
       let transaction: Transaction | null = null;
@@ -128,7 +128,7 @@ export class Loader {
           transaction,
           [payer, program],
           {
-            commitment: 'singleGossip',
+            commitment: 'confirmed',
           },
         );
       }
@@ -169,7 +169,7 @@ export class Loader {
       });
       transactions.push(
         sendAndConfirmTransaction(connection, transaction, [payer, program], {
-          commitment: 'singleGossip',
+          commitment: 'confirmed',
         }),
       );
 
@@ -209,7 +209,7 @@ export class Loader {
         transaction,
         [payer, program],
         {
-          commitment: 'singleGossip',
+          commitment: 'confirmed',
         },
       );
     }

test/bpf-loader.test.js

@@ -22,7 +22,7 @@ if (process.env.TEST_LIVE) {
     it('load BPF C program', async () => {
       const data = await fs.readFile('test/fixtures/noop-c/noop.so');
 
-      const connection = new Connection(url, 'singleGossip');
+      const connection = new Connection(url, 'confirmed');
       const {feeCalculator} = await connection.getRecentBlockhash();
       const fees =
         feeCalculator.lamportsPerSignature *
@@ -59,13 +59,13 @@ if (process.env.TEST_LIVE) {
         programId: program.publicKey,
       });
       await sendAndConfirmTransaction(connection, transaction, [from], {
-        commitment: 'singleGossip',
-        preflightCommitment: 'singleGossip',
+        commitment: 'confirmed',
+        preflightCommitment: 'confirmed',
       });
     }).timeout(5000);
 
     describe('load BPF Rust program', () => {
-      const connection = new Connection(url, 'singleGossip');
+      const connection = new Connection(url, 'confirmed');
 
       let program = new Account();
       let payerAccount = new Account();
@@ -141,8 +141,8 @@ if (process.env.TEST_LIVE) {
           transaction,
           [payerAccount],
           {
-            commitment: 'max', // `getParsedConfirmedTransaction` requires max commitment
-            preflightCommitment: connection.commitment || 'max',
+            commitment: 'finalized', // `getParsedConfirmedTransaction` requires max commitment
+            preflightCommitment: connection.commitment || 'finalized',
           },
         );