From 0d001495d551a8873523b5d0ca31dcd94631b700 Mon Sep 17 00:00:00 2001 From: Honza Date: Fri, 8 Sep 2023 20:28:49 +0200 Subject: [PATCH] Documentation update --- CHANGELOG.md | 2 +- README.md | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1258256c..01350cc7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # Change Log ## Unreleased -- `CompactBlockProcessor` now processes compact blocks from the lightwalletd server with spend-before-sync algorithm +- `CompactBlockProcessor` now processes compact blocks from the lightwalletd server with **Spend-before-Sync** algorithm (i.e. non-linear order). This feature shortens the time after which a wallet's spendable balance can be used. - The block synchronization mechanism is about one-third faster thanks to the optimized `CompactBlockProcessor.SYNC_BATCH_SIZE`. Issue **#1206**. diff --git a/README.md b/README.md index b41ecd0a..f02c0803 100644 --- a/README.md +++ b/README.md @@ -56,5 +56,6 @@ Note that we aim for the main branch of this repository to be stable and releasa ## Unstable Features ### Spend-before-Sync compact blocks synchronization algorithm -- CompactBlockProcessor now processes compact blocks from the lightwalletd server in the **spend-before-sync** order. This -feature shortens the time after which a wallet's spendable balance can be used. Please note that this new block synchronization algorithm is still under development. +`CompactBlockProcessor` now processes compact blocks from the lightwalletd server in non-linear order with the +**Spend-before-Sync** algorithm. This feature speeds up discovering the wallet's spendable balance. Please note that +this new block synchronization algorithm is still under development.