Add entities/dormant_epochs/v0 namespace and definitions

Author: joaosreis

.github/workflows/haskell-ci.yml

@@ -165,7 +165,7 @@ jobs:
         uses: actions/checkout@v6
         with:
           repository: tweag/CIPs
-          ref: 8b1b619bef7e11b37f21e2b39f3159ea5d48af23
+          ref: 4344988283363af3a1ae7dd130155bc36802ea9b
           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=8b1b619bef7e11b37f21e2b39f3159ea5d48af23";
+    url = "github:tweag/CIPs?rev=4344988283363af3a1ae7dd130155bc36802ea9b";
     flake = false;
   };
   outputs = { self, nixpkgs, flake-utils, haskellNix, git-hooks, treefmt-nix

flake.nix

@@ -14,6 +14,7 @@ import Cardano.SCLS.Namespace.EntitiesCommittee qualified as EntitiesCommittee
 import Cardano.SCLS.Namespace.EntitiesDReps qualified as EntitiesDReps
 import Cardano.SCLS.Namespace.EntitiesStakePools qualified as EntitiesStakePools
 import Cardano.SCLS.Namespace.EntitiesStakePoolsVRFKeyHashes qualified as EntitiesStakePoolsVRFKeyHashes
+import Cardano.SCLS.Namespace.EntitiesDormantEpochs qualified as EntitiesDormantEpochs
 import Cardano.SCLS.Namespace.GovCommittee qualified as GovCommittee
 import Cardano.SCLS.Namespace.GovConstitution qualified as GovConstitution
 import Cardano.SCLS.Namespace.GovPParams qualified as GovPParams
@@ -72,6 +73,9 @@ instance KnownSpec "entities/stake_pools/v0" where
 instance KnownSpec "entities/stake_pools/vrf_key_hashes/v0" where
   namespaceSpec _ = mkDefinition EntitiesStakePoolsVRFKeyHashes.record_entry
 
+instance KnownSpec "entities/dormant_epochs/v0" where
+  namespaceSpec _ = mkDefinition EntitiesDormantEpochs.record_entry
+
 instance KnownSpec "gov/committee/v0" where
   namespaceSpec _ = mkDefinition GovCommittee.record_entry
 
@@ -107,6 +111,7 @@ knownNamespaces =
   , mkNamespaceSymbol @"entities/dreps/v0"
   , mkNamespaceSymbol @"entities/stake_pools/v0"
   , mkNamespaceSymbol @"entities/stake_pools/vrf_key_hashes/v0"
+  , mkNamespaceSymbol @"entities/dormant_epochs/v0"
   , mkNamespaceSymbol @"gov/committee/v0"
   , mkNamespaceSymbol @"gov/constitution/v0"
   , mkNamespaceSymbol @"gov/pparams/v0"
@@ -125,6 +130,7 @@ type instance Spec.NamespaceKeySize "entities/committee/v0" = 1 -- One-byte zero
 type instance Spec.NamespaceKeySize "entities/dreps/v0" = 29 -- 1 byte for tag, 28 bytes for hash
 type instance Spec.NamespaceKeySize "entities/stake_pools/v0" = 28
 type instance Spec.NamespaceKeySize "entities/stake_pools/vrf_key_hashes/v0" = 32
+type instance Spec.NamespaceKeySize "entities/dormant_epochs/v0" = 1
 type instance Spec.NamespaceKeySize "gov/committee/v0" = 1 -- One-byte zero, as it's a singleton key
 type instance Spec.NamespaceKeySize "gov/constitution/v0" = 1 -- One-byte zero, as it's a singleton key
 type instance Spec.NamespaceKeySize "gov/pparams/v0" = 4

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

@@ -0,0 +1,37 @@
+{-# 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.EntitiesDormantEpochs where
+
+import Cardano.SCLS.Common
+import Codec.CBOR.Cuddle.Huddle
+import Data.Function (($))
+import Text.Heredoc (str)
+
+record_entry :: Rule
+record_entry =
+  comment
+    [str| The key for the namespace
+        |
+        | ```
+        | meta:
+        |   endian: be
+        |
+        | seq:
+        |   - id: key
+        |     type: singleton
+        |
+        | types:
+        |   singleton:
+        |     size: 1
+        |     type: u1
+        |     const: 0
+        | ```
+        |]
+    $ "record_entry" =:= epoch_no

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

@@ -34,6 +34,7 @@ library
     Cardano.SCLS.Namespace.EntitiesAccounts
     Cardano.SCLS.Namespace.EntitiesCommittee
     Cardano.SCLS.Namespace.EntitiesDReps
+    Cardano.SCLS.Namespace.EntitiesDormantEpochs
     Cardano.SCLS.Namespace.EntitiesStakePools
     Cardano.SCLS.Namespace.EntitiesStakePoolsVRFKeyHashes
     Cardano.SCLS.Namespace.GovCommittee

scls-cardano/scls-cardano.cabal

@@ -74,6 +74,7 @@ allReferenceCDDLs =
   , ("entities/dreps/v0", "entities_dreps_v0.cddl")
   , ("entities/stake_pools/v0", "entities_stake_pools_v0.cddl")
   , ("entities/stake_pools/vrf_key_hashes/v0", "entities_stake_pools_vrf_key_hashes_v0.cddl")
+  , ("entities/dormant_epochs/v0", "entities_dormant_epochs_v0.cddl")
   , ("gov/committee/v0", "gov_committee_v0.cddl")
   , ("gov/constitution/v0", "gov_constitution_v0.cddl")
   , ("gov/pparams/v0", "gov_pparams_v0.cddl")

scls-cardano/test/Reference.hs

@@ -60,6 +60,7 @@ testAllNS ::
   , ConstrNS "entities/dreps/v0"
   , ConstrNS "entities/stake_pools/v0"
   , ConstrNS "entities/stake_pools/vrf_key_hashes/v0"
+  , ConstrNS "entities/dormant_epochs/v0"
   , ConstrNS "gov/committee/v0"
   , ConstrNS "gov/constitution/v0"
   , ConstrNS "gov/pparams/v0"
@@ -78,6 +79,7 @@ testAllNS = describe "scls/conformance" $ do
   testNS @"entities/dreps/v0"
   testNS @"entities/stake_pools/v0"
   testNS @"entities/stake_pools/vrf_key_hashes/v0"
+  testNS @"entities/dormant_epochs/v0"
   testNS @"gov/committee/v0"
   testNS @"gov/constitution/v0"
   testNS @"gov/pparams/v0"