blocktx wip

Author: carbolymer

.changes/20260710_cardano_api_case_shelley_to_babbage_or_conway_or_dijkstra.yml

@@ -0,0 +1,6 @@
+project: cardano-api
+pr: 1247
+kind:
+  - compatible
+description: |
+  Add `caseShelleyToBabbageOrConwayOrDijkstra` to Cardano.Api.Era: a total variant of `caseShelleyToBabbageOrConwayEraOnwards` which passes the bare `ConwayEraOnwards` witness to the second arm instead of erroring for Dijkstra.

cardano-api/src/Cardano/Api/Era.hs

@@ -73,6 +73,7 @@ module Cardano.Api.Era
   , caseShelleyToMaryOrAlonzoEraOnwards
   , caseShelleyToAlonzoOrBabbageEraOnwards
   , caseShelleyToBabbageOrConwayEraOnwards
+  , caseShelleyToBabbageOrConwayOrDijkstra
   )
 where
 

cardano-api/src/Cardano/Api/Era/Internal/Case.hs

@@ -12,6 +12,7 @@ module Cardano.Api.Era.Internal.Case
   , caseShelleyToMaryOrAlonzoEraOnwards
   , caseShelleyToAlonzoOrBabbageEraOnwards
   , caseShelleyToBabbageOrConwayEraOnwards
+  , caseShelleyToBabbageOrConwayOrDijkstra
   )
 where
 
@@ -131,3 +132,27 @@ caseShelleyToBabbageOrConwayEraOnwards l r = \case
   ShelleyBasedEraBabbage -> l ShelleyToBabbageEraBabbage
   ShelleyBasedEraConway -> r ConwayEraOnwardsConway
   ShelleyBasedEraDijkstra -> error "TODO Dijkstra: caseShelleyToBabbageOrConwayEraOnwards: era not supported"
+
+-- | @caseShelleyToBabbageOrConwayOrDijkstra f g era@ applies @f@ to eras before conway;
+-- and applies @g@ to conway and later eras.
+--
+-- Unlike 'caseShelleyToBabbageOrConwayEraOnwards' this dispatcher is total: the
+-- second arm receives the bare 'ConwayEraOnwards' witness without
+-- 'ConwayEraOnwardsConstraints', whose bundle requires
+-- @TxCert ~ ConwayTxCert@ and therefore cannot be satisfied by dijkstra.
+-- Pattern match on the witness constructors in the second arm to get
+-- concrete-era instance resolution.
+caseShelleyToBabbageOrConwayOrDijkstra
+  :: ()
+  => (ShelleyToBabbageEraConstraints era => ShelleyToBabbageEra era -> a)
+  -> (ConwayEraOnwards era -> a)
+  -> ShelleyBasedEra era
+  -> a
+caseShelleyToBabbageOrConwayOrDijkstra l r = \case
+  ShelleyBasedEraShelley -> l ShelleyToBabbageEraShelley
+  ShelleyBasedEraAllegra -> l ShelleyToBabbageEraAllegra
+  ShelleyBasedEraMary -> l ShelleyToBabbageEraMary
+  ShelleyBasedEraAlonzo -> l ShelleyToBabbageEraAlonzo
+  ShelleyBasedEraBabbage -> l ShelleyToBabbageEraBabbage
+  ShelleyBasedEraConway -> r ConwayEraOnwardsConway
+  ShelleyBasedEraDijkstra -> r ConwayEraOnwardsDijkstra

cardano-rpc/cardano-rpc.cabal

@@ -99,6 +99,7 @@ library
     cardano-crypto,
     cardano-crypto-class,
     cardano-crypto-wrapper,
+    cardano-ledger-alonzo,
     cardano-ledger-api,
     cardano-ledger-binary,
     cardano-ledger-byron,

cardano-rpc/docs/node-kernel-access/01-node-access-types.md

@@ -1,5 +1,15 @@
 # Piece 1: NodeKernelAccess types and cardano-rpc plumbing
 
+## Status: as built
+
+Piece 1 shipped a deliberately thin `NodeKernelAccess`, not the snapshot record described below.
+As built, the module is `Cardano.Rpc.Server.NodeKernelAccess`, and the record itself lives in `Cardano.Rpc.Server.NodeKernelAccess.Type`.
+The module exports `mkNodeKernelAccess`, `fetchBlock` and `grabNodeKernelAccess`; there is no `withNodeKernelAccess`, no `LedgerSnapshot` and no `nkaWithSnapshot` / `nkaSubmitTx`.
+The record has three fields - `chainDb`, `systemStart` and `readEraHistory` - because direct `chainDb` access was enough to serve FetchBlock (pieces 2 and 3), so the snapshot interface was deferred.
+
+Everything from "## Acceptance criteria" onwards describes the originally-planned snapshot design.
+That design is the target that pieces 4-7 grow into as they migrate the query, submit and eval methods off N2C; it is not current code.
+
 ## Problem
 
 cardano-rpc currently threads `LocalNodeConnectInfo` through its environment and `MonadRpc` constraint.
@@ -18,6 +28,8 @@ As a cardano-rpc developer, I want the `NodeKernelAccess` abstraction and enviro
 
 ## Acceptance criteria
 
+These criteria describe the originally-planned snapshot design (see "Status: as built" above), which is the target for pieces 4-7 rather than what piece 1 shipped.
+
 1. **AC1: NodeKernelAccess module** - A new module `Cardano.Rpc.Server.Internal.NodeKernelAccess` exists at `src/Cardano/Rpc/Server/Internal/NodeKernelAccess.hs`, exporting `NodeKernelAccess(..)`, `LedgerSnapshot(..)`, and `withNodeKernelAccess`.
    `NodeKernelAccess` is a record with three fields: `nkaWithSnapshot :: forall a. (LedgerSnapshot -> IO a) -> IO a`, `nkaSubmitTx :: TxInMode -> IO (SubmitResult TxValidationErrorInCardanoMode)`, and `nkaFetchBlock :: SlotNo -> ByteString -> IO (Maybe ByteString)`.
    `LedgerSnapshot` is a newtype wrapping `runQuery :: forall result. QueryInMode result -> IO result`.

cardano-rpc/docs/node-kernel-access/analysis-consensus-protocol.md

@@ -186,3 +186,5 @@ newtype LedgerSnapshot = LedgerSnapshot
 
 `nkaWithSnapshot` acquires a single `ReadOnlyForker` and wraps it.
 All queries within one `nkaWithSnapshot` call share the same forker and therefore the same ledger state.
+
+Note: this snapshot design is forward-looking - it is the target interface for pieces 4-7, not current code (as built, `NodeKernelAccess` is the thinner `chainDb` / `systemStart` / `readEraHistory` record; see `01-node-access-types.md`).

cardano-rpc/docs/node-kernel-access/implementation-plan.md

@@ -85,12 +85,12 @@ The N2C error is wrapped in `Submit.hs` via `tryAny` + `first TraceRpcSubmitN2cC
 
 ## File summary
 
-### New files (2)
+### New files (as built)
 
 | File | Purpose |
 |------|---------|
-| `cardano-api/cardano-rpc/src/Cardano/Rpc/Server/Internal/NodeKernelAccess.hs` | `NodeKernelAccess` record + `withNodeKernelAccess` |
-| `cardano-node/cardano-node/src/Cardano/Node/Rpc/NodeKernelAccess.hs` | `mkNodeKernelAccess` from `NodeKernel` |
+| `cardano-api/cardano-rpc/src/Cardano/Rpc/Server/NodeKernelAccess.hs` | `mkNodeKernelAccess`, `fetchBlock` and `grabNodeKernelAccess`; the `NodeKernelAccess` record itself lives in `Cardano/Rpc/Server/NodeKernelAccess/Type.hs`. No `withNodeKernelAccess` was built. |
+| `cardano-node/cardano-node/src/Cardano/Node/Run.hs` (modified, not new) | `mkNodeKernelAccess` is called inline here; no dedicated cardano-node module was created. |
 
 ### Modified files (12)
 
@@ -114,7 +114,7 @@ The N2C error is wrapped in `Submit.hs` via `tryAny` + `first TraceRpcSubmitN2cC
 | File | Why |
 |------|-----|
 | `cardano-rpc/src/Cardano/Rpc/Server/Config.hs` | `nodeSocketPath` still needed for socket path derivation |
-| `cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Type.hs` | Conversion code untouched |
+| `cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Type.*` | The N2C-to-node-kernel migration does not touch the type conversions (now split across `Type.hs` and the `Type/*.hs` submodules). |
 | `cardano-rpc/src/Cardano/Rpc/Server/Internal/UtxoRpc/Predicate.hs` | Filtering untouched |
 | Testnet test files | gRPC client API unchanged |