@solana/web3.js 1.67.1 → 1.68.0

package/lib/index.d.ts

@@ -2100,6 +2100,18 @@ declare module '@solana/web3.js' {
   export type GetBlockConfig = {
     /** The level of finality desired */
     commitment?: Finality;
+    /**
+     * Whether to populate the rewards array. If parameter not provided, the default includes rewards.
+     */
+    rewards?: boolean;
+    /**
+     * Level of transaction detail to return, either "full", "accounts", "signatures", or "none". If
+     * parameter not provided, the default detail level is "full". If "accounts" are requested,
+     * transaction details only include signatures and an annotated list of accounts in each
+     * transaction. Transaction metadata is limited to only: fee, err, pre_balances, post_balances,
+     * pre_token_balances, and post_token_balances.
+     */
+    transactionDetails?: 'accounts' | 'full' | 'none' | 'signatures';
   };
   /**
    * Configuration object for changing `getBlock` query behavior
@@ -2109,6 +2121,18 @@ declare module '@solana/web3.js' {
     commitment?: Finality;
     /** The max transaction version to return in responses. If the requested transaction is a higher version, an error will be returned */
     maxSupportedTransactionVersion?: number;
+    /**
+     * Whether to populate the rewards array. If parameter not provided, the default includes rewards.
+     */
+    rewards?: boolean;
+    /**
+     * Level of transaction detail to return, either "full", "accounts", "signatures", or "none". If
+     * parameter not provided, the default detail level is "full". If "accounts" are requested,
+     * transaction details only include signatures and an annotated list of accounts in each
+     * transaction. Transaction metadata is limited to only: fee, err, pre_balances, post_balances,
+     * pre_token_balances, and post_token_balances.
+     */
+    transactionDetails?: 'accounts' | 'full' | 'none' | 'signatures';
   };
   /**
    * Configuration object for changing `getStakeMinimumDelegation` query behavior
@@ -2603,6 +2627,14 @@ declare module '@solana/web3.js' {
     /** The unix timestamp of when the block was processed */
     blockTime: number | null;
   };
+  /**
+   * A processed block fetched from the RPC API where the `transactionDetails` mode is `accounts`
+   */
+  export type AccountsModeBlockResponse = VersionedAccountsModeBlockResponse;
+  /**
+   * A processed block fetched from the RPC API where the `transactionDetails` mode is `none`
+   */
+  export type NoneModeBlockResponse = VersionedNoneModeBlockResponse;
   /**
    * A block with parsed transactions
    */
@@ -2638,6 +2670,31 @@ declare module '@solana/web3.js' {
     /** The number of blocks beneath this block */
     blockHeight: number | null;
   };
+  /**
+   * A block with parsed transactions where the `transactionDetails` mode is `accounts`
+   */
+  export type ParsedAccountsModeBlockResponse = Omit<
+    ParsedBlockResponse,
+    'transactions'
+  > & {
+    transactions: Array<
+      Omit<ParsedBlockResponse['transactions'][number], 'transaction'> & {
+        transaction: Pick<
+          ParsedBlockResponse['transactions'][number]['transaction'],
+          'signatures'
+        > & {
+          accountKeys: ParsedMessageAccount[];
+        };
+      }
+    >;
+  };
+  /**
+   * A block with parsed transactions where the `transactionDetails` mode is `none`
+   */
+  export type ParsedNoneModeBlockResponse = Omit<
+    ParsedBlockResponse,
+    'transactions'
+  >;
   /**
    * A processed block fetched from the RPC API
    */
@@ -2676,6 +2733,31 @@ declare module '@solana/web3.js' {
     /** The unix timestamp of when the block was processed */
     blockTime: number | null;
   };
+  /**
+   * A processed block fetched from the RPC API where the `transactionDetails` mode is `accounts`
+   */
+  export type VersionedAccountsModeBlockResponse = Omit<
+    VersionedBlockResponse,
+    'transactions'
+  > & {
+    transactions: Array<
+      Omit<VersionedBlockResponse['transactions'][number], 'transaction'> & {
+        transaction: Pick<
+          VersionedBlockResponse['transactions'][number]['transaction'],
+          'signatures'
+        > & {
+          accountKeys: ParsedMessageAccount[];
+        };
+      }
+    >;
+  };
+  /**
+   * A processed block fetched from the RPC API where the `transactionDetails` mode is `none`
+   */
+  export type VersionedNoneModeBlockResponse = Omit<
+    VersionedBlockResponse,
+    'transactions'
+  >;
   /**
    * A confirmed block on the ledger
    *
@@ -3534,7 +3616,7 @@ declare module '@solana/web3.js' {
      * Fetch the fee for a message from the cluster, return with context
      */
     getFeeForMessage(
-      message: Message,
+      message: VersionedMessage,
       commitment?: Commitment,
     ): Promise<RpcResponseAndContext<number>>;
     /**
@@ -3579,6 +3661,26 @@ declare module '@solana/web3.js' {
       slot: number,
       rawConfig?: GetBlockConfig,
     ): Promise<BlockResponse | null>;
+    /**
+     * @deprecated Instead, call `getBlock` using a `GetVersionedBlockConfig` by
+     * setting the `maxSupportedTransactionVersion` property.
+     */
+    getBlock(
+      slot: number,
+      rawConfig: GetBlockConfig & {
+        transactionDetails: 'accounts';
+      },
+    ): Promise<AccountsModeBlockResponse | null>;
+    /**
+     * @deprecated Instead, call `getBlock` using a `GetVersionedBlockConfig` by
+     * setting the `maxSupportedTransactionVersion` property.
+     */
+    getBlock(
+      slot: number,
+      rawConfig: GetBlockConfig & {
+        transactionDetails: 'none';
+      },
+    ): Promise<NoneModeBlockResponse | null>;
     /**
      * Fetch a processed block from the cluster.
      */
@@ -3586,13 +3688,37 @@ declare module '@solana/web3.js' {
       slot: number,
       rawConfig?: GetVersionedBlockConfig,
     ): Promise<VersionedBlockResponse | null>;
+    getBlock(
+      slot: number,
+      rawConfig: GetVersionedBlockConfig & {
+        transactionDetails: 'accounts';
+      },
+    ): Promise<VersionedAccountsModeBlockResponse | null>;
+    getBlock(
+      slot: number,
+      rawConfig: GetVersionedBlockConfig & {
+        transactionDetails: 'none';
+      },
+    ): Promise<VersionedNoneModeBlockResponse | null>;
     /**
      * Fetch parsed transaction details for a confirmed or finalized block
      */
     getParsedBlock(
       slot: number,
       rawConfig?: GetVersionedBlockConfig,
-    ): Promise<ParsedBlockResponse | null>;
+    ): Promise<ParsedAccountsModeBlockResponse>;
+    getParsedBlock(
+      slot: number,
+      rawConfig: GetVersionedBlockConfig & {
+        transactionDetails: 'accounts';
+      },
+    ): Promise<ParsedAccountsModeBlockResponse>;
+    getParsedBlock(
+      slot: number,
+      rawConfig: GetVersionedBlockConfig & {
+        transactionDetails: 'none';
+      },
+    ): Promise<ParsedNoneModeBlockResponse>;
     getBlockHeight(
       commitmentOrConfig?: Commitment | GetBlockHeightConfig,
     ): Promise<number>;

package/lib/index.esm.js

@@ -4388,6 +4388,16 @@ const ConfirmedTransactionResult = type({
     addressTableLookups: optional(array(AddressTableLookupStruct))
   })
 });
+const AnnotatedAccountKey = type({
+  pubkey: PublicKeyFromString,
+  signer: boolean(),
+  writable: boolean(),
+  source: optional(union([literal('transaction'), literal('lookupTable')]))
+});
+const ConfirmedTransactionAccountsModeResult = type({
+  accountKeys: array(AnnotatedAccountKey),
+  signatures: array(string())
+});
 const ParsedInstructionResult = type({
   parsed: unknown(),
   program: string(),
@@ -4422,12 +4432,7 @@ const ParsedOrRawInstruction = coerce(InstructionResult, UnknownInstructionResul
 const ParsedConfirmedTransactionResult = type({
   signatures: array(string()),
   message: type({
-    accountKeys: array(type({
-      pubkey: PublicKeyFromString,
-      signer: boolean(),
-      writable: boolean(),
-      source: optional(union([literal('transaction'), literal('lookupTable')]))
-    })),
+    accountKeys: array(AnnotatedAccountKey),
     instructions: array(ParsedOrRawInstruction),
     recentBlockhash: string(),
     addressTableLookups: optional(nullable(array(AddressTableLookupStruct)))
@@ -4486,6 +4491,14 @@ const ParsedConfirmedTransactionMetaResult = type({
   computeUnitsConsumed: optional(number())
 });
 const TransactionVersionStruct = union([literal(0), literal('legacy')]);
+/** @internal */
+
+const RewardsResult = type({
+  pubkey: string(),
+  lamports: number(),
+  postBalance: nullable(number()),
+  rewardType: nullable(string())
+});
 /**
  * Expected JSON RPC response for the "getBlock" message
  */
@@ -4499,12 +4512,36 @@ const GetBlockRpcResult = jsonRpcResult(nullable(type({
     meta: nullable(ConfirmedTransactionMetaResult),
     version: optional(TransactionVersionStruct)
   })),
-  rewards: optional(array(type({
-    pubkey: string(),
-    lamports: number(),
-    postBalance: nullable(number()),
-    rewardType: nullable(string())
-  }))),
+  rewards: optional(array(RewardsResult)),
+  blockTime: nullable(number()),
+  blockHeight: nullable(number())
+})));
+/**
+ * Expected JSON RPC response for the "getBlock" message when `transactionDetails` is `none`
+ */
+
+const GetNoneModeBlockRpcResult = jsonRpcResult(nullable(type({
+  blockhash: string(),
+  previousBlockhash: string(),
+  parentSlot: number(),
+  rewards: optional(array(RewardsResult)),
+  blockTime: nullable(number()),
+  blockHeight: nullable(number())
+})));
+/**
+ * Expected JSON RPC response for the "getBlock" message when `transactionDetails` is `accounts`
+ */
+
+const GetAccountsModeBlockRpcResult = jsonRpcResult(nullable(type({
+  blockhash: string(),
+  previousBlockhash: string(),
+  parentSlot: number(),
+  transactions: array(type({
+    transaction: ConfirmedTransactionAccountsModeResult,
+    meta: nullable(ConfirmedTransactionMetaResult),
+    version: optional(TransactionVersionStruct)
+  })),
+  rewards: optional(array(RewardsResult)),
   blockTime: nullable(number()),
   blockHeight: nullable(number())
 })));
@@ -4521,12 +4558,36 @@ const GetParsedBlockRpcResult = jsonRpcResult(nullable(type({
     meta: nullable(ParsedConfirmedTransactionMetaResult),
     version: optional(TransactionVersionStruct)
   })),
-  rewards: optional(array(type({
-    pubkey: string(),
-    lamports: number(),
-    postBalance: nullable(number()),
-    rewardType: nullable(string())
-  }))),
+  rewards: optional(array(RewardsResult)),
+  blockTime: nullable(number()),
+  blockHeight: nullable(number())
+})));
+/**
+ * Expected parsed JSON RPC response for the "getBlock" message  when `transactionDetails` is `accounts`
+ */
+
+const GetParsedAccountsModeBlockRpcResult = jsonRpcResult(nullable(type({
+  blockhash: string(),
+  previousBlockhash: string(),
+  parentSlot: number(),
+  transactions: array(type({
+    transaction: ConfirmedTransactionAccountsModeResult,
+    meta: nullable(ParsedConfirmedTransactionMetaResult),
+    version: optional(TransactionVersionStruct)
+  })),
+  rewards: optional(array(RewardsResult)),
+  blockTime: nullable(number()),
+  blockHeight: nullable(number())
+})));
+/**
+ * Expected parsed JSON RPC response for the "getBlock" message  when `transactionDetails` is `none`
+ */
+
+const GetParsedNoneModeBlockRpcResult = jsonRpcResult(nullable(type({
+  blockhash: string(),
+  previousBlockhash: string(),
+  parentSlot: number(),
+  rewards: optional(array(RewardsResult)),
   blockTime: nullable(number()),
   blockHeight: nullable(number())
 })));
@@ -4544,12 +4605,7 @@ const GetConfirmedBlockRpcResult = jsonRpcResult(nullable(type({
     transaction: ConfirmedTransactionResult,
     meta: nullable(ConfirmedTransactionMetaResult)
   })),
-  rewards: optional(array(type({
-    pubkey: string(),
-    lamports: number(),
-    postBalance: nullable(number()),
-    rewardType: nullable(string())
-  }))),
+  rewards: optional(array(RewardsResult)),
   blockTime: nullable(number())
 })));
 /**
@@ -6046,7 +6102,7 @@ class Connection {
 
 
   async getFeeForMessage(message, commitment) {
-    const wireMessage = message.serialize().toString('base64');
+    const wireMessage = toBuffer(message.serialize()).toString('base64');
 
     const args = this._buildArgs([wireMessage], commitment);
 
@@ -6171,33 +6227,67 @@ class Connection {
     , config);
 
     const unsafeRes = await this._rpcRequest('getBlock', args);
-    const res = create(unsafeRes, GetBlockRpcResult);
 
-    if ('error' in res) {
-      throw new SolanaJSONRPCError(res.error, 'failed to get confirmed block');
-    }
+    try {
+      switch (config === null || config === void 0 ? void 0 : config.transactionDetails) {
+        case 'accounts':
+          {
+            const res = create(unsafeRes, GetAccountsModeBlockRpcResult);
 
-    const result = res.result;
-    if (!result) return result;
-    return { ...result,
-      transactions: result.transactions.map(({
-        transaction,
-        meta,
-        version
-      }) => ({
-        meta,
-        transaction: { ...transaction,
-          message: versionedMessageFromResponse(version, transaction.message)
-        },
-        version
-      }))
-    };
+            if ('error' in res) {
+              throw res.error;
+            }
+
+            return res.result;
+          }
+
+        case 'none':
+          {
+            const res = create(unsafeRes, GetNoneModeBlockRpcResult);
+
+            if ('error' in res) {
+              throw res.error;
+            }
+
+            return res.result;
+          }
+
+        default:
+          {
+            const res = create(unsafeRes, GetBlockRpcResult);
+
+            if ('error' in res) {
+              throw res.error;
+            }
+
+            const {
+              result
+            } = res;
+            return result ? { ...result,
+              transactions: result.transactions.map(({
+                transaction,
+                meta,
+                version
+              }) => ({
+                meta,
+                transaction: { ...transaction,
+                  message: versionedMessageFromResponse(version, transaction.message)
+                },
+                version
+              }))
+            } : null;
+          }
+      }
+    } catch (e) {
+      throw new SolanaJSONRPCError(e, 'failed to get confirmed block');
+    }
   }
   /**
    * Fetch parsed transaction details for a confirmed or finalized block
    */
 
 
+  // eslint-disable-next-line no-dupe-class-members
   async getParsedBlock(slot, rawConfig) {
     const {
       commitment,
@@ -6207,13 +6297,45 @@ class Connection {
     const args = this._buildArgsAtLeastConfirmed([slot], commitment, 'jsonParsed', config);
 
     const unsafeRes = await this._rpcRequest('getBlock', args);
-    const res = create(unsafeRes, GetParsedBlockRpcResult);
 
-    if ('error' in res) {
-      throw new SolanaJSONRPCError(res.error, 'failed to get block');
-    }
+    try {
+      switch (config === null || config === void 0 ? void 0 : config.transactionDetails) {
+        case 'accounts':
+          {
+            const res = create(unsafeRes, GetParsedAccountsModeBlockRpcResult);
 
-    return res.result;
+            if ('error' in res) {
+              throw res.error;
+            }
+
+            return res.result;
+          }
+
+        case 'none':
+          {
+            const res = create(unsafeRes, GetParsedNoneModeBlockRpcResult);
+
+            if ('error' in res) {
+              throw res.error;
+            }
+
+            return res.result;
+          }
+
+        default:
+          {
+            const res = create(unsafeRes, GetParsedBlockRpcResult);
+
+            if ('error' in res) {
+              throw res.error;
+            }
+
+            return res.result;
+          }
+      }
+    } catch (e) {
+      throw new SolanaJSONRPCError(e, 'failed to get block');
+    }
   }
   /*
    * Returns the current block height of the node