mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-04 20:23:59 +00:00
docs: tweak light client documentation (#5121)
Updates the docs for the website to be a little bit clearer on how to run a light client, which is, I suspect, what most people will be looking for.
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
order: 9
|
||||
---
|
||||
|
||||
# Light Client Protocol
|
||||
# Light Client
|
||||
|
||||
Light clients are an important part of the complete blockchain system for most
|
||||
applications. Tendermint provides unique speed and security properties for
|
||||
@@ -21,7 +21,7 @@ proofs](https://github.com/tendermint/spec/blob/953523c3cb99fdb8c8f7a2d21e3a9909
|
||||
|
||||
## Properties
|
||||
|
||||
- You get the full collateralized security benefits of Tendermint; No
|
||||
- You get the full collateralized security benefits of Tendermint; no
|
||||
need to wait for confirmations.
|
||||
- You get the full speed benefits of Tendermint; transactions
|
||||
commit instantly.
|
||||
@@ -46,7 +46,7 @@ $ curl -s https://233.123.0.140:26657:26657/commit | jq "{height: .result.signed
|
||||
}
|
||||
```
|
||||
|
||||
## HTTP proxy
|
||||
## Running a light client as an HTTP proxy server
|
||||
|
||||
Tendermint comes with a built-in `tendermint light` command, which can be used
|
||||
to run a light client proxy server, verifying Tendermint rpc. All calls that
|
||||
@@ -54,6 +54,13 @@ can be tracked back to a block header by a proof will be verified before
|
||||
passing them back to the caller. Other than that, it will present the same
|
||||
interface as a full Tendermint node.
|
||||
|
||||
You can start the light client proxy server by running `tendermint light <chainID>`,
|
||||
with a variety of flags to specify the primary node, the witness nodes (which cross-check
|
||||
the information provided by the primary), the hash and height of the trusted header,
|
||||
and more.
|
||||
|
||||
For example:
|
||||
|
||||
```bash
|
||||
$ tendermint light supernova -p tcp://233.123.0.140:26657 \
|
||||
-w tcp://179.63.29.15:26657,tcp://144.165.223.135:26657 \
|
||||
|
||||
Reference in New Issue
Block a user