Extend information for the known Namespaces (#105)

* Extend information for the known Namespaces

We introduce a structure for the information about the namespaces
NamespaceInfo, that keeps an information and configuration for the
namespaces.

Currently there are only two fields, but they can be excended later:
1. namespaceSpec - Huddle specification for the namespace
2. namespaceKeySize - size of the key

We need the latter because in the CIP we propose that all the keys
in the namespaces have a statically known size. This way we can
pass this information.

We use GHC Natural because later we will need that info to pass
the values on the type level.

* Update scls-cddl/cddl-src/Cardano/SCLS/CDDL.hs

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: qnikst

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

@@ -1,13 +1,29 @@
-module Cardano.SCLS.CDDL where
+{-# LANGUAGE OverloadedStrings #-}
+
+module Cardano.SCLS.CDDL (
+  NamespaceInfo (..),
+  namespaces,
+) where
 
 import Cardano.SCLS.Namespace.Blocks qualified as Blocks
 import Cardano.SCLS.Namespace.UTxO qualified as UTxO
 import Codec.CBOR.Cuddle.Huddle (Huddle, HuddleItem (HIRule), collectFromInit)
 import Data.Map.Strict qualified as Map
+import Data.Text (Text)
+import Numeric.Natural (Natural)
+
+-- | Various information about supported namespaces.
+data NamespaceInfo = NamespaceInfo
+  { namespaceSpec :: !Huddle
+  -- ^ Specification for the namespace entries.
+  , namespaceKeySize :: !Natural
+  -- ^ Size of the keys in the namespace.
+  }
 
-namespaces :: Map.Map String Huddle
+-- | List of the namespaces known to the SCLS utilities.
+namespaces :: Map.Map Text NamespaceInfo
 namespaces =
   Map.fromList
-    [ ("utxo/v0", collectFromInit [HIRule UTxO.record_entry]),
-      ("blocks/v0", collectFromInit [HIRule Blocks.record_entry])
+    [ ("utxo/v0", NamespaceInfo (collectFromInit [HIRule UTxO.record_entry]) 32)
+    , ("blocks/v0", NamespaceInfo (collectFromInit [HIRule Blocks.record_entry]) 32)
     ]

scls-cddl/gen-cddl/Main.hs

@@ -2,12 +2,13 @@
 
 module Main where
 
-import Cardano.SCLS.CDDL (namespaces)
+import Cardano.SCLS.CDDL (NamespaceInfo (..), namespaces)
 
 import Codec.CBOR.Cuddle.Huddle qualified as Cuddle
 import Codec.CBOR.Cuddle.Pretty ()
 import Control.Monad (forM_)
 import Data.Map.Strict qualified as Map
+import Data.Text qualified as T
 import Prettyprinter (pretty)
 import Prettyprinter.Render.Text (hPutDoc)
 import System.Environment (getArgs)
@@ -17,8 +18,8 @@ import System.IO
 main :: IO ()
 main =
   getArgs >>= \case
-    [dir] -> forM_ (Map.toList namespaces) $ \(ns, cddl) -> do
-      writeSpec cddl (dir </> ns <.> "cddl")
+    [dir] -> forM_ (Map.toList namespaces) $ \(ns, NamespaceInfo{namespaceSpec = cddl}) -> do
+      writeSpec cddl (dir </> T.unpack ns <.> "cddl")
     _ -> error "Usage: gen-cddl directory"
 
 writeSpec :: Cuddle.Huddle -> FilePath -> IO ()

scls-cddl/scls-cddl.cabal

@@ -35,7 +35,8 @@ library
     base >=4.18 && <5,
     containers >=0.6,
     cuddle >=0.5,
-    heredoc >=0.2
+    heredoc >=0.2,
+    text
 
   hs-source-dirs:
     cddl-src
@@ -53,4 +54,5 @@ executable gen-cddl
     cuddle >=0.5,
     filepath >=1.4,
     prettyprinter,
-    scls-cddl
+    scls-cddl,
+    text

scls-format/test/Roundtrip.hs

@@ -5,7 +5,7 @@ module Roundtrip (
   tests,
 ) where
 
-import Cardano.SCLS.CDDL (namespaces)
+import Cardano.SCLS.CDDL (NamespaceInfo (..), namespaces)
 import Cardano.SCLS.Internal.Entry
 import Cardano.SCLS.Internal.Hash (Digest (..))
 import Cardano.SCLS.Internal.Reader (extractRootHash, withHeader, withNamespacedData, withRecordData)
@@ -36,7 +36,6 @@ import Data.Function ((&))
 import Data.List (sort)
 import Data.Map.Strict qualified as Map
 import Data.MemPack
-import Data.String
 import Data.Text qualified as T
 import Data.Word (Word32, Word64)
 import Streaming.Prelude qualified as S
@@ -73,7 +72,7 @@ mkRoundtripTestsFor groupName serialize =
   describe groupName $ do
     sequence_
       [ context (Namespace.asString n) $ it "should succeed with stream roundtrip" $ roundtrip n (toCDDL huddle)
-      | (fromString -> n, huddle) <- Map.toList namespaces
+      | (Namespace.fromText -> n, namespaceSpec -> huddle) <- Map.toList namespaces
       ]
  where
   roundtrip namespace cddl = do