Merge pull request #609 from IntersectMBO/jordan/bump-chap

Enable deposit return scripts and constitutional scripts

.github/workflows/check-stylish-haskell.yml

@@ -27,7 +27,7 @@ jobs:
 
     env:
       # Modify this value to "invalidate" the cabal cache.
-      CABAL_CACHE_VERSION: "2023-07-28"
+      CABAL_CACHE_VERSION: "2024-02-23"
 
       STYLISH_HASKELL_VERSION: "0.14.4.0"
 

.github/workflows/github-page.yml

@@ -22,7 +22,7 @@ jobs:
 
     env:
       # Modify this value to "invalidate" the cabal cache.
-      CABAL_CACHE_VERSION: "2023-12-12"
+      CABAL_CACHE_VERSION: "2024-02-23"
 
     concurrency:
       group: >

.github/workflows/haskell.yml

@@ -24,7 +24,7 @@ jobs:
 
     env:
       # Modify this value to "invalidate" the cabal cache.
-      CABAL_CACHE_VERSION: "2024-02-23-3"
+      CABAL_CACHE_VERSION: "2024-02-23-4"
 
     concurrency:
       group: >

cabal.project

@@ -14,7 +14,7 @@ repository cardano-haskell-packages
 -- you need to run if you change them
 index-state:
   , hackage.haskell.org 2024-02-23T02:09:28Z
-  , cardano-haskell-packages 2024-02-22T17:04:08Z
+  , cardano-haskell-packages 2024-02-23T11:16:54Z
 
 packages:
   cardano-cli

cardano-cli/cardano-cli.cabal

@@ -196,7 +196,7 @@ library
                       , binary
                       , bytestring
                       , canonical-json
-                      , cardano-api ^>= 8.39.0.0
+                      , cardano-api ^>= 8.39.1.0
                       , cardano-binary
                       , cardano-crypto
                       , cardano-crypto-class ^>= 2.1.2

cardano-cli/src/Cardano/CLI/EraBased/Commands/Governance/Actions.hs

@@ -46,7 +46,7 @@ data GoveranceActionUpdateCommitteeCmdArgs era
       { eon                     :: !(ConwayEraOnwards era)
       , networkId               :: !L.Network
       , deposit                 :: !Lovelace
-      , returnAddress           :: !(VerificationKeyOrHashOrFile StakeKey)
+      , returnAddress           :: !StakeIdentifier
       , proposalUrl             :: !ProposalUrl
       , proposalHash            :: !(L.SafeHash L.StandardCrypto L.AnchorData)
       , oldCommitteeVkeySource  :: ![VerificationKeyOrHashOrFile CommitteeColdKey]
@@ -61,12 +61,13 @@ data GovernanceActionCreateConstitutionCmdArgs era
       { eon                     :: !(ConwayEraOnwards era)
       , networkId               :: !L.Network
       , deposit                 :: !Lovelace
-      , stakeCredential         :: !(VerificationKeyOrHashOrFile StakeKey)
+      , stakeCredential         :: !StakeIdentifier
       , mPrevGovernanceActionId :: !(Maybe (TxId, Word32))
       , proposalUrl             :: !ProposalUrl
       , proposalHash            :: !(L.SafeHash L.StandardCrypto L.AnchorData)
       , constitutionUrl         :: !ConstitutionUrl
       , constitutionHash        :: !(L.SafeHash L.StandardCrypto L.AnchorData)
+      , constitutionScript      :: !(Maybe ScriptHash)
       , outFile                 :: !(File () Out)
       } deriving Show
 
@@ -76,7 +77,7 @@ data GovernanceActionInfoCmdArgs era
       { eon                 :: !(ConwayEraOnwards era)
       , networkId           :: !L.Network
       , deposit             :: !Lovelace
-      , returnStakeAddress  :: !(VerificationKeyOrHashOrFile StakeKey)
+      , returnStakeAddress  :: !StakeIdentifier
       , proposalUrl         :: !ProposalUrl
       , proposalHash        :: !(L.SafeHash L.StandardCrypto L.AnchorData)
       , outFile             :: !(File () Out)
@@ -87,7 +88,7 @@ data GovernanceActionCreateNoConfidenceCmdArgs era
       { eon                   :: !(ConwayEraOnwards era)
       , networkId             :: !L.Network
       , deposit               :: !Lovelace
-      , returnStakeAddress    :: !(VerificationKeyOrHashOrFile StakeKey)
+      , returnStakeAddress    :: !StakeIdentifier
       , proposalUrl           :: !ProposalUrl
       , proposalHash          :: !(L.SafeHash L.StandardCrypto L.AnchorData)
       , governanceActionId    :: !TxId
@@ -117,7 +118,7 @@ data GovernanceActionTreasuryWithdrawalCmdArgs era
       { eon                    :: !(ConwayEraOnwards era)
       , networkId              :: !L.Network
       , deposit                :: !Lovelace
-      , returnAddr             :: !(VerificationKeyOrHashOrFile StakeKey)
+      , returnAddr             :: !StakeIdentifier
       , proposalUrl            :: !ProposalUrl
       , proposalHash           :: !(L.SafeHash L.StandardCrypto L.AnchorData)
       , treasuryWithdrawal     :: ![(VerificationKeyOrHashOrFile StakeKey, Lovelace)]
@@ -138,7 +139,7 @@ data UpdateProtocolParametersConwayOnwards era
       { eon                 :: !(ConwayEraOnwards era)
       , networkId           :: !L.Network
       , deposit             :: !Lovelace
-      , returnAddr          :: !(VerificationKeyOrHashOrFile StakeKey)
+      , returnAddr          :: !StakeIdentifier
       , proposalUrl         :: !ProposalUrl
       , proposalHash        :: !(L.SafeHash L.StandardCrypto L.AnchorData)
       , governanceActionId  :: !(Maybe (TxId, Word32))

cardano-cli/src/Cardano/CLI/EraBased/Options/Address.hs

@@ -63,7 +63,7 @@ pAddressBuild :: EnvCli -> Parser (AddressCmds era)
 pAddressBuild envCli =
   AddressBuild
     <$> pPaymentVerifier
-    <*> Opt.optional pStakeIdentifier
+    <*> Opt.optional (pStakeIdentifier Nothing)
     <*> pNetworkId envCli
     <*> pMaybeOutputFile
 

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

@@ -206,22 +206,22 @@ decimal :: Parsec.Parser Integer
 Parsec.TokenParser { Parsec.decimal = decimal } = Parsec.haskell
 
 
-pStakeIdentifier :: Parser StakeIdentifier
-pStakeIdentifier = asum
-  [ StakeIdentifierVerifier <$> pStakeVerifier
-  , StakeIdentifierAddress <$> pStakeAddress
+pStakeIdentifier :: Maybe String -> Parser StakeIdentifier
+pStakeIdentifier prefix = asum
+  [ StakeIdentifierVerifier <$> pStakeVerifier prefix
+  , StakeIdentifierAddress <$> pStakeAddress prefix
   ]
 
-pStakeVerifier :: Parser StakeVerifier
-pStakeVerifier = asum
-  [ StakeVerifierKey <$> pStakeVerificationKeyOrFile Nothing
-  , StakeVerifierScriptFile <$> pScriptFor "stake-script-file" Nothing "Filepath of the staking script."
+pStakeVerifier :: Maybe String -> Parser StakeVerifier
+pStakeVerifier prefix = asum
+  [ StakeVerifierKey <$> pStakeVerificationKeyOrHashOrFile prefix
+  , StakeVerifierScriptFile <$> pScriptFor (prefixFlag prefix "stake-script-file") Nothing "Filepath of the staking script."
   ]
 
-pStakeAddress :: Parser StakeAddress
-pStakeAddress =
+pStakeAddress :: Maybe String -> Parser StakeAddress
+pStakeAddress prefix =
   Opt.option (readerFromParsecParser parseStakeAddress) $ mconcat
-    [ Opt.long "stake-address"
+    [ Opt.long $ prefixFlag prefix "stake-address"
     , Opt.metavar "ADDRESS"
     , Opt.help "Target stake address (bech32 format)."
     ]
@@ -1295,7 +1295,7 @@ pCertificateFile balanceExecUnits =
     <$> ( fmap CertificateFile $ asum
             [ Opt.strOption $ mconcat
                 [ Opt.long "certificate-file"
-                , Opt.metavar "CERTIFICATEFILE"
+                , Opt.metavar "FILE"
                 , Opt.help helpText
                 , Opt.completer (Opt.bashCompleter "file")
                 ]

cardano-cli/src/Cardano/CLI/EraBased/Options/Governance.hs

@@ -72,7 +72,7 @@ pMIRPayStakeAddresses :: ()
 pMIRPayStakeAddresses w =
   GovernanceCreateMirCertificateStakeAddressesCmd w
     <$> pMIRPot
-    <*> some pStakeAddress
+    <*> some (pStakeAddress Nothing)
     <*> some pRewardAmt
     <*> pOutputFile
 

cardano-cli/src/Cardano/CLI/EraBased/Options/Governance/Actions.hs

@@ -66,7 +66,7 @@ pGovernanceActionNewInfoCmd era = do
             Cmd.GovernanceActionInfoCmdArgs eon
               <$> pNetwork
               <*> pGovActionDeposit
-              <*> pStakeVerificationKeyOrHashOrFile (Just "deposit-return")
+              <*> pStakeIdentifier (Just "deposit-return")
               <*> pAnchorUrl
               <*> pAnchorDataHash
               <*> pFileOutDirection "out-file" "Path to action file to be used later on with build or build-raw "
@@ -86,12 +86,13 @@ pGovernanceActionNewConstitutionCmd era = do
             Cmd.GovernanceActionCreateConstitutionCmdArgs eon
               <$> pNetwork
               <*> pGovActionDeposit
-              <*> pStakeVerificationKeyOrHashOrFile (Just "deposit-return")
+              <*> pStakeIdentifier (Just "deposit-return")
               <*> pPreviousGovernanceAction
               <*> pAnchorUrl
               <*> pAnchorDataHash
               <*> pConstitutionUrl
               <*> pConstitutionHash
+              <*> optional pConstitutionScriptHash
               <*> pFileOutDirection "out-file" "Output filepath of the constitution."
         )
     $ Opt.progDesc "Create a constitution."
@@ -116,7 +117,7 @@ pUpdateCommitteeCmd eon =
   Cmd.GoveranceActionUpdateCommitteeCmdArgs eon
     <$> pNetwork
     <*> pGovActionDeposit
-    <*> pStakeVerificationKeyOrHashOrFile (Just "deposit-return")
+    <*> pStakeIdentifier (Just "deposit-return")
     <*> pAnchorUrl
     <*> pAnchorDataHash
     <*> many pRemoveCommitteeColdVerificationKeyOrHashOrFile
@@ -141,7 +142,7 @@ pGovernanceActionNoConfidenceCmd era = do
             Cmd.GovernanceActionCreateNoConfidenceCmdArgs eon
               <$> pNetwork
               <*> pGovActionDeposit
-              <*> pStakeVerificationKeyOrHashOrFile (Just "deposit-return")
+              <*> pStakeIdentifier (Just "deposit-return")
               <*> pAnchorUrl
               <*> pAnchorDataHash
               <*> pTxId "prev-governance-action-tx-id" "Txid of the previous governance action."
@@ -161,7 +162,7 @@ pUpdateProtocolParametersPostConway conwayOnwards =
   Cmd.UpdateProtocolParametersConwayOnwards conwayOnwards
     <$> pNetwork
     <*> pGovActionDeposit
-    <*> pStakeVerificationKeyOrHashOrFile (Just "deposit-return")
+    <*> pStakeIdentifier (Just "deposit-return")
     <*> pAnchorUrl
     <*> pAnchorDataHash
     <*> pPreviousGovernanceAction
@@ -353,7 +354,7 @@ pGovernanceActionTreasuryWithdrawalCmd era = do
             Cmd.GovernanceActionTreasuryWithdrawalCmdArgs eon
               <$> pNetwork
               <*> pGovActionDeposit
-              <*> pStakeVerificationKeyOrHashOrFile (Just "deposit-return")
+              <*> pStakeIdentifier (Just "deposit-return")
               <*> pAnchorUrl
               <*> pAnchorDataHash
               <*> many ((,) <$> pStakeVerificationKeyOrHashOrFile (Just "funds-receiving") <*> pTransferAmt)

cardano-cli/src/Cardano/CLI/EraBased/Options/StakeAddress.hs

@@ -75,7 +75,7 @@ pStakeAddressBuildCmd era envCli = do
     $ subParser "build"
     $ Opt.info
         ( StakeAddressBuildCmd w
-            <$> pStakeVerifier
+            <$> pStakeVerifier Nothing
             <*> pNetworkId envCli
             <*> pMaybeOutputFile
         )
@@ -90,7 +90,7 @@ pStakeAddressRegistrationCertificateCmd era = do
       (const $ subParser "registration-certificate"
             $ Opt.info
                 ( StakeAddressRegistrationCertificateCmd sbe
-                    <$> pStakeIdentifier
+                    <$> pStakeIdentifier Nothing
                     <*> pure Nothing
                     <*> pOutputFile
                 )
@@ -99,7 +99,7 @@ pStakeAddressRegistrationCertificateCmd era = do
       (const $ subParser "registration-certificate"
             $ Opt.info
                 ( StakeAddressRegistrationCertificateCmd sbe
-                    <$> pStakeIdentifier
+                    <$> pStakeIdentifier Nothing
                     <*> fmap Just pKeyRegistDeposit
                     <*> pOutputFile
                 )
@@ -118,7 +118,7 @@ pStakeAddressDeregistrationCertificateCmd era = do
       (\shelleyToBabbage -> subParser "deregistration-certificate"
            $ Opt.info
                ( StakeAddressDeregistrationCertificateCmd (shelleyToBabbageEraToShelleyBasedEra shelleyToBabbage)
-                   <$> pStakeIdentifier
+                   <$> pStakeIdentifier Nothing
                    <*> pure Nothing
                    <*> pOutputFile
                )
@@ -127,7 +127,7 @@ pStakeAddressDeregistrationCertificateCmd era = do
       (\conwayOnwards -> subParser "deregistration-certificate"
            $ Opt.info
                ( StakeAddressDeregistrationCertificateCmd (conwayEraOnwardsToShelleyBasedEra conwayOnwards)
-                   <$> pStakeIdentifier
+                   <$> pStakeIdentifier Nothing
                    <*> fmap Just pKeyRegistDeposit
                    <*> pOutputFile
                )
@@ -144,7 +144,7 @@ pStakeAddressStakeDelegationCertificateCmd era = do
     $ subParser "stake-delegation-certificate"
     $ Opt.info
         ( StakeAddressStakeDelegationCertificateCmd w
-            <$> pStakeIdentifier
+            <$> pStakeIdentifier Nothing
             <*> pStakePoolVerificationKeyOrHashOrFile Nothing
             <*> pOutputFile
         )
@@ -163,7 +163,7 @@ pStakeAddressStakeAndVoteDelegationCertificateCmd era = do
     $ subParser "stake-and-vote-delegation-certificate"
     $ Opt.info
         ( StakeAddressStakeAndVoteDelegationCertificateCmd w
-            <$> pStakeIdentifier
+            <$> pStakeIdentifier Nothing
             <*> pStakePoolVerificationKeyOrHashOrFile Nothing
             <*> pVoteDelegationTarget
             <*> pOutputFile
@@ -183,7 +183,7 @@ pStakeAddressVoteDelegationCertificateCmd era = do
     $ subParser "vote-delegation-certificate"
     $ Opt.info
         ( StakeAddressVoteDelegationCertificateCmd w
-            <$> pStakeIdentifier
+            <$> pStakeIdentifier Nothing
             <*> pVoteDelegationTarget
             <*> pOutputFile
         )

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

@@ -24,7 +24,7 @@ import           Cardano.CLI.Types.Common
 import           Cardano.CLI.Types.Errors.AddressCmdError
 import           Cardano.CLI.Types.Key (PaymentVerifier (..), StakeIdentifier (..),
                    StakeVerifier (..), VerificationKeyTextOrFile, generateKeyPair,
-                   readVerificationKeyOrFile, readVerificationKeyTextOrFileAnyOf)
+                   readVerificationKeyOrHashOrFile, readVerificationKeyTextOrFileAnyOf)
 
 import qualified Data.ByteString.Char8 as BS
 import           Data.Function
@@ -194,10 +194,10 @@ makeStakeAddressRef stakeIdentifier =
     StakeIdentifierVerifier stakeVerifier ->
       case stakeVerifier of
         StakeVerifierKey stkVkeyOrFile -> do
-          stakeVKey <- firstExceptT AddressCmdReadKeyFileError $
-            newExceptT $ readVerificationKeyOrFile AsStakeKey stkVkeyOrFile
+          stakeVKeyHash <- firstExceptT AddressCmdReadKeyFileError $
+            newExceptT $ readVerificationKeyOrHashOrFile AsStakeKey stkVkeyOrFile
 
-          return . StakeAddressByValue . StakeCredentialByKey . verificationKeyHash $ stakeVKey
+          return . StakeAddressByValue $ StakeCredentialByKey stakeVKeyHash
 
         StakeVerifierScriptFile (ScriptFile fp) -> do
           ScriptInAnyLang _lang script <-