424656519a
The new -limit option makes the filter operate on top N nodes by score. This also adds ENR attribute stats in the nodeset info command. Node set commands are now documented in README.
141 lines
5.6 KiB
Markdown
141 lines
5.6 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].
|
|
|
|
### Node Set Utilities
|
|
|
|
There are several commands for working with JSON node set files. These files are generated
|
|
by the discovery crawlers and DNS client commands. Node sets also used as the input of the
|
|
DNS deployer commands.
|
|
|
|
Run `devp2p nodeset info <nodes.json>` to display statistics of a node set.
|
|
|
|
Run `devp2p nodeset filter <nodes.json> <filter flags...>` to write a new, filtered node
|
|
set to standard output. The following filters are supported:
|
|
|
|
- `-limit <N>` limits the output set to N entries, taking the top N nodes by score
|
|
- `-ip <CIDR>` filters nodes by IP subnet
|
|
- `-min-age <duration>` filters nodes by 'first seen' time
|
|
- `-eth-network <mainnet/rinkeby/goerli/ropsten>` filters nodes by "eth" ENR entry
|
|
- `-les-server` filters nodes by LES server support
|
|
- `-snap` filters nodes by snap protocol support
|
|
|
|
For example, given a node set in `nodes.json`, you could create a filtered set containing
|
|
up to 20 eth mainnet nodes which also support snap sync using this command:
|
|
|
|
devp2p nodeset filter nodes.json -eth-network mainnet -snap -limit 20
|
|
|
|
### 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`.
|
|
|
|
### Eth Protocol Test Suite
|
|
|
|
The Eth Protocol test suite is a conformance test suite for the [eth protocol][eth].
|
|
|
|
To run the eth protocol test suite against your implementation, the node needs to be initialized as such:
|
|
|
|
1. initialize the geth node with the `genesis.json` file contained in the `testdata` directory
|
|
2. import the `halfchain.rlp` file in the `testdata` directory
|
|
3. run geth with the following flags:
|
|
```
|
|
geth --datadir <datadir> --nodiscover --nat=none --networkid 19763 --verbosity 5
|
|
```
|
|
|
|
Then, run the following command, replacing `<enode>` with the enode of the geth node:
|
|
```
|
|
devp2p rlpx eth-test <enode> cmd/devp2p/internal/ethtest/testdata/chain.rlp cmd/devp2p/internal/ethtest/testdata/genesis.json
|
|
```
|
|
|
|
Repeat the above process (re-initialising the node) in order to run the Eth Protocol test suite again.
|
|
|
|
#### Eth66 Test Suite
|
|
|
|
The Eth66 test suite is also a conformance test suite for the eth 66 protocol version specifically.
|
|
To run the eth66 protocol test suite, initialize a geth node as described above and run the following command,
|
|
replacing `<enode>` with the enode of the geth node:
|
|
|
|
```
|
|
devp2p rlpx eth66-test <enode> cmd/devp2p/internal/ethtest/testdata/chain.rlp cmd/devp2p/internal/ethtest/testdata/genesis.json
|
|
```
|
|
|
|
[eth]: https://github.com/ethereum/devp2p/blob/master/caps/eth.md
|
|
[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
|