Skip to content

Commit 91ef7b2

Browse files
authored
docs: add optional chainstore fallback section
Add documentation for the FOREST_ENABLE_CHAINSTORE_FALLBACK environment variable and describe how to enable the fallback blockstore via Bitswap. Part of issue #6353.
1 parent 019b1af commit 91ef7b2

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,19 @@ Have questions? Feel free to post them in [Forest Q&A]!
2929

3030
## Run with Docker
3131

32+
## Optional Chainstore Fallback
33+
34+
Forest supports an experimental fallback blockstore to fetch missing blocks from the network via Bitswap when they are not available locally. This behavior is disabled by default.
35+
36+
To enable fallback, set the environment variable:
37+
38+
FOREST_ENABLE_CHAINSTORE_FALLBACK=1
39+
40+
When enabled, Forest will attempt to retrieve missing blocks via Bitswap during chain sync. If the block is successfully retrieved, it will be stored locally and chain sync will continue. If the block cannot be fetched from the network, chain sync will return an error as usual.
41+
42+
Note: This feature is inspired by Lotus's `LOTUS_ENABLE_CHAINSTORE_FALLBACK` and is considered experimental. Use with caution in production.
43+
44+
3245
No need to install Rust toolchain or other dependencies, you will need only
3346
Docker - works on Linux, macOS and Windows.
3447

0 commit comments

Comments
 (0)