Skip to content

Commit

Permalink
update pages
Browse files Browse the repository at this point in the history
  • Loading branch information
joaniefromtheblock committed Sep 19, 2024
1 parent b941272 commit 01f300c
Show file tree
Hide file tree
Showing 10 changed files with 15,799 additions and 17 deletions.
10 changes: 5 additions & 5 deletions docs/public-networks/concepts/data-storage-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To run a node with Bonsai Tries data storage format, use the command line option
</p>

:::caution important
Do not run an [archive node](../get-started/connect/sync-node.md#run-an-archive-node) with Bonsai Tries.
Do not run an [archive node](#run-an-archive-node) with Bonsai Tries.
Bonsai is designed for retrieving recent data only.
:::

Expand All @@ -35,7 +35,7 @@ You can read more about Bonsai in [Consensys' Guide to Bonsai Tries](https://con

## Forest of Tries

Forest of Tries, also called forest mode, is another method of representing the world state, and is more suitable for [archive nodes](../get-started/connect/sync-node.md#run-an-archive-node).
Forest of Tries, also called forest mode, is another method of representing the world state, and is more suitable for [archive nodes](../../concepts/sync-node.md#run-an-archive-node).

In forest mode, each node in the trie is saved in a key-value store by hash. For each block, the world state is updated with new nodes, leaf nodes, and a new state root. Old leaf nodes remain in the underlying data store. Data is accessed and stored by hash, which increases the size of the database and increases the resources and time needed to access account data.

Expand All @@ -55,9 +55,9 @@ We recommend using [Bonsai Tries](#bonsai-tries) to save disk space.
### Storage requirements

Forest mode uses significantly more memory than Bonsai.
With a [full node](../get-started/connect/sync-node.md#run-a-full-node), forest mode uses an
With a [full node](../../concepts/sync-node.md#run-a-full-node), forest mode uses an
estimated 750 GB of storage, while Bonsai uses an estimated 650 GB of storage.
[Archive nodes](../get-started/connect/sync-node.md#run-an-archive-node) must use forest mode, which
[Archive nodes](../../concepts/sync-node.md#run-an-archive-node) must use forest mode, which
uses an estimated 12 TB of storage.

### Accessing data
Expand All @@ -74,7 +74,7 @@ Using `--bonsai-historical-block-limit` doesn't affect the size of the database

### Syncing nodes

The following table shows the ways you can [sync a full node](../get-started/connect/sync-node.md#run-a-full-node) with the different data storage formats using [fast](../get-started/connect/sync-node.md#fast-synchronization) and [snap](../get-started/connect/sync-node.md#snap-synchronization) sync.
The following table shows the ways you can [sync a full node](../../concepts/sync-node.md#run-a-full-node) with the different data storage formats using [fast](../../concepts/sync-node.md#fast-synchronization) and [snap](../../concepts/sync-node.md#snap-synchronization) sync.

| Data storage format | Sync mode | Storage estimate | Can other nodes sync to your node? |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/how-to/configure-besu/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ For example, extending the default configuration using the [staker profile](prof

|Configuration option|Default|Description|
|---------------------------|--------------------|------------------------------------------|
|[`sync-mode`](../../reference/cli/options.md#sync-mode)|`SNAP`|Besu syncs using [snap sync](../../get-started/connect/sync-node.md#snap-synchronization), the most time-efficient sync method.|
|[`sync-mode`](../../reference/cli/options.md#sync-mode)|`SNAP`|Besu syncs using [snap sync](../../concepts/sync-node.md#snap-synchronization), the most time-efficient sync method.|

:::note
You can see all default configuration values in the [configuration options reference](../../reference/cli/options.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/how-to/connect/manage-peers.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In detail, the P2P discovery process is as follows:
as network details, what the peer believes to be the current chain head, and its list of neighbors.
From this point on any traffic to that peer is only done using TCP.

5. Depending on the [synchronization method](../../get-started/connect/sync-node.md), a common block
5. Depending on the [synchronization method](../../../../concepts/connect/sync-node.md), a common block
(the pivot block) is selected that all connected peers (default of 5) have, and Besu syncs from
that block till it gets to chain head.
Log messages look like `Downloading world state from peers for pivot block .......`.
Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/how-to/monitor/understand-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

# Understand metrics

When running Besu on Ethereum Mainnet using [snap sync](../../get-started/connect/sync-node.md#snap-synchronization), you might notice graphical patterns that stand out in different metrics charts. These patterns are related to the [CPU usage](#cpu-usage) and [block time](#block-time) of the Besu sync process.
When running Besu on Ethereum Mainnet using [snap sync](../../../concepts/sync-node.md#snap-synchronization), you might notice graphical patterns that stand out in different metrics charts. These patterns are related to the [CPU usage](#cpu-usage) and [block time](#block-time) of the Besu sync process.

## CPU usage

Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/how-to/troubleshoot/peering.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ One or more of the following may be the cause:
- Your hardware doesn't have enough CPU, disk IOPS, or bandwidth to handle all the peers.
- Your ports aren't open in your firewall and/or router.
- Your node is sending large numbers of DNS requests. See [issue #4375](https://github.com/hyperledger/besu/issues/4375).
- You're using [checkpoint sync](../../get-started/connect/sync-node.md#checkpoint-synchronization), which doesn't download all historical block data, so your peers may disconnect you when fetching those blocks.
- You're using [checkpoint sync](../../concepts/sync-node.md#checkpoint-synchronization), which doesn't download all historical block data, so your peers may disconnect you when fetching those blocks.
- Your node is experiencing the normal behavior of peers connecting and disconnecting. This is especially normal soon after you start your node.

You can try the following to find more peers:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The ad-hoc tracing APIs are:
These APIs allow you to filter and search by specific information such as the block, address, or transaction. These APIs only use the [`trace` type](../../reference/trace-types.md#trace).

To use the transaction-trace filtering APIs, your node must be an
[archive node](../../get-started/connect/sync-node.md#run-an-archive-node), or the requested block
[archive node](../../concepts/sync-node.md#run-an-archive-node), or the requested block
or transaction must be within the number of
[blocks retained](../../reference/cli/options.md#bonsai-historical-block-limit) when using
[Bonsai Tries](../../concepts/data-storage-formats.md#bonsai-tries) (by default, 512 from the head
Expand Down
8 changes: 4 additions & 4 deletions docs/public-networks/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7131,7 +7131,7 @@ The `TRACE` API methods are not enabled by default for JSON-RPC. To enable the `
Provides transaction processing of [type `trace`](../trace-types.md#trace) for the specified block.
:::info note
Your node must be an [archive node](../../get-started/connect/sync-node.md#run-an-archive-node), or
Your node must be an [archive node](../../concepts/sync-node.md#run-an-archive-node), or
the requested block must be within the number of
[blocks retained](../cli/options.md#bonsai-historical-block-limit) when using
[Bonsai](../../concepts/data-storage-formats.md#bonsai-tries) (by default, 512 from the head of the chain).
Expand Down Expand Up @@ -7441,7 +7441,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"trace_callMany","params":[[[{"fr
Returns traces matching the specified filter. The maximum number of blocks you can supply to `trace_filter` is 1000 by default. You can adjust this limit using the [`--rpc-max-trace-filter-range`](../cli/options.md#rpc-max-trace-filter-range) option.
:::info note
Your node must be an [archive node](../../get-started/connect/sync-node.md#run-an-archive-node), or
Your node must be an [archive node](../../concepts/sync-node.md#run-an-archive-node), or
the requested blocks must be within the number of
[blocks retained](../cli/options.md#bonsai-historical-block-limit) when using
[Bonsai](../../concepts/data-storage-formats.md#bonsai-tries) (by default, 512 from the head of the chain).
Expand Down Expand Up @@ -7545,7 +7545,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"trace_filter","params":[{"fromBl
Returns a trace at the given position.
:::info note
Your node must be an [archive node](../../get-started/connect/sync-node.md#run-an-archive-node), or
Your node must be an [archive node](../../concepts/sync-node.md#run-an-archive-node), or
the requested transaction must be contained in a block within the number of
[blocks retained](../cli/options.md#bonsai-historical-block-limit) when using
[Bonsai](../../concepts/data-storage-formats.md#bonsai-tries) (by default, 512 from the head of the chain).
Expand Down Expand Up @@ -7822,7 +7822,7 @@ curl -X POST --data '{"jsonrpc": "2.0", "method": "trace_replayBlockTransactions
Provides transaction processing of [type `trace`](../trace-types.md#trace) for the specified transaction.
:::info note
Your node must be an [archive node](../../get-started/connect/sync-node.md#run-an-archive-node), or
Your node must be an [archive node](../../concepts/sync-node.md#run-an-archive-node), or
the requested transaction must be contained in a block within the number of
[blocks retained](../cli/options.md#bonsai-historical-block-limit) when using
[Bonsai](../../concepts/data-storage-formats.md#bonsai-tries) (by default, 512 from the head of the chain).
Expand Down
4 changes: 2 additions & 2 deletions docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -5029,7 +5029,7 @@ sync-min-peers=8

</Tabs>

The minimum number of peers required before starting [sync](../../get-started/connect/sync-node.md). The default is `5`. Set to `1` to enable static peers to contribute to the initial sync.
The minimum number of peers required before starting [sync](../../concepts/sync-node.md). The default is `5`. Set to `1` to enable static peers to contribute to the initial sync.

:::info

Expand Down Expand Up @@ -5075,7 +5075,7 @@ sync-mode="SNAP"

</Tabs>

The synchronization mode. Use `SNAP` for [snap sync](../../get-started/connect/sync-node.md#snap-synchronization), `CHECKPOINT` for [checkpoint sync](../../get-started/connect/sync-node.md#checkpoint-synchronization), `FAST` for [fast sync](../../get-started/connect/sync-node.md#fast-synchronization), and `FULL` for [full sync](../../get-started/connect/sync-node.md#run-an-archive-node).
The synchronization mode. Use `SNAP` for [snap sync](../../concepts/sync-node.md#snap-synchronization), `CHECKPOINT` for [checkpoint sync](../../concepts/sync-node.md#checkpoint-synchronization), `FAST` for [fast sync](../../concepts/sync-node.md#fast-synchronization), and `FULL` for [full sync](../../concepts/sync-node.md#run-an-archive-node).

- The default is `FULL` when connecting to a private network by not using the [`--network`](#network) option and specifying the [`--genesis-file`](#genesis-file) option.
- The default is `SNAP` when using the [`--network`](#network) option with named networks, except for the `dev` development network. `SNAP` is also the default if running Besu on the default network (Ethereum Mainnet) by specifying neither [network](#network) nor [genesis file](#genesis-file).
Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/tutorials/besu-teku-mainnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Specify:

Also, in the command:

- [`--sync-mode`](../reference/cli/options.md#sync-mode) specifies using [snap sync](../get-started/connect/sync-node.md#snap-synchronization).
- [`--sync-mode`](../reference/cli/options.md#sync-mode) specifies using [snap sync](../concepts/sync-node.md#snap-synchronization).
- [`--data-storage-format`](../reference/cli/options.md#data-storage-format) specifies using [Bonsai Tries](../concepts/data-storage-formats.md#bonsai-tries).
- [`--rpc-http-enabled`](../reference/cli/options.md#rpc-http-enabled) enables the HTTP JSON-RPC service.
- [`--engine-rpc-enabled`](../reference/cli/options.md#engine-rpc-enabled) enables the [Engine API](../reference/engine-api/index.md).
Expand Down
Loading

0 comments on commit 01f300c

Please sign in to comment.