jsonrpc2client

README

A Simple and Fast JsonRPC2.0 Client

The simplicity of the structure and interaction of something like https://github.com/ybbus/jsonrpc is fantastic, but the use of the standard connection lib and reflect is a significant drag on performance in certain situations. Notable, it isn't ideal for something like downloading and parsing thousands of blocks from a blockchain.

This client exists primarily to facilitate a simple interface with blockchain api nodes. There is little error handling as it is expected that will be handled upstream when checking protocol specific issues - handle bytes once for maximum speed

Usage

The general flow is to create a client:

maxConn := 2
maxBatch := 500
rpcClient := jsonrpc2client.NewClientWithOpts(endpoint, maxConn, maxBatch)

Create an RPC request (or batch of requests in this case):

    var jr2queries jsonrpc2client.RPCRequests
    for i, query := range queries {
        jr2query := &jsonrpc2client.RpcRequest{Method: query.method, JsonRpc: "2.0", Id: i, Params: query.params}
        jr2queries = append(jr2queries, jr2query)
    }

Then exec the RPC reqeuest. There are some options for single, batch, and batchFast. The "fast" option will return unprocessed bytes from the rpc server:

    resps, err :=rpcClient.CallBatchFast(jr2queries)
    if err != nil {
        return nil, err
    }
    data := doStuffWith(resps)

Documentation

Index

• func NewClient(endpoint string) *rpcClient
• func NewClientWithOpts(endpoint string, maxConn int, maxBatch int) *rpcClient
• type RPCRequests
• type RpcError
• type RpcRequest
• type RpcResponse
• type RpcResponses

Functions

func NewClient

func NewClient(endpoint string) *rpcClient

func NewClientWithOpts

func NewClientWithOpts(endpoint string, maxConn int, maxBatch int) *rpcClient

Types

type RPCRequests

type RPCRequests []*RpcRequest

type RpcError

type RpcError struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data,omitempty"`
}

type RpcRequest

type RpcRequest struct {
	JsonRpc string      `json:"jsonrpc"`
	Id      int         `json:"id"`
	Method  string      `json:"method"`
	Params  interface{} `json:"params,omitempty"`
}

type RpcResponse

type RpcResponse struct {
	JSONRPC string          `json:"jsonrpc"`
	Result  json.RawMessage `json:"result,omitempty"`
	Error   *RpcError       `json:"error,omitempty"`
	ID      int             `json:"id"`
}

type RpcResponses

type RpcResponses []*RpcResponse