CDDL: Consolidate protocol_version definitions

Author: aniketd

eras/alonzo/impl/CHANGELOG.md

@@ -9,6 +9,7 @@
 ### `testlib`
 
 * Use named CDDL `slot` and `block_number` rules in header
+* Remove CDDL `protocol_version` redefinition
 * Add `NativeScript` parameter to `exampleTx`
 
 ## 1.14.0.0

eras/alonzo/impl/testlib/Test/Cardano/Ledger/Alonzo/CDDL.hs

@@ -75,9 +75,6 @@ transaction =
       , a (auxiliary_data / VNil)
       ]
 
-protocol_version :: Named Group
-protocol_version = "protocol_version" =:~ grp [a $ major_protocol_version @AlonzoEra, a VUInt]
-
 transaction_body :: Rule
 transaction_body =
   comment
@@ -231,7 +228,7 @@ protocol_param_update =
         , opt (idx 11 ==> unit_interval)
         , opt (idx 12 ==> unit_interval)
         , opt (idx 13 ==> nonce)
-        , opt (idx 14 ==> arr [a protocol_version])
+        , opt (idx 14 ==> arr [a (protocol_version @AlonzoEra)])
         , opt (idx 16 ==> coin)
         , opt (idx 17 ==> coin)
         , opt (idx 18 ==> cost_models)
@@ -400,7 +397,7 @@ header_body =
         , "block_body_size" ==> VUInt
         , "block_body_hash" ==> hash32
         , a operational_cert
-        , a protocol_version
+        , a (protocol_version @AlonzoEra)
         ]
 
 native_script :: Rule

eras/babbage/impl/CHANGELOG.md

@@ -6,6 +6,7 @@
 
 ### `testlib`
 
+* Hide Shelley CDDL `protocol_version` and re-export a new one for Babbage
 * Use named CDDL `slot` and `block_number` rules in header
 * Add `BabbageEraImp`
 * Removed `babbageEraSpecificSpec`

eras/babbage/impl/testlib/Test/Cardano/Ledger/Babbage/CDDL.hs

@@ -1,7 +1,10 @@
+{-# LANGUAGE AllowAmbiguousTypes #-}
 {-# LANGUAGE ImportQualifiedPost #-}
 {-# LANGUAGE OverloadedLists #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE RankNTypes #-}
+{-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE NoImplicitPrelude #-}
 
@@ -14,13 +17,16 @@ module Test.Cardano.Ledger.Babbage.CDDL (
   operational_cert,
   babbage_transaction_output,
   plutus_data,
+  protocol_version,
 ) where
 
 import Cardano.Ledger.Babbage (BabbageEra)
+import Cardano.Ledger.Core (Era)
 import Codec.CBOR.Cuddle.Huddle
 import Data.Word (Word64)
 import Test.Cardano.Ledger.Alonzo.CDDL hiding (
   operational_cert,
+  protocol_version,
  )
 import Text.Heredoc
 import Prelude hiding ((/))
@@ -83,7 +89,7 @@ header_body =
         , "block_body_size" ==> VUInt
         , "block_body_hash" ==> hash32
         , a operational_cert
-        , a protocol_version
+        , a (protocol_version @BabbageEra)
         ]
 
 operational_cert :: Rule
@@ -96,8 +102,8 @@ operational_cert =
       , "sigma" ==> signature
       ]
 
-protocol_version :: Rule
-protocol_version = "protocol_version" =:= arr [a $ major_protocol_version @BabbageEra, a VUInt]
+protocol_version :: forall era. Era era => Rule
+protocol_version = "protocol_version" =:= arr [a $ major_protocol_version @era, a VUInt]
 
 transaction_body :: Rule
 transaction_body =
@@ -367,7 +373,7 @@ protocol_param_update =
         , opt (idx 9 ==> nonnegative_interval)
         , opt (idx 10 ==> unit_interval)
         , opt (idx 11 ==> unit_interval)
-        , opt (idx 14 ==> protocol_version)
+        , opt (idx 14 ==> protocol_version @BabbageEra)
         , opt (idx 16 ==> coin)
         , opt (idx 17 ==> coin)
         , opt (idx 18 ==> cost_models)

eras/conway/impl/CHANGELOG.md

@@ -12,6 +12,7 @@
 
 * Rename `epoch_no` to `epoch` for consistency
 * Rename `slot_no` to `slot` and `block_no` to `block_number` for consistency
+* Remove CDDL `protocol_version` redefinition
 * Removed `regDelegToDRep`
 * Removed `registerRewardAccountWithDeposit`
 * Removed `registerPoolWithDeposit`

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/CDDL.hs

@@ -181,12 +181,9 @@ header_body =
       , "block_body_size" ==> (VUInt `sized` (4 :: Word64))
       , "block_body_hash" ==> hash32
       , a operational_cert
-      , a protocol_version
+      , a (protocol_version @ConwayEra)
       ]
 
-protocol_version :: Rule
-protocol_version = "protocol_version" =:= arr [a $ major_protocol_version @ConwayEra, a VUInt]
-
 transaction_body :: Rule
 transaction_body =
   "transaction_body"
@@ -264,7 +261,7 @@ parameter_change_action =
 hard_fork_initiation_action :: Named Group
 hard_fork_initiation_action =
   "hard_fork_initiation_action"
-    =:~ grp [1, a $ gov_action_id / VNil, a protocol_version]
+    =:~ grp [1, a $ gov_action_id / VNil, a (protocol_version @ConwayEra)]
 
 treasury_withdrawals_action :: Named Group
 treasury_withdrawals_action =

eras/dijkstra/impl/CHANGELOG.md

@@ -13,6 +13,7 @@
 ### `testlib`
 
 * Use Conway's renamed CDDL `slot` and `block_number` rules
+* Remove CDDL `protocol_version` redefinition
 * Add `impDijkstraSatisfyNativeScript`
 * Add `DijkstraEraTxBody` and `DijkstraEraScript` constraints to `DijkstraEraTest`
 

eras/dijkstra/impl/testlib/Test/Cardano/Ledger/Dijkstra/CDDL.hs

@@ -105,12 +105,9 @@ header_body =
       , "block_body_size" ==> (VUInt `sized` (4 :: Word64))
       , "block_body_hash" ==> hash32
       , a operational_cert
-      , a protocol_version
+      , a (protocol_version @DijkstraEra)
       ]
 
-protocol_version :: Rule
-protocol_version = "protocol_version" =:= arr [a $ major_protocol_version @DijkstraEra, a VUInt]
-
 transaction_body :: Rule
 transaction_body =
   "transaction_body"

eras/shelley/impl/CHANGELOG.md

@@ -15,6 +15,7 @@
 
 ### `testlib`
 
+* Export polymorphic CDDL definition for `protocol_version`
 * Add CDDL definitions for `slot` and `block_number`
 * Remove CDDL definition for `nonce`
 * Rename `examplePoolParams` to `exampleStakePoolParams`

eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/CDDL.hs

@@ -27,6 +27,7 @@ module Test.Cardano.Ledger.Shelley.CDDL (
   bootstrap_witness,
   script_hash,
   major_protocol_version,
+  protocol_version,
   epoch,
   slot,
   block_number,