Merge pull request #5028 from IntersectMBO/lehins/deprecate-balance

Deprecate `balance` in favor of a better named `sumUTxO`

Author: lehins

eras/alonzo/impl/src/Cardano/Ledger/Alonzo/Rules/Utxo.hs

@@ -89,14 +89,7 @@ import Cardano.Ledger.Rules.ValidationMode (
 import Cardano.Ledger.Shelley.LedgerState (UTxOState (utxosUtxo))
 import Cardano.Ledger.Shelley.Rules (ShelleyPpupPredFailure, ShelleyUtxoPredFailure, UtxoEnv (..))
 import qualified Cardano.Ledger.Shelley.Rules as Shelley
-import Cardano.Ledger.State (
-  EraCertState,
-  EraUTxO (..),
-  UTxO (..),
-  areAllAdaOnly,
-  coinBalance,
-  sumAllValue,
- )
+import Cardano.Ledger.State
 import Cardano.Ledger.TxIn (TxIn)
 import qualified Cardano.Ledger.Val as Val
 import Cardano.Slotting.EpochInfo.API (EpochInfo, epochInfoSlotToUTCTime)
@@ -315,7 +308,7 @@ validateCollateral pp txb utxoCollateral =
       failureIf (null utxoCollateral) NoCollateralInputs
     ]
   where
-    bal = toDeltaCoin $ coinBalance (UTxO utxoCollateral)
+    bal = toDeltaCoin $ sumAllCoin utxoCollateral
 
 -- > (∀(a,_,_) ∈ range (collateral txb ◁ utxo), a ∈ Addrvkey)
 validateScriptsNotPaidUTxO ::

eras/alonzo/impl/src/Cardano/Ledger/Alonzo/Rules/Utxos.hs

@@ -314,7 +314,7 @@ alonzoEvalScriptsTxInvalid = do
   pure $!
     utxos
       { utxosUtxo = UTxO utxoKeep
-      , utxosFees = fees <> coinBalance (UTxO utxoDel)
+      , utxosFees = fees <> sumAllCoin utxoDel
       , utxosInstantStake = deleteInstantStake (UTxO utxoDel) (utxos ^. instantStakeL)
       }
 

eras/alonzo/test-suite/src/Test/Cardano/Ledger/Alonzo/AlonzoEraGen.hs

@@ -76,8 +76,8 @@ import Cardano.Ledger.Shelley.Scripts
 import Cardano.Ledger.State (
   EraUTxO (..),
   UTxO (..),
-  coinBalance,
   getScriptsNeeded,
+  sumCoinUTxO,
   txInsFilter,
  )
 import Cardano.Ledger.TxIn (TxIn)
@@ -543,7 +543,7 @@ instance EraGen AlonzoEra where
 
 sumCollateral :: (EraTx era, AlonzoEraTxBody era) => Tx era -> UTxO era -> Coin
 sumCollateral tx utxo =
-  coinBalance $ txInsFilter utxo $ tx ^. bodyTxL . collateralInputsTxBodyL
+  sumCoinUTxO $ txInsFilter utxo $ tx ^. bodyTxL . collateralInputsTxBodyL
 
 storageCost :: forall era t. (EraPParams era, EncCBOR t) => Integer -> PParams era -> t -> Coin
 storageCost extra pp x = (extra + encodedLen @era x) <×> pp ^. ppMinFeeAL

eras/babbage/impl/src/Cardano/Ledger/Babbage/Collateral.hs

@@ -17,7 +17,7 @@ import Cardano.Ledger.Babbage.TxBody (BabbageEraTxBody (..))
 import Cardano.Ledger.BaseTypes (TxIx (..), txIxFromIntegral)
 import Cardano.Ledger.Coin (DeltaCoin, toDeltaCoin)
 import Cardano.Ledger.Core
-import Cardano.Ledger.State (UTxO (..), coinBalance)
+import Cardano.Ledger.State
 import Cardano.Ledger.TxIn (TxIn (..))
 import Cardano.Ledger.Val ((<->))
 import qualified Data.Map.Strict as Map
@@ -38,7 +38,7 @@ collAdaBalance txBody utxoCollateral = toDeltaCoin $
     SNothing -> colbal
     SJust txOut -> colbal <-> (txOut ^. coinTxOutL @era)
   where
-    colbal = coinBalance $ UTxO utxoCollateral
+    colbal = sumAllCoin utxoCollateral
 
 collOuts ::
   BabbageEraTxBody era =>

eras/babbage/impl/src/Cardano/Ledger/Babbage/Rules/Utxo.hs

@@ -71,7 +71,7 @@ import Cardano.Ledger.Rules.ValidationMode (
 import Cardano.Ledger.Shelley.LedgerState (UTxOState (utxosUtxo))
 import Cardano.Ledger.Shelley.Rules (ShelleyPpupPredFailure, ShelleyUtxoPredFailure, UtxoEnv)
 import qualified Cardano.Ledger.Shelley.Rules as Shelley
-import Cardano.Ledger.State (EraCertState (..), EraUTxO (..), UTxO (..), areAllAdaOnly, balance)
+import Cardano.Ledger.State
 import Cardano.Ledger.TxIn (TxIn)
 import Cardano.Ledger.Val ((<->))
 import qualified Cardano.Ledger.Val as Val (inject, isAdaOnly, pointwise)
@@ -306,7 +306,7 @@ validateCollateralContainsNonADA txBody utxoCollateral =
             then retTxOut ^. valueTxOutL
             else collateralBalance
     -- This is the balance that is provided by the collateral inputs
-    collateralBalance = balance $ UTxO utxoCollateral
+    collateralBalance = sumAllValue utxoCollateral
     -- This is the total amount that will be spent as collateral. This is where we account
     -- for the fact that we can remove Non-Ada assets from collateral inputs, by directing
     -- them to the return TxOut.

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/ImpTest.hs

@@ -1710,7 +1710,7 @@ showConwayTxBalance pp certState utxo tx =
     ]
   where
     txBody = tx ^. bodyTxL
-    inputs = balance (txInsFilter utxo (txBody ^. inputsTxBodyL))
+    inputs = sumUTxO (txInsFilter utxo (txBody ^. inputsTxBodyL))
     refunds =
       getTotalRefundsTxBody
         pp

eras/mary/impl/src/Cardano/Ledger/Mary/UTxO.hs

@@ -28,7 +28,7 @@ import Cardano.Ledger.State (
   EraUTxO (..),
   ScriptsProvided (..),
   UTxO,
-  balance,
+  sumUTxO,
   txInsFilter,
  )
 import Cardano.Ledger.Val (inject)
@@ -78,7 +78,7 @@ getConsumedMaryValue pp lookupStakingDeposit lookupDRepDeposit utxo txBody =
     mintedMultiAsset = filterMultiAsset (\_ _ -> (> 0)) $ txBody ^. mintTxBodyL
     {- balance (txins tx ◁ u) + wbalance (txwdrls tx) + keyRefunds pp tx -}
     consumedValue =
-      balance (txInsFilter utxo (txBody ^. inputsTxBodyL))
+      sumUTxO (txInsFilter utxo (txBody ^. inputsTxBodyL))
         <> inject (refunds <> withdrawals)
     refunds = getTotalRefundsTxBody pp lookupStakingDeposit lookupDRepDeposit txBody
     withdrawals = fold . unWithdrawals $ txBody ^. withdrawalsTxBodyL

eras/shelley/impl/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.17.0.0
 
+* Replace export from `Cardano.Ledger.Shelley.UTxO` of deprecated `balance` and `coinBalance` with `sumUTxO` and `sumCoinUTxO` respectively
 * Remove `ShelleyTxBody`
 * Removed `era` parameter from `ShelleyTxBodyRaw`
 * Remove `HeapWords` instances for: #5001

eras/shelley/impl/src/Cardano/Ledger/Shelley/API/ByronTranslation.hs

@@ -138,7 +138,7 @@ translateToShelleyLedgerStateFromUtxo transCtxt epochNo utxoByron =
 
     reserves :: Coin
     reserves =
-      word64ToCoin (fbtcMaxLovelaceSupply transCtxt) <-> coinBalance utxoShelley
+      word64ToCoin (fbtcMaxLovelaceSupply transCtxt) <-> sumCoinUTxO utxoShelley
 
     epochState :: EpochState ShelleyEra
     epochState =

eras/shelley/impl/src/Cardano/Ledger/Shelley/AdaPots.hs

@@ -71,7 +71,7 @@ totalAdaPotsES (EpochState (ChainAccountState {casTreasury, casReserves}) ls _ _
     UTxOState u _ fees_ _ _ _ = lsUTxOState ls
     certState = ls ^. lsCertStateL
     rewards_ = fromCompact $ sumRewardsUView (rewards $ certState ^. certDStateL)
-    coins = coinBalance u
+    coins = sumCoinUTxO u
     govStateObligations = obligationGovState (ls ^. lsUTxOStateL . utxosGovStateL)
 
 sumAdaPots :: AdaPots -> Coin
@@ -145,7 +145,7 @@ consumedTxBody ::
 consumedTxBody txBody pp dpstate utxo =
   Consumed
     { conInputs =
-        coinBalance (txInsFilter utxo (txBody ^. inputsTxBodyL))
+        sumCoinUTxO (txInsFilter utxo (txBody ^. inputsTxBodyL))
     , conRefunds = certsTotalRefundsTxBody pp dpstate txBody
     , conWithdrawals = fold . unWithdrawals $ txBody ^. withdrawalsTxBodyL
     }
@@ -159,7 +159,7 @@ producedTxBody ::
   Produced
 producedTxBody txBody pp dpstate =
   Produced
-    { proOutputs = coinBalance (txouts txBody)
+    { proOutputs = sumCoinUTxO (txouts txBody)
     , proFees = txBody ^. feeTxBodyL
     , proDeposits = certsTotalDepositsTxBody pp dpstate txBody
     }