| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
Hydra.Node
Description
Top-level module to run a single Hydra node.
Checkout Hydra
Documentation
for some details about the overall architecture of the Node.
Synopsis
- initEnvironment :: RunOptions -> IO Environment
- checkHeadState :: MonadThrow m => Tracer m (HydraNodeLog tx) -> Environment -> HeadState tx -> m ()
- data DraftHydraNode tx m = DraftHydraNode {
- tracer :: Tracer m (HydraNodeLog tx)
- env :: Environment
- ledger :: Ledger tx
- nodeStateHandler :: NodeStateHandler tx m
- inputQueue :: InputQueue m (Input tx)
- eventSource :: EventSource (StateEvent tx) m
- eventSinks :: [EventSink (StateEvent tx) m]
- chainStateHistory :: ChainStateHistory tx
- hydrate :: (IsChainState tx, MonadDelay m, MonadLabelledSTM m, MonadAsync m, MonadThrow m, MonadUnliftIO m) => Tracer m (HydraNodeLog tx) -> Environment -> Ledger tx -> ChainStateType tx -> EventStore (StateEvent tx) m -> [EventSink (StateEvent tx) m] -> m (DraftHydraNode tx m)
- wireChainInput :: DraftHydraNode tx m -> ChainEvent tx -> m ()
- wireClientInput :: DraftHydraNode tx m -> ClientInput tx -> m ()
- wireNetworkInput :: DraftHydraNode tx m -> NetworkCallback (Authenticated (Message tx)) m
- mkNetworkInput :: Party -> Message tx -> Input tx
- connect :: Monad m => Chain tx m -> Network m (Message tx) -> Server tx m -> DraftHydraNode tx m -> m (HydraNode tx m)
- data HydraNode tx m = HydraNode {
- tracer :: Tracer m (HydraNodeLog tx)
- env :: Environment
- ledger :: Ledger tx
- nodeStateHandler :: NodeStateHandler tx m
- inputQueue :: InputQueue m (Input tx)
- eventSource :: EventSource (StateEvent tx) m
- eventSinks :: [EventSink (StateEvent tx) m]
- oc :: Chain tx m
- hn :: Network m (Message tx)
- server :: Server tx m
- runHydraNode :: (MonadCatch m, MonadAsync m, MonadTime m, IsChainState tx) => HydraNode tx m -> m ()
- stepHydraNode :: (MonadCatch m, MonadAsync m, MonadTime m, IsChainState tx) => UTCTime -> HydraNode tx m -> m ()
- defaultTTL :: TTL
- defaultTxTTL :: TTL
- waitDelay :: DiffTime
- processNextInput :: IsChainState tx => HydraNode tx m -> Input tx -> UTCTime -> STM m (Outcome tx)
- processStateChanges :: (MonadSTM m, MonadTime m) => HydraNode tx m -> [StateChanged tx] -> m ()
- processEffects :: (MonadAsync m, MonadCatch m, IsChainState tx) => HydraNode tx m -> Tracer m (HydraNodeLog tx) -> Word64 -> [Effect tx] -> m ()
- data NodeStateHandler tx m = NodeStateHandler {
- modifyNodeState :: forall a. (NodeState tx -> (a, NodeState tx)) -> STM m a
- queryNodeState :: STM m (NodeState tx)
- getNextEventId :: STM m EventId
- createNodeStateHandler :: MonadLabelledSTM m => Maybe EventId -> NodeState tx -> m (NodeStateHandler tx m)
- data HydraNodeLog tx
- = BeginInput { }
- | EndInput { }
- | BeginEffect { }
- | EndEffect { }
- | LogicOutcome { }
- | DroppedFromQueue { }
- | LoadingState
- | LoadedState {
- lastEventId :: Last EventId
- nodeState :: NodeState tx
- | LoadedChainState {
- lastKnownChainPoint :: ChainPointType tx
- | ReplayingState
- | Misconfiguration { }
Environment Handling
initEnvironment :: RunOptions -> IO Environment Source #
Initialize the Environment from command line options.
checkHeadState :: MonadThrow m => Tracer m (HydraNodeLog tx) -> Environment -> HeadState tx -> m () Source #
Checks that command line options match a given HeadState. This function
takes Environment because it is derived from RunOptions via
initEnvironment.
Throws: ParameterMismatch when state not matching the environment.
Create and run a hydra node
data DraftHydraNode tx m Source #
A draft version of the HydraNode that holds state, but is not yet
connected (see connect). This is commonly created by the hydrate smart
constructor.
Constructors
| DraftHydraNode | |
Fields
| |
hydrate :: (IsChainState tx, MonadDelay m, MonadLabelledSTM m, MonadAsync m, MonadThrow m, MonadUnliftIO m) => Tracer m (HydraNodeLog tx) -> Environment -> Ledger tx -> ChainStateType tx -> EventStore (StateEvent tx) m -> [EventSink (StateEvent tx) m] -> m (DraftHydraNode tx m) Source #
Hydrate a DraftHydraNode by loading events from source, re-aggregate node
state and sending events to sinks while doing so.
wireChainInput :: DraftHydraNode tx m -> ChainEvent tx -> m () Source #
wireClientInput :: DraftHydraNode tx m -> ClientInput tx -> m () Source #
wireNetworkInput :: DraftHydraNode tx m -> NetworkCallback (Authenticated (Message tx)) m Source #
mkNetworkInput :: Party -> Message tx -> Input tx Source #
Create a network input with corresponding default ttl from given sender.
connect :: Monad m => Chain tx m -> Network m (Message tx) -> Server tx m -> DraftHydraNode tx m -> m (HydraNode tx m) Source #
Connect chain, network and API to a hydrated DraftHydraNode to get a fully
connected HydraNode.
Fully connected hydra node with everything wired in.
Constructors
| HydraNode | |
Fields
| |
runHydraNode :: (MonadCatch m, MonadAsync m, MonadTime m, IsChainState tx) => HydraNode tx m -> m () Source #
stepHydraNode :: (MonadCatch m, MonadAsync m, MonadTime m, IsChainState tx) => UTCTime -> HydraNode tx m -> m () Source #
defaultTTL :: TTL Source #
The maximum number of times to re-enqueue a network messages upon Wait.
outcome.
defaultTxTTL :: TTL Source #
processNextInput :: IsChainState tx => HydraNode tx m -> Input tx -> UTCTime -> STM m (Outcome tx) Source #
Monadic interface around update.
processStateChanges :: (MonadSTM m, MonadTime m) => HydraNode tx m -> [StateChanged tx] -> m () Source #
processEffects :: (MonadAsync m, MonadCatch m, IsChainState tx) => HydraNode tx m -> Tracer m (HydraNodeLog tx) -> Word64 -> [Effect tx] -> m () Source #
Manage state
data NodeStateHandler tx m Source #
Handle to access and modify the state in the Hydra Node.
Constructors
| NodeStateHandler | |
Fields
| |
createNodeStateHandler Source #
Arguments
| :: MonadLabelledSTM m | |
| => Maybe EventId | Last seen |
| -> NodeState tx | |
| -> m (NodeStateHandler tx m) |
Initialize a new NodeStateHandler.
Logging
data HydraNodeLog tx Source #
Constructors
| BeginInput | |
| EndInput | |
| BeginEffect | |
| EndEffect | |
| LogicOutcome | |
| DroppedFromQueue | |
| LoadingState | |
| LoadedState | |
Fields
| |
| LoadedChainState | |
Fields
| |
| ReplayingState | |
| Misconfiguration | |
Fields | |