doc: add release notes for #22729

vasild commented at 9:48 am on July 23, 2024: contributor

Add release notes for #22729.

DrahtBot commented at 9:48 am on July 23, 2024: contributor

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

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	davidgumberg, willcl-ark

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

DrahtBot added the label Docs on Jul 23, 2024

fanquake added this to the milestone 28.0 on Jul 23, 2024

in doc/release-notes-22729.md:7 in 620bbc77d9 outdated

0@@ -0,0 +1,17 @@
1+Notable changes
2+===============
3+
4+P2P and network changes
5+-----------------------
6+
7+- Previously, if Bitcoin Core would be listening for P2P connections, then

maflcko commented at 10:01 am on July 23, 2024:

0- Previously, if Bitcoin Core were listening for P2P connections, then

grammar nit.

vasild commented at 11:32 am on July 23, 2024:

Done.

in doc/release-notes-22729.md:9 in 620bbc77d9 outdated

0@@ -0,0 +1,17 @@
1+Notable changes
2+===============
3+
4+P2P and network changes
5+-----------------------
6+
7+- Previously, if Bitcoin Core would be listening for P2P connections, then
8+  it would always bind on `127.0.0.1:8334` to listen for incoming Tor
9+  connections. It was not possible to switch off this even if the node didn't

maflcko commented at 10:02 am on July 23, 2024:

0  connections. It was not possible to switch this off even if the node didn't

vasild commented at 11:32 am on July 23, 2024:

Done.

JoeyVee8666 approved

in doc/release-notes-22729.md:10 in 620bbc77d9 outdated

 5+-----------------------
 6+
 7+- Previously, if Bitcoin Core would be listening for P2P connections, then
 8+  it would always bind on `127.0.0.1:8334` to listen for incoming Tor
 9+  connections. It was not possible to switch off this even if the node didn't
10+  use Tor. For example, a configuration `bind=addr:port` would result in

maflcko commented at 10:03 am on July 23, 2024:

0  use Tor. Previously, a configuration `bind=addr:port` would result in

Is this an example? If yes, it would be good to list all breaking changes, instead of only one.

vasild commented at 11:35 am on July 23, 2024:

Applied the s/For example/Previously/ change. Initially I wrote “for example 1.2.3.4:8333” but changed it to “for example addr:port”, now this covers all is not an example anymore.

maflcko commented at 10:56 am on July 23, 2024: member

left some nits/questions

vasild force-pushed on Jul 23, 2024

vasild commented at 11:35 am on July 23, 2024: contributor

620bbc77d9...307659733e: address suggestions

fanquake requested review from willcl-ark on Jul 25, 2024

doc: add release notes for #22729 a7f5d188cc

in doc/release-notes-22729.md:17 in 307659733e outdated

12+  `bind=addr:port` results in binding on `addr:port` only. The default behavior
13+  of binding to `0.0.0.0:8333` and `127.0.0.1:8334` has not been changed.
14+
15+  If you are using `bind=...` without `bind=...=onion` and rely on the previous
16+  behavior to accept incoming Tor connections at `127.0.0.1:8334`, you need to
17+  make this explicit by using `bind=... bind=127.0.0.1:8334=onion`. (#22729)

willcl-ark commented at 12:33 pm on July 25, 2024:

There’s some duplication in the first three sentences (repeating that we bind to 127.0.0.1:8334) that can perhaps be removed.

Additionally, not mentioned is the new startup behaviour where we abort on failure to bind to any P2P port.

Suggestion:

 0- Previously if Bitcoin Core was listening for P2P connections, either using
 1  default settings or via `bind=addr:port` it would always also bind to
 2  `127.0.0.1:8334` to listen for Tor connections. It was not possible to switch
 3  this off, even if the node didn't use Tor. This has been changed and now
 4  `bind=addr:port` results in binding on `addr:port` only. The default behavior
 5  of binding to `0.0.0.0:8333` and `127.0.0.1:8334` has not been changed.
 6
 7  If you are using a `bind=...` configuration without `bind=...=onion` and rely
 8  on the previous implied behavior to accept incoming Tor connections at
 9  `127.0.0.1:8334`, you need to now make this explicit by using `bind=host:port
10  bind=127.0.0.1:8334=onion`. (#22729)
11  
12- Bitcoin Core will now fail to start up if any of its P2P binds fail, rather
13  than the previous behaviour where we would only abort startup if all P2P
14  binds had failed.

vasild commented at 9:25 am on July 31, 2024:

Done with some minor changes. Thanks!

vasild force-pushed on Jul 31, 2024

vasild commented at 9:25 am on July 31, 2024: contributor

307659733e...a7f5d188cc: address suggestions

davidgumberg commented at 11:18 pm on August 1, 2024: contributor

ACK https://github.com/bitcoin/bitcoin/commit/a7f5d188cc7a23b1946d48693ada22fe90d9ffe0

Nit: Documentation in doc/tor.md should also be updated:

0 (obviously, replace the .onion address with your own). It should be noted that you still
1 listen on all devices and another node could establish a clearnet connection, when knowing
2 your address. To mitigate this, additionally bind the address of your Tor proxy:
3
4-    ./bitcoind ... -bind=127.0.0.1
5+    ./bitcoind ... -bind=127.0.0.1:8334=onion

doc: tor.md: use -bind=127.0.0.1:8334=onion for the Tor bind

After https://github.com/bitcoin/bitcoin/pull/22729 if
`-bind=127.0.0.1` is used, then bitcoind will not automatically
also bind on `127.0.0.1:8334`.

6d33e13bd4

vasild commented at 7:46 am on August 2, 2024: contributor

a7f5d188cc..6d33e13bd4: append one commit with that update to doc/tor.md, thanks!

davidgumberg commented at 3:09 pm on August 2, 2024: contributor

reACK https://github.com/bitcoin/bitcoin/pull/30502/commits/6d33e13bd493ca6cee7b52b990e4822a28e35d0a

willcl-ark approved

willcl-ark commented at 9:29 am on August 5, 2024: member

ACK 6d33e13bd493ca6cee7b52b990e4822a28e35d0a

Release notes look good to me now, thanks!

glozow merged this on Aug 5, 2024

glozow closed this on Aug 5, 2024

doc: add release notes for #22729 #30502

Code Coverage

Reviews