Skip to content

Commit 1cce8ca

Browse files
committed
Add instructions for headerssync-params.py to release-process.md
1 parent 8fb0458 commit 1cce8ca

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/release-process.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ Release Process
4343
- On mainnet, the selected value must not be orphaned, so it may be useful to set the height two blocks back from the tip.
4444
- Testnet should be set with a height some tens of thousands back from the tip, due to reorgs there.
4545
- `nMinimumChainWork` with the "chainwork" value of RPC `getblockheader` using the same height as that selected for the previous step.
46+
* Consider updating the headers synchronization tuning parameters to account for the chainparams updates.
47+
The optimal values change very slowly, so this isn't strictly necessary every release, but doing so doesn't hurt.
48+
- Update configuration variables in [`contrib/devtools/headerssync-params.py`](contrib/devtools/headerssync-params.py):
49+
- Set `TIME` to a reasonable time the software is expected to work well, for example the expected release data plus 3 years.
50+
- Set `MINCHAINWORK_HEADERS` to the height used for the `nMinimumChainWork` calculation above.
51+
- Check that the other variables still look reasonable.
52+
- Run the script. It works fine in CPython, but PyPy is much faster (seconds instead of minutes): `pypy3 contrib/devtools/headerssync-params.py`.
53+
- Paste the output defining `HEADER_COMMITMENT_INTERVAL` and `REDOWNLOAD_BUFFER_SIZE` into the top of [`src/headerssync.cpp`](/src/headerssync.cpp).
4654
- Clear the release notes and move them to the wiki (see "Write the release notes" below).
4755
- Translations on Transifex:
4856
- Pull translations from Transifex into the master branch.

0 commit comments

Comments
 (0)