Merge pull request #982 from IntersectMBO/move-genesis-hash-to-hash-g…

…roup Move `genesis hash` to `hash genesis-file`
IntersectMBO · Jan 7, 2025 · 0067de6 · 0067de6
2 parents 7963292 + 5a31b7e
commit 0067de6
Show file tree

Hide file tree

Showing 25 changed files with 138 additions and 31 deletions.
diff --git a/cardano-cli/src/Cardano/CLI/Commands/Hash.hs b/cardano-cli/src/Cardano/CLI/Commands/Hash.hs
@@ -1,4 +1,5 @@
 {-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE DuplicateRecordFields #-}
 {-# LANGUAGE LambdaCase #-}
 
@@ -22,6 +23,7 @@ import           Data.Text (Text)
 data HashCmds
   = HashAnchorDataCmd !HashAnchorDataCmdArgs
   | HashScriptCmd !HashScriptCmdArgs
+  | HashGenesisFile !GenesisFile
 
 data HashGoal hash
   = -- | The hash is written to stdout
@@ -58,3 +60,4 @@ renderHashCmds :: HashCmds -> Text
 renderHashCmds = \case
   HashAnchorDataCmd{} -> "hash anchor-data"
   HashScriptCmd{} -> "hash script"
+  HashGenesisFile{} -> "hash genesis-file"
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Genesis.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Genesis.hs
@@ -103,7 +103,13 @@ pGenesisCmds era envCli =
     , Just $
         subParser "hash" $
           Opt.info pGenesisHash $
-            Opt.progDesc "Compute the hash of a genesis file"
+            Opt.progDesc $
+              mconcat
+                [ "DEPRECATION WARNING! This command is deprecated and will be "
+                , "removed in a future release. Please use hash genesis-file "
+                , "instead. "
+                , "Compute the hash of a genesis file."
+                ]
     ]
 
 pGenesisKeyGen :: Parser (GenesisCmds era)

diff --git a/cardano-cli/src/Cardano/CLI/Legacy/Options.hs b/cardano-cli/src/Cardano/CLI/Legacy/Options.hs
@@ -173,7 +173,13 @@ pGenesisCmds envCli =
               ]
     , subParser "hash" $
         Opt.info pGenesisHash $
-          Opt.progDesc "Compute the hash of a genesis file"
+          Opt.progDesc $
+            unlines
+              [ "DEPRECATION WARNING! This command is deprecated and will be "
+              , "removed in a future release. Please use hash genesis-file "
+              , "instead. "
+              , "Compute the hash of a genesis file."
+              ]
     ]
  where
   pGenesisKeyGen :: Parser LegacyGenesisCmds

diff --git a/cardano-cli/src/Cardano/CLI/Options/Hash.hs b/cardano-cli/src/Cardano/CLI/Options/Hash.hs
@@ -20,7 +20,7 @@ pHashCmds :: Parser Cmd.HashCmds
 pHashCmds =
   subParser "hash" $
     Opt.info
-      (asum [pHashAnchorDataCmd, pHashScriptCmd])
+      (asum [pHashAnchorDataCmd, pHashScriptCmd, pHashGenesisHashCmd])
       ( Opt.progDesc $
           mconcat
             [ "Compute the hash to pass to the various --*-hash arguments of commands."
@@ -79,3 +79,13 @@ pHashScriptCmd = do
           )
       )
     $ Opt.progDesc "Compute the hash of a script (to then pass it to other commands)."
+
+pHashGenesisHashCmd :: Parser Cmd.HashCmds
+pHashGenesisHashCmd =
+  subParser "genesis-file" $
+    Opt.info pGenesisHash $
+      Opt.progDesc "Compute the hash of a genesis file."
+
+pGenesisHash :: Parser Cmd.HashCmds
+pGenesisHash =
+  Cmd.HashGenesisFile <$> pGenesisFile "The genesis file."
diff --git a/cardano-cli/src/Cardano/CLI/Run/Hash.hs b/cardano-cli/src/Cardano/CLI/Run/Hash.hs
@@ -21,11 +21,12 @@ import qualified Cardano.Api.Ledger as L
 import qualified Cardano.CLI.Commands.Hash as Cmd
 import           Cardano.CLI.Parser (stringToAnchorScheme)
 import           Cardano.CLI.Read
-import           Cardano.CLI.Types.Common (AnchorScheme (..), MustCheckHash (..),
+import           Cardano.CLI.Types.Common (AnchorScheme (..), GenesisFile (..), MustCheckHash (..),
                    PotentiallyCheckedAnchor (..), SupportedSchemes)
 import           Cardano.CLI.Types.Errors.HashCmdError
 import           Cardano.Crypto.Hash (hashToTextAsHex)
-import           Cardano.Prelude (first)
+import qualified Cardano.Crypto.Hash as Crypto
+import           Cardano.Prelude (ByteString, first)
 
 import           Control.Exception (throw)
 import           Control.Monad (when)
@@ -55,6 +56,7 @@ runHashCmds
 runHashCmds = \case
   Cmd.HashAnchorDataCmd args -> runHashAnchorDataCmd args
   Cmd.HashScriptCmd args -> runHashScriptCmd args
+  Cmd.HashGenesisFile args -> runHashGenesisFile args
 
 runHashAnchorDataCmd
   :: ()
@@ -217,3 +219,12 @@ carryHashChecks potentiallyCheckedAnchor =
     TrustHash -> pure ()
  where
   anchor = pcaAnchor potentiallyCheckedAnchor
+
+runHashGenesisFile :: GenesisFile -> ExceptT HashCmdError IO ()
+runHashGenesisFile (GenesisFile fpath) = do
+  content <-
+    handleIOExceptT (HashGenesisCmdGenesisFileError . FileIOError fpath) $
+      BS.readFile fpath
+  let gh :: Crypto.Hash Crypto.Blake2b_256 ByteString
+      gh = Crypto.hashWith id content
+  liftIO $ Text.putStrLn (Crypto.hashToTextAsHex gh)
diff --git a/cardano-cli/src/Cardano/CLI/Types/Errors/HashCmdError.hs b/cardano-cli/src/Cardano/CLI/Types/Errors/HashCmdError.hs
@@ -27,6 +27,7 @@ data HashCmdError
   | HashWriteFileError !(FileError ())
   | HashReadScriptError !FilePath !(FileError ScriptDecodeError)
   | HashFetchURLError !FetchURLError
+  | HashGenesisCmdGenesisFileError !(FileError ())
   deriving Show
 
 instance Error HashCmdError where
@@ -45,6 +46,8 @@ instance Error HashCmdError where
       "Cannot read script at" <+> pretty filepath <> ":" <+> prettyError err
     HashFetchURLError fetchErr ->
       pretty (displayException fetchErr)
+    HashGenesisCmdGenesisFileError fe ->
+      prettyError fe
 
 data FetchURLError
   = FetchURLInvalidURLError !String

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli
@@ -667,7 +667,9 @@ Usage: cardano-cli legacy genesis create-staked
 
 Usage: cardano-cli legacy genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli byron 
                            ( key
@@ -1195,7 +1197,9 @@ Usage: cardano-cli shelley genesis create-staked [--key-output-format STRING]
 
 Usage: cardano-cli shelley genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli shelley governance 
                                         ( create-mir-certificate
@@ -2244,7 +2248,9 @@ Usage: cardano-cli allegra genesis create-staked [--key-output-format STRING]
 
 Usage: cardano-cli allegra genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli allegra governance 
                                         ( create-mir-certificate
@@ -3291,7 +3297,9 @@ Usage: cardano-cli mary genesis create-staked [--key-output-format STRING]
 
 Usage: cardano-cli mary genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli mary governance 
                                      ( create-mir-certificate
@@ -4330,7 +4338,9 @@ Usage: cardano-cli alonzo genesis create-staked [--key-output-format STRING]
 
 Usage: cardano-cli alonzo genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli alonzo governance 
                                        ( create-mir-certificate
@@ -5406,7 +5416,9 @@ Usage: cardano-cli babbage genesis create-testnet-data [--spec-shelley FILEPATH]
 
 Usage: cardano-cli babbage genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli babbage governance 
                                         ( create-mir-certificate
@@ -6762,7 +6774,9 @@ Usage: cardano-cli conway genesis create-testnet-data [--spec-shelley FILEPATH]
 
 Usage: cardano-cli conway genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli conway governance (action | committee | drep | vote)
 
@@ -8780,7 +8794,9 @@ Usage: cardano-cli latest genesis create-testnet-data [--spec-shelley FILEPATH]
 
 Usage: cardano-cli latest genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Usage: cardano-cli latest governance (action | committee | drep | vote)
 
@@ -10525,7 +10541,7 @@ Usage: cardano-cli latest transaction txid
 
   Print a transaction identifier.
 
-Usage: cardano-cli hash (anchor-data | script)
+Usage: cardano-cli hash (anchor-data | script | genesis-file)
 
   Compute the hash to pass to the various --*-hash arguments of commands.
 
@@ -10545,6 +10561,10 @@ Usage: cardano-cli hash script --script-file FILEPATH [--out-file FILEPATH]
 
   Compute the hash of a script (to then pass it to other commands).
 
+Usage: cardano-cli hash genesis-file --genesis FILEPATH
+
+  Compute the hash of a genesis file.
+
 Usage: cardano-cli ping [-c|--count COUNT]
                           ((-h|--host HOST) | (-u|--unixsock SOCKET))
                           [-p|--port PORT]

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_genesis.cli
@@ -34,4 +34,7 @@ Available commands:
                            and genesis/delegation/spending keys.
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli allegra genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_genesis.cli
@@ -34,4 +34,7 @@ Available commands:
                            and genesis/delegation/spending keys.
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli alonzo genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_genesis.cli
@@ -36,4 +36,7 @@ Available commands:
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
   create-testnet-data      Create data to use for starting a testnet.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli babbage genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_genesis.cli
@@ -36,4 +36,7 @@ Available commands:
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
   create-testnet-data      Create data to use for starting a testnet.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli conway genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/hash.cli
@@ -1,4 +1,4 @@
-Usage: cardano-cli hash (anchor-data | script)
+Usage: cardano-cli hash (anchor-data | script | genesis-file)
 
   Compute the hash to pass to the various --*-hash arguments of commands.
 
@@ -10,3 +10,4 @@ Available commands:
                            to other commands).
   script                   Compute the hash of a script (to then pass it to
                            other commands).
+  genesis-file             Compute the hash of a genesis file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/hash_genesis-file.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/hash_genesis-file.cli
@@ -0,0 +1,7 @@
+Usage: cardano-cli hash genesis-file --genesis FILEPATH
+
+  Compute the hash of a genesis file.
+
+Available options:
+  --genesis FILEPATH       The genesis file.
+  -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_genesis.cli
@@ -36,4 +36,7 @@ Available commands:
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
   create-testnet-data      Create data to use for starting a testnet.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli latest genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/legacy_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/legacy_genesis.cli
@@ -34,4 +34,7 @@ Available commands:
                            and genesis/delegation/spending keys.
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/legacy_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/legacy_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli legacy genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/mary_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/mary_genesis.cli
@@ -34,4 +34,7 @@ Available commands:
                            and genesis/delegation/spending keys.
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/mary_genesis_hash.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/mary_genesis_hash.cli
@@ -1,6 +1,8 @@
 Usage: cardano-cli mary genesis hash --genesis FILEPATH
 
-  Compute the hash of a genesis file
+  DEPRECATION WARNING! This command is deprecated and will be removed in a
+  future release. Please use hash genesis-file instead. Compute the hash of a
+  genesis file.
 
 Available options:
   --genesis FILEPATH       The genesis file.

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/shelley_genesis.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/shelley_genesis.cli
@@ -34,4 +34,7 @@ Available commands:
                            and genesis/delegation/spending keys.
   create-staked            Create a staked Shelley genesis file from a genesis
                            template and genesis/delegation/spending keys.
-  hash                     Compute the hash of a genesis file
+  hash                     DEPRECATION WARNING! This command is deprecated and
+                           will be removed in a future release. Please use hash
+                           genesis-file instead. Compute the hash of a genesis
+                           file.