Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alexandra Carrillo <[email protected]>
Signed-off-by: Joan E <[email protected]>
  • Loading branch information
joaniefromtheblock and alexandratran authored Oct 4, 2024
1 parent 7186885 commit 9d62ee0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 12 deletions.
12 changes: 4 additions & 8 deletions docs/private-networks/concepts/node-sync-private.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,18 @@ To sync Besu on a private network:

:::warning Early access feature

`--Xsnapsync-bft-enabled` is an early access feature available since the release of Besu version 24.7.1.
It is not stable and is not fully supported in all versions of Besu.
Use this option with caution.
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
It is not stable, so use this option with caution.

Use `--Xsnapsync-bft-enabled` in private, permissioned networks that use BFT consensus mechanisms.
When enabled, this option allows Besu to use Snap sync on BFT networks.
Use this option in combination with the `--sync-mode=SNAP` option.
The default is `false`.
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.

:::

Choose the appropriate sync mode based on your private network's requirements and node purposes.

| Sync mode | Description | Requirements | Limitations |
|-----------|-------------|--------------|-------------|
| [Snap](../../public-networks/concepts/node-sync.md#snap-synchronization) | Recommended for fastest sync and lowest storage requirements on Mainnet. Downloads as many leaves of the trie as possible, reconstructs the trie locally. Faster than Fast sync. | Available as an _early access feature_ in Besu version 24.7.1 or later | Cannot switch from fast sync to snap sync mid-process. |
| [Snap](../../public-networks/concepts/node-sync.md#snap-synchronization) | Recommended for fastest sync and lowest storage requirements on Mainnet. Downloads as many leaves of the trie as possible, reconstructs the trie locally. Faster than fast sync. | Available as an _early access feature_ in Besu version 24.7.1 or later | Cannot switch from fast sync to snap sync mid-process. |
| [Checkpoint](../../public-networks/concepts/node-sync.md#checkpoint-synchronization) | Efficient sync from a specific checkpoint block configured in the genesis file. Syncs from a checkpoint block defined in the genesis file. Is the fastest sync and has the lowest storage requirements. | Besu version 22.4.3 or later | Not supported for QBFT or IBFT 2.0 networks without a checkpoint configuration. |
| [Fast](../../public-networks/concepts/node-sync.md#fast-synchronization) | Default for named networks except the dev development network. Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Not supported with private transactions. |
| [Full](../../public-networks/concepts/node-sync.md#run-an-archive-node) | Downloads and verifies the entire blockchain and state from the genesis block. This builds an archive node, with full state history. Downloads entire blockchain, verifies all states from genesis block. | None | Slowest sync mode, requires the most disk space. |
Expand Down
8 changes: 4 additions & 4 deletions docs/public-networks/concepts/node-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ For public networks, Besu offers the following sync modes:

| Sync mode | Description | Requirements | Limitations |
|-----------|-------------|--------------|-------------|
| [Snap](#snap-synchronization) | Default for Mainnet. Efficient sync from genesis block, downloading as many trie leaves as possible and reconstructing locally. Faster than Fast sync. | Besu version 22.4.0 or later | Cannot switch from fast sync to snap sync mid-process. |
| [Snap](#snap-synchronization) | Default for Mainnet. Efficient sync from genesis block, downloading as many trie leaves as possible and reconstructing locally. Faster than fast sync. | Besu version 22.4.0 or later | Cannot switch from fast sync to snap sync mid-process. |
| [Checkpoint](#checkpoint-synchronization) | Syncs from a specific checkpoint block configured in the genesis file. Fastest sync mode with lowest storage requirements. | Besu version 22.4.3 or later | |
| [Fast](#fast-synchronization) | Default for named networks except dev. Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Might become impossible to sync Ethereum Mainnet in the future. |
| [Fast](#fast-synchronization) | Default for named networks except `dev`. Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Might become impossible to fast sync Ethereum Mainnet in the future. |
| [Full](#run-an-archive-node) | Downloads and verifies the entire blockchain and state from genesis block, building an archive node with full state history. | None | Slowest sync mode, requires the most disk space. |

:::tip
Expand All @@ -51,14 +51,14 @@ We recommend snap sync because it follows the Ethereum specification and enables
:::note

Ethereum nodes sync two types of data: chain data (blocks) and world state data (account storage).
snap and checkpoint syncs handle chain data similarly to fast sync, but differ in how they process world state data.
Snap and checkpoint syncs handle chain data similarly to fast sync, but differ in how they process world state data.

:::

:::note Private network syncing

Private networks can use the same sync methods as public networks, but might require different configurations.
See [Private network syncing](../../private-networks/concepts/node-sync-private.md) for more information.
See [Node synchronization for private networks](../../private-networks/concepts/node-sync-private.md) for more information.

:::

Expand Down

0 comments on commit 9d62ee0

Please sign in to comment.