Non-producing Node Setup
Goal
This section describes how to set up a non-producing node within the Antelope network. A non-producing node is a node that is not configured to produce blocks, instead it is connected and synchronized with other peers from an Antelope
based blockchain, exposing one or more services publicly or privately by enabling one or more Nodeos Plugins, except the producer_plugin
.
Before you begin
- Install the Antelope software before starting this section.
- It is assumed that
nodeos
,cleos
, andkeosd
are accessible through the path.
- Know how to pass Nodeos options to enable or disable functionality.
Steps
To setup a non-producing node is simple.
1. Set Peers
You need to set some peers in your config ini, for example:
# config.ini:
p2p-peer-address = 106.10.42.238:9876
Or you can include the peer in as a boot flag when running nodeos
, as follows:
nodeos ... --p2p-peer-address=106.10.42.238:9876
2. Enable one or more available plugins
Each available plugin is listed and detailed in the Nodeos Plugins section. When nodeos
starts, it will expose the functionality provided by the enabled plugins it was started with. For example, if you start nodeos
with state_history_plugin
enabled, you will have a non-producing node that offers full blockchain history. If you start nodeos
with http_plugin
enabled, you will have a non-producing node which exposes the Antelope RPC API. Therefore, you can extend the basic functionality provided by a non-producing node by enabling any number of existing plugins on top of it. Another aspect to consider is that some plugins have dependencies to other plugins. Therefore, you need to satisfy all dependencies for a plugin in order to enable it.