diff --git a/docs/tendermint-core/rpc.md b/docs/tendermint-core/rpc.md index 51f34fc25..7ae59f0d3 100644 --- a/docs/tendermint-core/rpc.md +++ b/docs/tendermint-core/rpc.md @@ -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). diff --git a/docs/tendermint-core/running-in-production.md b/docs/tendermint-core/running-in-production.md index cb228be4a..f647bd9b0 100644 --- a/docs/tendermint-core/running-in-production.md +++ b/docs/tendermint-core/running-in-production.md @@ -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 diff --git a/docs/tendermint-core/using-tendermint.md b/docs/tendermint-core/using-tendermint.md index a54412849..33d981e4d 100644 --- a/docs/tendermint-core/using-tendermint.md +++ b/docs/tendermint-core/using-tendermint.md @@ -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 diff --git a/rpc/core/doc.go b/rpc/core/doc.go index 75f6ac82e..603b6679e 100644 --- a/rpc/core/doc.go +++ b/rpc/core/doc.go @@ -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