Focus Doxygen documentation #7
Open
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
When forced to deal with an untrusted node, a wallet will quantize its current height to disguise the real height to the adversary, to try and minimize the daemon's ability to distinguish returning wallets. Daemons will thus return more blocks than the wallet needs, starting from earlier in the chain. These extra blocks will be disregarded by the wallet, which had already scanned them. However, for the purposes of reorg size detection, the wallet assumes all blocks the daemon sends are different, which is only correct if the wallet hasn't been coy, which is only the case for trusted daemons (which you should use). This causes an issue when the size of this "fake reorg" is above the sanity check threshold at which the wallet refuses a reorg. To fix this, the reorg size check is moved later on, when the reorg is about to actually happen, after the wallet has checked which blocks are actually different from the ones it expects.
There are vulnerabilities in multisig protocol if the parties do not trust each other, and while there is a patch for it, it has not been throroughly reviewed yet, so it is felt safer to disable multisig by default for now. If all parties in a multisig setup trust each other, then it is safe to enable multisig.
As of OpenSSL 3.0, `SHA256_Init`, `SHA256_Update`, and `SHA256_Final` are deprectaed in favor of the higher-level `EVP_*` class of functions. This causes compiler warnings, and sooner or later, will cause build errors as these functions are excluded from distro headers. Also add some documentation.
026dbc8 Windows build: fix narrowing error for WaitForSingleObject (Jeffrey Ryan)
Remade monero-project#8270 (includes edits from UkoeHB)
af08c83 utils: delete outdated windows build script (selsta)
bae4a1a Don't send peerlist larger than max allowed (j-berman)
62914e7 Ignore gitian build files (Jeffrey Ryan)
b9d2c78 fix backoff delay logic when re-relaying txs (j-berman)
2979474 disable multisig by default (moneromooo-monero)
2dab31f Don't exclusively drop tor/i2p outgoing cxns in idle loop (j-berman)
fde7c96 wallet2: fix spurious reorg detection with untrusted nodes (moneromooo-monero)
1164874 src, epee: fix a couple compiler warnings (selsta)
5858f05 GCC: Fix -Wstringop-overflow= warnings (Jeffrey Ryan)
Unlike some other warnings, clang does not have a `stringop-overflow` group so it doesn't recognize the `#pragma GCC ...` directive in monero-project#8338
…nconfirmed unconfirmed solely uses a - b, and received now accepts b so it can provide more detailed logs on what occurred (printing a - b, yet with a and b).
Autodetects that a block device is being used.
Use mmap to read and initialize the meta pages, raw device may not support read/write syscalls.
Rename the "build-macos" job within "depends", as it is not building on macOS as the similarly named job within build.yml does. Also, both names overlap which is confusing when looking for step-by-step build instruction examples or when looking at the logfile.
Fish shell completions for monerod, monero-wallet-cli, and monero-wallet-rpc.
ade464a ITS#9385 fix using MDB_NOSUBDIR with nonexistent file (Kris Zyp) 033a32a Remove check is_directory check on lmdb path (Howard Chu) b096e16 Revert 'db_lmdb: test for mmap support at init time' (Howard Chu) 493577a Silence spurious fallthru warning (Howard Chu) b46a60e Fix rawpart flag collision (Howard Chu) 4e7586c More RAWPART support (Howard Chu) 747f5d3 Preliminary raw partition support (Howard Chu)
61d0712 Gitian: refresh the stale Monero dir via --setup switch (mj-xmr)
de2f0d0 wallet_api: add scanTransactions function (selsta)
bc05d2d README.md: Add v15/v16 network upgrade (garth-xmr)
fb3f7ce clang warning fix for monero-project#8338 (Jeffrey Ryan)
8460fcc Revert 'Merge pull request monero-project#7937' (j-berman)
04c0da2 Chunk /gettransactions to avoid hitting restricted RPC limit (tobtoht)
d486c03 utils: add fish shell completions (Leo Nerone)
41b1a6b simplewallet: print usage when given no args (hinto.janaiyo)
4278a3a cryptonote_basic: catch crypto api errors (moneromooo-monero)
6f3abbe Depends: Unbound disable getentropy()/reallocarray() (glibc < 2.26) (TheCharlatan)
50ccc7e wallet2: remove obsolete rpc version check (tobtoht)
09a597b wallet2: don't use DNS to obtain segregation heights (tobtoht)
83aa817 (fix): Confusingly named CI-Job (Klaus Frank)
8e9c60a README: depends has only been tested on ubuntu 18.04 and 20.04 (selsta)
Right now Doxygen is documenting everything in the repo including submodules, everything in contrib, util, tests, etc. This bogs down the documentation to the point where it is very hard to navigate. I think it would be a good move to focus on documenting only the main C++ code which is specific to this repo. Right now this means documenting `src/` (without SUPERCOP), `contrib/epee/`, `external/easylogging++`. After this commit, Doxygen went from running >6000 graphs to about 2200 graphs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
13 participants
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.
Right now Doxygen is documenting everything in the repo including submodules, everything in contrib,
util, tests, etc. This bogs down the documentation to the point where it is very hard to navigate. I think
it would be a good move to focus on documenting only the main C++ code which is specific to this repo.
Right now this means documenting
src/(without SUPERCOP) andcontrib/epee/. After this commit,Doxygen went from running >6000 graphs to about 2200 graphs.