Use Cardano API function calculateMinimumUTxO for minimum UTxO calculations.

lib/core/cardano-wallet-core.cabal

@@ -52,11 +52,14 @@ library
     , cardano-crypto-class
     , cardano-crypto-test
     , cardano-numeric
-    , cardano-ledger-core
+    , cardano-ledger-alonzo
+    , cardano-ledger-alonzo-test
+    , cardano-ledger-babbage
     , cardano-ledger-byron-test
-    , cardano-ledger-shelley-test
+    , cardano-ledger-core
     , cardano-ledger-shelley
-    , cardano-ledger-alonzo
+    , cardano-ledger-shelley-ma
+    , cardano-ledger-shelley-test
     , cardano-slotting
     , cborg
     , containers
@@ -251,6 +254,8 @@ library
       Cardano.Wallet.Primitive.Types.Address
       Cardano.Wallet.Primitive.Types.Coin
       Cardano.Wallet.Primitive.Types.Hash
+      Cardano.Wallet.Primitive.Types.MinimumUTxO
+      Cardano.Wallet.Primitive.Types.MinimumUTxO.Gen
       Cardano.Wallet.Primitive.Types.Redeemer
       Cardano.Wallet.Primitive.Types.RewardAccount
       Cardano.Wallet.Primitive.Types.TokenBundle

lib/core/src/Cardano/Api/Gen.hs

@@ -9,7 +9,8 @@
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
 module Cardano.Api.Gen
-    ( genAddressByron
+    ( genAddressAny
+    , genAddressByron
     , genAddressInEra
     , genAddressShelley
     , genAlphaNum
@@ -860,6 +861,14 @@ genPaymentCredential =
         byScript :: Gen PaymentCredential
         byScript = PaymentCredentialByScript <$> genScriptHash
 
+genAddressAny :: Gen AddressAny
+genAddressAny = oneof
+    [ AddressByron
+        <$> genAddressByron
+    , AddressShelley
+        <$> genAddressShelley
+    ]
+
 genAddressByron :: Gen (Address ByronAddr)
 genAddressByron = makeByronAddress <$> genNetworkId
                                    <*> genVerificationKey AsByronKey

lib/core/src/Cardano/Wallet/Api/Types.hs

@@ -308,7 +308,6 @@ import Cardano.Wallet.Primitive.Types
     , EpochNo (..)
     , ExecutionUnitPrices (..)
     , GenesisParameters (..)
-    , MinimumUTxOValue (..)
     , NetworkParameters (..)
     , NonWalletCertificate (..)
     , PoolId (..)
@@ -1129,11 +1128,8 @@ toApiNetworkParameters (NetworkParameters gp sp pp) txConstraints toEpochInfo =
             $ getDecentralizationLevel
             $ view #decentralizationLevel pp
         , desiredPoolNumber = view #desiredNumberOfStakePools pp
-        , minimumUtxoValue = toApiCoin $ case (view #minimumUTxOvalue pp) of
-            MinimumUTxOValue c ->
-                c
-            MinimumUTxOValueCostPerWord _perWord ->
-                txOutputMinimumAdaQuantity txConstraints TokenMap.empty
+        , minimumUtxoValue = toApiCoin $
+            txOutputMinimumAdaQuantity txConstraints TokenMap.empty
         , eras = apiEras
         , maximumCollateralInputCount =
             view #maximumCollateralInputCount pp

lib/core/src/Cardano/Wallet/Primitive/Types.hs

@@ -72,7 +72,6 @@ module Cardano.Wallet.Primitive.Types
     , GenesisParameters (..)
     , SlottingParameters (..)
     , ProtocolParameters (..)
-    , MinimumUTxOValue (..)
     , TxParameters (..)
     , TokenBundleMaxSize (..)
     , EraInfo (..)
@@ -181,6 +180,8 @@ import Cardano.Wallet.Primitive.Types.Coin
     ( Coin (..) )
 import Cardano.Wallet.Primitive.Types.Hash
     ( Hash (..), hashFromText )
+import Cardano.Wallet.Primitive.Types.MinimumUTxO
+    ( MinimumUTxO )
 import Cardano.Wallet.Primitive.Types.RewardAccount
     ( RewardAccount (..) )
 import Cardano.Wallet.Primitive.Types.Tx
@@ -1081,23 +1082,6 @@ instance Buildable (EraInfo EpochNo) where
         boundF (Just e) = " from " <> build e
         boundF Nothing = " <not started>"
 
-data MinimumUTxOValue
-    -- | In Shelley, tx outputs could only be created if they were larger than
-    -- this `MinimumUTxOValue`.
-    = MinimumUTxOValue Coin
-
-    -- | With Alonzo, `MinimumUTxOValue` is replaced by an ada-cost per word of
-    -- the output. Note that the alonzo ledger assumes fixed sizes for address
-    -- and coin, so the size is not the serialized size exactly.
-    | MinimumUTxOValueCostPerWord Coin
-    deriving (Eq, Generic, Show)
-
-instance NFData MinimumUTxOValue
-
-instance Buildable MinimumUTxOValue where
-    build (MinimumUTxOValue c) = "constant " <> build c
-    build (MinimumUTxOValueCostPerWord c) = build c <> " per word"
-
 -- | Protocol parameters that can be changed through the update system.
 --
 data ProtocolParameters = ProtocolParameters
@@ -1111,9 +1095,9 @@ data ProtocolParameters = ProtocolParameters
         :: Word16
         -- ^ The current desired number of stakepools in the network.
         -- Also known as k parameter.
-    , minimumUTxOvalue
-        :: MinimumUTxOValue
-        -- ^ The minimum UTxO value.
+    , minimumUTxO
+        :: MinimumUTxO
+        -- ^ Represents a way of calculating minimum UTxO values.
     , stakeKeyDeposit
         :: Coin
         -- ^ Registering a stake key requires storage on the node and as such
@@ -1151,7 +1135,7 @@ instance NFData ProtocolParameters where
         [ rnf decentralizationLevel
         , rnf txParameters
         , rnf desiredNumberOfStakePools
-        , rnf minimumUTxOvalue
+        , rnf minimumUTxO
         , rnf stakeKeyDeposit
         , rnf eras
         , rnf maximumCollateralInputCount
@@ -1162,13 +1146,18 @@ instance NFData ProtocolParameters where
 
 instance Buildable ProtocolParameters where
     build pp = blockListF' "" id
-        [ "Decentralization level: " <> build (pp ^. #decentralizationLevel)
-        , "Transaction parameters: " <> build (pp ^. #txParameters)
-        , "Desired number of pools: " <> build (pp ^. #desiredNumberOfStakePools)
-        , "Minimum UTxO value: " <> build (pp ^. #minimumUTxOvalue)
-        , "Eras:\n" <> indentF 2 (build (pp ^. #eras))
-        , "Execution unit prices: " <>
-            maybe "not specified" build (pp ^. #executionUnitPrices)
+        [ "Decentralization level: "
+            <> build (pp ^. #decentralizationLevel)
+        , "Transaction parameters: "
+            <> build (pp ^. #txParameters)
+        , "Desired number of pools: "
+            <> build (pp ^. #desiredNumberOfStakePools)
+        , "Minimum UTxO: "
+            <> build (pp ^. #minimumUTxO)
+        , "Eras:\n"
+            <> indentF 2 (build (pp ^. #eras))
+        , "Execution unit prices: "
+            <> maybe "not specified" build (pp ^. #executionUnitPrices)
         ]
 
 data ExecutionUnits = ExecutionUnits

lib/core/src/Cardano/Wallet/Primitive/Types/MinimumUTxO.hs

@@ -0,0 +1,144 @@
+{-# LANGUAGE BangPatterns #-}
+{-# LANGUAGE GADTs #-}
+{-# LANGUAGE LambdaCase #-}
+
+-- |
+-- Copyright: © 2022 IOHK
+-- License: Apache-2.0
+--
+-- Defines the 'MinimumUTxO' type and related functions.
+--
+module Cardano.Wallet.Primitive.Types.MinimumUTxO
+    (
+    -- * Types
+      MinimumUTxO (..)
+    , MinimumUTxOForShelleyBasedEra (..)
+
+    -- * Constructor functions
+    , minimumUTxONone
+    , minimumUTxOConstant
+    , minimumUTxOForShelleyBasedEra
+    )
+    where
+
+import Prelude
+
+import Cardano.Api.Shelley
+    ( ShelleyBasedEra, ShelleyLedgerEra, fromLedgerPParams )
+import Cardano.Ledger.Core
+    ( PParams )
+import Cardano.Wallet.Primitive.Types.Coin
+    ( Coin )
+import Control.DeepSeq
+    ( NFData (..) )
+import Data.Function
+    ( on )
+import Fmt
+    ( Buildable (..), blockListF )
+
+--------------------------------------------------------------------------------
+-- The 'MinimumUTxO' type
+--------------------------------------------------------------------------------
+
+-- | Represents a function for computing minimum UTxO values.
+--
+data MinimumUTxO where
+    MinimumUTxONone
+        :: MinimumUTxO
+        -- ^ Indicates that there is no minimum UTxO value.
+    MinimumUTxOConstant
+        :: Coin
+        -> MinimumUTxO
+        -- ^ Indicates a constant minimum UTxO value. This constructor is
+        -- useful for writing tests, where we often want to have precise
+        -- control over the value that is chosen.
+    MinimumUTxOForShelleyBasedEraOf
+        :: MinimumUTxOForShelleyBasedEra
+        -> MinimumUTxO
+        -- ^ Indicates a Shelley-based era-specific minimum UTxO function.
+
+instance Buildable MinimumUTxO where
+    build = \case
+        MinimumUTxONone ->
+            "MinimumUTxONone"
+        MinimumUTxOConstant c -> blockListF
+            [ "MinimumUTxOConstant"
+            , build c
+            ]
+        MinimumUTxOForShelleyBasedEraOf m -> blockListF
+            [ "MinimumUTxOForShelleyBasedEra"
+            , build m
+            ]
+
+instance Eq MinimumUTxO where
+    (==) = (==) `on` show
+
+instance NFData MinimumUTxO where
+    rnf = \case
+        MinimumUTxONone ->
+            rnf ()
+        MinimumUTxOConstant c ->
+            rnf c
+        MinimumUTxOForShelleyBasedEraOf pp ->
+            rnf pp
+
+instance Show MinimumUTxO where
+    show = \case
+        MinimumUTxONone ->
+            "MinimumUTxONone"
+        MinimumUTxOConstant c -> unwords
+            [ "MinimumUTxOConstant"
+            , show c
+            ]
+        MinimumUTxOForShelleyBasedEraOf pp -> unwords
+            [ "MinimumUTxOForShelleyBasedEra"
+            , show pp
+            ]
+
+--------------------------------------------------------------------------------
+-- The 'MinimumUTxOForShelleyBasedEra' type
+--------------------------------------------------------------------------------
+
+-- | Represents a minimum UTxO function that is specific to a Shelley-based era.
+--
+data MinimumUTxOForShelleyBasedEra where
+    MinimumUTxOForShelleyBasedEra
+        :: ShelleyBasedEra era
+        -> PParams (ShelleyLedgerEra era)
+        -> MinimumUTxOForShelleyBasedEra
+
+instance Buildable MinimumUTxOForShelleyBasedEra where
+    build (MinimumUTxOForShelleyBasedEra era _) = blockListF
+        [ "MinimumUTxOForShelleyBasedEra"
+        , show era
+        ]
+
+instance Eq MinimumUTxOForShelleyBasedEra where
+    (==) = (==) `on` show
+
+instance NFData MinimumUTxOForShelleyBasedEra where
+    rnf (MinimumUTxOForShelleyBasedEra !_ !_) = rnf ()
+
+instance Show MinimumUTxOForShelleyBasedEra where
+    show (MinimumUTxOForShelleyBasedEra era pp) = unwords
+        [ show era
+        , show (fromLedgerPParams era pp)
+        ]
+
+--------------------------------------------------------------------------------
+-- Constructor functions
+--------------------------------------------------------------------------------
+
+minimumUTxONone :: MinimumUTxO
+minimumUTxONone = MinimumUTxONone
+
+minimumUTxOConstant :: Coin -> MinimumUTxO
+minimumUTxOConstant = MinimumUTxOConstant
+
+minimumUTxOForShelleyBasedEra
+    :: ShelleyBasedEra era
+    -> PParams (ShelleyLedgerEra era)
+    -> MinimumUTxO
+minimumUTxOForShelleyBasedEra era pp =
+    MinimumUTxOForShelleyBasedEraOf $
+    MinimumUTxOForShelleyBasedEra era pp