Add certificates to CLI interface in compatible transaction-sign

[carbolymer]

Changelog

- description: |
    Add certificates to CLI interface in `compatible transaction-sign` 
# uncomment types applicable to the change:
  type:
   - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
   - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Requires:

• Add certificates support in createCompatibleSignedTx. cardano-api#691

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• New tests are added if needed and existing tests are updated. See Running tests for more details
• Self-reviewed the diff

[smelc]

I guess it's not possible to move this one out of the case, to share the code between the two branches?

[carbolymer]

not really, those are two different files with different purposes

[smelc]

Code LGTM ✔️

cc @Jimbo4350 for approval

[Jimbo4350]

LGTM! Two minor comments.

[Jimbo4350]

Why the name change? This error is TxOut related.

[carbolymer]

I disagree, TxCmdError is much broader than just transaction outputs. I'm also reusing it in line 296.

[Jimbo4350]

Unnecessary forall era

[carbolymer]

I'm using scopedtypevariables to have the same era in functions in where

[Jimbo4350]

Are you using it for readability purposes? If not you can remove all mentions of era in the function body of runCompatibleTransactionCmd. It still builds:

diff --git a/cardano-cli/src/Cardano/CLI/Compatible/Transaction.hs b/cardano-cli/src/Cardano/CLI/Compatible/Transaction.hs
index 25468707e..606a0945d 100644
--- a/cardano-cli/src/Cardano/CLI/Compatible/Transaction.hs
+++ b/cardano-cli/src/Cardano/CLI/Compatible/Transaction.hs
@@ -2,7 +2,6 @@
 {-# LANGUAGE ExistentialQuantification #-}
 {-# LANGUAGE GADTs #-}
 {-# LANGUAGE LambdaCase #-}
-{-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TupleSections #-}
 
 module Cardano.CLI.Compatible.Transaction
@@ -218,8 +217,7 @@ instance Error CompatibleTransactionError where
     CompatibleScriptWitnessError e -> renderScriptWitnessError e
 
 runCompatibleTransactionCmd
-  :: forall era
-   . CompatibleTransactionCmds era
+  :: CompatibleTransactionCmds era
   -> ExceptT CompatibleTransactionError IO ()
 runCompatibleTransactionCmd
   ( CreateCompatibleSignedTransaction
@@ -243,7 +241,7 @@ runCompatibleTransactionCmd
       firstExceptT CompatibleScriptWitnessError $
         readScriptWitnessFiles sbe certificates
 
-    certsAndMaybeScriptWits :: [(Certificate era, Maybe (ScriptWitness WitCtxStake era))] <-
+    certsAndMaybeScriptWits  <-
       shelleyBasedEraConstraints sbe $
         sequence
           [ fmap
@@ -254,7 +252,7 @@ runCompatibleTransactionCmd
           | (CertificateFile certFile, mSwit) <- certFilesAndMaybeScriptWits
           ]
 
-    (protocolUpdates, votes) :: (AnyProtocolUpdate era, AnyVote era) <-
+    (protocolUpdates, votes) <-
       caseShelleyToBabbageOrConwayEraOnwards
         ( const $ do
             prop <- maybe (pure $ NoPParamsUpdate sbe) readUpdateProposalFile mUpdateProposal
@@ -326,26 +324,17 @@ runCompatibleTransactionCmd
       newExceptT $
         writeTxFileTextEnvelopeCddl sbe outputFp signedTx
    where
-    convertCertificates
-      :: [(Certificate era, Maybe (ScriptWitness WitCtxStake era))]
-      -> TxCertificates BuildTx era
     convertCertificates certsAndScriptWitnesses =
       TxCertificates sbe certs $ BuildTxWith reqWits
      where
       certs = map fst certsAndScriptWitnesses
       reqWits = fromList $ mapMaybe convert' certsAndScriptWitnesses
-      convert'
-        :: (Certificate era, Maybe (ScriptWitness WitCtxStake era))
-        -> Maybe (StakeCredential, Witness WitCtxStake era)
       convert' (cert, mScriptWitnessFiles) = do
         sCred <- selectStakeCredentialWitness cert
         Just . (sCred,) $ case mScriptWitnessFiles of
           Just sWit -> ScriptWitness ScriptWitnessForStakeAddr sWit
           Nothing -> KeyWitness KeyWitnessForStakeAddr
 
-    validateTxInsReference
-      :: [TxIn]
-      -> Either TxCmdError (TxInsReference era)
     validateTxInsReference [] = return TxInsReferenceNone
     validateTxInsReference allRefIns = do
       let era = toCardanoEra era

[carbolymer]

Yes it's mostly for readability. If you prefer to not have type signatures, I can remove them.

[neilmayhew]

I've cherry-picked the non-SRP commit to #986 where it's needed for the version of api that's about to be released. However, I see now that there are a few minor comments still needing to be addressed. Could you please resolve those and then I can re-pick the commit.

[carbolymer]

@neilmayhew thanks for letting me know. I'll merge this PR separately - I've disabled the feature for now in the integration branch.