Skip to content

Commit

Permalink
Removr MD001
Browse files Browse the repository at this point in the history
  • Loading branch information
chong-he committed Apr 11, 2024
1 parent 337447e commit d3a3076
Show file tree
Hide file tree
Showing 14 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion book/src/advanced-blobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In the Deneb network upgrade, one of the changes is the implementation of EIP-4844, also known as [Proto-danksharding](https://blog.ethereum.org/2024/02/27/dencun-mainnet-announcement). Alongside with this, a new term named `blob` (binary large object) is introduced. Blobs are "side-cars" carrying transaction data in a block. They are mainly used by Ethereum layer 2 operators. As far as stakers are concerned, the main difference with the introduction of blobs is the increased storage requirement.

### FAQ
## FAQ

1. What is the storage requirement for blobs?

Expand Down
2 changes: 1 addition & 1 deletion book/src/advanced-datadir.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ lighthouse --network mainnet --datadir /var/lib/my-custom-dir vc
The first step creates a `validators` directory under `/var/lib/my-custom-dir` which contains the imported keys and [`validator_definitions.yml`](./validator-management.md).
After that, we simply run the beacon chain and validator client with the custom dir path.

### Relative Paths
## Relative Paths

[#2682]: https://github.com/sigp/lighthouse/pull/2682
[#2846]: https://github.com/sigp/lighthouse/pull/2846
Expand Down
2 changes: 1 addition & 1 deletion book/src/advanced-release-candidates.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ you're looking for stable Lighthouse**.
From time to time, Lighthouse may use the terms "release candidate" and "pre release"
interchangeably. A pre release is identical to a release candidate.

### Examples
## Examples

[`v1.4.0-rc.0`] has `rc` in the version string and is therefore a release candidate. This release is
*not* stable and is *not* intended for critical tasks on mainnet (e.g., staking).
Expand Down
18 changes: 9 additions & 9 deletions book/src/advanced_networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ be adjusted to handle a variety of network situations. This section outlines
some of these configuration parameters and their consequences at the networking
level and their general intended use.

### Target Peers
## Target Peers

The beacon node has a `--target-peers` CLI parameter. This allows you to
instruct the beacon node how many peers it should try to find and maintain.
Expand Down Expand Up @@ -37,7 +37,7 @@ large peer count will not speed up sync.
For these reasons, we recommend users do not modify the `--target-peers` count
drastically and use the (recommended) default.

### NAT Traversal (Port Forwarding)
## NAT Traversal (Port Forwarding)

Lighthouse, by default, uses port 9000 for both TCP and UDP. Since v4.5.0, Lighthouse will also attempt to make QUIC connections via UDP port 9001 by default. Lighthouse will
still function if it is behind a NAT without any port mappings. Although
Expand All @@ -61,7 +61,7 @@ TCP and UDP ports (9000 TCP/UDP, and 9001 UDP by default).
> explicitly specify them using the `--enr-tcp-port` and `--enr-udp-port` as
> explained in the following section.
### How to Open Ports
## How to Open Ports

The steps to do port forwarding depends on the router, but the general steps are given below:

Expand Down Expand Up @@ -93,7 +93,7 @@ Since V4.5.0 port 9001/UDP is also used for QUIC support.

5. To check that you have successfully opened the ports, go to [yougetsignal](https://www.yougetsignal.com/tools/open-ports/) and enter `9000` in the `port number`. If it shows "open", then you have successfully set up port forwarding. If it shows "closed", double check your settings, and also check that you have allowed firewall rules on port 9000. Note: this will only confirm if port 9000/TCP is open. You will need to ensure you have correctly setup port forwarding for the UDP ports (`9000` and `9001` by default).

### ENR Configuration
## ENR Configuration

Lighthouse has a number of CLI parameters for constructing and modifying the
local Ethereum Node Record (ENR). Examples are `--enr-address`,
Expand All @@ -115,15 +115,15 @@ harder for peers to find you or potentially making it harder for other peers to
find each other. We recommend not touching these settings unless for a more
advanced use case.

### IPv6 support
## IPv6 support

As noted in the previous sections, two fundamental parts to ensure good
connectivity are: The parameters that configure the sockets over which
Lighthouse listens for connections, and the parameters used to tell other peers
how to connect to your node. This distinction is relevant and applies to most
nodes that do not run directly on a public network.

#### Configuring Lighthouse to listen over IPv4/IPv6/Dual stack
### Configuring Lighthouse to listen over IPv4/IPv6/Dual stack

To listen over only IPv6 use the same parameters as done when listening over
IPv4 only:
Expand Down Expand Up @@ -151,7 +151,7 @@ To listen over both IPv4 and IPv6:
UDP over IPv6. This will default to the value given to `--port6` + 1. This flag
has no effect when listening over IPv6 only.

##### Configuration Examples
#### Configuration Examples

> When using `--listen-address :: --listen-address 0.0.0.0 --port 9909`, listening will be set up as follows:
>
Expand All @@ -177,7 +177,7 @@ To listen over both IPv4 and IPv6:
> It listens on the default value of `--port6` (`9090`) for TCP, and port `9999` for UDP.
> QUIC will use port `9091` for UDP, which is the default `--port6` value (`9090`) + 1.
#### Configuring Lighthouse to advertise IPv6 reachable addresses
### Configuring Lighthouse to advertise IPv6 reachable addresses

Lighthouse supports IPv6 to connect to other nodes both over IPv6 exclusively,
and dual stack using one socket for IPv4 and another socket for IPv6. In both
Expand Down Expand Up @@ -208,7 +208,7 @@ In the general case, a user will not require to set these explicitly. Update
these options only if you can guarantee your node is reachable with these
values.

#### Known caveats
### Known caveats

IPv6 link local addresses are likely to have poor connectivity if used in
topologies with more than one interface. Use global addresses for the general
Expand Down
50 changes: 25 additions & 25 deletions book/src/api-lighthouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Although we don't recommend that users rely on these endpoints, we
document them briefly so they can be utilized by developers and
researchers.

### `/lighthouse/health`
## `/lighthouse/health`

*Note: This endpoint is presently only available on Linux.*

Expand Down Expand Up @@ -64,7 +64,7 @@ curl -X GET "http://localhost:5052/lighthouse/health" -H "accept: application/j

```

### `/lighthouse/ui/health`
## `/lighthouse/ui/health`

Returns information regarding the health of the host machine.

Expand Down Expand Up @@ -102,7 +102,7 @@ curl -X GET "http://localhost:5052/lighthouse/ui/health" -H "accept: applicatio
}
```

### `/lighthouse/ui/validator_count`
## `/lighthouse/ui/validator_count`

Returns an overview of validators.

Expand All @@ -126,7 +126,7 @@ curl -X GET "http://localhost:5052/lighthouse/ui/validator_count" -H "accept: ap
}
```

### `/lighthouse/ui/validator_metrics`
## `/lighthouse/ui/validator_metrics`

Re-exposes certain metrics from the validator monitor to the HTTP API. This API requires that the beacon node to have the flag `--validator-monitor-auto`. This API will only return metrics for the validators currently being monitored and present in the POST data, or the validators running in the validator client.

Expand Down Expand Up @@ -165,7 +165,7 @@ Running this API without the flag `--validator-monitor-auto` in the beacon node
}
```

### `/lighthouse/syncing`
## `/lighthouse/syncing`

Returns the sync status of the beacon node.

Expand Down Expand Up @@ -196,7 +196,7 @@ There are two possible outcomes, depending on whether the beacon node is syncing
}
```

### `/lighthouse/peers`
## `/lighthouse/peers`

```bash
curl -X GET "http://localhost:5052/lighthouse/peers" -H "accept: application/json" | jq
Expand Down Expand Up @@ -265,7 +265,7 @@ curl -X GET "http://localhost:5052/lighthouse/peers" -H "accept: application/js
]
```

### `/lighthouse/peers/connected`
## `/lighthouse/peers/connected`

Returns information about connected peers.

Expand Down Expand Up @@ -337,28 +337,28 @@ curl -X GET "http://localhost:5052/lighthouse/peers/connected" -H "accept: appl
]
```

### `/lighthouse/proto_array`
## `/lighthouse/proto_array`

```bash
curl -X GET "http://localhost:5052/lighthouse/proto_array" -H "accept: application/json" | jq
```

*Example omitted for brevity.*

### `/lighthouse/validator_inclusion/{epoch}/{validator_id}`
## `/lighthouse/validator_inclusion/{epoch}/{validator_id}`

See [Validator Inclusion APIs](./validator-inclusion.md).

### `/lighthouse/validator_inclusion/{epoch}/global`
## `/lighthouse/validator_inclusion/{epoch}/global`

See [Validator Inclusion APIs](./validator-inclusion.md).

### `/lighthouse/eth1/syncing`
## `/lighthouse/eth1/syncing`

Returns information regarding execution layer, as it is required for use in
consensus layer

#### Fields
### Fields

- `head_block_number`, `head_block_timestamp`: the block number and timestamp
from the very head of the execution chain. Useful for understanding the immediate
Expand All @@ -383,7 +383,7 @@ number and timestamp of the latest block we have in our block cache.
`eth1_node_sync_status_percentage < 100.0` since the cache only cares
about blocks a certain distance behind the head.

#### Example
### Example

```bash
curl -X GET "http://localhost:5052/lighthouse/eth1/syncing" -H "accept: application/json" | jq
Expand All @@ -403,11 +403,11 @@ curl -X GET "http://localhost:5052/lighthouse/eth1/syncing" -H "accept: applica
}
```

### `/lighthouse/eth1/block_cache`
## `/lighthouse/eth1/block_cache`

Returns a list of all the execution layer blocks in the execution client voting cache.

#### Example
### Example

```bash
curl -X GET "http://localhost:5052/lighthouse/eth1/block_cache" -H "accept: application/json" | jq
Expand All @@ -434,11 +434,11 @@ curl -X GET "http://localhost:5052/lighthouse/eth1/block_cache" -H "accept: app
}
```

### `/lighthouse/eth1/deposit_cache`
## `/lighthouse/eth1/deposit_cache`

Returns a list of all cached logs from the deposit contract.

#### Example
### Example

```bash
curl -X GET "http://localhost:5052/lighthouse/eth1/deposit_cache" -H "accept: application/json" | jq
Expand Down Expand Up @@ -473,7 +473,7 @@ curl -X GET "http://localhost:5052/lighthouse/eth1/deposit_cache" -H "accept: a
}
```

### `/lighthouse/liveness`
## `/lighthouse/liveness`

POST request that checks if any of the given validators have attested in the given epoch. Returns a list
of objects, each including the validator index, epoch, and `is_live` status of a requested validator.
Expand All @@ -498,7 +498,7 @@ curl -X POST "http://localhost:5052/lighthouse/liveness" -d '{"indices":["0","1"
}
```

### `/lighthouse/database/info`
## `/lighthouse/database/info`

Information about the database's split point and anchor info.

Expand Down Expand Up @@ -548,7 +548,7 @@ reconstruction has yet to be completed. For more information
on the specific meanings of these fields see the docs on [Checkpoint
Sync](./checkpoint-sync.md#reconstructing-states).

### `/lighthouse/merge_readiness`
## `/lighthouse/merge_readiness`

Returns the current difficulty and terminal total difficulty of the network. Before [The Merge](https://ethereum.org/en/roadmap/merge/) on 15<sup>th</sup> September 2022, you will see that the current difficulty is less than the terminal total difficulty, An example is shown below:

Expand Down Expand Up @@ -582,7 +582,7 @@ As all testnets and Mainnet have been merged, both values will be the same after
}
```

### `/lighthouse/analysis/attestation_performance/{index}`
## `/lighthouse/analysis/attestation_performance/{index}`

Fetch information about the attestation performance of a validator index or all validators for a
range of consecutive epochs.
Expand Down Expand Up @@ -660,7 +660,7 @@ Caveats:
This is because the state *prior* to the `start_epoch` needs to be loaded from the database,
and loading a state on a boundary is most efficient.

### `/lighthouse/analysis/block_rewards`
## `/lighthouse/analysis/block_rewards`

Fetch information about the block rewards paid to proposers for a range of consecutive blocks.

Expand Down Expand Up @@ -714,7 +714,7 @@ Caveats:
[block_reward_src]:
https://github.com/sigp/lighthouse/tree/unstable/common/eth2/src/lighthouse/block_rewards.rs

### `/lighthouse/analysis/block_packing`
## `/lighthouse/analysis/block_packing`

Fetch information about the block packing efficiency of blocks for a range of consecutive
epochs.
Expand Down Expand Up @@ -756,7 +756,7 @@ Caveats:
This is because the state *prior* to the `start_epoch` needs to be loaded from the database, and
loading a state on a boundary is most efficient.

### `/lighthouse/logs`
## `/lighthouse/logs`

This is a Server Side Event subscription endpoint. This allows a user to read
the Lighthouse logs directly from the HTTP API endpoint. This currently
Expand Down Expand Up @@ -785,7 +785,7 @@ Should provide an output that emits log events as they occur:
}
```

### `/lighthouse/nat`
## `/lighthouse/nat`

Checks if the ports are open.

Expand Down
12 changes: 6 additions & 6 deletions book/src/graffiti.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Lighthouse provides four options for setting validator graffiti.

### 1. Using the "--graffiti-file" flag on the validator client
## 1. Using the "--graffiti-file" flag on the validator client

Users can specify a file with the `--graffiti-file` flag. This option is useful for dynamically changing graffitis for various use cases (e.g. drawing on the beaconcha.in graffiti wall). This file is loaded once on startup and reloaded everytime a validator is chosen to propose a block.

Expand All @@ -28,7 +28,7 @@ default: Lighthouse

Lighthouse will first search for the graffiti corresponding to the public key of the proposing validator, if there are no matches for the public key, then it uses the graffiti corresponding to the default key if present.

### 2. Setting the graffiti in the `validator_definitions.yml`
## 2. Setting the graffiti in the `validator_definitions.yml`

Users can set validator specific graffitis in `validator_definitions.yml` with the `graffiti` key. This option is recommended for static setups where the graffitis won't change on every new block proposal.

Expand All @@ -52,13 +52,13 @@ Below is an example of the validator_definitions.yml with validator specific gra
graffiti: "somethingprofound"
```

### 3. Using the "--graffiti" flag on the validator client
## 3. Using the "--graffiti" flag on the validator client

Users can specify a common graffiti for all their validators using the `--graffiti` flag on the validator client.

Usage: `lighthouse vc --graffiti example`

### 4. Using the "--graffiti" flag on the beacon node
## 4. Using the "--graffiti" flag on the beacon node

Users can also specify a common graffiti using the `--graffiti` flag on the beacon node as a common graffiti for all validators.

Expand All @@ -72,15 +72,15 @@ Usage: `lighthouse bn --graffiti fortytwo`
> 4. If the `--graffiti` flag on the validator client is not passed, load the graffiti passed in the `--graffiti` flag on the beacon node.
> 4. If the `--graffiti` flag is not passed, load the default Lighthouse graffiti.
### Set Graffiti via HTTP
## Set Graffiti via HTTP

Use the [Lighthouse API](api-vc-endpoints.md) to set graffiti on a per-validator basis. This method updates the graffiti
both in memory and in the `validator_definitions.yml` file. The new graffiti will be used in the next block proposal
without requiring a validator client restart.

Refer to [Lighthouse API](api-vc-endpoints.html#patch-lighthousevalidatorsvoting_pubkey) for API specification.

#### Example Command
### Example Command

```bash
DATADIR=/var/lib/lighthouse
Expand Down
6 changes: 3 additions & 3 deletions book/src/homebrew.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Lighthouse is available on Linux and macOS via the [Homebrew package manager](ht
Please note that this installation method is maintained by the Homebrew community.
It is not officially supported by the Lighthouse team.

### Installation
## Installation

Install the latest version of the [`lighthouse`][formula] formula with:

```bash
brew install lighthouse
```

### Usage
## Usage

If Homebrew is installed to your `PATH` (default), simply run:

Expand All @@ -27,7 +27,7 @@ Alternatively, you can find the `lighthouse` binary at:
"$(brew --prefix)/bin/lighthouse" --help
```

### Maintenance
## Maintenance

The [formula][] is kept up-to-date by the Homebrew community and a bot that lists for new releases.

Expand Down
Loading

0 comments on commit d3a3076

Please sign in to comment.