Merge pull request #86 from mlabs-haskell/misha/ex-units-for-plutip

Calculating exedcution budget with `Cardano.Api` tools

Author: szg251

README.md

@@ -97,8 +97,6 @@ main = do
           , -- Dry run mode will build the tx, but skip the submit step
             pcDryRun = False
           , pcLogLevel = Debug
-          , -- | Forced budget for scripts, as optional (CPU Steps, Memory Units)
-            pcForceBudget = Nothing
           , -- Protocol params file location relative to the cardano-cli working directory (needed for the cli)
           , pcProtocolParamsFile = "./protocol.json"
           , pcEnableTxEndpoint = True

bot-plutus-interface.cabal

@@ -77,12 +77,15 @@ library
   exposed-modules:
     BotPlutusInterface
     BotPlutusInterface.Balance
+    BotPlutusInterface.BodyBuilder
     BotPlutusInterface.CardanoCLI
     BotPlutusInterface.ChainIndex
     BotPlutusInterface.Contract
     BotPlutusInterface.Effects
+    BotPlutusInterface.ExBudget
     BotPlutusInterface.Files
     BotPlutusInterface.Helpers
+    BotPlutusInterface.QueryNode
     BotPlutusInterface.Server
     BotPlutusInterface.Types
     BotPlutusInterface.UtxoParser
@@ -94,6 +97,7 @@ library
     , cardano-api
     , cardano-crypto
     , cardano-ledger-alonzo
+    , cardano-slotting
     , containers
     , data-default
     , data-default-class

examples/plutus-game/app/Main.hs

@@ -68,7 +68,6 @@ main = do
           , pcDryRun = True
           , pcLogLevel = Debug
           , pcProtocolParamsFile = "./protocol.json"
-          , pcForceBudget = Just (9_000_000_000, 15_000_000)
           , pcEnableTxEndpoint = True
           }
   BotPlutusInterface.runPAB @GameContracts pabConf

examples/plutus-nft/app/Main.hs

@@ -68,7 +68,6 @@ main = do
           , pcDryRun = True
           , pcLogLevel = Debug
           , pcProtocolParamsFile = "./protocol.json"
-          , pcForceBudget = Just (1000, 1000)
           , pcEnableTxEndpoint = True
           }
   BotPlutusInterface.runPAB @MintNFTContracts pabConf

examples/plutus-transfer/app/Main.hs

@@ -67,7 +67,6 @@ main = do
           , pcDryRun = True
           , pcLogLevel = Debug
           , pcProtocolParamsFile = "./protocol.json"
-          , pcForceBudget = Nothing
           , pcEnableTxEndpoint = True
           }
   BotPlutusInterface.runPAB @TransferContracts pabConf

src/BotPlutusInterface/Balance.hs

@@ -58,6 +58,8 @@ import Plutus.V1.Ledger.Api (
   CurrencySymbol (..),
   TokenName (..),
  )
+
+import BotPlutusInterface.BodyBuilder qualified as BodyBuilder
 import Prelude
 
 {- | Collect necessary tx inputs and collaterals, add minimum lovelace values and balance non ada
@@ -134,7 +136,8 @@ balanceTxIO pabConf ownPkh unbalancedTx =
       txWithoutFees <-
         hoistEither $ balanceTxStep minUtxos utxoIndex changeAddr $ tx `withFee` 0
 
-      exBudget <- newEitherT $ CardanoCLI.buildTx @w pabConf privKeys txWithoutFees
+      exBudget <- newEitherT $ BodyBuilder.buildAndEstimateBudget @w pabConf privKeys txWithoutFees
+
       nonBudgettedFees <- newEitherT $ CardanoCLI.calculateMinFee @w pabConf txWithoutFees
 
       let fees = nonBudgettedFees + getBudgetPrice (getExecutionUnitPrices pabConf) exBudget

src/BotPlutusInterface/BodyBuilder.hs

@@ -0,0 +1,56 @@
+{-# LANGUAGE AllowAmbiguousTypes #-}
+
+{- | Module provides the way of building ".raw" transactions with execution budget
+ estimated with `Cardano.Api` tools.
+-}
+module BotPlutusInterface.BodyBuilder (buildAndEstimateBudget) where
+
+import BotPlutusInterface.CardanoCLI qualified as CardanoCLI
+import BotPlutusInterface.Effects (PABEffect, estimateBudget)
+
+import BotPlutusInterface.Files (
+  DummyPrivKey,
+  txFilePath,
+ )
+import BotPlutusInterface.Types (PABConfig, TxFile (Raw))
+import Control.Monad.Freer (Eff, Member)
+import Control.Monad.Trans.Either (firstEitherT, newEitherT, runEitherT)
+import Data.Kind (Type)
+import Data.Map (Map)
+import Data.Text (Text)
+import Data.Text qualified as Text
+import Ledger (ExBudget, Tx, txId)
+import Ledger.Crypto (PubKeyHash)
+import Prelude
+
+{- | Build and save raw transaction (transaction body) with estimated execution budgets using `CardanoCLI`.
+ It builds first transaction body with 0 budget for all spending inputs and minting policies,
+ then uses body of this transaction to estimate execution budget
+ and build final body with budget set.
+-}
+buildAndEstimateBudget ::
+  forall (w :: Type) (effs :: [Type -> Type]).
+  Member (PABEffect w) effs =>
+  PABConfig ->
+  Map PubKeyHash DummyPrivKey ->
+  Tx ->
+  Eff effs (Either Text ExBudget)
+buildAndEstimateBudget pabConf privKeys tx = runEitherT $ do
+  buildDraftTxBody
+    >> estimateBudgetByDraftBody (Text.unpack $ txFilePath pabConf "raw" (txId tx))
+    >>= buildBodyUsingEstimatedBudget
+  where
+    buildDraftTxBody = newEitherT $ CardanoCLI.buildTx @w pabConf privKeys mempty tx
+
+    estimateBudgetByDraftBody path =
+      firstEitherT toText . newEitherT $ estimateBudget @w (Raw path)
+
+    buildBodyUsingEstimatedBudget exBudget =
+      newEitherT $
+        CardanoCLI.buildTx @w
+          pabConf
+          privKeys
+          exBudget
+          tx
+
+    toText = Text.pack . show