Merge #2325

2325: Expose `calcMinimumDeposit` from cardano-api r=Jimbo4350 a=Jimbo4350 Expose `calcMinimumDeposit` to calculate the creation cost of a UTxO entry given a `Value` Co-authored-by: Jordan Millar <jordan.millar@iohk.io>
IntersectMBO · Mar 4, 2021 · f8b616e · f8b616e
2 parents 0c52f7d + 308de8f
commit f8b616e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/cardano-api/src/Cardano/Api/Shelley.hs b/cardano-api/src/Cardano/Api/Shelley.hs
@@ -52,6 +52,7 @@ module Cardano.Api.Shelley
     fromShelleyLovelace,
     toMaryValue,
     fromMaryValue,
+    calcMinimumDeposit,
 
     -- * Signing transactions
     -- | Creating transaction witnesses one by one, or all in one go.

diff --git a/cardano-api/src/Cardano/Api/Value.hs b/cardano-api/src/Cardano/Api/Value.hs
@@ -21,6 +21,7 @@ module Cardano.Api.Value
   , valueToList
   , filterValue
   , negateValue
+  , calcMinimumDeposit
 
     -- ** Ada \/ Lovelace specifically
   , quantityToLovelace
@@ -66,6 +67,7 @@ import qualified Data.Text.Encoding as Text
 import qualified Cardano.Chain.Common as Byron
 
 import qualified Cardano.Ledger.Mary.Value as Mary
+import qualified Cardano.Ledger.ShelleyMA.Rules.Utxo as Shelley
 import qualified Shelley.Spec.Ledger.Coin as Shelley
 
 import           Ouroboros.Consensus.Shelley.Protocol.Crypto (StandardCrypto)
@@ -283,6 +285,11 @@ fromMaryValue (Mary.Value lovelace other) =
     fromMaryAssetName :: Mary.AssetName -> AssetName
     fromMaryAssetName (Mary.AssetName n) = AssetName n
 
+-- | Calculate cost of making a UTxO entry for a given 'Value' and
+-- mininimum UTxO value derived from the 'ProtocolParameters'
+calcMinimumDeposit :: Value -> Lovelace -> Lovelace
+calcMinimumDeposit v minUTxo =
+  fromShelleyLovelace $ Shelley.scaledMinDeposit (toMaryValue v) (toShelleyLovelace minUTxo)
 
 -- ----------------------------------------------------------------------------
 -- An alternative nested representation