mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-09-26 18:04:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

rpc: remove global environment (#6426)

Browse Source
This commit is contained in:
Sam Kleinman
2022-11-01 16:37:26 -04:00
committed by William Banfield
parent c8f9f061fd
commit d02ea4e07a
21 changed files with 231 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files
node/node.go
+20 -18
View File
@@ -497,12 +497,8 @@ func (n *Node) OnStop() {
} }
// ConfigureRPC makes sure RPC has all the objects it needs to operate. // ConfigureRPC makes sure RPC has all the objects it needs to operate.
func (n *Node) ConfigureRPC() error { func (n *Node) ConfigureRPC() (*rpccore.Environment, error) {
pubKey, err := n.privValidator.GetPubKey() rpcCoreEnv := rpccore.Environment{
if err != nil {
return fmt.Errorf("can't get pubkey: %w", err)
}
rpccore.SetEnvironment(&rpccore.Environment{
ProxyAppQuery: n.proxyApp.Query(), ProxyAppQuery: n.proxyApp.Query(),
ProxyAppMempool: n.proxyApp.Mempool(), ProxyAppMempool: n.proxyApp.Mempool(),
@@ -513,7 +509,6 @@ func (n *Node) ConfigureRPC() error {
P2PPeers: n.sw, P2PPeers: n.sw,
P2PTransport: n, P2PTransport: n,
PubKey: pubKey,
GenDoc: n.genesisDoc, GenDoc: n.genesisDoc,
TxIndexer: n.txIndexer, TxIndexer: n.txIndexer,
BlockIndexer: n.blockIndexer, BlockIndexer: n.blockIndexer,
@@ -524,24 +519,31 @@ func (n *Node) ConfigureRPC() error {
Logger: n.Logger.With("module", "rpc"), Logger: n.Logger.With("module", "rpc"),
Config: *n.config.RPC, Config: *n.config.RPC,
})
if err := rpccore.InitGenesisChunks(); err != nil {
return err
} }
if err := rpccore.InitGenesisChunks(); err != nil {
return nil return nil, err
}
if n.config.Mode == cfg.ModeValidator {
pubKey, err := n.privValidator.GetPubKey()
if pubKey == nil || err != nil {
return nil, fmt.Errorf("can't get pubkey: %w", err)
}
rpcCoreEnv.PubKey = pubKey
}
return &rpcCoreEnv, nil
} }
func (n *Node) startRPC() ([]net.Listener, error) { func (n *Node) startRPC() ([]net.Listener, error) {
err := n.ConfigureRPC() env, err := n.ConfigureRPC()
if err != nil { if err != nil {
return nil, err return nil, err
} }
listenAddrs := splitAndTrimEmpty(n.config.RPC.ListenAddress, ",", " ") listenAddrs := strings.SplitAndTrimEmpty(n.config.RPC.ListenAddress, ",", " ")
routes := env.GetRoutes()
if n.config.RPC.Unsafe { if n.config.RPC.Unsafe {
rpccore.AddUnsafeRoutes() env.AddUnsafe(routes)
} }
config := rpcserver.DefaultConfig() config := rpcserver.DefaultConfig()
@@ -561,7 +563,7 @@ func (n *Node) startRPC() ([]net.Listener, error) {
mux := http.NewServeMux() mux := http.NewServeMux()
rpcLogger := n.Logger.With("module", "rpc-server") rpcLogger := n.Logger.With("module", "rpc-server")
wmLogger := rpcLogger.With("protocol", "websocket") wmLogger := rpcLogger.With("protocol", "websocket")
wm := rpcserver.NewWebsocketManager(rpccore.Routes, wm := rpcserver.NewWebsocketManager(routes,
rpcserver.OnDisconnect(func(remoteAddr string) { rpcserver.OnDisconnect(func(remoteAddr string) {
err := n.eventBus.UnsubscribeAll(context.Background(), remoteAddr) err := n.eventBus.UnsubscribeAll(context.Background(), remoteAddr)
if err != nil && err != tmpubsub.ErrSubscriptionNotFound { if err != nil && err != tmpubsub.ErrSubscriptionNotFound {
@@ -573,7 +575,7 @@ func (n *Node) startRPC() ([]net.Listener, error) {
) )
wm.SetLogger(wmLogger) wm.SetLogger(wmLogger)
mux.HandleFunc("/websocket", wm.WebsocketHandler) mux.HandleFunc("/websocket", wm.WebsocketHandler)
rpcserver.RegisterRPCFuncs(mux, rpccore.Routes, rpcLogger) rpcserver.RegisterRPCFuncs(mux, routes, rpcLogger)
listener, err := rpcserver.Listen( listener, err := rpcserver.Listen(
listenAddr, listenAddr,
config, config,
@@ -639,7 +641,7 @@ func (n *Node) startRPC() ([]net.Listener, error) {
return nil, err return nil, err
} }
go func() { go func() {
if err := grpccore.StartGRPCServer(listener); err != nil { if err := grpccore.StartGRPCServer(env, listener); err != nil {
n.Logger.Error("Error starting gRPC server", "err", err) n.Logger.Error("Error starting gRPC server", "err", err)
} }
}() }()
rpc/client/local/local.go
+31 -33
View File
@@ -41,22 +41,20 @@ type Local struct {
*types.EventBus *types.EventBus
Logger log.Logger Logger log.Logger
ctx *rpctypes.Context ctx *rpctypes.Context
env *core.Environment
} }
// NewLocal configures a client that calls the Node directly. // 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 New(node *nm.Node) *Local { func New(node *nm.Node) *Local {
if err := node.ConfigureRPC(); err != nil { env, err := node.ConfigureRPC()
if err != nil {
node.Logger.Error("Error configuring RPC", "err", err) node.Logger.Error("Error configuring RPC", "err", err)
} }
return &Local{ return &Local{
EventBus: node.EventBus(), EventBus: node.EventBus(),
Logger: log.NewNopLogger(), Logger: log.NewNopLogger(),
ctx: &rpctypes.Context{}, ctx: &rpctypes.Context{},
env: env,
} }
} }
@@ -68,11 +66,11 @@ func (c *Local) SetLogger(l log.Logger) {
} }
func (c *Local) Status(ctx context.Context) (*ctypes.ResultStatus, error) { func (c *Local) Status(ctx context.Context) (*ctypes.ResultStatus, error) {
return core.Status(c.ctx) return c.env.Status(c.ctx)
} }
func (c *Local) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error) { func (c *Local) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error) {
return core.ABCIInfo(c.ctx) return c.env.ABCIInfo(c.ctx)
} }
func (c *Local) ABCIQuery(ctx context.Context, path string, data bytes.HexBytes) (*ctypes.ResultABCIQuery, error) { func (c *Local) ABCIQuery(ctx context.Context, path string, data bytes.HexBytes) (*ctypes.ResultABCIQuery, error) {
@@ -84,55 +82,55 @@ func (c *Local) ABCIQueryWithOptions(
path string, path string,
data bytes.HexBytes, data bytes.HexBytes,
opts rpcclient.ABCIQueryOptions) (*ctypes.ResultABCIQuery, error) { opts rpcclient.ABCIQueryOptions) (*ctypes.ResultABCIQuery, error) {
return core.ABCIQuery(c.ctx, path, data, opts.Height, opts.Prove) return c.env.ABCIQuery(c.ctx, path, data, opts.Height, opts.Prove)
} }
func (c *Local) BroadcastTxCommit(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error) { func (c *Local) BroadcastTxCommit(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error) {
return core.BroadcastTxCommit(c.ctx, tx) return c.env.BroadcastTxCommit(c.ctx, tx)
} }
func (c *Local) BroadcastTxAsync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) { func (c *Local) BroadcastTxAsync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) {
return core.BroadcastTxAsync(c.ctx, tx) return c.env.BroadcastTxAsync(c.ctx, tx)
} }
func (c *Local) BroadcastTxSync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) { func (c *Local) BroadcastTxSync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) {
return core.BroadcastTxSync(c.ctx, tx) return c.env.BroadcastTxSync(c.ctx, tx)
} }
func (c *Local) UnconfirmedTxs(ctx context.Context, limit *int) (*ctypes.ResultUnconfirmedTxs, error) { func (c *Local) UnconfirmedTxs(ctx context.Context, limit *int) (*ctypes.ResultUnconfirmedTxs, error) {
return core.UnconfirmedTxs(c.ctx, limit) return c.env.UnconfirmedTxs(c.ctx, limit)
} }
func (c *Local) NumUnconfirmedTxs(ctx context.Context) (*ctypes.ResultUnconfirmedTxs, error) { func (c *Local) NumUnconfirmedTxs(ctx context.Context) (*ctypes.ResultUnconfirmedTxs, error) {
return core.NumUnconfirmedTxs(c.ctx) return c.env.NumUnconfirmedTxs(c.ctx)
} }
func (c *Local) CheckTx(ctx context.Context, tx types.Tx) (*ctypes.ResultCheckTx, error) { func (c *Local) CheckTx(ctx context.Context, tx types.Tx) (*ctypes.ResultCheckTx, error) {
return core.CheckTx(c.ctx, tx) return c.env.CheckTx(c.ctx, tx)
} }
func (c *Local) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error) { func (c *Local) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error) {
return core.NetInfo(c.ctx) return c.env.NetInfo(c.ctx)
} }
func (c *Local) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error) { func (c *Local) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error) {
return core.DumpConsensusState(c.ctx) return c.env.DumpConsensusState(c.ctx)
} }
func (c *Local) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error) { func (c *Local) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error) {
return core.ConsensusState(c.ctx) return c.env.GetConsensusState(c.ctx)
} }
func (c *Local) ConsensusParams(ctx context.Context, height *int64) (*ctypes.ResultConsensusParams, error) { func (c *Local) ConsensusParams(ctx context.Context, height *int64) (*ctypes.ResultConsensusParams, error) {
return core.ConsensusParams(c.ctx, height) return c.env.ConsensusParams(c.ctx, height)
} }
func (c *Local) Health(ctx context.Context) (*ctypes.ResultHealth, error) { func (c *Local) Health(ctx context.Context) (*ctypes.ResultHealth, error) {
return core.Health(c.ctx) return c.env.Health(c.ctx)
} }
func (c *Local) DialSeeds(ctx context.Context, seeds []string) (*ctypes.ResultDialSeeds, error) { func (c *Local) DialSeeds(ctx context.Context, seeds []string) (*ctypes.ResultDialSeeds, error) {
return core.UnsafeDialSeeds(c.ctx, seeds) return c.env.UnsafeDialSeeds(c.ctx, seeds)
} }
func (c *Local) DialPeers( func (c *Local) DialPeers(
@@ -142,15 +140,15 @@ func (c *Local) DialPeers(
unconditional, unconditional,
private bool, private bool,
) (*ctypes.ResultDialPeers, error) { ) (*ctypes.ResultDialPeers, error) {
return core.UnsafeDialPeers(c.ctx, peers, persistent, unconditional, private) return c.env.UnsafeDialPeers(c.ctx, peers, persistent, unconditional, private)
} }
func (c *Local) BlockchainInfo(ctx context.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error) { func (c *Local) BlockchainInfo(ctx context.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error) {
return core.BlockchainInfo(c.ctx, minHeight, maxHeight) return c.env.BlockchainInfo(c.ctx, minHeight, maxHeight)
} }
func (c *Local) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error) { func (c *Local) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error) {
return core.Genesis(c.ctx) return c.env.Genesis(c.ctx)
} }
func (c *Local) GenesisChunked(ctx context.Context, id uint) (*ctypes.ResultGenesisChunk, error) { func (c *Local) GenesisChunked(ctx context.Context, id uint) (*ctypes.ResultGenesisChunk, error) {
@@ -158,15 +156,15 @@ func (c *Local) GenesisChunked(ctx context.Context, id uint) (*ctypes.ResultGene
} }
func (c *Local) Block(ctx context.Context, height *int64) (*ctypes.ResultBlock, error) { func (c *Local) Block(ctx context.Context, height *int64) (*ctypes.ResultBlock, error) {
return core.Block(c.ctx, height) return c.env.Block(c.ctx, height)
} }
func (c *Local) BlockByHash(ctx context.Context, hash []byte) (*ctypes.ResultBlock, error) { func (c *Local) BlockByHash(ctx context.Context, hash []byte) (*ctypes.ResultBlock, error) {
return core.BlockByHash(c.ctx, hash) return c.env.BlockByHash(c.ctx, hash)
} }
func (c *Local) BlockResults(ctx context.Context, height *int64) (*ctypes.ResultBlockResults, error) { func (c *Local) BlockResults(ctx context.Context, height *int64) (*ctypes.ResultBlockResults, error) {
return core.BlockResults(c.ctx, height) return c.env.BlockResults(c.ctx, height)
} }
func (c *Local) Header(ctx context.Context, height *int64) (*ctypes.ResultHeader, error) { func (c *Local) Header(ctx context.Context, height *int64) (*ctypes.ResultHeader, error) {
@@ -178,15 +176,15 @@ func (c *Local) HeaderByHash(ctx context.Context, hash bytes.HexBytes) (*ctypes.
} }
func (c *Local) Commit(ctx context.Context, height *int64) (*ctypes.ResultCommit, error) { func (c *Local) Commit(ctx context.Context, height *int64) (*ctypes.ResultCommit, error) {
return core.Commit(c.ctx, height) return c.env.Commit(c.ctx, height)
} }
func (c *Local) Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error) { func (c *Local) Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error) {
return core.Validators(c.ctx, height, page, perPage) return c.env.Validators(c.ctx, height, page, perPage)
} }
func (c *Local) Tx(ctx context.Context, hash []byte, prove bool) (*ctypes.ResultTx, error) { func (c *Local) Tx(ctx context.Context, hash []byte, prove bool) (*ctypes.ResultTx, error) {
return core.Tx(c.ctx, hash, prove) return c.env.Tx(c.ctx, hash, prove)
} }
func (c *Local) TxSearch( func (c *Local) TxSearch(
@@ -197,7 +195,7 @@ func (c *Local) TxSearch(
perPage *int, perPage *int,
orderBy string, orderBy string,
) (*ctypes.ResultTxSearch, error) { ) (*ctypes.ResultTxSearch, error) {
return core.TxSearch(c.ctx, query, prove, page, perPage, orderBy) return c.env.TxSearch(c.ctx, query, prove, page, perPage, orderBy)
} }
func (c *Local) BlockSearch( func (c *Local) BlockSearch(
@@ -206,11 +204,11 @@ func (c *Local) BlockSearch(
page, perPage *int, page, perPage *int,
orderBy string, orderBy string,
) (*ctypes.ResultBlockSearch, error) { ) (*ctypes.ResultBlockSearch, error) {
return core.BlockSearch(c.ctx, query, page, perPage, orderBy) return c.env.BlockSearch(c.ctx, query, page, perPage, orderBy)
} }
func (c *Local) BroadcastEvidence(ctx context.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) { func (c *Local) BroadcastEvidence(ctx context.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) {
return core.BroadcastEvidence(c.ctx, ev) return c.env.BroadcastEvidence(c.ctx, ev)
} }
func (c *Local) Subscribe( func (c *Local) Subscribe(
rpc/client/mock/client.go
+29 -25
View File
@@ -28,10 +28,6 @@ import (
) )
// Client wraps arbitrary implementations of the various interfaces. // Client wraps arbitrary implementations of the various interfaces.
//
// We provide a few choices to mock out each one in this package.
// Nothing hidden here, so no New function, just construct it from
// some parts, and swap them out them during the tests.
type Client struct { type Client struct {
client.ABCIClient client.ABCIClient
client.SignClient client.SignClient
@@ -41,6 +37,14 @@ type Client struct {
client.EvidenceClient client.EvidenceClient
client.MempoolClient client.MempoolClient
service.Service service.Service
env *core.Environment
}
func New() Client {
return Client{
env: &core.Environment{},
}
} }
var _ client.Client = Client{} var _ client.Client = Client{}
@@ -80,11 +84,11 @@ func (c Call) GetResponse(args interface{}) (interface{}, error) {
} }
func (c Client) Status(ctx context.Context) (*ctypes.ResultStatus, error) { func (c Client) Status(ctx context.Context) (*ctypes.ResultStatus, error) {
return core.Status(&rpctypes.Context{}) return c.env.Status(&rpctypes.Context{})
} }
func (c Client) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error) { func (c Client) ABCIInfo(ctx context.Context) (*ctypes.ResultABCIInfo, error) {
return core.ABCIInfo(&rpctypes.Context{}) return c.env.ABCIInfo(&rpctypes.Context{})
} }
func (c Client) ABCIQuery(ctx context.Context, path string, data bytes.HexBytes) (*ctypes.ResultABCIQuery, error) { func (c Client) ABCIQuery(ctx context.Context, path string, data bytes.HexBytes) (*ctypes.ResultABCIQuery, error) {
@@ -96,47 +100,47 @@ func (c Client) ABCIQueryWithOptions(
path string, path string,
data bytes.HexBytes, data bytes.HexBytes,
opts client.ABCIQueryOptions) (*ctypes.ResultABCIQuery, error) { opts client.ABCIQueryOptions) (*ctypes.ResultABCIQuery, error) {
return core.ABCIQuery(&rpctypes.Context{}, path, data, opts.Height, opts.Prove) return c.env.ABCIQuery(&rpctypes.Context{}, path, data, opts.Height, opts.Prove)
} }
func (c Client) BroadcastTxCommit(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error) { func (c Client) BroadcastTxCommit(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error) {
return core.BroadcastTxCommit(&rpctypes.Context{}, tx) return c.env.BroadcastTxCommit(&rpctypes.Context{}, tx)
} }
func (c Client) BroadcastTxAsync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) { func (c Client) BroadcastTxAsync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) {
return core.BroadcastTxAsync(&rpctypes.Context{}, tx) return c.env.BroadcastTxAsync(&rpctypes.Context{}, tx)
} }
func (c Client) BroadcastTxSync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) { func (c Client) BroadcastTxSync(ctx context.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) {
return core.BroadcastTxSync(&rpctypes.Context{}, tx) return c.env.BroadcastTxSync(&rpctypes.Context{}, tx)
} }
func (c Client) CheckTx(ctx context.Context, tx types.Tx) (*ctypes.ResultCheckTx, error) { func (c Client) CheckTx(ctx context.Context, tx types.Tx) (*ctypes.ResultCheckTx, error) {
return core.CheckTx(&rpctypes.Context{}, tx) return c.env.CheckTx(&rpctypes.Context{}, tx)
} }
func (c Client) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error) { func (c Client) NetInfo(ctx context.Context) (*ctypes.ResultNetInfo, error) {
return core.NetInfo(&rpctypes.Context{}) return c.env.NetInfo(&rpctypes.Context{})
} }
func (c Client) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error) { func (c Client) ConsensusState(ctx context.Context) (*ctypes.ResultConsensusState, error) {
return core.ConsensusState(&rpctypes.Context{}) return c.env.GetConsensusState(&rpctypes.Context{})
} }
func (c Client) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error) { func (c Client) DumpConsensusState(ctx context.Context) (*ctypes.ResultDumpConsensusState, error) {
return core.DumpConsensusState(&rpctypes.Context{}) return c.env.DumpConsensusState(&rpctypes.Context{})
} }
func (c Client) ConsensusParams(ctx context.Context, height *int64) (*ctypes.ResultConsensusParams, error) { func (c Client) ConsensusParams(ctx context.Context, height *int64) (*ctypes.ResultConsensusParams, error) {
return core.ConsensusParams(&rpctypes.Context{}, height) return c.env.ConsensusParams(&rpctypes.Context{}, height)
} }
func (c Client) Health(ctx context.Context) (*ctypes.ResultHealth, error) { func (c Client) Health(ctx context.Context) (*ctypes.ResultHealth, error) {
return core.Health(&rpctypes.Context{}) return c.env.Health(&rpctypes.Context{})
} }
func (c Client) DialSeeds(ctx context.Context, seeds []string) (*ctypes.ResultDialSeeds, error) { func (c Client) DialSeeds(ctx context.Context, seeds []string) (*ctypes.ResultDialSeeds, error) {
return core.UnsafeDialSeeds(&rpctypes.Context{}, seeds) return c.env.UnsafeDialSeeds(&rpctypes.Context{}, seeds)
} }
func (c Client) DialPeers( func (c Client) DialPeers(
@@ -146,33 +150,33 @@ func (c Client) DialPeers(
unconditional, unconditional,
private bool, private bool,
) (*ctypes.ResultDialPeers, error) { ) (*ctypes.ResultDialPeers, error) {
return core.UnsafeDialPeers(&rpctypes.Context{}, peers, persistent, unconditional, private) return c.env.UnsafeDialPeers(&rpctypes.Context{}, peers, persistent, unconditional, private)
} }
func (c Client) BlockchainInfo(ctx context.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error) { func (c Client) BlockchainInfo(ctx context.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error) {
return core.BlockchainInfo(&rpctypes.Context{}, minHeight, maxHeight) return c.env.BlockchainInfo(&rpctypes.Context{}, minHeight, maxHeight)
} }
func (c Client) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error) { func (c Client) Genesis(ctx context.Context) (*ctypes.ResultGenesis, error) {
return core.Genesis(&rpctypes.Context{}) return c.env.Genesis(&rpctypes.Context{})
} }
func (c Client) Block(ctx context.Context, height *int64) (*ctypes.ResultBlock, error) { func (c Client) Block(ctx context.Context, height *int64) (*ctypes.ResultBlock, error) {
return core.Block(&rpctypes.Context{}, height) return c.env.Block(&rpctypes.Context{}, height)
} }
func (c Client) BlockByHash(ctx context.Context, hash []byte) (*ctypes.ResultBlock, error) { func (c Client) BlockByHash(ctx context.Context, hash []byte) (*ctypes.ResultBlock, error) {
return core.BlockByHash(&rpctypes.Context{}, hash) return c.env.BlockByHash(&rpctypes.Context{}, hash)
} }
func (c Client) Commit(ctx context.Context, height *int64) (*ctypes.ResultCommit, error) { func (c Client) Commit(ctx context.Context, height *int64) (*ctypes.ResultCommit, error) {
return core.Commit(&rpctypes.Context{}, height) return c.env.Commit(&rpctypes.Context{}, height)
} }
func (c Client) Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error) { func (c Client) Validators(ctx context.Context, height *int64, page, perPage *int) (*ctypes.ResultValidators, error) {
return core.Validators(&rpctypes.Context{}, height, page, perPage) return c.env.Validators(&rpctypes.Context{}, height, page, perPage)
} }
func (c Client) BroadcastEvidence(ctx context.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) { func (c Client) BroadcastEvidence(ctx context.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) {
return core.BroadcastEvidence(&rpctypes.Context{}, ev) return c.env.BroadcastEvidence(&rpctypes.Context{}, ev)
} }
rpc/core/abci.go
+4 -4
View File
@@ -9,8 +9,8 @@ import (
) )
// ABCIQuery queries the application for some information. // ABCIQuery queries the application for some information.
// More: https://docs.tendermint.com/main/rpc/#/ABCI/abci_query // More: https://docs.tendermint.com/master/rpc/#/ABCI/abci_query
func ABCIQuery( func (env *Environment) ABCIQuery(
ctx *rpctypes.Context, ctx *rpctypes.Context,
path string, path string,
data bytes.HexBytes, data bytes.HexBytes,
@@ -31,8 +31,8 @@ func ABCIQuery(
} }
// ABCIInfo gets some info about the application. // ABCIInfo gets some info about the application.
// More: https://docs.tendermint.com/main/rpc/#/ABCI/abci_info // More: https://docs.tendermint.com/master/rpc/#/ABCI/abci_info
func ABCIInfo(ctx *rpctypes.Context) (*ctypes.ResultABCIInfo, error) { func (env *Environment) ABCIInfo(ctx *rpctypes.Context) (*ctypes.ResultABCIInfo, error) {
resInfo, err := env.ProxyAppQuery.InfoSync(proxy.RequestInfo) resInfo, err := env.ProxyAppQuery.InfoSync(proxy.RequestInfo)
if err != nil { if err != nil {
return nil, err return nil, err
rpc/core/blocks.go
+26 -17
View File
@@ -15,10 +15,19 @@ import (
) )
// BlockchainInfo gets block headers for minHeight <= height <= maxHeight. // BlockchainInfo gets block headers for minHeight <= height <= maxHeight.
// Block headers are returned in descending order (highest first). //
// More: https://docs.tendermint.com/main/rpc/#/Info/blockchain // If maxHeight does not yet exist, blocks up to the current height will be
func BlockchainInfo(ctx *rpctypes.Context, minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error) { // returned. If minHeight does not exist (due to pruning), earliest existing
// maximum 20 block metas // height will be used.
//
// At most 20 items will be returned. Block headers are returned in descending
// order (highest first).
//
// More: https://docs.tendermint.com/master/rpc/#/Info/blockchain
func (env *Environment) BlockchainInfo(
ctx *rpctypes.Context,
minHeight, maxHeight int64) (*ctypes.ResultBlockchainInfo, error) {
const limit int64 = 20 const limit int64 = 20
var err error var err error
minHeight, maxHeight, err = filterMinMax( minHeight, maxHeight, err = filterMinMax(
@@ -110,9 +119,9 @@ func HeaderByHash(ctx *rpctypes.Context, hash bytes.HexBytes) (*ctypes.ResultHea
// Block gets block at a given height. // Block gets block at a given height.
// If no height is provided, it will fetch the latest block. // If no height is provided, it will fetch the latest block.
// More: https://docs.tendermint.com/main/rpc/#/Info/block // More: https://docs.tendermint.com/master/rpc/#/Info/block
func Block(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultBlock, error) { func (env *Environment) Block(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultBlock, error) {
height, err := getHeight(env.BlockStore.Height(), heightPtr) height, err := env.getHeight(env.BlockStore.Height(), heightPtr)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -126,8 +135,8 @@ func Block(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultBlock, error)
} }
// BlockByHash gets block by hash. // BlockByHash gets block by hash.
// More: https://docs.tendermint.com/main/rpc/#/Info/block_by_hash // More: https://docs.tendermint.com/master/rpc/#/Info/block_by_hash
func BlockByHash(ctx *rpctypes.Context, hash []byte) (*ctypes.ResultBlock, error) { func (env *Environment) BlockByHash(ctx *rpctypes.Context, hash []byte) (*ctypes.ResultBlock, error) {
block := env.BlockStore.LoadBlockByHash(hash) block := env.BlockStore.LoadBlockByHash(hash)
if block == nil { if block == nil {
return &ctypes.ResultBlock{BlockID: types.BlockID{}, Block: nil}, nil return &ctypes.ResultBlock{BlockID: types.BlockID{}, Block: nil}, nil
@@ -139,9 +148,9 @@ func BlockByHash(ctx *rpctypes.Context, hash []byte) (*ctypes.ResultBlock, error
// Commit gets block commit at a given height. // Commit gets block commit at a given height.
// If no height is provided, it will fetch the commit for the latest block. // If no height is provided, it will fetch the commit for the latest block.
// More: https://docs.tendermint.com/main/rpc/#/Info/commit // More: https://docs.tendermint.com/master/rpc/#/Info/commit
func Commit(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultCommit, error) { func (env *Environment) Commit(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultCommit, error) {
height, err := getHeight(env.BlockStore.Height(), heightPtr) height, err := env.getHeight(env.BlockStore.Height(), heightPtr)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -170,9 +179,9 @@ func Commit(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultCommit, erro
// Results are for the height of the block containing the txs. // Results are for the height of the block containing the txs.
// Thus response.results.deliver_tx[5] is the results of executing // Thus response.results.deliver_tx[5] is the results of executing
// getBlock(h).Txs[5] // getBlock(h).Txs[5]
// More: https://docs.tendermint.com/main/rpc/#/Info/block_results // More: https://docs.tendermint.com/master/rpc/#/Info/block_results
func BlockResults(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultBlockResults, error) { func (env *Environment) BlockResults(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultBlockResults, error) {
height, err := getHeight(env.BlockStore.Height(), heightPtr) height, err := env.getHeight(env.BlockStore.Height(), heightPtr)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -194,7 +203,7 @@ func BlockResults(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultBlockR
// BlockSearch searches for a paginated set of blocks matching BeginBlock and // BlockSearch searches for a paginated set of blocks matching BeginBlock and
// EndBlock event search criteria. // EndBlock event search criteria.
func BlockSearch( func (env *Environment) BlockSearch(
ctx *rpctypes.Context, ctx *rpctypes.Context,
query string, query string,
pagePtr, perPagePtr *int, pagePtr, perPagePtr *int,
@@ -230,7 +239,7 @@ func BlockSearch(
// paginate results // paginate results
totalCount := len(results) totalCount := len(results)
perPage := validatePerPage(perPagePtr) perPage := env.validatePerPage(perPagePtr)
page, err := validatePage(pagePtr, perPage, totalCount) page, err := validatePage(pagePtr, perPage, totalCount)
if err != nil { if err != nil {
rpc/core/blocks_test.go
+1 -1
View File
@@ -110,7 +110,7 @@ func TestBlockResults(t *testing.T) {
} }
for _, tc := range testCases { for _, tc := range testCases {
res, err := BlockResults(&rpctypes.Context{}, &tc.height) res, err := env.BlockResults(&rpctypes.Context{}, &tc.height)
if tc.wantErr { if tc.wantErr {
assert.Error(t, err) assert.Error(t, err)
} else { } else {
rpc/core/consensus.go
+18 -11
View File
@@ -14,10 +14,14 @@ import (
// validators are sorted by their voting power - this is the canonical order // validators are sorted by their voting power - this is the canonical order
// for the validators in the set as used in computing their Merkle root. // for the validators in the set as used in computing their Merkle root.
// //
// More: https://docs.tendermint.com/main/rpc/#/Info/validators // More: https://docs.tendermint.com/master/rpc/#/Info/validators
func Validators(ctx *rpctypes.Context, heightPtr *int64, pagePtr, perPagePtr *int) (*ctypes.ResultValidators, error) { func (env *Environment) Validators(
ctx *rpctypes.Context,
heightPtr *int64,
pagePtr, perPagePtr *int) (*ctypes.ResultValidators, error) {
// The latest validator that we know is the NextValidator of the last block. // The latest validator that we know is the NextValidator of the last block.
height, err := getHeight(latestUncommittedHeight(), heightPtr) height, err := env.getHeight(env.latestUncommittedHeight(), heightPtr)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -28,7 +32,7 @@ func Validators(ctx *rpctypes.Context, heightPtr *int64, pagePtr, perPagePtr *in
} }
totalCount := len(validators.Validators) totalCount := len(validators.Validators)
perPage := validatePerPage(perPagePtr) perPage := env.validatePerPage(perPagePtr)
page, err := validatePage(pagePtr, perPage, totalCount) page, err := validatePage(pagePtr, perPage, totalCount)
if err != nil { if err != nil {
return nil, err return nil, err
@@ -47,8 +51,8 @@ func Validators(ctx *rpctypes.Context, heightPtr *int64, pagePtr, perPagePtr *in
// DumpConsensusState dumps consensus state. // DumpConsensusState dumps consensus state.
// UNSTABLE // UNSTABLE
// More: https://docs.tendermint.com/main/rpc/#/Info/dump_consensus_state // More: https://docs.tendermint.com/master/rpc/#/Info/dump_consensus_state
func DumpConsensusState(ctx *rpctypes.Context) (*ctypes.ResultDumpConsensusState, error) { func (env *Environment) DumpConsensusState(ctx *rpctypes.Context) (*ctypes.ResultDumpConsensusState, error) {
// Get Peer consensus states. // Get Peer consensus states.
peers := env.P2PPeers.Peers().List() peers := env.P2PPeers.Peers().List()
peerStates := make([]ctypes.PeerStateInfo, len(peers)) peerStates := make([]ctypes.PeerStateInfo, len(peers))
@@ -80,8 +84,8 @@ func DumpConsensusState(ctx *rpctypes.Context) (*ctypes.ResultDumpConsensusState
// ConsensusState returns a concise summary of the consensus state. // ConsensusState returns a concise summary of the consensus state.
// UNSTABLE // UNSTABLE
// More: https://docs.tendermint.com/main/rpc/#/Info/consensus_state // More: https://docs.tendermint.com/master/rpc/#/Info/consensus_state
func ConsensusState(ctx *rpctypes.Context) (*ctypes.ResultConsensusState, error) { func (env *Environment) GetConsensusState(ctx *rpctypes.Context) (*ctypes.ResultConsensusState, error) {
// Get self round state. // Get self round state.
bz, err := env.ConsensusState.GetRoundStateSimpleJSON() bz, err := env.ConsensusState.GetRoundStateSimpleJSON()
return &ctypes.ResultConsensusState{RoundState: bz}, err return &ctypes.ResultConsensusState{RoundState: bz}, err
@@ -89,11 +93,14 @@ func ConsensusState(ctx *rpctypes.Context) (*ctypes.ResultConsensusState, error)
// ConsensusParams gets the consensus parameters at the given block height. // ConsensusParams gets the consensus parameters at the given block height.
// If no height is provided, it will fetch the latest consensus params. // If no height is provided, it will fetch the latest consensus params.
// More: https://docs.tendermint.com/main/rpc/#/Info/consensus_params // More: https://docs.tendermint.com/master/rpc/#/Info/consensus_params
func ConsensusParams(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultConsensusParams, error) { func (env *Environment) ConsensusParams(
ctx *rpctypes.Context,
heightPtr *int64) (*ctypes.ResultConsensusParams, error) {
// The latest consensus params that we know is the consensus params after the // The latest consensus params that we know is the consensus params after the
// last block. // last block.
height, err := getHeight(latestUncommittedHeight(), heightPtr) height, err := env.getHeight(env.latestUncommittedHeight(), heightPtr)
if err != nil { if err != nil {
return nil, err return nil, err
} }
rpc/core/dev.go
+1 -1
View File
@@ -6,7 +6,7 @@ import (
) )
// UnsafeFlushMempool removes all transactions from the mempool. // UnsafeFlushMempool removes all transactions from the mempool.
func UnsafeFlushMempool(ctx *rpctypes.Context) (*ctypes.ResultUnsafeFlushMempool, error) { func (env *Environment) UnsafeFlushMempool(ctx *rpctypes.Context) (*ctypes.ResultUnsafeFlushMempool, error) {
env.Mempool.Flush() env.Mempool.Flush()
return &ctypes.ResultUnsafeFlushMempool{}, nil return &ctypes.ResultUnsafeFlushMempool{}, nil
} }
rpc/core/env.go
+3 -14
View File
@@ -33,17 +33,6 @@ const (
genesisChunkSize = 16 * 1024 * 1024 // 16 genesisChunkSize = 16 * 1024 * 1024 // 16
) )
var (
// set by Node
env *Environment
)
// SetEnvironment sets up the given Environment.
// It will race if multiple Node call SetEnvironment.
func SetEnvironment(e *Environment) {
env = e
}
//---------------------------------------------- //----------------------------------------------
// These interfaces are used by RPC and must be thread safe // These interfaces are used by RPC and must be thread safe
@@ -125,7 +114,7 @@ func validatePage(pagePtr *int, perPage, totalCount int) (int, error) {
return page, nil return page, nil
} }
func validatePerPage(perPagePtr *int) int { func (env *Environment) validatePerPage(perPagePtr *int) int {
if perPagePtr == nil { // no per_page parameter if perPagePtr == nil { // no per_page parameter
return defaultPerPage return defaultPerPage
} }
@@ -178,7 +167,7 @@ func validateSkipCount(page, perPage int) int {
} }
// latestHeight can be either latest committed or uncommitted (+1) height. // latestHeight can be either latest committed or uncommitted (+1) height.
func getHeight(latestHeight int64, heightPtr *int64) (int64, error) { func (env *Environment) getHeight(latestHeight int64, heightPtr *int64) (int64, error) {
if heightPtr != nil { if heightPtr != nil {
height := *heightPtr height := *heightPtr
if height <= 0 { if height <= 0 {
@@ -198,7 +187,7 @@ func getHeight(latestHeight int64, heightPtr *int64) (int64, error) {
return latestHeight, nil return latestHeight, nil
} }
func latestUncommittedHeight() int64 { func (env *Environment) latestUncommittedHeight() int64 {
nodeIsSyncing := env.ConsensusReactor.WaitSync() nodeIsSyncing := env.ConsensusReactor.WaitSync()
if nodeIsSyncing { if nodeIsSyncing {
return env.BlockStore.Height() return env.BlockStore.Height()
rpc/core/env_test.go
-1
View File
@@ -70,7 +70,6 @@ func TestPaginationPerPage(t *testing.T) {
{5, maxPerPage, maxPerPage}, {5, maxPerPage, maxPerPage},
{5, maxPerPage + 1, maxPerPage}, {5, maxPerPage + 1, maxPerPage},
} }
for _, c := range cases { for _, c := range cases {
p := validatePerPage(&c.perPage) p := validatePerPage(&c.perPage)
assert.Equal(t, c.newPerPage, p, fmt.Sprintf("%v", c)) assert.Equal(t, c.newPerPage, p, fmt.Sprintf("%v", c))
rpc/core/events.go
+6 -6
View File
@@ -19,8 +19,8 @@ const (
) )
// Subscribe for events via WebSocket. // Subscribe for events via WebSocket.
// More: https://docs.tendermint.com/main/rpc/#/Websocket/subscribe // More: https://docs.tendermint.com/master/rpc/#/Websocket/subscribe
func Subscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultSubscribe, error) { func (env *Environment) Subscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultSubscribe, error) {
addr := ctx.RemoteAddr() addr := ctx.RemoteAddr()
if env.EventBus.NumClients() >= env.Config.MaxSubscriptionClients { if env.EventBus.NumClients() >= env.Config.MaxSubscriptionClients {
@@ -102,8 +102,8 @@ func Subscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultSubscribe, er
} }
// Unsubscribe from events via WebSocket. // Unsubscribe from events via WebSocket.
// More: https://docs.tendermint.com/main/rpc/#/Websocket/unsubscribe // More: https://docs.tendermint.com/master/rpc/#/Websocket/unsubscribe
func Unsubscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultUnsubscribe, error) { func (env *Environment) Unsubscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultUnsubscribe, error) {
addr := ctx.RemoteAddr() addr := ctx.RemoteAddr()
env.Logger.Info("Unsubscribe from query", "remote", addr, "query", query) env.Logger.Info("Unsubscribe from query", "remote", addr, "query", query)
q, err := tmquery.New(query) q, err := tmquery.New(query)
@@ -118,8 +118,8 @@ func Unsubscribe(ctx *rpctypes.Context, query string) (*ctypes.ResultUnsubscribe
} }
// UnsubscribeAll from all events via WebSocket. // UnsubscribeAll from all events via WebSocket.
// More: https://docs.tendermint.com/main/rpc/#/Websocket/unsubscribe_all // More: https://docs.tendermint.com/master/rpc/#/Websocket/unsubscribe_all
func UnsubscribeAll(ctx *rpctypes.Context) (*ctypes.ResultUnsubscribe, error) { func (env *Environment) UnsubscribeAll(ctx *rpctypes.Context) (*ctypes.ResultUnsubscribe, error) {
addr := ctx.RemoteAddr() addr := ctx.RemoteAddr()
env.Logger.Info("Unsubscribe from all", "remote", addr) env.Logger.Info("Unsubscribe from all", "remote", addr)
err := env.EventBus.UnsubscribeAll(context.Background(), addr) err := env.EventBus.UnsubscribeAll(context.Background(), addr)
rpc/core/evidence.go
+5 -2
View File
@@ -10,8 +10,11 @@ import (
) )
// BroadcastEvidence broadcasts evidence of the misbehavior. // BroadcastEvidence broadcasts evidence of the misbehavior.
// More: https://docs.tendermint.com/main/rpc/#/Info/broadcast_evidence // More: https://docs.tendermint.com/master/rpc/#/Evidence/broadcast_evidence
func BroadcastEvidence(ctx *rpctypes.Context, ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) { func (env *Environment) BroadcastEvidence(
ctx *rpctypes.Context,
ev types.Evidence) (*ctypes.ResultBroadcastEvidence, error) {
if ev == nil { if ev == nil {
return nil, errors.New("no evidence was provided") return nil, errors.New("no evidence was provided")
} }
rpc/core/health.go
+2 -2
View File
@@ -7,7 +7,7 @@ import (
// Health gets node health. Returns empty result (200 OK) on success, no // Health gets node health. Returns empty result (200 OK) on success, no
// response - in case of an error. // response - in case of an error.
// More: https://docs.tendermint.com/main/rpc/#/Info/health // More: https://docs.tendermint.com/master/rpc/#/Info/health
func Health(ctx *rpctypes.Context) (*ctypes.ResultHealth, error) { func (env *Environment) Health(ctx *rpctypes.Context) (*ctypes.ResultHealth, error) {
return &ctypes.ResultHealth{}, nil return &ctypes.ResultHealth{}, nil
} }
rpc/core/mempool.go
+13 -13
View File
@@ -18,8 +18,8 @@ import (
// BroadcastTxAsync returns right away, with no response. Does not wait for // BroadcastTxAsync returns right away, with no response. Does not wait for
// CheckTx nor DeliverTx results. // CheckTx nor DeliverTx results.
// More: https://docs.tendermint.com/main/rpc/#/Tx/broadcast_tx_async // More: https://docs.tendermint.com/master/rpc/#/Tx/broadcast_tx_async
func BroadcastTxAsync(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) { func (env *Environment) BroadcastTxAsync(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) {
err := env.Mempool.CheckTx(tx, nil, mempl.TxInfo{}) err := env.Mempool.CheckTx(tx, nil, mempl.TxInfo{})
if err != nil { if err != nil {
@@ -30,8 +30,8 @@ func BroadcastTxAsync(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadca
// BroadcastTxSync returns with the response from CheckTx. Does not wait for // BroadcastTxSync returns with the response from CheckTx. Does not wait for
// DeliverTx result. // DeliverTx result.
// More: https://docs.tendermint.com/main/rpc/#/Tx/broadcast_tx_sync // More: https://docs.tendermint.com/master/rpc/#/Tx/broadcast_tx_sync
func BroadcastTxSync(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) { func (env *Environment) BroadcastTxSync(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcastTx, error) {
resCh := make(chan *abci.Response, 1) resCh := make(chan *abci.Response, 1)
err := env.Mempool.CheckTx(tx, func(res *abci.Response) { err := env.Mempool.CheckTx(tx, func(res *abci.Response) {
select { select {
@@ -60,8 +60,8 @@ func BroadcastTxSync(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcas
} }
// BroadcastTxCommit returns with the responses from CheckTx and DeliverTx. // BroadcastTxCommit returns with the responses from CheckTx and DeliverTx.
// More: https://docs.tendermint.com/main/rpc/#/Tx/broadcast_tx_commit // More: https://docs.tendermint.com/master/rpc/#/Tx/broadcast_tx_commit
func BroadcastTxCommit(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error) { func (env *Environment) BroadcastTxCommit(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadcastTxCommit, error) {
subscriber := ctx.RemoteAddr() subscriber := ctx.RemoteAddr()
if env.EventBus.NumClients() >= env.Config.MaxSubscriptionClients { if env.EventBus.NumClients() >= env.Config.MaxSubscriptionClients {
@@ -149,10 +149,10 @@ func BroadcastTxCommit(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultBroadc
// UnconfirmedTxs gets unconfirmed transactions (maximum ?limit entries) // UnconfirmedTxs gets unconfirmed transactions (maximum ?limit entries)
// including their number. // including their number.
// More: https://docs.tendermint.com/main/rpc/#/Info/unconfirmed_txs // More: https://docs.tendermint.com/master/rpc/#/Info/unconfirmed_txs
func UnconfirmedTxs(ctx *rpctypes.Context, limitPtr *int) (*ctypes.ResultUnconfirmedTxs, error) { func (env *Environment) UnconfirmedTxs(ctx *rpctypes.Context, limitPtr *int) (*ctypes.ResultUnconfirmedTxs, error) {
// reuse per_page validator // reuse per_page validator
limit := validatePerPage(limitPtr) limit := env.validatePerPage(limitPtr)
txs := env.Mempool.ReapMaxTxs(limit) txs := env.Mempool.ReapMaxTxs(limit)
return &ctypes.ResultUnconfirmedTxs{ return &ctypes.ResultUnconfirmedTxs{
@@ -163,8 +163,8 @@ func UnconfirmedTxs(ctx *rpctypes.Context, limitPtr *int) (*ctypes.ResultUnconfi
} }
// NumUnconfirmedTxs gets number of unconfirmed transactions. // NumUnconfirmedTxs gets number of unconfirmed transactions.
// More: https://docs.tendermint.com/main/rpc/#/Info/num_unconfirmed_txs // More: https://docs.tendermint.com/master/rpc/#/Info/num_unconfirmed_txs
func NumUnconfirmedTxs(ctx *rpctypes.Context) (*ctypes.ResultUnconfirmedTxs, error) { func (env *Environment) NumUnconfirmedTxs(ctx *rpctypes.Context) (*ctypes.ResultUnconfirmedTxs, error) {
return &ctypes.ResultUnconfirmedTxs{ return &ctypes.ResultUnconfirmedTxs{
Count: env.Mempool.Size(), Count: env.Mempool.Size(),
Total: env.Mempool.Size(), Total: env.Mempool.Size(),
@@ -173,8 +173,8 @@ func NumUnconfirmedTxs(ctx *rpctypes.Context) (*ctypes.ResultUnconfirmedTxs, err
// CheckTx checks the transaction without executing it. The transaction won't // CheckTx checks the transaction without executing it. The transaction won't
// be added to the mempool either. // be added to the mempool either.
// More: https://docs.tendermint.com/main/rpc/#/Tx/check_tx // More: https://docs.tendermint.com/master/rpc/#/Tx/check_tx
func CheckTx(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultCheckTx, error) { func (env *Environment) CheckTx(ctx *rpctypes.Context, tx types.Tx) (*ctypes.ResultCheckTx, error) {
res, err := env.ProxyAppMempool.CheckTxSync(abci.RequestCheckTx{Tx: tx}) res, err := env.ProxyAppMempool.CheckTxSync(abci.RequestCheckTx{Tx: tx})
if err != nil { if err != nil {
return nil, err return nil, err
rpc/core/net.go
+10 -11
View File
@@ -11,8 +11,8 @@ import (
) )
// NetInfo returns network info. // NetInfo returns network info.
// More: https://docs.tendermint.com/main/rpc/#/Info/net_info // More: https://docs.tendermint.com/master/rpc/#/Info/net_info
func NetInfo(ctx *rpctypes.Context) (*ctypes.ResultNetInfo, error) { func (env *Environment) NetInfo(ctx *rpctypes.Context) (*ctypes.ResultNetInfo, error) {
peersList := env.P2PPeers.Peers().List() peersList := env.P2PPeers.Peers().List()
peers := make([]ctypes.Peer, 0, len(peersList)) peers := make([]ctypes.Peer, 0, len(peersList))
for _, peer := range peersList { for _, peer := range peersList {
@@ -39,7 +39,7 @@ func NetInfo(ctx *rpctypes.Context) (*ctypes.ResultNetInfo, error) {
} }
// UnsafeDialSeeds dials the given seeds (comma-separated id@IP:PORT). // UnsafeDialSeeds dials the given seeds (comma-separated id@IP:PORT).
func UnsafeDialSeeds(ctx *rpctypes.Context, seeds []string) (*ctypes.ResultDialSeeds, error) { func (env *Environment) UnsafeDialSeeds(ctx *rpctypes.Context, seeds []string) (*ctypes.ResultDialSeeds, error) {
if len(seeds) == 0 { if len(seeds) == 0 {
return &ctypes.ResultDialSeeds{}, errors.New("no seeds provided") return &ctypes.ResultDialSeeds{}, errors.New("no seeds provided")
} }
@@ -52,8 +52,11 @@ func UnsafeDialSeeds(ctx *rpctypes.Context, seeds []string) (*ctypes.ResultDialS
// UnsafeDialPeers dials the given peers (comma-separated id@IP:PORT), // UnsafeDialPeers dials the given peers (comma-separated id@IP:PORT),
// optionally making them persistent. // optionally making them persistent.
func UnsafeDialPeers(ctx *rpctypes.Context, peers []string, persistent, unconditional, private bool) ( func (env *Environment) UnsafeDialPeers(
*ctypes.ResultDialPeers, error) { ctx *rpctypes.Context,
peers []string,
persistent, unconditional, private bool) (*ctypes.ResultDialPeers, error) {
if len(peers) == 0 { if len(peers) == 0 {
return &ctypes.ResultDialPeers{}, errors.New("no peers provided") return &ctypes.ResultDialPeers{}, errors.New("no peers provided")
} }
@@ -92,12 +95,8 @@ func UnsafeDialPeers(ctx *rpctypes.Context, peers []string, persistent, uncondit
} }
// Genesis returns genesis file. // Genesis returns genesis file.
// More: https://docs.tendermint.com/main/rpc/#/Info/genesis // More: https://docs.tendermint.com/master/rpc/#/Info/genesis
func Genesis(ctx *rpctypes.Context) (*ctypes.ResultGenesis, error) { func (env *Environment) Genesis(ctx *rpctypes.Context) (*ctypes.ResultGenesis, error) {
if len(env.genChunks) > 1 {
return nil, errors.New("genesis response is large, please use the genesis_chunked API instead")
}
return &ctypes.ResultGenesis{Genesis: env.GenDoc}, nil return &ctypes.ResultGenesis{Genesis: env.GenDoc}, nil
} }
rpc/core/net_test.go
+4 -2
View File
@@ -23,6 +23,7 @@ func TestUnsafeDialSeeds(t *testing.T) {
} }
}) })
env := &Environment{}
env.Logger = log.TestingLogger() env.Logger = log.TestingLogger()
env.P2PPeers = sw env.P2PPeers = sw
@@ -36,7 +37,7 @@ func TestUnsafeDialSeeds(t *testing.T) {
} }
for _, tc := range testCases { for _, tc := range testCases {
res, err := UnsafeDialSeeds(&rpctypes.Context{}, tc.seeds) res, err := env.UnsafeDialSeeds(&rpctypes.Context{}, tc.seeds)
if tc.isErr { if tc.isErr {
assert.Error(t, err) assert.Error(t, err)
} else { } else {
@@ -62,6 +63,7 @@ func TestUnsafeDialPeers(t *testing.T) {
} }
}) })
env := &Environment{}
env.Logger = log.TestingLogger() env.Logger = log.TestingLogger()
env.P2PPeers = sw env.P2PPeers = sw
@@ -76,7 +78,7 @@ func TestUnsafeDialPeers(t *testing.T) {
} }
for _, tc := range testCases { for _, tc := range testCases {
res, err := UnsafeDialPeers(&rpctypes.Context{}, tc.peers, tc.persistence, tc.unconditional, tc.private) res, err := env.UnsafeDialPeers(&rpctypes.Context{}, tc.peers, tc.persistence, tc.unconditional, tc.private)
if tc.isErr { if tc.isErr {
assert.Error(t, err) assert.Error(t, err)
} else { } else {
rpc/core/routes.go
+42 -41
View File
@@ -6,54 +6,55 @@ import (
// TODO: better system than "unsafe" prefix // TODO: better system than "unsafe" prefix
type RoutesMap map[string]*rpc.RPCFunc
// Routes is a map of available routes. // Routes is a map of available routes.
var Routes = map[string]*rpc.RPCFunc{ func (env *Environment) GetRoutes() RoutesMap {
// subscribe/unsubscribe are reserved for websocket events. return RoutesMap{
"subscribe": rpc.NewWSRPCFunc(Subscribe, "query"), // subscribe/unsubscribe are reserved for websocket events.
"unsubscribe": rpc.NewWSRPCFunc(Unsubscribe, "query"), "subscribe": rpc.NewWSRPCFunc(env.Subscribe, "query"),
"unsubscribe_all": rpc.NewWSRPCFunc(UnsubscribeAll, ""), "unsubscribe": rpc.NewWSRPCFunc(env.Unsubscribe, "query"),
"unsubscribe_all": rpc.NewWSRPCFunc(env.UnsubscribeAll, ""),
// info API // info API
"health": rpc.NewRPCFunc(Health, ""), "health": rpc.NewRPCFunc(env.Health, "", false),
"status": rpc.NewRPCFunc(Status, ""), "status": rpc.NewRPCFunc(env.Status, "", false),
"net_info": rpc.NewRPCFunc(NetInfo, ""), "net_info": rpc.NewRPCFunc(env.NetInfo, "", false),
"blockchain": rpc.NewRPCFunc(BlockchainInfo, "minHeight,maxHeight"), "blockchain": rpc.NewRPCFunc(env.BlockchainInfo, "minHeight,maxHeight", true),
"genesis": rpc.NewRPCFunc(Genesis, ""), "genesis": rpc.NewRPCFunc(env.Genesis, "", true),
"genesis_chunked": rpc.NewRPCFunc(GenesisChunked, "chunk"), "block": rpc.NewRPCFunc(env.Block, "height", true),
"block": rpc.NewRPCFunc(Block, "height"), "block_by_hash": rpc.NewRPCFunc(env.BlockByHash, "hash", true),
"block_by_hash": rpc.NewRPCFunc(BlockByHash, "hash"), "block_results": rpc.NewRPCFunc(env.BlockResults, "height", true),
"block_results": rpc.NewRPCFunc(BlockResults, "height"), "commit": rpc.NewRPCFunc(env.Commit, "height", true),
"commit": rpc.NewRPCFunc(Commit, "height"), "check_tx": rpc.NewRPCFunc(env.CheckTx, "tx", true),
"header": rpc.NewRPCFunc(Header, "height"), "tx": rpc.NewRPCFunc(env.Tx, "hash,prove", true),
"header_by_hash": rpc.NewRPCFunc(HeaderByHash, "hash"), "tx_search": rpc.NewRPCFunc(env.TxSearch, "query,prove,page,per_page,order_by", false),
"check_tx": rpc.NewRPCFunc(CheckTx, "tx"), "block_search": rpc.NewRPCFunc(env.BlockSearch, "query,page,per_page,order_by", false),
"tx": rpc.NewRPCFunc(Tx, "hash,prove"), "validators": rpc.NewRPCFunc(env.Validators, "height,page,per_page", true),
"tx_search": rpc.NewRPCFunc(TxSearch, "query,prove,page,per_page,order_by"), "dump_consensus_state": rpc.NewRPCFunc(env.DumpConsensusState, "", false),
"block_search": rpc.NewRPCFunc(BlockSearch, "query,page,per_page,order_by"), "consensus_state": rpc.NewRPCFunc(env.GetConsensusState, "", false),
"validators": rpc.NewRPCFunc(Validators, "height,page,per_page"), "consensus_params": rpc.NewRPCFunc(env.ConsensusParams, "height", true),
"dump_consensus_state": rpc.NewRPCFunc(DumpConsensusState, ""), "unconfirmed_txs": rpc.NewRPCFunc(env.UnconfirmedTxs, "limit", false),
"consensus_state": rpc.NewRPCFunc(ConsensusState, ""), "num_unconfirmed_txs": rpc.NewRPCFunc(env.NumUnconfirmedTxs, "", false),
"consensus_params": rpc.NewRPCFunc(ConsensusParams, "height"),
"unconfirmed_txs": rpc.NewRPCFunc(UnconfirmedTxs, "limit"),
"num_unconfirmed_txs": rpc.NewRPCFunc(NumUnconfirmedTxs, ""),
// tx broadcast API // tx broadcast API
"broadcast_tx_commit": rpc.NewRPCFunc(BroadcastTxCommit, "tx"), "broadcast_tx_commit": rpc.NewRPCFunc(env.BroadcastTxCommit, "tx", false),
"broadcast_tx_sync": rpc.NewRPCFunc(BroadcastTxSync, "tx"), "broadcast_tx_sync": rpc.NewRPCFunc(env.BroadcastTxSync, "tx", false),
"broadcast_tx_async": rpc.NewRPCFunc(BroadcastTxAsync, "tx"), "broadcast_tx_async": rpc.NewRPCFunc(env.BroadcastTxAsync, "tx", false),
// abci API // abci API
"abci_query": rpc.NewRPCFunc(ABCIQuery, "path,data,height,prove"), "abci_query": rpc.NewRPCFunc(env.ABCIQuery, "path,data,height,prove", false),
"abci_info": rpc.NewRPCFunc(ABCIInfo, ""), "abci_info": rpc.NewRPCFunc(env.ABCIInfo, "", true),
// evidence API // evidence API
"broadcast_evidence": rpc.NewRPCFunc(BroadcastEvidence, "evidence"), "broadcast_evidence": rpc.NewRPCFunc(env.BroadcastEvidence, "evidence", false),
}
} }
// AddUnsafeRoutes adds unsafe routes. // AddUnsafeRoutes adds unsafe routes.
func AddUnsafeRoutes() { func (env *Environment) AddUnsafe(routes RoutesMap) {
// control API // control API
Routes["dial_seeds"] = rpc.NewRPCFunc(UnsafeDialSeeds, "seeds") routes["dial_seeds"] = rpc.NewRPCFunc(env.UnsafeDialSeeds, "seeds", false)
Routes["dial_peers"] = rpc.NewRPCFunc(UnsafeDialPeers, "peers,persistent,unconditional,private") routes["dial_peers"] = rpc.NewRPCFunc(env.UnsafeDialPeers, "peers,persistent,unconditional,private", false)
Routes["unsafe_flush_mempool"] = rpc.NewRPCFunc(UnsafeFlushMempool, "") routes["unsafe_flush_mempool"] = rpc.NewRPCFunc(env.UnsafeFlushMempool, "", false)
} }
rpc/core/status.go
+6 -6
View File
@@ -12,8 +12,8 @@ import (
// Status returns Tendermint status including node info, pubkey, latest block // Status returns Tendermint status including node info, pubkey, latest block
// hash, app hash, block height and time. // hash, app hash, block height and time.
// More: https://docs.tendermint.com/main/rpc/#/Info/status // More: https://docs.tendermint.com/master/rpc/#/Info/status
func Status(ctx *rpctypes.Context) (*ctypes.ResultStatus, error) { func (env *Environment) Status(ctx *rpctypes.Context) (*ctypes.ResultStatus, error) {
var ( var (
earliestBlockHeight int64 earliestBlockHeight int64
earliestBlockHash tmbytes.HexBytes earliestBlockHash tmbytes.HexBytes
@@ -47,7 +47,7 @@ func Status(ctx *rpctypes.Context) (*ctypes.ResultStatus, error) {
// Return the very last voting power, not the voting power of this validator // Return the very last voting power, not the voting power of this validator
// during the last block. // during the last block.
var votingPower int64 var votingPower int64
if val := validatorAtHeight(latestUncommittedHeight()); val != nil { if val := env.validatorAtHeight(env.latestUncommittedHeight()); val != nil {
votingPower = val.VotingPower votingPower = val.VotingPower
} }
@@ -74,12 +74,12 @@ func Status(ctx *rpctypes.Context) (*ctypes.ResultStatus, error) {
return result, nil return result, nil
} }
func validatorAtHeight(h int64) *types.Validator { func (env *Environment) validatorAtHeight(h int64) *types.Validator {
vals, err := env.StateStore.LoadValidators(h) valsWithH, err := env.StateStore.LoadValidators(h)
if err != nil { if err != nil {
return nil return nil
} }
privValAddress := env.PubKey.Address() privValAddress := env.PubKey.Address()
_, val := vals.GetByAddress(privValAddress) _, val := valsWithH.GetByAddress(privValAddress)
return val return val
} }
rpc/core/tx.go
+5 -5
View File
@@ -16,8 +16,8 @@ import (
// Tx allows you to query the transaction results. `nil` could mean the // Tx allows you to query the transaction results. `nil` could mean the
// transaction is in the mempool, invalidated, or was not sent in the first // transaction is in the mempool, invalidated, or was not sent in the first
// place. // place.
// More: https://docs.tendermint.com/main/rpc/#/Info/tx // More: https://docs.tendermint.com/master/rpc/#/Info/tx
func Tx(ctx *rpctypes.Context, hash []byte, prove bool) (*ctypes.ResultTx, error) { func (env *Environment) Tx(ctx *rpctypes.Context, hash []byte, prove bool) (*ctypes.ResultTx, error) {
// if index is disabled, return error // if index is disabled, return error
if _, ok := env.TxIndexer.(*null.TxIndex); ok { if _, ok := env.TxIndexer.(*null.TxIndex); ok {
return nil, fmt.Errorf("transaction indexing is disabled") return nil, fmt.Errorf("transaction indexing is disabled")
@@ -50,8 +50,8 @@ func Tx(ctx *rpctypes.Context, hash []byte, prove bool) (*ctypes.ResultTx, error
// TxSearch allows you to query for multiple transactions results. It returns a // TxSearch allows you to query for multiple transactions results. It returns a
// list of transactions (maximum ?per_page entries) and the total count. // list of transactions (maximum ?per_page entries) and the total count.
// More: https://docs.tendermint.com/main/rpc/#/Info/tx_search // More: https://docs.tendermint.com/master/rpc/#/Info/tx_search
func TxSearch( func (env *Environment) TxSearch(
ctx *rpctypes.Context, ctx *rpctypes.Context,
query string, query string,
prove bool, prove bool,
@@ -98,7 +98,7 @@ func TxSearch(
// paginate results // paginate results
totalCount := len(results) totalCount := len(results)
perPage := validatePerPage(perPagePtr) perPage := env.validatePerPage(perPagePtr)
page, err := validatePage(pagePtr, perPage, totalCount) page, err := validatePage(pagePtr, perPage, totalCount)
if err != nil { if err != nil {
rpc/grpc/api.go
+2 -1
View File
@@ -9,6 +9,7 @@ import (
) )
type broadcastAPI struct { type broadcastAPI struct {
env *core.Environment
} }
func (bapi *broadcastAPI) Ping(ctx context.Context, req *RequestPing) (*ResponsePing, error) { func (bapi *broadcastAPI) Ping(ctx context.Context, req *RequestPing) (*ResponsePing, error) {
@@ -19,7 +20,7 @@ func (bapi *broadcastAPI) Ping(ctx context.Context, req *RequestPing) (*Response
func (bapi *broadcastAPI) BroadcastTx(ctx context.Context, req *RequestBroadcastTx) (*ResponseBroadcastTx, error) { func (bapi *broadcastAPI) BroadcastTx(ctx context.Context, req *RequestBroadcastTx) (*ResponseBroadcastTx, error) {
// NOTE: there's no way to get client's remote address // NOTE: there's no way to get client's remote address
// see https://stackoverflow.com/questions/33684570/session-and-remote-ip-address-in-grpc-go // see https://stackoverflow.com/questions/33684570/session-and-remote-ip-address-in-grpc-go
res, err := core.BroadcastTxCommit(&rpctypes.Context{}, req.Tx) res, err := bapi.env.BroadcastTxCommit(&rpctypes.Context{}, req.Tx)
if err != nil { if err != nil {
return nil, err return nil, err
} }
rpc/grpc/client_server.go
+3 -2
View File
@@ -7,6 +7,7 @@ import (
"google.golang.org/grpc" "google.golang.org/grpc"
tmnet "github.com/tendermint/tendermint/libs/net" tmnet "github.com/tendermint/tendermint/libs/net"
"github.com/tendermint/tendermint/rpc/core"
) )
// Config is an gRPC server configuration. // Config is an gRPC server configuration.
@@ -17,9 +18,9 @@ type Config struct {
// StartGRPCServer starts a new gRPC BroadcastAPIServer using the given // StartGRPCServer starts a new gRPC BroadcastAPIServer using the given
// net.Listener. // net.Listener.
// NOTE: This function blocks - you may want to call it in a go-routine. // NOTE: This function blocks - you may want to call it in a go-routine.
func StartGRPCServer(ln net.Listener) error { func StartGRPCServer(env *core.Environment, ln net.Listener) error {
grpcServer := grpc.NewServer() grpcServer := grpc.NewServer()
RegisterBroadcastAPIServer(grpcServer, &broadcastAPI{}) RegisterBroadcastAPIServer(grpcServer, &broadcastAPI{env: env})
return grpcServer.Serve(ln) return grpcServer.Serve(ln)
} }