Merge pull request #365 from input-output-hk/newhoggy/build-raw-conwa…

…y-support `transaction build-raw` support for `--vote-file` and `--proposal-file`
IntersectMBO · Oct 12, 2023 · fea0796 · fea0796
2 parents 935d5e8 + d86ff89
commit fea0796
Show file tree

Hide file tree

Showing 12 changed files with 93 additions and 21 deletions.
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Commands/Transaction.hs b/cardano-cli/src/Cardano/CLI/EraBased/Commands/Transaction.hs
@@ -48,6 +48,8 @@ data TransactionCmds era
       [MetadataFile]
       (Maybe ProtocolParamsFile)
       (Maybe UpdateProposalFile)
+      [VoteFile In]
+      [ProposalFile In]
       (TxBodyFile Out)
 
     -- | Like 'TxBuildRaw' but without the fee, and with a change output.

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Transaction.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Transaction.hs
@@ -211,6 +211,8 @@ pTransactionBuildRaw era =
     <*> many pMetadataFile
     <*> optional pProtocolParamsFile
     <*> optional pUpdateProposalFile
+    <*> many (pFileInDirection "vote-file" "Filepath of the vote.")
+    <*> many (pFileInDirection "proposal-file" "Filepath of the proposal.")
     <*> pTxBodyFileOut
 
 pTransactionSign  :: EnvCli -> Parser (TransactionCmds era)

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Run/Transaction.hs b/cardano-cli/src/Cardano/CLI/EraBased/Run/Transaction.hs
@@ -79,20 +79,24 @@ runTransactionCmds cmd =
     TxBuild
         era mNodeSocketPath consensusModeParams nid mScriptValidity mOverrideWits txins readOnlyRefIns
         reqSigners txinsc mReturnColl mTotCollateral txouts changeAddr mValue mLowBound
-        mUpperBound certs wdrls metadataSchema scriptFiles metadataFiles mUpProp mconwayVote
-        mNewConstitution outputOptions ->
+        mUpperBound certs wdrls metadataSchema scriptFiles metadataFiles mUpProp voteFiles
+        proposalFiles outputOptions ->
       runTxBuildCmd
         era mNodeSocketPath consensusModeParams nid mScriptValidity mOverrideWits txins readOnlyRefIns
         reqSigners txinsc mReturnColl mTotCollateral txouts changeAddr mValue mLowBound
-        mUpperBound certs wdrls metadataSchema scriptFiles metadataFiles mUpProp mconwayVote
-        mNewConstitution outputOptions
+        mUpperBound certs wdrls metadataSchema scriptFiles metadataFiles mUpProp voteFiles
+        proposalFiles outputOptions
     TxBuildRaw
         era mScriptValidity txins readOnlyRefIns txinsc mReturnColl
         mTotColl reqSigners txouts mValue mLowBound mUpperBound fee certs wdrls
-        metadataSchema scriptFiles metadataFiles mProtocolParamsFile mUpProp out ->
+        metadataSchema scriptFiles metadataFiles mProtocolParamsFile mUpProp
+        voteFiles proposalFiles
+        out ->
       runTxBuildRawCmd era mScriptValidity txins readOnlyRefIns txinsc mReturnColl
         mTotColl reqSigners txouts mValue mLowBound mUpperBound fee certs wdrls
-        metadataSchema scriptFiles metadataFiles mProtocolParamsFile mUpProp out
+        metadataSchema scriptFiles metadataFiles mProtocolParamsFile mUpProp
+        voteFiles proposalFiles
+        out
     TxSign txinfile skfiles network txoutfile ->
       runTxSignCmd txinfile skfiles network txoutfile
     TxSubmit mNodeSocketPath anyConsensusModeParams network txFp ->
@@ -150,7 +154,7 @@ runTxBuildCmd
     era socketPath consensusModeParams@(AnyConsensusModeParams cModeParams) nid
     mScriptValidity mOverrideWits txins readOnlyRefIns reqSigners txinsc mReturnColl mTotCollateral txouts
     changeAddr mValue mLowBound mUpperBound certs wdrls metadataSchema scriptFiles metadataFiles mUpProp
-    conwayVotes newProposals outputOptions = do
+    voteFiles proposalFiles outputOptions = do
 
   -- The user can specify an era prior to the era that the node is currently in.
   -- We cannot use the user specified era to construct a query against a node because it may differ
@@ -192,14 +196,14 @@ runTxBuildCmd
   txOuts <- mapM (toTxOutInAnyEra era) txouts
 
   -- Conway related
-  votes <-
+  votingProcedures <-
     inEonForEra
       (pure emptyVotingProcedures)
-      (\w -> firstExceptT TxCmdVoteError $ ExceptT (readVotingProceduresFiles w conwayVotes))
+      (\w -> firstExceptT TxCmdVoteError $ ExceptT (readVotingProceduresFiles w voteFiles))
       era
 
   proposals <- newExceptT $ first TxCmdConstitutionError
-                  <$> readTxGovernanceActions era newProposals
+                  <$> readTxGovernanceActions era proposalFiles
 
   -- the same collateral input can be used for several plutus scripts
   let filteredTxinsc = Set.toList $ Set.fromList txinsc
@@ -210,7 +214,7 @@ runTxBuildCmd
       era socketPath consensusModeParams nid mScriptValidity inputsAndMaybeScriptWits readOnlyRefIns filteredTxinsc
       mReturnCollateral mTotCollateral txOuts changeAddr valuesWithScriptWits mLowBound
       mUpperBound certsAndMaybeScriptWits withdrawalsAndMaybeScriptWits
-      requiredSigners txAuxScripts txMetadata mProp mOverrideWits votes proposals outputOptions
+      requiredSigners txAuxScripts txMetadata mProp mOverrideWits votingProcedures proposals outputOptions
 
   let mScriptWits =
         forEraInEon era [] $ \sbe -> collectTxBodyScriptWitnesses sbe txBodyContent
@@ -305,12 +309,15 @@ runTxBuildRawCmd
   -> [MetadataFile]
   -> Maybe ProtocolParamsFile
   -> Maybe UpdateProposalFile
+  -> [VoteFile In]
+  -> [ProposalFile In]
   -> TxBodyFile Out
   -> ExceptT TxCmdError IO ()
 runTxBuildRawCmd
   era mScriptValidity txins readOnlyRefIns txinsc mReturnColl
   mTotColl reqSigners txouts mValue mLowBound mUpperBound fee certs wdrls
-  metadataSchema scriptFiles metadataFiles mpParamsFile mUpProp out = do
+  metadataSchema scriptFiles metadataFiles mpParamsFile mUpProp
+  voteFiles proposalFiles out = do
   inputsAndMaybeScriptWits <- firstExceptT TxCmdScriptWitnessError
                                 $ readScriptWitnessFiles era txins
   certFilesAndMaybeScriptWits <- firstExceptT TxCmdScriptWitnessError
@@ -357,10 +364,21 @@ runTxBuildRawCmd
     -- the same collateral input can be used for several plutus scripts
   let filteredTxinsc = Set.toList $ Set.fromList txinsc
 
+  -- Conway related
+  votingProcedures <-
+    inEonForEra
+      (pure emptyVotingProcedures)
+      (\w -> firstExceptT TxCmdVoteError $ ExceptT (readVotingProceduresFiles w voteFiles))
+      era
+
+  proposals <-
+    lift (readTxGovernanceActions era proposalFiles)
+      & onLeft (left . TxCmdConstitutionError)
+
   txBody <- hoistEither $ runTxBuildRaw era mScriptValidity inputsAndMaybeScriptWits readOnlyRefIns filteredTxinsc
                           mReturnCollateral mTotColl txOuts mLowBound mUpperBound fee valuesWithScriptWits
                           certsAndMaybeScriptWits withdrawalsAndMaybeScriptWits requiredSigners txAuxScripts
-                          txMetadata mLedgerPParams mProp
+                          txMetadata mLedgerPParams mProp votingProcedures proposals
 
   let noWitTx = makeSignedTransaction [] txBody
   lift (cardanoEraConstraints era $ writeTxFileTextEnvelopeCddl out noWitTx)
@@ -399,6 +417,8 @@ runTxBuildRaw :: ()
   -> TxMetadataInEra era
   -> Maybe (LedgerProtocolParameters era)
   -> Maybe UpdateProposal
+  -> VotingProcedures era
+  -> [Proposal era]
   -> Either TxCmdError (TxBody era)
 runTxBuildRaw era
               mScriptValidity inputsAndMaybeScriptWits
@@ -407,7 +427,7 @@ runTxBuildRaw era
               mLowerBound mUpperBound
               mFee valuesWithScriptWits
               certsAndMaybeSriptWits withdrawals reqSigners
-              txAuxScripts txMetadata mpparams mUpdateProp = do
+              txAuxScripts txMetadata mpparams mUpdateProp votingProcedures proposals = do
 
     let allReferenceInputs = getAllReferenceInputs
                                inputsAndMaybeScriptWits
@@ -440,8 +460,8 @@ runTxBuildRaw era
       <- createTxMintValue era valuesWithScriptWits
     validatedTxScriptValidity
       <- first TxCmdScriptValidityValidationError $ validateTxScriptValidity era mScriptValidity
-    let validatedTxProposalProcedures = Nothing -- TODO: Conwary era
-        validatedTxVotes = Nothing -- TODO: Conwary era
+    let validatedTxProposal = proposals
+        validatedTxVotes = votingProcedures
     let txBodyContent =
           TxBodyContent
             { txIns = validateTxIns inputsAndMaybeScriptWits
@@ -461,8 +481,8 @@ runTxBuildRaw era
             , txUpdateProposal = validatedTxUpProp
             , txMintValue = validatedMintValue
             , txScriptValidity = validatedTxScriptValidity
-            , txProposalProcedures = validatedTxProposalProcedures
-            , txVotingProcedures = validatedTxVotes
+            , txProposalProcedures = forEraInEonMaybe era (`Featured` validatedTxProposal)
+            , txVotingProcedures = forEraInEonMaybe era (`Featured` validatedTxVotes)
             }
 
     first TxCmdTxBodyError $
@@ -513,7 +533,7 @@ runTxBuild
     inputsAndMaybeScriptWits readOnlyRefIns txinsc mReturnCollateral mTotCollateral txouts
     (TxOutChangeAddress changeAddr) valuesWithScriptWits mLowerBound mUpperBound
     certsAndMaybeScriptWits withdrawals reqSigners txAuxScripts txMetadata
-    mUpdatePropF mOverrideWits votes proposals outputOptions = do
+    mUpdatePropF mOverrideWits votingProcedures proposals outputOptions = do
 
   let consensusMode = consensusModeOnly cModeParams
       dummyFee = Just $ Lovelace 0
@@ -575,7 +595,7 @@ runTxBuild
                                       $ validateProtocolParameters era (Just pparams)
 
       let validatedTxProposalProcedures = proposals
-          validatedTxVotes = votes
+          validatedTxVotes = votingProcedures
           txBodyContent =
             TxBodyContent
               { txIns = validateTxIns inputsAndMaybeScriptWits

diff --git a/cardano-cli/src/Cardano/CLI/Legacy/Run/Transaction.hs b/cardano-cli/src/Cardano/CLI/Legacy/Run/Transaction.hs
@@ -114,7 +114,13 @@ runLegacyTxBuildRawCmd :: ()
   -> Maybe UpdateProposalFile
   -> TxBodyFile Out
   -> ExceptT TxCmdError IO ()
-runLegacyTxBuildRawCmd (AnyCardanoEra era) = runTxBuildRawCmd era
+runLegacyTxBuildRawCmd
+    (AnyCardanoEra era) mScriptValidity txins readOnlyRefIns txinsc mReturnColl
+    mTotColl reqSigners txouts mValue mLowBound mUpperBound fee certs wdrls
+    metadataSchema scriptFiles metadataFiles mProtocolParamsFile mUpProp =
+  runTxBuildRawCmd era mScriptValidity txins readOnlyRefIns txinsc mReturnColl
+    mTotColl reqSigners txouts mValue mLowBound mUpperBound fee certs wdrls
+    metadataSchema scriptFiles metadataFiles mProtocolParamsFile mUpProp [] []
 
 runLegacyTxSignCmd :: InputTxBodyOrTxFile
           -> [WitnessSigningData]

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli
@@ -915,6 +915,8 @@ Usage: cardano-cli shelley transaction build-raw
                                                    ]
                                                    [--protocol-params-file FILE]
                                                    [--update-proposal-file FILE]
+                                                   [--vote-file FILE]
+                                                   [--proposal-file FILE]
                                                    --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -2069,6 +2071,8 @@ Usage: cardano-cli allegra transaction build-raw
                                                    ]
                                                    [--protocol-params-file FILE]
                                                    [--update-proposal-file FILE]
+                                                   [--vote-file FILE]
+                                                   [--proposal-file FILE]
                                                    --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -3210,6 +3214,8 @@ Usage: cardano-cli mary transaction build-raw
                                                 ]
                                                 [--protocol-params-file FILE]
                                                 [--update-proposal-file FILE]
+                                                [--vote-file FILE]
+                                                [--proposal-file FILE]
                                                 --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -4349,6 +4355,8 @@ Usage: cardano-cli alonzo transaction build-raw
                                                   ]
                                                   [--protocol-params-file FILE]
                                                   [--update-proposal-file FILE]
+                                                  [--vote-file FILE]
+                                                  [--proposal-file FILE]
                                                   --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -5527,6 +5535,8 @@ Usage: cardano-cli babbage transaction build-raw
                                                    ]
                                                    [--protocol-params-file FILE]
                                                    [--update-proposal-file FILE]
+                                                   [--vote-file FILE]
+                                                   [--proposal-file FILE]
                                                    --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -7083,6 +7093,8 @@ Usage: cardano-cli conway transaction build-raw
                                                   ]
                                                   [--protocol-params-file FILE]
                                                   [--update-proposal-file FILE]
+                                                  [--vote-file FILE]
+                                                  [--proposal-file FILE]
                                                   --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -8258,6 +8270,8 @@ Usage: cardano-cli latest transaction build-raw
                                                   ]
                                                   [--protocol-params-file FILE]
                                                   [--update-proposal-file FILE]
+                                                  [--vote-file FILE]
+                                                  [--proposal-file FILE]
                                                   --out-file FILE
 
   Build a transaction (low-level, inconvenient)

diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_transaction_build-raw.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_transaction_build-raw.cli
@@ -113,6 +113,8 @@ Usage: cardano-cli allegra transaction build-raw
                                                    ]
                                                    [--protocol-params-file FILE]
                                                    [--update-proposal-file FILE]
+                                                   [--vote-file FILE]
+                                                   [--proposal-file FILE]
                                                    --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -381,5 +383,7 @@ Available options:
                            Filepath of the JSON-encoded protocol parameters file
   --update-proposal-file FILE
                            Filepath of the update proposal.
+  --vote-file FILE         Filepath of the vote.
+  --proposal-file FILE     Filepath of the proposal.
   --out-file FILE          Output filepath of the JSON TxBody.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_transaction_build-raw.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_transaction_build-raw.cli
@@ -113,6 +113,8 @@ Usage: cardano-cli alonzo transaction build-raw
                                                   ]
                                                   [--protocol-params-file FILE]
                                                   [--update-proposal-file FILE]
+                                                  [--vote-file FILE]
+                                                  [--proposal-file FILE]
                                                   --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -381,5 +383,7 @@ Available options:
                            Filepath of the JSON-encoded protocol parameters file
   --update-proposal-file FILE
                            Filepath of the update proposal.
+  --vote-file FILE         Filepath of the vote.
+  --proposal-file FILE     Filepath of the proposal.
   --out-file FILE          Output filepath of the JSON TxBody.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_transaction_build-raw.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_transaction_build-raw.cli
@@ -113,6 +113,8 @@ Usage: cardano-cli babbage transaction build-raw
                                                    ]
                                                    [--protocol-params-file FILE]
                                                    [--update-proposal-file FILE]
+                                                   [--vote-file FILE]
+                                                   [--proposal-file FILE]
                                                    --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -381,5 +383,7 @@ Available options:
                            Filepath of the JSON-encoded protocol parameters file
   --update-proposal-file FILE
                            Filepath of the update proposal.
+  --vote-file FILE         Filepath of the vote.
+  --proposal-file FILE     Filepath of the proposal.
   --out-file FILE          Output filepath of the JSON TxBody.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_transaction_build-raw.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_transaction_build-raw.cli
@@ -113,6 +113,8 @@ Usage: cardano-cli conway transaction build-raw
                                                   ]
                                                   [--protocol-params-file FILE]
                                                   [--update-proposal-file FILE]
+                                                  [--vote-file FILE]
+                                                  [--proposal-file FILE]
                                                   --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -381,5 +383,7 @@ Available options:
                            Filepath of the JSON-encoded protocol parameters file
   --update-proposal-file FILE
                            Filepath of the update proposal.
+  --vote-file FILE         Filepath of the vote.
+  --proposal-file FILE     Filepath of the proposal.
   --out-file FILE          Output filepath of the JSON TxBody.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_transaction_build-raw.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_transaction_build-raw.cli
@@ -113,6 +113,8 @@ Usage: cardano-cli latest transaction build-raw
                                                   ]
                                                   [--protocol-params-file FILE]
                                                   [--update-proposal-file FILE]
+                                                  [--vote-file FILE]
+                                                  [--proposal-file FILE]
                                                   --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -381,5 +383,7 @@ Available options:
                            Filepath of the JSON-encoded protocol parameters file
   --update-proposal-file FILE
                            Filepath of the update proposal.
+  --vote-file FILE         Filepath of the vote.
+  --proposal-file FILE     Filepath of the proposal.
   --out-file FILE          Output filepath of the JSON TxBody.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/mary_transaction_build-raw.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/mary_transaction_build-raw.cli
@@ -113,6 +113,8 @@ Usage: cardano-cli mary transaction build-raw
                                                 ]
                                                 [--protocol-params-file FILE]
                                                 [--update-proposal-file FILE]
+                                                [--vote-file FILE]
+                                                [--proposal-file FILE]
                                                 --out-file FILE
 
   Build a transaction (low-level, inconvenient)
@@ -381,5 +383,7 @@ Available options:
                            Filepath of the JSON-encoded protocol parameters file
   --update-proposal-file FILE
                            Filepath of the update proposal.
+  --vote-file FILE         Filepath of the vote.
+  --proposal-file FILE     Filepath of the proposal.
   --out-file FILE          Output filepath of the JSON TxBody.
   -h,--help                Show this help text