tendermint: github.com/tendermint/tendermint/rpc/client Index | Files | Directories

package client

import "github.com/tendermint/tendermint/rpc/client"

Index

Package Files

helpers.go httpclient.go interface.go localclient.go types.go

Variables

var DefaultABCIQueryOptions = ABCIQueryOptions{Height: 0, Prove: false}

DefaultABCIQueryOptions are latest height (0) and prove false.

func DefaultWaitStrategy Uses

func DefaultWaitStrategy(delta int64) (abort error)

DefaultWaitStrategy is the standard backoff algorithm, but you can plug in another one

func WaitForHeight Uses

func WaitForHeight(c StatusClient, h int64, waiter Waiter) error

Wait for height will poll status at reasonable intervals until the block at the given height is available.

If waiter is nil, we use DefaultWaitStrategy, but you can also provide your own implementation

func WaitForOneEvent Uses

func WaitForOneEvent(c EventsClient, evtTyp string, timeout time.Duration) (types.TMEventData, error)

WaitForOneEvent subscribes to a websocket event for the given event time and returns upon receiving it one time, or when the timeout duration has expired.

This handles subscribing and unsubscribing under the hood

type ABCIClient Uses

type ABCIClient interface {
    // Reading from abci app
    ABCIInfo() (*ctypes.ResultABCIInfo, error)
    ABCIQuery(path string, data cmn.HexBytes) (*ctypes.ResultABCIQuery, error)
    ABCIQueryWithOptions(path string, data cmn.HexBytes,
        opts ABCIQueryOptions) (*ctypes.ResultABCIQuery, error)

    // Writing to abci app
    BroadcastTxCommit(tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error)
    BroadcastTxAsync(tx types.Tx) (*ctypes.ResultBroadcastTx, error)
    BroadcastTxSync(tx types.Tx) (*ctypes.ResultBroadcastTx, error)
}

ABCIClient groups together the functionality that principally affects the ABCI app. In many cases this will be all we want, so we can accept an interface which is easier to mock

type ABCIQueryOptions Uses

type ABCIQueryOptions struct {
    Height int64
    Prove  bool
}

ABCIQueryOptions can be used to provide options for ABCIQuery call other than the DefaultABCIQueryOptions.

type Client Uses

type Client interface {
    cmn.Service
    ABCIClient
    EventsClient
    HistoryClient
    NetworkClient
    SignClient
    StatusClient
}

Client wraps most important rpc calls a client would make if you want to listen for events, test if it also implements events.EventSwitch

type EventsClient Uses

type EventsClient interface {
    // Subscribe subscribes given subscriber to query. Returns a channel with
    // cap=1 onto which events are published. An error is returned if it fails to
    // subscribe. outCapacity can be used optionally to set capacity for the
    // channel. Channel is never closed to prevent accidental reads.
    //
    // ctx cannot be used to unsubscribe. To unsubscribe, use either Unsubscribe
    // or UnsubscribeAll.
    Subscribe(ctx context.Context, subscriber, query string, outCapacity ...int) (out <-chan ctypes.ResultEvent, err error)
    // Unsubscribe unsubscribes given subscriber from query.
    Unsubscribe(ctx context.Context, subscriber, query string) error
    // UnsubscribeAll unsubscribes given subscriber from all the queries.
    UnsubscribeAll(ctx context.Context, subscriber string) error
}

EventsClient is reactive, you can subscribe to any message, given the proper string. see tendermint/types/events.go

type HTTP Uses

type HTTP struct {
    *WSEvents
    // contains filtered or unexported fields
}

HTTP is a Client implementation that communicates with a tendermint 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 tendermint 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 Tendermint using Subscribe method. Note delivery is best-effort. If you don't read events fast enough or network is slow, Tendermint 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.

func NewHTTP Uses

func NewHTTP(remote, wsEndpoint string) *HTTP

NewHTTP takes a remote endpoint in the form tcp://<host>:<port> and the websocket path (which always seems to be "/websocket")

func (*HTTP) ABCIInfo Uses

func (c *HTTP) ABCIInfo() (*ctypes.ResultABCIInfo, error)

func (*HTTP) ABCIQuery Uses

func (c *HTTP) ABCIQuery(path string, data cmn.HexBytes) (*ctypes.ResultABCIQuery, error)

func (*HTTP) ABCIQueryWithOptions Uses

func (c *HTTP) ABCIQueryWithOptions(path string, data cmn.HexBytes, opts ABCIQueryOptions) (*ctypes.ResultABCIQuery, error)

func (*HTTP) Block Uses

func (c *HTTP) Block(height *int64) (*ctypes.ResultBlock, error)

func (*HTTP) BlockResults Uses

func (c *HTTP) BlockResults(height *int64) (*ctypes.ResultBlockResults, error)

func (*HTTP) BlockchainInfo Uses

func (c *HTTP) BlockchainInfo(minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error)

func (*HTTP) BroadcastTxAsync Uses

func (c *HTTP) BroadcastTxAsync(tx types.Tx) (*ctypes.ResultBroadcastTx, error)

func (*HTTP) BroadcastTxCommit Uses

func (c *HTTP) BroadcastTxCommit(tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error)

func (*HTTP) BroadcastTxSync Uses

func (c *HTTP) BroadcastTxSync(tx types.Tx) (*ctypes.ResultBroadcastTx, error)

func (*HTTP) Commit Uses

func (c *HTTP) Commit(height *int64) (*ctypes.ResultCommit, error)

func (*HTTP) ConsensusState Uses

func (c *HTTP) ConsensusState() (*ctypes.ResultConsensusState, error)

func (*HTTP) DumpConsensusState Uses

func (c *HTTP) DumpConsensusState() (*ctypes.ResultDumpConsensusState, error)

func (*HTTP) Genesis Uses

func (c *HTTP) Genesis() (*ctypes.ResultGenesis, error)

func (*HTTP) Health Uses

func (c *HTTP) Health() (*ctypes.ResultHealth, error)

func (*HTTP) NetInfo Uses

func (c *HTTP) NetInfo() (*ctypes.ResultNetInfo, error)

func (*HTTP) NumUnconfirmedTxs Uses

func (c *HTTP) NumUnconfirmedTxs() (*ctypes.ResultUnconfirmedTxs, error)

func (*HTTP) Status Uses

func (c *HTTP) Status() (*ctypes.ResultStatus, error)

func (*HTTP) Tx Uses

func (c *HTTP) Tx(hash []byte, prove bool) (*ctypes.ResultTx, error)

func (*HTTP) TxSearch Uses

func (c *HTTP) TxSearch(query string, prove bool, page, perPage int) (*ctypes.ResultTxSearch, error)

func (*HTTP) UnconfirmedTxs Uses

func (c *HTTP) UnconfirmedTxs(limit int) (*ctypes.ResultUnconfirmedTxs, error)

func (*HTTP) Validators Uses

func (c *HTTP) Validators(height *int64) (*ctypes.ResultValidators, error)

type HistoryClient Uses

type HistoryClient interface {
    Genesis() (*ctypes.ResultGenesis, error)
    BlockchainInfo(minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error)
}

HistoryClient shows us data from genesis to now in large chunks.

type Local Uses

type Local struct {
    *types.EventBus
    Logger log.Logger
    // contains filtered or unexported fields
}

Local is a Client implementation that directly executes the rpc functions on a given node, without going through HTTP or GRPC.

This implementation is useful for:

* Running tests against a node in-process without the overhead of going through an http server * Communication between an ABCI app and Tendermint core when they are compiled in process.

For real clients, you probably want to use client.HTTP. For more powerful control during testing, you probably want the "client/mock" package.

You can subscribe for any event published by Tendermint using Subscribe method. Note delivery is best-effort. If you don't read events fast enough, Tendermint might cancel the subscription. The client will attempt to resubscribe (you don't need to do anything). It will keep trying indefinitely with exponential backoff (10ms -> 20ms -> 40ms) until successful.

func NewLocal Uses

func NewLocal(node *nm.Node) *Local

NewLocal configures a client that calls the Node directly.

Note that given how rpc/core works with package singletons, that you can only have one node per process. So make sure test cases don't run in parallel, or try to simulate an entire network in one process...

func (*Local) ABCIInfo Uses

func (c *Local) ABCIInfo() (*ctypes.ResultABCIInfo, error)

func (*Local) ABCIQuery Uses

func (c *Local) ABCIQuery(path string, data cmn.HexBytes) (*ctypes.ResultABCIQuery, error)

func (*Local) ABCIQueryWithOptions Uses

func (c *Local) ABCIQueryWithOptions(path string, data cmn.HexBytes, opts ABCIQueryOptions) (*ctypes.ResultABCIQuery, error)

func (*Local) Block Uses

func (c *Local) Block(height *int64) (*ctypes.ResultBlock, error)

func (*Local) BlockResults Uses

func (c *Local) BlockResults(height *int64) (*ctypes.ResultBlockResults, error)

func (*Local) BlockchainInfo Uses

func (c *Local) BlockchainInfo(minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error)

func (*Local) BroadcastTxAsync Uses

func (c *Local) BroadcastTxAsync(tx types.Tx) (*ctypes.ResultBroadcastTx, error)

func (*Local) BroadcastTxCommit Uses

func (c *Local) BroadcastTxCommit(tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error)

func (*Local) BroadcastTxSync Uses

func (c *Local) BroadcastTxSync(tx types.Tx) (*ctypes.ResultBroadcastTx, error)

func (*Local) Commit Uses

func (c *Local) Commit(height *int64) (*ctypes.ResultCommit, error)

func (*Local) ConsensusState Uses

func (c *Local) ConsensusState() (*ctypes.ResultConsensusState, error)

func (*Local) DialPeers Uses

func (c *Local) DialPeers(peers []string, persistent bool) (*ctypes.ResultDialPeers, error)

func (*Local) DialSeeds Uses

func (c *Local) DialSeeds(seeds []string) (*ctypes.ResultDialSeeds, error)

func (*Local) DumpConsensusState Uses

func (c *Local) DumpConsensusState() (*ctypes.ResultDumpConsensusState, error)

func (*Local) Genesis Uses

func (c *Local) Genesis() (*ctypes.ResultGenesis, error)

func (*Local) Health Uses

func (c *Local) Health() (*ctypes.ResultHealth, error)

func (*Local) NetInfo Uses

func (c *Local) NetInfo() (*ctypes.ResultNetInfo, error)

func (*Local) NumUnconfirmedTxs Uses

func (c *Local) NumUnconfirmedTxs() (*ctypes.ResultUnconfirmedTxs, error)

func (*Local) SetLogger Uses

func (c *Local) SetLogger(l log.Logger)

SetLogger allows to set a logger on the client.

func (*Local) Status Uses

func (c *Local) Status() (*ctypes.ResultStatus, error)

func (*Local) Subscribe Uses

func (c *Local) Subscribe(ctx context.Context, subscriber, query string, outCapacity ...int) (out <-chan ctypes.ResultEvent, err error)

func (*Local) Tx Uses

func (c *Local) Tx(hash []byte, prove bool) (*ctypes.ResultTx, error)

func (*Local) TxSearch Uses

func (c *Local) TxSearch(query string, prove bool, page, perPage int) (*ctypes.ResultTxSearch, error)

func (*Local) UnconfirmedTxs Uses

func (c *Local) UnconfirmedTxs(limit int) (*ctypes.ResultUnconfirmedTxs, error)

func (*Local) Unsubscribe Uses

func (c *Local) Unsubscribe(ctx context.Context, subscriber, query string) error

func (*Local) UnsubscribeAll Uses

func (c *Local) UnsubscribeAll(ctx context.Context, subscriber string) error

func (*Local) Validators Uses

func (c *Local) Validators(height *int64) (*ctypes.ResultValidators, error)

type MempoolClient Uses

type MempoolClient interface {
    UnconfirmedTxs(limit int) (*ctypes.ResultUnconfirmedTxs, error)
    NumUnconfirmedTxs() (*ctypes.ResultUnconfirmedTxs, error)
}

MempoolClient shows us data about current mempool state.

type NetworkClient Uses

type NetworkClient interface {
    NetInfo() (*ctypes.ResultNetInfo, error)
    DumpConsensusState() (*ctypes.ResultDumpConsensusState, error)
    ConsensusState() (*ctypes.ResultConsensusState, error)
    Health() (*ctypes.ResultHealth, error)
}

NetworkClient is general info about the network state. May not be needed usually.

type SignClient Uses

type SignClient interface {
    Block(height *int64) (*ctypes.ResultBlock, error)
    BlockResults(height *int64) (*ctypes.ResultBlockResults, error)
    Commit(height *int64) (*ctypes.ResultCommit, error)
    Validators(height *int64) (*ctypes.ResultValidators, error)
    Tx(hash []byte, prove bool) (*ctypes.ResultTx, error)
    TxSearch(query string, prove bool, page, perPage int) (*ctypes.ResultTxSearch, error)
}

SignClient groups together the interfaces need to get valid signatures and prove anything about the chain

type StatusClient Uses

type StatusClient interface {
    // General chain info
    Status() (*ctypes.ResultStatus, error)
}

type WSEvents Uses

type WSEvents struct {
    cmn.BaseService
    // contains filtered or unexported fields
}

func (*WSEvents) OnStart Uses

func (w *WSEvents) OnStart() error

OnStart implements cmn.Service by starting WSClient and event loop.

func (*WSEvents) OnStop Uses

func (w *WSEvents) OnStop()

OnStop implements cmn.Service by stopping WSClient.

func (*WSEvents) Subscribe Uses

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 erroneus event.

func (*WSEvents) Unsubscribe Uses

func (w *WSEvents) Unsubscribe(ctx context.Context, subscriber, query string) error

Unsubscribe implements EventsClient by using WSClient to unsubscribe given subscriber from query.

func (*WSEvents) UnsubscribeAll Uses

func (w *WSEvents) UnsubscribeAll(ctx context.Context, subscriber string) error

UnsubscribeAll implements EventsClient by using WSClient to unsubscribe given subscriber from all the queries.

type Waiter Uses

type Waiter func(delta int64) (abort error)

Waiter is informed of current height, decided whether to quit early

Directories

PathSynopsis
mock

Package client imports 16 packages (graph) and is imported by 57 packages. Updated 2019-04-17. Refresh now. Tools for package owners.