- Ethereum Node Records: A standard format for connectivity information for a node
- Discovery protocol: Defines how nodes find each other.
- RLPx protocol: Defines a TCP based transport system for communication between nodes.
- Ethereum Wire Protocol: facilitates exchange of blockchain data between peers
- Ethereum Snapshot Protocol: enables exchange of snapshots between peers
- Light Ethereum Subprotocol: protocol used by light clients
devp2p
.
This page will outline some of devp2p
s built-in tools.
PNR Decoding
Parallax Node Records can be decoded, verified and displayed to the terminal usingenrdump
. It takes the ENR in its encoded form, which is the base64 encoding of its RLP representation. A decoded human-readable text representation is displayed.
Use devp2p enrdump <base64>
to verify and display a Parallax Node Record.
The following is an example of the data returned by enrdump:
Node Key Management
Thedevp2p 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. Rundevp2p 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.
More information about these commands can be found in the DNS Discovery Setup Guide.
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. Rundevp2p 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/testnet>
filters nodes by “prl” ENR entry-les-server
filters nodes by LES server support-snap
filters nodes by snap protocol support
nodes.json
, you could create a filtered set containing up to 20 Parallax mainnet nodes which also support snap sync using this command:
Discovery v4 Utilities
Thedevp2p 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
Thedevp2p 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 a networking environment must be set up with 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, to run the test on the local host when the node under test is also on the local host, assign two IP addresses (or a larger range) to the loopback interface. On macOS, this can be done by executing the following command:- 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
. - Get the ENR of the 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. To run the eth protocol test suite, the node needs to be initialized as follows:- initialize the Parallax node with the
genesis.json
file contained in the testdata directory - import the
halfchain.rlp
file in the testdata directory - run the Parallax client with the following flags:
<enode>
with the enode of the Parallax node:
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 Parallax node as described above and run the following command, replacing<enode>
with the enode of the Parallax node:
Summary
This page introduced the DevP2P stack that defines Parallax’s peer-to-peer network and thedevp2p
command line tool that comes bundled with the Parallax client. The devp2p tools enables the Parallax client developers to work on the peer-to-peer network.