mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-07 05:46:32 +00:00
44a3fbf109
https://www.jsonrpc.org/specification What is done in this PR: JSONRPCClient: validate that Response.ID matches Request.ID I wanted to do the same for the WSClient, but since we're sending events as responses, not notifications, checking IDs would require storing them in memory indefinitely (and we won't be able to remove them upon client unsubscribing because ID is different then). Request.ID is now optional. Notification is a Request without an ID. Previously "" or 0 were considered as notifications Remove #event suffix from ID from an event response (partially fixes #2949) ID must be either string, int or null AND must be equal to request's ID. Now, because we've implemented events as responses, WS clients are tripping when they see Response.ID("0#event") != Request.ID("0"). Implementing events as requests would require a lot of time (~ 2 days to completely rewrite WS client and server) generate unique ID for each request switch to integer IDs instead of "json-client-XYZ" id=0 method=/subscribe id=0 result=... id=1 method=/abci_query id=1 result=... > send events (resulting from /subscribe) as requests+notifications (not responses) this will require a lot of work. probably not worth it * rpc: generate an unique ID for each request in conformance with JSON-RPC spec * WSClient: check for unsolicited responses * fix golangci warnings * save commit * fix errors * remove ID from responses from subscribe Refs #2949 * clients are safe for concurrent access * tm-bench: switch to int ID * fixes after my own review * comment out sentIDs in WSClient see commit body for the reason * remove body.Close it will be closed automatically * stop ws connection outside of write/read routines also, use t.Rate in tm-bench indexer when calculating ID fix gocritic issues * update swagger.yaml * Apply suggestions from code review * fix stylecheck and golint linter warnings * update changelog * update changelog2
87 lines
2.7 KiB
Go
87 lines
2.7 KiB
Go
// HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over
|
|
// websockets
|
|
//
|
|
// Client Requests
|
|
//
|
|
// Suppose we want to expose the rpc function `HelloWorld(name string, num int)`.
|
|
//
|
|
// GET (URI)
|
|
//
|
|
// As a GET request, it would have URI encoded parameters, and look like:
|
|
//
|
|
// curl 'http://localhost:8008/hello_world?name="my_world"&num=5'
|
|
//
|
|
// Note the `'` around the url, which is just so bash doesn't ignore the quotes in `"my_world"`.
|
|
// This should also work:
|
|
//
|
|
// curl http://localhost:8008/hello_world?name=\"my_world\"&num=5
|
|
//
|
|
// A GET request to `/` returns a list of available endpoints.
|
|
// For those which take arguments, the arguments will be listed in order, with `_` where the actual value should be.
|
|
//
|
|
// POST (JSONRPC)
|
|
//
|
|
// As a POST request, we use JSONRPC. For instance, the same request would have this as the body:
|
|
//
|
|
// {
|
|
// "jsonrpc": "2.0",
|
|
// "id": "anything",
|
|
// "method": "hello_world",
|
|
// "params": {
|
|
// "name": "my_world",
|
|
// "num": 5
|
|
// }
|
|
// }
|
|
//
|
|
// With the above saved in file `data.json`, we can make the request with
|
|
//
|
|
// curl --data @data.json http://localhost:8008
|
|
//
|
|
//
|
|
// WebSocket (JSONRPC)
|
|
//
|
|
// All requests are exposed over websocket in the same form as the POST JSONRPC.
|
|
// Websocket connections are available at their own endpoint, typically `/websocket`,
|
|
// though this is configurable when starting the server.
|
|
//
|
|
// Server Definition
|
|
//
|
|
// Define some types and routes:
|
|
//
|
|
// type ResultStatus struct {
|
|
// Value string
|
|
// }
|
|
//
|
|
// Define some routes
|
|
//
|
|
// var Routes = map[string]*rpcserver.RPCFunc{
|
|
// "status": rpcserver.NewRPCFunc(Status, "arg"),
|
|
// }
|
|
//
|
|
// An rpc function:
|
|
//
|
|
// func Status(v string) (*ResultStatus, error) {
|
|
// return &ResultStatus{v}, nil
|
|
// }
|
|
//
|
|
// Now start the server:
|
|
//
|
|
// mux := http.NewServeMux()
|
|
// rpcserver.RegisterRPCFuncs(mux, Routes)
|
|
// wm := rpcserver.NewWebsocketManager(Routes)
|
|
// mux.HandleFunc("/websocket", wm.WebsocketHandler)
|
|
// logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
|
|
// listener, err := rpc.Listen("0.0.0.0:8080", rpcserver.Config{})
|
|
// if err != nil { panic(err) }
|
|
// go rpcserver.StartHTTPServer(listener, mux, logger)
|
|
//
|
|
// Note that unix sockets are supported as well (eg. `/path/to/socket` instead of `0.0.0.0:8008`)
|
|
// Now see all available endpoints by sending a GET request to `0.0.0.0:8008`.
|
|
// Each route is available as a GET request, as a JSONRPCv2 POST request, and via JSONRPCv2 over websockets.
|
|
//
|
|
// Examples
|
|
//
|
|
// - [Tendermint](https://github.com/tendermint/tendermint/blob/master/rpc/core/routes.go)
|
|
// - [tm-monitor](https://github.com/tendermint/tendermint/blob/master/tools/tm-monitor/rpc.go)
|
|
package rpc
|