Refine local-state-query.cddl by specifying possible queries

IntersectMBO · Feb 10, 2025 · 6073392 · 6073392
1 parent a933425
commit 6073392
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 5 deletions.
diff --git a/ouroboros-network-protocols/cddl/specs/local-state-query.cddl b/ouroboros-network-protocols/cddl/specs/local-state-query.cddl
@@ -18,7 +18,16 @@ acquireFailurePointNotOnChain = 1
 failure      = acquireFailurePointTooOld
              / acquireFailurePointNotOnChain
 
-query        = any
+blockQuery      = [0, point]
+getSystemStart  = [1]
+getChainBlockNo = [2]
+getChainPoint   = [3]
+
+query        = blockQuery
+             / getSystemStart
+             / getChainBlockNo
+             / getChainPoint
+
 result       = any
 
 msgAcquire   = [0, point]

diff --git a/ouroboros-network-protocols/testlib/Ouroboros/Network/Protocol/LocalStateQuery/Codec/CDDL.hs b/ouroboros-network-protocols/testlib/Ouroboros/Network/Protocol/LocalStateQuery/Codec/CDDL.hs
@@ -1,4 +1,6 @@
 {-# LANGUAGE DeriveGeneric              #-}
+{-# LANGUAGE DeriveAnyClass             #-}
+{-# LANGUAGE DerivingStrategies         #-}
 {-# LANGUAGE FlexibleInstances          #-}
 {-# LANGUAGE GADTs                      #-}
 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
@@ -20,14 +22,29 @@ import Ouroboros.Network.Protocol.BlockFetch.Codec.CDDL (Block, BlockPoint)
 import Ouroboros.Network.Protocol.LocalStateQuery.Codec
 import Ouroboros.Network.Protocol.LocalStateQuery.Type
 import Test.Data.CDDL (Any)
-import Test.QuickCheck (Arbitrary (..))
+import Test.QuickCheck (Arbitrary (..), oneof)
 
 newtype Result = Result Any
-  deriving (Eq, Show, Arbitrary, Serialise, Generic, NFData)
+  deriving stock (Eq, Show, Generic)
+  deriving newtype (Arbitrary, Serialise, NFData)
+
+data QueryPayload =
+    BlockQuery Any
+  | GetSystemStart
+  | GetChainBlockNo
+  | GetChainPoint
+  deriving stock (Eq, Show, Generic)
+  deriving anyclass (Serialise, NFData)
+
+instance Arbitrary QueryPayload where
+    arbitrary = oneof [ BlockQuery <$> arbitrary
+                      , pure GetSystemStart
+                      , pure GetChainBlockNo
+                      , pure GetChainPoint
+                      ]
 
--- TODO: add payload to the query
 data Query result where
-    Query :: Any -> Query Result
+    Query :: QueryPayload -> Query Result
 
 instance NFData (Query result) where
   rnf (Query a) = rnf a