and update and improve doc/tor.md and doc/i2p.md.
Adapted in part from the CJDNS description in #23077 and feedback by Vasil Dimov and from the CJDNS documentation and feedback by Caleb James DeLisle.
Targets backport to v23.x.
Co-authored-by: Vasil Dimov vd@FreeBSD.org
33+["3. Connect your node to your friend's
34+node"](https://github.com/cjdelisle/cjdns#3-connect-your-node-to-your-friends-node).
35+You need to be connected to the CJDNS network before it will work with your
36+Bitcoin Core node.
37+
38+Typically, CJDNS might be launched with `./cjdroute < cjdroute.conf >
sudo or CAP_NET_ADMIN to allow it to spawn a tun device.
Maybe:
Typically, CJDNS might be launched with sudo ./cjdroute < cjdroute.conf
and it sheds permissions after setting up the TUN device. You may also launch it as an unprivileged user with some additional setup.
34+node"](https://github.com/cjdelisle/cjdns#3-connect-your-node-to-your-friends-node).
35+You need to be connected to the CJDNS network before it will work with your
36+Bitcoin Core node.
37+
38+Typically, CJDNS might be launched with `./cjdroute < cjdroute.conf >
39+cjdroute.log` and the network connection checked with `./tools/peerStats`.
> cjdroute.log is not particularly useful in the default mode, it just prints a few lines of startup stuff. And if you set it to log to stdout, it will fill your harddrive quickly, so that’s a bad idea. I would recommend no >
Updated with feedback from @cjdelisle (thanks!)
0diff --git a/doc/cjdns.md b/doc/cjdns.md
1index 5b4e112b90..482d861af6 100644
2--- a/doc/cjdns.md
3+++ b/doc/cjdns.md
4@@ -16,7 +16,7 @@ Compared to IPv4/IPv6, CJDNS provides end-to-end encryption and protects nodes
5 from traffic analysis and filtering.
6
7 Used with Tor and I2P, CJDNS is a complementary option that can enhance network
8-redundancy and robustness for both the Bitcoin network and the individual node.
9+redundancy and robustness for both the Bitcoin network and individual nodes.
10
11 Each network has different characteristics. For instance, Tor is widely used but
12 somewhat centralized. I2P connections have a source address and I2P is slow.
13@@ -35,8 +35,13 @@ node"](https://github.com/cjdelisle/cjdns#3-connect-your-node-to-your-friends-no
14 You need to be connected to the CJDNS network before it will work with your
15 Bitcoin Core node.
16
17-Typically, CJDNS might be launched with `./cjdroute < cjdroute.conf >
18-cjdroute.log` and the network connection checked with `./tools/peerStats`.
19+Typically, CJDNS might be launched with `sudo ./cjdroute < cjdroute.conf` and it
20+sheds permissions after setting up the [TUN](https://en.wikipedia.org/wiki/TUN/TAP)
21+device. You may also [launch it as an unprivileged
22+user](https://github.com/cjdelisle/cjdns/blob/master/doc/non-root-user.md) with
23+some additional setup.
24+
25+The network connection can be checked with `./tools/peerStats`.
ACK a69ef4b
Looks good to me! And thanks for mentioning the “don’t skip these steps” part. I think one of those was mostly the trouble people had because we skipped it 😅
Looks good to me! And thanks for mentioning the “don’t skip these steps” part. I think one of those was mostly the trouble people had because we skipped it 😅
Yes! I skipped those and so did a couple others 🙂
35+You need to be connected to the CJDNS network before it will work with your
36+Bitcoin Core node.
37+
38+Typically, CJDNS might be launched with `sudo ./cjdroute < cjdroute.conf` and it
39+sheds permissions after setting up the [TUN](https://en.wikipedia.org/wiki/TUN/TAP)
40+device. You may also [launch it as an unprivileged
39+sheds permissions after setting up the [TUN](https://en.wikipedia.org/wiki/TUN/TAP)
40+device. You may also [launch it as an unprivileged
41+user](https://github.com/cjdelisle/cjdns/blob/master/doc/non-root-user.md) with
42+some additional setup.
43+
44+The network connection can be checked with `./tools/peerStats`.
./cjdroute command - could that be misinterpreted as tools/peerStats being in the Bitcoin Core source repository? Maybe something like $CJDNS/tools/peerStats would be more clear?
53+```
54+
55+With this option enabled, if your node connects to `fc00::/8` addresses, they
56+will lead to the CJDNS network. Without the option and by default, they will
57+lead to an IPv6 local network as defined in
58+[RFC 4193](https://datatracker.ietf.org/doc/html/rfc4193).
This gives the wrong impression that Bitcoin Core will decide to connect to CJDNS instead of the private IPv6 network based on -cjdnsreachable. That is not the case. This option merely tells Bitcoin Core that it is running in such an environment that connecting to a fc00::/8 address will result in connecting to the CJDNS network, not the IPv6 private network. Given a peer like [fc12::34]:8333 Bitcoin Core cannot choose between CJDNS vs IPv6-private. I am not sure how to make this more explicit in the text above.
The -cjdnsreachable option helps Bitcoin Core do better address management. Like, if one of its local addresses is fc00::/8 and -cjdnsreachable is set, then it may choose to gossip that address to others. Also, making it possible to distinguish whether an incoming connection from fc00::/8 comes from the CJDNS network or from a IPv6-private one.
70+CJDNS support was added to Bitcoin Core in version 23.0 and there may be fewer
71+CJDNS peers than Tor or IP ones. You can use `bitcoin-cli -addrinfo` to see the
72+number of CJDNS addresses known to your node.
73+
74+Another consideration with `onlynet=cjdns` is that the initial blocks download
75+phase when syncing up a new node can be slow. This phase can be sped up by using
71+CJDNS peers than Tor or IP ones. You can use `bitcoin-cli -addrinfo` to see the
72+number of CJDNS addresses known to your node.
73+
74+Another consideration with `onlynet=cjdns` is that the initial blocks download
75+phase when syncing up a new node can be slow. This phase can be sped up by using
76+other networks, for instance `onlynet=onion`, at the same time.
73+
74+Another consideration with `onlynet=cjdns` is that the initial blocks download
75+phase when syncing up a new node can be slow. This phase can be sped up by using
76+other networks, for instance `onlynet=onion`, at the same time.
77+
78+In general, a node can be run with both onion and CJDNS hidden services (or
CJDNS does not have hidden services:
0In general, a node can be run with both onion hidden services and CJDNS (or
86+- in the "localaddresses" output of RPC `getnetworkinfo`
87+
88+To see which CJDNS peers your node is connected to, use `bitcoin-cli -netinfo 4`
89+or the `getpeerinfo` RPC (i.e. `bitcoin-cli getpeerinfo`).
90+
91+To see which CJDNS addresses your node knows, use the `getnodeaddresses 0 "cjdns"`
"cjdns" (same in tor and i2p docs).
Thanks for the excellent feedback @vasild; updated.
0diff --git a/doc/cjdns.md b/doc/cjdns.md
1index 482d861af6..220a95e742 100644
2--- a/doc/cjdns.md
3+++ b/doc/cjdns.md
4@@ -35,13 +35,14 @@ node"](https://github.com/cjdelisle/cjdns#3-connect-your-node-to-your-friends-no
5 You need to be connected to the CJDNS network before it will work with your
6 Bitcoin Core node.
7
8-Typically, CJDNS might be launched with `sudo ./cjdroute < cjdroute.conf` and it
9-sheds permissions after setting up the [TUN](https://en.wikipedia.org/wiki/TUN/TAP)
10-device. You may also [launch it as an unprivileged
11-user](https://github.com/cjdelisle/cjdns/blob/master/doc/non-root-user.md) with
12-some additional setup.
13+Typically, CJDNS might be launched from its directory with
14+`sudo ./cjdroute < cjdroute.conf` and it sheds permissions after setting up the
15+[TUN](https://en.wikipedia.org/wiki/TUN/TAP) interface. You may also [launch it as an
16+unprivileged user](https://github.com/cjdelisle/cjdns/blob/master/doc/non-root-user.md)
17+with some additional setup.
18
19-The network connection can be checked with `./tools/peerStats`.
20+The network connection can be checked by running `./tools/peerStats` from the
21+CJDNS directory.
22
23 ## Run Bitcoin Core with CJDNS
24
25@@ -52,10 +53,14 @@ configuration option makes CJDNS peers automatically reachable:
26
27-With this option enabled, if your node connects to `fc00::/8` addresses, they
28-will lead to the CJDNS network. Without the option and by default, they will
29-lead to an IPv6 local network as defined in
30-[RFC 4193](https://datatracker.ietf.org/doc/html/rfc4193).
31+When enabled, this option tells Bitcoin Core that it is running in an
32+environment where a connection to an `fc00::/8` address will be to the CJDNS
33+network instead of to an [RFC4193](https://datatracker.ietf.org/doc/html/rfc4193)
34+IPv6 local network. This helps Bitcoin Core perform better address management:
35+ - Your node can consider incoming `fc00::/8` connections to be from the CJDNS
36+ network rather than from an IPv6 private one.
37+ - If one of your node's local addresses is `fc00::/8`, then it can choose to
38+ gossip that address to peers.
39
40 ## Additional configuration options related to CJDNS
41
42@@ -71,11 +76,7 @@ CJDNS support was added to Bitcoin Core in version 23.0 and there may be fewer
43 CJDNS peers than Tor or IP ones. You can use `bitcoin-cli -addrinfo` to see the
44 number of CJDNS addresses known to your node.
45
46-Another consideration with `onlynet=cjdns` is that the initial blocks download
47-phase when syncing up a new node can be slow. This phase can be sped up by using
48-other networks, for instance `onlynet=onion`, at the same time.
49-
50-In general, a node can be run with both onion and CJDNS hidden services (or
51+In general, a node can be run with both an onion hidden service and CJDNS (or
52 any/all of IPv4/IPv6/onion/I2P/CJDNS), which can provide a potential fallback if
53 one of the networks has issues.
54
55@@ -88,5 +89,5 @@ There are several ways to see your CJDNS address in Bitcoin Core:
56 To see which CJDNS peers your node is connected to, use `bitcoin-cli -netinfo 4`
57 or the `getpeerinfo` RPC (i.e. `bitcoin-cli getpeerinfo`).
58
59-To see which CJDNS addresses your node knows, use the `getnodeaddresses 0 "cjdns"`
60+To see which CJDNS addresses your node knows, use the `getnodeaddresses 0 cjdns`
61 RPC.
62diff --git a/doc/i2p.md b/doc/i2p.md
63index 6b440f43a6..39f65c4e5f 100644
64--- a/doc/i2p.md
65+++ b/doc/i2p.md
66@@ -93,7 +93,7 @@ There are several ways to see your I2P address in Bitcoin Core:
67 To see which I2P peers your node is connected to, use `bitcoin-cli -netinfo 4`
68 or the `getpeerinfo` RPC (e.g. `bitcoin-cli getpeerinfo`).
69
70-To see which I2P addresses your node knows, use the `getnodeaddresses 0 "i2p"`
71+To see which I2P addresses your node knows, use the `getnodeaddresses 0 i2p`
72 RPC.
73
74 ## Compatibility
75diff --git a/doc/tor.md b/doc/tor.md
76index b8876b9825..08d031d084 100644
77--- a/doc/tor.md
78+++ b/doc/tor.md
79@@ -28,7 +28,7 @@ network. This can be useful to see how many onion peers your node knows,
80 e.g. for `-onlynet=onion`.
81
82 To fetch a number of onion addresses that your node knows, for example seven
83-addresses, use the `getnodeaddresses 7 "onion"` RPC.
84+addresses, use the `getnodeaddresses 7 onion` RPC.
85 </p></details>
ACK 1e95550
nit: According to this comment, if the node is proxying IPv6 over Tor, CJDNS will not work.
As doc/tor.md suggests using ./bitcoind -proxy=127.0.0.1:9050 to run Tor and it will prevent CJDNS from working, maybe it would be interesting to add a setting that allows Tor + CJDNS to work together.
Adapted in part from the CJDNS description in #23077 by Vasil Dimov
and from CJDNS documentation and feedback by Caleb James DeLisle.
Co-authored-by: Vasil Dimov <vd@FreeBSD.org>
and improve local addresses section
Thanks for the review and feedback @lsilva01. Without going into specific configuration suggestions, I’ve re-pushed with the following update. What do you think? Do we need to provide specific Tor + CJDNS configurations?
0--- a/doc/cjdns.md
1+++ b/doc/cjdns.md
2@@ -76,9 +76,11 @@ CJDNS support was added to Bitcoin Core in version 23.0 and there may be fewer
3 CJDNS peers than Tor or IP ones. You can use `bitcoin-cli -addrinfo` to see the
4 number of CJDNS addresses known to your node.
5
6-In general, a node can be run with both an onion hidden service and CJDNS (or
7-any/all of IPv4/IPv6/onion/I2P/CJDNS), which can provide a potential fallback if
8-one of the networks has issues.
9+In general, a node can be run with both an onion service and CJDNS (or any/all
10+of IPv4/IPv6/onion/I2P/CJDNS), which can provide a potential fallback if one of
11+the networks has issues. There are a number of ways to configure this; see
12+[doc/tor.md](https://github.com/bitcoin/bitcoin/blob/master/doc/tor.md) for
13+details.
14
15 ## CJDNS-related information in Bitcoin Core
I think it’s good. The user has a reference to the Tor documentation for configuring both networks.
ACK f44efc3
I wanted to suggest if it would be helpful to add some hints as per e.g. this IRC discussion on using the public nodes
Thanks! For now, I didn’t want to replicate or enhance the CJDNS installation docs (i.e. https://github.com/cjdelisle/cjdns#2-find-a-friend), but this can evolve based on feedback.
