Skip to main content

Configuration

This document explains the configurable properties of the node. Kaia node package ships with good defaults and requires very little configuration. If you changed any settings of a running node, you must restart the node to reflect the changes.

CN Configuration File location

  • kcnd.conf for configuring the Consensus Node

The configuration file is located in the conf directory, whose default location depends on whether or not the installation is from an archive distribution (tar.gz) or a package distribution (RPM).

  • For the archive distribution, the config directory location defaults to $INSTALL_PATH/kcn-linux-amd64/conf/.
  • For the package distribution, the config directory defaults to /etc/kcnd/conf/.

PN Configuration File location

  • kpnd.conf for configuring the Proxy Node

The configuration file is located in the conf directory, whose default location depends on whether or not the installation is from an archive distribution (tar.gz) or a package distribution (RPM).

  • For the archive distribution, the config directory location defaults to $INSTALL_PATH/kpn-linux-amd64/conf/.
  • For the package distribution, the config directory defaults to /etc/kpnd/conf/.

EN Configuration File location

  • kend.conf for configuring the Endpoint Node

The configuration file is located in the conf directory, whose default location depends on whether or not the installation is from an archive distribution (tar.gz) or a package distribution (RPM).

  • For the archive distribution, the config directory location defaults to $INSTALL_PATH/ken-linux-amd64/conf/.
  • For the package distribution, the config directory defaults to /etc/kend/conf/.

Configuration File Format

CN and PN have the same configuration file format and the properties.

Below is a sample configuration file for the CN that participates in the mainnet and stores the blockchain data in the default location, which is ~/kcnd_home with the archive distribution, /var/kcnd/data with the package distribution.


# Configuration file for the kcnd
# mainnet, kairos is only available if you don't specify NETWORK_ID.
NETWORK="mainnet"
# if you specify NETWORK_ID, a private network is created.
NETWORK_ID=
PORT=32323
SERVER_TYPE="fasthttp"
SYNCMODE="full"
VERBOSITY=3
MAXCONNECTIONS=100
# LDBCACHESIZE=10240
REWARDBASE="0x0"
...
DATA_DIR=
LOG_DIR=$DATA_DIR/logs

The recommended txpool sizes for CN are as follows.


TXPOOL_EXEC_SLOTS_ALL=16384
TXPOOL_NONEXEC_SLOTS_ALL=16384
TXPOOL_EXEC_SLOTS_ACCOUNT=16384
TXPOOL_NONEXEC_SLOTS_ACCOUNT=16384

The recommended txpool sizes for PN are as follows.


TXPOOL_EXEC_SLOTS_ALL=8192
TXPOOL_NONEXEC_SLOTS_ALL=8192
TXPOOL_EXEC_SLOTS_ACCOUNT=8192
TXPOOL_NONEXEC_SLOTS_ACCOUNT=8192

The recommended txpool sizes for EN are as follows.


TXPOOL_EXEC_SLOTS_ALL=4096
TXPOOL_NONEXEC_SLOTS_ALL=4096
TXPOOL_EXEC_SLOTS_ACCOUNT=4096
TXPOOL_NONEXEC_SLOTS_ACCOUNT=4096

Properties

The configuration file has the following configurable properties. CN and PN configuration files have the same properties except REWARDBASE.

NameDescription
NETWORKNetwork name that this node will join. This value is used when NETWORK_ID is not defined. ("mainnet", "kairos")
NETWORK_IDKaia network ID. If you create a local private network, you will define the network ID for your own. Following IDs are reserved for pre-configured networks.
8217 : Mainnet
1000 : Aspen test network
1001 : Kairos test network
PORTP2P port. (Default: "32323")
SERVER_TYPEJSON RPC server type. ("http", "fasthttp")
SYNCMODEBlockchain sync mode. ("fast", "full")
VERBOSITYLogging verbosity. (0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail)
MAXCONNECTIONSMaximum number of physical connections. All single-channel peers can have up to MAXCONNECTIONS peers. All multi-channel peers can have up to MAXCONNECTIONS/2 peers. Network connection is disabled if it is set to 0. (Default: 10)
LDBCACHESIZESize of in-memory cache in LevelDB (MiB). (Default : 768)
REWARDBASEAccount address that will receive block consensus rewards. This property only applies to CN.
TXPOOL_EXEC_SLOTS_ALLMaximum number of executable transaction slots for all accounts. (Default: 4096)
TXPOOL_NONEXEC_SLOTS_ALLMaximum number of non-executable transaction slots for all accounts. (Default: 1024)
TXPOOL_EXEC_SLOTS_ACCOUNTNumber of executable transaction slots guaranteed per account. (Default: 16)
TXPOOL_NONEXEC_SLOTS_ACCOUNTMaximum number of non-executable transaction slots guaranteed per account. (Default: 64)
TXPOOL_LIFE_TIMEMaximum amount of time non-executable transactions is queued. (Default : 5m)
RPC_ENABLEEnable the HTTP-RPC server if it is set to 1.
RPC_APIComma-separated list of APIs offered over the HTTP-RPC interface. (admin, debug, klay, miner, net, personal, rpc, txpool, web3)
RPC_PORTHTTP-RPC server listening port. (Default: "8551")
RPC_ADDRHTTP-RPC server listening interface. (Default: "localhost")
RPC_CORSDOMAINComma-separated list of domains from which to accept cross-origin requests (browser enforced)
RPC_VHOSTSComma-separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard. (Default: localhost)
WS_ENABLEEnable the WS-RPC server if it is set to 1.
WS_APIAPIs offered over the WS-RPC interface. (admin, debug, klay, miner, net, personal, rpc, txpool, web3)
WS_ADDRWS-RPC server listening interface.
WS_PORTWS-RPC server listening port. (Default : "8552")
WS_ORIGINSOrigins from which to accept websockets requests. (Default: "localhost")
AUTO_RESTARTRestart the process when the current block has not been updated for autorestart.timeout (e.g., 60s, 10m and 1h) if it is set to 1.
METRICSEnable metrics collection and reporting if it is set to 1.
PROMETHEUSEnable prometheus exporter if it is set to 1.
DB_NO_PARALLEL_WRITEDisable parallel writes of block data to persistent database if it is set to 1.
MULTICHANNELCreate a dedicated channel for block propagation if it is set to 1.
SUBPORTListening sub port number if multichannel option is enabled. (Default : "32324")
NO_DISCOVERTurn off the discovery option if it is set to 1.
BOOTNODESComma-separated kni addresses of bootstrap nodes.
ADDITIONALFor additional command-line options. e.g) --txpool.nolocals
DATA_DIRKaia blockchain data folder path.
LOG_DIRLog folder path.
Make this page better