Move Environment into dedicated module

Author: ch1bo

hydra-node/hydra-node.cabal

@@ -67,6 +67,7 @@ library
     Hydra.Chain.Offline
     Hydra.ContestationPeriod
     Hydra.Crypto
+    Hydra.Environment
     Hydra.Events
     Hydra.HeadId
     Hydra.HeadLogic

hydra-node/src/Hydra/Environment.hs

@@ -0,0 +1,36 @@
+module Hydra.Environment where
+
+import Hydra.Prelude
+
+import Hydra.ContestationPeriod (ContestationPeriod)
+import Hydra.Crypto (HydraKey, SigningKey)
+import Hydra.OnChainId (OnChainId)
+import Hydra.Party (Party, deriveParty)
+
+data Environment = Environment
+  { party :: Party
+  -- ^ This is the p_i from the paper
+  , -- XXX: In the long run we would not want to keep the signing key in memory,
+    -- i.e. have an 'Effect' for signing or so.
+    signingKey :: SigningKey HydraKey
+  , otherParties :: [Party]
+  , -- XXX: Improve naming
+    participants :: [OnChainId]
+  , contestationPeriod :: ContestationPeriod
+  }
+  deriving stock (Show)
+
+instance Arbitrary Environment where
+  arbitrary = do
+    signingKey <- arbitrary
+    otherParties <- arbitrary
+    participants <- arbitrary
+    contestationPeriod <- arbitrary
+    pure $
+      Environment
+        { signingKey
+        , party = deriveParty signingKey
+        , otherParties
+        , contestationPeriod
+        , participants
+        }

hydra-node/src/Hydra/HeadLogic.hs

@@ -47,6 +47,7 @@ import Hydra.Crypto (
   sign,
   verifyMultiSignature,
  )
+import Hydra.Environment (Environment (..))
 import Hydra.HeadId (HeadId, HeadSeed)
 import Hydra.HeadLogic.Error (
   LogicError (..),
@@ -69,7 +70,6 @@ import Hydra.HeadLogic.State (
   ClosedState (..),
   Committed,
   CoordinatedHeadState (..),
-  Environment (..),
   HeadState (..),
   IdleState (IdleState, chainState),
   InitialState (..),

hydra-node/src/Hydra/HeadLogic/Outcome.hs

@@ -8,6 +8,7 @@ import Hydra.Prelude
 import Hydra.API.ServerOutput (ServerOutput)
 import Hydra.Chain (ChainStateType, HeadParameters, IsChainState, PostChainTx)
 import Hydra.Crypto (MultiSignature, Signature)
+import Hydra.Environment (Environment (..))
 import Hydra.Events (HasEventId (..))
 import Hydra.HeadId (HeadId, HeadSeed)
 import Hydra.HeadLogic.Error (LogicError)

hydra-node/src/Hydra/HeadLogic/State.hs

@@ -8,42 +8,12 @@ import Hydra.Prelude
 
 import Data.Map qualified as Map
 import Hydra.Chain (ChainStateType, HeadParameters)
-import Hydra.ContestationPeriod (ContestationPeriod)
-import Hydra.Crypto (HydraKey, Signature, SigningKey)
+import Hydra.Crypto (Signature)
 import Hydra.HeadId (HeadId, HeadSeed)
 import Hydra.Ledger (ChainSlot, IsTx (..))
-import Hydra.OnChainId (OnChainId)
-import Hydra.Party (Party, deriveParty)
+import Hydra.Party (Party)
 import Hydra.Snapshot (ConfirmedSnapshot, Snapshot (..), SnapshotNumber)
 
-data Environment = Environment
-  { party :: Party
-  -- ^ This is the p_i from the paper
-  , -- NOTE(MB): In the long run we would not want to keep the signing key in
-    -- memory, i.e. have an 'Effect' for signing or so.
-    signingKey :: SigningKey HydraKey
-  , otherParties :: [Party]
-  , -- XXX: Improve naming
-    participants :: [OnChainId]
-  , contestationPeriod :: ContestationPeriod
-  }
-  deriving stock (Show)
-
-instance Arbitrary Environment where
-  arbitrary = do
-    signingKey <- arbitrary
-    otherParties <- arbitrary
-    participants <- arbitrary
-    contestationPeriod <- arbitrary
-    pure $
-      Environment
-        { signingKey
-        , party = deriveParty signingKey
-        , otherParties
-        , contestationPeriod
-        , participants
-        }
-
 -- | The main state of the Hydra protocol state machine. It holds both, the
 -- overall protocol state, but also the off-chain 'CoordinatedHeadState'.
 --

hydra-node/src/Hydra/Node.hs

@@ -33,10 +33,10 @@ import Hydra.Chain (
 import Hydra.Chain.Direct.Tx (verificationKeyToOnChainId)
 import Hydra.Chain.Direct.Util (readFileTextEnvelopeThrow)
 import Hydra.Crypto (AsType (AsHydraKey))
+import Hydra.Environment (Environment (..))
 import Hydra.Events (EventSink (..), EventSource (..), putEventToSinks, putEventsToSinks)
 import Hydra.HeadLogic (
   Effect (..),
-  Environment (..),
   HeadState (..),
   IdleState (..),
   Input (..),

hydra-node/src/Hydra/Node/Run.hs

@@ -12,7 +12,7 @@ import Hydra.Chain.CardanoClient (QueryPoint (..), queryGenesisParameters)
 import Hydra.Chain.Direct (loadChainContext, mkTinyWallet, withDirectChain)
 import Hydra.Chain.Direct.State (initialChainState)
 import Hydra.Chain.Offline (loadGenesisFile, withOfflineChain)
-import Hydra.HeadLogic (Environment (..))
+import Hydra.Environment (Environment (..))
 import Hydra.Ledger.Cardano qualified as Ledger
 import Hydra.Ledger.Cardano.Configuration (
   Globals,

hydra-node/test/Hydra/BehaviorSpec.hs

@@ -38,9 +38,9 @@ import Hydra.Chain.Direct.Handlers (getLatest, newLocalChainState, pushNew, roll
 import Hydra.Chain.Direct.State (ChainStateAt (..))
 import Hydra.ContestationPeriod (ContestationPeriod (UnsafeContestationPeriod), toNominalDiffTime)
 import Hydra.Crypto (HydraKey, aggregate, sign)
+import Hydra.Environment (Environment (..))
 import Hydra.HeadLogic (
   Effect (..),
-  Environment (..),
   HeadState (..),
   IdleState (..),
   Input (..),

hydra-node/test/Hydra/HeadLogicSnapshotSpec.hs

@@ -10,10 +10,10 @@ import Data.List qualified as List
 import Data.Map.Strict qualified as Map
 import Hydra.Chain (HeadParameters (..))
 import Hydra.Crypto (sign)
+import Hydra.Environment (Environment (..))
 import Hydra.HeadLogic (
   CoordinatedHeadState (..),
   Effect (..),
-  Environment (..),
   HeadState (..),
   Input (NetworkInput),
   OpenState (OpenState),

hydra-node/test/Hydra/HeadLogicSpec.hs

@@ -28,12 +28,12 @@ import Hydra.Chain.Direct.Fixture qualified as Fixture
 import Hydra.Chain.Direct.State ()
 import Hydra.Crypto (generateSigningKey, sign)
 import Hydra.Crypto qualified as Crypto
+import Hydra.Environment (Environment (..))
 import Hydra.Events (EventId)
 import Hydra.HeadLogic (
   ClosedState (..),
   CoordinatedHeadState (..),
   Effect (..),
-  Environment (..),
   HeadState (..),
   IdleState (..),
   InitialState (..),