Safe Haskell	None
Language	Haskell2010

Cardano.Rpc.Server

Contents

Traces

Synopsis

runRpcServer :: Tracer IO TraceRpc -> RpcConfig -> NetworkMagic -> IORef (Maybe NodeKernelAccess) -> IO ()
data NodeKernelAccess
mkNodeKernelAccess :: Monad m => Tracer m Text -> BlockType blk -> TopLevelConfig blk -> NodeKernel IO addrNTN addrNTC blk -> m (Maybe NodeKernelAccess)
data TraceRpc
data TraceRpcSubmit
data TraceRpcQuery
data TraceRpcSync
data TraceSpanEvent
- = SpanBegin SpanId
- | SpanEnd SpanId

Documentation

runRpcServer Source #

Arguments

:: Tracer IO TraceRpc	Tracer for RPC lifecycle and error events
-> RpcConfig	Server configuration
-> NetworkMagic	Network discriminant
-> IORef (Maybe NodeKernelAccess)	Node kernel access, populated when the kernel is ready
-> IO ()

Start the gRPC server, registering all RPC service handlers. Does nothing when the RPC server is disabled in configuration.

data NodeKernelAccess Source #

In-process access to the node kernel. Constructed by cardano-node once consensus initialisation completes.

Instances

Instances details

Has (IORef (Maybe NodeKernelAccess)) RpcEnv Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Monad Methods obtain :: RpcEnv -> IORef (Maybe NodeKernelAccess) Source #

mkNodeKernelAccess Source #

Arguments

:: Monad m
=> Tracer m Text	Tracer for unsupported block type warnings
-> BlockType blk	Block type witness
-> TopLevelConfig blk	Top-level consensus config (for system start and era history)
-> NodeKernel IO addrNTN addrNTC blk	Consensus node kernel
-> m (Maybe NodeKernelAccess)

Construct NodeKernelAccess from a consensus NodeKernel. Returns Nothing and traces the block type for non-Cardano block types.

Traces

data TraceRpc Source #

A sum type representing all possible traces

Constructors

TraceRpcQuery TraceRpcQuery
TraceRpcSubmit TraceRpcSubmit
TraceRpcSync TraceRpcSync
TraceRpcError SomeException
TraceRpcFatalError SomeException

Instances

Instances details

Pretty TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods pretty :: TraceRpc -> Doc ann # prettyList :: [TraceRpc] -> Doc ann #
Inject TraceRpcQuery TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods inject :: TraceRpcQuery -> TraceRpc Source #
Inject TraceRpcSubmit TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods inject :: TraceRpcSubmit -> TraceRpc Source #
Inject TraceRpcSync TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods inject :: TraceRpcSync -> TraceRpc Source #
MonadIO m => Has (Tracer m TraceRpc) RpcEnv Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Monad Methods obtain :: RpcEnv -> Tracer m TraceRpc Source #

data TraceRpcSubmit Source #

Traces used in SubmitTx service

Constructors

TraceRpcSubmitN2cConnectionError SomeException	Node-to-client connection error during submission
TraceRpcSubmitTxDecodingError DecoderError	Transaction deserialisation error
TraceRpcSubmitTxValidationError TxValidationErrorInCardanoMode	Transaction submission error
TraceRpcSubmitSpan TraceSpanEvent	Transaction submission span
TraceRpcEvalTxDecodingError SerialiseAsRawBytesError	Transaction evaluation deserialisation error
TraceRpcEvalTxSpan TraceSpanEvent	Transaction evaluation span

Instances

Instances details

Error TraceRpcSubmit Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods prettyError :: TraceRpcSubmit -> Doc ann Source #
Show TraceRpcSubmit Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods showsPrec :: Int -> TraceRpcSubmit -> ShowS Source # show :: TraceRpcSubmit -> String Source # showList :: [TraceRpcSubmit] -> ShowS Source #
Pretty TraceRpcSubmit Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods pretty :: TraceRpcSubmit -> Doc ann # prettyList :: [TraceRpcSubmit] -> Doc ann #
Inject TraceRpcSubmit TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods inject :: TraceRpcSubmit -> TraceRpc Source #

data TraceRpcQuery Source #

Traces used in Query service

Constructors

TraceRpcQueryParamsSpan TraceSpanEvent	Span trace marking ReadParams query
TraceRpcQueryReadUtxosSpan TraceSpanEvent	Span trace marking ReadUtxos query
TraceRpcQuerySearchUtxosSpan TraceSpanEvent	Span trace marking SearchUtxos query

Instances

Instances details

Error TraceRpcQuery Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods prettyError :: TraceRpcQuery -> Doc ann Source #
Show TraceRpcQuery Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods showsPrec :: Int -> TraceRpcQuery -> ShowS Source # show :: TraceRpcQuery -> String Source # showList :: [TraceRpcQuery] -> ShowS Source #
Pretty TraceRpcQuery Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods pretty :: TraceRpcQuery -> Doc ann # prettyList :: [TraceRpcQuery] -> Doc ann #
Inject TraceRpcQuery TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods inject :: TraceRpcQuery -> TraceRpc Source #

data TraceRpcSync Source #

Traces used in SyncService (FetchBlock, FollowTip)

Constructors

TraceRpcFetchBlockSpan TraceSpanEvent	FetchBlock span
TraceRpcFetchBlockNotFound SlotNo	Requested block was not found
TraceRpcNodeKernelAccessUnavailable	Node kernel access is not yet available
TraceRpcForkerError String	Ledger forker error

Instances

Instances details

Error TraceRpcSync Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods prettyError :: TraceRpcSync -> Doc ann Source #
Show TraceRpcSync Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods showsPrec :: Int -> TraceRpcSync -> ShowS Source # show :: TraceRpcSync -> String Source # showList :: [TraceRpcSync] -> ShowS Source #
Pretty TraceRpcSync Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods pretty :: TraceRpcSync -> Doc ann # prettyList :: [TraceRpcSync] -> Doc ann #
Inject TraceRpcSync TraceRpc Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods inject :: TraceRpcSync -> TraceRpc Source #

data TraceSpanEvent Source #

Span type

Constructors

SpanBegin SpanId	Opening span trace
SpanEnd SpanId	Ending span trace

Instances

Instances details

Show TraceSpanEvent Source #
Instance details Defined in Cardano.Rpc.Server.Internal.Tracing Methods showsPrec :: Int -> TraceSpanEvent -> ShowS Source # show :: TraceSpanEvent -> String Source # showList :: [TraceSpanEvent] -> ShowS Source #