Rename a module and re-export evalTxExUnits from Api.Tx:

`evalTxExUnits` requires a transactions, not just `Scripts` and `ExUnits`, as such it belongs in the `Api.Tx` module. Also `Tools` isn't a very descriptive name of the module.
IntersectMBO · Mar 22, 2023 · 40b875c · 40b875c
1 parent 1aa7ef1
commit 40b875c
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 8 deletions.
diff --git a/libs/cardano-ledger-api/cardano-ledger-api.cabal b/libs/cardano-ledger-api/cardano-ledger-api.cabal
@@ -37,7 +37,7 @@ library
         Cardano.Ledger.Api.UTxO
 
     hs-source-dirs:   src
-    other-modules:    Cardano.Ledger.Api.Scripts.Tools
+    other-modules:    Cardano.Ledger.Api.Scripts.ExUnits
     default-language: Haskell2010
     ghc-options:
         -Wall -Wcompat -Wincomplete-record-updates

diff --git a/libs/cardano-ledger-api/src/Cardano/Ledger/Api/Scripts.hs b/libs/cardano-ledger-api/src/Cardano/Ledger/Api/Scripts.hs
@@ -4,16 +4,12 @@ module Cardano.Ledger.Api.Scripts (
   ScriptHash,
   CostModels (..),
   ValidityInterval (..),
-
-  -- * Tools
-  module Cardano.Ledger.Api.Scripts.Tools,
 )
 where
 
 import Cardano.Ledger.Allegra.Scripts (ValidityInterval (..))
 import Cardano.Ledger.Alonzo.Scripts (CostModels (..))
 import Cardano.Ledger.Api.Era ()
 import Cardano.Ledger.Api.Scripts.Data
-import Cardano.Ledger.Api.Scripts.Tools
 import Cardano.Ledger.Core (EraScript (..))
 import Cardano.Ledger.Hashes (ScriptHash)
diff --git a/...i/src/Cardano/Ledger/Api/Scripts/Tools.hs → ...src/Cardano/Ledger/Api/Scripts/ExUnits.hs b/...i/src/Cardano/Ledger/Api/Scripts/Tools.hs → ...src/Cardano/Ledger/Api/Scripts/ExUnits.hs
@@ -7,7 +7,7 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TypeFamilies #-}
 
-module Cardano.Ledger.Api.Scripts.Tools (
+module Cardano.Ledger.Api.Scripts.ExUnits (
   TransactionScriptFailure (..),
   ValidationFailed (..),
   evalTxExUnits,

diff --git a/libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx.hs b/libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx.hs
@@ -48,11 +48,31 @@ module Cardano.Ledger.Api.Tx (
   AlonzoEraTx,
   isValidTxL,
   IsValid (..),
+
+  -- ** Execution units
+  evalTxExUnits,
+  evaluateTransactionExecutionUnits,
+  RedeemerReport,
+  evalTxExUnitsWithLogs,
+  evaluateTransactionExecutionUnitsWithLogs,
+  RedeemerReportWithLogs,
+  TransactionScriptFailure (..),
+  ValidationFailed (..),
 )
 where
 
 import Cardano.Ledger.Alonzo.Tx (AlonzoEraTx (..), IsValid (..))
 import Cardano.Ledger.Api.Era ()
+import Cardano.Ledger.Api.Scripts.ExUnits (
+  RedeemerReport,
+  RedeemerReportWithLogs,
+  TransactionScriptFailure (..),
+  ValidationFailed (..),
+  evalTxExUnits,
+  evalTxExUnitsWithLogs,
+  evaluateTransactionExecutionUnits,
+  evaluateTransactionExecutionUnitsWithLogs,
+ )
 import Cardano.Ledger.Api.Tx.AuxData
 import Cardano.Ledger.Api.Tx.Body
 import Cardano.Ledger.Api.Tx.Wits

diff --git a/libs/cardano-ledger-test/src/Test/Cardano/Ledger/Alonzo/Tools.hs b/libs/cardano-ledger-test/src/Test/Cardano/Ledger/Alonzo/Tools.hs
@@ -17,8 +17,8 @@ import Cardano.Ledger.Alonzo.Tx (AlonzoEraTx (..))
 import Cardano.Ledger.Alonzo.TxInfo (ExtendedUTxO, exBudgetToExUnits, transExUnits)
 import Cardano.Ledger.Alonzo.TxWits
 import Cardano.Ledger.Alonzo.UTxO (AlonzoScriptsNeeded)
-import Cardano.Ledger.Api.Scripts (TransactionScriptFailure (..), evaluateTransactionExecutionUnits)
-import Cardano.Ledger.BaseTypes (ProtVer (..), ShelleyBase, natVersion)
+import Cardano.Ledger.Api.Tx (TransactionScriptFailure (..), evalTxExUnits)
+import Cardano.Ledger.BaseTypes (ProtVer (..), ShelleyBase)
 import Cardano.Ledger.Coin (Coin (..))
 import Cardano.Ledger.Crypto
 import Cardano.Ledger.Keys (GenDelegs (..))