mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-19 13:35:17 +01:00
Code Issues Projects Releases Packages Wiki Activity

Small cleanups on the chain docs (#2515)

Browse source 
* Small cleanups on the chain docs

* Remove extra whitespace
This commit is contained in:
Chris Stewart 2021-01-18 11:32:03 -06:00 • committed by GitHub
parent 1903ee30b0
commit e44a620ea1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/chain/filter-sync.md
View file

@ -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 rpc is implemented there. You need to make sure bitcoind is started with the `-blockfilterindex` flag. This makes it
so we can query filters. 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. #### Abstract idea of syncing filters.
Our internal infrastructure depends on one function to be implemented to be able to sync 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 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 your headers are synced before you can sync filters, so make sure that you are calling `ChainSync.sync()` before syncing
filters. filters.