status-go/rpc/README.md

31 lines
1.1 KiB
Markdown

# rpc [![GoDoc](https://godoc.org/github.com/status-im/status-go/rpc?status.png)](https://godoc.org/github.com/status-im/status-go/rpc)
Package rpc - JSON-RPC client with custom routing.
Download:
```shell
go get github.com/status-im/status-go/rpc
```
* * *
Package rpc - JSON-RPC client with custom routing.
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.
* * *
Automatically generated by [autoreadme](https://github.com/jimmyfrasche/autoreadme) on 2017.09.18