From 1f375d3fbc8e9b11e4670ba125e107b96377c29f Mon Sep 17 00:00:00 2001
From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
Date: Mon, 19 Aug 2024 11:44:18 -0400
Subject: [PATCH] Add experimental feature
Signed-off-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com>
---
.../private-networks/reference/cli/options.md | 49 +++++++++++++++++++
1 file changed, 49 insertions(+)
diff --git a/docs/private-networks/reference/cli/options.md b/docs/private-networks/reference/cli/options.md
index 24ba7ff03a4..2299fdcda35 100644
--- a/docs/private-networks/reference/cli/options.md
+++ b/docs/private-networks/reference/cli/options.md
@@ -904,6 +904,55 @@ privacy-url="http://127.0.0.1:8888"
The URL on which the [Tessera node](../../tutorials/privacy/index.md#3-create-tessera-configuration-files) is running.
+### `Xsnapsync-bft-enabled`
+
+:::caution
+This is an experimental feature. It is not stable and is not fully supported in all versions of Besu. Use this option with caution.
+:::
+
+
+
+
+```bash
+--Xsnapsync-bft-enabled[=]
+```
+
+
+
+
+```bash
+--Xsnapsync-bft-enabled=true
+```
+
+
+
+
+```bash
+BESU_XSNAPSYNC_BFT_ENABLED=true
+```
+
+
+
+
+```bash
+Xsnapsync-bft-enabled=true
+```
+
+
+
+
+Enables or disables snap synchronization for networks using BFT consensus mechanisms such as [IBFT 2.0](../../how-to/configure/consensus/ibft) or [QBFT](../../how-to/configure/consensus/qbft). The default is `false`.
+
+When enabled, this option allows Besu to use snap sync on BFT networks. Use this option in combination with the `--sync-mode=SNAP` option.
+
+Example usage:
+
+```bash
+besu --network= --sync-mode=SNAP --Xsnapsync-bft-enabled=true
+```
+
+This option is primarily intended for use in private, permissioned networks that employ BFT consensus mechanisms.
+
[accounts permissions configuration file]: ../../how-to/use-permissioning/local.md#permissions-configuration-file