; Conflicts: ; cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Query.hs ; cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Submit.hs ; cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Type.hs
All Dijkstra-era placeholder `error` messages and `TODO` comments in `cardano-api/src/` now share the greppable token `TODO Dijkstra:`, so a single `grep -r 'TODO Dijkstra'` locates every site that needs attention when Dijkstra-era support lands. No behaviour change; this is a pure message/comment unification across 30 sites in 16 files. The runtime invariant assertion at `Tx/Internal/Body.hs:2858` (`toScriptIndexDijkstra: unexpected DijkstraGuarding`) is intentionally untouched — it is an impossible-case assertion, not a pending-implementation stub. The PlutusV4 placeholder at `Plutus/Internal/Script.hs:1302` (`toShelleyScript: PlutusV4 not implemented yet.`) is tracked separately as it blocks on ledger exposing a PlutusV4 constructor.
Haddock resolves re-exports to the local re-export page (e.g. a reference to cardano-ledger-byron's Address via Cardano.Api.Byron becomes href="Cardano-Api-Byron.html#t:Address", not an external link). The Haddock-emitted "Source" link, however, points to the cabal store path for the original defining package. Phase 2b uses that as ground truth to rewrite local re-export hrefs to the upstream doc site. Also extend dead-link handling in Phase 3: before annotating a 404 as unclickable, probe for the page under doc-site subdirectories (api/, protocols/, framework/ — ouroboros-network's layout) and under parent modules (Cardano-Ledger-Api-State-Query-CommitteeMembersState.html -> Cardano-Ledger-Api-State-Query.html#t:CommitteeMembersState). If the parent resolves, rewrite to it with a reconstructed #t: fragment so the browser still scrolls to the definition. On a full cardano-api build this rewrites 205 of 208 re-exported types (up from 0) and rescues 182 of 233 previously-annotated dead links.
- Remove UpdateProposal CBOR roundtrip test since EraBasedProtocolParametersUpdate has stub ToCBOR/FromCBOR instances - Set cost models to SNothing in genAlonzoOnwardsPParams since cost models don't survive CBOR roundtrip (matching the old generator behaviour) - Fix unused import in Shared.hs
All Dijkstra-era placeholder `error` messages and `TODO` comments in `cardano-api/src/` now share the greppable token `TODO Dijkstra:`, so a single `grep -r 'TODO Dijkstra'` locates every site that needs attention when Dijkstra-era support lands. No behaviour change; this is a pure message/comment unification across 30 sites in 16 files. The runtime invariant assertion at `Tx/Internal/Body.hs:2858` (`toScriptIndexDijkstra: unexpected DijkstraGuarding`) is intentionally untouched — it is an impossible-case assertion, not a pending-implementation stub. The PlutusV4 placeholder at `Plutus/Internal/Script.hs:1302` (`toShelleyScript: PlutusV4 not implemented yet.`) is tracked separately as it blocks on ledger exposing a PlutusV4 constructor.
Add per-era FromJSON instances for the experimental TxOut type, mirroring the ToJSON structure. Pre-Alonzo eras parse address and value only; Alonzo adds datum hash support; Babbage+ adds inline datum (parsed from inlineDatumRaw with hash validation) and reference script support. Supplemental datums are deliberately unsupported as the ledger TxOut does not carry them.
Add HasCallStack constraints to functions containing error calls
Cross-package hrefs to non-CHaP packages (base, bytestring, time, the
transformers stack, etc.) were being rewritten to Hackage URLs. In
practice:
- Readers of cardano-api docs rarely click into bootlib internals.
- Haddock's per-module URL structure (including src/ source views
and '-<version>-inplace' suffixes from local rebuilds) doesn't
line up cleanly with Hackage's rendering, so most of these URLs
fail validation and become dead-link spans anyway.
The Hackage rewrites were therefore mostly producing 404s without
adding reader value. Treat non-CHaP just like unmapped CHaP: emit an
unclickable <span> with a tooltip, no outbound link. Track the count
in a separate NON_CHAP bucket so it's visible in the summary but does
not contribute to strict-mode failure (it's a policy choice, not a
gap).
Same shape of bug as 3c557b542 (Phase 1 symlink loops): an && chain runs a capturing regex followed by a non-capturing one, and the second match clears BASH_REMATCH[1] before the capture is consumed. Under set -u the access errors. Reorder so the non-capturing exclusion is evaluated first.
Flip the exit-code default so the docs deploy is no longer blocked by
upstream drift. The script still collects every dead link across all
phases and reports them at the end (no early-exit); only the final
exit code changes:
- Default: exit 0 after printing the full diagnostic. Set
FIX_HADDOCK_LINKS_STRICT=1 to fail the build instead.
- github-page.yml runs post-push and never blocked merges, but
exit 1 was skipping the Deploy step — default 0 keeps the site
deploying while the diagnostic is still visible.
Make the per-URL diagnostic tell the reader what to fix:
- Upstream Haskell module name (derived from the URL path by
reversing Haddock's dot-to-dash encoding).
- Symbols being linked (the <a> tag anchor text, collected before
the <a>→<span> replacement runs).
- Our own docs pages that reference the URL (maps 1:1 to our .hs
source files).
In GitHub Actions, each dead link also emits a ::warning:: workflow
command so the failure surfaces as an annotation in the job summary
UI, not just in the log body.
The previous 8 phases narrated every internal step (filesystem scan,
CHaP fetch, HTML grep, probing, rewriting, validation, annotation, CSS
injection). Most were set-up substeps under three conceptual stages:
Phase 1: Prepare — filesystem scan, inplace symlinks, CHaP
fetch, single HTML grep that feeds both
target discovery and versioned-hash
symlinking.
Phase 2: Resolve +
rewrite — probe each discovered package, build sed
args (rewrites and unmapped-CHaP
unclickables), apply in one sed pass.
Phase 3: Validate +
annotate — HEAD-check all rewritten URLs, annotate dead
ones, inject CSS.
Also drops a redundant grep (the Phase 0(b)/Phase 3 HTML scans collapse
into one) and a redundant empty-dead-count check. Script is now 261
lines (from 328).
Config simplifications: - Drop EXACT_OVERRIDES table (14 entries), SITE_PATH_SUFFIX table (2 entries), and the 4 named base-URL constants. - Replace with one IOG_DOC_BASES list (6 entries) of known IOG doc-site roots, including path prefixes for non-flat sites. - resolve_url now tries name-suffix candidates first, then falls back to probing each IOG_DOC_BASES entry. Verified against all 30 packages cardano-api currently links to: all resolve correctly with no per-package bookkeeping. - Adding a new IOG doc site is now one line; new packages on existing sites need no edit at all. Structural simplifications: - Merge Phase 5 (link rewrites) and Phase 5b (unmapped-CHaP unclickables) into a single sed pass — their rewrites are on disjoint package patterns. - Consolidate three redundant trap calls into one upfront trap. - Fix a latent bug: dead-link CSS was only injected when there were dead URLs, so a run with only unmapped-CHaP spans would leave them unstyled. CSS now runs whenever any spans were produced. - Replace REWRITTEN_HACKAGE / REWRITTEN_DOCSITE arrays (used only for counts) with counters. - Factor the <span class='dead-link'> sed expression into a small add_unclickable_sed helper shared by Phase 5 and Phase 7.
Add HasCallStack to makeShelleyTransactionBody, createAndValidateTransactionBody, fromLegacyTxOut, and toShelleyUTxO, which call functions like mkCommonTxBody, toShelleyTxOutAny, toShelleyTxOut, and createTransactionBody that already carry the constraint.
Add HasCallStack to calcMinFeeRecursive, estimateOrCalculateBalancedTxBody, and constructBalancedTx, which call balanceTxOuts, makeTransactionBodyAutoBalance, estimateBalancedTxBody, and calculateMinimumUTxO that already carry the constraint.