CDDL: Move cddl-files to cddl/data.

Improve `writeSpec` to validate filepath.

Author: aniketd

CONTRIBUTING.md

@@ -133,7 +133,7 @@ Using the current date should ensure that this is the case.
 ## CDDL files
 
 For each era, the serialization protocol is defined by a corresponding cddl file,
-located at: `eras/<era>/impl/cddl-files/<era>.cddl`.
+located at: `eras/<era>/impl/cddl/data/<era>.cddl`.
 
 These files are generated using [cuddle](https://github.com/input-output-hk/cuddle),
 based on the Haskell definitions in: `eras/<era>/impl/testlib/Test/Cardano/Ledger/<era>/CDDL.hs`.

README.md

@@ -21,12 +21,12 @@ following links:
 Era | Design Documents | Formal Specification | CDDL
 ----|------------------|----------------------|-----
 Byron | | [Chain Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/byron-blockchain.pdf "Specification of the Blockchain Layer"), [Ledger Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/byron-ledger.pdf "A Formal Specification of the Cardano Ledger") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/byron/ledger/impl/cddl-spec/byron.cddl), [PDF](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/byron-binary.pdf)
-Shelley | [Design](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-delegation.pdf "Design Specification for Delegation and Incentives in Cardano") | [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-ledger.pdf "A Formal Specification of the Cardano Ledger") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/shelley/impl/cddl-files)
-Allegra | Same as Mary era below | Same as Mary era below | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/allegra/impl/cddl-files)
-Mary | [Multi-Currency](https://eprint.iacr.org/2020/895 "Multi-Currency Ledgers"), [UTXOma](https://iohk.io/en/research/library/papers/utxoma-utxo-with-multi-asset-support/ "UTXOma:UTXO with Multi-Asset Support") | [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/mary-ledger.pdf "A Formal Specification of the Cardano Ledger with a Native Multi-Asset Implementation") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/mary/impl/cddl-files)
-Alonzo | [eUTXO](https://iohk.io/en/research/library/papers/the-extended-utxo-model/ "The Extended UTXO Model")| [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/alonzo-ledger.pdf "A Formal Specification of the Cardano Ledger integrating Plutus Core") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/alonzo/impl/cddl-files)
-Babbage | [batch-verification](https://iohk.io/en/research/library/papers/on-uc-secure-range-extension-and-batch-verification-for-ecvrf/ "On UC-Secure Range Extension and Batch Verification for ECVRF"), [CIP-31](https://github.com/cardano-foundation/CIPs/pull/159 "Reference inputs"), [CIP-32](https://github.com/cardano-foundation/CIPs/pull/160 "Inline datums"), [CIP-33](https://github.com/cardano-foundation/CIPs/pull/161 "Reference scripts") | [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/babbage-ledger.pdf "Formal Specification of the Cardano Ledger for the Babbage era") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/babbage/impl/cddl-files)
-Conway | [CIP-1694](https://github.com/cardano-foundation/CIPs/tree/master/CIP-1694) | [Spec (WIP)](https://github.com/intersectmbo/formal-ledger-specifications) | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/conway/impl/cddl-files)
+Shelley | [Design](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-delegation.pdf "Design Specification for Delegation and Incentives in Cardano") | [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-ledger.pdf "A Formal Specification of the Cardano Ledger") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/shelley/impl/cddl/data)
+Allegra | Same as Mary era below | Same as Mary era below | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/allegra/impl/cddl/data)
+Mary | [Multi-Currency](https://eprint.iacr.org/2020/895 "Multi-Currency Ledgers"), [UTXOma](https://iohk.io/en/research/library/papers/utxoma-utxo-with-multi-asset-support/ "UTXOma:UTXO with Multi-Asset Support") | [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/mary-ledger.pdf "A Formal Specification of the Cardano Ledger with a Native Multi-Asset Implementation") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/mary/impl/cddl/data)
+Alonzo | [eUTXO](https://iohk.io/en/research/library/papers/the-extended-utxo-model/ "The Extended UTXO Model")| [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/alonzo-ledger.pdf "A Formal Specification of the Cardano Ledger integrating Plutus Core") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/alonzo/impl/cddl/data)
+Babbage | [batch-verification](https://iohk.io/en/research/library/papers/on-uc-secure-range-extension-and-batch-verification-for-ecvrf/ "On UC-Secure Range Extension and Batch Verification for ECVRF"), [CIP-31](https://github.com/cardano-foundation/CIPs/pull/159 "Reference inputs"), [CIP-32](https://github.com/cardano-foundation/CIPs/pull/160 "Inline datums"), [CIP-33](https://github.com/cardano-foundation/CIPs/pull/161 "Reference scripts") | [Spec](https://github.com/intersectmbo/cardano-ledger/releases/latest/download/babbage-ledger.pdf "Formal Specification of the Cardano Ledger for the Babbage era") | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/babbage/impl/cddl/data)
+Conway | [CIP-1694](https://github.com/cardano-foundation/CIPs/tree/master/CIP-1694) | [Spec (WIP)](https://github.com/intersectmbo/formal-ledger-specifications) | [CDDL](https://github.com/intersectmbo/cardano-ledger/tree/master/eras/conway/impl/cddl/data)
 
 
 Other Documents:
@@ -58,7 +58,7 @@ The directory structure of this repository is as follows:
   - [formal-spec](./eras/shelley/formal-spec)
   - [implementation](./eras/shelley/impl)
   - [tests](./eras/shelley/test-suite)
-  - [cddl](./eras/shelley/impl/cddl-files)
+  - [cddl](./eras/shelley/impl/cddl/data)
 - [Allegra - Timelocks](./eras/allegra)
   - [formal-spec](./eras/shelley-ma/formal-spec)
   - [implementation](./eras/allegra/impl)
@@ -70,17 +70,17 @@ The directory structure of this repository is as follows:
 - [Alonzo - Smart Contracts](./eras/alonzo)
   - [formal-spec](./eras/alonzo/formal-spec)
   - [implementation](./eras/alonzo/impl)
-  - [cddl](./eras/alonzo/impl/cddl-files)
+  - [cddl](./eras/alonzo/impl/cddl/data)
   - [tests](./eras/alonzo/test-suite)
 - [Babbage](./eras/babbage)
   - [formal-spec](./eras/babbage/formal-spec)
   - [implementation](./eras/babbage/impl)
-  - [cddl](./eras/babbage/impl/cddl-files)
+  - [cddl](./eras/babbage/impl/cddl/data)
   - [tests](./eras/babbage/impl/test)
 - [Conway - Governance](./eras/conway)
   - [formal-spec](./eras/conway/formal-spec)
   - [implementation](./eras/conway/impl)
-  - [cddl](./eras/conway/impl/cddl-files)
+  - [cddl](./eras/conway/impl/cddl/data)
   - [tests](./eras/conway/impl/test)
 - [Libraries](./libs)
 
@@ -191,4 +191,4 @@ $ curl -sSLO https://raw.githubusercontent.com/IntersectMBO/cardano-ledger/refs/
 $ git clone -c fetch.fsck.skipList=.git-fsck-skiplist ...
 ...
 $ rm .git-fsck-skiplist
-```
+```

eras/allegra/impl/CHANGELOG.md

@@ -14,6 +14,7 @@
 
 ### `cddl`
 
+* Move `cddl-files` to `cddl/data`.
 * Make `max_int64`, `min_int64` and `int64` era generic.
 * Export for cross-era reuse:
   - `auxiliaryScriptsRule`, `auxiliaryDataArrayRule`, `auxiliaryDataRule`

eras/allegra/impl/cardano-ledger-allegra.cabal

@@ -11,7 +11,7 @@ description:
 
 category: Network
 build-type: Simple
-data-files: cddl-files/allegra.cddl
+data-files: cddl/data/allegra.cddl
 extra-source-files: CHANGELOG.md
 
 source-repository head
@@ -125,8 +125,6 @@ executable generate-cddl
     base,
     cardano-ledger-binary:testlib >=1.4,
     cddl,
-    directory,
-    filepath,
 
 library testlib
   exposed-modules:

eras/allegra/impl/cddl-files/allegra.cddl eras/allegra/impl/cddl/data/allegra.cddleras/allegra/impl/cddl-files/allegra.cddl renamed to eras/allegra/impl/cddl/data/allegra.cddl

@@ -1,4 +1,4 @@
-; This file was auto-generated from huddle. Please do not modify it directly!
+; This file was auto-generated using generate-cddl. Please do not modify it directly!
 
 block = 
   [ header                 

eras/allegra/impl/cddl/exe/Main.hs

@@ -2,13 +2,7 @@ module Main where
 
 import Cardano.Ledger.Allegra.HuddleSpec (allegraCDDL)
 import Paths_cardano_ledger_allegra (getDataFileName)
-import System.Directory (createDirectoryIfMissing)
-import System.FilePath (takeDirectory)
 import Test.Cardano.Ledger.Binary.Cuddle (writeSpec)
 
 main :: IO ()
-main = do
-  outputPath <- getDataFileName "cddl-files/allegra.cddl"
-  createDirectoryIfMissing True (takeDirectory outputPath)
-  writeSpec allegraCDDL outputPath
-  putStrLn $ "Generated CDDL file at: " ++ outputPath
+main = writeSpec allegraCDDL =<< getDataFileName "cddl/data/allegra.cddl"

eras/allegra/impl/huddle-cddl/Main.hs

@@ -5,4 +5,4 @@ import Test.Cardano.Ledger.Allegra.CDDL (allegraCDDL)
 import Test.Cardano.Ledger.Binary.Cuddle (writeSpec)
 
 main :: IO ()
-main = writeSpec allegraCDDL =<< getDataFileName "cddl-files/allegra.cddl"
+main = writeSpec allegraCDDL =<< getDataFileName "cddl/data/allegra.cddl"

eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/Binary/Cddl.hs

@@ -8,7 +8,7 @@ import Paths_cardano_ledger_allegra
 
 readAllegraCddlFileNames :: IO [FilePath]
 readAllegraCddlFileNames = do
-  base <- getDataFileName "cddl-files/allegra.cddl"
+  base <- getDataFileName "cddl/data/allegra.cddl"
   pure [base]
 
 readAllegraCddlFiles :: IO [BSL.ByteString]

eras/alonzo/impl/CHANGELOG.md

@@ -52,6 +52,7 @@
 
 ### `cddl`
 
+* Move `cddl-files` to `cddl/data`.
 * Export `exUnitPricesRule` and `requiredSignersRule` for reuse.
 * Make `plutus_v1_script` and `plutus_data` era generic.
 * Add full `HuddleSpec`.

eras/alonzo/impl/cardano-ledger-alonzo.cabal

@@ -13,7 +13,7 @@ description:
 category: Network
 build-type: Simple
 data-files:
-  cddl-files/alonzo.cddl
+  cddl/data/alonzo.cddl
   golden/*.cbor
   golden/*.json
 
@@ -145,8 +145,6 @@ executable generate-cddl
     base,
     cardano-ledger-binary:testlib >=1.5,
     cddl,
-    directory,
-    filepath,
 
 library testlib
   exposed-modules: