Change imp initialization to set the the initialized state in MonadState

IntersectMBO · Apr 25, 2024 · 0a0157f · 0a0157f
1 parent a2d7a81
commit 0a0157f
Show file tree

Hide file tree

Showing 19 changed files with 52 additions and 50 deletions.
diff --git a/eras/allegra/impl/cardano-ledger-allegra.cabal b/eras/allegra/impl/cardano-ledger-allegra.cabal
@@ -68,7 +68,7 @@ library
         cardano-crypto-class,
         cardano-ledger-binary ^>=1.3,
         cardano-ledger-core ^>=1.12,
-        cardano-ledger-shelley ^>=1.10,
+        cardano-ledger-shelley ^>=1.11,
         cardano-strict-containers,
         cardano-slotting,
         cborg,

diff --git a/eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/ImpTest.hs b/eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/ImpTest.hs
@@ -37,7 +37,7 @@ instance
   ) =>
   ShelleyEraImp (AllegraEra c)
   where
-  initImpNES = initShelleyImpNES
+  initImpTestState = pure ()
 
   impSatisfyNativeScript = impAllegraSatisfyNativeScript
 

diff --git a/eras/alonzo/impl/cardano-ledger-alonzo.cabal b/eras/alonzo/impl/cardano-ledger-alonzo.cabal
@@ -81,7 +81,7 @@ library
         cardano-ledger-binary ^>=1.3,
         cardano-ledger-core ^>=1.12,
         cardano-ledger-mary ^>=1.6.0,
-        cardano-ledger-shelley ^>=1.10,
+        cardano-ledger-shelley ^>=1.11,
         cardano-slotting,
         cardano-strict-containers,
         containers,
@@ -133,10 +133,10 @@ library testlib
         cardano-ledger-core:{cardano-ledger-core, testlib},
         cardano-strict-containers,
         cardano-ledger-shelley:{cardano-ledger-shelley, testlib},
-        data-default-class,
         plutus-ledger-api,
         generic-random,
         microlens,
+        microlens-mtl,
         text,
         tree-diff
 

diff --git a/eras/alonzo/impl/testlib/Test/Cardano/Ledger/Alonzo/ImpTest.hs b/eras/alonzo/impl/testlib/Test/Cardano/Ledger/Alonzo/ImpTest.hs
@@ -58,7 +58,6 @@ import Cardano.Ledger.Plutus.Language (
  )
 import Cardano.Ledger.Shelley.LedgerState (
   NewEpochState,
-  StashedAVVMAddresses,
   curPParamsEpochStateL,
   esLStateL,
   lsUTxOStateL,
@@ -68,14 +67,14 @@ import Cardano.Ledger.Shelley.LedgerState (
 import Cardano.Ledger.Shelley.UTxO (EraUTxO (..), ScriptsProvided (..))
 import Cardano.Ledger.TxIn (TxIn)
 import Control.Monad (forM)
-import Data.Default.Class (Default)
 import Data.Map.Strict (Map)
 import qualified Data.Map.Strict as Map
 import Data.MapExtras (fromElems)
 import Data.Maybe (catMaybes)
 import Data.Set (Set)
 import qualified Data.Set as Set
 import Lens.Micro
+import Lens.Micro.Mtl ((%=))
 import qualified PlutusLedgerApi.Common as P
 import Test.Cardano.Ledger.Alonzo.TreeDiff ()
 import Test.Cardano.Ledger.Core.Arbitrary ()
@@ -102,14 +101,12 @@ class
 initAlonzoImpNES ::
   forall era.
   ( AlonzoEraPParams era
-  , Default (StashedAVVMAddresses era)
   , ShelleyEraImp era
   , AlonzoEraScript era
   ) =>
+  NewEpochState era ->
   NewEpochState era
-initAlonzoImpNES =
-  initShelleyImpNES
-    & nesEsL . curPParamsEpochStateL %~ initPParams
+initAlonzoImpNES = nesEsL . curPParamsEpochStateL %~ initPParams
   where
     initPParams pp =
       pp
@@ -384,7 +381,7 @@ instance
   ) =>
   ShelleyEraImp (AlonzoEra c)
   where
-  initImpNES = initAlonzoImpNES
+  initImpTestState = impNESL %= initAlonzoImpNES
   impSatisfyNativeScript = impAllegraSatisfyNativeScript
   fixupTx = alonzoFixupTx
 

diff --git a/eras/alonzo/test-suite/cardano-ledger-alonzo-test.cabal b/eras/alonzo/test-suite/cardano-ledger-alonzo-test.cabal
@@ -48,7 +48,7 @@ library
         cardano-ledger-binary:{cardano-ledger-binary, testlib} >=1.0,
         cardano-ledger-core:{cardano-ledger-core, testlib} >=1.11 && <1.13,
         cardano-ledger-allegra >=1.2,
-        cardano-ledger-shelley:{cardano-ledger-shelley, testlib} >=1.6 && <1.11,
+        cardano-ledger-shelley:{cardano-ledger-shelley, testlib} >=1.6 && <1.12,
         cardano-ledger-shelley-test >=1.2,
         cardano-ledger-shelley-ma-test ^>=1.2,
         cardano-ledger-mary >=1.4,

diff --git a/eras/babbage/impl/cardano-ledger-babbage.cabal b/eras/babbage/impl/cardano-ledger-babbage.cabal
@@ -77,7 +77,7 @@ library
         cardano-ledger-binary ^>=1.3,
         cardano-ledger-core ^>=1.12,
         cardano-ledger-mary ^>=1.6,
-        cardano-ledger-shelley ^>=1.10,
+        cardano-ledger-shelley ^>=1.11,
         cardano-strict-containers,
         containers,
         deepseq,
@@ -117,6 +117,7 @@ library testlib
         cardano-ledger-binary,
         cardano-ledger-core:{cardano-ledger-core, testlib},
         generic-random,
+        microlens-mtl,
         small-steps >=1.1,
         QuickCheck
 

diff --git a/eras/babbage/impl/testlib/Test/Cardano/Ledger/Babbage/ImpTest.hs b/eras/babbage/impl/testlib/Test/Cardano/Ledger/Babbage/ImpTest.hs
@@ -17,6 +17,7 @@ import Cardano.Ledger.Babbage (BabbageEra)
 import Cardano.Ledger.Core
 import Cardano.Ledger.Crypto (Crypto (..))
 import Cardano.Ledger.Plutus.Language (SLanguage (..))
+import Lens.Micro.Mtl ((%=))
 import Test.Cardano.Ledger.Alonzo.ImpTest
 import Test.Cardano.Ledger.Babbage.TreeDiff ()
 import Test.Cardano.Ledger.Common
@@ -30,7 +31,7 @@ instance
   ) =>
   ShelleyEraImp (BabbageEra c)
   where
-  initImpNES = initAlonzoImpNES
+  initImpTestState = impNESL %= initAlonzoImpNES
   impSatisfyNativeScript = impAllegraSatisfyNativeScript
   fixupTx = alonzoFixupTx
 

diff --git a/eras/babbage/test-suite/cardano-ledger-babbage-test.cabal b/eras/babbage/test-suite/cardano-ledger-babbage-test.cabal
@@ -41,7 +41,7 @@ library
         cardano-ledger-shelley-ma-test >=1.1,
         cardano-ledger-mary >=1.4,
         cardano-ledger-shelley-test >=1.1,
-        cardano-ledger-shelley >=1.6 && <1.11,
+        cardano-ledger-shelley >=1.6 && <1.12,
         cardano-strict-containers,
         cardano-slotting,
         containers,

diff --git a/eras/conway/impl/cardano-ledger-conway.cabal b/eras/conway/impl/cardano-ledger-conway.cabal
@@ -92,7 +92,7 @@ library
         cardano-ledger-babbage ^>=1.8,
         cardano-ledger-core ^>=1.12,
         cardano-ledger-mary ^>=1.6,
-        cardano-ledger-shelley ^>=1.10,
+        cardano-ledger-shelley ^>=1.11,
         cardano-slotting,
         cardano-strict-containers,
         containers,
@@ -157,6 +157,7 @@ library testlib
         cardano-strict-containers,
         data-default-class,
         generic-random,
+        microlens-mtl,
         mtl,
         text,
         small-steps >=1.1

diff --git a/eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/ImpTest.hs b/eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/ImpTest.hs
@@ -192,6 +192,7 @@ import qualified Data.Text as T
 import Data.Tree
 import qualified GHC.Exts as GHC (fromList)
 import Lens.Micro
+import Lens.Micro.Mtl ((%=))
 import Test.Cardano.Ledger.Babbage.ImpTest
 import Test.Cardano.Ledger.Conway.Arbitrary ()
 import Test.Cardano.Ledger.Conway.TreeDiff ()
@@ -224,16 +225,19 @@ instance
   ) =>
   ShelleyEraImp (ConwayEra c)
   where
-  initImpNES =
-    let nes =
-          initAlonzoImpNES
-            & nesEsL . curPParamsEpochStateL . ppDRepActivityL .~ EpochInterval 100
-            & nesEsL . curPParamsEpochStateL . ppGovActionLifetimeL .~ EpochInterval 30
-        epochState = nes ^. nesEsL
-        ratifyState =
-          def
-            & rsEnactStateL .~ mkEnactState (epochState ^. epochStateGovStateL)
-     in nes & nesEsL .~ setCompleteDRepPulsingState def ratifyState epochState
+  initImpTestState =
+    impNESL %= initConwayNES
+    where
+      initConwayNES nes =
+        let newNes =
+              (initAlonzoImpNES nes)
+                & nesEsL . curPParamsEpochStateL . ppDRepActivityL .~ EpochInterval 100
+                & nesEsL . curPParamsEpochStateL . ppGovActionLifetimeL .~ EpochInterval 30
+            epochState = newNes ^. nesEsL
+            ratifyState =
+              def
+                & rsEnactStateL .~ mkEnactState (epochState ^. epochStateGovStateL)
+         in newNes & nesEsL .~ setCompleteDRepPulsingState def ratifyState epochState
 
   impSatisfyNativeScript = impAllegraSatisfyNativeScript
 

diff --git a/eras/mary/impl/cardano-ledger-mary.cabal b/eras/mary/impl/cardano-ledger-mary.cabal
@@ -77,7 +77,7 @@ library
         cardano-ledger-allegra ^>=1.4.1,
         cardano-ledger-binary ^>=1.3,
         cardano-ledger-core ^>=1.12,
-        cardano-ledger-shelley ^>=1.10,
+        cardano-ledger-shelley ^>=1.11,
         containers,
         deepseq,
         groups,

diff --git a/eras/mary/impl/testlib/Test/Cardano/Ledger/Mary/ImpTest.hs b/eras/mary/impl/testlib/Test/Cardano/Ledger/Mary/ImpTest.hs
@@ -30,7 +30,7 @@ instance
   ) =>
   ShelleyEraImp (MaryEra c)
   where
-  initImpNES = initShelleyImpNES
+  initImpTestState = pure ()
   impSatisfyNativeScript = impAllegraSatisfyNativeScript
   fixupTx = shelleyFixupTx
 

diff --git a/eras/shelley-ma/test-suite/cardano-ledger-shelley-ma-test.cabal b/eras/shelley-ma/test-suite/cardano-ledger-shelley-ma-test.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name:          cardano-ledger-shelley-ma-test
-version:       1.2.2.0
+version:       1.2.2.1
 license:       Apache-2.0
 maintainer:    operations@iohk.io
 author:        IOHK
@@ -49,7 +49,7 @@ library
         containers,
         hashable,
         cardano-ledger-shelley-test >=1.1,
-        cardano-ledger-shelley:{cardano-ledger-shelley, testlib} ^>=1.10,
+        cardano-ledger-shelley:{cardano-ledger-shelley, testlib} ^>=1.11,
         cardano-strict-containers,
         microlens,
         mtl,

diff --git a/eras/shelley/impl/CHANGELOG.md b/eras/shelley/impl/CHANGELOG.md
@@ -1,11 +1,13 @@
 # Version history for `cardano-ledger-shelley`
 
-## 1.10.1.0
+## 1.11.0.0
 
 *
 
 ### `testlib`
 
+* Export `impNESL` instead of of `impNESG` from `ImpTest`
+* Replace `initImpNES` with `initImpTestState` and change its return type to MonadState
 * Add functions to Shelley `ImpTest`:
   * `withFixup`
   * `withCustomFixup`

diff --git a/eras/shelley/impl/cardano-ledger-shelley.cabal b/eras/shelley/impl/cardano-ledger-shelley.cabal
@@ -1,6 +1,6 @@
 cabal-version:      3.0
 name:               cardano-ledger-shelley
-version:            1.10.1.0
+version:            1.11.0.0
 license:            Apache-2.0
 maintainer:         operations@iohk.io
 author:             IOHK

diff --git a/eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/ImpTest.hs b/eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/ImpTest.hs
@@ -96,8 +96,7 @@ module Test.Cardano.Ledger.Shelley.ImpTest (
   withNoFixup,
   withPostFixup,
   withPreFixup,
-  -- We only export getters, because internal state should not be accessed during testing
-  impNESG,
+  impNESL,
   impLastTickG,
   impKeyPairsG,
   impNativeScriptsG,
@@ -287,9 +286,6 @@ impLogL = lens impLog (\x y -> x {impLog = y})
 impNESL :: Lens' (ImpTestState era) (NewEpochState era)
 impNESL = lens impNES (\x y -> x {impNES = y})
 
-impNESG :: SimpleGetter (ImpTestState era) (NewEpochState era)
-impNESG = impNESL
-
 impLastTickL :: Lens' (ImpTestState era) SlotNo
 impLastTickL = lens impLastTick (\x y -> x {impLastTick = y})
 
@@ -336,6 +332,7 @@ class
   , Show (StashedAVVMAddresses era)
   , ToExpr (StashedAVVMAddresses era)
   , NFData (StashedAVVMAddresses era)
+  , Default (StashedAVVMAddresses era)
   , -- For the LEDGER rule
     STS (EraRule "LEDGER" era)
   , BaseM (EraRule "LEDGER" era) ~ ShelleyBase
@@ -376,7 +373,8 @@ class
   ) =>
   ShelleyEraImp era
   where
-  initImpNES :: NewEpochState era
+  initImpTestState ::
+    (MonadState (ImpTestState era) m, MonadGen m) => m ()
 
   -- | Try to find a sufficient number of KeyPairs that would satisfy a native script.
   -- Whenever script can't be satisfied, Nothing is returned
@@ -439,11 +437,7 @@ testKeyHash :: Crypto c => KeyHash kd c
 testKeyHash = mkKeyHash (-1)
 
 initShelleyImpNES ::
-  forall era.
-  ( Default (StashedAVVMAddresses era)
-  , ShelleyEraImp era
-  ) =>
-  NewEpochState era
+  forall era. ShelleyEraImp era => NewEpochState era
 initShelleyImpNES =
   NewEpochState
     { stashedAVVMAddresses = def
@@ -514,7 +508,7 @@ instance
   ) =>
   ShelleyEraImp (ShelleyEra c)
   where
-  initImpNES = initShelleyImpNES
+  initImpTestState = pure ()
 
   impSatisfyNativeScript providedVKeyHashes script = do
     keyPairs <- gets impKeyPairs
@@ -1126,11 +1120,13 @@ withImpState ::
   SpecWith (ImpTestState era) ->
   Spec
 withImpState =
-  beforeAll $ execImpTestM Nothing initImpTestState addRootTxOut
+  beforeAll $
+    execImpTestM Nothing impTestState0 $
+      addRootTxOut >> initImpTestState
   where
-    initImpTestState =
+    impTestState0 =
       ImpTestState
-        { impNES = initImpNES
+        { impNES = initShelleyImpNES
         , impRootTxIn = rootTxIn
         , impKeyPairs = mempty
         , impByronKeyPairs = mempty

diff --git a/eras/shelley/test-suite/cardano-ledger-shelley-test.cabal b/eras/shelley/test-suite/cardano-ledger-shelley-test.cabal
@@ -79,7 +79,7 @@ library
         cardano-ledger-binary:{cardano-ledger-binary, testlib} >=1.3,
         cardano-ledger-byron,
         cardano-ledger-core:{cardano-ledger-core, testlib} >=1.11 && <1.13,
-        cardano-ledger-shelley:{cardano-ledger-shelley, testlib} ^>=1.10,
+        cardano-ledger-shelley:{cardano-ledger-shelley, testlib} ^>=1.11,
         cardano-protocol-tpraos:{cardano-protocol-tpraos, testlib} >=1.0.1,
         cardano-slotting:{cardano-slotting, testlib},
         cborg,

diff --git a/libs/cardano-ledger-api/cardano-ledger-api.cabal b/libs/cardano-ledger-api/cardano-ledger-api.cabal
@@ -61,7 +61,7 @@ library
         cardano-ledger-conway >=1.13 && <1.15,
         cardano-ledger-core ^>=1.12,
         cardano-ledger-mary >=1.5 && <1.7,
-        cardano-ledger-shelley ^>=1.10,
+        cardano-ledger-shelley ^>=1.11,
         cardano-slotting,
         containers,
         FailT,

diff --git a/libs/cardano-ledger-api/test/Test/Cardano/Ledger/Api/State/Imp/QuerySpec.hs b/libs/cardano-ledger-api/test/Test/Cardano/Ledger/Api/State/Imp/QuerySpec.hs
@@ -271,7 +271,7 @@ spec = do
       Map.Map (Credential 'ColdCommitteeRole (EraCrypto era)) (CommitteeMemberState (EraCrypto era)) ->
       ImpTestM era ()
     expectQueryResult ckFilter hkFilter statusFilter expResult = do
-      nes <- use impNESG
+      nes <- use impNESL
       let CommitteeMembersState {csCommittee} =
             queryCommitteeMembersState
               ckFilter