@solana/web3.js 1.4.1 → 1.5.1

package/lib/index.d.ts

@@ -447,6 +447,14 @@ declare module '@solana/web3.js' {
     | 'singleGossip'
     | '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>
+   */
+  export type Finality = 'confirmed' | 'finalized';
   /**
    * Filter for largest accounts query
    * <pre>
@@ -1310,30 +1318,37 @@ declare module '@solana/web3.js' {
      * 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,
+      commitment?: Finality,
     ): Promise<ConfirmedBlockSignatures>;
     /**
      * Fetch a transaction details for a confirmed transaction
      */
     getConfirmedTransaction(
       signature: TransactionSignature,
+      commitment?: Finality,
     ): Promise<ConfirmedTransaction | null>;
     /**
      * Fetch parsed transaction details for a confirmed transaction
      */
     getParsedConfirmedTransaction(
       signature: TransactionSignature,
+      commitment?: Finality,
     ): Promise<ParsedConfirmedTransaction | null>;
     /**
      * Fetch parsed transaction details for a batch of confirmed transactions
      */
     getParsedConfirmedTransactions(
       signatures: TransactionSignature[],
+      commitment?: Finality,
     ): Promise<(ParsedConfirmedTransaction | null)[]>;
     /**
      * Fetch a list of all the confirmed signatures for transactions involving an address
@@ -1360,6 +1375,7 @@ declare module '@solana/web3.js' {
     getConfirmedSignaturesForAddress2(
       address: PublicKey,
       options?: ConfirmedSignaturesForAddress2Options,
+      commitment?: Finality,
     ): Promise<Array<ConfirmedSignatureInfo>>;
     /**
      * Fetch the contents of a Nonce account from the cluster, return with context

package/lib/index.esm.js

@@ -3952,8 +3952,10 @@ class Connection {
    */
 
 
-  async getConfirmedBlock(slot) {
-    const unsafeRes = await this._rpcRequest('getConfirmedBlock', [slot]);
+  async getConfirmedBlock(slot, commitment) {
+    const args = this._buildArgsAtLeastConfirmed([slot], commitment);
+
+    const unsafeRes = await this._rpcRequest('getConfirmedBlock', args);
     const res = create(unsafeRes, GetConfirmedBlockRpcResult);
 
     if ('error' in res) {
@@ -3973,11 +3975,13 @@ class Connection {
    */
 
 
-  async getConfirmedBlockSignatures(slot) {
-    const unsafeRes = await this._rpcRequest('getConfirmedBlock', [slot, {
+  async getConfirmedBlockSignatures(slot, commitment) {
+    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) {
@@ -3997,8 +4001,10 @@ class Connection {
    */
 
 
-  async getConfirmedTransaction(signature) {
-    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', [signature]);
+  async getConfirmedTransaction(signature, commitment) {
+    const args = this._buildArgsAtLeastConfirmed([signature], commitment);
+
+    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', args);
     const res = create(unsafeRes, GetConfirmedTransactionRpcResult);
 
     if ('error' in res) {
@@ -4012,8 +4018,10 @@ class Connection {
    */
 
 
-  async getParsedConfirmedTransaction(signature) {
-    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', [signature, 'jsonParsed']);
+  async getParsedConfirmedTransaction(signature, commitment) {
+    const args = this._buildArgsAtLeastConfirmed([signature], commitment, 'jsonParsed');
+
+    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', args);
     const res = create(unsafeRes, GetParsedConfirmedTransactionRpcResult);
 
     if ('error' in res) {
@@ -4027,11 +4035,13 @@ class Connection {
    */
 
 
-  async getParsedConfirmedTransactions(signatures) {
+  async getParsedConfirmedTransactions(signatures, commitment) {
     const batch = signatures.map(signature => {
+      const args = this._buildArgsAtLeastConfirmed([signature], commitment, 'jsonParsed');
+
       return {
         methodName: 'getConfirmedTransaction',
-        args: [signature, 'jsonParsed']
+        args
       };
     });
     const unsafeRes = await this._rpcBatchRequest(batch);
@@ -4069,7 +4079,7 @@ 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].toString();
@@ -4120,8 +4130,10 @@ class Connection {
    */
 
 
-  async getConfirmedSignaturesForAddress2(address, options) {
-    const unsafeRes = await this._rpcRequest('getConfirmedSignaturesForAddress2', [address.toBase58(), options]);
+  async getConfirmedSignaturesForAddress2(address, options, commitment) {
+    const args = this._buildArgsAtLeastConfirmed([address.toBase58()], commitment, undefined, options);
+
+    const unsafeRes = await this._rpcRequest('getConfirmedSignaturesForAddress2', args);
     const res = create(unsafeRes, GetConfirmedSignaturesForAddress2RpcResult);
 
     if ('error' in res) {
@@ -4831,6 +4843,20 @@ class Connection {
    */
 
 
+  _buildArgsAtLeastConfirmed(args, override, encoding, extra) {
+    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
+   */
+
+
   _wsOnSignatureNotification(notification) {
     const res = create(notification, SignatureNotificationResult);