From e44a620ea1aa4de47cdbbe74bb3f35522bd3a9a8 Mon Sep 17 00:00:00 2001 From: Chris Stewart Date: Mon, 18 Jan 2021 11:32:03 -0600 Subject: [PATCH] Small cleanups on the chain docs (#2515) * Small cleanups on the chain docs * Remove extra whitespace --- docs/chain/filter-sync.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/chain/filter-sync.md b/docs/chain/filter-sync.md index 51f3ffb361..f945d030e2 100644 --- a/docs/chain/filter-sync.md +++ b/docs/chain/filter-sync.md @@ -13,6 +13,8 @@ that the bitcoind version you are using is >= `v19` as the [`getblockfilter`](ht rpc is implemented there. You need to make sure bitcoind is started with the `-blockfilterindex` flag. This makes it so we can query filters. +> It is important to remember that you need fully synced block headers before you can sync filter headers and filters. Please see [the chain docs](chain.md) for syncing block headers. + #### Abstract idea of syncing filters. Our internal infrastructure depends on one function to be implemented to be able to sync filters. @@ -124,6 +126,8 @@ resultF.onComplete { _ => Yay! Now we have synced block filters from an external data source. If you want to repeatedly sync you can just call -`FilterSync.syncFilters(syncedFiltersChainApi,getFilterFunc)` every time you would like to sync. Again, you need to ensure +`FilterSync.syncFilters(syncedFiltersChainApi,getFilterFunc)` every time you would like to sync. + +Again, you need to ensure your headers are synced before you can sync filters, so make sure that you are calling `ChainSync.sync()` before syncing filters. \ No newline at end of file