Safe Haskell	Safe-Inferred
Language	Haskell2010

Utxorpc.Server

Synopsis

runUtxorpc :: MonadIO m => ServiceConfig m a b c d e -> IO ()
data ServiceConfig m a b c d e = ServiceConfig {
- tlsSettings :: TLSSettings
- warpSettings :: Settings
- handlers :: UtxorpcHandlers m a b c d e
- logger :: Maybe (UtxorpcServiceLogger m)
- unlift :: forall x. m x -> IO x
- compression :: [Compression]
}
data UtxorpcHandlers m a b c d e = UtxorpcHandlers {
- buildHandlers :: BuildHandlers m a
- submitHandlers :: SubmitHandlers m b c
- syncHandlers :: SyncHandlers m d
- watchHandlers :: WatchHandlers m e
}
data BuildHandlers m a = BuildHandlers {
}
data SubmitHandlers m a b = SubmitHandlers {
}
data SyncHandlers m a = SyncHandlers {
}
newtype WatchHandlers m a = WatchHandlers {
- watchTx :: ServerStreamHandler m WatchTxRequest WatchTxResponse a
}
data UtxorpcServiceLogger m = UtxorpcServiceLogger {
- requestLogger :: RequestLogger m
- replyLogger :: ReplyLogger m
- serverStreamLogger :: ServerStreamLogger m
- serverStreamEndLogger :: ServerStreamEndLogger m
}
type RequestLogger m = forall i. Show i => ByteString -> Request -> UUID -> i -> m ()
type ReplyLogger m = forall o. Show o => ByteString -> Request -> UUID -> o -> m ()
type ServerStreamLogger m = forall o. Show o => ByteString -> Request -> (UUID, Int) -> o -> m ()
type ServerStreamEndLogger m = ByteString -> Request -> (UUID, Int) -> m ()

Documentation

runUtxorpc Source #

Arguments

:: MonadIO m
=> ServiceConfig m a b c d e	Configuration info and method handlers. See `ServiceConfig` for type information.
-> IO ()

Run a UTxO RPC service from a ServiceConfig.

data ServiceConfig m a b c d e Source #

Configuration info and method handlers. Note that the handlers and logger run in the same monad. The monadic actions of the logger and handlers for a single call are combined, and unlift runs the combined action in IO. This means that changes to the monadic state made by the request logger (e.g., adding a namespace) are seen by the handlers and other logging functions for that specific call.

Constructors

ServiceConfig

Fields

tlsSettings :: TLSSettings
warp-tls settings for using TLS.
warpSettings :: Settings
warp settings
handlers :: UtxorpcHandlers m a b c d e
A handler for each method in the UTxO RPC specification.
logger :: Maybe (UtxorpcServiceLogger m)
Log each RPC event.
unlift :: forall x. m x -> IO x
An unlift function for the handlers and logger. Allows the handler and logger to be run in any monad, but they must be the same monad.
compression :: [Compression]
A list of compressions to accept and use.

data UtxorpcHandlers m a b c d e Source #

A handler for each method in the UTxO RPC specification. ServerStreamHandlers require a type variable representing the "stream state" (a value that the stream processes/folds over). The type variables here (other than m) are the type variables of each stream handler in the record.

Constructors

UtxorpcHandlers
Fields buildHandlers :: BuildHandlers m a Handlers for the Build module. submitHandlers :: SubmitHandlers m b c Handlers for the Submit module. syncHandlers :: SyncHandlers m d Handlers for the Sync module. watchHandlers :: WatchHandlers m e Handlers for the Watch module.

data SubmitHandlers m a b Source #

Constructors

SubmitHandlers
Fields submitTx :: UnaryHandler m SubmitTxRequest SubmitTxResponse readMempool :: UnaryHandler m ReadMempoolRequest ReadMempoolResponse waitForTx :: ServerStreamHandler m WaitForTxRequest WaitForTxResponse a watchMempool :: ServerStreamHandler m WatchMempoolRequest WatchMempoolResponse b

data SyncHandlers m a Source #

Constructors

SyncHandlers
Fields fetchBlock :: UnaryHandler m FetchBlockRequest FetchBlockResponse dumpHistory :: UnaryHandler m DumpHistoryRequest DumpHistoryResponse followTip :: ServerStreamHandler m FollowTipRequest FollowTipResponse a

newtype WatchHandlers m a Source #

Constructors

WatchHandlers
Fields watchTx :: ServerStreamHandler m WatchTxRequest WatchTxResponse a

data UtxorpcServiceLogger m Source #

A record of logging functions that runs in the same monad as the request handlers. Monadic state is passed along throughout the lifecycle of responding to a request. This means that changes to the monadic state in the request logger is seen by the stream logger, stream handler and logger, and reply logger. An unlift function to run the monad in IO is provided to runUtxorpc.

Constructors

UtxorpcServiceLogger
Fields requestLogger :: RequestLogger m replyLogger :: ReplyLogger m serverStreamLogger :: ServerStreamLogger m serverStreamEndLogger :: ServerStreamEndLogger m

type RequestLogger m Source #

Arguments

= forall i. Show i
=> ByteString	The RPC path
-> Request	Request metadata
-> UUID	A UUID generated for this request and passed to stream and reply loggers.
-> i	The request message
-> m ()

Log incoming requests.

type ReplyLogger m Source #

Arguments

= forall o. Show o
=> ByteString	The RPC path
-> Request	Request metadata
-> UUID
-> o	The reply message
-> m ()

Log outgoing replies.

type ServerStreamLogger m Source #

Arguments

= forall o. Show o
=> ByteString	The RPC path
-> Request	Request metadata
-> (UUID, Int)	The UUID generated for the request that generated this stream, and the 0-based index of the message in the stream.
-> o	The stream message
-> m ()

Log outgoing server stream messages.

type ServerStreamEndLogger m Source #

Arguments

= ByteString	The RPC path
-> Request	Request metadata
-> (UUID, Int)	The UUID generated for the request that generated this stream, and the 0-based index of the message in the stream.
-> m ()

Log the end of a server stream.

BuildHandlers
Fields getChainTip :: UnaryHandler m GetChainTipRequest GetChainTipResponse getChainParam :: UnaryHandler m GetChainParamRequest GetChainParamResponse getUtxoByAddress :: UnaryHandler m GetUtxoByAddressRequest GetUtxoByAddressResponse getUtxoByRef :: UnaryHandler m GetUtxoByRefRequest GetUtxoByRefResponse holdUtxo :: ServerStreamHandler m HoldUtxoRequest HoldUtxoResponse a