Merge pull request #787 from IntersectMBO/smelc/remove-governance-in-…

…conway-governance-hash Move "conway governance hash" commands to "hash"
IntersectMBO · Jul 2, 2024 · 2006e3b · 2006e3b
2 parents c24a488 + fe71860
commit 2006e3b
Show file tree

Hide file tree

Showing 48 changed files with 355 additions and 378 deletions.
diff --git a/cardano-cli/cardano-cli.cabal b/cardano-cli/cardano-cli.cabal
@@ -56,6 +56,7 @@ library
                         Cardano.CLI.Byron.UpdateProposal
                         Cardano.CLI.Byron.Vote
                         Cardano.CLI.Commands
+                        Cardano.CLI.Commands.Hash
                         Cardano.CLI.Commands.Ping
                         Cardano.CLI.Commands.Debug
                         Cardano.CLI.Commands.Debug.LogEpochState
@@ -67,7 +68,6 @@ library
                         Cardano.CLI.EraBased.Commands.Governance.Actions
                         Cardano.CLI.EraBased.Commands.Governance.Committee
                         Cardano.CLI.EraBased.Commands.Governance.DRep
-                        Cardano.CLI.EraBased.Commands.Governance.Hash
                         Cardano.CLI.EraBased.Commands.Governance.Poll
                         Cardano.CLI.EraBased.Commands.Governance.Vote
                         Cardano.CLI.EraBased.Commands.Key
@@ -84,7 +84,6 @@ library
                         Cardano.CLI.EraBased.Options.Governance.Actions
                         Cardano.CLI.EraBased.Options.Governance.Committee
                         Cardano.CLI.EraBased.Options.Governance.DRep
-                        Cardano.CLI.EraBased.Options.Governance.Hash
                         Cardano.CLI.EraBased.Options.Governance.Poll
                         Cardano.CLI.EraBased.Options.Governance.Vote
                         Cardano.CLI.EraBased.Options.Key
@@ -103,7 +102,6 @@ library
                         Cardano.CLI.EraBased.Run.Governance.Actions
                         Cardano.CLI.EraBased.Run.Governance.Committee
                         Cardano.CLI.EraBased.Run.Governance.DRep
-                        Cardano.CLI.EraBased.Run.Governance.Hash
                         Cardano.CLI.EraBased.Run.Governance.GenesisKeyDelegationCertificate
                         Cardano.CLI.EraBased.Run.Governance.Poll
                         Cardano.CLI.EraBased.Run.Governance.Vote
@@ -143,6 +141,7 @@ library
                         Cardano.CLI.Legacy.Run.Transaction
                         Cardano.CLI.Options
                         Cardano.CLI.Options.Debug
+                        Cardano.CLI.Options.Hash
                         Cardano.CLI.Options.Ping
                         Cardano.CLI.Orphans
                         Cardano.CLI.OS.Posix
@@ -153,6 +152,7 @@ library
                         Cardano.CLI.Run
                         Cardano.CLI.Run.Debug
                         Cardano.CLI.Run.Debug.LogEpochState
+                        Cardano.CLI.Run.Hash
                         Cardano.CLI.Run.Ping
                         Cardano.CLI.TopHandler
                         Cardano.CLI.Types.Common
@@ -167,9 +167,9 @@ library
                         Cardano.CLI.Types.Errors.GovernanceActionsError
                         Cardano.CLI.Types.Errors.GovernanceCmdError
                         Cardano.CLI.Types.Errors.GovernanceCommitteeError
-                        Cardano.CLI.Types.Errors.GovernanceHashError
                         Cardano.CLI.Types.Errors.GovernanceQueryError
                         Cardano.CLI.Types.Errors.GovernanceVoteCmdError
+                        Cardano.CLI.Types.Errors.HashCmdError
                         Cardano.CLI.Types.Errors.ItnKeyConversionError
                         Cardano.CLI.Types.Errors.KeyCmdError
                         Cardano.CLI.Types.Errors.NodeCmdError
@@ -334,6 +334,7 @@ test-suite cardano-cli-test
                         Test.Cli.Pioneers.Exercise6
                         Test.Cli.Pipes
                         Test.Cli.VerificationKey
+                        Test.Cli.Shelley.Run.Hash
                         Test.Cli.Shelley.Run.Query
                         Test.Cli.Shelley.Transaction.Build
 
@@ -394,9 +395,9 @@ test-suite cardano-cli-golden
                         Test.Golden.Governance.Action
                         Test.Golden.Governance.Committee
                         Test.Golden.Governance.DRep
-                        Test.Golden.Governance.Hash
                         Test.Golden.Governance.StakeAddress
                         Test.Golden.Governance.Vote
+                        Test.Golden.Hash.Hash
                         Test.Golden.Help
                         Test.Golden.Key.NonExtendedKey
                         Test.Golden.Shelley.Address.Build

diff --git a/cardano-cli/src/Cardano/CLI/Commands.hs b/cardano-cli/src/Cardano/CLI/Commands.hs
@@ -6,6 +6,7 @@ module Cardano.CLI.Commands
 
 import           Cardano.CLI.Byron.Commands (ByronCommand)
 import           Cardano.CLI.Commands.Debug
+import           Cardano.CLI.Commands.Hash (HashCmds)
 import           Cardano.CLI.Commands.Ping (PingCmd (..))
 import           Cardano.CLI.EraBased.Commands
 import           Cardano.CLI.Legacy.Commands
@@ -19,6 +20,9 @@ data ClientCommand =
     -- | Byron Related Commands
   | ByronCommand ByronCommand
 
+    -- | Era-agnostic hashing commands
+  | HashCmds HashCmds
+
     -- | Legacy shelley-based Commands
   | LegacyCmds LegacyCmds
 

diff --git a/cardano-cli/src/Cardano/CLI/Commands/Hash.hs b/cardano-cli/src/Cardano/CLI/Commands/Hash.hs
@@ -0,0 +1,44 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE LambdaCase #-}
+
+module Cardano.CLI.Commands.Hash
+  ( HashCmds (..)
+  , HashAnchorDataCmdArgs (..)
+  , HashScriptCmdArgs (..)
+  , AnchorDataHashSource (..)
+  , renderHashCmds
+  ) where
+
+import           Cardano.Api
+
+import           Cardano.CLI.Types.Common
+
+import           Data.Text (Text)
+
+data HashCmds
+  = HashAnchorDataCmd !HashAnchorDataCmdArgs
+  | HashScriptCmd !HashScriptCmdArgs
+
+data HashAnchorDataCmdArgs
+  = HashAnchorDataCmdArgs {
+      toHash  :: !AnchorDataHashSource
+    , mOutFile :: !(Maybe (File () Out)) -- ^ The output file to which the hash is written
+  } deriving Show
+
+data AnchorDataHashSource
+  = AnchorDataHashSourceBinaryFile (File ProposalBinary In)
+  | AnchorDataHashSourceTextFile (File ProposalText In)
+  | AnchorDataHashSourceText Text
+  deriving Show
+
+data HashScriptCmdArgs
+  = HashScriptCmdArgs {
+      toHash  ::  !ScriptFile
+    , mOutFile :: !(Maybe (File () Out)) -- ^ The output file to which the hash is written
+  } deriving Show
+
+renderHashCmds :: HashCmds -> Text
+renderHashCmds = \case
+  HashAnchorDataCmd {} -> "hash anchor-data"
+  HashScriptCmd {} -> "hash script"
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Commands/Governance.hs b/cardano-cli/src/Cardano/CLI/EraBased/Commands/Governance.hs
@@ -14,7 +14,6 @@ import           Cardano.Api.Shelley (VrfKey)
 import           Cardano.CLI.EraBased.Commands.Governance.Actions
 import           Cardano.CLI.EraBased.Commands.Governance.Committee
 import           Cardano.CLI.EraBased.Commands.Governance.DRep
-import           Cardano.CLI.EraBased.Commands.Governance.Hash
 import           Cardano.CLI.EraBased.Commands.Governance.Poll
 import           Cardano.CLI.EraBased.Commands.Governance.Vote
 import           Cardano.CLI.Types.Key (VerificationKeyOrHashOrFile)
@@ -48,8 +47,6 @@ data GovernanceCmds era
       (GovernanceCommitteeCmds era)
   | GovernanceDRepCmds
       (GovernanceDRepCmds era)
-  | GovernanceHashCmds
-      (GovernanceHashCmds era)
   | GovernancePollCmds
       (GovernancePollCmds era)
   | GovernanceVoteCmds
@@ -71,8 +68,6 @@ renderGovernanceCmds = \case
     renderGovernanceCommitteeCmds cmds
   GovernanceDRepCmds cmds ->
     renderGovernanceDRepCmds cmds
-  GovernanceHashCmds cmds ->
-    renderGovernanceHashCmds cmds
   GovernancePollCmds cmds ->
     renderGovernancePollCmds cmds
   GovernanceVoteCmds cmds ->

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Commands/Governance/Hash.hs b/cardano-cli/src/Cardano/CLI/EraBased/Commands/Governance/Hash.hs
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs
@@ -642,7 +642,7 @@ pAddCommitteeColdVerificationKeySource =
     , VkhfshScriptHash <$>
         pScriptHash
           "add-cc-cold-script-hash"
-          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
     ]
 
 pAddCommitteeColdVerificationKeyHash :: Parser (Hash CommitteeColdKey)
@@ -698,7 +698,7 @@ pRemoveCommitteeColdVerificationKeySource =
     , VkhfshScriptHash <$>
         pScriptHash
           "remove-cc-cold-script-hash"
-          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
     ]
 
 pScriptHash
@@ -920,7 +920,7 @@ pCommitteeHotVerificationKeyOrHashOrVerificationFileOrScriptHash =
     , VkhfshScriptHash <$>
         pScriptHash
           "cc-hot-script-hash"
-          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
     ]
 
 catCommands :: [Parser a] -> Maybe (Parser a)
@@ -3233,13 +3233,13 @@ pDRepScriptHash :: Parser ScriptHash
 pDRepScriptHash =
   pScriptHash
     "drep-script-hash"
-    "DRep script hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+    "DRep script hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
 
 pConstitutionScriptHash :: Parser ScriptHash
 pConstitutionScriptHash =
   pScriptHash
     "constitution-script-hash"
-    "Constitution script hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+    "Constitution script hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
 
 pDRepVerificationKeyOrHashOrFile
   :: Parser (VerificationKeyOrHashOrFile DRepKey)
@@ -3257,7 +3257,7 @@ pDRepVerificationKeyOrHashOrFileOrScriptHash =
     , VkhfshScriptHash <$>
         pScriptHash
           "drep-script-hash"
-          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+          "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
     ]
 
 pAllOrOnlyDRepHashSource

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Governance.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Governance.hs
@@ -14,7 +14,6 @@ import           Cardano.CLI.EraBased.Options.Common
 import           Cardano.CLI.EraBased.Options.Governance.Actions
 import           Cardano.CLI.EraBased.Options.Governance.Committee
 import           Cardano.CLI.EraBased.Options.Governance.DRep
-import           Cardano.CLI.EraBased.Options.Governance.Hash
 import           Cardano.CLI.EraBased.Options.Governance.Poll
 import           Cardano.CLI.EraBased.Options.Governance.Vote
 
@@ -37,7 +36,6 @@ pGovernanceCmds era =
     , fmap GovernanceActionCmds       <$> pGovernanceActionCmds era
     , fmap GovernanceCommitteeCmds    <$> pGovernanceCommitteeCmds era
     , fmap GovernanceDRepCmds         <$> pGovernanceDRepCmds era
-    , fmap GovernanceHashCmds         <$> pGovernanceHashCmds era
     , fmap GovernancePollCmds         <$> pGovernancePollCmds era
     , fmap GovernanceVoteCmds         <$> pGovernanceVoteCmds era
     ]

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Governance/Committee.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Governance/Committee.hs
@@ -145,7 +145,7 @@ pColdCredential =
     , VksScriptHash <$>
         pScriptHash
           "cold-script-hash"
-          "Committee cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+          "Committee cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
     , VksScript <$> pScriptFor "cold-script-file" Nothing "Cold Native or Plutus script file"
     ]
 

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Governance/Hash.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Governance/Hash.hs
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs
@@ -428,7 +428,7 @@ pQueryGetCommitteeStateCmd era envCli = do
         , VkhfshScriptHash <$>
             pScriptHash
               "cold-script-hash"
-              "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+              "Cold Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
         ]
 
     pCommitteeHotKeyOrHashOrFileOrScriptHash :: Parser (VerificationKeyOrHashOrFileOrScriptHash CommitteeHotKey)
@@ -438,7 +438,7 @@ pQueryGetCommitteeStateCmd era envCli = do
         , VkhfshScriptHash <$>
             pScriptHash
               "hot-script-hash"
-              "Hot Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli conway governance hash script ...\"."
+              "Hot Native or Plutus script file hash (hex-encoded). Obtain it with \"cardano-cli hash script ...\"."
         ]
 
     pMemberStatus :: Parser MemberStatus