|
|
|
|
@ -1,58 +1,170 @@
|
|
|
|
|
Configuration
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
TendermintCore can be configured via a TOML file in
|
|
|
|
|
``$TMHOME/config.toml``. Some of these parameters can be overridden by
|
|
|
|
|
command-line flags.
|
|
|
|
|
Tendermint Core can be configured via a TOML file in
|
|
|
|
|
``$TMHOME/config/config.toml``. Some of these parameters can be overridden by
|
|
|
|
|
command-line flags. For most users, the options in the ``##### main
|
|
|
|
|
base configuration options #####`` are intended to be modified while
|
|
|
|
|
config options further below are intended for advance power users.
|
|
|
|
|
|
|
|
|
|
Config parameters
|
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
Config options
|
|
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The main config parameters are defined
|
|
|
|
|
`here <https://github.com/tendermint/tendermint/blob/master/config/config.go>`__.
|
|
|
|
|
The default configuration file create by ``tendermint init`` has all
|
|
|
|
|
the parameters set with their default values. It will look something
|
|
|
|
|
like the file below, however, double check by inspecting the
|
|
|
|
|
``config.toml`` created with your version of ``tendermint`` installed:
|
|
|
|
|
|
|
|
|
|
- ``abci``: ABCI transport (socket \| grpc). *Default*: ``socket``
|
|
|
|
|
- ``db_backend``: Database backend for the blockchain and
|
|
|
|
|
TendermintCore state. ``leveldb`` or ``memdb``. *Default*:
|
|
|
|
|
``"leveldb"``
|
|
|
|
|
- ``db_dir``: Database dir. *Default*: ``"$TMHOME/data"``
|
|
|
|
|
- ``fast_sync``: Whether to sync faster from the block pool. *Default*:
|
|
|
|
|
``true``
|
|
|
|
|
- ``genesis_file``: The location of the genesis file. *Default*:
|
|
|
|
|
``"$TMHOME/genesis.json"``
|
|
|
|
|
- ``log_level``: *Default*: ``"state:info,*:error"``
|
|
|
|
|
- ``moniker``: Name of this node. *Default*: the host name or ``"anonymous"``
|
|
|
|
|
if runtime fails to get the host name
|
|
|
|
|
- ``priv_validator_file``: Validator private key file. *Default*:
|
|
|
|
|
``"$TMHOME/priv_validator.json"``
|
|
|
|
|
- ``prof_laddr``: Profile listen address. *Default*: ``""``
|
|
|
|
|
- ``proxy_app``: The ABCI app endpoint. *Default*:
|
|
|
|
|
``"tcp://127.0.0.1:46658"``
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
- ``consensus.max_block_size_txs``: Maximum number of block txs.
|
|
|
|
|
*Default*: ``10000``
|
|
|
|
|
- ``consensus.create_empty_blocks``: Create empty blocks w/o txs.
|
|
|
|
|
*Default*: ``true``
|
|
|
|
|
- ``consensus.create_empty_blocks_interval``: Block creation interval, even if empty.
|
|
|
|
|
- ``consensus.timeout_*``: Various consensus timeout parameters
|
|
|
|
|
- ``consensus.wal_file``: Consensus state WAL. *Default*:
|
|
|
|
|
``"$TMHOME/data/cs.wal/wal"``
|
|
|
|
|
- ``consensus.wal_light``: Whether to use light-mode for Consensus
|
|
|
|
|
state WAL. *Default*: ``false``
|
|
|
|
|
# This is a TOML config file.
|
|
|
|
|
# For more information, see https://github.com/toml-lang/toml
|
|
|
|
|
|
|
|
|
|
- ``mempool.*``: Various mempool parameters
|
|
|
|
|
##### main base config options #####
|
|
|
|
|
|
|
|
|
|
- ``p2p.addr_book_file``: Peer address book. *Default*:
|
|
|
|
|
``"$TMHOME/addrbook.json"``. **NOT USED**
|
|
|
|
|
- ``p2p.laddr``: Node listen address. (0.0.0.0:0 means any interface,
|
|
|
|
|
any port). *Default*: ``"0.0.0.0:46656"``
|
|
|
|
|
- ``p2p.pex``: Enable Peer-Exchange (dev feature). *Default*: ``false``
|
|
|
|
|
- ``p2p.seeds``: Comma delimited host:port seed nodes. *Default*:
|
|
|
|
|
``""``
|
|
|
|
|
- ``p2p.skip_upnp``: Skip UPNP detection. *Default*: ``false``
|
|
|
|
|
# TCP or UNIX socket address of the ABCI application,
|
|
|
|
|
# or the name of an ABCI application compiled in with the Tendermint binary
|
|
|
|
|
proxy_app = "tcp://127.0.0.1:46658"
|
|
|
|
|
|
|
|
|
|
- ``rpc.grpc_laddr``: GRPC listen address (BroadcastTx only). Port
|
|
|
|
|
required. *Default*: ``""``
|
|
|
|
|
- ``rpc.laddr``: RPC listen address. Port required. *Default*:
|
|
|
|
|
``"0.0.0.0:46657"``
|
|
|
|
|
- ``rpc.unsafe``: Enabled unsafe rpc methods. *Default*: ``true``
|
|
|
|
|
# A custom human readable name for this node
|
|
|
|
|
moniker = "anonymous"
|
|
|
|
|
|
|
|
|
|
# If this node is many blocks behind the tip of the chain, FastSync
|
|
|
|
|
# allows them to catchup quickly by downloading blocks in parallel
|
|
|
|
|
# and verifying their commits
|
|
|
|
|
fast_sync = true
|
|
|
|
|
|
|
|
|
|
# Database backend: leveldb | memdb
|
|
|
|
|
db_backend = "leveldb"
|
|
|
|
|
|
|
|
|
|
# Database directory
|
|
|
|
|
db_path = "data"
|
|
|
|
|
|
|
|
|
|
# Output level for logging
|
|
|
|
|
log_level = "state:info,*:error"
|
|
|
|
|
|
|
|
|
|
##### additional base config options #####
|
|
|
|
|
|
|
|
|
|
# The ID of the chain to join (should be signed with every transaction and vote)
|
|
|
|
|
chain_id = ""
|
|
|
|
|
|
|
|
|
|
# Path to the JSON file containing the initial validator set and other meta data
|
|
|
|
|
genesis_file = "genesis.json"
|
|
|
|
|
|
|
|
|
|
# Path to the JSON file containing the private key to use as a validator in the consensus protocol
|
|
|
|
|
priv_validator_file = "priv_validator.json"
|
|
|
|
|
|
|
|
|
|
# Mechanism to connect to the ABCI application: socket | grpc
|
|
|
|
|
abci = "socket"
|
|
|
|
|
|
|
|
|
|
# TCP or UNIX socket address for the profiling server to listen on
|
|
|
|
|
prof_laddr = ""
|
|
|
|
|
|
|
|
|
|
# If true, query the ABCI app on connecting to a new peer
|
|
|
|
|
# so the app can decide if we should keep the connection or not
|
|
|
|
|
filter_peers = false
|
|
|
|
|
|
|
|
|
|
##### advanced configuration options #####
|
|
|
|
|
|
|
|
|
|
##### rpc server configuration options #####
|
|
|
|
|
[rpc]
|
|
|
|
|
|
|
|
|
|
# TCP or UNIX socket address for the RPC server to listen on
|
|
|
|
|
laddr = "tcp://0.0.0.0:46657"
|
|
|
|
|
|
|
|
|
|
# TCP or UNIX socket address for the gRPC server to listen on
|
|
|
|
|
# NOTE: This server only supports /broadcast_tx_commit
|
|
|
|
|
grpc_laddr = ""
|
|
|
|
|
|
|
|
|
|
# Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
|
|
|
|
|
unsafe = false
|
|
|
|
|
|
|
|
|
|
##### peer to peer configuration options #####
|
|
|
|
|
[p2p]
|
|
|
|
|
|
|
|
|
|
# Address to listen for incoming connections
|
|
|
|
|
laddr = "tcp://0.0.0.0:46656"
|
|
|
|
|
|
|
|
|
|
# Comma separated list of seed nodes to connect to
|
|
|
|
|
seeds = ""
|
|
|
|
|
|
|
|
|
|
# Path to address book
|
|
|
|
|
addr_book_file = "addrbook.json"
|
|
|
|
|
|
|
|
|
|
# Set true for strict address routability rules
|
|
|
|
|
addr_book_strict = true
|
|
|
|
|
|
|
|
|
|
# Time to wait before flushing messages out on the connection, in ms
|
|
|
|
|
flush_throttle_timeout = 100
|
|
|
|
|
|
|
|
|
|
# Maximum number of peers to connect to
|
|
|
|
|
max_num_peers = 50
|
|
|
|
|
|
|
|
|
|
# Maximum size of a message packet payload, in bytes
|
|
|
|
|
max_msg_packet_payload_size = 1024
|
|
|
|
|
|
|
|
|
|
# Rate at which packets can be sent, in bytes/second
|
|
|
|
|
send_rate = 512000
|
|
|
|
|
|
|
|
|
|
# Rate at which packets can be received, in bytes/second
|
|
|
|
|
recv_rate = 512000
|
|
|
|
|
|
|
|
|
|
##### mempool configuration options #####
|
|
|
|
|
[mempool]
|
|
|
|
|
|
|
|
|
|
recheck = true
|
|
|
|
|
recheck_empty = true
|
|
|
|
|
broadcast = true
|
|
|
|
|
wal_dir = "data/mempool.wal"
|
|
|
|
|
|
|
|
|
|
##### consensus configuration options #####
|
|
|
|
|
[consensus]
|
|
|
|
|
|
|
|
|
|
wal_file = "data/cs.wal/wal"
|
|
|
|
|
wal_light = false
|
|
|
|
|
|
|
|
|
|
# All timeouts are in milliseconds
|
|
|
|
|
timeout_propose = 3000
|
|
|
|
|
timeout_propose_delta = 500
|
|
|
|
|
timeout_prevote = 1000
|
|
|
|
|
timeout_prevote_delta = 500
|
|
|
|
|
timeout_precommit = 1000
|
|
|
|
|
timeout_precommit_delta = 500
|
|
|
|
|
timeout_commit = 1000
|
|
|
|
|
|
|
|
|
|
# Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
|
|
|
|
|
skip_timeout_commit = false
|
|
|
|
|
|
|
|
|
|
# BlockSize
|
|
|
|
|
max_block_size_txs = 10000
|
|
|
|
|
max_block_size_bytes = 1
|
|
|
|
|
|
|
|
|
|
# EmptyBlocks mode and possible interval between empty blocks in seconds
|
|
|
|
|
create_empty_blocks = true
|
|
|
|
|
create_empty_blocks_interval = 0
|
|
|
|
|
|
|
|
|
|
# Reactor sleep duration parameters are in milliseconds
|
|
|
|
|
peer_gossip_sleep_duration = 100
|
|
|
|
|
peer_query_maj23_sleep_duration = 2000
|
|
|
|
|
|
|
|
|
|
##### transactions indexer configuration options #####
|
|
|
|
|
[tx_index]
|
|
|
|
|
|
|
|
|
|
# What indexer to use for transactions
|
|
|
|
|
#
|
|
|
|
|
# Options:
|
|
|
|
|
# 1) "null" (default)
|
|
|
|
|
# 2) "kv" - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
|
|
|
|
|
indexer = "{{ .TxIndex.Indexer }}"
|
|
|
|
|
|
|
|
|
|
# Comma-separated list of tags to index (by default the only tag is tx hash)
|
|
|
|
|
#
|
|
|
|
|
# It's recommended to index only a subset of tags due to possible memory
|
|
|
|
|
# bloat. This is, of course, depends on the indexer's DB and the volume of
|
|
|
|
|
# transactions.
|
|
|
|
|
index_tags = "{{ .TxIndex.IndexTags }}"
|
|
|
|
|
|
|
|
|
|
# When set to true, tells indexer to index all tags. Note this may be not
|
|
|
|
|
# desirable (see the comment above). IndexTags has a precedence over
|
|
|
|
|
# IndexAllTags (i.e. when given both, IndexTags will be indexed).
|
|
|
|
|
index_all_tags = {{ .TxIndex.IndexAllTags }}
|
|
|
|
|
|
Ethan Buchman
GitHub