Use more meaningful (phantom) types for files around governance comma…

…nds.
CardanoSolutions · Apr 25, 2023 · 0929d04 · 0929d04
1 parent 5ba4ef7
commit 0929d04
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/cardano-cli/src/Cardano/CLI/Shelley/Commands.hs b/cardano-cli/src/Cardano/CLI/Shelley/Commands.hs
@@ -415,7 +415,7 @@ data GovernanceCmd
       (Maybe Word) -- Answer index
   | GovernanceVerifyPoll
       FilePath -- Poll file
-      FilePath -- Tx file
+      TxFile -- Tx file
   deriving Show
 
 renderGovernanceCmd :: GovernanceCmd -> Text

diff --git a/cardano-cli/src/Cardano/CLI/Shelley/Parsers.hs b/cardano-cli/src/Cardano/CLI/Shelley/Parsers.hs
@@ -1124,7 +1124,7 @@ pGovernanceCmd =
     pGovernanceVerifyPoll =
       GovernanceVerifyPoll
         <$> pPollFile
-        <*> pTxFileIn
+        <*> pPollTxFile
 
 
 pPollQuestion :: Parser Text
@@ -1160,6 +1160,15 @@ pPollFile =
     <> Opt.completer (Opt.bashCompleter "file")
     )
 
+pPollTxFile :: Parser TxFile
+pPollTxFile =
+  fmap TxFile $ Opt.strOption $ mconcat
+    [ Opt.long "signed-tx-file"
+    , Opt.metavar "FILE"
+    , Opt.help "Filepath to a signed transaction carrying a valid poll answer."
+    , Opt.completer (Opt.bashCompleter "file")
+    ]
+
 pPollNonce :: Parser Word
 pPollNonce =
   Opt.option auto

diff --git a/cardano-cli/src/Cardano/CLI/Shelley/Run/Governance.hs b/cardano-cli/src/Cardano/CLI/Shelley/Run/Governance.hs
@@ -252,6 +252,7 @@ runGovernanceCreatePoll govPollQuestion govPollAnswers govPollNonce (OutputFile
 
 runGovernanceAnswerPoll
   :: FilePath
+    -- ^ Poll file
   -> Maybe Word
     -- ^ Answer index
   -> ExceptT ShelleyGovernanceCmdError IO ()
@@ -318,9 +319,11 @@ runGovernanceAnswerPoll pollFile maybeChoice = do
 
 runGovernanceVerifyPoll
   :: FilePath
-  -> FilePath
+    -- ^ Poll file
+  -> TxFile
+    -- ^ Signed transaction (answer) file
   -> ExceptT ShelleyGovernanceCmdError IO ()
-runGovernanceVerifyPoll pollFile txFile = do
+runGovernanceVerifyPoll pollFile (TxFile txFile) = do
   poll <- firstExceptT ShelleyGovernanceCmdTextEnvReadError . newExceptT $
     readFileTextEnvelope AsGovernancePoll pollFile