Add UTxO.totalValue and UTxO.totalLovelace

Author: locallycompact

hydra-cardano-api/src/Cardano/Api/UTxO.hs

@@ -10,6 +10,7 @@ module Cardano.Api.UTxO where
 
 import Cardano.Api hiding (UTxO, toLedgerUTxO)
 import Cardano.Api qualified
+import Cardano.Api.Ledger (Coin)
 import Cardano.Api.Shelley (ReferenceScript (..))
 import Cardano.Ledger.Babbage ()
 import Data.Bifunctor (second)
@@ -103,10 +104,15 @@ txOutputs = Map.elems . toMap
 null :: UTxO -> Bool
 null = Map.null . toMap
 
-
 size :: UTxO -> Int
 size = Map.size . toMap
 
+totalValue :: UTxO -> Value
+totalValue = Cardano.Api.UTxO.foldMap (\(TxOut _ (txOutValueToValue -> v) _ _) -> v)
+
+totalLovelace :: UTxO -> Coin
+totalLovelace = selectLovelace . totalValue
+
 -- * Type Conversions
 
 -- | Transforms a UTxO containing tx outs from any era into Babbage era.

hydra-cluster/src/Hydra/Cluster/Scenarios.hs

@@ -744,7 +744,7 @@ singlePartyUsesWithdrawZeroTrick tracer workDir backend hydraScriptsTxId =
                   recomputeIntegrityHash pparams [PlutusV3] $
                     toLedgerTx tx
                       & bodyTxL . collateralInputsTxBodyL .~ Set.map toLedgerTxIn (UTxO.inputSet utxoToCommit)
-                      & bodyTxL . totalCollateralTxBodyL .~ SJust (UTxO.foldMap (selectLovelace . txOutValue) utxoToCommit)
+                      & bodyTxL . totalCollateralTxBodyL .~ SJust (UTxO.totalLovelace utxoToCommit)
                       & bodyTxL . withdrawalsTxBodyL .~ Withdrawals (Map.singleton rewardAccount 0)
                       & witsTxL . rdmrsTxWitsL .~ Redeemers (Map.singleton (ConwayRewarding $ AsIx 0) (redeemer, exUnits))
                       & witsTxL . scriptTxWitsL .~ Map.singleton scriptHash script

hydra-cluster/src/Hydra/Generator.hs

@@ -134,7 +134,7 @@ generateDemoUTxODataset ::
 generateDemoUTxODataset network nodeSocket faucetSk nClients nTxs = do
   -- Query available funds
   faucetUTxO <- queryUTxOFor network nodeSocket QueryTip faucetVk
-  let (Coin fundsAvailable) = UTxO.foldMap (selectLovelace . txOutValue) faucetUTxO
+  let (Coin fundsAvailable) = UTxO.totalLovelace faucetUTxO
   -- Generate client datasets
   allPaymentKeys <- generate $ replicateM nClients genSigningKey
   clientFunds <- generate $ genClientFunds allPaymentKeys fundsAvailable

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, txOutValue)
+import Hydra.Cardano.Api (Coin (..), selectLovelace)
 import Hydra.Chain.Backend qualified as Backend
 import Hydra.Chain.CardanoClient (QueryPoint (..))
 import Hydra.Chain.Direct (DirectBackend (..))
@@ -54,13 +54,13 @@ spec =
               returnFundsToFaucet tracer backend actor
               remaining <- Backend.queryUTxOFor backend QueryTip vk
               finalFaucetFunds <- Backend.queryUTxOFor backend QueryTip faucetVk
-              UTxO.foldMap txOutValue remaining `shouldBe` mempty
+              UTxO.totalValue remaining `shouldBe` mempty
 
               -- check the faucet has one utxo extra in the end
               UTxO.size finalFaucetFunds `shouldBe` UTxO.size initialFaucetFunds + 1
 
-              let initialFaucetValue = selectLovelace (UTxO.foldMap txOutValue initialFaucetFunds)
-              let finalFaucetValue = selectLovelace (UTxO.foldMap txOutValue finalFaucetFunds)
+              let initialFaucetValue = selectLovelace (UTxO.totalValue initialFaucetFunds)
+              let finalFaucetValue = selectLovelace (UTxO.totalValue finalFaucetFunds)
               let difference = initialFaucetValue - finalFaucetValue
               -- difference between starting faucet amount and final one should
               -- just be the amount of paid fees

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

@@ -45,7 +45,6 @@ import Hydra.Cardano.Api (
   modifyTxOutValue,
   negateValue,
   selectAsset,
-  selectLovelace,
   toCtxUTxOTxOut,
   toShelleyNetwork,
   txIns',
@@ -381,7 +380,7 @@ rejectMoreThanMainnetLimit network u = do
     Left $
       CommittedTooMuchADAForMainnet lovelaceAmt maxMainnetLovelace
  where
-  lovelaceAmt = UTxO.foldMap (selectLovelace . txOutValue) u
+  lovelaceAmt = UTxO.totalLovelace u
 
 -- | Construct a abort transaction based on known, spendable UTxO. This function
 -- looks for head, initial and commit outputs to spend and it will fail if we
@@ -521,7 +520,7 @@ decrement ctx spendableUTxO headId headParameters decrementingSnapshot = do
     Left DecrementValueNegative
   Right $ decrementTx scriptRegistry ownVerificationKey headId headParameters headUTxO sn sigs
  where
-  decommitValue = UTxO.foldMap txOutValue $ fromMaybe mempty $ utxoToDecommit sn
+  decommitValue = UTxO.totalValue $ fromMaybe mempty $ utxoToDecommit sn
 
   isNegative = any ((< 0) . snd) . IsList.toList
 

hydra-node/test/Hydra/Chain/Direct/TxTraceSpec.hs

@@ -793,7 +793,7 @@ openHeadUTxO =
   openHeadTxOut =
     mkHeadOutput Fixture.testNetworkId Fixture.testPolicyId openHeadDatum
       & addParticipationTokens [alicePVk, bobPVk, carolPVk]
-      & modifyTxOutValue (<> UTxO.foldMap txOutValue inHeadUTxO)
+      & modifyTxOutValue (<> UTxO.totalValue inHeadUTxO)
 
   openHeadDatum =
     mkTxOutDatumInline $

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

@@ -131,7 +131,7 @@ commitTx networkId scriptRegistry headId party commitBlueprintTx (initialInput,
     UTxO.fromList $ mapMaybe (\txin -> (txin,) <$> UTxO.resolveTxIn txin lookupUTxO) committedTxIns
 
   commitValue =
-    txOutValue out <> UTxO.foldMap txOutValue utxoToCommit
+    txOutValue out <> UTxO.totalValue utxoToCommit
 
   commitDatum =
     mkTxOutDatumInline $ mkCommitDatum party utxoToCommit (headIdToCurrencySymbol headId)

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

@@ -61,7 +61,7 @@ mkDepositOutput networkId headId depositUTxO deadline =
     depositDatum
     ReferenceScriptNone
  where
-  depositValue = UTxO.foldMap txOutValue depositUTxO
+  depositValue = UTxO.totalValue depositUTxO
 
   deposits = mapMaybe Commit.serializeCommit $ UTxO.toList depositUTxO
 
@@ -128,7 +128,7 @@ observeDepositTxOut network depositOut = do
   headId <- currencySymbolToHeadId headCurrencySymbol
   deposit <- do
     depositedUTxO <- UTxO.fromList <$> traverse (Commit.deserializeCommit network) onChainDeposits
-    guard $ depositValue `containsValue` UTxO.foldMap txOutValue depositedUTxO
+    guard $ depositValue `containsValue` UTxO.totalValue depositedUTxO
     pure depositedUTxO
   pure (headId, deposit, deadline)
  where

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

@@ -162,7 +162,7 @@ instance IsTx Tx where
   type ValueType Tx = Value
 
   txId = getTxId . getTxBody
-  balance = UTxO.foldMap txOutValue
+  balance = UTxO.totalValue
 
   -- NOTE: See note from `Util.hashTxOuts`.
   hashUTxO = fromBuiltin . Util.hashTxOuts . mapMaybe toPlutusTxOut . UTxO.txOutputs

hydra-tx/test/Hydra/Tx/Contract/Abort.hs

@@ -324,7 +324,7 @@ generateCommitUTxOs parties = do
     commitValue =
       mconcat
         [ lovelaceToValue (Coin 2000000)
-        , UTxO.foldMap txOutValue utxo
+        , UTxO.totalValue utxo
         , fromList
             [ (AssetId testPolicyId (assetNameFromVerificationKey vk), 1)
             ]