@solana/web3.js 1.13.1 → 1.14.1

package/lib/index.d.ts

@@ -740,6 +740,24 @@ declare module '@solana/web3.js' {
     /** The error result of transaction processing */
     err: TransactionError | null;
   };
+  /**
+   * A processed transaction from the RPC API
+   */
+  export type TransactionResponse = {
+    /** The slot during which the transaction was processed */
+    slot: number;
+    /** The transaction */
+    transaction: {
+      /** The transaction message */
+      message: Message;
+      /** The transaction signatures */
+      signatures: string[];
+    };
+    /** Metadata produced from the transaction */
+    meta: ConfirmedTransactionMeta | null;
+    /** The unix timestamp of when the transaction was processed */
+    blockTime?: number | null;
+  };
   /**
    * A confirmed transaction on the ledger
    */
@@ -819,6 +837,42 @@ declare module '@solana/web3.js' {
     /** The unix timestamp of when the transaction was processed */
     blockTime?: number | null;
   };
+  /**
+   * A processed block fetched from the RPC API
+   */
+  export type BlockResponse = {
+    /** Blockhash of this block */
+    blockhash: Blockhash;
+    /** Blockhash of this block's parent */
+    previousBlockhash: Blockhash;
+    /** Slot index of this block's parent */
+    parentSlot: number;
+    /** Vector of transactions with status meta and original message */
+    transactions: Array<{
+      /** The transaction */
+      transaction: {
+        /** The transaction message */
+        message: Message;
+        /** The transaction signatures */
+        signatures: string[];
+      };
+      /** Metadata produced from the transaction */
+      meta: ConfirmedTransactionMeta | null;
+    }>;
+    /** Vector of block rewards */
+    rewards?: Array<{
+      /** Public key of reward recipient */
+      pubkey: string;
+      /** Reward value in lamports */
+      lamports: number;
+      /** Account balance after reward is applied */
+      postBalance: number | null;
+      /** Type of reward received */
+      rewardType: string | null;
+    }>;
+    /** The unix timestamp of when the block was processed */
+    blockTime: number | null;
+  };
   /**
    * A ConfirmedBlock on the ledger
    */
@@ -1453,7 +1507,8 @@ declare module '@solana/web3.js' {
     getTransactionCount(commitment?: Commitment): Promise<number>;
     /**
      * Fetch the current total currency supply of the cluster in lamports
-     * @deprecated Deprecated since v1.2.8. Use `Connection.getSupply()` instead.
+     *
+     * @deprecated Deprecated since v1.2.8. Please use {@link getSupply} instead.
      */
     getTotalSupply(commitment?: Commitment): Promise<number>;
     /**
@@ -1523,9 +1578,29 @@ declare module '@solana/web3.js' {
      * Fetch the node version
      */
     getVersion(): Promise<Version>;
+    /**
+     * Fetch a processed block from the cluster.
+     */
+    getBlock(
+      slot: number,
+      opts?: {
+        commitment?: Finality;
+      },
+    ): Promise<BlockResponse | null>;
+    /**
+     * Fetch a processed transaction from the cluster.
+     */
+    getTransaction(
+      signature: string,
+      opts?: {
+        commitment?: Finality;
+      },
+    ): Promise<TransactionResponse | null>;
     /**
      * Fetch a list of Transactions and transaction statuses from the cluster
-     * for a confirmed block
+     * for a confirmed block.
+     *
+     * @deprecated Deprecated since v1.13.0. Please use {@link getBlock} instead.
      */
     getConfirmedBlock(
       slot: number,
@@ -1562,7 +1637,8 @@ declare module '@solana/web3.js' {
     /**
      * Fetch a list of all the confirmed signatures for transactions involving an address
      * within a specified slot range. Max range allowed is 10,000 slots.
-     * @deprecated Deprecated since v1.3. Use `Connection.getConfirmedSignaturesForAddress2()` instead.
+     *
+     * @deprecated Deprecated since v1.3. Please use {@link getConfirmedSignaturesForAddress2} instead.
      *
      * @param address queried address
      * @param startSlot start slot, inclusive

package/lib/index.esm.js

@@ -2936,10 +2936,6 @@ const GetSignatureStatusesRpcResult = jsonRpcResultAndContext(array(nullable(Sig
  */
 
 const GetMinimumBalanceForRentExemptionRpcResult = jsonRpcResult(number());
-/**
- * @internal
- */
-
 const ConfirmedTransactionResult = type({
   signatures: array(string()),
   message: type({
@@ -2957,13 +2953,6 @@ const ConfirmedTransactionResult = type({
     recentBlockhash: string()
   })
 });
-const TransactionFromConfirmed = coerce(instance(Transaction), ConfirmedTransactionResult, result => {
-  const {
-    message,
-    signatures
-  } = result;
-  return Transaction.populate(new Message(message), signatures);
-});
 const ParsedInstructionResult = type({
   parsed: unknown(),
   program: string(),
@@ -3059,7 +3048,7 @@ const GetConfirmedBlockRpcResult = jsonRpcResult(nullable(type({
   previousBlockhash: string(),
   parentSlot: number(),
   transactions: array(type({
-    transaction: TransactionFromConfirmed,
+    transaction: ConfirmedTransactionResult,
     meta: nullable(ConfirmedTransactionMetaResult)
   })),
   rewards: optional(array(type({
@@ -3087,9 +3076,9 @@ const GetConfirmedBlockSignaturesRpcResult = jsonRpcResult(nullable(type({
 
 const GetConfirmedTransactionRpcResult = jsonRpcResult(nullable(type({
   slot: number(),
-  transaction: TransactionFromConfirmed,
   meta: ConfirmedTransactionMetaResult,
-  blockTime: optional(nullable(number()))
+  blockTime: optional(nullable(number())),
+  transaction: ConfirmedTransactionResult
 })));
 /**
  * Expected JSON RPC response for the "getConfirmedTransaction" message
@@ -3902,7 +3891,8 @@ class Connection {
   }
   /**
    * Fetch the current total currency supply of the cluster in lamports
-   * @deprecated Deprecated since v1.2.8. Use `Connection.getSupply()` instead.
+   *
+   * @deprecated Deprecated since v1.2.8. Please use {@link getSupply} instead.
    */
 
 
@@ -4111,13 +4101,12 @@ class Connection {
     return res.result;
   }
   /**
-   * Fetch a list of Transactions and transaction statuses from the cluster
-   * for a confirmed block
+   * Fetch a processed block from the cluster.
    */
 
 
-  async getConfirmedBlock(slot, commitment) {
-    const args = this._buildArgsAtLeastConfirmed([slot], commitment);
+  async getBlock(slot, opts) {
+    const args = this._buildArgsAtLeastConfirmed([slot], opts && opts.commitment);
 
     const unsafeRes = await this._rpcRequest('getConfirmedBlock', args);
     const res = create(unsafeRes, GetConfirmedBlockRpcResult);
@@ -4127,12 +4116,73 @@ class Connection {
     }
 
     const result = res.result;
+    if (!result) return result;
+    return { ...result,
+      transactions: result.transactions.map(({
+        transaction,
+        meta
+      }) => {
+        const message = new Message(transaction.message);
+        return {
+          meta,
+          transaction: { ...transaction,
+            message
+          }
+        };
+      })
+    };
+  }
+  /**
+   * Fetch a processed transaction from the cluster.
+   */
+
+
+  async getTransaction(signature, opts) {
+    const args = this._buildArgsAtLeastConfirmed([signature], opts && opts.commitment);
+
+    const unsafeRes = await this._rpcRequest('getConfirmedTransaction', args);
+    const res = create(unsafeRes, GetConfirmedTransactionRpcResult);
+
+    if ('error' in res) {
+      throw new Error('failed to get confirmed transaction: ' + res.error.message);
+    }
+
+    const result = res.result;
+    if (!result) return result;
+    return { ...result,
+      transaction: { ...result.transaction,
+        message: new Message(result.transaction.message)
+      }
+    };
+  }
+  /**
+   * Fetch a list of Transactions and transaction statuses from the cluster
+   * for a confirmed block.
+   *
+   * @deprecated Deprecated since v1.13.0. Please use {@link getBlock} instead.
+   */
+
+
+  async getConfirmedBlock(slot, commitment) {
+    const result = await this.getBlock(slot, {
+      commitment
+    });
 
     if (!result) {
       throw new Error('Confirmed block ' + slot + ' not found');
     }
 
-    return result;
+    return { ...result,
+      transactions: result.transactions.map(({
+        transaction,
+        meta
+      }) => {
+        return {
+          meta,
+          transaction: Transaction.populate(transaction.message, transaction.signatures)
+        };
+      })
+    };
   }
   /**
    * Fetch a list of Signatures from the cluster for a confirmed block, excluding rewards
@@ -4166,16 +4216,17 @@ class Connection {
 
 
   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) {
-      throw new Error('failed to get confirmed transaction: ' + res.error.message);
-    }
-
-    return res.result;
+    const result = await this.getTransaction(signature, {
+      commitment
+    });
+    if (!result) return result;
+    const {
+      message,
+      signatures
+    } = result.transaction;
+    return { ...result,
+      transaction: Transaction.populate(message, signatures)
+    };
   }
   /**
    * Fetch parsed transaction details for a confirmed transaction
@@ -4223,7 +4274,8 @@ class Connection {
   /**
    * Fetch a list of all the confirmed signatures for transactions involving an address
    * within a specified slot range. Max range allowed is 10,000 slots.
-   * @deprecated Deprecated since v1.3. Use `Connection.getConfirmedSignaturesForAddress2()` instead.
+   *
+   * @deprecated Deprecated since v1.3. Please use {@link getConfirmedSignaturesForAddress2} instead.
    *
    * @param address queried address
    * @param startSlot start slot, inclusive