Re-implement and expose intermediate rewards calculation.

  This query used to exists, but was removed and replaced with rewardsProvenance', which does provide far less insightful results. I figured we could re-implement the old query by actually fetching the NewEpochState, and re-running the same calculations.

  The downside is obviously the time and resources it takes to fetch that state. So I ended up writing a partial CBOR decoder for it, that would skip the entire UTxO set (the largest part of the object) since it isn't actually required for calculations. However, this turned out not so useful because the results are unfortunately encoded and decoded as a strict bytestring at the moment instead of leverage lazy I/O. So we get no benefit from having a lazy decoder.

  I opened a PR to address the issue ouroboros-network:

  IntersectMBO/ouroboros-network#5138

  So, hopefully, this wasn't all for nothing.

Author: KtorZ

CHANGELOG.md

@@ -11,12 +11,14 @@ math: true
 
 #### Added
 
-N/A
+- A new query `queryLedgerState/rewardsProvenance` which now re-implements and exposes the intermediate rewards calculation. The query name already exists, but the schema is now different. The previous behaviour can be recovered by using the new `queryLedgerState/stakePoolsPerformances` instead.
 
 #### Changed
 
 - **⚠️ BREAKING-CHANGE ⚠️**: `queryLedgerState/dump` no longer return a hex-encoded CBOR dump as part of the JSON response, but instead, serialise directly to a specified on-disk location.
 
+- **⚠️ BREAKING-CHANGE ⚠️**: `queryLedgerState/rewardsProvenance` has been renamed to `queryLedgerState/stakePoolsPerformances`. The schema remains otherwise unchanged.
+
 #### Removed
 
 N/A

README.md

@@ -71,6 +71,7 @@ See our [Ogmios client starter kit](https://github.com/CardanoSolutions/ogmios-t
   `rewardAccountSummaries`     | Current delegation settings and rewards of chosen reward accounts.
   `rewardsProvenance`          | Get details about rewards calculation for the ongoing epoch.
   `stakePools`                 | The list of all pool identifiers currently registered and active, as well as their voting stake.
+  `stakePoolsPerformances`     | Details about pools performances indicators for the ongoing epoch.
   `tip`                        | The current tip the ledger is at. Said differently, the slot number and header hash of the last block that has been processed by the ledger.
   `treasuryAndReserves`        | The Ada value of the treasury and reserves of the protocol.
   `utxo`                       | Current UTXO, possibly filtered by output reference.

docs/content/mini-protocols/local-state-query.md

@@ -116,6 +116,7 @@ queryLedgerState             | Information
 `rewardAccountSummaries`     | Current delegation settings and rewards of chosen reward accounts.
 `rewardsProvenance`          | Get details about rewards calculation for the ongoing epoch.
 `stakePools`                 | The list of all currently registered and active stake pools with their current parameters. This query can be made with or without specifying list of target `stakePools`. When no stake pools are provided as parameter, the query returns the list of all stake pools and their parameters from the node.
+`stakePoolsPerformances`     | Details about pools performances indicators for the ongoing epoch.
 `tip`                        | The current tip the ledger is at. Said differently, the slot number and header hash of the last block that has been processed by the ledger.
 `treasuryAndReserves`        | The Ada value of the treasury and reserves of the protocol.
 `utxo`                       | Current UTXO, possibly filtered by output reference.
@@ -671,6 +672,15 @@ Be aware that it is possible for an acquire request to fail even if (and in part
 }
 ```
 
+#### stakePoolsPerformances
+
+```json
+{
+  "jsonrpc": "2.0",
+  "method": "queryLedgerState/stakePoolsPerformances"
+}
+```
+
 #### treasuryAndReserves
 
 ```json

docs/static/api/specification.yaml

@@ -34,6 +34,7 @@ info:
       - [ledgerState/rewardAccountSummaries](#operation-publish-/?QueryLedgerStateRewardAccountSummaries)
       - [ledgerState/rewardsProvenance](#operation-publish-/?QueryLedgerStateRewardsProvenance)
       - [ledgerState/stakePools](#operation-publish-/?QueryLedgerStateStakePools)
+      - [ledgerState/stakePoolsPerformances](#operation-publish-/?QueryLedgerStateStakePoolsPerformances)
       - [ledgerState/tip](#operation-publish-/?QueryLedgerStateTip)
       - [ledgerState/treasuryAndReserves](#operation-publish-/?QueryLedgerStateTreasuryAndReserves)
       - [ledgerState/utxo](#operation-publish-/?QueryLedgerStateUtxo)
@@ -476,6 +477,20 @@ channels:
         oneOf:
           - $ref: "#/components/messages/QueryLedgerStateStakePoolsResponse"
 
+  /?QueryLedgerStateStakePoolsPerformances:
+    description: |
+      <p align="right"><a href="#asyncapi">Top ⬆️</a></p>
+    publish:
+      operationId: QueryLedgerStateStakePoolsPerformances
+      message:
+        oneOf:
+          - $ref: "#/components/messages/QueryLedgerStateStakePoolsPerformances"
+    subscribe:
+      operationId: QueryLedgerStateStakePoolsPerformancesResponse
+      message:
+        oneOf:
+          - $ref: "#/components/messages/QueryLedgerStateStakePoolsPerformancesResponse"
+
   /?QueryLedgerStateTip:
     description: |
       <p align="right"><a href="#asyncapi">Top ⬆️</a></p>
@@ -842,6 +857,14 @@ components:
       payload:
         $ref: "/ogmios.json#/properties/QueryLedgerStateStakePools"
 
+    QueryLedgerStateStakePoolsPerformances:
+      title: QueryLedgerStateStakePoolsPerformances
+      name: "since v6.13.0"
+      description: |
+        Query details about pools performances indicators for the ongoing epoch.
+      payload:
+        $ref: "/ogmios.json#/properties/QueryLedgerStateStakePoolsPerformances"
+
     QueryLedgerStateTip:
       title: QueryLedgerStateTip
       name: "since v6.0.0"
@@ -1006,6 +1029,12 @@ components:
       payload:
         $ref: "/ogmios.json#/properties/QueryLedgerStateStakePoolsResponse"
 
+    QueryLedgerStateStakePoolsPerformancesResponse:
+      title: QueryLedgerStateStakePoolsPerformancesResponse
+      name: "since v6.13.0"
+      payload:
+        $ref: "/ogmios.json#/properties/QueryLedgerStateStakePoolsPerformancesResponse"
+
     QueryLedgerStateTipResponse:
       title: QueryLedgerStateTipResponse
       name: "since v6.0.0"

docs/static/ogmios.json

@@ -28,6 +28,7 @@
   , "QueryLedgerStateRewardAccountSummaries", "QueryLedgerStateRewardAccountSummariesResponse"
   , "QueryLedgerStateRewardsProvenance", "QueryLedgerStateRewardsProvenanceResponse"
   , "QueryLedgerStateStakePools", "QueryLedgerStateStakePoolsResponse"
+  , "QueryLedgerStateStakePoolsPerformances", "QueryLedgerStateStakePoolsPerformancesResponse"
   , "QueryLedgerStateTip", "QueryLedgerStateTipResponse"
   , "QueryLedgerStateTreasuryAndReserves", "QueryLedgerStateTreasuryAndReservesResponse"
   , "QueryLedgerStateUtxo", "QueryLedgerStateUtxoResponse"
@@ -689,6 +690,7 @@
           , "queryLedgerState/rewardAccountSummaries"
           , "queryLedgerState/rewardsProvenance"
           , "queryLedgerState/stakePools"
+          , "queryLedgerState/stakePoolsPerformances"
           , "queryLedgerState/utxo"
           , "queryLedgerState/tip"
           , "queryLedgerState/treasuryAndReserves"
@@ -740,6 +742,7 @@
           , "queryLedgerState/rewardAccountSummaries"
           , "queryLedgerState/rewardsProvenance"
           , "queryLedgerState/stakePools"
+          , "queryLedgerState/stakePoolsPerformances"
           , "queryLedgerState/utxo"
           , "queryLedgerState/tip"
           , "queryLedgerState/treasuryAndReserves"
@@ -790,6 +793,7 @@
           , "queryLedgerState/rewardAccountSummaries"
           , "queryLedgerState/rewardsProvenance"
           , "queryLedgerState/stakePools"
+          , "queryLedgerState/stakePoolsPerformances"
           , "queryLedgerState/utxo"
           , "queryLedgerState/tip"
           , "queryLedgerState/treasuryAndReserves"
@@ -1715,6 +1719,56 @@
       ]
     }
 
+  , "QueryLedgerStateStakePoolsPerformances":
+    { "title": "QueryLedgerStateStakePoolsPerformances"
+    , "description": "Query details about pools performances indicators for the ongoing epoch."
+    , "type": "object"
+    , "required": [ "jsonrpc", "method" ]
+    , "additionalProperties": false
+    , "properties":
+      { "jsonrpc":
+        { "type": "string"
+        , "enum": [ "2.0" ]
+        }
+      , "method":
+        { "type": "string"
+        , "enum": [ "queryLedgerState/stakePoolsPerformances" ]
+        }
+      , "id":
+        { "description": "An arbitrary JSON value that will be mirrored back in the response."
+        }
+      }
+    }
+
+  , "QueryLedgerStateStakePoolsPerformancesResponse":
+    { "oneOf":
+      [ { "title": "QueryLedgerStateStakePoolsPerformancesResponse"
+        , "type": "object"
+        , "required": [ "jsonrpc", "method", "result" ]
+        , "additionalProperties": false
+        , "properties":
+          { "jsonrpc":
+            { "type": "string"
+            , "enum": [ "2.0" ]
+            }
+          , "method":
+            { "type": "string"
+            , "enum": [ "queryLedgerState/stakePoolsPerformances" ]
+            }
+          , "result":
+            { "$ref": "ogmios.json#/definitions/StakePoolsPerformances"
+            }
+          , "id":
+            { "description": "Any value that was set by a client request in the 'id' field."
+            }
+          }
+        }
+      , { "$ref": "ogmios.json#/properties/QueryLedgerStateEraMismatch" }
+      , { "$ref": "ogmios.json#/properties/QueryLedgerStateUnavailableInCurrentEra" }
+      , { "$ref": "ogmios.json#/properties/QueryLedgerStateAcquiredExpired" }
+      ]
+    }
+
   , "QueryLedgerStateStakePools":
     { "title": "QueryLedgerStateStakePools"
     , "description": "Query the list of all stake pools currently registered and active, optionally filtered by ids."
@@ -2919,6 +2973,37 @@
     }
 
   , "RewardsProvenance":
+    { "type": "object"
+    , "additionalProperties": false
+    , "required": [ "totalStake", "activeStake", "fees", "incentives", "treasuryTax", "totalRewards", "efficiency", "pools" ]
+    , "properties":
+      { "totalStake": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+      , "activeStake": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+      , "fees": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+      , "incentives": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+      , "treasuryTax": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+      , "totalRewards": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+      , "efficiency": { "$ref": "cardano.json#/definitions/Ratio" }
+      , "pools":
+        { "type": "object"
+        , "propertyNames": { "$ref": "cardano.json#/definitions/StakePoolId" }
+        , "additionalProperties":
+          { "title": "StakePoolRewardsProvenance"
+          , "type": "object"
+          , "additionalProperties": false
+          , "required": [ "relativeStake", "blocksMade", "totalRewards", "leaderReward"]
+          , "properties":
+            { "relativeStake": { "$ref": "cardano.json#/definitions/Ratio" }
+            , "blocksMade": { "$ref": "cardano.json#/definitions/UInt32" }
+            , "totalRewards": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+            , "leaderReward": { "$ref": "cardano.json#/definitions/Value<AdaOnly>" }
+            }
+          }
+        }
+      }
+    }
+
+  , "StakePoolsPerformances":
     { "type": "object"
     , "description": "Details about how rewards are calculated for the ongoing epoch."
     , "additionalProperties": false

server/ogmios.cabal

@@ -60,6 +60,7 @@ library:
     - cardano-ledger-core
     - cardano-ledger-mary
     - cardano-ledger-shelley
+    - cardano-ledger-shelley
     - cardano-protocol-tpraos
     - cardano-slotting
     - cardano-strict-containers
@@ -107,20 +108,21 @@ library:
     - serialise
     - small-steps
     - sop-extras
-    - strict-sop-core
     - stm
+    - strict-sop-core
     - text
     - time
     - time-manager
     - transformers
     - typed-protocols
     - unix
     - vector
+    - vector-map
     - wai
     - wai-websockets
     - warp
-    - yaml
     - websockets
+    - yaml
 
 executables:
   ogmios: