Merge pull request #456 from input-output-hk/smelc/stakeaddr-reg-depo…

…sit-value-mandatory-in-conway-era Correct conway parser, so that --key-reg-deposit-amt is mandatory
IntersectMBO · Nov 16, 2023 · a3d4a04 · a3d4a04
2 parents ec7d3b3 + e79703a
commit a3d4a04
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 20 deletions.
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/StakeAddress.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/StakeAddress.hs
@@ -85,16 +85,29 @@ pStakeAddressRegistrationCertificateCmd :: ()
   => CardanoEra era
   -> Maybe (Parser (StakeAddressCmds era))
 pStakeAddressRegistrationCertificateCmd era = do
-  w <- forEraMaybeEon era
-  pure
-    $ subParser "registration-certificate"
-    $ Opt.info
-        ( StakeAddressRegistrationCertificateCmd w
-            <$> pStakeIdentifier
-            <*> optional pKeyRegistDeposit
-            <*> pOutputFile
-        )
-    $ Opt.progDesc "Create a stake address registration certificate"
+  forEraInEonMaybe era $ \sbe ->
+    caseShelleyToBabbageOrConwayEraOnwards
+      (\shelleyToBabbage -> subParser "registration-certificate"
+            $ Opt.info
+                ( StakeAddressRegistrationCertificateCmd (shelleyToBabbageEraToShelleyBasedEra shelleyToBabbage)
+                    <$> pStakeIdentifier
+                    <*> optional pKeyRegistDeposit
+                    <*> pOutputFile
+                )
+            desc
+      )
+      (\conwayOnwards -> subParser "registration-certificate"
+            $ Opt.info
+                ( StakeAddressRegistrationCertificateCmd (conwayEraOnwardsToShelleyBasedEra conwayOnwards)
+                    <$> pStakeIdentifier
+                    <*> fmap Just pKeyRegistDeposit
+                    <*> pOutputFile
+                )
+            desc
+      )
+      sbe
+   where
+     desc = Opt.progDesc "Create a stake address registration certificate"
 
 pStakeAddressDeregistrationCertificateCmd :: ()
   => CardanoEra era

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Run/StakeAddress.hs b/cardano-cli/src/Cardano/CLI/EraBased/Run/StakeAddress.hs
@@ -146,7 +146,7 @@ runStakeAddressRegistrationCertificateCmd sbe stakeIdentifier mDeposit oFp = do
 createRegistrationCertRequirements :: ()
   => ShelleyBasedEra era
   -> StakeCredential
-  -> Maybe Lovelace
+  -> Maybe Lovelace -- ^ Deposit required in conway era
   -> Either StakeAddressRegistrationError (StakeAddressRequirements era)
 createRegistrationCertRequirements sbe stakeCred mdeposit =
   case sbe of
@@ -162,8 +162,10 @@ createRegistrationCertRequirements sbe stakeCred mdeposit =
       return $ StakeAddrRegistrationPreConway ShelleyToBabbageEraBabbage stakeCred
     ShelleyBasedEraConway ->
       case mdeposit of
-        -- TODO: This error constructor will never be called
-        Nothing -> Left StakeAddressRegistrationDepositRequired
+        Nothing ->
+          -- This case is made impossible by the parser, that distinguishes between Conway
+          -- and pre-Conway.
+          Left StakeAddressRegistrationDepositRequired
         Just dep ->
           return $ StakeAddrRegistrationConway ConwayEraOnwardsConway dep stakeCred
 

diff --git a/cardano-cli/test/cardano-cli-golden/Test/Golden/Help.hs b/cardano-cli/test/cardano-cli-golden/Test/Golden/Help.hs
@@ -100,6 +100,6 @@ hprop_golden_HelpCmds =
         H.noteShow_ usage
         let expectedCmdHelpFp = "test/cardano-cli-golden/files/golden/help" </> Text.unpack (Text.intercalate "_" usage) <> ".cli"
 
-        cmdHelp <- filterAnsi . third <$> H.execDetailCardanoCli (fmap Text.unpack usage)
+        cmdHelp <- filterAnsi . third <$> H.execDetailCardanoCLI (fmap Text.unpack usage)
 
         H.diffVsGoldenFile cmdHelp expectedCmdHelpFp
diff --git a/...o-cli/test/cardano-cli-golden/Test/Golden/Shelley/StakeAddress/RegistrationCertificate.hs b/...o-cli/test/cardano-cli-golden/Test/Golden/Shelley/StakeAddress/RegistrationCertificate.hs
@@ -9,8 +9,8 @@ import           Test.Cardano.CLI.Util
 
 import           Hedgehog
 import qualified Hedgehog.Extras.Test.Base as H
-import qualified Hedgehog.Extras.Test.Process as H
 import qualified Hedgehog.Extras.Test.Golden as H
+import qualified Hedgehog.Extras.Test.Process as H
 
 {- HLINT ignore "Use camelCase" -}
 
@@ -67,3 +67,15 @@ hprop_golden_shelley_stake_address_registration_certificate_with_build_raw = pro
 
   goldenFile2 <- H.note "test/cardano-cli-golden/files/golden/shelley/stake-address/build-raw-out.json"
   H.diffFileVsGoldenFile txRawFile goldenFile2
+
+hprop_golden_shelley_stake_address_registration_certificate_missing_reg_deposit :: Property
+hprop_golden_shelley_stake_address_registration_certificate_missing_reg_deposit = propertyOnce . H.moduleWorkspace "tmp" $ \tempDir -> do
+  keyGenStakingVerificationKeyFile <- noteInputFile "test/cardano-cli-golden/files/input/shelley/keys/stake_keys/verification_key"
+  registrationCertFile <- noteTempFile tempDir "registration.cert"
+
+  void $ execDetailCardanoCLI
+    [ "conway", "stake-address", "registration-certificate"
+    , "--staking-verification-key-file", keyGenStakingVerificationKeyFile
+    -- , "--key-reg-deposit-amt", "2000000" This argument being mandatory in conway, the call should fail
+    , "--out-file", registrationCertFile
+    ]
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli
@@ -6598,7 +6598,7 @@ Usage: cardano-cli conway stake-address registration-certificate
                                                                    | --stake-script-file FILE
                                                                    | --stake-address ADDRESS
                                                                    )
-                                                                   [--key-reg-deposit-amt NATURAL]
+                                                                   --key-reg-deposit-amt NATURAL
                                                                    --out-file FILE
 
   Create a stake address registration certificate

diff --git a/...st/cardano-cli-golden/files/golden/help/conway_stake-address_registration-certificate.cli b/...st/cardano-cli-golden/files/golden/help/conway_stake-address_registration-certificate.cli
@@ -4,7 +4,7 @@ Usage: cardano-cli conway stake-address registration-certificate
                                                                    | --stake-script-file FILE
                                                                    | --stake-address ADDRESS
                                                                    )
-                                                                   [--key-reg-deposit-amt NATURAL]
+                                                                   --key-reg-deposit-amt NATURAL
                                                                    --out-file FILE
 
   Create a stake address registration certificate

diff --git a/cardano-cli/test/cardano-cli-test-lib/Test/Cardano/CLI/Util.hs b/cardano-cli/test/cardano-cli-test-lib/Test/Cardano/CLI/Util.hs
@@ -3,7 +3,7 @@ module Test.Cardano.CLI.Util
   , checkTextEnvelopeFormat
   , equivalence
   , execCardanoCLI
-  , execDetailCardanoCli
+  , execDetailCardanoCLI
   , tryExecCardanoCLI
   , propertyOnce
   , withSnd
@@ -64,13 +64,13 @@ execCardanoCLI = GHC.withFrozenCallStack $ H.execFlex "cardano-cli" "CARDANO_CLI
 -- | Execute cardano-cli via the command line, expecting it to fail.
 --
 -- Waits for the process to finish and returns the exit code, stdout and stderr.
-execDetailCardanoCli
+execDetailCardanoCLI
   :: (MonadTest m, MonadCatch m, MonadIO m, HasCallStack)
   => [String]
   -- ^ Arguments to the CLI command
   -> m (IO.ExitCode, String, String)
   -- ^ Captured stdout
-execDetailCardanoCli = GHC.withFrozenCallStack $ execDetailFlex H.defaultExecConfig "cardano-cli" "CARDANO_CLI"
+execDetailCardanoCLI = GHC.withFrozenCallStack $ execDetailFlex H.defaultExecConfig "cardano-cli" "CARDANO_CLI"
 
 procFlex'
   :: (MonadTest m, MonadCatch m, MonadIO m, HasCallStack)