Merge branch 'feature/node-11.0'

Author: KtorZ

.github/workflows/continuous-integration.yaml

@@ -227,7 +227,7 @@ jobs:
         os: [ linux ]
         arch: [ x86_64 ]
         network: [ preview ]
-        cardano-node: [ 10.5.1 ]
+        cardano-node: [ 11.0.1 ]
 
     runs-on: ${{ matrix.os == 'linux' && 'ubuntu-22.04' }}
     steps:
@@ -404,8 +404,8 @@ jobs:
         os: [ linux ]
         target: [ cardano-node-ogmios ]
         network: [ mainnet, preprod, preview ]
-        cardano-node: [ 10.5.1 ]
-        cardano-node-latest: [  10.5.1 ]
+        cardano-node: [ 11.0.1 ]
+        cardano-node-latest: [  11.0.1 ]
         arch: [ x86_64 ]
     steps:
     - name: 📥 Checkout repository

CHANGELOG.md

@@ -7,6 +7,23 @@ pre: "<b>6. </b>"
 math: true
 ---
 
+### [7.0.0] - UNRELEASED
+
+#### Added
+
+- Preliminary support for the DijkstraEra and PlutusV4
+
+#### Changed
+
+- Upgraded dependencies and compatibility to `cardano-node==11.0.1`.
+
+- Fixed Ogmios not returning a success error code when interrupted by the user (e.g. CTRL+C / SIGINT).
+
+- **⚠️ BREAKING-CHANGE ⚠️**: on `ProtocolParameters` and `ProposedProtocolParameters`, the field `maxReferenceScriptsSize` has been renamed to `maxReferenceScriptsSizePerTransaction` to disambiguate it from `maxReferenceScriptsSizePerBlock`.
+
+---
+---
+
 ### [6.14.0] - 2025-10-16
 
 #### Added
@@ -28,6 +45,9 @@ math: true
 
 - `queryLedgerState/proposedProtocolParameters` is no longer available in the underlying node and was already returning dummy data for a few versions. It's been removed.
 
+---
+---
+
 ### [6.13.0] - 2025-06-13
 
 #### Added
@@ -46,6 +66,9 @@ math: true
 
 N/A
 
+---
+---
+
 ### [6.12.0] - 2025-05-22
 
 #### Added
@@ -60,18 +83,27 @@ N/A
 
 - The `queryLedgerState/delegateRepresentatives` no longer discards registered DReps that have unregistered but whose stake is still available. This may happen when a DRep is already unregistered, but his stake distribution is still available because still needed to ratify votes on the next epoch boundary. As a consequence, some of the fields for the registered drep summaries are now optional instead of required."
 
+---
+---
+
 ### [6.11.2] - 2025-02-01
 
 #### Changed
 
 - Fix (sometimes) missing governance proposals returned from the `queryLedgerState/governanceProposals` (likely) due to unfinished incremental calculations on the ledger state. The proposals are now pulled from a different location in the ledger state which ensures they are complete.
 
+---
+---
+
 ### [6.11.1] - 2025-01-31
 
 #### Changed
 
 - Fix missing DReps with no stake not showing up through `queryLedgerState/delegateRepresentatives`.
 
+---
+---
+
 ### [6.11.0] - 2025-01-12
 
 #### Added
@@ -88,6 +120,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.10.0] - 2024-12-14
 
 #### Added
@@ -104,6 +139,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.9.0] - 2024-11-08
 
 #### Added
@@ -121,6 +159,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.8.0] - 2024-09-21
 
 #### Added
@@ -138,6 +179,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.7.0] - 2024-09-13
 
 #### Added
@@ -152,6 +196,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.6.2] - 2024-09-10
 
 #### Added
@@ -166,6 +213,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.6.1] - 2024-09-01
 
 #### Added
@@ -180,6 +230,9 @@ N/A
 
 - N/A
 
+---
+---
+
 ### [6.6.0] - 2024-08-15
 
 #### Added
@@ -218,7 +271,7 @@ N/A
 - New ledger-state query: `queryLedgerState/treasuryAndReserves` to retrieve the current Ada values of the treasury and reserves.
 
 - New protocol parameters in Conway:
-  - `maximumReferenceScriptsSize` which indicates the maximum total number of bytes of scripts referenced by a transaction.
+  - `maxReferenceScriptsSize` which indicates the maximum total number of bytes of scripts referenced by a transaction.
   - `minFeeReferenceScripts` with three sub fields: `range`, `base` and `multiplier` that now intervenes in the minimum fee calculation. Note that, starting in the Conway era, the min fee calculation is given by the following formula:
 
 $$

CONTRIBUTING.md

@@ -18,6 +18,27 @@ Do not hesitate to upvote discussions or comments to show your interest!
 
  Pull requests are welcome, but we do recommend to open an issue to bring any idea to discussion first!
 
+##### Adding Support For A New Era
+
+Ogmios generally supports the current Cardano era and the next era when one is available, so era transitions usually require a coordinated bump across the server, tests, generated schemas, and clients. After updating the Cardano dependencies and the hard-fork block type, audit these areas:
+
+- Type-level era plumbing: update `Ogmios.Prelude`, `Ogmios.Data.EraTranslation`, era indexes, `MostRecentEra` assumptions, and helper constraints such as `ShelleyBasedEra` and `AlonzoBasedEra`.
+- Node-to-client protocol support: check `server/modules/ouroboros-network-ogmios/src/Cardano/Network/Protocol/NodeToClient.hs` for supported versions, codec configuration, raw transaction id conversion, and any version gates that decide when the new era may flow over the wire.
+- Runtime protocols: inspect `server/src/Ogmios/App/Protocol/ChainSync.hs`, `StateQuery.hs`, `TxSubmission.hs`, and `TxMonitor.hs` for era-specific branches, `QueryIfCurrent*` constructors, transaction evaluation paths, and mempool lookup order.
+- JSON and ledger adapters: add or update the era-specific JSON module, `Ogmios.Data.Json`, `Ogmios.Data.Json.Query`, predicate failure encoders, script failure encoders, `Ogmios.Data.Ledger`, and `Ogmios.Data.Protocol.TxSubmission`.
+- Configuration, health, and genesis behavior: update era names in health reporting and configuration parsing. Do not add genesis-query support by reflex; some eras intentionally reuse the previous era's genesis configuration or have no genesis configuration at all.
+- Tests and generators: extend `server/test/unit/Test/Generators.hs`, `Test/Generators/Orphans.hs`, protocol specs, JSON specs, and golden vectors so the new era is generated and round-tripped. Include a direct node-to-client roundtrip for a block in the new era, because this catches consensus codec gaps before Ogmios JSON is involved.
+- Schemas and clients: regenerate and review JSON schemas and TypeScript clients, especially public era unions, block shapes, query result types, and error variants.
+
+Useful searches when reviewing an era bump:
+
+```sh
+rg -n "Conway|MostRecentEra|EraIndex|NodeToClientV_|ShelleyBasedEra|AlonzoBasedEra|QueryIfCurrent|GenTx|Block[A-Z]" server/src server/test/unit server/modules/ouroboros-network-ogmios/src clients
+rg -n "conway|ConwayEra|ShelleyBasedEraConway|AlonzoBasedEraConway|QueryIfCurrentConway" server/src server/test/unit server/modules/ouroboros-network-ogmios/src clients
+```
+
+Not every reference to the previous era is wrong. Older-era codecs, backwards-compatible parsers, historical block encoders, and genesis-query support often need to remain as-is. Treat each remaining previous-era reference as either a deliberate historical branch or a missing new-era branch, and document the decision in the pull request when it is not obvious.
+
 #### 3. Donation
 
 Want to give some financial support? Have a look at the [sponsors page](https://github.com/sponsors/KtorZ/) for more details.

Dockerfile

@@ -2,13 +2,13 @@
 #  License, v. 2.0. If a copy of the MPL was not distributed with this
 #  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-ARG CARDANO_NODE_IMAGE=ghcr.io/intersectmbo/cardano-node:10.1.4
+ARG CARDANO_NODE_IMAGE=ghcr.io/intersectmbo/cardano-node:11.0.1
 
 #                                                                              #
 # --------------------------- BUILD (ogmios) --------------------------------- #
 #                                                                              #
 
-FROM --platform=${TARGETPLATFORM:-linux/amd64} busybox:1.35 as ogmios
+FROM busybox:1.35 AS ogmios
 
 LABEL name=ogmios
 LABEL description="A JSON WebSocket bridge for cardano-node."
@@ -28,10 +28,10 @@ ENTRYPOINT ["/bin/ogmios"]
 # --------------------- RUN (cardano-node & ogmios) -------------------------- #
 #                                                                              #
 
-FROM ${CARDANO_NODE_IMAGE} as cardano-node-ogmios
+FROM ${CARDANO_NODE_IMAGE} AS cardano-node-ogmios
 
 ARG NETWORK=mainnet
-ENV TINI_VERSION v0.19.0
+ENV TINI_VERSION=v0.19.0
 
 LABEL name=cardano-node-ogmios
 LABEL description="A Cardano node, side-by-side with its JSON WebSocket bridge."

README.md

@@ -15,7 +15,8 @@
 
 | Ogmios        | Cardano-node (mainnet, preview, preprod) |
 | ---           | ---                                      |
-| **`v6.14.*`** | **`10.5.1`**                             |
+| **`v6.15.*`** | **`11.0.1`**                             |
+| `v6.14.*`     | `10.5.1`                                 |
 | `v6.13.*`     | `10.1.2`, `10.1.3`, `10.1.4`             |
 | `v6.12.*`     | `10.1.2`, `10.1.3`, `10.1.4`             |
 | `v6.11.*`     | `10.1.2`, `10.1.3`, `10.1.4`             |

clients/TypeScript/README.md

@@ -12,66 +12,9 @@ yarn install && \
 yarn build
 ```
 #### Run Tests
-```console
-yarn testnet:up
-```
-In another terminal
-```console
-yarn test
-```
-
-### Start Cardano Node and Ogmios Server
-#### mainnet
-```console
-yarn mainnet:up
-```
-#### testnet
-```console
-yarn testnet:up
-```
-### Stop Cardano Node and Ogmios Server
-#### mainnet
-```console
-yarn mainnet:down
-```
-#### testnet
-```console
-yarn testnet:down
-```
-
-### Start the REPL
-#### mainnet
-```console
-yarn repl:start
-```
-#### testnet
-```console
-yarn repl:start --port 1337
-```
-### Lint
-```console
-yarn lint
-```
-### Cleanup
-```
-yarn cleanup
-```
-
-## Distribute
 
-### Pack
-```console
-./scripts/pack.sh
-```
-### Publish to npm.org
-```console
-./scripts/publish.sh
-```
+Have a cardano node running on PreProd, and then:
 
-### Pkg REPL
 ```console
-yarn repl:pkg
+yarn test
 ```
-
-
-

clients/TypeScript/package.json

@@ -20,13 +20,9 @@
     "cleanup": "yarn workspaces run cleanup &&  shx rm -rf docs/theme && shx rm -rf node_modules",
     "generate-schema-types": "yarn workspace @cardano-ogmios/schema run generate-schema-types",
     "lint": "yarn workspaces run lint",
-    "mainnet:up": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -p ogmios-mainnet up --build",
-    "mainnet:down": "docker-compose -p ogmios-mainnet down",
     "repl:pkg": "yarn workspace @cardano-ogmios/repl run pkg",
     "repl:start": "yarn workspace @cardano-ogmios/repl run start",
     "test": "yarn workspaces run test",
-    "testnet:up": "DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 OGMIOS_PORT=1337 NETWORK=testnet docker-compose -p ogmios-testnet up",
-    "testnet:down": "docker-compose -p ogmios-testnet down",
     "tags": "ctags $(find packages -type f -name '*.ts' ! -path 'dist/*' ! -name '*.test.ts' ! -name '*.d.ts' ! -path 'node_modules/*')",
     "docs": "tar -C docs -xf docs/ogmios-typedoc-theme.tar.gz && typedoc --packages ."
   },

clients/TypeScript/packages/client/src/LedgerStateQuery/Client.ts

@@ -26,6 +26,7 @@ import {
   GenesisAlonzo,
   GenesisByron,
   GenesisConway,
+  GenesisDijkstra,
   GenesisShelley,
   GovernanceProposalReference,
   Origin,
@@ -56,6 +57,7 @@ export interface LedgerStateQueryClient {
   genesisConfiguration(era: 'shelley'): Promise<GenesisShelley>
   genesisConfiguration(era: 'alonzo'): Promise<GenesisAlonzo>
   genesisConfiguration(era: 'conway'): Promise<GenesisConway>
+  genesisConfiguration(era: 'dijkstra'): Promise<GenesisDijkstra>
   ledgerTip(): ReturnType<typeof ledgerTip>
   liveStakeDistribution(): ReturnType<typeof liveStakeDistribution>
   networkBlockHeight(): ReturnType<typeof networkBlockHeight>
@@ -147,6 +149,8 @@ export async function createLedgerStateQueryClient (
           return genesisConfiguration(context, era)
         case 'conway':
           return genesisConfiguration(context, era)
+        case 'dijkstra':
+          return genesisConfiguration(context, era)
         default: {
           // NOTE: This raises "Type 'string' is not assignable to type 'never'."
           // whenever a branch of 'EraWithGenesis' isn't covered in the above

clients/TypeScript/packages/client/src/LedgerStateQuery/query/genesisConfiguration.ts

@@ -5,6 +5,7 @@ import {
   GenesisAlonzo,
   GenesisByron,
   GenesisConway,
+  GenesisDijkstra,
   GenesisShelley,
   EraWithGenesis
 } from '@cardano-ogmios/schema'
@@ -21,11 +22,12 @@ export function genesisConfiguration(context: InteractionContext, era: 'byron'):
 export function genesisConfiguration(context: InteractionContext, era: 'shelley'): Promise<GenesisShelley>
 export function genesisConfiguration(context: InteractionContext, era: 'alonzo'): Promise<GenesisAlonzo>
 export function genesisConfiguration(context: InteractionContext, era: 'conway'): Promise<GenesisConway>
+export function genesisConfiguration(context: InteractionContext, era: 'dijkstra'): Promise<GenesisDijkstra>
 export function genesisConfiguration (
   context: InteractionContext,
   era: EraWithGenesis
-): Promise<GenesisByron | GenesisShelley | GenesisAlonzo | GenesisConway> {
-  return Method<Request, Response, GenesisByron | GenesisShelley | GenesisAlonzo | GenesisConway>(
+): Promise<GenesisByron | GenesisShelley | GenesisAlonzo | GenesisConway | GenesisDijkstra> {
+  return Method<Request, Response, GenesisByron | GenesisShelley | GenesisAlonzo | GenesisConway | GenesisDijkstra>(
     {
       method: 'queryNetwork/genesisConfiguration',
       params: { era }
@@ -40,6 +42,8 @@ export function genesisConfiguration (
           resolve(response.result as GenesisAlonzo)
         } else if (era === 'conway' && isQueryNetworkGenesisConfigurationConway(response)) {
           resolve(response.result as GenesisConway)
+        } else if (era === 'dijkstra' && isQueryNetworkGenesisConfigurationDijkstra(response)) {
+          resolve(response.result as GenesisDijkstra)
         } else {
           reject(response)
         }
@@ -75,3 +79,10 @@ export function isQueryNetworkGenesisConfigurationAlonzo (response: any): respon
 export function isQueryNetworkGenesisConfigurationConway (response: any): response is GenesisConway {
   return ((response as Response)?.result as GenesisConway)?.era === 'conway'
 }
+
+/**
+ * @internal
+ */
+export function isQueryNetworkGenesisConfigurationDijkstra (response: any): response is GenesisDijkstra {
+  return ((response as Response)?.result as GenesisDijkstra)?.era === 'dijkstra'
+}