multi: Update outdated IBD refs to inital chain sync. #3490
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrick
approved these changes
Jun 3, 2025
matheusd
approved these changes
Jun 3, 2025
This updates the help text for the initialblockdownload field of the getblockchaininfo RPC to more accurately refer to the initial chain sync mode that it represents since what was previously the initial block download no longer applies and hasn't for a very long time. Historically, initial block download consisted of downloading all blocks one-by-one in a linear fashion and only storing them once they had been fully verified, so the terminology of initial block download accurately described the process. However, the logic related to initial chain syncing was changed long ago to a much more efficient and robust approach based on downloading the headers first and then using those to guide the sync process. The RPC field name was not updated to avoid breaking the API, but its meaning changed and this updates the text accordingly.
This updates the description of the initialblockdownload field to more accurately refer to the initial chain sync mode that it represents.
davecgh
force-pushed
the
multi_consistent_initial_chain_sync
branch
from
080de83 to
3339a78
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Historically, initial block download consisted of downloading all blocks one-by-one in a linear fashion and only storing them once they had been fully verified, so the terminology of initial block download accurately described the process.
However, the logic related to initial chain syncing was changed long ago to a much more efficient and robust approach based on downloading the headers first and then using those to guide the sync process.
This updates the remaining references in the code to more accurately refer to the initial chain sync process/mode accordingly.
The following is an overview of the changes:
initialblockdownloadfield of thegetblockchaininfoRPC to refer to the initial chain sync modepeer,blockchain, andnetsync