config.toml

#######################################################################
###                   Main Base Config Options                      ###
#######################################################################

# A custom human readable name for this node
# Override with MALACHITE__MONIKER env variable
moniker = "malachite"

#######################################################
###          Logging Configuration Options          ###
#######################################################
[logging]
# The application log level.
# Override with MALACHITE__LOGGING__LOG_LEVEL env variable.
# See more: https://docs.rs/env_logger/latest/env_logger/#enabling-logging
log_level = "debug"

# The log format.
# Possible values:
# - "plaintext": log entries are in colorful text
# - "json": log entries are presented as JSON objects
# Override with MALACHITE__LOGGING__LOG_FORMAT env variable.
log_format = "plaintext"


#######################################################
###         Consensus Configuration Options         ###
#######################################################
[consensus]

## Timeouts

# How long we wait for a proposal block before prevoting nil
# Override with MALACHITE__CONSENSUS__TIMEOUT_PROPOSE env variable
timeout_propose = "3s"

# How much timeout_propose increases with each round
timeout_propose_delta = "500ms"

# How long we wait after receiving +2/3 prevotes for “anything” (ie. not a single block or nil)
# Override with MALACHITE__CONSENSUS__TIMEOUT_PREVOTE env variable
timeout_prevote = "1s"

# How much the timeout_prevote increases with each round
timeout_prevote_delta = "500ms"

# How long we wait after receiving +2/3 precommits for “anything” (ie. not a single block or nil)
# Override with MALACHITE__CONSENSUS__TIMEOUT_PRECOMMIT env variable
timeout_precommit = "1s"

# How much the timeout_precommit increases with each round
timeout_precommit_delta = "500ms"

# How long we wait after committing a block, before starting on the new
# height (this gives us a chance to receive some more precommits, even
# though we already have +2/3).
# Override with MALACHITE__CONSENSUS__TIMEOUT_COMMIT env variable
timeout_commit = "0s"

# How long we wait in the prevote and precommit steps before starting
# the vote synchronization protocol
# Override with MALACHITE__CONSENSUS__TIMEOUT_STEP env variable
timeout_step = "30s"

# The message(s) required to carry the value payload.
# Available options are:
# - "parts-only": Full value is included in the proposal parts and there is no explicit Proposal message (default)
# - "proposal-only": Full value is included in the (explicit) consensus Proposal message (not supported by example app)
# - "proposal-and-parts": Both proposal parts and Proposal message are required (similar to CometBFT implementation of Tendermint, not supported by example app)
# Override with MALACHITE__CONSENSUS__VALUE_PAYLOAD env variable
value_payload = "parts-only"

# VoteSync configuration options
[consensus.vote_sync]
# The mode of vote synchronization
# - "request-response": The lagging node sends a request to a peer for the missing votes
# - "rebroadcast": Nodes rebroadcast their last vote to all peers
# Override with MALACHITE__CONSENSUS__VOTE_SYNC__MODE env variable
mode = "request-response"

#######################################################
###       Consensus P2P Configuration Options       ###
#######################################################
[consensus.p2p]

# Address to listen for incoming connections
# Override with MALACHITE__CONSENSUS__P2P__LISTEN_ADDR env variable
listen_addr = "/ip4/0.0.0.0/udp/0/quic-v1"

# List of nodes to keep persistent connections to
# Override with MALACHITE__CONSENSUS__P2P__PERSISTENT_PEERS env variable
persistent_peers = []

# Transport protocol to use for P2P communication
# Valid values:
# - "tcp": TCP + Noise
# - "quic": QUIC
# Override with MALACHITE__CONSENSUS__P2P__TRANSPORT env variable
transport = "tcp"

# Enable the discovery protocol to find more peers
# Override with MALACHITE__CONSENSUS__P2P__DISCOVERY__ENABLED env variable
discovery = { enabled = true }

# The maximum size of messages to send over pub-sub
# Must be larger than the maximum block part size.
# Override with MALACHITE__CONSENSUS__P2P__PUBSUB_MAX_SIZE env variable
pubsub_max_size = "4 MiB"

# The maximum size of messages to send over RPC
# Must be larger than the maximum block size.
# Override with MALACHITE__CONSENSUS__P2P__RPC_MAX_SIZE env variable
rpc_max_size = "10 MiB"

#######################################################
###  Consensus P2P Protocol Configuration Options   ###
#######################################################
# GossipSub v1.1 is the default and recommended protocol for Consensus P2P.
[consensus.p2p.protocol]
# Valid options are "gossipsub" and "broadcast".
# Broadcast is an experimental protocol with no additional configuration options.
type = "gossipsub"

# GossipSub only. Target number of peers for the mesh network (D in the GossipSub spec)
mesh_n = 6

# GossipSub only. Maximum number of peers in mesh network before removing some (D_high in the GossipSub spec)
mesh_n_high = 12

# GossipSub only. Minimum number of peers in mesh network before adding more (D_low in the spec)
mesh_n_low = 4

# GossipSub only. Minimum number of outbound peers in the mesh network before adding more (D_out in the spec).
# This value must be smaller or equal than `mesh_n / 2` and smaller than `mesh_n_low`.
# When this value is set to 0 or does not meet the above constraints,
# it will be calculated as `max(1, min(mesh_n / 2, mesh_n_low - 1))`
mesh_outbound_min = 2

#######################################################
###          Mempool Configuration Options          ###
#######################################################
[mempool]

# Maximum number of transactions in the mempool
# Override with MALACHITE__MEMPOOL__MAX_TX_COUNT env variable
max_tx_count = 10000

# Maximum number of transactions to gossip at once in a batch.
# If set to 0, mempool does not gossip the transactions.
# Override with MALACHITE__MEMPOOL__GOSSIP_BATCH_SIZE
gossip_batch_size = 0

#######################################################
###       Mempool P2P Configuration Options       ###
#######################################################
[mempool.p2p]

# Address to listen for incoming connections
listen_addr = "/ip4/0.0.0.0/udp/0/quic-v1"

# List of nodes to keep persistent connections to
persistent_peers = []

# Transport protocol to use for P2P communication
# Valid values:
# - "tcp": TCP + Noise
# - "quic": QUIC
transport = "tcp"

# These have no effects on the mempool yet
pubsub_max_size = "4 MiB"
rpc_max_size = "10 MiB"

#######################################################
###   Mempool P2P Protocol Configuration Options    ###
#######################################################

# /!\ This setting has no effect on the mempool yet /!\
# GossipSub v1.1 is the default and recommended protocol for Mempool P2P.
[mempool.p2p.protocol]
# Valid options are "gossipsub" and "broadcast".
# Broadcast is an experimental protocol with no additional configuration options.
type = "gossipsub"


#######################################################
###         ValueSync Configuration Options         ###
#######################################################
[value_sync]
# Enable the ValueSync synchronization protocol
# Override with MALACHITE__VALUE_SYNC__ENABLED env variable
enabled = true

# Interval at which to update other peers of our status
# Override with MALACHITE__VALUE_SYNC__STATUS_UPDATE_INTERVAL env variable
status_update_interval = "10s"

# Timeout duration for ValueSync requests
# Override with MALACHITE__VALUE_SYNC__REQUEST_TIMEOUT env variable
request_timeout = "10s"

#######################################################
###          Metrics Configuration Options          ###
#######################################################
[metrics]

# Enable the metrics server
# Override with MALACHITE__METRICS__ENABLED env variable
enabled = true

# Metrics are exported at `http://127.0.0.1:9000/metrics`
# Override with MALACHITE__METRICS__LISTEN_ADDR env variable
listen_addr = "127.0.0.1:9000"

#######################################################
###          Runtime Configuration Options          ###
#######################################################
[runtime]

# The flavor of Tokio runtime to use.
# Possible values:
# - "single_threaded": A single threaded runtime (default)
# - "multi_threaded":  A multi-threaded runtime
# Override with MALACHITE__RUNTIME__FLAVOR env variable
flavor = "single_threaded"

# For the multi-threaded runtime only.
# Sets the number of worker threads the Runtime will use.
# If set to 0, defaults to the number of cores available to the system.
# Override with MALACHITE__RUNTIME__WORKER_THREADS env variable
# worker_threads = 4


#######################################################
###          Test Node Configuration Options         ###
#######################################################
[test]

# Maximum block size
# Override with MALACHITE__TEST__MAX_BLOCK_SIZE env variable
max_block_size = "1 MiB"
# Override with MALACHITE__TEST__TX_SIZE env variable
tx_size = "1 KiB"
# Override with MALACHITE__TEST__TXS_PER_PART env variable
txs_per_part = 256
# Override with MALACHITE__TEST__TIME_ALLOWANCE_FACTOR env variable
time_allowance_factor = 0.5
# Override with MALACHITE__TEST__EXEC_TIME_PER_TX env variable
exec_time_per_tx = "1ms"
# Maximum number of blocks, relative to the current block, that can be kept in the block store.
# A value of 0 indicates that no blocks are pruned.
# Override with MALACHITE__TEST__MAX_RETAIN_BLOCKS env variable
max_retain_blocks = 1000
# Override with MALACHITE__TEST__VOTE_EXTENSIONS__ENABLED and MALACHITE__TEST__VOTE_EXTENSIONS__SIZE env variables
vote_extensions = { enabled = false, size = "0 KB" }