| Safe Haskell | Safe-Inferred |
|---|---|
| Language | GHC2021 |
Hydra.Cluster.HeadLifecycle
Description
Head lifecycle shared by benchmarks and scripted demonstrations.
Synopsis
- fundDataset :: ChainBackendOptions -> Dataset -> Bool -> Tracer IO FaucetLog -> IO [UTxO]
- openHead :: Timing -> ChainBackendOptions -> [ClientDataset] -> NonEmpty HydraClient -> IO HeadId
- closeHead :: Timing -> HeadId -> HydraClient -> IO UTCTime
- fanoutHead :: Tracer IO HydraNodeLog -> UTCTime -> HeadId -> HydraClient -> IO Int
Documentation
fundDataset :: ChainBackendOptions -> Dataset -> Bool -> Tracer IO FaucetLog -> IO [UTxO] Source #
Fund the dataset and node fuel, optionally reserving incremental deposits.
openHead :: Timing -> ChainBackendOptions -> [ClientDataset] -> NonEmpty HydraClient -> IO HeadId Source #
Open an empty Head and wait for every dataset deposit to settle everywhere.
closeHead :: Timing -> HeadId -> HydraClient -> IO UTCTime Source #
Return the observed contestation deadline, allowing reporting before fanout.
fanoutHead :: Tracer IO HydraNodeLog -> UTCTime -> HeadId -> HydraClient -> IO Int Source #
Wait for the deadline and require successful finalization. Callers decide whether a failure is fatal (scenarios) or belongs in a benchmark report.