Skip to content

Commit

Permalink
docs(config): clarify ReproviderStrategy roots
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel authored and hacdias committed Jan 12, 2024
1 parent 75f3c10 commit 9343a95
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -1467,6 +1467,13 @@ Tells reprovider what should be announced. Valid strategies are:
- `"all"` - announce all CIDs of stored blocks
- `"pinned"` - only announce pinned CIDs recursively (both roots and child blocks)
- `"roots"` - only announce the root block of explicitly pinned CIDs
- **⚠️ BE CAREFUL:** node with `roots` strategy will not announce child blocks.
It makes sense only for use cases where the entire DAG is fetched in full,
and a graceful resume does not have to be guaranteed: the lack of child
announcements means an interrupted retrieval won't be able to find
providers for the missing block in the middle of a file, unless the peer
happens to already be connected to a provider and ask for child CID over
bitswap.

Default: `"all"`

Expand Down

0 comments on commit 9343a95

Please sign in to comment.