Move Chain-Examples module under Examples

for consistency and also in order to make `Example` module available

Author: teodanciu

eras/shelley/test-suite/cardano-ledger-shelley-test.cabal

@@ -112,7 +112,7 @@ test-suite cardano-ledger-shelley-test
   hs-source-dirs: test
   other-modules:
     Paths_cardano_ledger_shelley_test
-    Test.Cardano.Ledger.Shelley.Examples
+    Test.Cardano.Ledger.Shelley.Examples.Chain
     Test.Cardano.Ledger.Shelley.Examples.Combinators
     Test.Cardano.Ledger.Shelley.Examples.EmptyBlock
     Test.Cardano.Ledger.Shelley.Examples.GenesisDelegation

…/Test/Cardano/Ledger/Shelley/Examples.hs …Cardano/Ledger/Shelley/Examples/Chain.hseras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples.hs renamed to eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/Chain.hs eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples.hs renamed to eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/Chain.hs

@@ -1,6 +1,6 @@
 {-# LANGUAGE TypeApplications #-}
 
-module Test.Cardano.Ledger.Shelley.Examples (
+module Test.Cardano.Ledger.Shelley.Examples.Chain (
   CHAINExample (..),
   testCHAINExample,
 ) where

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/Combinators.hs

@@ -6,11 +6,7 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE TypeOperators #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.Combinators
--- Description : Chain State Combinators
---
--- A collection of combinators for manipulating Chain State.
+-- | A collection of combinators for manipulating Chain State.
 -- The idea is to provide a clear way of describing the
 -- changes to the chain state when a block is processed.
 module Test.Cardano.Ledger.Shelley.Examples.Combinators (

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/EmptyBlock.hs

@@ -20,7 +20,7 @@ import Cardano.Protocol.TPraos.OCert (KESPeriod (..))
 import Data.Default
 import GHC.Stack (HasCallStack)
 import Test.Cardano.Ledger.Shelley.ConcreteCryptoTypes (MockCrypto)
-import Test.Cardano.Ledger.Shelley.Examples (CHAINExample (..))
+import Test.Cardano.Ledger.Shelley.Examples.Chain (CHAINExample (..))
 import Test.Cardano.Ledger.Shelley.Examples.Combinators (
   evolveNonceUnfrozen,
   newLab,

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/GenesisDelegation.hs

@@ -5,11 +5,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.GenesisDelegation
--- Description : Genesis Delegation Example
---
--- Example demonstrating Genesis Delegation
+-- | Example demonstrating Genesis Delegation
 module Test.Cardano.Ledger.Shelley.Examples.GenesisDelegation (
   genesisDelegExample,
 ) where
@@ -38,8 +34,8 @@ import qualified Data.Sequence.Strict as StrictSeq
 import qualified Data.Set as Set
 import Test.Cardano.Ledger.Core.KeyPair (KeyPair (..), mkWitnessesVKey)
 import Test.Cardano.Ledger.Shelley.ConcreteCryptoTypes (MockCrypto)
-import Test.Cardano.Ledger.Shelley.Examples (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Cast as Cast
+import Test.Cardano.Ledger.Shelley.Examples.Chain (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Combinators as C
 import Test.Cardano.Ledger.Shelley.Examples.Federation (
   coreNodeKeysBySchedule,

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/Init.hs

@@ -5,11 +5,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.Init
--- Description : Initial State for Shelley ledger examples
---
--- The initial state for Shelley Ledger Examples.
+-- | The initial state for Shelley Ledger Examples.
 module Test.Cardano.Ledger.Shelley.Examples.Init (
   ppEx,
   initSt,

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/Mir.hs

@@ -5,11 +5,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.Mir
--- Description : MIR Example
---
--- Example demonstrating the Move Instantaneous Rewards mechanism
+-- | Example demonstrating the Move Instantaneous Rewards mechanism
 module Test.Cardano.Ledger.Shelley.Examples.Mir (
   mirExample,
 ) where
@@ -47,8 +43,8 @@ import qualified Data.Sequence.Strict as StrictSeq
 import qualified Data.Set as Set
 import Test.Cardano.Ledger.Core.KeyPair (KeyPair (..), mkWitnessesVKey)
 import Test.Cardano.Ledger.Shelley.ConcreteCryptoTypes (MockCrypto)
-import Test.Cardano.Ledger.Shelley.Examples (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Cast as Cast
+import Test.Cardano.Ledger.Shelley.Examples.Chain (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Combinators as C
 import Test.Cardano.Ledger.Shelley.Examples.Federation (
   coreNodeIssuerKeys,

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/PoolLifetime.hs

@@ -8,11 +8,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.PoolLifetime
--- Description : Pool Lifetime Example
---
--- Example demonstrating the creation of a new stake pool,
+-- | Example demonstrating the creation of a new stake pool,
 -- block production under Praos, rewards, and pool retirement.
 module Test.Cardano.Ledger.Shelley.Examples.PoolLifetime (
   makePulser,
@@ -92,8 +88,8 @@ import GHC.Exts (fromList)
 import GHC.Stack (HasCallStack)
 import Test.Cardano.Ledger.Core.KeyPair (mkWitnessesVKey)
 import Test.Cardano.Ledger.Shelley.ConcreteCryptoTypes (MockCrypto)
-import Test.Cardano.Ledger.Shelley.Examples (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Cast as Cast
+import Test.Cardano.Ledger.Shelley.Examples.Chain (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Combinators as C
 import Test.Cardano.Ledger.Shelley.Examples.Federation (
   coreNodeIssuerKeys,

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/PoolReReg.hs

@@ -5,11 +5,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.PoolReReg
--- Description : Pool Re-Registration
---
--- Example demonstrating the adoption of of pool parameters
+-- | Example demonstrating the adoption of of pool parameters
 -- when re-registratiing.
 module Test.Cardano.Ledger.Shelley.Examples.PoolReReg (
   poolReRegExample,
@@ -45,8 +41,8 @@ import Data.Word (Word64)
 import GHC.Stack (HasCallStack)
 import Test.Cardano.Ledger.Core.KeyPair (mkWitnessesVKey)
 import Test.Cardano.Ledger.Shelley.ConcreteCryptoTypes (MockCrypto)
-import Test.Cardano.Ledger.Shelley.Examples (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Cast as Cast
+import Test.Cardano.Ledger.Shelley.Examples.Chain (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Combinators as C
 import Test.Cardano.Ledger.Shelley.Examples.Federation (coreNodeKeysBySchedule)
 import Test.Cardano.Ledger.Shelley.Examples.Init (

eras/shelley/test-suite/test/Test/Cardano/Ledger/Shelley/Examples/TwoPools.hs

@@ -9,11 +9,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 
--- |
--- Module      : Test.Cardano.Ledger.Shelley.Examples.TwoPools
--- Description : Two Pools Example
---
--- Example demonstrating a particular delegation scenario involving
+-- | Example demonstrating a particular delegation scenario involving
 -- two pools. Both pools select a reward account which is *not*
 -- a pool owner, and which delegates to one of the pools.
 module Test.Cardano.Ledger.Shelley.Examples.TwoPools (
@@ -99,8 +95,8 @@ import GHC.Stack (HasCallStack)
 import Lens.Micro ((&), (.~), (^.))
 import Test.Cardano.Ledger.Core.KeyPair (mkWitnessesVKey)
 import Test.Cardano.Ledger.Shelley.ConcreteCryptoTypes (MockCrypto)
-import Test.Cardano.Ledger.Shelley.Examples (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Cast as Cast
+import Test.Cardano.Ledger.Shelley.Examples.Chain (CHAINExample (..), testCHAINExample)
 import qualified Test.Cardano.Ledger.Shelley.Examples.Combinators as C
 import Test.Cardano.Ledger.Shelley.Examples.Federation (
   coreNodeKeysBySchedule,