Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.API.Server

Synopsis

newtype Server tx m = Server {
- sendMessage :: ClientMessage tx -> m ()
}
data APIServerConfig = APIServerConfig {
- host :: IP
- port :: PortNumber
- tlsCertPath :: Maybe FilePath
- tlsKeyPath :: Maybe FilePath
}
withAPIServer :: forall tx. IsChainState tx => APIServerConfig -> Environment -> Party -> EventSource (StateEvent tx) IO -> Tracer IO APIServerLog -> Chain tx IO -> PParams LedgerEra -> ServerOutputFilter tx -> (ClientInput tx -> IO ()) -> ((EventSink (StateEvent tx) IO, Server tx IO) -> IO ()) -> IO ()
data RunServerException = RunServerException {
- ioException :: IOException
- host :: IP
- port :: PortNumber
}
type NotifyServerRunning = IO ()
type WaitForServer = IO ()
setupServerNotification :: IO (NotifyServerRunning, WaitForServer)
mkTimedServerOutputFromStateEvent :: IsTx tx => StateEvent tx -> Maybe (TimedServerOutput tx)
projectPendingDeposits :: IsTx tx => [TxIdType tx] -> StateChanged tx -> [TxIdType tx]
projectCommitInfo :: CommitInfo -> StateChanged tx -> CommitInfo
projectInitializingHeadId :: Maybe HeadId -> StateChanged tx -> Maybe HeadId
projectHeadStatus :: HeadStatus -> StateChanged tx -> HeadStatus
projectSnapshotUtxo :: Monoid (UTxOType tx) => Maybe (UTxOType tx) -> StateChanged tx -> Maybe (UTxOType tx)
projectSeenSnapshot :: SeenSnapshot tx -> StateChanged tx -> SeenSnapshot tx
projectSnapshotConfirmed :: Maybe (ConfirmedSnapshot tx) -> StateChanged tx -> Maybe (ConfirmedSnapshot tx)

Documentation

newtype Server tx m Source #

Handle to provide a means for sending server outputs to clients.

Constructors

Server
Fields sendMessage :: ClientMessage tx -> m () Send some output to all connected clients.

data APIServerConfig Source #

Constructors

APIServerConfig
Fields host :: IP port :: PortNumber tlsCertPath :: Maybe FilePath tlsKeyPath :: Maybe FilePath

withAPIServer :: forall tx. IsChainState tx => APIServerConfig -> Environment -> Party -> EventSource (StateEvent tx) IO -> Tracer IO APIServerLog -> Chain tx IO -> PParams LedgerEra -> ServerOutputFilter tx -> (ClientInput tx -> IO ()) -> ((EventSink (StateEvent tx) IO, Server tx IO) -> IO ()) -> IO () Source #

data RunServerException Source #

An IOException with more IP and PortNumber added as context.

Constructors

RunServerException
Fields ioException :: IOException host :: IP port :: PortNumber

Instances

Instances details

Exception RunServerException Source #
Instance details Defined in Hydra.API.Server Methods toException :: RunServerException -> SomeException Source # fromException :: SomeException -> Maybe RunServerException Source # displayException :: RunServerException -> String Source #
Show RunServerException Source #
Instance details Defined in Hydra.API.Server Methods showsPrec :: Int -> RunServerException -> ShowS Source # show :: RunServerException -> String Source # showList :: [RunServerException] -> ShowS Source #

type NotifyServerRunning = IO () Source #

type WaitForServer = IO () Source #

setupServerNotification :: IO (NotifyServerRunning, WaitForServer) Source #

Setup notification and waiter to ensure that something only runs after the server is actually listening.

mkTimedServerOutputFromStateEvent :: IsTx tx => StateEvent tx -> Maybe (TimedServerOutput tx) Source #

Defines the subset of StateEvent that should be sent as TimedServerOutput to clients.

projectPendingDeposits :: IsTx tx => [TxIdType tx] -> StateChanged tx -> [TxIdType tx] Source #

Projection to obtain the list of pending deposits.

projectCommitInfo :: CommitInfo -> StateChanged tx -> CommitInfo Source #

Projection to obtain CommitInfo needed to draft commit transactions. NOTE: We only want to project HeadId when the Head is in the Initializing state since this is when Head parties need to commit some funds.

projectInitializingHeadId :: Maybe HeadId -> StateChanged tx -> Maybe HeadId Source #

Projection to obtain the HeadId needed to draft a commit transaction. NOTE: We only want to project HeadId when the Head is in the Initializing state since this is when Head parties need to commit some funds.

projectHeadStatus :: HeadStatus -> StateChanged tx -> HeadStatus Source #

Projection function related to headStatus field in Greetings message.

projectSnapshotUtxo :: Monoid (UTxOType tx) => Maybe (UTxOType tx) -> StateChanged tx -> Maybe (UTxOType tx) Source #

Projection of latest confirmed snapshot UTxO.

projectSeenSnapshot :: SeenSnapshot tx -> StateChanged tx -> SeenSnapshot tx Source #

Projection of latest seen snapshot.

projectSnapshotConfirmed :: Maybe (ConfirmedSnapshot tx) -> StateChanged tx -> Maybe (ConfirmedSnapshot tx) Source #

Projection of latest confirmed snapshot.