Skip to content

Track remaining Dijkstra API and CLI integration #1382

Open

Description

@Jimbo4350

Scope

Track remaining Dijkstra integration across cardano-api and cardano-cli. Peras and Leios implementation are outside this checklist. Distinguish API support, CLI exposure, and dependency integration; a merged upstream fix does not by itself mean the CLI consumes it.

Rechecked against upstream master and GitHub PR status on 2026-10-30:

This refresh is a source/status audit, not a new build or live-node validation run. Completed means present on master unless release availability is explicitly stated.

Merged checklist items rechecked on 2026-11-10. The updates below record merged implementation, not release availability or a new live-node validation run.

Integration checklist

1. Top-level script guards — CIP-112

Sub-transaction build-raw already supports script guards, redeemers, execution units, and required-top-level-guard declarations. Top-level key guards work through --required-signer. Do not count those interfaces as missing. Generalising the API's supported Plutus guard language representation is a separate, non-blocking follow-up in #1386.

2. Account-balance assertions — CIP-159

  • CLI: expose accountBalanceIntervals for top-level transactions and sub-transactions, including exact balances and bounded intervals — cardano-cli#1483.
  • CLI: expose startingAccountBalanceIntervals for top-level transactions — the same PR.

The API setters and ledger-body fields already existed. Direct ADA deposits are also exposed in the builders.

3. Protocol-parameter governance updates

All four are Dijkstra parameters. The API genesis defaults document the two reference-input prices as taking effect at a later intra-era hard fork within Dijkstra. Expose the options and document that activation timing; adding governance options does not activate pricing. These are distinct from reference-script fee parameters. The existing stake-pool --pool-margin option sets an individual pool's margin, not the protocol's minimum pool margin.

4. Balanced nested transactions — CIP-118

  • Before merging cardano-api automatic balancing support in Complete Dijkstra nested transaction auto-balancing #1402, wait for cardano-ledger#6265 to be fixed and released, then integrate the released dependency and verify nested script evaluation. evalTxExUnitsWithLogs currently omits sub-transaction information needed by top-level Plutus scripts, including guards. An upstream merge alone does not satisfy this requirement.
  • Integrate the nested minimum-fee correction from cardano-ledger#6190, merged upstream on 2026-10-22, into the dependencies used for API/CLI builds.
  • API: establish and complete the end-to-end balancing path for a top-level transaction containing fixed, signed sub-transactions. Resolve inputs and relevant ledger state across the whole batch, account for nested script costs, and preserve signed sub-transaction bodies while adjusting top-level fee/change.
  • API: add regression coverage for sub-transaction surpluses and deficits, insufficient aggregate funds, native assets, nested fees, preservation of signed bodies, and legacy-Plutus conservation constraints.
  • CLI: accept --signed-sub-tx-file in online transaction build once the API path is verified.
  • API/CLI: establish the caller-supplied information needed for offline batch balancing, then expose sub-transactions in transaction build-estimate.
  • Reject missing collateral when balancing transactions that require it, including Plutus scripts in top-level transactions and Dijkstra sub-transactions; preserve valid cases with collateral and transactions that need none — Reject missing collateral when balancing transactions with Plutus scripts #1419. This is a pre-existing balancing bug tracked separately from Complete Dijkstra nested transaction auto-balancing #1402.

Balance is a batch-level condition. Sub-transactions may intentionally contribute surpluses or deficits; do not require each one to balance independently. The API already delegates balance calculation to the ledger's evalBalanceTxBody, and Dijkstra aggregates top-level and sub-transaction values. The remaining work is integration and validation of the full builder, not inventing an independent-balance requirement. Legacy-Plutus mode adds a separate top-level conservation check. Balanced totals alone do not establish full ledger validity.

CLI master currently accepts signed sub-transactions only in transaction build-raw. That command embeds them but does not verify their economic balance against the UTxO.

5. Independent sub-transaction witnessing

  • CLI: add sub-transaction witness for producing a signature separately — cardano-cli#1485, merged 2026-10-28.
  • CLI: add sub-transaction assemble for combining separately collected witnesses — the same PR.

The API already provides makeSubTxKeyWitness and signSubTx with separately supplied witnesses.

6. Dijkstra transaction inspection

  • Render direct deposits — cardano-cli#1470.
  • Render top-level account-balance assertions and embedded sub-transaction IDs/account-balance intervals — cardano-cli#1483.
  • Render the Guarding redeemer purpose, replacing the previous TODO Dijkstra — cardano-cli#1477.
  • Render complete embedded sub-transactions beyond their IDs and account-balance intervals — cardano-cli#1492, merged 2026-11-05.
  • Render guard credentials and required top-level guards — cardano-cli#1494, merged 2026-11-06.
  • Accept standalone signed and unsigned sub-transaction envelopes for inspection — cardano-cli#1496.

The general debug certificate view command also merged in cardano-cli#1488; it does not complete the remaining transaction/sub-transaction inspection work.

7. Ledger dependency fixes

  • Integrate required-top-level-guard Plutus-data decoding and compatible dependencies; cardano-cli#1473 remains open, using the upstream fix in cardano-ledger#6189.
  • Pick up cardano-ledger#6109 and verify that extracting Dijkstra auxiliary scripts preserves Plutus V4 scripts.

Both upstream fixes are merged. Rechecked on 2026-11-20: CHaP has released cardano-ledger-dijkstra 0.5.0.0, and current master CI for both cardano-api and cardano-cli already builds with it. However, the released source still uses the old required-top-level-guard data decoder, declares eraMaxLanguage = PlutusV3, and uses getConwayMinFeeTx. Version 0.5.0.0 does not contain the fixes in ledger #6189, #6109 or #6190. Keep dependency integration and regression verification open. Nested fee integration and the separate open evaluation issue, ledger #6265, are tracked in item 4.

8. Experimental API decoding

  • Implement Dijkstra JSON native-script reading in the experimental AnyScript reader — cardano-api#1404, merged 2026-11-03.
  • Add experimental Dijkstra TxOut JSON decoding — cardano-api#1405, merged 2026-11-06.

Source: AnyScript.hs, BodyContent.hs.

Other completed work and separate tracking

  • Dijkstra script-validity flag removal: cardano-cli#1474.
  • Basic sub-transaction construction, signing, embedding, guard witnesses, and required-top-level-guard declarations already exist.
  • Direct ADA deposit construction and the Plutus V4 cost-model-file route already exist.
  • UTxO RPC Dijkstra wire-format work remains separately tracked in gRPC: Dijkstra era support gaps in UTxO RPC #1263.
  • Peras and Leios implementation remain outside this checklist; the later activation of reference-input pricing does not remove its CLI governance interface from Dijkstra work.

Related Leios committee and BLS tooling

These remain outside the Dijkstra integration checklist above, but are linked here so the outstanding API/CLI work is visible:

  • Leios #1093 — Complete CLI tools to bootstrap keys tracks committee queries, pool BLS state and the key-registration/rotation workflow.
  • cardano-api #1383 adds queryStakePoolState and queryLeiosCommittee.
  • cardano-cli #1478 adds query leios-committee and makes query pool-state use the ledger's actual pool state. This addresses CLI #1493, where bksRegisteredIn incorrectly reports the current epoch instead of the BLS key's registration epoch. As of 2026-11-20, both query PRs remain open, require review and have merge conflicts.
  • cardano-cli #1490 adds BLS-registration certificate creation using saved pool-state output or a live node query. It is approved and stacked on #1478; it cannot merge before that dependency. The original-certificate offline workflow already merged in #1489.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions