cardano-rpc: Add timestamp to fetchBlock#1242
Open
carbolymer wants to merge 1 commit into
Open
Conversation
carbolymer
force-pushed
the
mgalazyn/feature/rpc-fetchblock-add-timestamp
branch
from
4cc7e51 to
3ef4994
Compare
carbolymer
requested review from
CarlosLopezDeLara,
disassembler,
erikd and
palas
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the cardano-rpc FetchBlock SyncService implementation to populate Block.timestamp, by deriving a slot timestamp using SystemStart plus an EraHistory computed from the node’s ledger state. To support this from cardano-rpc, it also expands Cardano.Api.Consensus re-exports for node-kernel access.
Changes:
- Extend
NodeKernelAccessto carrySystemStartand an IO-backedreadEraHistoryaction, enabling slot-to-UTC conversion when servingFetchBlock. - Populate
Block.timestamp(milliseconds since epoch) in the FetchBlock handler and update docs to reflect the feature. - Add additional consensus re-exports (and changelog fragments) to support the new node-kernel/ledger-era-history functionality.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| cardano-rpc/src/Cardano/Rpc/Server/NodeKernelAccess/Type.hs | Extend the node-kernel handle with systemStart and readEraHistory (and rename the ChainDB field). |
| cardano-rpc/src/Cardano/Rpc/Server/NodeKernelAccess.hs | Build the extended NodeKernelAccess from TopLevelConfig + NodeKernel; adjust block fetch helper to use renamed field. |
| cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Sync.hs | Compute and populate Block.timestamp during FetchBlock responses. |
| cardano-rpc/README.md | Mark FetchBlock as no longer missing Block.timestamp. |
| cardano-api/src/Cardano/Api/Consensus/Internal/Reexport.hs | Expand internal consensus re-exports used by Cardano.Api.Consensus. |
| cardano-api/src/Cardano/Api/Consensus.hs | Re-export additional consensus/node-kernel symbols from the public Cardano.Api.Consensus module. |
| .changes/20260602_cardano_rpc_fetchblock.yml | Update changelog fragment text for the FetchBlock timestamp work. |
| .changes/20260602_cardano_api_consensus_reexports.yml | Update changelog fragment text for additional consensus re-exports. |
| - compatible | ||
| description: | | ||
| Re-export consensus types from Cardano.Api.Consensus for node kernel access: NodeKernel, ChainDB, BlockComponent, RealPoint, OneEraHash, HeaderHash, HasHeader, BlockType, StandardCrypto, CardanoBlock, blockNo. | ||
| Re-export consensus types from Cardano.Api.Consensus for node kernel access: NodeKernel, ChainDB, BlockComponent, RealPoint, OneEraHash, HeaderHash, HasHeader, BlockType, StandardCrypto, CardanoBlock, blockNo, getCurrentLedger, TopLevelConfig, configLedger, configBlock, ledgerState, HasHardForkHistory(..), ConfigSupportsNode, nodeSystemStart, mkInterpreter. |
Comment on lines
+48
to
+59
| throwPastHorizon = | ||
| throwGrpcErrorWithMessage GrpcInternal $ | ||
| "past horizon converting slot " <> tshow (unSlotNo slot) <> " to timestamp" | ||
| headerHash <- | ||
| deserialiseFromRawBytes (proxyToAsType (Proxy @(Hash BlockHeader))) hashBytes | ||
| & either (const throwInvalidHash) pure | ||
| (rawBytes, BlockNo height) <- | ||
| fetchBlock nodeKernelAccess slot headerHash >>= maybe throwNotFound pure | ||
| eraHistory <- readEraHistory | ||
| timestampMs <- | ||
| slotToUTCTime systemStart eraHistory slot | ||
| & either (const throwPastHorizon) (pure . round . (* 1000) . utcTimeToPOSIXSeconds) |
Contributor
Author
There was a problem hiding this comment.
we don't gain any extra info from it, and the showed exception is quite verbose
Comment on lines
+56
to
+59
| eraHistory <- readEraHistory | ||
| timestampMs <- | ||
| slotToUTCTime systemStart eraHistory slot | ||
| & either (const throwPastHorizon) (pure . round . (* 1000) . utcTimeToPOSIXSeconds) |
| - breaking | ||
| description: | | ||
| Implement FetchBlock SyncService method via node kernel access. Fetches blocks from ChainDB with raw CBOR bytes and cardano block header (slot, hash, height). Breaking: `runRpcServer` signature now takes `IORef (Maybe NodeKernelAccess)` for node kernel access. | ||
| Implement FetchBlock SyncService method via node kernel access. Fetches blocks from ChainDB with raw CBOR bytes, cardano block header (slot, hash, height), and timestamp (slot-to-UTC conversion via EraHistory). Breaking: `runRpcServer` signature now takes `IORef (Maybe NodeKernelAccess)` for node kernel access. |
Comment on lines
79
to
83
| , getOpCertCounters | ||
| , interpreterToEpochInfo | ||
| , mkInterpreter | ||
| , unsafeExtendSafeZone | ||
| , txId |
carbolymer
force-pushed
the
mgalazyn/feature/rpc-fetchblock-add-timestamp
branch
from
3ef4994 to
73e1a16
Compare
Jimbo4350
approved these changes
Jul 8, 2026
| import Ouroboros.Consensus.Util.Condense (condense) | ||
|
|
||
| -- | Extract the network system start time from the node's top-level configuration. | ||
| nodeSystemStart :: ConfigSupportsNode blk => TopLevelConfig blk -> SystemStart |
Contributor
There was a problem hiding this comment.
This would be better suited in Cardano.Api.Consensus or some other adjacent module as it's not strictly a re-export.
| "block not found at slot " <> tshow (unSlotNo slot) | ||
| throwPastHorizon = | ||
| throwGrpcErrorWithMessage GrpcInternal $ | ||
| "past horizon converting slot " <> tshow (unSlotNo slot) <> " to timestamp" |
Contributor
There was a problem hiding this comment.
Can you add a hint as to how a user would correct this error in the error message?
| { nkaChainDB :: Consensus.ChainDB IO (Consensus.CardanoBlock Consensus.StandardCrypto) | ||
| { chainDb :: Consensus.ChainDB IO (Consensus.CardanoBlock Consensus.StandardCrypto) | ||
| -- ^ Handle to the consensus chain database | ||
| , systemStart :: SystemStart |
Contributor
There was a problem hiding this comment.
Something like:
- ^ Network system start time, extracted from genesis config.
-- Used together with 'readEraHistory' to convert slots to wall-clock
-- time
Would be useful.
4 tasks
carbolymer
force-pushed
the
mgalazyn/feature/rpc-fetchblock-add-timestamp
branch
from
73e1a16 to
534dce1
Compare
carbolymer
force-pushed
the
mgalazyn/feature/rpc-fetchblock-add-timestamp
branch
from
534dce1 to
15431b7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.
How to trust this PR
Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.
Checklist
.changes/