Add gov/proposals/roots/v0 namespace (#293)

* Update CIPs reference

* Move gov_action_id rule

* Add gov/proposals/roots/v0 namespace and definitions

* Apply suggestion from @qnikst

* Update scls-cardano/cddl-src/Cardano/SCLS/Namespace/GovProposalsRoots.hs

---------

Co-authored-by: Alexander Vershilov <alexander.vershilov@tweag.io>

Author: joaosreis

.github/workflows/haskell-ci.yml

@@ -165,7 +165,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: tweag/CIPs
-          ref: 5a4f49835b01695583830e01e2dfd11e9e582efc
+          ref: c92a3b5db78268e7f0db5f24c80ed6f49cf4b149
           path: cips
       - name: set env for reference CDDL
         run: |

flake.lock

@@ -18,7 +18,7 @@
     inputs.nixpkgs.follows = "nixpkgs";
   };
   inputs.cips = {
-    url = "github:tweag/CIPs?rev=5a4f49835b01695583830e01e2dfd11e9e582efc";
+    url = "github:tweag/CIPs?rev=c92a3b5db78268e7f0db5f24c80ed6f49cf4b149";
     flake = false;
   };
   outputs = { self, nixpkgs, flake-utils, haskellNix, git-hooks, treefmt-nix

flake.nix

@@ -14,6 +14,7 @@ import Cardano.SCLS.Namespace.GovCommittee qualified as GovCommittee
 import Cardano.SCLS.Namespace.GovConstitution qualified as GovConstitution
 import Cardano.SCLS.Namespace.GovPParams qualified as GovPParams
 import Cardano.SCLS.Namespace.GovProposals qualified as GovProposals
+import Cardano.SCLS.Namespace.GovProposalsRoots qualified as GovProposalsRoots
 import Cardano.SCLS.Namespace.Nonces qualified as Nonces
 import Cardano.SCLS.Namespace.Snapshots qualified as Snapshots
 import Cardano.SCLS.Namespace.UTxO qualified as UTxO
@@ -67,6 +68,9 @@ instance KnownSpec "gov/pparams/v0" where
 instance KnownSpec "gov/proposals/v0" where
   namespaceSpec _ = mkDefinition GovProposals.record_entry
 
+instance KnownSpec "gov/proposals/roots/v0" where
+  namespaceSpec _ = mkDefinition GovProposalsRoots.record_entry
+
 mkDefinition :: Rule -> Huddle
 mkDefinition r = collectFromInit [HIRule r]
 
@@ -87,6 +91,7 @@ knownNamespaces =
   , mkNamespaceSymbol @"gov/constitution/v0"
   , mkNamespaceSymbol @"gov/pparams/v0"
   , mkNamespaceSymbol @"gov/proposals/v0"
+  , mkNamespaceSymbol @"gov/proposals/roots/v0"
   ]
 
 type instance Spec.NamespaceKeySize "utxo/v0" = 34
@@ -100,3 +105,4 @@ type instance Spec.NamespaceKeySize "gov/committee/v0" = 8
 type instance Spec.NamespaceKeySize "gov/constitution/v0" = 8
 type instance Spec.NamespaceKeySize "gov/pparams/v0" = 4
 type instance Spec.NamespaceKeySize "gov/proposals/v0" = 34 -- 32 bytes txid+tx index + 2 bytes for proposal index
+type instance Spec.NamespaceKeySize "gov/proposals/roots/v0" = 1 -- 1 byte for proposal purpose

scls-cardano/cddl-src/Cardano/SCLS/CDDL.hs

@@ -243,3 +243,8 @@ protocol_version = "protocol_version" =:= arr [a major_protocol_version, a VUInt
 
 major_protocol_version :: Rule
 major_protocol_version = "major_protocol_version" =:= VUInt
+
+gov_action_id :: Rule
+gov_action_id =
+  "gov_action_id"
+    =:= arr ["transaction_id" ==> hash32, "gov_action_index" ==> VUInt `sized` (2 :: Word64)]

scls-cardano/cddl-src/Cardano/SCLS/Common.hs

@@ -109,11 +109,6 @@ gov_action =
     / (arr [5, "purpose" ==> (gov_action_id / VNil), "constitution" ==> constitution] //- "New constitution")
     / (arr [6] //- "Info action")
 
-gov_action_id :: Rule
-gov_action_id =
-  "gov_action_id"
-    =:= arr ["transaction_id" ==> hash32, "gov_action_index" ==> VUInt `sized` (2 :: Word64)]
-
 gov_params_update :: Rule
 gov_params_update =
   comment

scls-cardano/cddl-src/Cardano/SCLS/Namespace/GovProposals.hs

@@ -0,0 +1,40 @@
+{-# LANGUAGE ImportQualifiedPost #-}
+{-# LANGUAGE OverloadedLists #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE TypeApplications #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
+
+{-# HLINT ignore "Use camelCase" #-}
+module Cardano.SCLS.Namespace.GovProposalsRoots where
+
+import Cardano.SCLS.Common
+import Codec.CBOR.Cuddle.Huddle
+import Data.Function (($))
+import Text.Heredoc (str)
+
+record_entry :: Rule
+record_entry =
+  comment
+    [str| Size of the key
+        |
+        | ```
+        | meta:
+        |   endian: be
+        |
+        | seq:
+        |   - id: key
+        |     type: u1
+        |     enum: gov_proposals_purpose
+        | 
+        |   enums:
+        |     gov_proposals_purpose:
+        |       0: pparams_update
+        |       1: hard_fork
+        |       2: committee
+        |       3: constitution
+        | ```
+        |
+        |]
+    $ "record_entry" =:= gov_action_id

scls-cardano/cddl-src/Cardano/SCLS/Namespace/GovProposalsRoots.hs

@@ -36,6 +36,7 @@ library
     Cardano.SCLS.Namespace.GovConstitution
     Cardano.SCLS.Namespace.GovPParams
     Cardano.SCLS.Namespace.GovProposals
+    Cardano.SCLS.Namespace.GovProposalsRoots
     Cardano.SCLS.Namespace.Nonces
     Cardano.SCLS.Namespace.Snapshots
     Cardano.SCLS.Namespace.UTxO

scls-cardano/scls-cardano.cabal

@@ -74,6 +74,7 @@ allReferenceCDDLs =
   , ("gov/constitution/v0", "gov_constitution_v0.cddl")
   , ("gov/pparams/v0", "gov_pparams_v0.cddl")
   , ("gov/proposals/v0", "gov_proposals_v0.cddl")
+  , ("gov/proposals/roots/v0", "gov_proposals_roots_v0.cddl")
   ]
 
 loadAllReferenceCDDLs :: IO (Maybe ([(Text, Either LoadError (CTreeRoot MonoReferenced))]))

scls-cardano/test/Reference.hs

@@ -60,6 +60,7 @@ testAllNS ::
   , ConstrNS "gov/constitution/v0"
   , ConstrNS "gov/pparams/v0"
   , ConstrNS "gov/proposals/v0"
+  , ConstrNS "gov/proposals/roots/v0"
   ) =>
   Spec
 testAllNS = describe "scls/conformance" $ do
@@ -73,6 +74,7 @@ testAllNS = describe "scls/conformance" $ do
   testNS @"gov/constitution/v0"
   testNS @"gov/pparams/v0"
   testNS @"gov/proposals/v0"
+  testNS @"gov/proposals/roots/v0"
 
 -- | Validate concrete type against its definition in CDDL
 validateType :: forall ns a. (KnownSymbol ns, ToCanonicalCBOR ns a, Arbitrary a, Show a, Typeable a) => T.Text -> Spec