Add "cip" sub command

Add "cip-126" sub commands

Add cip-129 encoding functions

Add functions to read committee cold keys, governance action ids, hot keys and drep keys

Update Bech32 errors

Update "governance drep id" command to also output the cip-129 format

Implement Cardano.CLI.EraIndependent.Cip.Common

Misc changes

Update golden files

REMOVE ME

Incorporate Vary

Update golden files

Author: Jimbo4350

cabal.project

@@ -74,3 +74,8 @@ if impl (ghc >= 9.12)
     -- https://github.com/kapralVV/Unique/issues/11
     , Unique:hashable
 
+source-repository-package
+  type: git 
+  location: https://github.com/IntersectMBO/cardano-api.git
+  tag: 180129463ef6fb1942883fa9058e3cb34eef160f
+  subdir: cardano-api

cardano-cli/cardano-cli.cabal

@@ -142,6 +142,14 @@ library
     Cardano.CLI.EraIndependent.Address.Info.Run
     Cardano.CLI.EraIndependent.Address.Option
     Cardano.CLI.EraIndependent.Address.Run
+    Cardano.CLI.EraIndependent.Cip.Cip129.Command
+    Cardano.CLI.EraIndependent.Cip.Cip129.Conversion
+    Cardano.CLI.EraIndependent.Cip.Cip129.Options
+    Cardano.CLI.EraIndependent.Cip.Cip129.Run
+    Cardano.CLI.EraIndependent.Cip.Command
+    Cardano.CLI.EraIndependent.Cip.Common
+    Cardano.CLI.EraIndependent.Cip.Options
+    Cardano.CLI.EraIndependent.Cip.Run
     Cardano.CLI.EraIndependent.Debug.CheckNodeConfiguration.Command
     Cardano.CLI.EraIndependent.Debug.CheckNodeConfiguration.Run
     Cardano.CLI.EraIndependent.Debug.Command
@@ -181,6 +189,10 @@ library
     Cardano.CLI.Orphan
     Cardano.CLI.Parser
     Cardano.CLI.Read
+    Cardano.CLI.Read.Committee.ColdKey
+    Cardano.CLI.Read.Committee.HotKey 
+    Cardano.CLI.Read.DRep
+    Cardano.CLI.Read.GovernanceActionId
     Cardano.CLI.Render
     Cardano.CLI.Run
     Cardano.CLI.Run.Mnemonic
@@ -287,6 +299,7 @@ library
     transformers-except ^>=0.1.3,
     unliftio-core,
     utf8-string,
+    validation,
     vary ^>=0.1.1.2,
     vector,
     yaml,

cardano-cli/src/Cardano/CLI/Command.hs

@@ -10,6 +10,7 @@ import Cardano.CLI.Compatible.Command
 import Cardano.CLI.EraBased.Command
 import Cardano.CLI.EraBased.Query.Command
 import Cardano.CLI.EraIndependent.Address.Command
+import Cardano.CLI.EraIndependent.Cip.Command (CipFormatCmds)
 import Cardano.CLI.EraIndependent.Debug.Command
 import Cardano.CLI.EraIndependent.Hash.Command (HashCmds)
 import Cardano.CLI.EraIndependent.Key.Command
@@ -37,6 +38,8 @@ data ClientCommand
     forall era. QueryCommands (QueryCmds era)
   | -- | Legacy shelley-based Commands
     LegacyCmds LegacyCmds
+  | -- | Miscellaneous commands
+    CipFormatCmds CipFormatCmds
   | CliPingCommand PingCmd
   | CliDebugCmds DebugCmds
   | forall a. Help ParserPrefs (ParserInfo a)

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

@@ -1830,12 +1830,30 @@ pFormatFlags content =
       , "."
       ]
 
+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
 
+flagFormatCip129
+  :: FormatCip129 :| fs
+  => Flag (Vary fs)
+flagFormatCip129 =
+  mkFlag "output-cip129" "CIP-129" FormatCip129
+
+flagFormatHex
+  :: FormatHex :| fs
+  => Flag (Vary fs)
+flagFormatHex =
+  mkFlag "output-hex" "BASE16" FormatHex
+
 flagFormatJson
   :: FormatJson :| fs
   => Flag (Vary fs)
@@ -1996,6 +2014,7 @@ pKesVerificationKey =
       Left err@(Bech32DataPartToBytesError _) -> Left (docToString $ prettyError err)
       Left err@(Bech32DeserialiseFromBytesError _) -> Left (docToString $ prettyError err)
       Left err@(Bech32WrongPrefix _ _) -> Left (docToString $ prettyError err)
+      Left err@(Bech32UnexpectedHeader _ _) -> Left (docToString $ prettyError err)
       -- The input was not valid Bech32. Attempt to deserialise it as hex.
       Left (Bech32DecodingError _) ->
         first

cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Command.hs

@@ -1,5 +1,6 @@
 {-# LANGUAGE DataKinds #-}
 {-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE GADTs #-}
 {-# LANGUAGE LambdaCase #-}
 
 module Cardano.CLI.EraBased.Governance.DRep.Command
@@ -24,6 +25,8 @@ import Cardano.CLI.Type.Key
 
 import Data.Text (Text)
 
+import Vary (Vary)
+
 data GovernanceDRepCmds era
   = GovernanceDRepKeyGenCmd !(GovernanceDRepKeyGenCmdArgs era)
   | GovernanceDRepIdCmd !(GovernanceDRepIdCmdArgs era)
@@ -43,7 +46,7 @@ data GovernanceDRepIdCmdArgs era
   = GovernanceDRepIdCmdArgs
   { eon :: !(ConwayEraOnwards era)
   , vkeySource :: !(VerificationKeyOrHashOrFile DRepKey)
-  , idOutputFormat :: !IdOutputFormat
+  , idOutputFormat :: !(Vary [FormatHex, FormatBech32, FormatCip129])
   , mOutFile :: !(Maybe (File () Out))
   }
 

cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Option.hs

@@ -14,12 +14,13 @@ import Cardano.Api.Shelley (Hash (DRepMetadataHash))
 import Cardano.CLI.EraBased.Common.Option
 import Cardano.CLI.EraBased.Governance.DRep.Command
 import Cardano.CLI.EraIndependent.Hash.Command (HashGoal (..))
+import Cardano.CLI.Option.Flag
 import Cardano.CLI.Parser
 import Cardano.CLI.Read
-import Cardano.CLI.Type.Common hiding (CheckHash)
 
 import Control.Applicative (Alternative ((<|>)), optional)
 import Data.Foldable (asum)
+import Data.Function
 import Options.Applicative (Parser)
 import Options.Applicative qualified as Opt
 
@@ -73,27 +74,16 @@ pGovernanceDRepKeyIdCmd era = do
       ( fmap GovernanceDRepIdCmd $
           GovernanceDRepIdCmdArgs w
             <$> pDRepVerificationKeyOrHashOrFile
-            <*> pDRepIdOutputFormat
+            <*> pFormatFlags
+              "drep id output"
+              [ flagFormatHex
+              , flagFormatBech32 & setDefault
+              , flagFormatCip129
+              ]
             <*> optional pOutputFile
       )
     $ Opt.progDesc "Generate a drep id."
 
-pDRepIdOutputFormat :: Parser IdOutputFormat
-pDRepIdOutputFormat =
-  asum [make IdOutputFormatHex "hex", make IdOutputFormatBech32 "bech32"]
-    <|> pure default_
- where
-  default_ = IdOutputFormatBech32
-  make format flag_ =
-    Opt.flag' format $
-      mconcat
-        [ Opt.help $
-            "Format drep id output as "
-              <> flag_
-              <> (if format == default_ then " (the default)." else ".")
-        , Opt.long ("output-" <> flag_)
-        ]
-
 -- Registration Certificate related
 
 pRegistrationCertificateCmd

cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Run.hs

@@ -17,6 +17,7 @@ where
 
 import Cardano.Api
 import Cardano.Api.Ledger qualified as L
+import Cardano.Api.Shelley
 
 import Cardano.CLI.EraBased.Governance.DRep.Command qualified as Cmd
 import Cardano.CLI.EraIndependent.Hash.Command qualified as Cmd
@@ -38,6 +39,8 @@ import Data.ByteString (ByteString)
 import Data.Function
 import Data.Text.Encoding qualified as Text
 
+import Vary qualified
+
 runGovernanceDRepCmds
   :: ()
   => Cmd.GovernanceDRepCmds era
@@ -92,9 +95,18 @@ runGovernanceDRepIdCmd
         readVerificationKeyOrHashOrTextEnvFile AsDRepKey vkeySource
 
     content <-
-      pure $ case idOutputFormat of
-        IdOutputFormatHex -> serialiseToRawBytesHex drepVerKeyHash
-        IdOutputFormatBech32 -> Text.encodeUtf8 $ serialiseToBech32 drepVerKeyHash
+      pure $
+        idOutputFormat
+          & ( Vary.on (\FormatHex -> serialiseToRawBytesHex drepVerKeyHash)
+                $ Vary.on (\FormatBech32 -> Text.encodeUtf8 $ serialiseToBech32 drepVerKeyHash)
+                $ Vary.on
+                  ( \FormatCip129 ->
+                      let DRepKeyHash kh = drepVerKeyHash
+                          keyCredential = L.KeyHashObj kh
+                       in Text.encodeUtf8 $ serialiseToBech32Cip129 keyCredential
+                  )
+                $ Vary.exhaustiveCase
+            )
 
     lift (writeByteStringOutput mOutFile content)
       & onLeft (left . WriteFileError)

cardano-cli/src/Cardano/CLI/EraBased/Query/Run.hs

@@ -42,7 +42,7 @@ where
 import Cardano.Api hiding (QueryInShelleyBasedEra (..))
 import Cardano.Api qualified as Api
 import Cardano.Api.Consensus qualified as Consensus
-import Cardano.Api.Ledger (StandardCrypto, strictMaybeToMaybe)
+import Cardano.Api.Ledger (strictMaybeToMaybe)
 import Cardano.Api.Ledger qualified as L
 import Cardano.Api.Network (LedgerPeerSnapshot, Serialised (..))
 import Cardano.Api.Network qualified as Consensus
@@ -1118,7 +1118,7 @@ writePoolState mOutFile serialisedCurrentEpochState = do
             <> Map.keysSet (L.psFutureStakePoolParams poolState)
             <> Map.keysSet (L.psRetiring poolState)
 
-  let poolStates :: Map (L.KeyHash 'L.StakePool) (Params StandardCrypto)
+  let poolStates :: Map (L.KeyHash 'L.StakePool) Params
       poolStates =
         fromList $
           hks

cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Command.hs

@@ -0,0 +1,21 @@
+module Cardano.CLI.EraIndependent.Cip.Cip129.Command
+  ( Cip129 (..)
+  , renderCip129Command
+  )
+where
+
+import Cardano.CLI.EraIndependent.Cip.Common
+
+import Data.Text (Text)
+
+data Cip129
+  = Cip129DRep Input Output
+  | Cip129CommitteeHotKey Input Output
+  | Cip129CommitteeColdKey Input Output
+  | Cip129GovernanceAction Input Output
+
+renderCip129Command :: Cip129 -> Text
+renderCip129Command (Cip129DRep{}) = "cip-129 drep"
+renderCip129Command (Cip129CommitteeHotKey{}) = "cip-129 committee-hot-key"
+renderCip129Command (Cip129CommitteeColdKey{}) = "cip-129 committee-cold-key"
+renderCip129Command (Cip129GovernanceAction{}) = "cip-129 governance-action-id"

cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Conversion.hs

@@ -0,0 +1,63 @@
+{-# LANGUAGE DataKinds #-}
+
+module Cardano.CLI.EraIndependent.Cip.Cip129.Conversion
+  ( encodeCip129DrepVerficationKeyText
+  , encodeCip129CommitteeColdVerficationKeyText
+  , encodeCip129CommitteeHotVerficationKeyText
+  , encodeCip129GovernanceActionIdText
+  )
+where
+
+import Cardano.Api.Ledger qualified as L
+import Cardano.Api.Shelley
+
+import Cardano.CLI.Read.Committee.ColdKey
+import Cardano.CLI.Read.Committee.HotKey
+import Cardano.CLI.Read.DRep
+
+import Data.Text
+
+encodeCip129DrepVerficationKeyText :: AnyDrepVerificationKey -> Text
+encodeCip129DrepVerficationKeyText = serialiseToBech32Cip129 . anyDrepVerificationKeyToCredential
+
+anyDrepVerificationKeyToCredential
+  :: AnyDrepVerificationKey -> L.Credential L.DRepRole
+anyDrepVerificationKeyToCredential drepKey =
+  case drepKey of
+    AnyDrepVerificationKey vk ->
+      let DRepKeyHash hash = verificationKeyHash vk
+       in L.KeyHashObj hash
+    AnyDrepExtendedVerificationKey vk ->
+      let DRepExtendedKeyHash hash = verificationKeyHash vk
+       in L.KeyHashObj hash
+
+encodeCip129CommitteeHotVerficationKeyText :: AnyCommitteeHotVerificationKey -> Text
+encodeCip129CommitteeHotVerficationKeyText = serialiseToBech32Cip129 . anyCommitteeHotVerificationKeyToCredential
+
+anyCommitteeHotVerificationKeyToCredential
+  :: AnyCommitteeHotVerificationKey -> L.Credential L.HotCommitteeRole
+anyCommitteeHotVerificationKeyToCredential committeeHotKey =
+  case committeeHotKey of
+    AnyCommitteeHotVerificationKey vk ->
+      let CommitteeHotKeyHash hash = verificationKeyHash vk
+       in L.KeyHashObj hash
+    AnyCommitteeHotExtendedVerificationKey vk ->
+      let CommitteeHotExtendedKeyHash hash = verificationKeyHash vk
+       in L.KeyHashObj hash
+
+encodeCip129CommitteeColdVerficationKeyText :: AnyCommitteeColdVerificationKey -> Text
+encodeCip129CommitteeColdVerficationKeyText = serialiseToBech32Cip129 . anyCommitteeColdVerificationKeyToCredential
+
+anyCommitteeColdVerificationKeyToCredential
+  :: AnyCommitteeColdVerificationKey -> L.Credential L.ColdCommitteeRole
+anyCommitteeColdVerificationKeyToCredential committeeColdKey =
+  case committeeColdKey of
+    AnyCommitteeColdVerificationKey vk ->
+      let CommitteeColdKeyHash hash = verificationKeyHash vk
+       in L.KeyHashObj hash
+    AnyCommitteeColdExtendedVerificationKey vk ->
+      let CommitteeColdExtendedKeyHash hash = verificationKeyHash vk
+       in L.KeyHashObj hash
+
+encodeCip129GovernanceActionIdText :: L.GovActionId -> Text
+encodeCip129GovernanceActionIdText = serialiseGovActionIdToBech32Cip129