Add Disk CDDLs

Author: jasagredo

ouroboros-consensus-cardano/cddl/base.cddl

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

ouroboros-consensus-cardano/cddl/disk/immutable/chunkFile.cddl

@@ -0,0 +1,3 @@
+chunkFile = bytes .cborseq block.cardanoBlock
+
+;# import block as block

ouroboros-consensus-cardano/cddl/disk/ledger/headerstate.cddl

@@ -0,0 +1,28 @@
+headerState =
+  [withOrigin<headerStateTip>, headerStateChainDep]
+
+headerStateTip =
+  ns7<byronAnnTip, annTip, annTip, annTip, annTip, annTip, annTip>
+
+byronAnnTip = [slotno,
+               hash,
+               blockno,
+               bool]
+
+annTip = [slotno,
+          hash,
+          blockno]
+
+headerStateChainDep =
+  telescope7<versionedPbftState,
+             versionedTPraosState,
+             versionedTPraosState,
+             versionedTPraosState,
+             versionedTPraosState,
+             versionedPraosState,
+             versionedPraosState>
+
+;# import withOrigin, ns7, telescope7, slotno, hash, blockno from base
+;# import versionedPbftState from pbft
+;# import versionedPraosState from praos
+;# import versionedTPraosState from tpraos

ouroboros-consensus-cardano/cddl/disk/ledger/ledgerstate.cddl

@@ -0,0 +1,30 @@
+ledgerState =
+  telescope7<byron.ledgerstate,
+             versionedShelleyLedgerState<shelley.ledgerstate>,
+             versionedShelleyLedgerState<allegra.ledgerstate>,
+             versionedShelleyLedgerState<mary.ledgerstate>,
+             versionedShelleyLedgerState<alonzo.ledgerstate>,
+             versionedShelleyLedgerState<babbage.ledgerstate>,
+             versionedShelleyLedgerState<conway.ledgerstate>>
+
+versionedShelleyLedgerState<eraSt1> = [ shelleyVersion2, shelleyLedgerState<eraSt1> ]
+
+shelleyVersion2 = 2
+
+shelleyLedgerState<eraSt2> = [ withOrigin<shelleyTip>, eraSt2, shelleyTransition ]
+
+shelleyTip = [slotno, blockno, hash]
+
+shelleyTransition = word32
+
+; TODO these should be imports from the ledger however they do not
+; provide these definitions yet.
+byron.ledgerstate = any
+shelley.ledgerstate = any
+allegra.ledgerstate = any
+mary.ledgerstate = any
+alonzo.ledgerstate = any
+babbage.ledgerstate = any
+conway.ledgerstate = any
+
+;# import telescope7, withOrigin, slotno, blockno, hash, word32 from base

ouroboros-consensus-cardano/cddl/disk/ledger/pbft.cddl

@@ -0,0 +1,5 @@
+versionedPbftState = [serializationFormat1, {* keyhash => [* slotno]}]
+
+serializationFormat1 = 1
+
+;# import keyhash, slotno from base

ouroboros-consensus-cardano/cddl/disk/ledger/praos.cddl

@@ -0,0 +1,13 @@
+versionedPraosState = [praosVersion, praosState]
+
+praosVersion = 0
+
+praosState = [withOrigin<slotno>,
+              {* keyhash => word64},
+              nonce,
+              nonce,
+              nonce,
+              nonce,
+              nonce]
+
+;# import withOrigin, slotno, keyhash, word64, nonce from base

ouroboros-consensus-cardano/cddl/disk/ledger/stateFile.cddl

@@ -0,0 +1,9 @@
+ledgerStateSnapshot =
+  [snapshotEncodingVersion1, extLedgerState]
+
+snapshotEncodingVersion1 = 1
+
+extLedgerState = [ledgerState, headerState]
+
+;# import headerState from headerstate
+;# import ledgerState from ledgerstate

ouroboros-consensus-cardano/cddl/disk/ledger/tpraos.cddl

@@ -0,0 +1,12 @@
+versionedTPraosState =
+  [serializationFormat1, [withOriginTH<slotno>, tpraosState]]
+
+tpraosState = [prtclState, ticknState, nonce]
+
+prtclState = [{* keyhash => word64}, nonce, nonce]
+
+ticknState = [nonce, nonce]
+
+serializationFormat1 = 1
+
+;# import withOriginTH, slotno, keyhash, word64, nonce from base

ouroboros-consensus-cardano/cddl/disk/volatile/blocksDatFile.cddl

@@ -0,0 +1,3 @@
+blockDatFile = bytes .cborseq block.cardanoBlock
+
+;# import block as block