doc: followups to #26471 #26991

willcl-ark commented at 11:12 AM on January 30, 2023: contributor

Fix syntax error and specify NetPermissionFlags for whitelisted tx relay

doc: Fix comment syntax error e325e0fccb

DrahtBot commented at 11:12 AM on January 30, 2023: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	w0xlt

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

DrahtBot renamed this:
~~doc: followups to #26471~~
doc: followups to #26471
on Jan 30, 2023

DrahtBot added the label Docs on Jan 30, 2023

doc: NetPermissionFlags for tx relay in blocksonly

Detail which permission type enables transaction relay for nodes
connected in blockonly mode

47c174d8ce

in doc/reduce-memory.md:21 in 4b6080cd84 outdated

  17 | @@ -18,7 +18,7 @@ The size of some in-memory caches can be reduced. As caches trade off memory usa
  18 |  
  19 |  - Since `0.14.0`, unused memory allocated to the mempool (default: 300MB) is shared with the UTXO cache, so when trying to reduce memory usage you should limit the mempool, with the `-maxmempool` command line argument.
  20 |  
  21 | -- To disable most of the mempool functionality there is the `-blocksonly` option. This will reduce the default memory usage to 5MB and make the client opt out of receiving (and thus relaying) transactions, except from whitelisted peers and as part of blocks.
  22 | +- To disable most of the mempool functionality there is the `-blocksonly` option. This will reduce the default memory usage to 5MB and make the client opt out of receiving (and thus relaying) transactions, except from peers who have `NetpermissionFlags::Relay` set (e.g. whitelisted peers), and as part of blocks.

maflcko commented at 11:16 AM on January 30, 2023:

nit: Might be good to use the value referred to by the RPC or manpage, not the internal fragile symbol name

willcl-ark commented at 11:23 AM on January 30, 2023:

OK I switched to the RPC permission.

willcl-ark force-pushed on Jan 30, 2023

in doc/reduce-memory.md:21 in 47c174d8ce

  17 | @@ -18,7 +18,7 @@ The size of some in-memory caches can be reduced. As caches trade off memory usa
  18 |  
  19 |  - Since `0.14.0`, unused memory allocated to the mempool (default: 300MB) is shared with the UTXO cache, so when trying to reduce memory usage you should limit the mempool, with the `-maxmempool` command line argument.
  20 |  
  21 | -- To disable most of the mempool functionality there is the `-blocksonly` option. This will reduce the default memory usage to 5MB and make the client opt out of receiving (and thus relaying) transactions, except from whitelisted peers and as part of blocks.
  22 | +- To disable most of the mempool functionality there is the `-blocksonly` option. This will reduce the default memory usage to 5MB and make the client opt out of receiving (and thus relaying) transactions, except from peers who have the `relay` permission set (e.g. whitelisted peers), and as part of blocks.

jonatack commented at 3:48 PM on January 30, 2023:

The `-blocksonly` configuration option reduces the default mempool memory usage from 300MB to 5MB, as it makes bitcoind opt out of receiving and relaying transactions except (a) as part of blocks and (b) from peers who have the `relay` permission set (e.g. whitelisted peers). These allow for a smaller mempool and lower default memory allocation.

Suggest beginning with the memory usage that relates to this document and dropping the "disable mempool functionality" part in favor of concretely stating what the config option does and how that allows for a smaller default mempool size.

glozow commented at 5:25 PM on January 30, 2023:

This helps explain the motivation for developers, but for a user, there is no cause and effect relationship between what transactions might be relayed and what the default maximum capacity is.

jonatack commented at 5:40 PM on January 30, 2023:

I think there is a clear relationship between fewer transactions to relay and less memory needed, but can drop the second sentence if that seems unclear. The main suggestion is to begin with the memory usage, as it is the topic of the document, rather than the "disable mempool functionality" phrase (which seems a bit misleading as well).

w0xlt approved

w0xlt commented at 4:05 PM on January 30, 2023: contributor

ACK https://github.com/bitcoin/bitcoin/pull/26991/commits/47c174d8ce4c5f36c41203aedde86c5f0da90217

glozow merged this on Feb 1, 2023

glozow closed this on Feb 1, 2023

sidhujag referenced this in commit e1e1fab923 on Feb 1, 2023

bitcoin locked this on Feb 1, 2024