WIP: Add support for supplementary datums

IntersectMBO · Sep 18, 2024 · a8f6ad3 · a8f6ad3
1 parent ca49409
commit a8f6ad3
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 3 deletions.
diff --git a/cardano-cli/src/Cardano/CLI/Byron/Parsers.hs b/cardano-cli/src/Cardano/CLI/Byron/Parsers.hs
@@ -24,7 +24,7 @@ module Cardano.CLI.Byron.Parsers
   )
 where
 
-import           Cardano.Api hiding (GenesisParameters, UpdateProposal, parseFilePath)
+import           Cardano.Api hiding (GenesisParameters, UpdateProposal)
 import           Cardano.Api.Byron (Address (..), ByronProtocolParametersUpdate (..),
                    toByronLovelace)
 import qualified Cardano.Api.Ledger as L

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Commands/Transaction.hs b/cardano-cli/src/Cardano/CLI/EraBased/Commands/Transaction.hs
@@ -75,6 +75,7 @@ data TransactionBuildRawCmdArgs era = TransactionBuildRawCmdArgs
   , metadataSchema :: !TxMetadataJsonSchema
   , scriptFiles :: ![ScriptFile]
   -- ^ Auxiliary scripts
+  , supplementaryDatums :: ![ScriptDataOrFile]
   , metadataFiles :: ![MetadataFile]
   , mProtocolParamsFile :: !(Maybe ProtocolParamsFile)
   , mUpdateProprosalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
@@ -124,6 +125,7 @@ data TransactionBuildCmdArgs era = TransactionBuildCmdArgs
   , metadataSchema :: !TxMetadataJsonSchema
   , scriptFiles :: ![ScriptFile]
   -- ^ Auxiliary scripts
+  , supplementaryDatums :: ![ScriptDataOrFile]
   , metadataFiles :: ![MetadataFile]
   , mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
   , voteFiles :: ![(VoteFile In, Maybe (ScriptWitnessFiles WitCtxStake))]
@@ -174,6 +176,7 @@ data TransactionBuildEstimateCmdArgs era = TransactionBuildEstimateCmdArgs
   , metadataSchema :: !TxMetadataJsonSchema
   , scriptFiles :: ![ScriptFile]
   -- ^ Auxiliary scripts
+  , supplementaryDatums :: ![ScriptDataOrFile]
   , metadataFiles :: ![MetadataFile]
   , mUpdateProposalFile :: !(Maybe (Featured ShelleyToBabbageEra era (Maybe UpdateProposalFile)))
   , voteFiles :: ![(VoteFile In, Maybe (ScriptWitnessFiles WitCtxStake))]

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Common.hs
@@ -12,9 +12,9 @@
 
 module Cardano.CLI.EraBased.Options.Common where
 
-import           Cardano.Api hiding (bounded, parseFilePath)
+import           Cardano.Api 
 import qualified Cardano.Api.Ledger as L
-import           Cardano.Api.Shelley hiding (bounded, parseFilePath)
+import           Cardano.Api.Shelley
 
 import           Cardano.CLI.Environment (EnvCli (..), envCliAnyShelleyBasedEra,
                    envCliAnyShelleyToBabbageEra)

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Transaction.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Transaction.hs
@@ -196,6 +196,7 @@ pTransactionBuildCmd era envCli = do
               Nothing
               "Filepath of auxiliary script(s)"
           )
+        <*> many (pScriptDataOrFile "supplementary-datum" "The supplementary datum." "The supplementary datum file.")
         <*> many pMetadataFile
         <*> pFeatured (toCardanoEra sbe) (optional pUpdateProposalFile)
         <*> pVoteFiles sbe AutoBalance
@@ -256,6 +257,7 @@ pTransactionBuildEstimateCmd era _envCli = do
               Nothing
               "Filepath of auxiliary script(s)"
           )
+        <*> many (pScriptDataOrFile "supplementary-datum" "The supplementary datum." "The supplementary datum file.") 
         <*> many pMetadataFile
         <*> pFeatured (toCardanoEra sbe) (optional pUpdateProposalFile)
         <*> pVoteFiles sbe ManualBalance
@@ -293,6 +295,7 @@ pTransactionBuildRaw era =
       <*> many (pWithdrawal era ManualBalance)
       <*> pTxMetadataJsonSchema
       <*> many (pScriptFor "auxiliary-script-file" Nothing "Filepath of auxiliary script(s)")
+      <*> many (pScriptDataOrFile "supplementary-datum" "The supplementary datum." "The supplementary datum file.")
       <*> many pMetadataFile
       <*> optional pProtocolParamsFile
       <*> pFeatured era (optional pUpdateProposalFile)

diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Run/Transaction.hs b/cardano-cli/src/Cardano/CLI/EraBased/Run/Transaction.hs
@@ -128,6 +128,7 @@ runTransactionBuildCmd
     , certificates
     , withdrawals
     , metadataSchema
+    , supplementaryDatums
     , scriptFiles
     , metadataFiles
     , mUpdateProposalFile
@@ -174,6 +175,10 @@ runTransactionBuildCmd
               firstExceptT TxCmdMetadataError . newExceptT $
                 readTxMetadata eon metadataSchema metadataFiles
             valuesWithScriptWits <- readValueScriptWitnesses eon $ fromMaybe mempty mValue
+
+            txSupplementaryDatums <- 
+              firstExceptT TxCmdScriptDataError $ readTxSupplementaryDatums supplementaryDatums
+
             scripts <-
               firstExceptT TxCmdScriptFileError $
                 mapM (readFileScriptInAnyLang . unFile) scriptFiles
@@ -261,6 +266,7 @@ runTransactionBuildCmd
                 withdrawalsAndMaybeScriptWits
                 requiredSigners
                 txAuxScripts
+                txSupplementaryDatums
                 txMetadata
                 mProp
                 mOverrideWitnesses
@@ -340,6 +346,7 @@ runTransactionBuildEstimateCmd -- TODO change type
     , withdrawals
     , metadataSchema
     , scriptFiles
+    , supplementaryDatums
     , metadataFiles
     , mUpdateProposalFile
     , voteFiles
@@ -373,6 +380,9 @@ runTransactionBuildEstimateCmd -- TODO change type
     txAuxScripts <-
       hoistEither $ first TxCmdAuxScriptsValidationError $ validateTxAuxScripts sbe scripts
 
+    txSupplementalDatums <- 
+      firstExceptT TxCmdScriptDataError $ readTxSupplementaryDatums supplementaryDatums
+
     txUpdateProposal <- case mUpdateProposalFile of
       Just (Featured w (Just updateProposalFile)) ->
         readTxUpdateProposal w updateProposalFile & firstExceptT TxCmdReadTextViewFileError
@@ -434,6 +444,7 @@ runTransactionBuildEstimateCmd -- TODO change type
           requiredSigners
           0
           txAuxScripts
+          txSupplementalDatums
           txMetadata
           txUpdateProposal
           votingProceduresAndMaybeScriptWits
@@ -584,6 +595,7 @@ runTransactionBuildRawCmd
     , withdrawals
     , metadataSchema
     , scriptFiles
+    , supplementaryDatums
     , metadataFiles
     , mProtocolParamsFile
     , mUpdateProprosalFile
@@ -610,6 +622,10 @@ runTransactionBuildRawCmd
     scripts <-
       firstExceptT TxCmdScriptFileError $
         mapM (readFileScriptInAnyLang . unFile) scriptFiles
+
+    txSupplementaryDatums <- 
+      firstExceptT TxCmdScriptDataError $ readTxSupplementaryDatums supplementaryDatums
+
     txAuxScripts <-
       hoistEither $ first TxCmdAuxScriptsValidationError $ validateTxAuxScripts eon scripts
 
@@ -677,6 +693,7 @@ runTransactionBuildRawCmd
           withdrawalsAndMaybeScriptWits
           requiredSigners
           txAuxScripts
+          txSupplementaryDatums
           txMetadata
           mLedgerPParams
           txUpdateProposal
@@ -718,6 +735,7 @@ runTxBuildRaw
   -> [Hash PaymentKey]
   -- ^ Required signers
   -> TxAuxScripts era
+  -> TxSupplementalDatums era
   -> TxMetadataInEra era
   -> Maybe (LedgerProtocolParameters era)
   -> TxUpdateProposal era
@@ -742,6 +760,7 @@ runTxBuildRaw
   withdrawals
   reqSigners
   txAuxScripts
+  txSupplementalDatums
   txMetadata
   mpparams
   txUpdateProposal
@@ -767,6 +786,7 @@ runTxBuildRaw
         reqSigners
         fee
         txAuxScripts
+        txSupplementalDatums
         txMetadata
         txUpdateProposal
         votingProcedures
@@ -807,6 +827,7 @@ constructTxBodyContent
   -> Lovelace
   -- ^ Tx fee
   -> TxAuxScripts era
+  -> TxSupplementalDatums era
   -> TxMetadataInEra era
   -> TxUpdateProposal era
   -> [(VotingProcedures era, Maybe (ScriptWitness WitCtxStake era))]
@@ -834,6 +855,7 @@ constructTxBodyContent
   reqSigners
   fee
   txAuxScripts
+  txSupplementalDatums
   txMetadata
   txUpdateProposal
   votingProcedures
@@ -893,6 +915,7 @@ constructTxBodyContent
               & setTxValidityLowerBound validatedLowerBound
               & setTxValidityUpperBound mUpperBound
               & setTxMetadata txMetadata
+              & setTxSupplementalDatums txSupplementalDatums
               & setTxAuxScripts txAuxScripts
               & setTxExtraKeyWits validatedReqSigners
               & setTxProtocolParams (BuildTxWith $ LedgerProtocolParameters <$> mPparams)
@@ -948,6 +971,7 @@ runTxBuild
   -> [Hash PaymentKey]
   -- ^ Required signers
   -> TxAuxScripts era
+  -> TxSupplementalDatums era
   -> TxMetadataInEra era
   -> TxUpdateProposal era
   -> Maybe Word
@@ -975,6 +999,7 @@ runTxBuild
   withdrawals
   reqSigners
   txAuxScripts
+  txSupplementaryData
   txMetadata
   txUpdateProposal
   mOverrideWits
@@ -1047,6 +1072,7 @@ runTxBuild
             reqSigners
             0
             txAuxScripts
+            txSupplementaryData
             txMetadata
             txUpdateProposal
             votingProcedures

diff --git a/cardano-cli/src/Cardano/CLI/Json/Friendly.hs b/cardano-cli/src/Cardano/CLI/Json/Friendly.hs
@@ -217,6 +217,7 @@ friendlyTxBodyImpl
             txValidityUpperBound
             txMetadata
             txAuxScripts
+            _txSupplementalDatums
             txExtraKeyWits
             _txProtocolParams
             txWithdrawals

diff --git a/cardano-cli/src/Cardano/CLI/Legacy/Run/Transaction.hs b/cardano-cli/src/Cardano/CLI/Legacy/Run/Transaction.hs
@@ -263,6 +263,7 @@ runLegacyTransactionBuildCmd
           wdrls
           metadataSchema
           scriptFiles
+          []
           metadataFiles
           mUpdateProposalFile
           voteFiles
@@ -391,6 +392,7 @@ runLegacyTransactionBuildRawCmd
                 wdrls
                 metadataSchema
                 scriptFiles
+                []
                 metadataFiles
                 mProtocolParamsFile
                 mUpdateProposalFile

diff --git a/cardano-cli/src/Cardano/CLI/Read.hs b/cardano-cli/src/Cardano/CLI/Read.hs
@@ -28,6 +28,7 @@ module Cardano.CLI.Read
   , ScriptDataError (..)
   , readScriptDatumOrFile
   , readScriptRedeemerOrFile
+  , readTxSupplementaryDatums
   , renderScriptDataError
 
     -- * Tx
@@ -485,6 +486,11 @@ readScriptDataOrFile (ScriptDataCborFile fp) = do
         getScriptData hSd
   return hSd
 
+readTxSupplementaryDatums ::  [ScriptDataOrFile] -> ExceptT ScriptDataError IO (TxSupplementalDatums era)
+readTxSupplementaryDatums supplementaryDatums = 
+  TxSupplementalDatums <$> mapM readScriptDataOrFile supplementaryDatums
+
+
 readVerificationKeyOrHashOrFileOrScript
   :: MonadIOTransError (Either (FileError ScriptDecodeError) (FileError InputDecodeError)) t m
   => Key keyrole