Connecting to peers
Last updated
Was this helpful?
Last updated
Was this helpful?
The default behaviour for Etn-sc is to connect to Electroneum Mainnet. However, Etn-sc can also connect to public testnets, and . For convenience, the the public testnet with long term support have their own command line flag. Etn-sc can connect to the testnet simply by passing:
--testnet
Note: Network selection is not persisted from a config file. To connect to a pre-defined network you must always enable it explicitly, even when using the --config
flag to load other configuration values. For example:
Etn-sc continuously attempts to connect to other nodes on the network until it has enough peers. If UPnP (Universal Plug and Play) is enabled at the router or Electroneum is run on an Internet-facing server, it will also accept connections from other nodes. Etn-sc finds peers using the . In the discovery protocol, nodes exchange connectivity details and then establish sessions (). If the nodes support compatible sub-protocols they can start exchanging Electroneum data .
A new node entering the network for the first time gets introduced to a set of peers by a bootstrap node ("bootnode") whose sole purpose is to connect new nodes to peers. The endpoints for these bootnodes are hardcoded into Etn-sc, but they can also be specified by providing the --bootnode
flag along with comma-separated bootnode addresses in the form of on startup. For example:
There are scenarios where disabling the discovery process is useful, for example for running a local test node or an experimental test network with known, fixed nodes. This can be achieved by passing the --nodiscover
flag to Etn-sc at startup.
There are occasions when Etn-sc simply fails to connect to peers. The common reasons for this are:
Local time might be incorrect. An accurate clock is required to participate in the Electroneum network. The local clock can be resynchronized using commands such as sudo ntpdate -s time.nist.gov
(this will vary depending on operating system).
Some firewall configurations can prohibit UDP traffic. The static nodes feature or admin.addPeer()
on the console can be used to configure connections manually.
Running Etn-sc in often leads to connectivity issues because there are few nodes running light servers. There is no easy fix for this except to switch Etn-sc out of light mode.
The public test network Etn-sc is connecting to might be deprecated or have a low number of active nodes that are hard to find. In this case, the best action is to switch to an alternative test network.
Functions in the admin
module provide more information about the connected peers, including their IP address, port number, supported protocols etc. Calling admin.peers
returns this information for all connected peers.
The admin
module also includes functions for gathering information about the local node rather than its peers. For example, admin.nodeInfo
returns the name and connectivity details for the local node.
Etn-sc also supports static nodes. Static nodes are specific peers that are always connected to. Etn-sc reconnects to these peers automatically when it is restarted. Specific nodes are defined to be static nodes by adding their enode addresses to a config file. The easiest way to create this config file is to run:
This will create config.toml
in the current directory. The enode addresses for static nodes can then be added as a list to the StaticNodes
field of the Node.P2P
section in config.toml
. When Etn-sc is started, pass --config config.toml
. The relevant line in config.toml
looks as follows:
Static nodes can also be added at runtime in the Javascript console by passing an enode address to admin.addPeer()
:
It is sometimes desirable to cap the number of peers Etn-sc will connect to in order to limit on the computational and bandwidth cost associated with running a node. By default, the limit is 50 peers, however, this can be updated by passing a value to --maxpeers
:
Trusted nodes can be added to config.toml
in the same way as for static nodes. Add the trusted node's enode address to the TrustedNodes
field in config.toml
before starting Etn-sc with --config config.toml
.
Nodes can be added using the admin.addTrustedPeer()
call in the Javascript console and removed using admin.removeTrustedPeer()
call.
Etn-sc connects to Electroneum Mainnet by default. However, this behaviour can be changed using combinations of command line flags and files. This page has described the various options available for connecting a Etn-sc node to the Electroneum Smart Chain, public testnet and private networks.
The net
module has two attributes that enable checking node connectivity from the . These are net.listening
which reports whether the Etn-sc node is listening for inbound requests, and peerCount
which returns the number of active peers the node is connected to.
It is often useful for developers to connect to private test networks rather than public testnets or Electroneum mainnet. These sandbox environments allow block creation without competing against other miners, easy minting of test ether and give freedom to break things without real-world consequences. A private network is started by providing a value to --networkid
that is not used by any other existing public network () and creating a custom genesis.json
file. Detailed instructions for this are available on the .
Ensure the other lines in config.toml
are also set correctly before starting Etn-sc, as passing --config
instructs Etn-sc to get its configuration values from this file. An example of a complete config.toml
file can be found .