highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-01-19 06:43:45 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
65526fc8666fef35ef908dbc225f706bef642c7e
bitcoin/src
History
MarcoFalke 65526fc866 Merge #15777: [docs] Add doxygen comments for keypool classes 
f1a77b0c51 [docs] Add doxygen comment for CReserveKey (John Newbery)
37796b2dd4 [docs] Add doxygen comment for CKeyPool (John Newbery)
ef2d515af3 [wallet] move-only: move CReserveKey to be next to CKeyPool (John Newbery)

Pull request description:

  Docs/move-only

  Adds doxygen comments for the CKeyPool and CReserveKey objects. The way these work is pretty confusing and it's easy to overlook details (eg https://github.com/bitcoin/bitcoin/pull/15557#discussion_r271956393).

  These are on the verbose side, but I think too much commenting is better than not enough. Happy to take feedback on what's an appropriate level.

ACKs for commit f1a77b:
  jonatack:
    Thanks, John. Re-ACK f1a77b0c51, doc-only changes with respect to previous review.
  jb55:
    ACK f1a77b0c51

Tree-SHA512: 8bc97c7029cd2e8d9bfd2d2144eeff73474c71eda5a9d10817e1578ca0b70da677252037d83143faaff1808e2193408a21a8a89d36049eac77fd313990f0b67b
2019-05-14 09:16:33 -04:00
..
bench
[refactor] interfaces: Add missing LockAnnotation for cs_main
2019-05-13 14:46:01 -04:00
compat
Document assumptions about C++ compiler
2019-03-05 11:19:32 +01:00
config
…
consensus
Separate reason for premature spends (coinbase/locktime)
2019-05-02 15:30:58 -04:00
crypto
Merge #15512: Add ChaCha20 encryption option (XOR)
2019-05-10 09:26:23 +02:00
index
scripted-diff: replace chainActive -> ::ChainActive()
2019-05-03 15:02:54 -04:00
interfaces
[refactor] interfaces: Add missing LockAnnotation for cs_main
2019-05-13 14:46:01 -04:00
leveldb
Pull leveldb subtree
2019-01-26 12:45:48 -05:00
node
[build] Move AnalyzePSBT from psbt.cpp to node/psbt.cpp
2019-04-09 17:53:08 -04:00
obj
…
obj-test
…
policy
scripted-diff: replace chainActive -> ::ChainActive()
2019-05-03 15:02:54 -04:00
primitives
Merge #14039: Disallow extended encoding for non-witness transactions
2019-04-25 14:15:43 -04:00
qt
[refactor] interfaces: Add missing LockAnnotation for cs_main
2019-05-13 14:46:01 -04:00
rpc
Merge #14802: rpc: faster getblockstats using BlockUndo data
2019-05-10 13:20:48 -04:00
script
Merge #15452: Replace CScriptID and CKeyID in CTxDestination with dedicated types
2019-05-09 18:54:43 +02:00
secp256k1
Bump secp256k1 subtree
2017-09-29 16:02:39 +02:00
support
windows: Set _WIN32_WINNT to 0x0601 (Windows 7)
2019-01-23 16:28:27 +08:00
test
Merge #15988: Add test for ArgsManager::GetChainName
2019-05-14 08:53:37 -04:00
univalue
Update univalue subtree
2018-09-07 08:21:14 -04:00
util
Merge #15650: Handle the result of posix_fallocate system call
2019-05-02 08:43:57 -04:00
wallet
Merge #15777: [docs] Add doxygen comments for keypool classes
2019-05-14 09:16:33 -04:00
zmq
RPCHelpMan: Pass through Result and Examples
2019-01-25 14:16:07 -05:00
.clang-format
Fix inconsistent namespace formatting guidelines
2018-04-13 15:37:20 -04:00
addrdb.cpp
banman: pass the banfile path in
2019-01-16 13:54:18 -05:00
addrdb.h
banman: Add, use CBanEntry ctor that takes ban reason
2019-01-16 13:54:18 -05:00
addrman.cpp
[addrman] Improve collision logging and address nits
2019-03-01 16:15:50 -05:00
addrman.h
[addrman] Ensure collisions eventually get resolved
2019-02-27 16:53:44 -05:00
amount.h
Update copyright headers to 2018
2018-12-29 10:15:01 +01:00
arith_uint256.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
arith_uint256.h
Use std::numeric_limits<UNSIGNED>::max()) instead of (UNSIGNED)-1
2018-12-04 19:55:04 +02:00
attributes.h
Add NODISCARD to all {Decode,Parse}[...](...) functions returning bool. Sort includes.
2018-11-05 17:03:11 +01:00
banman.cpp
Allow connections from misbehavior banned peers.
2019-01-22 21:10:48 +00:00
banman.h
Allow connections from misbehavior banned peers.
2019-01-22 21:10:48 +00:00
base58.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
base58.h
Add NODISCARD to all {Decode,Parse}[...](...) functions returning bool. Sort includes.
2018-11-05 17:03:11 +01:00
bech32.cpp
Make objects in range declarations immutable by default. Avoid unnecessary copying of objects in range declarations.
2018-08-27 18:19:33 +02:00
bech32.h
Fix missing or inconsistent include guards
2018-03-22 16:23:04 +01:00
bitcoin-cli-res.rc
…
bitcoin-cli.cpp
Merge #15564: cli: remove duplicate wallet fields from -getinfo
2019-03-11 10:28:42 -04:00
bitcoin-tx-res.rc
…
bitcoin-tx.cpp
Replace CScriptID and CKeyID in CTxDestination with dedicated types
2019-04-29 10:15:23 -04:00
bitcoin-wallet-res.rc
[tools] Add wallet inspection and modification tool
2019-01-30 16:26:52 -05:00
bitcoin-wallet.cpp
util: Add SetupHelpOptions()
2019-02-06 14:16:43 -05:00
bitcoind-res.rc
…
bitcoind.cpp
threads: introduce util/threadnames, refactor thread naming
2019-04-29 13:42:25 -04:00
blockencodings.cpp
CorruptionPossible -> BLOCK_MUTATED
2019-05-02 15:14:12 -04:00
blockencodings.h
disallow oversized CBlockHeaderAndShortTxIDs
2018-11-13 12:41:41 -08:00
blockfilter.cpp
init: Add CLI option to enable block filter index.
2019-04-06 12:10:55 -07:00
blockfilter.h
init: Add CLI option to enable block filter index.
2019-04-06 12:10:55 -07:00
bloom.cpp
Merge #13429: Return the script type from Solver
2018-08-25 17:41:00 +02:00
bloom.h
Removes unsed CBloomFilter constructor.
2018-08-13 01:24:55 +02:00
chain.cpp
refactor: combine Chain::findFirstBlockWithTime/findFirstBlockWithTimeAndHeight
2019-03-27 18:29:48 -04:00
chain.h
refactor: combine Chain::findFirstBlockWithTime/findFirstBlockWithTimeAndHeight
2019-03-27 18:29:48 -04:00
chainparams.cpp
Update assumevalid, minimumchainwork, and getchaintxstats to height 563378.
2019-02-17 03:38:08 +00:00
chainparams.h
implements different disk sizes for different networks on intro
2018-10-07 13:11:36 +01:00
chainparamsbase.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
chainparamsbase.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
chainparamsseeds.h
net: Update hardcoded seeds
2018-08-13 13:57:15 +02:00
checkqueue.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
clientversion.cpp
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
clientversion.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
coins.cpp
Extract CSipHasher to it's own file in crypto/ directory.
2018-11-05 09:25:15 -08:00
coins.h
Merge #15267: doc: explain AcceptToMemoryPoolWorker's coins_to_uncache
2019-04-26 13:09:30 -04:00
compat.h
windows: Set _WIN32_WINNT to 0x0601 (Windows 7)
2019-01-23 16:28:27 +08:00
compressor.cpp
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
compressor.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
core_io.h
Move PSBT decoding functions from core_io to psbt.cpp
2019-03-26 17:38:00 -07:00
core_memusage.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
core_read.cpp
Move PSBT decoding functions from core_io to psbt.cpp
2019-03-26 17:38:00 -07:00
core_write.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
cuckoocache.h
Make objects in range declarations immutable by default. Avoid unnecessary copying of objects in range declarations.
2018-08-27 18:19:33 +02:00
dbwrapper.cpp
Replace deprecated Boost Filesystem function
2019-04-30 10:05:54 +03:00
dbwrapper.h
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
dummywallet.cpp
Bugfix: dummywallet: Add -ignorepartialspends to list of ignored wallet options
2019-04-28 04:42:38 +00:00
flatfile.cpp
Style cleanup.
2019-02-22 17:38:45 -08:00
flatfile.h
Style cleanup.
2019-02-22 17:38:45 -08:00
fs.cpp
Avoid redefine warning
2019-04-10 12:16:52 +01:00
fs.h
Replace deprecated Boost Filesystem function
2019-04-30 10:05:54 +03:00
hash.cpp
Extract CSipHasher to it's own file in crypto/ directory.
2018-11-05 09:25:15 -08:00
hash.h
Merge #13258: uint256: Remove unnecessary crypto/common.h dependency
2018-11-30 18:48:58 +01:00
httprpc.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
httprpc.h
Cleanup StartRest()
2018-08-11 09:34:47 +03:00
httpserver.cpp
threads: introduce util/threadnames, refactor thread naming
2019-04-29 13:42:25 -04:00
httpserver.h
[build] Add several util units
2019-04-09 17:53:08 -04:00
indirectmap.h
…
init.cpp
Merge #14364: doc: Clarify -blocksdir usage
2019-05-13 12:46:03 -04:00
init.h
Pass chain and client variables where needed
2018-11-06 11:44:40 -04:00
key_io.cpp
Replace CScriptID and CKeyID in CTxDestination with dedicated types
2019-04-29 10:15:23 -04:00
key_io.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
key.cpp
Fix assertion in CKey::SignCompact
2019-01-31 15:00:56 +00:00
key.h
convert C-style (void) parameter lists to C++ style ()
2018-09-13 10:36:41 -07:00
keystore.cpp
Replace CScriptID and CKeyID in CTxDestination with dedicated types
2019-04-29 10:15:23 -04:00
keystore.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
limitedmap.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
logging.cpp
threads: prefix log messages with thread names
2019-04-29 13:49:15 -04:00
logging.h
threads: prefix log messages with thread names
2019-04-29 13:49:15 -04:00
Makefile.am
Merge #15849: Thread names in logs and deadlock debug tools
2019-04-30 15:26:01 -04:00
Makefile.bench.include
Merge #15512: Add ChaCha20 encryption option (XOR)
2019-05-10 09:26:23 +02:00
Makefile.leveldb.include
build: Remove WINVER pre define in Makefile.leveldb.inlcude
2019-01-26 09:28:48 +08:00
Makefile.qt.include
GUI: Move QRImageWidget to its own file-pair
2019-05-02 12:18:18 +00:00
Makefile.qttest.include
scripted-diff: Rename test_bitcoin to test/setup_common
2019-04-11 10:12:36 -04:00
Makefile.test.include
tests: add threadutil tests
2019-04-29 13:43:01 -04:00
memusage.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
merkleblock.cpp
Replace use of BEGIN and END macros on uint256
2019-01-10 01:58:33 +01:00
merkleblock.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
miner.cpp
scripted-diff: replace chainActive -> ::ChainActive()
2019-05-03 15:02:54 -04:00
miner.h
[rpc] mining: Omit uninitialized currentblockweight, currentblocktx
2019-02-12 11:34:57 -05:00
net_processing.cpp
Merge #15948: refactor: rename chainActive
2019-05-07 11:51:30 -04:00
net_processing.h
banman: create and split out banman
2019-01-16 13:54:18 -05:00
net.cpp
net: Remove unused unsanitized user agent string CNode::strSubVer
2019-03-23 11:32:40 -04:00
net.h
Merge #15654: net: Remove unused unsanitized user agent string CNode::strSubVer
2019-04-04 16:45:23 -04:00
netaddress.cpp
docs: Improve netaddress comments
2019-04-10 11:48:47 -04:00
netaddress.h
docs: Improve netaddress comments
2019-04-10 11:48:47 -04:00
netbase.cpp
Drop defunct Windows compat fixes
2019-01-24 15:58:49 -08:00
netbase.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
netmessagemaker.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
noui.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
noui.h
Update copyright headers to 2018
2018-12-29 10:15:01 +01:00
optional.h
Remove 'boost::optional'-related gcc warnings
2019-01-30 22:44:28 +02:00
outputtype.cpp
Replace CScriptID and CKeyID in CTxDestination with dedicated types
2019-04-29 10:15:23 -04:00
outputtype.h
Add NODISCARD to all {Decode,Parse}[...](...) functions returning bool. Sort includes.
2018-11-05 17:03:11 +01:00
pow.cpp
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
pow.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
prevector.h
Merge #14266: refactor: Lift prevector default vals to the member declaration
2019-05-06 15:32:24 -04:00
protocol.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
protocol.h
Use C++11 default member initializers
2019-01-05 16:16:37 +01:00
psbt.cpp
Silence GCC 7 warning "control reaches end of non-void function" (-Wreturn-type) in psbt.cpp
2019-05-02 15:08:22 +02:00
psbt.h
[build] Move AnalyzePSBT from psbt.cpp to node/psbt.cpp
2019-04-09 17:53:08 -04:00
pubkey.cpp
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
pubkey.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
random.cpp
Add ChaCha20 encryption option (XOR)
2019-05-03 20:31:18 +02:00
random.h
Add ChaCha20 encryption option (XOR)
2019-05-03 20:31:18 +02:00
rest.cpp
scripted-diff: replace chainActive -> ::ChainActive()
2019-05-03 15:02:54 -04:00
reverse_iterator.h
scripted-diff: Remove trailing whitespaces
2018-07-24 20:46:23 +01:00
reverselock.h
…
scheduler.cpp
Switch all RNG code to the built-in PRNG.
2019-01-16 16:34:56 -08:00
scheduler.h
trivial: correct parameter name in comments
2019-02-10 17:17:32 -05:00
serialize.h
serialize: Serialization support for big-endian 32-bit ints.
2019-04-06 12:03:21 -07:00
shutdown.cpp
Break circular dependency: init -> * -> init by extracting shutdown.h
2018-06-25 00:08:49 -04:00
shutdown.h
Break circular dependency: init -> * -> init by extracting shutdown.h
2018-06-25 00:08:49 -04:00
span.h
Add more methods to Span class
2018-07-27 11:52:18 -07:00
streams.h
Trivial: Doxygenize existing CBufferedFile and VectorReader comments
2019-01-25 12:32:37 -08:00
sync.cpp
threads: add thread names to deadlock debugging message
2019-04-29 13:51:59 -04:00
sync.h
Add WITH_LOCK macro: run code while locking a mutex
2019-04-20 08:13:34 -04:00
threadinterrupt.cpp
Merge #11640: Make LOCK, LOCK2, TRY_LOCK work with CWaitableCriticalSection
2018-08-31 16:00:38 +02:00
threadinterrupt.h
Update copyright headers to 2018
2018-12-29 10:15:01 +01:00
threadsafety.h
Pass chain locked variables where needed
2018-11-06 11:44:40 -04:00
timedata.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
timedata.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
tinyformat.h
Fix typos
2018-03-21 08:34:44 +02:00
torcontrol.cpp
Drop IsLimited in favor of IsReachable
2019-01-13 22:50:36 -08:00
torcontrol.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
txdb.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
txdb.h
init: Add CLI option to enable block filter index.
2019-04-06 12:10:55 -07:00
txmempool.cpp
Merge #15323: rpc: Expose g_is_mempool_loaded via getmempoolinfo
2019-05-01 10:06:15 -04:00
txmempool.h
scripted-diff: replace chainActive -> ::ChainActive()
2019-05-03 15:02:54 -04:00
ui_interface.cpp
Merge #15699: Remove no-op CClientUIInterface::[signal_name]_disconnect. Disconnect BlockNotifyGenesisWait and RPCNotifyBlockChange properly.
2019-04-23 13:03:41 -04:00
ui_interface.h
Merge #15699: Remove no-op CClientUIInterface::[signal_name]_disconnect. Disconnect BlockNotifyGenesisWait and RPCNotifyBlockChange properly.
2019-04-23 13:03:41 -04:00
uint256.cpp
util: Make ToLower and ToUpper take a char
2019-01-10 02:51:14 +01:00
uint256.h
uint256: Remove unnecessary crypto/common.h use
2018-09-18 14:27:05 +09:00
undo.h
Extract CSipHasher to it's own file in crypto/ directory.
2018-11-05 09:25:15 -08:00
validation.cpp
[refactor] interfaces: Add missing LockAnnotation for cs_main
2019-05-13 14:46:01 -04:00
validation.h
[refactor] interfaces: Add missing LockAnnotation for cs_main
2019-05-13 14:46:01 -04:00
validationinterface.cpp
[wallet] Schedule tx rebroadcasts in wallet
2019-04-09 10:38:13 -04:00
validationinterface.h
[cleanup] Remove unused CReserveKey
2019-04-10 11:44:40 -04:00
version.h
Update copyright headers to 2018
2018-07-27 07:15:02 -04:00
versionbits.cpp
MOVEONLY: Move versionbits info out of versionbits.o
2018-09-23 22:55:11 +02:00
versionbits.h
MOVEONLY: Move versionbits info out of versionbits.o
2018-09-23 22:55:11 +02:00
versionbitsinfo.cpp
MOVEONLY: Move versionbits info out of versionbits.o
2018-09-23 22:55:11 +02:00
versionbitsinfo.h
MOVEONLY: Move versionbits info out of versionbits.o
2018-09-23 22:55:11 +02:00
walletinitinterface.h
Remove direct node->wallet calls in init.cpp
2018-11-06 11:44:40 -04:00
warnings.cpp
scripted-diff: Move util files to separate directory.
2018-11-04 22:46:07 -08:00
warnings.h
Merge #13780: 0.17: Pre-branch maintenance
2018-08-08 13:55:27 +02:00