status-im
/
status-go
mirror of https://github.com/status-im/status-go.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
status-go/rpc/doc.go

23 lines
826 B
Go
Raw Normal View History

Add some docs/readmes (#329) Updates and adds some package docs. It also provides autogenerated README's using https://github.com/jimmyfrasche/autoreadme tool. To use it, make sure it's installed on your system, and every time you update documentation, run go generate to update the README.md file.
2017-09-15 16:00:00 +00:00
/*
Add support for JSON-RPC batched calls (#341) This PR introduces proper support for JSON-RPC batched requests (http://www.jsonrpc.org/specification#batch)
2017-09-18 14:24:35 +00:00
Package rpc - JSON-RPC client with custom routing.
Add some docs/readmes (#329) Updates and adds some package docs. It also provides autogenerated README's using https://github.com/jimmyfrasche/autoreadme tool. To use it, make sure it's installed on your system, and every time you update documentation, run go generate to update the README.md file.
2017-09-15 16:00:00 +00:00
Package rpc implements status-go JSON-RPC client and handles
requests to different endpoints: upstream or local node.
Every JSON-RPC request coming from either JS code or any other part
of status-go should use this package to be handled and routed properly.
Routing rules are following:
- if Upstream is disabled, everything is routed to local ethereum-go node
- otherwise, some requests (from the list, see below) are routed to upstream, others - locally.
List of methods to be routed is currently available here: https://docs.google.com/spreadsheets/d/1N1nuzVN5tXoDmzkBLeC9_mwIlVH8DGF7YD2XwxA8BAE/edit#gid=0
Note, upon creation of a new client, it ok to be offline - client will keep trying to reconnect in background.
*/
package rpc
//go:generate autoreadme -f