gnosis/lighthouse
1
0
Fork 0
mirror of https://github.com/sigp/lighthouse.git synced 2026-07-05 13:54:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reformat tables and add borders (#3377)

Browse Source 
## Proposed Changes

This PR reformats Markdown tables and ensures all tables have borders.
This commit is contained in:
Justin Traglia
2022-07-27 00:51:07 +00:00
parent 0f62d900fe
commit e29765e118
4 changed files with 98 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
book/src/advanced_database.md
View File

@@ -24,7 +24,7 @@ frequent restore points, while a higher SPRP corresponds to less frequent. The t
some example values.
| Use Case | SPRP | Yearly Disk Usage | Load Historical State |
| ---------------------- | -------------- | ----------------- | --------------------- |
|--------------------------|------|-------------------|-----------------------|
| Block explorer/analysis | 32 | 1.4 TB | 155 ms |
| Hobbyist (prev. default) | 2048 | 23.1 GB | 10.2 s |
| Validator only (default) | 8192 | 5.7 GB | 41 s |

110
book/src/api-vc-endpoints.md
View File

@@ -25,11 +25,11 @@ Returns the software version and `git` commit hash for the Lighthouse binary.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/version`
Method | GET
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/version` |
| Method | GET |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
### Example Response Body
@@ -48,11 +48,11 @@ Returns information regarding the health of the host machine.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/health`
Method | GET
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/health` |
| Method | GET |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
*Note: this endpoint is presently only available on Linux.*
@@ -84,11 +84,11 @@ Returns the Ethereum proof-of-stake consensus specification loaded for this vali
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/spec`
Method | GET
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/spec` |
| Method | GET |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
### Example Response Body
@@ -169,11 +169,11 @@ file may be read by a local user with access rights.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/auth`
Method | GET
Required Headers | -
Typical Responses | 200
|-------------------|--------------------|
| Path | `/lighthouse/auth` |
| Method | GET |
| Required Headers | - |
| Typical Responses | 200 |
### Example Path
@@ -196,11 +196,11 @@ Lists all validators managed by this validator client.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators`
Method | GET
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators` |
| Method | GET |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
### Example Response Body
@@ -233,11 +233,11 @@ Get a validator by their `voting_pubkey`.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators/:voting_pubkey`
Method | GET
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200, 400
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators/:voting_pubkey` |
| Method | GET |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200, 400 |
### Example Path
@@ -263,11 +263,11 @@ Update some values for the validator with `voting_pubkey`.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators/:voting_pubkey`
Method | PATCH
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200, 400
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators/:voting_pubkey` |
| Method | PATCH |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200, 400 |
### Example Path
@@ -302,11 +302,11 @@ Validators are generated from the mnemonic according to
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators`
Method | POST
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators` |
| Method | POST |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
### Example Request Body
@@ -360,11 +360,11 @@ Import a keystore into the validator client.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators/keystore`
Method | POST
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators/keystore` |
| Method | POST |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
### Example Request Body
@@ -434,11 +434,11 @@ generated with the path `m/12381/3600/i/42`.
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators/mnemonic`
Method | POST
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators/mnemonic` |
| Method | POST |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200 |
### Example Request Body
@@ -480,11 +480,11 @@ Create any number of new validators, all of which will refer to a
### HTTP Specification
| Property | Specification |
| --- |--- |
Path | `/lighthouse/validators/web3signer`
Method | POST
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200, 400
|-------------------|--------------------------------------------|
| Path | `/lighthouse/validators/web3signer` |
| Method | POST |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200, 400 |
### Example Request Body

2
book/src/installation-priorities.md
View File

@@ -5,7 +5,7 @@ When publishing releases, Lighthouse will include an "Update Priority" section i
The "Update Priority" section will include a table which may appear like so:
| User Class | Beacon Node | Validator Client |
--- | --- | ---
|-------------------|-----------------|------------------|
| Staking Users | Medium Priority | Low Priority |
| Non-Staking Users | Low Priority | --- |

30
book/src/suggested-fee-recipient.md
View File

@@ -80,11 +80,11 @@ will be saved in `validator_definitions.yml` so that it persists across restarts
client.
| Property | Specification |
| --- | --- |
Path | `/eth/v1/validator/{pubkey}/feerecipient`
Method | POST
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 202, 404
|-------------------|--------------------------------------------|
| Path | `/eth/v1/validator/{pubkey}/feerecipient` |
| Method | POST |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 202, 404 |
#### Example Request Body
```json
@@ -115,11 +115,11 @@ null
The same path with a `GET` request can be used to query the fee recipient for a given public key at any time.
| Property | Specification |
| --- | --- |
Path | `/eth/v1/validator/{pubkey}/feerecipient`
Method | GET
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 200, 404
|-------------------|--------------------------------------------|
| Path | `/eth/v1/validator/{pubkey}/feerecipient` |
| Method | GET |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 200, 404 |
```bash
DATADIR=$HOME/.lighthouse/mainnet
@@ -147,11 +147,11 @@ The same path with a `DELETE` request can be used to remove the fee recipient fo
This is useful if you want the fee recipient to fall back to the validator client (or beacon node) default.
| Property | Specification |
| --- | --- |
Path | `/eth/v1/validator/{pubkey}/feerecipient`
Method | DELETE
Required Headers | [`Authorization`](./api-vc-auth-header.md)
Typical Responses | 204, 404
|-------------------|--------------------------------------------|
| Path | `/eth/v1/validator/{pubkey}/feerecipient` |
| Method | DELETE |
| Required Headers | [`Authorization`](./api-vc-auth-header.md) |
| Typical Responses | 204, 404 |
```bash
DATADIR=$HOME/.lighthouse/mainnet