doc: add basic I2P documentation #22250

vasild · 2021-06-15T12:14:18Z

Add basic I2P documentation to help users to start using I2P and Bitcoin Core.

vasild · 2021-06-15T12:17:41Z

Render: https://github.com/bitcoin/bitcoin/blob/2f689c9bfee44acac211a5e569223fc7c8f293c0/doc/i2p.md

vasild · 2021-06-15T12:19:28Z

Related: https://bitcoin.stackexchange.com/questions/103402/how-can-i-use-bitcoin-core-with-the-anonymous-network-protocol-i2p

jonatack · 2021-06-15T12:21:22Z

Concept ACK!

Can be merged after FF but is needed before release.

fanquake · 2021-06-15T12:24:22Z

Can be merged after FF

Why after feature freeze? I can't see why this couldn't be merged at any time.

jonatack · 2021-06-15T12:37:56Z

That it's ok if it isn't merged today.

maflcko · 2021-06-15T12:57:01Z

Missing a link to the new doc from the main file doc/Readme.md?

theStack · 2021-06-15T13:26:17Z

Concept ACK

ghost · 2021-06-15T14:43:18Z

Concept ACK

nit: Docs mention i2p 'router' is required, this can be confusing for some users. I had to use i2pd (C++) instead of i2prouter (Java) last time I tried i2p in Bitcoin Core.

Related comments:

#20685 (comment)

Will test again today on POP!_OS.

ghost · 2021-06-15T20:54:11Z

Tried on POP!_OS and had no issues except last step:

Install i2pd using instructions mentioned for Ubuntu: https://i2pd.readthedocs.io/en/latest/user-guide/install/
Run: sudo systemctl start i2pd.service

Confirm if running: ss -nlt

State   Recv-Q   Send-Q     Local Address:Port      Peer Address:Port  Process  
         
LISTEN  0        4096           127.0.0.1:7656           0.0.0.0:*

bitcoin.conf:

testnet=1
i2psam=127.0.0.1:7656
i2pacceptincoming=1
debug=i2p

Run bitcoind

Check debug.log:

2021-06-15T20:36:16Z i2paccept thread start
2021-06-15T20:36:16Z I2P: Creating SAM session with 127.0.0.1:7656

2021-06-15T20:36:56Z I2P: SAM session created: session id=3e0f35228b, my address=bmwyyuzyqdc5dcx27s4baltbu6zw7rbqfl2nmclt45i7ng3ul4pa.b32.i2p:18333
2021-06-15T20:36:56Z AddLocal(bmwyyuzyqdc5dcx27s4baltbu6zw7rbqfl2nmclt45i7ng3ul4pa.b32.i2p:18333,4)

Confirm i2p_private_key was created:

~/.bitcoin/testnet3$ ls

anchors.dat  chainstate         i2p_private_key  settings.json
banlist.dat  debug.log          mempool.dat      wallets
blocks       fee_estimates.dat  peers.dat

bitcoin-cli -netinfo returns i2p address but no column for i2p peers

Bitcoin Core v21.99.0-eb63b1db2c4d testnet - 70016/Satoshi:21.99.0/

        ipv4    ipv6   onion   total   block
in         0       0       0       0
out       10       0       0      10       2
total     10       0       0      10

Local addresses
bmwyyuzyqdc5dcx27s4baltbu6zw7rbqfl2nmclt45i7ng3ul4pa.b32.i2p     port  18333    score      4

jonatack · 2021-06-15T21:07:27Z

-netinfo displays an I2P column if you have any I2P connections; addnode any of the I2P addresses in contrib/seeds/nodes_main.txt and you will see the connection in -netinfo.

doc/i2p.md

jonatack · 2021-06-18T09:12:56Z

doc/i2p.md

+- in the output of the CLI `-netinfo` peer connections dashboard
+
+To see to which I2P peers your node is connected, use `bitcoin-cli -netinfo 4`
+or the RPC `getpeerinfo` (e.g. `bitcoin-cli getpeerinfo`).


Maybe mention that you can see which I2P addresses your node knows with RPC getnodeaddresses 0 i2p and (maybe, not sure) that there are I2P seed nodes to bootstrap your I2P connections in /contrib/seeds/nodes_main.txt

Added getnodeaddresses 0 i2p, but not the seeds mention.

Actually, we use the seeds to fill addrman / establish a connection if we don't have any. But as far as I am aware we do this regardless of the network. Should we do that per-network? I.e. make sure we establish at least one connection to Tor if the user has bothered to setup a Tor proxy, using the seeds if necessary? Same for I2P.

This seems like a good idea. IRC discussion: https://www.erisian.com.au/bitcoin-core-dev/log-2021-06-18.html#l-289

The few times I talked people through testing an I2P service, each time they needed an I2P address to connect to or wouldn't see one. @prayank23's review is another good example 👍

"(N being either I2P or Tor). If N is configured, make sure we have at least one connection to N (either inbound or outbound). If nobody connects to us, then try to open a connection to a peer from N (using either the seeds or addresses received via gossip)".

This will help I2P now / 22.0. But it is too late for 22.0.

For 23.0 it may not be necessary for I2P if it gains traction quickly. I am not sure if Tor needs it at all.

If demonstrated to be an issue, it may (possibly) not be too late.

doc/i2p.md

jonatack · 2021-06-18T09:18:38Z

ACK, modulo the comments. I was wondering if we should warn that i2pd needs to be a version more recent than 2.33.0 due to the issues Suhas experienced with it, but mentioning i2pd can be done in a follow-up, if desired.

laanwj · 2021-06-18T12:12:07Z

I was wondering if we should warn that i2pd needs to be a version more recent than 2.33.0 due to the issues Suhas experienced with it, but mentioning i2pd can be done in a follow-up

Was about to comment this as well, but I guess we cannot really recommend any version of i2pd at this point at all due to known crash issues? In any case, I agree it can be done later if at all.

ghost · 2021-06-18T12:18:37Z

I have nothing more to add in review apart from my comments above. Would be helpful if someone could answer this question on SE: https://bitcoin.stackexchange.com/questions/107060/tor-and-i2p-tradeoffs-in-bitcoin-core

vasild · 2021-06-18T14:25:00Z

2f689c9bfe...28fb34a275: address suggestions

vasild · 2021-06-18T14:27:03Z

28fb34a275...e498c9292a: remove redundant word

Render: https://github.com/bitcoin/bitcoin/blob/e498c9292af233c33616dcee2fe749ecb85fa186/doc/i2p.md

vasild · 2021-06-18T14:36:06Z

@prayank23, I added a link to the I2P glossary https://geti2p.net/en/about/glossary, I think "I2P router" in general means an I2P proxy not the specific implementation in Java.

ghost · 2021-06-18T14:54:23Z

doc/i2p.md

+## Run Bitcoin Core with an I2P router (proxy)
+
+A running I2P router (proxy) with [SAM](https://geti2p.net/en/docs/api/samv3)
+enabled is required (there is an [official one](https://geti2p.net) and


This official link has one 'download' button, it will open https://geti2p.net/en/download which has options for different OS. If you try installing i2p for Ubuntu from here it won't work. Others also look like .jar files

jonatack

ACK with a few more comments :)

Edit: I wonder if the first sentence from doc/tor.md would be clearer: "It is possible to run Bitcoin Core as an I2P (Invisible Internet Project) service and connect to such services."

doc/i2p.md

vasild · 2021-06-21T09:50:27Z

e498c9292a...afe5c3e70a: address suggestions and remove leading - from config options since - is used only on the command line and not in bitcoin.conf and it may be confused with an option to bitcoin-cli (instead of bitcoind).

vasild · 2021-06-21T09:54:32Z

I wonder if the first sentence from doc/tor.md would be clearer: "It is possible to run Bitcoin Core as an I2P (Invisible Internet Project) service and connect to such services."

Yes. The previous "to connect to other bitcoin nodes through I2P" may be interpreted as to connect to other non-I2P nodes (e.g. IPv4).

doc/i2p.md

jonatack · 2021-06-21T15:23:30Z

doc/i2p.md

+To see to which I2P peers your node is connected, use `bitcoin-cli -netinfo 4`
+or the RPC `getpeerinfo` (e.g. `bitcoin-cli getpeerinfo`).
+
+To see which I2P addresses your node knows, use the RPC


Suggested change

To see which I2P addresses your node knows, use the RPC

To see which I2P addresses your node knows, run RPC

"run" because getnodeaddresses 0 i2p is not just the name of an RPC but a call with specific arguments. But definitely a pico-nit.

doc/README.md

doc/i2p.md

jonatack · 2021-06-21T15:30:19Z

ACK

There are a few fixups but nothing that can't be done in a follow-up before -final. Personally, I was procrastinating on writing this doc out of bikeshed avoidance, so just noting a few things here and happy to open a follow-up.

vasild · 2021-06-23T10:24:37Z

afe5c3e70a...78cdab1ad2: address suggestions

For the next time: maybe a wiki is more appropriate, where everybody can edit and only open a PR once settled/finalized.

jonatack · 2021-06-23T11:08:50Z

ACK 78cdab1

Thanks for updating. It may be a good idea to mention the ports (0 or ignored) I2P specificity to users here once it's settled.

laanwj · 2021-06-24T11:38:23Z

ACK 78cdab1

For the next time: maybe a wiki is more appropriate, where everybody can edit and only open a PR once settled/finalized.

Yes, I don't think this is a bad idea for new documentation. I'd be uncomfortable with using a wiki as main documentation source, but during the editing phase it can be less friction.

michaelfolkson · 2021-06-24T11:43:21Z

For the next time: maybe a wiki is more appropriate, where everybody can edit and only open a PR once settled/finalized.

Neat idea. Better than a StackExchange post if it is intended to go directly into Core docs and as @laanwj says less friction during editing phase than opening a PR with a first draft.

vasild · 2021-06-24T12:33:23Z

Indeed. Just the initial/draft phase.

78cdab1 doc: sort entries in doc/README.md#Miscellaneous alphabetically (Vasil Dimov) cad487b doc: add basic I2P documentation (Vasil Dimov) Pull request description: Add basic I2P documentation to help users to start using I2P and Bitcoin Core. ACKs for top commit: jonatack: ACK 78cdab1 laanwj: ACK 78cdab1 Tree-SHA512: 71cffc9419338a21cb9e811ee9463d6d09eef1a2a73190f766523bc1642a1f58984d5b2ab13da9b6560387ac9f431aace8bc7ae9b776585ecd3e3c1ff6af8e8d

Summary: This is a backport of [[bitcoin/bitcoin#22250 | core#22250]] Depends on D11037 Test Plan: proofreading and following the steps to run a node using I2P Reviewers: #bitcoin_abc, Fabien Reviewed By: #bitcoin_abc, Fabien Differential Revision: https://reviews.bitcoinabc.org/D11041

fanquake added the Docs label Jun 15, 2021

ghost mentioned this pull request Jun 16, 2021

Add i2p BlockchainCommons/Learning-Bitcoin-from-the-Command-Line#221

Merged

laanwj reviewed Jun 17, 2021

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

laanwj reviewed Jun 17, 2021

View reviewed changes

doc/i2p.md Show resolved Hide resolved

laanwj added this to the 22.0 milestone Jun 17, 2021

jonatack reviewed Jun 18, 2021

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

jonatack reviewed Jun 18, 2021

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

vasild force-pushed the i2p_doc branch from 2f689c9 to 28fb34a Compare June 18, 2021 14:24

vasild force-pushed the i2p_doc branch from 28fb34a to e498c92 Compare June 18, 2021 14:26

ghost reviewed Jun 18, 2021

View reviewed changes

jonatack reviewed Jun 18, 2021

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

doc/i2p.md Outdated Show resolved Hide resolved

vasild force-pushed the i2p_doc branch from e498c92 to afe5c3e Compare June 21, 2021 09:49

jonatack reviewed Jun 21, 2021

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

jonatack reviewed Jun 21, 2021

View reviewed changes

doc/README.md Outdated Show resolved Hide resolved

jonatack reviewed Jun 21, 2021

View reviewed changes

doc/i2p.md Outdated Show resolved Hide resolved

vasild added 2 commits June 23, 2021 12:21

doc: add basic I2P documentation

cad487b

doc: sort entries in doc/README.md#Miscellaneous alphabetically

78cdab1

vasild force-pushed the i2p_doc branch from afe5c3e to 78cdab1 Compare June 23, 2021 10:22

laanwj merged commit b7565c7 into bitcoin:master Jun 24, 2021

vasild deleted the i2p_doc branch June 24, 2021 12:31

ghost mentioned this pull request Aug 8, 2021

doc, test: improve i2p/tor docs and i2p reachable unit tests #22648

Merged

jonatack mentioned this pull request Aug 21, 2021

I2P: Creating SAM session with 127.0.0.1:7656 #22759

Closed

ghost mentioned this pull request Oct 20, 2021

Print peer counts for all reachable networks in -netinfo #23324

Merged

gwillen pushed a commit to ElementsProject/elements that referenced this pull request Jun 1, 2022

Merge b7565c7 into merged_master (Bitcoin PR bitcoin/bitcoin#22250)

a1f89ca

bitcoin locked as resolved and limited conversation to collaborators Aug 16, 2022

	To see which I2P addresses your node knows, use the RPC
	To see which I2P addresses your node knows, run RPC

doc: add basic I2P documentation #22250

doc: add basic I2P documentation #22250

Uh oh!

Conversation

vasild commented Jun 15, 2021

Uh oh!

vasild commented Jun 15, 2021

Uh oh!

vasild commented Jun 15, 2021

Uh oh!

jonatack commented Jun 15, 2021

Uh oh!

fanquake commented Jun 15, 2021

Uh oh!

jonatack commented Jun 15, 2021

Uh oh!

maflcko commented Jun 15, 2021

Uh oh!

theStack commented Jun 15, 2021

Uh oh!

ghost commented Jun 15, 2021

Uh oh!

ghost commented Jun 15, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonatack commented Jun 15, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jonatack commented Jun 18, 2021

Uh oh!

laanwj commented Jun 18, 2021

Uh oh!

ghost commented Jun 18, 2021

Uh oh!

vasild commented Jun 18, 2021

Uh oh!

vasild commented Jun 18, 2021

Uh oh!

vasild commented Jun 18, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonatack left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vasild commented Jun 21, 2021

Uh oh!

vasild commented Jun 21, 2021

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonatack Jun 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost commented Jun 15, 2021 •

edited by ghost

Loading

jonatack left a comment •

edited

Loading

jonatack Jun 23, 2021 •

edited

Loading

jonatack commented Jun 21, 2021 •

edited

Loading