Browse Source

docs: update link to rpc (#2361)

* md links dont work in slate

* docs: link to rpc

* docs: use unsafe_reset_all

* do not advertise unsafe_reset_priv_validator
pull/2410/head
Zach 6 years ago
committed by Anton Kaliaev
parent
commit
33b4617e9a
4 changed files with 16 additions and 12 deletions
  1. +4
    -2
      docs/tendermint-core/rpc.md
  2. +2
    -1
      docs/tendermint-core/running-in-production.md
  3. +8
    -8
      docs/tendermint-core/using-tendermint.md
  4. +2
    -1
      rpc/core/doc.go

+ 4
- 2
docs/tendermint-core/rpc.md View File

@ -1,5 +1,7 @@
# RPC
The RPC documentation is hosted [here](https://tendermint.github.io/slate) and is generated by the CI from our [Slate repo](https://github.com/tendermint/slate). To update the documentation, edit the relevant `godoc` comments in the [rpc/core directory](https://github.com/tendermint/tendermint/tree/develop/rpc/core).
The RPC documentation is hosted here:
NOTE: We will be moving the RPC documentation into the website in the near future. Stay tuned!
- https://tendermint.com/rpc/
To update the documentation, edit the relevant `godoc` comments in the [rpc/core directory](https://github.com/tendermint/tendermint/tree/develop/rpc/core).

+ 2
- 1
docs/tendermint-core/running-in-production.md View File

@ -28,7 +28,8 @@ send & receive rate per connection (`SendRate`, `RecvRate`).
### RPC
Endpoints returning multiple entries are limited by default to return 30
elements (100 max). See [here](./rpc.md) for more information about the RPC.
elements (100 max). See the [RPC Documentation](https://tendermint.com/rpc/)
for more information.
Rate-limiting and authentication are another key aspects to help protect
against DOS attacks. While in the future we may implement these


+ 8
- 8
docs/tendermint-core/using-tendermint.md View File

@ -156,6 +156,10 @@ Visit http://localhost:26657 in your browser to see the list of other
endpoints. Some take no arguments (like `/status`), while others specify
the argument name and use `_` as a placeholder.
::: tip
Find the RPC Documentation [here](https://tendermint.com/rpc/)
:::
### Formatting
The following nuances when sending/formatting transactions should be
@ -209,18 +213,14 @@ Note that raw hex cannot be used in `POST` transactions.
**WARNING: UNSAFE** Only do this in development and only if you can
afford to lose all blockchain data!
To reset a blockchain, stop the node, remove the `~/.tendermint/data`
directory and run
To reset a blockchain, stop the node and run:
```
tendermint unsafe_reset_priv_validator
tendermint unsafe_reset_all
```
This final step is necessary to reset the `priv_validator.json`, which
otherwise prevents you from making conflicting votes in the consensus
(something that could get you in trouble if you do it on a real
blockchain). If you don't reset the `priv_validator.json`, your fresh
new blockchain will not make any blocks.
This command will remove the data directory and reset private validator and
address book files.
## Configuration


+ 2
- 1
rpc/core/doc.go View File

@ -7,7 +7,8 @@ Tendermint supports the following RPC protocols:
* JSONRPC over HTTP
* JSONRPC over websockets
Tendermint RPC is built using [our own RPC library](https://github.com/tendermint/tendermint/tree/master/rpc/lib) which contains its own set of documentation and tests.
Tendermint RPC is built using our own RPC library which contains its own set of documentation and tests.
See it here: https://github.com/tendermint/tendermint/tree/master/rpc/lib
## Configuration


Loading…
Cancel
Save