Safe Haskell	Safe-Inferred
Language	Haskell2010

Utxorpc.Types

Description

The types in this module are required to call methods of a UtxorpcClient.

Synopsis

Documentation

Methods for each module in UTxO RPC. >>> fetchBlock (buildClient client) defMessage

Constructors

UtxorpcClient
Fields buildClient :: BuildClientImpl Build module service methods. submitClient :: SubmitClientImpl Submit module service methods. syncClient :: SyncClientImpl Sync module service methods. watchClient :: WatchClientImpl Watch module service methods. close :: IO (Either ClientError ()) Closes the gRPC connection.

Methods of the Build module

Methods of the Submit module

Constructors

SubmitClientImpl
Fields submitTx :: SubmitTxRequest -> UnaryReply SubmitTxResponse readMempool :: ReadMempoolRequest -> UnaryReply ReadMempoolResponse waitForTx :: ServerStreamCall WaitForTxRequest WaitForTxResponse watchMempool :: ServerStreamCall WatchMempoolRequest WatchMempoolResponse

Methods of the Sync module

Constructors

SyncClientImpl
Fields fetchBlock :: FetchBlockRequest -> UnaryReply FetchBlockResponse dumpHistory :: DumpHistoryRequest -> UnaryReply DumpHistoryResponse followTip :: ServerStreamCall FollowTipRequest FollowTipResponse

Methods of the watch module

Constructors

WatchClientImpl
Fields watchTx :: ServerStreamCall WatchTxRequest WatchTxResponse

Arguments

= forall a. a	The initial state for the stream processing function.
-> i	The request message to send to the service.
-> (a -> HeaderList -> o -> IO a)	The stream processing function. It is a fold over some state a with stream messages o.
-> ServerStreamReply a	The final state of the stream processing function, or an error.

Type definition for functions that make calls to server stream methods. Note that the stream state, a, can be different for each call.

The type returned by calls to server stream methods. a is the final state of the stream processing function.

The type returned by calls to unary service methods.

BuildClientImpl
Fields getChainTip :: GetChainTipRequest -> UnaryReply GetChainTipResponse getChainParam :: GetChainParamRequest -> UnaryReply GetChainParamResponse getUtxoByAddress :: GetUtxoByAddressRequest -> UnaryReply GetUtxoByAddressResponse getUtxoByRef :: GetUtxoByRefRequest -> UnaryReply GetUtxoByRefResponse holdUtxo :: ServerStreamCall HoldUtxoRequest HoldUtxoResponse