Merge pull request #541 from IntersectMBO/ch/clarify-all-or-some-flags

Clarify stake-pool queries with an "all or some"-logic
IntersectMBO · Jan 9, 2024 · 6386a51 · 6386a51
2 parents 5e8ee57 + 4823900
commit 6386a51
Show file tree

Hide file tree

Showing 56 changed files with 227 additions and 342 deletions.
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Commands/Query.hs b/cardano-cli/src/Cardano/CLI/EraBased/Commands/Query.hs
@@ -139,7 +139,7 @@ data QueryStakeSnapshotCmdArgs = QueryStakeSnapshotCmdArgs
   { nodeSocketPath      :: !SocketPath
   , consensusModeParams :: !ConsensusModeParams
   , networkId           :: !NetworkId
-  , allOrOnlyPoolIds    :: !(AllOrOnly [Hash StakePoolKey])
+  , allOrOnlyPoolIds    :: !(AllOrOnly (Hash StakePoolKey))
   , mOutFile            :: !(Maybe (File () Out))
   } deriving (Generic, Show)
 
@@ -155,7 +155,7 @@ data QueryPoolStateCmdArgs = QueryPoolStateCmdArgs
   { nodeSocketPath      :: !SocketPath
   , consensusModeParams :: !ConsensusModeParams
   , networkId           :: !NetworkId
-  , allOrOnlyPoolIds    :: !(AllOrOnly [Hash StakePoolKey])
+  , allOrOnlyPoolIds    :: !(AllOrOnly (Hash StakePoolKey))
   } deriving (Generic, Show)
 
 data QueryTxMempoolCmdArgs = QueryTxMempoolCmdArgs

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs
@@ -2294,10 +2294,8 @@ pStakePoolVerificationKeyHash prefix =
     Opt.option (pBech32KeyHash AsStakePoolKey <|> pHexHash AsStakePoolKey) $ mconcat
       [ Opt.long $ prefixFlag prefix "stake-pool-id"
       , Opt.metavar "STAKE_POOL_ID"
-      , Opt.help $ mconcat
-          [ "Stake pool ID/verification key hash (either Bech32-encoded or hex-encoded).  "
-          , "Zero or more occurences of this option is allowed."
-          ]
+      , Opt.help
+         "Stake pool ID/verification key hash (either Bech32-encoded or hex-encoded)."
       ]
 
 pVrfVerificationKeyFile :: Parser (VerificationKeyFile In)

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs
@@ -189,15 +189,15 @@ pQueryProtocolStateCmd envCli =
       <*> pNetworkId envCli
       <*> pMaybeOutputFile
 
-pAllStakePoolsOrOnly :: Parser (AllOrOnly [Hash StakePoolKey])
-pAllStakePoolsOrOnly = pAll <|> pOnly
-  where pAll :: Parser (AllOrOnly [Hash StakePoolKey])
+pAllStakePoolsOrSome :: Parser (AllOrOnly (Hash StakePoolKey))
+pAllStakePoolsOrSome = pAll <|> pOnly
+  where pAll :: Parser (AllOrOnly (Hash StakePoolKey))
         pAll = Opt.flag' All $ mconcat
           [ Opt.long "all-stake-pools"
           , Opt.help "Query for all stake pools"
           ]
-        pOnly :: Parser (AllOrOnly [Hash StakePoolKey])
-        pOnly = Only <$> many (pStakePoolVerificationKeyHash Nothing)
+        pOnly :: Parser (AllOrOnly (Hash StakePoolKey))
+        pOnly = Only <$> some (pStakePoolVerificationKeyHash Nothing)
 
 pQueryStakeSnapshotCmd :: EnvCli -> Parser (QueryCmds era)
 pQueryStakeSnapshotCmd envCli =
@@ -206,7 +206,7 @@ pQueryStakeSnapshotCmd envCli =
       <$> pSocketPath envCli
       <*> pConsensusModeParams
       <*> pNetworkId envCli
-      <*> pAllStakePoolsOrOnly
+      <*> pAllStakePoolsOrSome
       <*> pMaybeOutputFile
 
 pQueryPoolStateCmd :: EnvCli -> Parser (QueryCmds era)
@@ -216,7 +216,7 @@ pQueryPoolStateCmd envCli =
       <$> pSocketPath envCli
       <*> pConsensusModeParams
       <*> pNetworkId envCli
-      <*> pAllStakePoolsOrOnly
+      <*> pAllStakePoolsOrSome
 
 pQueryTxMempoolCmd :: EnvCli -> Parser (QueryCmds era)
 pQueryTxMempoolCmd envCli =

diff --git a/cardano-cli/src/Cardano/CLI/Legacy/Commands/Query.hs b/cardano-cli/src/Cardano/CLI/Legacy/Commands/Query.hs
@@ -129,7 +129,7 @@ data LegacyQueryStakeSnapshotCmdArgs = LegacyQueryStakeSnapshotCmdArgs
   { nodeSocketPath      :: !SocketPath
   , consensusModeParams :: !ConsensusModeParams
   , networkId           :: !NetworkId
-  , allOrOnlyPoolIds    :: !(AllOrOnly [Hash StakePoolKey])
+  , allOrOnlyPoolIds    :: !(AllOrOnly (Hash StakePoolKey))
   , mOutFile            :: !(Maybe (File () Out))
   } deriving (Generic, Show)
 
@@ -145,7 +145,7 @@ data LegacyQueryPoolStateCmdArgs = LegacyQueryPoolStateCmdArgs
   { nodeSocketPath      :: !SocketPath
   , consensusModeParams :: !ConsensusModeParams
   , networkId           :: !NetworkId
-  , allOrOnlyPoolIds    :: !(AllOrOnly [Hash StakePoolKey])
+  , allOrOnlyPoolIds    :: !(AllOrOnly (Hash StakePoolKey))
   } deriving (Generic, Show)
 
 data LegacyQueryTxMempoolCmdArgs = LegacyQueryTxMempoolCmdArgs

diff --git a/cardano-cli/src/Cardano/CLI/Legacy/Options.hs b/cardano-cli/src/Cardano/CLI/Legacy/Options.hs
@@ -696,15 +696,15 @@ pQueryCmds envCli =
           <*> pNetworkId envCli
           <*> pMaybeOutputFile
 
-    pAllStakePoolsOrOnly :: Parser (AllOrOnly [Hash StakePoolKey])
+    pAllStakePoolsOrOnly :: Parser (AllOrOnly (Hash StakePoolKey))
     pAllStakePoolsOrOnly = pAll <|> pOnly
-      where pAll :: Parser (AllOrOnly [Hash StakePoolKey])
+      where pAll :: Parser (AllOrOnly (Hash StakePoolKey))
             pAll = Opt.flag' All $ mconcat
               [ Opt.long "all-stake-pools"
               , Opt.help "Query for all stake pools"
               ]
-            pOnly :: Parser (AllOrOnly [Hash StakePoolKey])
-            pOnly = Only <$> many (pStakePoolVerificationKeyHash Nothing)
+            pOnly :: Parser (AllOrOnly (Hash StakePoolKey))
+            pOnly = Only <$> some (pStakePoolVerificationKeyHash Nothing)
 
     pQueryStakeSnapshot :: Parser LegacyQueryCmds
     pQueryStakeSnapshot =

diff --git a/cardano-cli/src/Cardano/CLI/Types/Common.hs b/cardano-cli/src/Cardano/CLI/Types/Common.hs
@@ -291,7 +291,7 @@ data KeyOutputFormat
   | KeyOutputFormatBech32
   deriving (Eq, Show)
 
-data AllOrOnly a = All | Only a deriving (Eq, Show)
+data AllOrOnly a = All | Only [a] deriving (Eq, Show)
 
 -- | This data structure is used to allow nicely formatted output in the query pool-params command.
 -- params are the current pool parameter settings, futureparams are new parameters, retiringEpoch is the