plugeth/cmd/devp2p
Felix Lange 524aaf5ec6
p2p/discover: implement v5.1 wire protocol (#21647)
This change implements the Discovery v5.1 wire protocol and
also adds an interactive test suite for this protocol.
2020-10-14 12:28:17 +02:00
..
internal p2p/discover: implement v5.1 wire protocol (#21647) 2020-10-14 12:28:17 +02:00
crawl.go p2p/discover: add initial discovery v5 implementation (#20750) 2020-04-08 09:57:23 +02:00
discv4cmd.go p2p/discover: implement v5.1 wire protocol (#21647) 2020-10-14 12:28:17 +02:00
discv5cmd.go p2p/discover: implement v5.1 wire protocol (#21647) 2020-10-14 12:28:17 +02:00
dns_cloudflare.go cmd/devp2p: submit Route53 changes in batches (#20524) 2020-01-17 11:32:29 +01:00
dns_route53_test.go cmd/devp2p: be very correct about route53 change splitting (#20820) 2020-03-26 23:55:33 +01:00
dns_route53.go cmd/devp2p: be very correct about route53 change splitting (#20820) 2020-03-26 23:55:33 +01:00
dnscmd.go cmd/clef, signer/core: password input fixes (#20960) 2020-05-19 10:44:46 +02:00
enrcmd.go cmd/devp2p: print enode:// URL in enrdump (#21270) 2020-08-04 11:33:07 +02:00
keycmd.go cmd/devp2p: add commands for node key management (#21202) 2020-06-24 10:41:53 +02:00
main.go cmd/devp2p: add eth protocol test suite (#21598) 2020-09-23 15:18:17 +02:00
nodeset.go cmd/devp2p, p2p: dial using node iterator, discovery crawler (#20132) 2019-10-29 17:08:57 +02:00
nodesetcmd.go cmd: deprecate --testnet, use named networks instead (#20852) 2020-04-09 12:09:58 +03:00
README.md p2p/discover: implement v5.1 wire protocol (#21647) 2020-10-14 12:28:17 +02:00
rlpxcmd.go cmd/devp2p: add eth protocol test suite (#21598) 2020-09-23 15:18:17 +02:00

The devp2p command

The devp2p command line tool is a utility for low-level peer-to-peer debugging and protocol development purposes. It can do many things.

ENR Decoding

Use devp2p enrdump <base64> to verify and display an Ethereum Node Record.

Node Key Management

The devp2p key ... command family deals with node key files.

Run devp2p key generate mynode.key to create a new node key in the mynode.key file.

Run devp2p key to-enode mynode.key -ip 127.0.0.1 -tcp 30303 to create an enode:// URL corresponding to the given node key and address information.

Maintaining DNS Discovery Node Lists

The devp2p command can create and publish DNS discovery node lists.

Run devp2p dns sign <directory> to update the signature of a DNS discovery tree.

Run devp2p dns sync <enrtree-URL> to download a complete DNS discovery tree.

Run devp2p dns to-cloudflare <directory> to publish a tree to CloudFlare DNS.

Run devp2p dns to-route53 <directory> to publish a tree to Amazon Route53.

You can find more information about these commands in the DNS Discovery Setup Guide.

Discovery v4 Utilities

The devp2p discv4 ... command family deals with the Node Discovery v4 protocol.

Run devp2p discv4 ping <enode/ENR> to ping a node.

Run devp2p discv4 resolve <enode/ENR> to find the most recent node record of a node in the DHT.

Run devp2p discv4 crawl <nodes.json path> to create or update a JSON node set.

Discovery v5 Utilities

The devp2p discv5 ... command family deals with the Node Discovery v5 protocol. This protocol is currently under active development.

Run devp2p discv5 ping <ENR> to ping a node.

Run devp2p discv5 resolve <ENR> to find the most recent node record of a node in the discv5 DHT.

Run devp2p discv5 listen to run a Discovery v5 node.

Run devp2p discv5 crawl <nodes.json path> to create or update a JSON node set containing discv5 nodes.

Discovery Test Suites

The devp2p command also contains interactive test suites for Discovery v4 and Discovery v5.

To run these tests against your implementation, you need to set up a networking environment where two separate UDP listening addresses are available on the same machine. The two listening addresses must also be routed such that they are able to reach the node you want to test.

For example, if you want to run the test on your local host, and the node under test is also on the local host, you need to assign two IP addresses (or a larger range) to your loopback interface. On macOS, this can be done by executing the following command:

sudo ifconfig lo0 add 127.0.0.2

You can now run either test suite as follows: Start the node under test first, ensuring that it won't talk to the Internet (i.e. disable bootstrapping). An easy way to prevent unintended connections to the global DHT is listening on 127.0.0.1.

Now get the ENR of your node and store it in the NODE environment variable.

Start the test by running devp2p discv5 test -listen1 127.0.0.1 -listen2 127.0.0.2 $NODE.