524aaf5ec6
This change implements the Discovery v5.1 wire protocol and also adds an interactive test suite for this protocol.
87 lines
3.2 KiB
Markdown
87 lines
3.2 KiB
Markdown
# 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][dns-tutorial].
|
|
|
|
### Discovery v4 Utilities
|
|
|
|
The `devp2p discv4 ...` command family deals with the [Node Discovery v4][discv4]
|
|
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][discv5]
|
|
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`.
|
|
|
|
[dns-tutorial]: https://geth.ethereum.org/docs/developers/dns-discovery-setup
|
|
[discv4]: https://github.com/ethereum/devp2p/tree/master/discv4.md
|
|
[discv5]: https://github.com/ethereum/devp2p/tree/master/discv5/discv5.md
|