Check CDDLs in CI

Author: jasagredo

.github/workflows/ci.yml

@@ -138,6 +138,17 @@ jobs:
     - name: Build projects [build]
       run: cabal build all -j
 
+    - name: Clone Blueprints
+      uses: actions/checkout@v4
+      with:
+        repo: 'cardano-scaling/cardano-blueprint'
+        path: 'blueprints'
+
+    - name: Check CDDLs up-to-date with Blueprints
+      continue-on-error: true
+      run: |
+        ./scripts/ci/diff-cddls.sh
+
     - name: Install cddl tools
       run: |
         gem install cddlc

ouroboros-consensus-cardano/cddl/base.cddl

@@ -29,7 +29,6 @@ slotno = word64
 stake = rational
 
 withOrigin<v> = [] / [v]
-withOriginTH<v> = [0] / [1, v]
 
 ;; Collections
 either<x, y> = [0, x] / [1, y]

ouroboros-consensus-cardano/cddl/node-to-node/blockfetch/block.cddl

@@ -1,3 +1,17 @@
 serialisedCardanoBlock = #6.24(bytes .cbor cardanoBlock)
 
-;# import cardanoBlock from block
+cardanoBlock = byron.block
+             / [2, shelley.block]
+             / [3, allegra.block]
+             / [4, mary.block]
+             / [5, alonzo.block]
+             / [6, babbage.block]
+             / [7, conway.block]
+
+;# import byron as byron
+;# import shelley as shelley
+;# import allegra as allegra
+;# import mary as mary
+;# import alonzo as alonzo
+;# import babbage as babbage
+;# import conway as conway

ouroboros-consensus-cardano/cddl/node-to-node/blockfetch/point.cddl

@@ -1,17 +1,17 @@
 header
- = ns7<byronHeader,
-       serialisedShelleyHeader<shelley.header>,
-       serialisedShelleyHeader<allegra.header>,
-       serialisedShelleyHeader<mary.header>,
-       serialisedShelleyHeader<alonzo.header>,
-       serialisedShelleyHeader<babbage.header>,
-       serialisedShelleyHeader<conway.header>>
+ = base.ns7<byronHeader,
+            serialisedShelleyHeader<shelley.header>,
+            serialisedShelleyHeader<allegra.header>,
+            serialisedShelleyHeader<mary.header>,
+            serialisedShelleyHeader<alonzo.header>,
+            serialisedShelleyHeader<babbage.header>,
+            serialisedShelleyHeader<conway.header>>
 
 byronHeader = [byronRegularIdx, #6.24(bytes .cbor byron.blockhead)]
             / [byronBoundaryIdx, #6.24(bytes .cbor byron.ebbhead)]
 
-byronBoundaryIdx = [0, word32]
-byronRegularIdx = [1, word32]
+byronBoundaryIdx = [0, base.word32]
+byronRegularIdx = [1, base.word32]
 
 serialisedShelleyHeader<era> = #6.24(bytes .cbor era)
 
@@ -22,4 +22,4 @@ serialisedShelleyHeader<era> = #6.24(bytes .cbor era)
 ;# include alonzo as alonzo
 ;# include babbage as babbage
 ;# include conway as conway
-;# import base
+;# import base as base

ouroboros-consensus-cardano/cddl/node-to-node/chainsync/header.cddl

@@ -1,11 +1,11 @@
 tx =
-  ns7<byron.tx,
-      serialisedShelleyTx<shelley.transaction>,
-      serialisedShelleyTx<allegra.transaction>,
-      serialisedShelleyTx<mary.transaction>,
-      serialisedShelleyTx<alonzo.transaction>,
-      serialisedShelleyTx<babbage.transaction>,
-      serialisedShelleyTx<conway.transaction>>
+  base.ns7<byron.tx,
+           serialisedShelleyTx<shelley.transaction>,
+           serialisedShelleyTx<allegra.transaction>,
+           serialisedShelleyTx<mary.transaction>,
+           serialisedShelleyTx<alonzo.transaction>,
+           serialisedShelleyTx<babbage.transaction>,
+           serialisedShelleyTx<conway.transaction>>
 
 serialisedShelleyTx<era> = #6.24(bytes .cbor era)
 
@@ -16,4 +16,4 @@ serialisedShelleyTx<era> = #6.24(bytes .cbor era)
 ;# include alonzo as alonzo
 ;# include babbage as babbage
 ;# include conway as conway
-;# import base
+;# import base as base

ouroboros-consensus-cardano/cddl/node-to-node/chainsync/point.cddl

@@ -1,11 +1,11 @@
 txId =
-  ns7<byronTxId,
-      shelley.transaction_id,
-      allegra.transaction_id,
-      mary.transaction_id,
-      alonzo.transaction_id,
-      conway.transaction_id,
-      babbage.transaction_id>
+  base.ns7<byronTxId,
+           shelley.transaction_id,
+           allegra.transaction_id,
+           mary.transaction_id,
+           alonzo.transaction_id,
+           conway.transaction_id,
+           babbage.transaction_id>
 
 byronTxId = [0, byron.txid]
           / [1, byron.certificateid]
@@ -19,4 +19,4 @@ byronTxId = [0, byron.txid]
 ;# include alonzo as alonzo
 ;# include babbage as babbage
 ;# include conway as conway
-;# import base
+;# import base as base

ouroboros-consensus-cardano/cddl/node-to-node/chainsync/tip.cddl

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+check-diff() {
+    if [ ! diff "ouroboros-consensus-cardano/cddl/node-to-node/$1" "blueprints/src/network/node-to-node/$1" ];
+    then
+        echo "::warning ouroboros-consensus-cardano/cddl/node-to-node/$1 differs from blueprints/src/network/node-to-node/$1"
+    else
+        echo "$1 OK"
+    fi
+}
+
+check-diff "blockfetch/block.cddl"
+check-diff "chainsync/header.cddl"
+check-diff "txsubmission2/txId.cddl"
+check-diff "txsubmission2/tx.cddl"