Incorporate cip-129

Jimbo4350 · Jimbo4350 · commit b6e319973b89 · 2025-03-17T16:13:35.000-04:00
diff --git a/cabal.project b/cabal.project
@@ -77,3 +77,9 @@ if impl (ghc >= 9.12)
     -- https://github.com/fizruk/http-api-data/pull/146
     , http-api-data:base
 
+
+source-repository-package
+  type: git 
+  location: https://github.com/IntersectMBO/cardano-api.git
+  tag: cc7535791ee480e7644acc3283c58e4a2f44e85d
+  subdir: cardano-api
diff --git a/cardano-cli/cardano-cli.cabal b/cardano-cli/cardano-cli.cabal
@@ -142,6 +142,13 @@ 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.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
diff --git a/cardano-cli/src/Cardano/CLI/Command.hs b/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)
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Common/Option.hs b/cardano-cli/src/Cardano/CLI/EraBased/Common/Option.hs
@@ -1978,6 +1978,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
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Command.hs b/cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Command.hs
@@ -11,6 +11,7 @@ module Cardano.CLI.EraBased.Governance.DRep.Command
   , GovernanceDRepRetirementCertificateCmdArgs (..)
   , GovernanceDRepUpdateCertificateCmdArgs (..)
   , GovernanceDRepMetadataHashCmdArgs (..)
+  , DRepIdOutputFormat (..)
   , DRepMetadataSource (..)
   )
 where
@@ -43,7 +44,7 @@ data GovernanceDRepIdCmdArgs era
   = GovernanceDRepIdCmdArgs
   { eon :: !(ConwayEraOnwards era)
   , vkeySource :: !(VerificationKeyOrHashOrFile DRepKey)
-  , idOutputFormat :: !IdOutputFormat
+  , idOutputFormat :: !DRepIdOutputFormat
   , mOutFile :: !(Maybe (File () Out))
   }
 
@@ -112,3 +113,8 @@ renderGovernanceDRepCmds = \case
     "governance drep update-certificate"
   GovernanceDRepMetadataHashCmd{} ->
     "governance drep metadata-hash"
+
+data DRepIdOutputFormat
+  = IdOutputFormat IdOutputFormat
+  | DRepCIP129OutputFormat
+  deriving (Eq, Show)
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Option.hs b/cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Option.hs
@@ -76,12 +76,16 @@ pGovernanceDRepKeyIdCmd era = do
       )
     $ Opt.progDesc "Generate a drep id."
 
-pDRepIdOutputFormat :: Parser IdOutputFormat
+pDRepIdOutputFormat :: Parser DRepIdOutputFormat
 pDRepIdOutputFormat =
-  asum [make IdOutputFormatHex "hex", make IdOutputFormatBech32 "bech32"]
-    <|> pure default_
+  asum
+    [ make (IdOutputFormat IdOutputFormatHex) "hex"
+    , make (IdOutputFormat IdOutputFormatBech32) "bech32"
+    , make DRepCIP129OutputFormat "cip129"
+    , pure default_
+    ]
  where
-  default_ = IdOutputFormatBech32
+  default_ = IdOutputFormat IdOutputFormatBech32
   make format flag_ =
     Opt.flag' format $
       mconcat
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Governance/DRep/Run.hs b/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
@@ -93,8 +94,12 @@ runGovernanceDRepIdCmd
 
     content <-
       pure $ case idOutputFormat of
-        IdOutputFormatHex -> serialiseToRawBytesHex drepVerKeyHash
-        IdOutputFormatBech32 -> Text.encodeUtf8 $ serialiseToBech32 drepVerKeyHash
+        Cmd.IdOutputFormat IdOutputFormatHex -> serialiseToRawBytesHex drepVerKeyHash
+        Cmd.IdOutputFormat IdOutputFormatBech32 -> Text.encodeUtf8 $ serialiseToBech32 drepVerKeyHash
+        Cmd.DRepCIP129OutputFormat ->
+          let DRepKeyHash kh = drepVerKeyHash
+              keyCredential = L.KeyHashObj kh
+           in Text.encodeUtf8 $ serialiseToBech32CIP129 keyCredential
 
     lift (writeByteStringOutput mOutFile content)
       & onLeft (left . WriteFileError)
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Command.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Command.hs
@@ -0,0 +1,12 @@
+module Cardano.CLI.EraIndependent.Cip.Cip129.Command
+  ( Cip129(..)
+  )
+where
+
+import Cardano.CLI.EraIndependent.Cip.Common
+
+data Cip129 
+    = Cip129DRep Input Output
+    | Cip129CommitteeHotKey Input Output
+    | Cip129CommitteeColdKey Input Output
+    | Cip129GovernanceAction Input Output
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Options.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Options.hs
@@ -0,0 +1,67 @@
+module Cardano.CLI.EraIndependent.Cip.Cip129.Options
+  ( pCip129
+  )
+where
+
+import Options.Applicative qualified as Opt
+import Cardano.CLI.EraIndependent.Cip.Command
+import Control.Applicative
+import Cardano.CLI.EraIndependent.Cip.Common
+
+pCip129 :: Opt.Parser CipFormatCmds
+pCip129 = Cip129 <$> asum [ pCip129Drep
+                          , pCip129CommitteeHotKey 
+                          , pCip129CommitteeColdKey
+                          , pCip129GovernanceAction
+                          ] 
+
+pCip129Drep :: Opt.Parser Cip129
+pCip129Drep = 
+    Cip129DRep 
+      <$> pInput
+      <*> pOutput
+ where 
+  pInput = asum [ pInputFile "drep-file" "Input hex/bech32/text envelope drep file"
+                , pInputHexText "drep-hex" "HEX" "Input hex encoded drep"
+                , pInputBech32Text "drep-bech32" "BECH32" "Input bech32 encoded drep"
+                ] 
+
+pCip129CommitteeHotKey :: Opt.Parser Cip129
+pCip129CommitteeHotKey = 
+    Cip129CommitteeHotKey 
+      <$> pInput
+      <*> pOutput
+ where 
+  pInput = asum [ pInputFile "committee-hot-key-file" "Input hex/bech32/text envelope committee hot key file"
+                , pInputHexText "committee-hot-key-hex" "HEX" "Input hex encoded committee hot key"
+                , pInputBech32Text "committee-hot-key-bech32" "BECH32" "Input bech32 encoded committee hot key"
+                ]
+
+pCip129CommitteeColdKey :: Opt.Parser Cip129
+pCip129CommitteeColdKey = 
+    Cip129CommitteeColdKey 
+      <$> pInput
+      <*> pOutput
+ where 
+  pInput = asum [ pInputFile "committee-cold-key-file" "Input hex/bech32/text envelope committee cold key file"
+                , pInputHexText "committee-cold-key-hex" "HEX" "Input hex encoded committee cold key"
+                , pInputBech32Text "committee-cold-key-bech32" "BECH32" "Input bech32 encoded committee cold key"
+                ]
+
+pCip129GovernanceAction :: Opt.Parser Cip129
+pCip129GovernanceAction = 
+    Cip129GovernanceAction 
+      <$> pInput
+      <*> pOutput
+ where 
+  pInput = asum [ pInputFile "governance-action-file" "Input hex/bech32/text envelope governance action file"
+                , pInputHexText "governance-action-hex" "HEX" "Input hex encoded governance action"
+                , pInputBech32Text "governance-action-bech32" "BECH32" "Input bech32 encoded governance action"
+                ]
+            
+
+
+pOutput :: Opt.Parser Output
+pOutput = asum [ pOutputFile "output-file" "Output file"
+               , pOutputText "output-text" "TEXT" "Output text"
+               ]
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Run.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Cip129/Run.hs
@@ -0,0 +1,12 @@
+module Cardano.CLI.EraIndependent.Cip.Cip129.Run
+  ( runCip129
+  )
+where
+
+import Cardano.CLI.EraIndependent.Cip.Cip129.Command
+
+runCip129 :: Cip129 -> IO ()
+runCip129 (Cip129DRep inp out) = undefined 
+runCip129 (Cip129CommitteeHotKey inp out) = undefined
+runCip129 (Cip129CommitteeColdKey inp out) = undefined
+runCip129 (Cip129GovernanceAction inp out) = undefined
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Command.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Command.hs
@@ -0,0 +1,15 @@
+
+module Cardano.CLI.EraIndependent.Cip.Command
+  ( -- * Supported CIPs
+    Cip129(..)
+
+  , CipFormatCmds(..)
+
+  )
+where
+import Cardano.CLI.EraIndependent.Cip.Cip129.Command
+
+newtype CipFormatCmds
+    = Cip129 Cip129
+
+
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Common.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Common.hs
@@ -0,0 +1,73 @@
+{-# LANGUAGE DataKinds #-}
+
+module Cardano.CLI.EraIndependent.Cip.Common
+  ( -- * Input related 
+    Input (..)
+
+  , pInputFile
+  , pInputHexText
+  , pInputBech32Text
+  
+    -- * Output related 
+  , Output (..)
+  , pOutputFile
+  , pOutputText
+  )
+  where 
+
+
+import Options.Applicative qualified as Opt
+import Cardano.Api 
+import Cardano.CLI.EraBased.Common.Option hiding (pOutputFile)
+import qualified Data.Text as Text
+import Data.Text (Text)
+
+
+data Input 
+    = InputFile (File () In)
+    | InputHexText Text
+    | InputBech32Text Text
+
+pInputFile :: String -> String -> Opt.Parser Input
+pInputFile optName desc = 
+  InputFile <$> pFileInDirection optName desc
+
+pInputHexText :: String -> String -> String -> Opt.Parser Input
+pInputHexText optName metavar help = 
+   fmap (InputHexText . Text.pack) $
+    Opt.strOption $
+      mconcat
+        [ Opt.long optName
+        , Opt.metavar metavar
+        , Opt.help help
+        ]
+
+pInputBech32Text :: String -> String -> String -> Opt.Parser Input
+pInputBech32Text optName metavar help = 
+   fmap (InputBech32Text . Text.pack) $
+    Opt.strOption $
+      mconcat
+        [ Opt.long optName
+        , Opt.metavar metavar
+        , Opt.help help
+        ]
+
+
+data Output 
+    = OutputFile (File () Out)
+    | OutputText Text 
+
+pOutputFile :: String -> String -> Opt.Parser Output
+pOutputFile optName desc = 
+    OutputFile <$> pFileOutDirection optName desc
+
+
+pOutputText :: String -> String -> String -> Opt.Parser Output
+pOutputText optName metavar help = 
+   fmap (OutputText . Text.pack) $
+    Opt.strOption $
+      mconcat
+        [ Opt.long optName
+        , Opt.metavar metavar
+        , Opt.help help
+        ]
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Options.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Options.hs
@@ -0,0 +1,38 @@
+{-# LANGUAGE TypeApplications #-}
+
+module Cardano.CLI.EraIndependent.Cip.Options
+  ( parseCipCmd
+  )
+where
+
+import Cardano.CLI.Command (ClientCommand (CipFormatCmds))
+import Options.Applicative qualified as Opt
+import Prettyprinter qualified as PP
+import Cardano.CLI.EraIndependent.Cip.Command
+import Cardano.CLI.EraIndependent.Cip.Cip129.Options
+
+import Cardano.CLI.Parser
+
+parseCipCmd :: Opt.Mod Opt.CommandFields ClientCommand
+parseCipCmd =
+  Opt.command "cip-format" $
+    Opt.info (CipFormatCmds <$> pCipFormat) $
+      Opt.progDescDoc $
+        Just $
+          mconcat
+            [ PP.pretty @String "Convert a hex or bech32 ledger cddl encoded thing to a CIP format."
+            ]
+
+pCipFormat :: Opt.Parser CipFormatCmds
+pCipFormat =  
+    subParser "cip-129" $
+        Opt.info pCip129 $
+          Opt.progDesc $
+            mconcat
+              [ "Modified binary encoding of drep keys, constitutional committee cold and hot keys, governance actions."
+              , "https://github.com/cardano-foundation/CIPs/tree/master/CIP-0129"
+              ]
+
+
+
+
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Run.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Cip/Run.hs
@@ -0,0 +1,11 @@
+
+module Cardano.CLI.EraIndependent.Cip.Run
+  ( runCipFormat
+  )
+where
+
+import Cardano.CLI.EraIndependent.Cip.Command
+import  Cardano.CLI.EraIndependent.Cip.Cip129.Run
+
+runCipFormat :: CipFormatCmds -> IO ()
+runCipFormat (Cip129 cip129) = runCip129 cip129
diff --git a/cardano-cli/src/Cardano/CLI/EraIndependent/Key/Run.hs b/cardano-cli/src/Cardano/CLI/EraIndependent/Key/Run.hs
@@ -36,6 +36,7 @@ import Cardano.Api
 import Cardano.Api.Byron qualified as ByronApi
 import Cardano.Api.Crypto.Ed25519Bip32 (xPrvFromBytes)
 import Cardano.Api.Ledger qualified as L
+import Cardano.Api.Shelley
 
 import Cardano.CLI.Byron.Key qualified as Byron
 import Cardano.CLI.EraIndependent.Key.Command qualified as Cmd
@@ -178,12 +179,15 @@ runNonExtendedKeyCmd
             vkf
             (Just genesisVkeyDelegateDesc)
             (castVerificationKey vk :: VerificationKey GenesisDelegateKey)
+        AStakePoolExtendedVerificationKey vk ->
+          writeToDisk vkf (Just stakeVkeyDesc) (castVerificationKey vk :: VerificationKey StakePoolKey)
         -- Non-extended keys are below and cause failure.
         vk@AByronVerificationKey{} -> goFail vk
         vk@APaymentVerificationKey{} -> goFail vk
         vk@AGenesisUTxOVerificationKey{} -> goFail vk
         vk@AKesVerificationKey{} -> goFail vk
         vk@AVrfVerificationKey{} -> goFail vk
+        vk@AStakePoolVerificationKey{} -> goFail vk
         vk@AStakeVerificationKey{} -> goFail vk
         vk@ADRepVerificationKey{} -> goFail vk
         vk@ACommitteeColdVerificationKey{} -> goFail vk
@@ -216,6 +220,7 @@ readExtendedVerificationKeyFile evkfile = do
     k@ADRepExtendedVerificationKey{} -> return k
     k@ACommitteeColdExtendedVerificationKey{} -> return k
     k@ACommitteeHotExtendedVerificationKey{} -> return k
+    k@AStakePoolExtendedVerificationKey{} -> return k
     k@AStakeExtendedVerificationKey{} -> return k
     k@AGenesisExtendedVerificationKey{} -> return k
     k@AGenesisDelegateExtendedVerificationKey{} -> return k
@@ -225,6 +230,7 @@ readExtendedVerificationKeyFile evkfile = do
     k@AGenesisUTxOVerificationKey{} -> goFail k
     k@AKesVerificationKey{} -> goFail k
     k@AVrfVerificationKey{} -> goFail k
+    k@AStakePoolVerificationKey{} -> goFail k
     k@AStakeVerificationKey{} -> goFail k
     k@ADRepVerificationKey{} -> goFail k
     k@ACommitteeColdVerificationKey{} -> goFail k
diff --git a/cardano-cli/src/Cardano/CLI/Option.hs b/cardano-cli/src/Cardano/CLI/Option.hs
diff --git a/cardano-cli/src/Cardano/CLI/Run.hs b/cardano-cli/src/Cardano/CLI/Run.hs
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/compatible_conway_governance_drep_id.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/compatible_conway_governance_drep_id.cli
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_governance_drep_id.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_governance_drep_id.cli
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_governance_drep_id.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_governance_drep_id.cli
