Utxorpc.Types

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

Documentation

data UtxorpcClient

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.

data BuildClientImpl

Methods of the Build module

Constructors

BuildClientImpl

Fields

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

data SubmitClientImpl

Methods of the Submit module

Constructors

SubmitClientImpl

Fields

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

data SyncClientImpl

Methods of the Sync module

Constructors

SyncClientImpl

Fields

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

newtype WatchClientImpl

Methods of the watch module

Constructors

WatchClientImpl

Fields

• watchTx :: ServerStreamCall WatchTxRequest WatchTxResponse

type ServerStreamCall i o

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.

type ServerStreamReply a = IO (Either ClientError (Either TooMuchConcurrency (a, HeaderList, HeaderList)))

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

type UnaryReply o = IO (Either ClientError (Either TooMuchConcurrency (RawReply o)))

The type returned by calls to unary service methods.