Skip to content

Fix supplemental datum propagation in transaction build #1341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carbolymer merged 2 commits into from
Mar 3, 2026
Merged

Fix supplemental datum propagation in transaction build #1341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e50737f
Potential supplementary datum fix
Jimbo4350 Feb 23, 2026
8e3411e
Remove cardano-api SRP
carbolymer Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cabal.project
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ repository cardano-haskell-packages
-- you need to run if you change them
index-state:
, hackage.haskell.org 2026-02-06T20:27:32Z
, cardano-haskell-packages 2026-02-18T15:43:28Z
, cardano-haskell-packages 2026-02-27T19:25:49Z

packages:
cardano-cli
Expand Down
56 changes: 41 additions & 15 deletions cardano-cli/src/Cardano/CLI/EraBased/Transaction/Run.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ import Cardano.CLI.Type.Error.TxCmdError
import Cardano.CLI.Type.Error.TxValidationError
import Cardano.CLI.Type.Output (renderScriptCostsWithScriptHashesMap)
import Cardano.Ledger.Api (allInputsTxBodyF, bodyTxL)
import Cardano.Ledger.Hashes (DataHash)
import Cardano.Prelude (putLByteString)

import RIO hiding (toList)
Expand Down Expand Up @@ -203,13 +204,14 @@ runTransactionBuildCmd

requiredSigners <-
mapM (fromEitherIOCli . readRequiredSigner) reqSigners
mReturnCollateral :: Maybe (Exp.TxOut (Exp.LedgerEra era)) <-
mReturnCollateralAndDatums <-
forM mReturnColl toTxOutInShelleyBasedEra
let mReturnCollateral = fst <$> mReturnCollateralAndDatums
returnCollDatums = maybe mempty snd mReturnCollateralAndDatums

txOuts <-
mapM
toTxOutInEra
txouts
txOutsAndDatums <- mapM toTxOutInEra txouts
let txOuts = map fst txOutsAndDatums
supplementalDatums = mconcat (map snd txOutsAndDatums) <> returnCollDatums

-- Conway related
votingProceduresAndMaybeScriptWits :: [(VotingProcedures era, Exp.AnyWitness (Exp.LedgerEra era))] <-
Expand Down Expand Up @@ -321,6 +323,7 @@ runTransactionBuildCmd
votingProceduresAndMaybeScriptWits
proposals
currentTreasuryValueAndDonation
supplementalDatums

-- TODO: Calculating the script cost should live as a different command.
-- Why? Because then we can simply read a txbody and figure out
Expand Down Expand Up @@ -374,7 +377,7 @@ runTransactionBuildCmd
toTxOutInEra
:: Exp.IsEra era
=> TxOutAnyEra
-> CIO e (Exp.TxOut (Exp.LedgerEra era))
-> CIO e (Exp.TxOut (Exp.LedgerEra era), Map.Map DataHash (L.Data (Exp.LedgerEra era)))
toTxOutInEra (TxOutAnyEra addr' val' mDatumHash refScriptFp) = do
let addr = anyAddressInShelleyBasedEra (convert Exp.useEra) addr'
o <- mkTxOut (convert Exp.useEra) addr val' mDatumHash refScriptFp
Expand Down Expand Up @@ -445,9 +448,13 @@ runTransactionBuildEstimateCmd -- TODO change type
requiredSigners <-
mapM (fromEitherIOCli . readRequiredSigner) reqSigners

mReturnCollateral <- mapM toTxOutInShelleyBasedEra mReturnColl
mReturnCollateralAndDatums <- mapM toTxOutInShelleyBasedEra mReturnColl
let mReturnCollateral = fst <$> mReturnCollateralAndDatums
returnCollDatums = maybe mempty snd mReturnCollateralAndDatums

txOuts <- mapM toTxOutInEra txouts
txOutsAndDatums <- mapM toTxOutInEra txouts
let txOuts = map fst txOutsAndDatums
supplementalDatums = mconcat (map snd txOutsAndDatums) <> returnCollDatums

-- the same collateral input can be used for several plutus scripts
let filteredTxinsc = nubOrd txInsCollateral
Expand Down Expand Up @@ -498,6 +505,7 @@ runTransactionBuildEstimateCmd -- TODO change type
votingProceduresAndMaybeScriptWits
proposals
currentTreasuryValueAndDonation
supplementalDatums

let stakeCredentialsToDeregisterMap = fromList $ catMaybes [getStakeDeregistrationInfo cert | (cert, _) <- certsAndMaybeScriptWits]
drepsToDeregisterMap =
Expand Down Expand Up @@ -653,9 +661,13 @@ runTransactionBuildRawCmd
requiredSigners <-
mapM (fromEitherIOCli . readRequiredSigner) reqSigners

mReturnCollateral <- mapM toTxOutInShelleyBasedEra mReturnColl
mReturnCollateralAndDatums <- mapM toTxOutInShelleyBasedEra mReturnColl
let mReturnCollateral = fst <$> mReturnCollateralAndDatums
returnCollDatums = maybe mempty snd mReturnCollateralAndDatums

txOuts <- mapM toTxOutInEra txouts
txOutsAndDatums <- mapM toTxOutInEra txouts
let txOuts = map fst txOutsAndDatums
supplementalDatums = mconcat (map snd txOutsAndDatums) <> returnCollDatums

-- the same collateral input can be used for several plutus scripts
let filteredTxinsc = toList @(Set _) $ fromList txInsCollateral
Expand Down Expand Up @@ -700,6 +712,7 @@ runTransactionBuildRawCmd
votingProceduresAndMaybeScriptWits
proposals
currentTreasuryValueAndDonation
supplementalDatums
let Exp.UnsignedTx lTx = txBody
noWitTx = ShelleyTx (convert eon) lTx
fromEitherIOCli $
Expand Down Expand Up @@ -741,6 +754,8 @@ runTxBuildRaw
-> [(VotingProcedures era, Exp.AnyWitness (Exp.LedgerEra era))]
-> [(Proposal era, Exp.AnyWitness (Exp.LedgerEra era))]
-> Maybe (TxCurrentTreasuryValue, TxTreasuryDonation)
-> Map.Map DataHash (L.Data (Exp.LedgerEra era))
-- ^ Supplemental datums
-> Either TxCmdError (Exp.UnsignedTx (Exp.LedgerEra era))
runTxBuildRaw
mScriptValidity
Expand All @@ -762,7 +777,8 @@ runTxBuildRaw
mpparams
votingProcedures
proposals
mCurrentTreasuryValueAndDonation = do
mCurrentTreasuryValueAndDonation
suppDatums = do
txBodyContent <-
constructTxBodyContent
mScriptValidity
Expand All @@ -785,6 +801,7 @@ runTxBuildRaw
votingProcedures
proposals
mCurrentTreasuryValueAndDonation
suppDatums

return $ Exp.makeUnsignedTx Exp.useEra txBodyContent

Expand Down Expand Up @@ -827,6 +844,8 @@ constructTxBodyContent
-- ^ The current treasury value and the donation. This is a stop gap as the
-- semantics of the donation and treasury value depend on the script languages
-- being used.
-> Map.Map DataHash (L.Data (Exp.LedgerEra era))
-- ^ Supplemental datums
-> Either TxCmdError (Exp.TxBodyContent (Exp.LedgerEra era))
constructTxBodyContent
mScriptValidity
Expand All @@ -848,7 +867,8 @@ constructTxBodyContent
txMetadata
votingProcedures
proposals
mCurrentTreasuryValueAndDonation =
mCurrentTreasuryValueAndDonation
suppDatums =
do
let allReferenceInputs =
getAllReferenceInputs
Expand Down Expand Up @@ -912,6 +932,7 @@ constructTxBodyContent
& Exp.setTxProposalProcedures validatedTxProposals
& maybe id Exp.setTxCurrentTreasuryValue validatedCurrentTreasuryValue
& maybe id Exp.setTxTreasuryDonation validatedTreasuryDonation
& Exp.setTxSupplementalDatums suppDatums
)

convertWithdrawals
Expand Down Expand Up @@ -978,6 +999,8 @@ runTxBuild
-> [(Proposal era, Exp.AnyWitness (Exp.LedgerEra era))]
-> Maybe (TxCurrentTreasuryValue, TxTreasuryDonation)
-- ^ The current treasury value and the donation.
-> Map.Map DataHash (L.Data (Exp.LedgerEra era))
-- ^ Supplemental datums
-> ExceptT TxCmdError IO (Exp.UnsignedTx (Exp.LedgerEra era), Exp.TxBodyContent (Exp.LedgerEra era))
runTxBuild
socketPath
Expand All @@ -1002,7 +1025,8 @@ runTxBuild
mOverrideWits
votingProcedures
proposals
mCurrentTreasuryValueAndDonation = do
mCurrentTreasuryValueAndDonation
suppDatums = do
let sbe = convert (Exp.useEra @era)
shelleyBasedEraConstraints sbe $ do
-- TODO: All functions should be parameterized by ShelleyBasedEra
Expand Down Expand Up @@ -1068,6 +1092,7 @@ runTxBuild
votingProcedures
proposals
mCurrentTreasuryValueAndDonation
suppDatums

firstExceptT TxCmdTxInsDoNotExist
. hoistEither
Expand Down Expand Up @@ -1156,7 +1181,7 @@ getAllReferenceInputs
toTxOutInShelleyBasedEra
:: Exp.IsEra era
=> TxOutShelleyBasedEra
-> CIO e (Exp.TxOut (Exp.LedgerEra era))
-> CIO e (Exp.TxOut (Exp.LedgerEra era), Map.Map DataHash (L.Data (Exp.LedgerEra era)))
toTxOutInShelleyBasedEra (TxOutShelleyBasedEra addr' val' mDatumHash refScriptFp) = do
let sbe = convert Exp.useEra
addr = shelleyAddressInEra sbe addr'
Expand Down Expand Up @@ -1439,7 +1464,8 @@ runTransactionCalculateMinValueCmd
pp :: L.PParams (Exp.LedgerEra era) <-
fromExceptTCli @ProtocolParamsError
(obtainCommonConstraints era $ readProtocolParameters protocolParamsFile)
out <- obtainCommonConstraints era $ toTxOutInShelleyBasedEra txOut
(out, _suppDatums :: Map.Map DataHash (L.Data (Exp.LedgerEra era))) <-
Copy link

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The variable name _suppDatums uses an underscore prefix typically reserved for intentionally unused variables in Haskell, but includes an explicit type annotation. If the datums are truly unused here, remove the type annotation. If they might be used in the future, use a name without the underscore prefix like suppDatums.

Suggested change
(out, _suppDatums :: Map.Map DataHash (L.Data (Exp.LedgerEra era))) <-
(out, _suppDatums) <-

Copilot uses AI. Check for mistakes.
obtainCommonConstraints era $ toTxOutInShelleyBasedEra txOut

let minValue = Exp.calculateMinimumUTxO pp out
liftIO . IO.print $ minValue
Expand Down
2 changes: 1 addition & 1 deletion cardano-cli/test/cardano-cli-golden/files/golden/shelley/build-raw-tx-body-out-6.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"type": "Tx ConwayEra",
"description": "Ledger Cddl Format",
"cborHex": "84a300d90102818258202392d2b1200b5139fe555c81261697b29a8ccf561c5c783d46e78a479d977053000181a3005839016b837ca50316ee4e00033482ed128887d72c2bae5b0438d692dc1251b0c8b17595ebdb93c1f974be0a9b1ef26c474649d9c2ae766ed135cf011864028201d81842182a020ca104d9010281182af5f6"
"cborHex": "84a300d90102818258202392d2b1200b5139fe555c81261697b29a8ccf561c5c783d46e78a479d977053000181a3005839016b837ca50316ee4e00033482ed128887d72c2bae5b0438d692dc1251b0c8b17595ebdb93c1f974be0a9b1ef26c474649d9c2ae766ed135cf011864028201d81842182a020ca0f5f6"
}
6 changes: 3 additions & 3 deletions flake.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading