Skip to content

Commit c618eb1

Browse files
author
Alexandra Tran
committed
Merge branch 'main' of github.com:hyperledger/besu-docs
2 parents 6c2361b + cd1c52d commit c618eb1

File tree

6 files changed

+84
-45
lines changed

6 files changed

+84
-45
lines changed

docs/private-networks/concepts/node-sync-private.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,9 @@ To sync Besu on a private network:
2222
The following is an overview of the private network sync modes.
2323
Select the sync mode based on your network's requirements and node purposes.
2424

25-
| Sync mode | Description | Requirements | Limitations |
26-
|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-------------|
27-
| [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 and reconstructs the trie locally. Faster than fast sync. | Besu version 24.3.0 or later | Cannot switch from fast sync to snap sync mid-process. |
25+
| Sync mode | Description | Requirements | Limitations |
26+
|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------------------------------------------------------|
27+
| [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 and reconstructs the trie locally. Faster than fast sync. | Besu version 24.3.0 or later | Cannot switch from fast sync to snap sync mid-process. |
2828
| [Checkpoint](../../public-networks/concepts/node-sync.md#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 | Not supported for QBFT or IBFT 2.0 networks without a checkpoint configuration. |
29-
| [Fast](../../public-networks/concepts/node-sync.md#fast-synchronization-deprecated) | Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Deprecated. Not supported with private transactions. |
30-
| [Full](../../public-networks/concepts/node-sync.md#full-synchronization) | Default for all private networks. 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. |
31-
32-
:::warning Early access feature
33-
34-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
35-
It is not stable, so use this option with caution.
36-
37-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.
38-
39-
:::
29+
| [Fast](../../public-networks/concepts/node-sync.md#fast-synchronization-deprecated) | Downloads block headers and transaction receipts, verifies chain from genesis block. | None | Deprecated. Not supported with private transactions. |
30+
| [Full](../../public-networks/concepts/node-sync.md#full-synchronization) | Default for all private networks. 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. |

docs/private-networks/concepts/permissioning/plugin.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ tags:
1010

1111
You can define complex [permissioning](index.md) solutions by building a plugin that extends Besu functionality.
1212

13-
The plugin API provides a `PermissioningService` interface that currently supports connection permissioning and message permissioning.
13+
The plugin API provides a `PermissioningService` interface that currently supports connection (node) permissioning, transaction permissioning and message permissioning.
1414

15-
## Connection permissioning
15+
## Connection (node) permissioning
1616

1717
Use connection permissioning when deciding whether to restrict node access to known participants only.
1818

19+
## Transaction permissioning
20+
21+
Use transaction permissioning when deciding whether to restrict transaction processing based on transaction properties.
22+
1923
## Message permissioning
2024

2125
Use message permissioning to propagate different types of devP2P messages to particular nodes. For example, this can be used to prevent pending transactions from being forwarded to other nodes.

docs/private-networks/how-to/configure/consensus/ibft.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,6 @@ You can use a plugin to securely store a validator's key using the [`--security-
3333

3434
:::
3535

36-
:::info Early access feature
37-
38-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
39-
It is not stable, so use this option with caution.
40-
41-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable
42-
[snap sync](../../../concepts/node-sync-private.md) in IBFT 2.0 networks.
43-
44-
:::
45-
4636
## Genesis file
4737

4838
To use IBFT 2.0, Besu requires an IBFT 2.0 [genesis file](../../../../public-networks/concepts/genesis-file.md). The genesis file defines properties specific to IBFT 2.0.

docs/private-networks/how-to/configure/consensus/qbft.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,6 @@ You can use a plugin to securely store a validator's key using the [`--security-
3333

3434
:::
3535

36-
:::info Early access feature
37-
38-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
39-
It is not stable, so use this option with caution.
40-
41-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable
42-
[snap sync](../../../concepts/node-sync-private.md) in QBFT networks.
43-
44-
:::
45-
4636
## Genesis file
4737

4838
To use QBFT, define a [genesis file](../../../../public-networks/concepts/genesis-file.md) that contains the QBFT properties.

docs/public-networks/reference/cli/options.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5802,15 +5802,6 @@ The synchronization mode. Use `SNAP` for [snap sync](../../concepts/node-sync.md
58025802

58035803
:::
58045804

5805-
:::warning Early access feature
5806-
5807-
`--Xsnapsync-bft-enabled` is an early access feature available in Besu version 24.7.1 and later.
5808-
It is not stable, so use this option with caution.
5809-
5810-
Use `--Xsnapsync-bft-enabled` with `--sync-mode=SNAP` to enable snap sync in QBFT and IBFT 2.0 private networks.
5811-
5812-
:::
5813-
58145805
### `target-gas-limit`
58155806

58165807
<Tabs>

docs/public-networks/reference/cli/subcommands.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,79 @@ You can configure the retention limit using [`--bonsai-historical-block-limit`](
449449
The retention limit should match the configuration used with [`--bonsai-limit-trie-logs-enabled`](options.md#bonsai-limit-trie-logs-enabled).
450450
The default limit is `512`.
451451

452+
#### `export`
453+
454+
<Tabs>
455+
456+
<TabItem value="Syntax" label="Syntax" default>
457+
458+
```bash
459+
besu --config-file <PATH-TO-CONFIG-FILE> storage trie-log export [--trie-log-block-hash=<list>] [--trie-log-file-path=<file>]
460+
```
461+
462+
</TabItem>
463+
464+
<TabItem value="Example exporting single trie log">
465+
466+
```bash
467+
besu --config-file config.toml storage trie-log export --trie-log-block-hash=0x0dcfa528de7d12df63673d0ebbd103dbf3a9464fae7eeb89e0934678cd05d64b
468+
```
469+
470+
:::note
471+
This example exports the trie log corresponding to a particular block hash into a file in the default location, `<data-dir>/trie-logs.bin`.
472+
:::
473+
474+
</TabItem>
475+
476+
<TabItem value="Example exporting list">
477+
478+
```bash
479+
besu --config-file config.toml storage trie-log export --trie-log-file-path=/tmp/list_of_trielogs.bin --trie-log-block-hash=0x0dcfa528de7d12df63673d0ebbd103dbf3a9464fae7eeb89e0934678cd05d64b,0xe8c3e77a6eaf6c87552aee07b86ecf4aacba43650b1d6aac32a44fa3ca97780d,0x86df7008b32fee67baac103846931c58454fc1b391e7d826c4886ba8580ba169
480+
```
481+
482+
:::note
483+
This example exports trie logs corresponding to a list of block hashes into a specific file location.
484+
:::
485+
486+
</TabItem>
487+
488+
</Tabs>
489+
490+
Exports the trie logs of blocks specified by hash to a binary file.
491+
492+
By default, Bonsai trie logs are regularly pruned, so the trie log for a given block might not be present if it has been pruned.
493+
If you need to manually import or export trie logs, we recommend temporarily disabling trie log pruning by setting
494+
[`--bonsai-limit-trie-logs-enabled`](options.md#bonsai-limit-trie-logs-enabled) to `false`.
495+
496+
#### `import`
497+
498+
<Tabs>
499+
500+
<TabItem value="Syntax" label="Syntax" default>
501+
502+
```bash
503+
besu --config-file <PATH-TO-CONFIG-FILE> storage trie-log import [--trie-log-file-path=<file>]
504+
```
505+
506+
</TabItem>
507+
508+
<TabItem value="Example">
509+
510+
```bash
511+
besu --config-file config.toml storage trie-log import --trie-log-file-path=/tmp/list_of_trielogs.bin
512+
```
513+
514+
</TabItem>
515+
516+
</Tabs>
517+
518+
Imports trie logs from a binary trie log export file.
519+
520+
By default, Bonsai trie logs are regularly pruned.
521+
If pruning is enabled, Besu might subsequently prune the imported trie logs.
522+
If you need to manually import or export trie logs, we recommend temporarily disabling trie log pruning by setting
523+
[`--bonsai-limit-trie-logs-enabled`](options.md#bonsai-limit-trie-logs-enabled) to `false`.
524+
452525
## `validate-config`
453526

454527
<Tabs>

0 commit comments

Comments
 (0)