Documentation ¶
Index ¶
- type BatchHTTP
- func (c BatchHTTP) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error)
- func (c BatchHTTP) ABCIQuery(ctx context.Context, path string, data bytes.HexBytes) (*ctypes.ResultABCIQuery, error)
- func (c BatchHTTP) ABCIQueryWithOptions(ctx context.Context, path string, data bytes.HexBytes, ...) (*ctypes.ResultABCIQuery, error)
- func (c BatchHTTP) Block(ctx context.Context, height *int64) (*ctypes.ResultBlock, error)
- func (c BatchHTTP) BlockByHash(ctx context.Context, hash []byte) (*ctypes.ResultBlock, error)
- func (c BatchHTTP) BlockResults(ctx context.Context, height *int64) (*ctypes.ResultBlockResults, error)
- func (c BatchHTTP) BlockSearch(ctx context.Context, query string, page, perPage *int, orderBy string) (*ctypes.ResultBlockSearch, error)
- func (c BatchHTTP) BlockchainInfo(ctx context.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error)
- func (c BatchHTTP) BroadcastEvidence(ctx context.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error)
- func (c BatchHTTP) BroadcastTxAsync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error)
- func (c BatchHTTP) BroadcastTxCommit(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error)
- func (c BatchHTTP) BroadcastTxSync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error)
- func (c BatchHTTP) CheckTx(ctx context.Context, tx types.Tx) (*ctypes.ResultCheckTx, error)
- func (b *BatchHTTP) Clear() int
- func (c BatchHTTP) Commit(ctx context.Context, height *int64) (*ctypes.ResultCommit, error)
- func (c BatchHTTP) ConsensusParams(ctx context.Context, height *int64) (*ctypes.ResultConsensusParams, error)
- func (c BatchHTTP) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error)
- func (b *BatchHTTP) Count() int
- func (c BatchHTTP) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error)
- func (c BatchHTTP) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error)
- func (c BatchHTTP) GenesisChunked(ctx context.Context, id uint) (*ctypes.ResultGenesisChunk, error)
- func (c BatchHTTP) Health(ctx context.Context) (*ctypes.ResultHealth, error)
- func (c BatchHTTP) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error)
- func (c BatchHTTP) NumUnconfirmedTxs(ctx context.Context) (*ctypes.ResultUnconfirmedTxs, error)
- func (b *BatchHTTP) Send(ctx context.Context) ([]interface{}, error)
- func (c BatchHTTP) Status(ctx context.Context) (*ctypes.ResultStatus, error)
- func (c BatchHTTP) Tx(ctx context.Context, hash []byte, prove bool) (*ctypes.ResultTx, error)
- func (c BatchHTTP) TxSearch(ctx context.Context, query string, prove bool, page, perPage *int, ...) (*ctypes.ResultTxSearch, error)
- func (c BatchHTTP) UnconfirmedTxs(ctx context.Context, limit *int) (*ctypes.ResultUnconfirmedTxs, error)
- func (c BatchHTTP) Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error)
- type HTTP
- func (c HTTP) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error)
- func (c HTTP) ABCIQuery(ctx context.Context, path string, data bytes.HexBytes) (*ctypes.ResultABCIQuery, error)
- func (c HTTP) ABCIQueryWithOptions(ctx context.Context, path string, data bytes.HexBytes, ...) (*ctypes.ResultABCIQuery, error)
- func (c HTTP) Block(ctx context.Context, height *int64) (*ctypes.ResultBlock, error)
- func (c HTTP) BlockByHash(ctx context.Context, hash []byte) (*ctypes.ResultBlock, error)
- func (c HTTP) BlockResults(ctx context.Context, height *int64) (*ctypes.ResultBlockResults, error)
- func (c HTTP) BlockSearch(ctx context.Context, query string, page, perPage *int, orderBy string) (*ctypes.ResultBlockSearch, error)
- func (c HTTP) BlockchainInfo(ctx context.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error)
- func (c HTTP) BroadcastEvidence(ctx context.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error)
- func (c HTTP) BroadcastTxAsync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error)
- func (c HTTP) BroadcastTxCommit(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error)
- func (c HTTP) BroadcastTxSync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error)
- func (c HTTP) CheckTx(ctx context.Context, tx types.Tx) (*ctypes.ResultCheckTx, error)
- func (c HTTP) Commit(ctx context.Context, height *int64) (*ctypes.ResultCommit, error)
- func (c HTTP) ConsensusParams(ctx context.Context, height *int64) (*ctypes.ResultConsensusParams, error)
- func (c HTTP) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error)
- func (c HTTP) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error)
- func (c HTTP) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error)
- func (c HTTP) GenesisChunked(ctx context.Context, id uint) (*ctypes.ResultGenesisChunk, error)
- func (c HTTP) Health(ctx context.Context) (*ctypes.ResultHealth, error)
- func (c HTTP) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error)
- func (c *HTTP) NewBatch() *BatchHTTP
- func (c HTTP) NumUnconfirmedTxs(ctx context.Context) (*ctypes.ResultUnconfirmedTxs, error)
- func (c *HTTP) Remote() string
- func (c *HTTP) SetLogger(l log.Logger)
- func (c HTTP) Status(ctx context.Context) (*ctypes.ResultStatus, error)
- func (c HTTP) Tx(ctx context.Context, hash []byte, prove bool) (*ctypes.ResultTx, error)
- func (c HTTP) TxSearch(ctx context.Context, query string, prove bool, page, perPage *int, ...) (*ctypes.ResultTxSearch, error)
- func (c HTTP) UnconfirmedTxs(ctx context.Context, limit *int) (*ctypes.ResultUnconfirmedTxs, error)
- func (c HTTP) Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error)
- type WSEvents
- func (w *WSEvents) OnStart() error
- func (w *WSEvents) OnStop()
- func (w *WSEvents) Subscribe(ctx context.Context, subscriber, query string, outCapacity ...int) (out <-chan ctypes.ResultEvent, err error)
- func (w *WSEvents) Unsubscribe(ctx context.Context, subscriber, query string) error
- func (w *WSEvents) UnsubscribeAll(ctx context.Context, subscriber string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BatchHTTP ¶
type BatchHTTP struct {
// contains filtered or unexported fields
}
BatchHTTP provides the same interface as `HTTP`, but allows for batching of requests (as per https://www.jsonrpc.org/specification#batch). Do not instantiate directly - rather use the HTTP.NewBatch() method to create an instance of this struct.
Batching of HTTP requests is thread-safe in the sense that multiple goroutines can each create their own batches and send them using the same HTTP client. Multiple goroutines could also enqueue transactions in a single batch, but ordering of transactions in the batch cannot be guaranteed in such an example.
func (BatchHTTP) ABCIInfo ¶
func (c BatchHTTP) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error)
func (BatchHTTP) ABCIQueryWithOptions ¶
func (c BatchHTTP) ABCIQueryWithOptions( ctx context.Context, path string, data bytes.HexBytes, opts rpcclient.ABCIQueryOptions) (*ctypes.ResultABCIQuery, error)
func (BatchHTTP) BlockByHash ¶
func (BatchHTTP) BlockResults ¶
func (BatchHTTP) BlockSearch ¶
func (BatchHTTP) BlockchainInfo ¶
func (BatchHTTP) BroadcastEvidence ¶
func (BatchHTTP) BroadcastTxAsync ¶
func (BatchHTTP) BroadcastTxCommit ¶
func (BatchHTTP) BroadcastTxSync ¶
func (*BatchHTTP) Clear ¶
Clear will empty out this batch of requests and return the number of requests that were cleared out.
func (BatchHTTP) ConsensusParams ¶
func (BatchHTTP) ConsensusState ¶
func (c BatchHTTP) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error)
func (BatchHTTP) DumpConsensusState ¶
func (c BatchHTTP) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error)
func (BatchHTTP) Genesis ¶
func (c BatchHTTP) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error)
func (BatchHTTP) GenesisChunked ¶
func (BatchHTTP) Health ¶
func (c BatchHTTP) Health(ctx context.Context) (*ctypes.ResultHealth, error)
func (BatchHTTP) NetInfo ¶
func (c BatchHTTP) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error)
func (BatchHTTP) NumUnconfirmedTxs ¶
func (c BatchHTTP) NumUnconfirmedTxs(ctx context.Context) (*ctypes.ResultUnconfirmedTxs, error)
func (*BatchHTTP) Send ¶
Send is a convenience function for an HTTP batch that will trigger the compilation of the batched requests and send them off using the client as a single request. On success, this returns a list of the deserialized results from each request in the sent batch.
func (BatchHTTP) Status ¶
func (c BatchHTTP) Status(ctx context.Context) (*ctypes.ResultStatus, error)
func (BatchHTTP) UnconfirmedTxs ¶
func (BatchHTTP) Validators ¶
type HTTP ¶
type HTTP struct { *WSEvents // contains filtered or unexported fields }
HTTP is a Client implementation that communicates with an Ostracon node over JSON RPC and WebSockets.
This is the main implementation you probably want to use in production code. There are other implementations when calling the Ostracon node in-process (Local), or when you want to mock out the server for test code (mock).
You can subscribe for any event published by Ostracon using Subscribe method. Note delivery is best-effort. If you don't read events fast enough or network is slow, Ostracon might cancel the subscription. The client will attempt to resubscribe (you don't need to do anything). It will keep trying every second indefinitely until successful.
Request batching is available for JSON RPC requests over HTTP, which conforms to the JSON RPC specification (https://www.jsonrpc.org/specification#batch). See the example for more details.
Example:
c, err := New("http://192.168.1.10:26657", "/websocket") if err != nil { // handle error } // call Start/Stop if you're subscribing to events err = c.Start() if err != nil { // handle error } defer c.Stop() res, err := c.Status() if err != nil { // handle error } // handle result
func New ¶
New takes a remote endpoint in the form <protocol>://<host>:<port> and the websocket path (which always seems to be "/websocket") An error is returned on invalid remote. The function panics when remote is nil.
func NewWithClient ¶
NewWithClient allows for setting a custom http client (See New). An error is returned on invalid remote. The function panics when remote is nil.
func NewWithTimeout ¶
Create timeout enabled http client
func (HTTP) ABCIQueryWithOptions ¶
func (c HTTP) ABCIQueryWithOptions( ctx context.Context, path string, data bytes.HexBytes, opts rpcclient.ABCIQueryOptions) (*ctypes.ResultABCIQuery, error)
func (HTTP) BlockByHash ¶
func (HTTP) BlockResults ¶
func (HTTP) BlockSearch ¶
func (HTTP) BlockchainInfo ¶
func (HTTP) BroadcastEvidence ¶
func (HTTP) BroadcastTxAsync ¶
func (HTTP) BroadcastTxCommit ¶
func (HTTP) BroadcastTxSync ¶
func (HTTP) ConsensusParams ¶
func (HTTP) ConsensusState ¶
func (c HTTP) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error)
func (HTTP) DumpConsensusState ¶
func (c HTTP) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error)
func (HTTP) GenesisChunked ¶
func (HTTP) NumUnconfirmedTxs ¶
func (c HTTP) NumUnconfirmedTxs(ctx context.Context) (*ctypes.ResultUnconfirmedTxs, error)
func (HTTP) UnconfirmedTxs ¶
func (HTTP) Validators ¶
type WSEvents ¶
type WSEvents struct { service.BaseService // contains filtered or unexported fields }
WSEvents is a wrapper around WSClient, which implements EventsClient.
func (*WSEvents) OnStop ¶
func (w *WSEvents) OnStop()
OnStop implements service.Service by stopping WSClient.
func (*WSEvents) Subscribe ¶
func (w *WSEvents) Subscribe(ctx context.Context, subscriber, query string, outCapacity ...int) (out <-chan ctypes.ResultEvent, err error)
Subscribe implements EventsClient by using WSClient to subscribe given subscriber to query. By default, returns a channel with cap=1. Error is returned if it fails to subscribe.
Channel is never closed to prevent clients from seeing an erroneous event.
It returns an error if WSEvents is not running.
func (*WSEvents) Unsubscribe ¶
Unsubscribe implements EventsClient by using WSClient to unsubscribe given subscriber from query.
It returns an error if WSEvents is not running.