Use splitToken check and some improvements

Add haddocks, remove unused imports

Signed-off-by: Sasha Bogicevic <[email protected]>

Author: v0d1ch

hydra-node/src/Hydra/API/HTTPServer.hs

@@ -15,7 +15,7 @@ import Data.Text (pack)
 import Hydra.API.APIServerLog (APIServerLog (..), Method (..), PathInfo (..))
 import Hydra.API.ClientInput (ClientInput (..))
 import Hydra.API.ServerOutput (ClientMessage (..), CommitInfo (..), ServerOutput (..), TimedServerOutput (..), getConfirmedSnapshot, getSeenSnapshot, getSnapshotUtxo)
-import Hydra.Cardano.Api (AssetName, Coin, LedgerEra, PolicyAssets, PolicyId, Quantity, Tx)
+import Hydra.Cardano.Api (Coin, LedgerEra, PolicyAssets, PolicyId, Tx)
 import Hydra.Chain (Chain (..), PostTxError (..), draftCommitTx)
 import Hydra.Chain.ChainState (IsChainState)
 import Hydra.Chain.Direct.State ()

hydra-node/src/Hydra/Chain.hs

@@ -17,13 +17,11 @@ import Cardano.Ledger.Core (PParams)
 import Data.List.NonEmpty ((<|))
 import Hydra.Cardano.Api (
   Address,
-  AssetName,
   ByronAddr,
   Coin (..),
   LedgerEra,
   PolicyAssets,
   PolicyId,
-  Quantity,
  )
 import Hydra.Chain.ChainState (ChainSlot, IsChainState (..))
 import Hydra.Tx (
@@ -211,7 +209,7 @@ data PostTxError tx
   | DepositTooLow {providedValue :: Coin, minimumValue :: Coin}
   | AmountTooLow {providedValue :: Coin, totalUTxOValue :: Coin}
   | MissingTokenPolicies [PolicyId]
-  | InvalidTokenRequest [(PolicyId, (AssetName, Quantity))]
+  | InvalidTokenRequest [(PolicyId, PolicyAssets)]
   deriving stock (Generic)
 
 deriving stock instance IsChainState tx => Eq (PostTxError tx)

hydra-node/src/Hydra/Chain/Direct/Handlers.hs

@@ -15,6 +15,7 @@ import Cardano.Slotting.Slot (SlotNo (..))
 import Control.Concurrent.Class.MonadSTM (modifyTVar, writeTVar)
 import Control.Monad.Class.MonadSTM (throwSTM)
 import Data.List qualified as List
+import Data.Map.Strict qualified as Map
 import Hydra.Cardano.Api (
   BlockHeader,
   ChainPoint (..),
@@ -194,7 +195,10 @@ mkChain tracer queryTimeHandle wallet ctx LocalChainState{getLatest} submitTx =
             liftEither $ do
               checkAmount lookupUTxO amount
               rejectLowDeposits pparams lookupUTxO amount
-            let (validTokens, _invalidTokens) = splitTokens lookupUTxO (fromMaybe mempty tokens)
+            let (validTokens, invalidTokens) = splitTokens lookupUTxO (fromMaybe mempty tokens)
+            unless (null invalidTokens) $
+              throwError $
+                InvalidTokenRequest (Map.assocs invalidTokens)
             (currentSlot, currentTime) <- case currentPointInTime of
               Left failureReason -> throwError FailedToConstructDepositTx{failureReason}
               Right (s, t) -> pure (s, t)

hydra-tx/src/Hydra/Tx/Deposit.hs

@@ -132,6 +132,15 @@ mkDepositOutput networkId headId depositUTxO deadline =
 depositAddress :: NetworkId -> AddressInEra
 depositAddress networkId = mkScriptAddress networkId depositValidatorScript
 
+-- | Splits the specified tokens into those that are available in sufficient quantities in the user's UTxO
+-- and those that are not (either because the policy is missing or the asset quantities are insufficient).
+--
+-- This function takes a user's UTxO and a map of specified policy IDs to their desired assets and quantities.
+-- It checks the total value in the UTxO, converts it to a policy-assets map, and then partitions the specified
+-- tokens into "ok" (available) and "invalid" (unavailable or insufficient).
+--
+-- If no tokens are specified, it returns two empty maps. Otherwise, it returns the partitioned maps, ensuring
+-- that if there are no invalid tokens, the second map is empty.
 splitTokens :: UTxO.UTxO -> Map PolicyId PolicyAssets -> (Map PolicyId PolicyAssets, Map PolicyId PolicyAssets)
 splitTokens userUTxO specifiedTokens
   | Map.null specifiedTokens = (mempty, mempty) -- Trivial case: no tokens specified