Add NodeToNode CDDLs

Author: jasagredo

.github/workflows/ci.yml

@@ -55,6 +55,17 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Clone Blueprints
+      uses: actions/checkout@v4
+      with:
+        repository: '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 base libraries
       uses: input-output-hk/actions/base@latest
       with:

ouroboros-consensus-cardano/cddl/base.cddl

@@ -0,0 +1,52 @@
+telescope7<byron, shelley, allegra, mary, alonzo, babbage, conway>
+  = [pastEra, pastEra, pastEra, pastEra, pastEra, pastEra, currentEra<conway>] /
+    [pastEra, pastEra, pastEra, pastEra, pastEra, currentEra<babbage>] /
+    [pastEra, pastEra, pastEra, pastEra, currentEra<alonzo>] /
+    [pastEra, pastEra, pastEra, currentEra<mary>] /
+    [pastEra, pastEra, currentEra<allegra>] /
+    [pastEra, currentEra<shelley>] /
+    [currentEra<byron>]
+
+ns7<byron, shelley, allegra, mary, alonzo, babbage, conway>
+  = [6, conway] /
+    [5, babbage] /
+    [4, alonzo] /
+    [3, mary] /
+    [2, allegra] /
+    [1, shelley] /
+    [0, byron]
+
+;; Blockchain types
+pastEra = [bound, bound]
+currentEra<st> = [bound, st]
+bound = [relativeTime, slotno, epochno]
+eraIdx = word8
+individualPoolStake = [stake, hash]
+nonce = [0] / [1, hash]
+point = [] / [ slotno, hash ]
+poolDistr = map<keyhash, individualPoolStake>
+slotno = word64
+stake = rational
+
+withOrigin<v> = [] / [v]
+
+;; Collections
+either<x, y> = [0, x] / [1, y]
+map<x, y> = { * x => y }
+maybe<x> = [] / [x]
+seq<x> = [*23 x] / [24* x] ; encoded with indefinite-length encoding
+set<x> = #6.258([* x])
+
+;; Types from other packages
+blockno = word64
+epochno = word64
+coin = word64
+rational = [int, int]
+keyhash = bstr .size 28
+hash = bstr .size 32
+relativeTime = int
+
+;; Base word types
+word8  = uint .size 1
+word32 = uint .size 4
+word64 = uint .size 8

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

@@ -0,0 +1,17 @@
+serialisedCardanoBlock = #6.24(bytes .cbor cardanoBlock)
+
+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/chainsync/header.cddl

@@ -0,0 +1,25 @@
+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, base.word32]
+byronRegularIdx = [1, base.word32]
+
+serialisedShelleyHeader<era> = #6.24(bytes .cbor era)
+
+;# include byron as byron
+;# include shelley as shelley
+;# include allegra as allegra
+;# include mary as mary
+;# include alonzo as alonzo
+;# include babbage as babbage
+;# include conway as conway
+;# import base as base

ouroboros-consensus-cardano/cddl/node-to-node/txsubmission2/tx.cddl

@@ -0,0 +1,19 @@
+tx =
+  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)
+
+;# include byron as byron
+;# include shelley as shelley
+;# include allegra as allegra
+;# include mary as mary
+;# include alonzo as alonzo
+;# include babbage as babbage
+;# include conway as conway
+;# import base as base

ouroboros-consensus-cardano/cddl/node-to-node/txsubmission2/txId.cddl

@@ -0,0 +1,22 @@
+txId =
+  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]
+          / [2, byron.updid]
+          / [3, byron.voteid]
+
+;# include byron as byron
+;# include shelley as shelley
+;# include allegra as allegra
+;# include mary as mary
+;# include alonzo as alonzo
+;# include babbage as babbage
+;# include conway as conway
+;# import base as base

ouroboros-consensus-cardano/ouroboros-consensus-cardano.cabal

@@ -23,6 +23,9 @@ extra-doc-files:
   CHANGELOG.md
   README.md
 
+data-files:
+  cddl/**/*.cddl
+
 source-repository head
   type: git
   location: https://github.com/IntersectMBO/ouroboros-consensus

scripts/ci/diff-cddls.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+check_diff () {
+    diff "ouroboros-consensus-cardano/cddl/node-to-node/$1" "blueprints/src/network/node-to-node/$1"
+    if [ $? -ne 0 ]
+    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"