You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
79 lines
2.6 KiB
79 lines
2.6 KiB
/*
|
|
package client provides a general purpose interface for connecting
|
|
to a tendermint node, as well as higher-level functionality.
|
|
|
|
The main implementation for production code is http, which connects
|
|
via http to the jsonrpc interface of the tendermint node.
|
|
|
|
For connecting to a node running in the same process (eg. when
|
|
compiling the abci app in the same process), you can use the local
|
|
implementation.
|
|
|
|
For mocking out server responses during testing to see behavior for
|
|
arbitrary return values, use the mock package.
|
|
|
|
In addition to the Client interface, which should be used externally
|
|
for maximum flexibility and testability, this package also provides
|
|
a wrapper that accepts any Client implementation and adds some
|
|
higher-level functionality.
|
|
*/
|
|
package client
|
|
|
|
import (
|
|
ctypes "github.com/tendermint/tendermint/rpc/core/types"
|
|
"github.com/tendermint/tendermint/types"
|
|
)
|
|
|
|
// 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 ABCIClient interface {
|
|
// reading from abci app
|
|
ABCIInfo() (*ctypes.ResultABCIInfo, error)
|
|
ABCIQuery(path string, data []byte, prove bool) (*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)
|
|
}
|
|
|
|
// SignClient groups together the interfaces need to get valid
|
|
// signatures and prove anything about the chain
|
|
type SignClient interface {
|
|
Block(height int) (*ctypes.ResultBlock, error)
|
|
Commit(height int) (*ctypes.ResultCommit, error)
|
|
Validators() (*ctypes.ResultValidators, error)
|
|
}
|
|
|
|
// NetworkClient is general info about the network state. May not
|
|
// be needed usually.
|
|
//
|
|
// Not included in the Client interface, but generally implemented
|
|
// by concrete implementations.
|
|
type NetworkClient interface {
|
|
NetInfo() (*ctypes.ResultNetInfo, error)
|
|
// remove this???
|
|
DialSeeds(seeds []string) (*ctypes.ResultDialSeeds, error)
|
|
}
|
|
|
|
// HistoryClient shows us data from genesis to now in large chunks.
|
|
type HistoryClient interface {
|
|
Genesis() (*ctypes.ResultGenesis, error)
|
|
BlockchainInfo(minHeight, maxHeight int) (*ctypes.ResultBlockchainInfo, error)
|
|
}
|
|
|
|
type StatusClient interface {
|
|
// general chain info
|
|
Status() (*ctypes.ResultStatus, error)
|
|
}
|
|
|
|
type Client interface {
|
|
ABCIClient
|
|
SignClient
|
|
HistoryClient
|
|
StatusClient
|
|
// Note: doesn't include NetworkClient, is it important??
|
|
|
|
// TODO: add some sort of generic subscription mechanism...
|
|
}
|