Fix the deposit output to include any specified asset

v0d1ch · v0d1ch · commit 1e579652cbe7 · 2025-09-15T17:45:16.000+02:00
At this point we have increment failing wih H4.
diff --git a/hydra-cluster/bench/Bench/EndToEnd.hs b/hydra-cluster/bench/Bench/EndToEnd.hs
@@ -28,7 +28,7 @@ import Data.Set ((\\))
 import Data.Set qualified as Set
 import Data.Text (pack)
 import Data.Time (UTCTime (UTCTime), utctDayTime)
-import Hydra.Cardano.Api (NetworkId, SocketPath, Tx, TxId, UTxO, getVerificationKey, signTx)
+import Hydra.Cardano.Api (NetworkId, SocketPath, Tx, TxId, UTxO, getVerificationKey, lovelaceToValue, signTx)
 import Hydra.Chain.Backend (ChainBackend)
 import Hydra.Chain.Backend qualified as Backend
 import Hydra.Cluster.Faucet (FaucetLog (..), publishHydraScriptsAs, returnFundsToFaucet', seedFromFaucet)
@@ -352,7 +352,7 @@ seedNetwork backend Dataset{fundingTransaction, hydraNodeKeys} tracer = do
   fuelWith100Ada signingKey = do
     let vk = getVerificationKey signingKey
     putTextLn $ "Fuel node key " <> show vk
-    seedFromFaucet backend vk 100_000_000 tracer
+    seedFromFaucet backend vk (lovelaceToValue 100_000_000) tracer
 
 -- | Commit all (expected to exit) 'initialUTxO' from the dataset using the
 -- (assumed same sequence) of clients.
diff --git a/hydra-cluster/src/Hydra/Cluster/Faucet.hs b/hydra-cluster/src/Hydra/Cluster/Faucet.hs
@@ -52,21 +52,21 @@ seedFromFaucet ::
   -- | Recipient of the funds
   VerificationKey PaymentKey ->
   -- | Amount to get from faucet
-  Coin ->
+  Value ->
   Tracer IO FaucetLog ->
   IO UTxO
-seedFromFaucet backend receivingVerificationKey lovelace tracer = do
+seedFromFaucet backend receivingVerificationKey val tracer = do
   (faucetVk, faucetSk) <- keysFor Faucet
   networkId <- Backend.queryNetworkId backend
   seedTx <- retryOnExceptions tracer $ submitSeedTx faucetVk faucetSk networkId
   producedUTxO <- Backend.awaitTransaction backend seedTx receivingVerificationKey
   pure $ UTxO.filter (== toCtxUTxOTxOut (theOutput networkId)) producedUTxO
  where
   submitSeedTx faucetVk faucetSk networkId = do
-    faucetUTxO <- findFaucetUTxO networkId backend lovelace
+    faucetUTxO <- findFaucetUTxO networkId backend (selectLovelace val)
     let changeAddress = mkVkAddress networkId faucetVk
 
-    buildTransaction backend changeAddress faucetUTxO [] [theOutput networkId] >>= \case
+    buildTransaction backend changeAddress faucetUTxO (toList $ UTxO.inputSet faucetUTxO) [theOutput networkId] >>= \case
       Left e -> throwIO $ FaucetFailedToBuildTx{reason = e}
       Right tx -> do
         let signedTx = sign faucetSk $ getTxBody tx
@@ -78,7 +78,7 @@ seedFromFaucet backend receivingVerificationKey lovelace tracer = do
   theOutput networkId =
     TxOut
       (shelleyAddressInEra shelleyBasedEra (receivingAddress networkId))
-      (lovelaceToValue lovelace)
+      val
       TxOutDatumNone
       ReferenceScriptNone
 
@@ -152,7 +152,7 @@ seedFromFaucet_ ::
   Tracer IO FaucetLog ->
   IO ()
 seedFromFaucet_ backend vk ll tracer =
-  void $ seedFromFaucet backend vk ll tracer
+  void $ seedFromFaucet backend vk (lovelaceToValue ll) tracer
 
 -- | Return the remaining funds to the faucet
 returnFundsToFaucet ::
diff --git a/hydra-cluster/src/Hydra/Cluster/Scenarios.hs b/hydra-cluster/src/Hydra/Cluster/Scenarios.hs
diff --git a/hydra-cluster/src/HydraNode.hs b/hydra-cluster/src/HydraNode.hs
@@ -190,19 +190,19 @@ waitForAll tracer delay nodes expected = do
 -- Create a commit tx using the hydra-node for later submission.
 requestCommitTx :: HydraClient -> UTxO -> IO Tx
 requestCommitTx client utxos =
-  requestCommitTx' client utxos Nothing
+  requestCommitTx' client utxos Nothing Nothing
 
 -- | Helper to make it easy to obtain a commit tx using some wallet utxo and optional amount.
 -- Create a commit tx using the hydra-node for later submission.
-requestCommitTx' :: HydraClient -> UTxO -> Maybe Coin -> IO Tx
-requestCommitTx' HydraClient{apiHost = Host{hostname, port}} utxos amount =
+requestCommitTx' :: HydraClient -> UTxO -> Maybe Coin -> Maybe (Map PolicyId PolicyAssets) -> IO Tx
+requestCommitTx' HydraClient{apiHost = Host{hostname, port}} utxos amount tokens =
   runReq defaultHttpConfig request <&> commitTx . responseBody
  where
   request =
     Req.req
       POST
       (Req.http hostname /: "commit")
-      (ReqBodyJson $ SimpleCommitRequest @Tx utxos amount mempty)
+      (ReqBodyJson $ SimpleCommitRequest @Tx utxos amount tokens)
       (Proxy :: Proxy (JsonResponse (DraftCommitTxResponse Tx)))
       (Req.port (fromInteger . toInteger $ port))
 
diff --git a/hydra-cluster/test/Test/ChainObserverSpec.hs b/hydra-cluster/test/Test/ChainObserverSpec.hs
@@ -53,7 +53,7 @@ spec = do
 
                 (walletVk, walletSk) <- generate genKeyPair
 
-                commitUTxO <- seedFromFaucet backend walletVk 10_000_000 (contramap FromFaucet tracer)
+                commitUTxO <- seedFromFaucet backend walletVk (lovelaceToValue 10_000_000) (contramap FromFaucet tracer)
 
                 send hydraNode $ input "Init" []
 
diff --git a/hydra-cluster/test/Test/DirectChainSpec.hs b/hydra-cluster/test/Test/DirectChainSpec.hs
@@ -131,7 +131,7 @@ spec = around (showLogsOnFailure "DirectChainSpec") $ do
                 -- Mimic "external commit" by using different keys for Alice.
                 (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
 
-                aliceUTxO <- seedFromFaucet backend aliceExternalVk aliceCommitment (contramap FromFaucet tracer)
+                aliceUTxO <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommitment) (contramap FromFaucet tracer)
 
                 participants <- loadParticipants [Alice, Bob, Carol]
                 let headParameters = HeadParameters cperiod [alice, bob, carol]
@@ -211,7 +211,7 @@ spec = around (showLogsOnFailure "DirectChainSpec") $ do
             headId <- fst <$> aliceChain `observesInTimeSatisfying` hasInitTxWith headParameters participants
 
             (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-            aliceUTxO <- seedFromFaucet backend aliceExternalVk 1_000_000 (contramap FromFaucet tracer)
+            aliceUTxO <- seedFromFaucet backend aliceExternalVk (lovelaceToValue 1_000_000) (contramap FromFaucet tracer)
             externalCommit backend aliceChain aliceExternalSk headId aliceUTxO
 
             aliceChain `observesInTime` OnCommitTx headId alice aliceUTxO
@@ -231,7 +231,7 @@ spec = around (showLogsOnFailure "DirectChainSpec") $ do
             postTx $ InitTx{participants, headParameters}
             headId <- fst <$> aliceChain `observesInTimeSatisfying` hasInitTxWith headParameters participants
 
-            aliceUTxO <- seedFromFaucet backend aliceCardanoVk 1_000_000 (contramap FromFaucet tracer)
+            aliceUTxO <- seedFromFaucet backend aliceCardanoVk (lovelaceToValue 1_000_000) (contramap FromFaucet tracer)
             externalCommit backend aliceChain aliceCardanoSk headId aliceUTxO
 
             aliceChain `observesInTime` OnCommitTx headId alice aliceUTxO
@@ -273,7 +273,7 @@ spec = around (showLogsOnFailure "DirectChainSpec") $ do
             headId <- fst <$> aliceChain `observesInTimeSatisfying` hasInitTxWith headParameters participants
 
             (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-            newAliceUTxO <- seedFromFaucet backend aliceExternalVk 3_000_000 (contramap FromFaucet tracer)
+            newAliceUTxO <- seedFromFaucet backend aliceExternalVk (lovelaceToValue 3_000_000) (contramap FromFaucet tracer)
 
             numberOfKeyWits <- generate $ choose (2, 10)
             randomKeys <- generate $ replicateM numberOfKeyWits genKeyPair
@@ -300,8 +300,8 @@ spec = around (showLogsOnFailure "DirectChainSpec") $ do
           \aliceChain@CardanoChainTest{postTx} -> do
             -- Scenario
             (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-            someUTxO <- seedFromFaucet backend aliceExternalVk 2_000_000 (contramap FromFaucet tracer)
-            someUTxOToCommit <- seedFromFaucet backend aliceExternalVk 2_000_000 (contramap FromFaucet tracer)
+            someUTxO <- seedFromFaucet backend aliceExternalVk (lovelaceToValue 2_000_000) (contramap FromFaucet tracer)
+            someUTxOToCommit <- seedFromFaucet backend aliceExternalVk (lovelaceToValue 2_000_000) (contramap FromFaucet tracer)
             participants <- loadParticipants [Alice]
             let headParameters = HeadParameters cperiod [alice]
             postTx $ InitTx{participants, headParameters}
@@ -439,7 +439,7 @@ spec = around (showLogsOnFailure "DirectChainSpec") $ do
         withDirectChainTest (contramap (FromDirectChain "alice") tracer) aliceChainConfig alice $
           \aliceChain@CardanoChainTest{postTx} -> do
             (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-            someUTxO <- seedFromFaucet backend aliceExternalVk 1_000_000 (contramap FromFaucet tracer)
+            someUTxO <- seedFromFaucet backend aliceExternalVk (lovelaceToValue 1_000_000) (contramap FromFaucet tracer)
 
             participants <- loadParticipants [Alice]
             let headParameters = HeadParameters cperiod [alice]
diff --git a/hydra-cluster/test/Test/EndToEndSpec.hs b/hydra-cluster/test/Test/EndToEndSpec.hs
@@ -407,11 +407,11 @@ spec = around (showLogsOnFailure "EndToEndSpec") $ do
 
                 -- Get some UTXOs to commit to a head
                 (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-                committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk aliceCommittedToHead (contramap FromFaucet tracer)
+                committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommittedToHead) (contramap FromFaucet tracer)
                 requestCommitTx n1 committedUTxOByAlice <&> signTx aliceExternalSk >>= Backend.submitTransaction backend
 
                 (bobExternalVk, bobExternalSk) <- generate genKeyPair
-                committedUTxOByBob <- seedFromFaucet backend bobExternalVk bobCommittedToHead (contramap FromFaucet tracer)
+                committedUTxOByBob <- seedFromFaucet backend bobExternalVk (lovelaceToValue bobCommittedToHead) (contramap FromFaucet tracer)
                 requestCommitTx n2 committedUTxOByBob <&> signTx bobExternalSk >>= Backend.submitTransaction backend
 
                 requestCommitTx n3 mempty >>= Backend.submitTransaction backend
@@ -472,11 +472,11 @@ spec = around (showLogsOnFailure "EndToEndSpec") $ do
 
               -- Get some UTXOs to commit to a head
               (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-              committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk aliceCommittedToHead (contramap FromFaucet tracer)
+              committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommittedToHead) (contramap FromFaucet tracer)
               requestCommitTx n1 committedUTxOByAlice <&> signTx aliceExternalSk >>= Backend.submitTransaction backend
 
               (bobExternalVk, bobExternalSk) <- generate genKeyPair
-              committedUTxOByBob <- seedFromFaucet backend bobExternalVk bobCommittedToHead (contramap FromFaucet tracer)
+              committedUTxOByBob <- seedFromFaucet backend bobExternalVk (lovelaceToValue bobCommittedToHead) (contramap FromFaucet tracer)
               requestCommitTx n2 committedUTxOByBob <&> signTx bobExternalSk >>= Backend.submitTransaction backend
 
               requestCommitTx n3 mempty >>= Backend.submitTransaction backend
@@ -614,7 +614,7 @@ spec = around (showLogsOnFailure "EndToEndSpec") $ do
                 headId <- waitForAllMatch 10 [n1, n2] $ headIsInitializingWith (Set.fromList [alice, bob])
 
                 (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-                committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk aliceCommittedToHead (contramap FromFaucet tracer)
+                committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommittedToHead) (contramap FromFaucet tracer)
                 requestCommitTx n1 committedUTxOByAlice <&> signTx aliceExternalSk >>= Backend.submitTransaction backend
 
                 (bobExternalVk, _bobExternalSk) <- generate genKeyPair
@@ -844,7 +844,7 @@ timedTx tmpDir tracer backend hydraScriptsTxId = do
 
     -- Get some UTXOs to commit to a head
     (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-    committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk aliceCommittedToHead (contramap FromFaucet tracer)
+    committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommittedToHead) (contramap FromFaucet tracer)
     _ <- requestCommitTx n1 committedUTxOByAlice <&> signTx aliceExternalSk >>= Backend.submitTransaction backend
 
     waitFor hydraTracer 3 [n1] $ output "HeadIsOpen" ["utxo" .= committedUTxOByAlice, "headId" .= headId]
@@ -919,11 +919,11 @@ initAndClose tmpDir tracer clusterIx hydraScriptsTxId backend = do
 
     -- Get some UTXOs to commit to a head
     (aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-    committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk aliceCommittedToHead (contramap FromFaucet tracer)
+    committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommittedToHead) (contramap FromFaucet tracer)
     requestCommitTx n1 committedUTxOByAlice <&> signTx aliceExternalSk >>= Backend.submitTransaction backend
 
     (bobExternalVk, bobExternalSk) <- generate genKeyPair
-    committedUTxOByBob <- seedFromFaucet backend bobExternalVk bobCommittedToHead (contramap FromFaucet tracer)
+    committedUTxOByBob <- seedFromFaucet backend bobExternalVk (lovelaceToValue bobCommittedToHead) (contramap FromFaucet tracer)
     requestCommitTx n2 committedUTxOByBob <&> signTx bobExternalSk >>= Backend.submitTransaction backend
 
     requestCommitTx n3 mempty >>= Backend.submitTransaction backend
diff --git a/hydra-cluster/test/Test/Hydra/Cluster/FaucetSpec.hs b/hydra-cluster/test/Test/Hydra/Cluster/FaucetSpec.hs
@@ -8,7 +8,7 @@ import Test.Hydra.Prelude
 import Cardano.Api.UTxO qualified as UTxO
 import CardanoNode (withCardanoNodeDevnet)
 import Control.Concurrent.Async (replicateConcurrently)
-import Hydra.Cardano.Api (Coin (..), selectLovelace)
+import Hydra.Cardano.Api (Coin (..), lovelaceToValue, selectLovelace)
 import Hydra.Chain.Backend qualified as Backend
 import Hydra.Chain.CardanoClient (QueryPoint (..))
 import Hydra.Chain.Direct (DirectBackend (..))
@@ -35,7 +35,7 @@ spec =
       it "should work concurrently when called multiple times with the same amount of lovelace" $ \(tracer, backend) -> do
         utxos <- replicateConcurrently 10 $ do
           vk <- generate genVerificationKey
-          seedFromFaucet backend vk 1_000_000 tracer
+          seedFromFaucet backend vk (lovelaceToValue 1_000_000) tracer
         -- 10 unique outputs
         UTxO.size (fold utxos) `shouldBe` 10
 
@@ -50,7 +50,7 @@ spec =
               (vk, _) <- keysFor actor
               (faucetVk, _) <- keysFor Faucet
               initialFaucetFunds <- Backend.queryUTxOFor backend QueryTip faucetVk
-              void $ seedFromFaucet backend vk coin tracer
+              void $ seedFromFaucet backend vk (lovelaceToValue coin) tracer
               returnFundsToFaucet tracer backend actor
               remaining <- Backend.queryUTxOFor backend QueryTip vk
               finalFaucetFunds <- Backend.queryUTxOFor backend QueryTip faucetVk
@@ -71,7 +71,7 @@ spec =
         -- NOTE: Note use 'Faucet' as this has a very big initial amount
         (vk, _) <- keysFor Alice
         -- NOTE: 83 ADA is just enough to pay for reference scripts deposits.
-        forM_ [1_000_000, 2_000_000, 83_000_000] $ \c -> seedFromFaucet backend vk c tracer
+        forM_ [1_000_000, 2_000_000, 83_000_000] $ \c -> seedFromFaucet backend vk (lovelaceToValue c) tracer
 
         void $ publishHydraScriptsAs backend Alice
 
diff --git a/hydra-cluster/test/Test/Hydra/Cluster/HydraClientSpec.hs b/hydra-cluster/test/Test/Hydra/Cluster/HydraClientSpec.hs
@@ -291,11 +291,11 @@ prepareScenario backend nodes tracer = do
 
   -- Get some UTXOs to commit to a head
   aliceKeys@(aliceExternalVk, aliceExternalSk) <- generate genKeyPair
-  committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk aliceCommittedToHead (contramap FromFaucet tracer)
+  committedUTxOByAlice <- seedFromFaucet backend aliceExternalVk (lovelaceToValue aliceCommittedToHead) (contramap FromFaucet tracer)
   requestCommitTx n1 committedUTxOByAlice <&> signTx aliceExternalSk >>= Backend.submitTransaction backend
 
   bobKeys@(bobExternalVk, bobExternalSk) <- generate genKeyPair
-  committedUTxOByBob <- seedFromFaucet backend bobExternalVk bobCommittedToHead (contramap FromFaucet tracer)
+  committedUTxOByBob <- seedFromFaucet backend bobExternalVk (lovelaceToValue bobCommittedToHead) (contramap FromFaucet tracer)
   requestCommitTx n2 committedUTxOByBob <&> signTx bobExternalSk >>= Backend.submitTransaction backend
 
   requestCommitTx n3 mempty >>= Backend.submitTransaction backend
diff --git a/hydra-node/src/Hydra/API/HTTPServer.hs b/hydra-node/src/Hydra/API/HTTPServer.hs
@@ -322,6 +322,7 @@ handleDraftCommitUtxo env pparams directChain getCommitInfo body = do
           CannotFindOwnInitial _ -> badRequest e
           DepositTooLow _ _ -> badRequest e
           AmountTooLow _ _ -> badRequest e
+          FailedToConstructDepositTx _ -> badRequest e
           _ -> responseLBS status500 [] (Aeson.encode $ toJSON e)
       Right commitTx ->
         okJSON $ DraftCommitTxResponse commitTx
diff --git a/hydra-node/src/Hydra/Chain.hs b/hydra-node/src/Hydra/Chain.hs
@@ -208,7 +208,6 @@ data PostTxError tx
   | FailedToConstructFanoutTx
   | DepositTooLow {providedValue :: Coin, minimumValue :: Coin}
   | AmountTooLow {providedValue :: Coin, totalUTxOValue :: Coin}
-  | MissingTokenPolicies [PolicyId]
   | InvalidTokenRequest [(PolicyId, PolicyAssets)]
   deriving stock (Generic)
 
diff --git a/hydra-node/src/Hydra/Chain/Backend.hs b/hydra-node/src/Hydra/Chain/Backend.hs
diff --git a/hydra-tx/src/Hydra/Tx/Deposit.hs b/hydra-tx/src/Hydra/Tx/Deposit.hs
diff --git a/hydra-tx/test/Hydra/Tx/DepositSpec.hs b/hydra-tx/test/Hydra/Tx/DepositSpec.hs
diff --git a/hydra-tx/testlib/Test/Hydra/Tx/Gen.hs b/hydra-tx/testlib/Test/Hydra/Tx/Gen.hs
