-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Write witness caches when writing the best block #1904
Write witness caches when writing the best block #1904
Conversation
For steady-state operation, this reduces the average time between wallet disk writes from once per block to once per hour. On -rescan, witness caches are only written out at the end along with the best block, increasing speed while ensuring that on-disk state is kept consistent. Witness caches are now never recreated during a -reindex, on the assumption that the blocks themselves are not changing (the chain is just being reconstructed), and so the witnesses will remain valid. Part of zcash#1749.
Running tests to check for anything missed. @zkbot try |
☀️ Test successful - zcash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments based on PR from pairing. Now that user has confirmed speed-up, these comments may become stale as PR is updated.
BerkeleyDB does support nested transactions e.g dbenv->txn_begin(parentTxn...
, so we could create a parent transaction with two child transactions, one for best block, the other for witness cache. However, upstream API does not support parent transactions, so current approach works fine.
Document that SetBestChain() now does two things:
- Saves location of best block to disk
- Saves witness cache to disk
Do we still need the template for testing, can we move WriteWitnessCache to .cpp?
Can we have a better (easier to read) name than SetBestChainINTERNAL e.g. SetBestChain_internal or something else entirely?
Document why ClearNoteWitnessCache() has been removed.
Also confirm and document what happens if -reindex and -rescan are interrupted, whether cleanly via ctrl-c, or kill -9. Will the witness cache still be consistent?
Done.
Still necessary (for the now-named
I was following existing conventions (
Is the documentation in the commit message sufficient?
If With
|
ACK |
^-- |
Yes, typo. |
ACK (note: i'm currently in the middle of yet another -reindex which should take ~45-60 mins to complete as it doesn't have the verifyjoinsplit checkpoint patch applied) |
Temporary NACK - investigating an issue. |
ACK
|
@str4d @ebfull Temporary NACK.
debug.log:
|
It looks like your local blockchain captured an orphan - neat! It then gets replayed as you reindex:
I've also figured out the bug: when I added support for incrementing new notes on rescan (in #1400), I conditionally ignored notes that had already been witnessed above the current height (for efficiency). I neglected to add a similar conditional for decrementing, which at the time was fine, because:
With this PR, witnesses are no longer cleared on reindex, and combined with the fact that orphans get replayed, this means that I need to implement the corresponding conditional in |
Checked out PR, -reindex works, does not trigger assertion. |
@ebfull could you please re-review to update your ACK? |
reACK, thanks @str4d and @bitcartel! @zkbot r+ |
📌 Commit 9d2cc3a has been approved by |
… r=ebfull Write witness caches when writing the best block For steady-state operation, this reduces the average time between wallet disk writes from once per block to once per hour. On -rescan, witness caches are only written out at the end along with the best block, increasing speed while ensuring that on-disk state is kept consistent. Witness caches are now never recreated during a -reindex, on the assumption that the blocks themselves are not changing (the chain is just being reconstructed), and so the witnesses will remain valid. Part of #1749.
☀️ Test successful - zcash |
The second assertion being triggered is fixed in #1933. |
Fixes the bug resulting from zcash#1904.
Only increment new notes on reindex Addresses another issue in #1904. When an existing one of our notes was found again, its cache was reset and it was re-witnessed. This would cause encountered notes to get out-of-sync with the otherwise-ignored newer notes, which could be a problem if the wallet data happens to be written out during a reindex.
* Add getlocalsolps and getnetworksolps RPC calls, show them in getmininginfo * Add benchmark for attempting decryption of notes * Add benchmark for incrementing note witnesses * Add -metricsui flag to toggle between persistent screen and rolling metrics Defaults to true if stdout is a TTY, else false. * Add -metricsrefreshtime option * Only show metrics by default if stdout is a TTY * Document metrics screen options * Fix stale comment referencing upstream block interval * Add checkpoint at block height 15000 * Added mainnet, testnet, and onion nodes * Make command line option to show all debugging consistent with similar options Most people expect a value of 1 to enable all for command line arguments. However to do this for the -debug option you must type "-debug=". This has been changed to allow "-debug=1" as well as "-debug=" to enable all debug logging * Update documentation to match the zcash#4219 change * Update help message to match the zcash#4219 change * Clarify that metrics options are only useful without -daemon and -printtoconsole * Increase length of metrics divider * Closes zcash#1857. Fixes bug where tx spending only notes had priority of 0. * Closes zcash#1901. Increase default settings for the max block size when mining and the amount of space available for priority transactions. * Write witness caches when writing the best block For steady-state operation, this reduces the average time between wallet disk writes from once per block to once per hour. On -rescan, witness caches are only written out at the end along with the best block, increasing speed while ensuring that on-disk state is kept consistent. Witness caches are now never recreated during a -reindex, on the assumption that the blocks themselves are not changing (the chain is just being reconstructed), and so the witnesses will remain valid. Part of zcash#1749. * Add porter dev overrides for CC, CXX, MAKE, BUILD, HOST * Apply miniupnpc patches to enable compilation on Solaris 11 These can be removed after the next MiniUPnP release. Closes zcash#1835. * Closes zcash#1903. Add fee parameter to z_sendmany. * Add an upstream miniupnpc patch revision * Metrics - Don't exclaim unless > 1 "You have validated 0 transactions!" sounds a little less enthusiastic that intended. Also, only says "1 transaction". * Address review comments, tweak strings * bash-completion: Adapt for 0.12 and 0.13 * separate completion for bitcoind and bitcoin-cli * remove RPC support from bitcoind completion * add completion for bitcoin-tx and bitcoin-qt * rely on autoloading of completions * Change function names to not clash with Bitcoin, apply to correct binaries * Add bash completion files to Debian package * Always bash-complete the default account * Add Zcash RPC commands to CLI argument completion * Fixes zcash#1823. Witness anchors for input notes no longer cross block boundaries. * Edit for grammar: "block chain" At this point, I believe it is universally accepted that "blockchain" is one word, and should not be separated into two. * Increase timeout as laptops on battery power have cpu throttling. * Isolate verification to a `ProofVerifier` context object that allows verification behavior to be tuned by the caller. * Regression test. * Ensure cache contains valid entry when anchor is popped. * Ensure ProofVerifier cannot be accidentally copied. * Document behaviour of CWallet::SetBestChain * WitnessAnchorData only needs to store one witness per JSOutPoint. * Rename Dummy to Disabled. * Add more tests for ProofVerifier. * Fix indentation * Generate JS for trydecryptnotes, make number of addresses a variable * Add JS to second block to ensure witnesses are incremented * ASSERT_TRUE -> ASSERT_FALSE * Skip JoinSplit verification before the last checkpoint Part of zcash#1749 * Gather release notes from previous release to HEAD Also update release-process.md to replace git shortlog command with release-notes.py script. * Add a reindex test that fails because of a bug in decrementing witness caches Ref: zcash#1904 (comment) * Make the test pass by fixing the bug! * Only check cache validity for witnesses being incremented or decremented Fixes the bug resulting from zcash#1904. * Check that E' points are actually in G2 by ensuring they are of order r. * Fix bug in wallet tests * Extract block-generation wallet test code into a function * Rewrite reindex test to check beyond the max witness cache size * Fix bug in IncrementNoteWitness() * Update payment API docs to recommend -rescan for fixing witness errors * Update version to 1.0.4 * Update man pages * Release notes, authors, changelog * Update seed nodes * Bugfix #14 - getblocksubsidy RPC command is incorrect
* Add getlocalsolps and getnetworksolps RPC calls, show them in getmininginfo * Add benchmark for attempting decryption of notes * Add benchmark for incrementing note witnesses * Add -metricsui flag to toggle between persistent screen and rolling metrics Defaults to true if stdout is a TTY, else false. * Add -metricsrefreshtime option * Only show metrics by default if stdout is a TTY * Document metrics screen options * Fix stale comment referencing upstream block interval * Add checkpoint at block height 15000 * Make command line option to show all debugging consistent with similar options Most people expect a value of 1 to enable all for command line arguments. However to do this for the -debug option you must type "-debug=". This has been changed to allow "-debug=1" as well as "-debug=" to enable all debug logging * Update documentation to match the zcash#4219 change * Update help message to match the zcash#4219 change * Clarify that metrics options are only useful without -daemon and -printtoconsole * Increase length of metrics divider * Closes zcash#1857. Fixes bug where tx spending only notes had priority of 0. * Closes zcash#1901. Increase default settings for the max block size when mining and the amount of space available for priority transactions. * Write witness caches when writing the best block For steady-state operation, this reduces the average time between wallet disk writes from once per block to once per hour. On -rescan, witness caches are only written out at the end along with the best block, increasing speed while ensuring that on-disk state is kept consistent. Witness caches are now never recreated during a -reindex, on the assumption that the blocks themselves are not changing (the chain is just being reconstructed), and so the witnesses will remain valid. Part of zcash#1749. * Add porter dev overrides for CC, CXX, MAKE, BUILD, HOST * Apply miniupnpc patches to enable compilation on Solaris 11 These can be removed after the next MiniUPnP release. Closes zcash#1835. * Closes zcash#1903. Add fee parameter to z_sendmany. * Add an upstream miniupnpc patch revision * Metrics - Don't exclaim unless > 1 "You have validated 0 transactions!" sounds a little less enthusiastic that intended. Also, only says "1 transaction". * Address review comments, tweak strings * bash-completion: Adapt for 0.12 and 0.13 * separate completion for bitcoind and bitcoin-cli * remove RPC support from bitcoind completion * add completion for bitcoin-tx and bitcoin-qt * rely on autoloading of completions * Change function names to not clash with Bitcoin, apply to correct binaries * Add bash completion files to Debian package * Always bash-complete the default account * Add Zcash RPC commands to CLI argument completion * Fixes zcash#1823. Witness anchors for input notes no longer cross block boundaries. * Edit for grammar: "block chain" At this point, I believe it is universally accepted that "blockchain" is one word, and should not be separated into two. * Increase timeout as laptops on battery power have cpu throttling. * Isolate verification to a `ProofVerifier` context object that allows verification behavior to be tuned by the caller. * Regression test. * Ensure cache contains valid entry when anchor is popped. * Ensure ProofVerifier cannot be accidentally copied. * Document behaviour of CWallet::SetBestChain * WitnessAnchorData only needs to store one witness per JSOutPoint. * Rename Dummy to Disabled. * Add more tests for ProofVerifier. * Fix indentation * Generate JS for trydecryptnotes, make number of addresses a variable * Add JS to second block to ensure witnesses are incremented * ASSERT_TRUE -> ASSERT_FALSE * Skip JoinSplit verification before the last checkpoint Part of zcash#1749 * Gather release notes from previous release to HEAD Also update release-process.md to replace git shortlog command with release-notes.py script. * Add a reindex test that fails because of a bug in decrementing witness caches Ref: zcash#1904 (comment) * Make the test pass by fixing the bug! * Only check cache validity for witnesses being incremented or decremented Fixes the bug resulting from zcash#1904. * Update release process to check in with users who opened resolved issues * Check that E' points are actually in G2 by ensuring they are of order r. * Fix bug in wallet tests * Extract block-generation wallet test code into a function * Rewrite reindex test to check beyond the max witness cache size * Fix bug in IncrementNoteWitness() * Extend createjoinsplit to benchmark parallel JoinSplits Closes zcash#1940 * Update payment API docs to recommend -rescan for fixing witness errors * Add total number of commitments to getblockchaininfo * Update version to 1.0.4 * Update man pages * Release notes, authors, changelog * Only enable getblocktemplate when wallet is enabled * Only run wallet tests when wallet is enabled * Add a tool for profiling the creation of JoinSplits * Add test for IncrementalMerkleTree::size(). * Exclude test binaries from make install Closes zcash#1943. * Fixes zcash#1964 to catch general exception in z_sendmany and catch exceptions as reference-to-const. * Fixes zcash#1967 by adding age of note to z_sendmany logging. * Scan the whole chain whenever a z-key is imported Closes zcash#1941. * Instruct users to run zcash-fetch-params if network params aren't available Closes zcash#1786. * Fixes a bug where the unsigned transaction was logged by z_sendmany after a successful sign and send, meaning that the logged hash fragment would be different from the txid logged by "AddToWallet". This issue occured when sending from transparent addresses, as utxo inputs must be signed. It did not occur when sending from shielded addresses. * Trigger metrics UI refresh on new messages * Strip out the SECURE flag in metrics UI so message style is detected * Add 'CreateJoinSplit' standalone utility to gitignore. * Handle newlines in UI messages * Suggest ./zcutil/fetch-params.sh as well Once we improve the from-source installation docs to use 'make install', we can revert this commit. * Update debug categories Closes zcash#1954. * CreateJoinSplit: add start_profiling() call This solves the problem of profiling output displaying nonsensical large time values. * rpc: Implement random-cookie based authentication When no `-rpcpassword` is specified, use a special 'cookie' file for authentication. This file is generated with random content when the daemon starts, and deleted when it exits. Read access to this file controls who can access through RPC. By default this file is stored in the data directory but it be overriden with `-rpccookiefile`. This is similar to Tor CookieAuthentication: see https://www.torproject.org/docs/tor-manual.html.en Alternative to zcash#6258. Like that pull, this allows running bitcoind without any manual configuration. However, daemons should ideally never write to their configuration files, so I prefer this solution. * Rename build-aux/m4/bitcoin_find_bdb48.m4 to remove version Closes zcash#1622. * Bump COPYRIGHT_YEAR from 2016 to 2017. * Throw an error if zcash.conf is missing An empty zcash.conf is sufficient to bypass this error. * Show a friendly message explaining why zcashd needs a zcash.conf * Closes zcash#1780. Result of z_getoperationstatus now sorted by creation time of operation * Create ISSUE_TEMPLATE.md * move template to subdirectory, fix typo, include prompt under describing issue section, include uploading file directly to github ticket as option for sharing logs * Remove UTF-8 BOM efbbbf from zcash.conf to avoid problems with command line tools * Closes zcash#1097 so zcash-cli now displays license info like zcashd. LicenseInfo is refactored from init.cpp to util.cpp so that the bitcoin-cli makefile target does not need to be modified. * Fixes zcash#1497 ZCA-009 by restricting data exporting to user defined folder. Previously the RPC interface allowed z_exportwallet, backupwallet and dumpwallet to write data to an arbitrary filename. ZCA-009 demonstrates how this is vulnerable. The resolution is to only allow data to written when the -exportdir has been configured. Also filenames are restricted to alphanumeric characters. * Closes zcash#1957 by adding tx serialization size to listtransactions output. * Fix gtest ordering broken by zcash#1949 Part of zcash#1539 * Fixes zcash#1960: z_getoperationstatus/result now includes operation details. * Debian package lint - Tweak description synopsis to make Debian happy - Put bash completion files in correct directory - Add a manpage for zcash-fetch-params * Generate Debian control file to fix shlibs lint * Create empty zcash.conf during performance measurements * Create empty zcash.conf during coverage checks Fixes regression caused by zcash#2013. * Coverage build system tweaks * Update walletbackup.py qa test to use -exportdir option * Add missing header required by std::accumulate * Increase timeout for z_sendmany transaction in wallet.py qa test * Add test for z_importkey rescanning from beginning of chain. * Bump version to 1.0.5. * Update release notes and Debian package. * V1.0.4 mac (#51) * initial mac version of zclassic Work in progress - 15JAN2017 more refactoring linux refactoring fixes osx refactoring fixes initial win64 commit fixup! initial win64 commit compile libsnark with posix threads build gtest and gmock with posix Working build fixup! Working build * Windows and Linux builds ok * fixup! Merge tag 'v1.0.5' into v1.0.5-multios * fixup! fixup! Merge tag 'v1.0.5' into v1.0.5-multios * fixup! fixup! fixup! Merge tag 'v1.0.5' into v1.0.5-multios * Fix OSX compatibility with depends * OSX Compat - Fix site_t ambiguity in json * fixup! OSX Compat - Fix site_t ambiguity in json
For steady-state operation, this reduces the average time between wallet disk
writes from once per block to once per hour.
On -rescan, witness caches are only written out at the end along with the best
block, increasing speed while ensuring that on-disk state is kept consistent.
Witness caches are now never recreated during a -reindex, on the assumption that
the blocks themselves are not changing (the chain is just being reconstructed),
and so the witnesses will remain valid.
Part of #1749.