Merge pull request #1160 from IntersectMBO/newhoggy/standardise-bech32-hex-output-flag

Standardise bech32 hex output flag

Author: newhoggy

cardano-cli/src/Cardano/CLI/EraBased/Common/Option.hs

@@ -1785,14 +1785,27 @@ pKeyOutputFormat =
 
 pPoolIdOutputFormat :: Parser (Vary [FormatBech32, FormatHex])
 pPoolIdOutputFormat =
+  asum
+    [ pFormatFlags
+        "pool-id output"
+        [ flagFormatBech32 & setDefault
+        , flagFormatHex
+        ]
+    , pDeprecatedPoolIdOutputFormat
+    ]
+
+pDeprecatedPoolIdOutputFormat :: Parser (Vary [FormatBech32, FormatHex])
+pDeprecatedPoolIdOutputFormat =
   Opt.option readIdOutputFormat $
     mconcat
       [ Opt.long "output-format"
       , Opt.metavar "STRING"
+      , Opt.hidden
       , Opt.help $
           mconcat
             [ "Optional pool id output format. Accepted output formats are \"hex\" "
-            , "and \"bech32\" (default is \"bech32\")."
+            , "and \"bech32\" (default is \"bech32\").  The --output-format flag is "
+            , "deprecated and will be removed in a future version."
             ]
       , Opt.value (Vary.from FormatBech32)
       ]
@@ -1848,12 +1861,24 @@ flagKeyOutputTextEnvelope
 flagKeyOutputTextEnvelope =
   mkFlag "key-output-text-envelope" "TEXT_ENVELOPE" FormatTextEnvelope
 
+flagFormatBech32
+  :: FormatBech32 :| fs
+  => Flag (Vary fs)
+flagFormatBech32 =
+  mkFlag "output-bech32" "BECH32" FormatBech32
+
 flagFormatCbor
   :: FormatCbor :| fs
   => Flag (Vary fs)
 flagFormatCbor =
   mkFlag "output-cbor" "BASE16 CBOR" FormatCbor
 
+flagFormatHex
+  :: FormatHex :| fs
+  => Flag (Vary fs)
+flagFormatHex =
+  mkFlag "output-hex" "HEX" FormatHex
+
 flagFormatJson
   :: FormatJson :| fs
   => Flag (Vary fs)

cardano-cli/test/cardano-cli-golden/files/golden/help.cli

@@ -2600,7 +2600,7 @@ Usage: cardano-cli conway stake-pool id
                                           | --stake-pool-verification-extended-key STRING
                                           | --cold-verification-key-file FILEPATH
                                           )
-                                          [--output-format STRING]
+                                          [--output-bech32 | --output-hex]
                                           [--out-file FILEPATH]
 
   Build pool id from the offline key
@@ -4833,7 +4833,7 @@ Usage: cardano-cli latest stake-pool id
                                           | --stake-pool-verification-extended-key STRING
                                           | --cold-verification-key-file FILEPATH
                                           )
-                                          [--output-format STRING]
+                                          [--output-bech32 | --output-hex]
                                           [--out-file FILEPATH]
 
   Build pool id from the offline key

cardano-cli/test/cardano-cli-golden/files/golden/help/conway_stake-pool_id.cli

@@ -3,7 +3,7 @@ Usage: cardano-cli conway stake-pool id
                                           | --stake-pool-verification-extended-key STRING
                                           | --cold-verification-key-file FILEPATH
                                           )
-                                          [--output-format STRING]
+                                          [--output-bech32 | --output-hex]
                                           [--out-file FILEPATH]
 
   Build pool id from the offline key
@@ -16,7 +16,11 @@ Available options:
                            hex-encoded).
   --cold-verification-key-file FILEPATH
                            Filepath of the stake pool verification key.
+  --output-bech32          Format pool-id output to BECH32 (default).
+  --output-hex             Format pool-id output to HEX.
   --output-format STRING   Optional pool id output format. Accepted output
                            formats are "hex" and "bech32" (default is "bech32").
+                           The --output-format flag is deprecated and will be
+                           removed in a future version.
   --out-file FILEPATH      Optional output file. Default is to write to stdout.
   -h,--help                Show this help text

cardano-cli/test/cardano-cli-golden/files/golden/help/latest_stake-pool_id.cli

@@ -3,7 +3,7 @@ Usage: cardano-cli latest stake-pool id
                                           | --stake-pool-verification-extended-key STRING
                                           | --cold-verification-key-file FILEPATH
                                           )
-                                          [--output-format STRING]
+                                          [--output-bech32 | --output-hex]
                                           [--out-file FILEPATH]
 
   Build pool id from the offline key
@@ -16,7 +16,11 @@ Available options:
                            hex-encoded).
   --cold-verification-key-file FILEPATH
                            Filepath of the stake pool verification key.
+  --output-bech32          Format pool-id output to BECH32 (default).
+  --output-hex             Format pool-id output to HEX.
   --output-format STRING   Optional pool id output format. Accepted output
                            formats are "hex" and "bech32" (default is "bech32").
+                           The --output-format flag is deprecated and will be
+                           removed in a future version.
   --out-file FILEPATH      Optional output file. Default is to write to stdout.
   -h,--help                Show this help text