cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Doc updates (#1226)

Browse Source 
* Keep wallet name and password file in sync with commands

* Fix create validator example to include required param --count

The current example fails with v0.1.2 fails with "Must supply either --count or --at-most"  This change proposes passing count=1, esp'ly since "Creating another validator is easy" a couple of paragraphs down.

* Fix broken links to wallet-create

Wallet links result in file not found.  May be caused by the lack of `.md`?

* Include node/health in TOC

* Remove unnecessary book files

Co-authored-by: J Burnett <jburnett@users.noreply.github.com>
This commit is contained in:
Age Manning 2020-06-01 11:34:16 +10:00 committed by GitHub
parent 91cb14ac41
commit cb26ddebb1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
book/src/SUMMARY.md
View File

@ -12,6 +12,7 @@
* [Local Testnets](./local-testnets.md)
* [API](./api.md)
* [HTTP (RESTful JSON)](./http.md)
* [/node](./http/node.md)
* [/beacon](./http/beacon.md)
* [/validator](./http/validator.md)
* [/consensus](./http/consensus.md)

1
book/src/http/node.md
View File

@ -8,6 +8,7 @@ HTTP Path | Description |
| --- | -- |
[`/node/version`](#nodeversion) | Get the node's version.
[`/node/syncing`](#nodesyncing) | Get the node's syncing status.
[`/node/health`](#nodehealth) | Get the node's health.
## `/node/version`

1
book/src/http_advanced.md
View File

@ -1 +0,0 @@
# /advanced

1
book/src/http_beacon.md
View File

@ -1 +0,0 @@
# /beacon

1
book/src/http_consensus.md
View File

@ -1 +0,0 @@
# /consensus

1
book/src/http_network.md
View File

@ -1 +0,0 @@
# /network

1
book/src/http_spec.md
View File

@ -1 +0,0 @@
# /spec

1
book/src/http_validator.md
View File

@ -1 +0,0 @@
# /validator

4
book/src/key-managment.md
View File

@ -37,12 +37,12 @@ keypairs. Creating a single validator looks like this:
1. Create a **wallet** and record the **mnemonic**:
- `lighthouse account wallet create --name wally --passphrase-file wally.pass`
1. Create the voting and withdrawal **keystores** for one validator:
- `lighthouse account validator create --wallet-name wally --wallet-passphrase wally.pass`
- `lighthouse account validator create --wallet-name wally --wallet-passphrase wally.pass --count 1`
In step (1), we created a wallet in `~/.lighthouse/wallets` with the name
`mywallet`. We encrypted this using a pre-defined password in the
`mywallet.pass` file. Then, in step (2), we created a new validator in the
`mywallet.pass` file. Then, in step (2), we created one new validator in the
`~/.lighthouse/validators` directory using `mywallet` (unlocking it with
`mywallet.pass`) and storing the passwords to the validators voting key in
`~/.lighthouse/secrets`.

6
book/src/validator-create.md
View File

@ -1,14 +1,14 @@
# Create a validator
Validators are fundamentally represented by a BLS keypair. In Lighthouse, we
use a [wallet](./wallet-create) to generate these keypairs. Once a wallet
use a [wallet](./wallet-create.md) to generate these keypairs. Once a wallet
exists, the `lighthouse account validator create` command is used to generate
the BLS keypair and all necessary information to submit a validator deposit and
have that validator operate in the `lighthouse validator_client`.
## Usage
To create a validator from a [wallet](./wallet-create), use the `lighthouse
To create a validator from a [wallet](./wallet-create.md), use the `lighthouse
account validator create` command:
```bash
@ -57,7 +57,7 @@ OPTIONS:
## Example
The example assumes that the `wally` wallet was generated from the
[wallet](./wallet-create) example.
[wallet](./wallet-create.md) example.
```bash
lighthouse account wallet validator --name wally --wallet-password wally.pass