feat: add support for rewards parameter for getBlock

README.md

@@ -128,18 +128,18 @@ The table below summarizes the supported endpoints and the necessary changes (if
 * :scissors: one or several fields are either not supported in the request parameters, or removed from the raw response.
 * :hammer_and_wrench: the raw response is more heavily transformed (e.g. rounding, subset, etc.).
 
-| Solana method                                                                                   | Support              | Known limitations                                                                                                                                                                                                                                                                                                       |
-|-------------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [`getAccountInfo`](https://solana.com/de/docs/rpc/http/getaccountinfo)                          | :scissors:           | <ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                                                                                                      |
-| [`getBalance`](https://solana.com/de/docs/rpc/http/getbalance)                                  | :scissors:           | <ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                                                                                                      |
-| [`getBlock`](https://solana.com/de/docs/rpc/http/getblock)                                      | :scissors: | <ul><li>Only the `signatures` and `none` values for the `transactionDetails` request parameter are supported. If not specified, the default value is `none`.</li></ul><ul><li>The `encoding` and `rewards` request parameters are not supported. If not specified, the default value of `rewards` is `false`.</li></ul> |
-| [`getRecenPrioritizationFees`](https://solana.com/de/docs/rpc/http/getrecentprioritizationfees) | :hammer_and_wrench:  | <ul><li>Returns a subset of the response (configurable by caller)</li></ul>                                                                                                                                                                                                                                             |
-| [`getSignaturesForAddress`](https://solana.com/de/docs/rpc/http/getsignaturesforaddress)        | :white_check_mark:   | <ul><li>Use the field `before` to have idempotent responses</li></ul>                                                                                                                                                                                                                                                   |
-| [`getSignatureStatuses`](https://solana.com/de/docs/rpc/http/getsignaturestatuses)              | :scissors:           | <ul><li>The field `confirmations` is removed from the response</li></ul><ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                              |
-| [`getSlot`](https://solana.com/de/docs/rpc/http/getslot)                                        | :hammer_and_wrench:  | <ul><li>The result is rounded down (configurable by caller)</li></ul>                                                                                                                                                                                                                                                   |
-| [`getTokenAccountBalance`](https://solana.com/de/docs/rpc/http/gettokenaccountbalance)          | :scissors:           | <ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                                                                                                      |
-| [`getTransaction`](https://solana.com/de/docs/rpc/http/gettransaction)                          | :scissors: | <ul><li>Only the `base64` and `base58` values for the `encoding` request parameter are supported.</li></ul>                                                                                                                                                                                                             |
-| [`sendTransaction`](https://solana.com/de/docs/rpc/http/sendtransaction)                        | :white_check_mark:   |                                                                                                                                                                                                                                                                                                                         |
+| Solana method                                                                                   | Support              | Known limitations                                                                                                                                                                                                                                                                                       |
+|-------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [`getAccountInfo`](https://solana.com/de/docs/rpc/http/getaccountinfo)                          | :scissors:           | <ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                                                                                      |
+| [`getBalance`](https://solana.com/de/docs/rpc/http/getbalance)                                  | :scissors:           | <ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                                                                                      |
+| [`getBlock`](https://solana.com/de/docs/rpc/http/getblock)                                      | :scissors: | <ul><li>Only the `signatures` and `none` values for the `transactionDetails` request parameter are supported. If not specified, the default value is `none`.</li></ul><ul><li>The `encoding` request parameter is not supported.</li></ul> |
+| [`getRecenPrioritizationFees`](https://solana.com/de/docs/rpc/http/getrecentprioritizationfees) | :hammer_and_wrench:  | <ul><li>Returns a subset of the response (configurable by caller)</li></ul>                                                                                                                                                                                                                             |
+| [`getSignaturesForAddress`](https://solana.com/de/docs/rpc/http/getsignaturesforaddress)        | :white_check_mark:   | <ul><li>Use the field `before` to have idempotent responses</li></ul>                                                                                                                                                                                                                                   |
+| [`getSignatureStatuses`](https://solana.com/de/docs/rpc/http/getsignaturestatuses)              | :scissors:           | <ul><li>The field `confirmations` is removed from the response</li></ul><ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                              |
+| [`getSlot`](https://solana.com/de/docs/rpc/http/getslot)                                        | :hammer_and_wrench:  | <ul><li>The result is rounded down (configurable by caller)</li></ul>                                                                                                                                                                                                                                   |
+| [`getTokenAccountBalance`](https://solana.com/de/docs/rpc/http/gettokenaccountbalance)          | :scissors:           | <ul><li>The field `context` is removed from the response</li></ul>                                                                                                                                                                                                                                      |
+| [`getTransaction`](https://solana.com/de/docs/rpc/http/gettransaction)                          | :scissors: | <ul><li>Only the `base64` and `base58` values for the `encoding` request parameter are supported.</li></ul>                                                                                                                                                                                             |
+| [`sendTransaction`](https://solana.com/de/docs/rpc/http/sendtransaction)                        | :white_check_mark:   |                                                                                                                                                                                                                                                                                                         |
 
 
 ## Supported Solana JSON-RPC Providers

canister/scripts/examples.sh

@@ -57,6 +57,7 @@ GET_BLOCK_PARAMS="(
     commitment = opt variant { finalized };
     transactionDetails = opt variant { signatures };
     maxSupportedTransactionVersion = opt (0 : nat8);
+    rewards = opt false;
   },
 )"
 CYCLES=$(dfx canister call sol_rpc getBlockCyclesCost "$GET_BLOCK_PARAMS" $FLAGS --output json | jq '.Ok' --raw-output || exit 1)

canister/sol_rpc_canister.did

@@ -369,7 +369,11 @@ type GetBlockParams = record {
     // Slot number of the block to fetch.
     slot: Slot;
     // Specifies what transaction details to include in the response.
-    // If this field is not specified, the default value of "none" will be used.
+    //
+    // *Warning:* If this value is not specified, the default value of `none` will be used, which
+    // is different from the default value in the Solana RPC API. This is because the default value
+    // of `full` for the Solana RPC API results in response sizes that are generally too large to
+    // be supported by the ICP.
     transactionDetails: opt TransactionDetails;
     // The commitment describes how finalized a block is at that point in time.
     commitment: opt variant { confirmed; finalized };
@@ -379,6 +383,8 @@ type GetBlockParams = record {
     // * If this parameter is omitted, only legacy transactions will be returned, and a block
     // containing any versioned transaction will prompt the error.
     maxSupportedTransactionVersion: opt nat8;
+    // Whether to populate the rewards array. If not provided, the default includes rewards.
+    rewards: opt bool;
 };
 
 // Unix timestamp (seconds since the Unix epoch).
@@ -387,7 +393,7 @@ type GetBlockParams = record {
 type Timestamp = int64;
 
 // The result of a Solana `getBlock` RPC method call.
-// TODO XC-342: Add `transactions`, `signatures`, `rewards` and `num_reward_partitions` fields.
+// TODO XC-342: Add `transactions` field.
 type ConfirmedBlock = record {
     // The blockhash of this block's parent, as base-58 encoded string; if the parent block is not
     // available due to ledger cleanup, this field will return "11111111111111111111111111111111".
@@ -403,6 +409,12 @@ type ConfirmedBlock = record {
     // The signatures of the transactions in this block. Included if the request parameter `transactionDetails` is not
     // `none`.
     signatures: opt vec Signature;
+    // Array of rewards distributed in this block.
+    rewards: opt vec Reward;
+    // The epoch rewards are distributed over `1 + numRewardPartition` blocks. See the
+    // [Partitioned Inflationary Rewards Distribution](https://docs.anza.xyz/proposals/partitioned-inflationary-rewards-distribution/)
+    // feature for more details.
+    numRewardPartition: opt nat64;
 };
 
 // Represents the result of a call to the `getBlock` Solana RPC method.

canister/src/rpc_client/json/mod.rs

@@ -139,21 +139,25 @@ impl From<GetBalanceParams> for (String, Option<GetBalanceConfig>) {
 pub struct GetBlockParams(Slot, Option<GetBlockConfig>);
 
 impl GetBlockParams {
-    pub fn get_transaction_details(&self) -> Option<&TransactionDetails> {
+    pub fn get_transaction_details(&self) -> Option<TransactionDetails> {
         self.1
             .as_ref()
-            .and_then(|config| config.transaction_details.as_ref())
+            .and_then(|config| config.transaction_details)
+    }
+
+    pub fn include_rewards(&self) -> Option<bool> {
+        self.1.as_ref().and_then(|config| config.rewards)
     }
 }
 
 impl From<sol_rpc_types::GetBlockParams> for GetBlockParams {
     fn from(params: sol_rpc_types::GetBlockParams) -> Self {
-        // TODO XC-342: Check if all config fields are null, and if so, serialize it as null.
-        //  Currently, we do not want it to be null since rewards=false is not the default value.
+        // We always use a non-null config since the default value for `transaction_details` is
+        // `none` which is different from the Solana RPC API default of `full`.
         let config = Some(GetBlockConfig {
             encoding: None,
             transaction_details: Some(params.transaction_details.unwrap_or_default()),
-            rewards: Some(false),
+            rewards: params.rewards,
             commitment: params.commitment,
             max_supported_transaction_version: params.max_supported_transaction_version,
         });

canister/src/rpc_client/mod.rs

@@ -154,6 +154,9 @@ impl GetBlockRequest {
             match params.get_transaction_details() {
                 None | Some(TransactionDetails::None) => 2048,
                 Some(TransactionDetails::Signatures) => 512 * 1024,
+            } + match params.include_rewards() {
+                None | Some(true) => 256,
+                Some(false) => 0,
             } + HEADER_SIZE_LIMIT,
         );
 

canister/src/rpc_client/tests.rs

@@ -286,10 +286,7 @@ mod request_serialization_tests {
                 GetBlockParams::from(123),
             )
             .unwrap(),
-            json!([
-                123,
-                {"rewards": false, "transactionDetails": "none"}
-            ]),
+            json!([123, {"transactionDetails": "none"}]),
         );
         assert_params_eq(
             GetBlockRequest::get_block(
@@ -300,13 +297,14 @@ mod request_serialization_tests {
                     commitment: Some(GetBlockCommitmentLevel::Finalized),
                     max_supported_transaction_version: Some(2u8),
                     transaction_details: Some(TransactionDetails::Signatures),
+                    rewards: Some(true),
                 },
             )
             .unwrap(),
             json!([
                 123,
                 {
-                    "rewards": false,
+                    "rewards": true,
                     "transactionDetails": "signatures",
                     "commitment": "finalized",
                     "maxSupportedTransactionVersion": 2