mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-07 22:05:18 +00:00
docs: use hyphens instead of snake case (#5802)
This commit is contained in:
Callum Waters
GitHub
@@ -32,7 +32,7 @@ A quick example of a built-in app and Tendermint core in one container.
|
||||
|
||||
```sh
|
||||
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
|
||||
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint node --proxy_app=kvstore
|
||||
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint node --proxy-app=kvstore
|
||||
```
|
||||
|
||||
## Local cluster
|
||||
|
||||
@@ -71,7 +71,7 @@ func checkConfig(configFile string) bool {
|
||||
var elems = []string{
|
||||
"moniker",
|
||||
"seeds",
|
||||
"proxy_app",
|
||||
"proxy-app",
|
||||
"fast_sync",
|
||||
"create_empty_blocks",
|
||||
"peer",
|
||||
|
||||
@@ -355,7 +355,6 @@ deployment, the role of sending messages is taken by Tendermint, which
|
||||
connects to the app using three separate connections, each with its own
|
||||
pattern of messages.
|
||||
|
||||
For more information, see the [application developers
|
||||
guide](./app-development.md). For examples of running an ABCI app with
|
||||
For examples of running an ABCI app with
|
||||
Tendermint, see the [getting started guide](./getting-started.md).
|
||||
Next is the ABCI specification.
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
## Changelog
|
||||
* 22-10-2019: Initial draft
|
||||
* 05-11-2019: Modify `maximum_dial_period` to `persistent_peers_max_dial_period`
|
||||
* 05-11-2019: Modify `maximum-dial-period` to `persistent-peers-max-dial-period`
|
||||
|
||||
## Context
|
||||
|
||||
When `max_num_inbound_peers` or `max_num_outbound_peers` of a node is reached, the node cannot spare more slots to any peer
|
||||
When `max-num-inbound-peers` or `max-num-outbound-peers` of a node is reached, the node cannot spare more slots to any peer
|
||||
by inbound or outbound. Therefore, after a certain period of disconnection, any important peering can be lost indefinitely
|
||||
because all slots are consumed by other peers, and the node stops trying to dial the peer anymore.
|
||||
|
||||
@@ -15,25 +15,25 @@ This is happening because of two reasons, exponential backoff and absence of unc
|
||||
|
||||
## Decision
|
||||
|
||||
We would like to suggest solving this problem by introducing two parameters in `config.toml`, `unconditional_peer_ids` and
|
||||
`persistent_peers_max_dial_period`.
|
||||
We would like to suggest solving this problem by introducing two parameters in `config.toml`, `unconditional-peer-ids` and
|
||||
`persistent-peers-max-dial-period`.
|
||||
|
||||
1) `unconditional_peer_ids`
|
||||
1) `unconditional-peer-ids`
|
||||
|
||||
A node operator inputs list of ids of peers which are allowed to be connected by both inbound or outbound regardless of
|
||||
`max_num_inbound_peers` or `max_num_outbound_peers` of user's node reached or not.
|
||||
`max-num-inbound-peers` or `max-num-outbound-peers` of user's node reached or not.
|
||||
|
||||
2) `persistent_peers_max_dial_period`
|
||||
2) `persistent-peers-max-dial-period`
|
||||
|
||||
Terms between each dial to each persistent peer will not exceed `persistent_peers_max_dial_period` during exponential backoff.
|
||||
Therefore, `dial_period` = min(`persistent_peers_max_dial_period`, `exponential_backoff_dial_period`)
|
||||
Terms between each dial to each persistent peer will not exceed `persistent-peers-max-dial-period` during exponential backoff.
|
||||
Therefore, `dial-period` = min(`persistent-peers-max-dial-period`, `exponential-backoff-dial-period`)
|
||||
|
||||
Alternative approach
|
||||
|
||||
Persistent_peers is only for outbound, therefore it is not enough to cover the full utility of `unconditional_peer_ids`.
|
||||
@creamers158(https://github.com/Creamers158) suggested putting id-only items into persistent_peers to be handled as
|
||||
`unconditional_peer_ids`, but it needs very complicated struct exception for different structure of items in persistent_peers.
|
||||
Therefore we decided to have `unconditional_peer_ids` to independently cover this use-case.
|
||||
Persistent-peers is only for outbound, therefore it is not enough to cover the full utility of `unconditional-peer-ids`.
|
||||
@creamers158(https://github.com/Creamers158) suggested putting id-only items into persistent-peers to be handled as
|
||||
`unconditional-peer-ids`, but it needs very complicated struct exception for different structure of items in persistent-peers.
|
||||
Therefore we decided to have `unconditional-peer-ids` to independently cover this use-case.
|
||||
|
||||
## Status
|
||||
|
||||
@@ -44,8 +44,8 @@ Proposed
|
||||
### Positive
|
||||
|
||||
A node operator can configure two new parameters in `config.toml` so that he/she can assure that tendermint will allow connections
|
||||
from/to peers in `unconditional_peer_ids`. Also he/she can assure that every persistent peer will be dialed at least once in every
|
||||
`persistent_peers_max_dial_period` term. It achieves more stable and persistent peering for trusted peers.
|
||||
from/to peers in `unconditional-peer-ids`. Also he/she can assure that every persistent peer will be dialed at least once in every
|
||||
`persistent-peers-max-dial-period` term. It achieves more stable and persistent peering for trusted peers.
|
||||
|
||||
### Negative
|
||||
|
||||
|
||||
@@ -63,7 +63,7 @@ To start a one-node blockchain with a simple in-process application:
|
||||
|
||||
```sh
|
||||
tendermint init
|
||||
tendermint node --proxy_app=kvstore
|
||||
tendermint node --proxy-app=kvstore
|
||||
```
|
||||
|
||||
## Reinstall
|
||||
|
||||
@@ -59,10 +59,10 @@ Configuring a cluster is covered further below.
|
||||
Start Tendermint with a simple in-process application:
|
||||
|
||||
```sh
|
||||
tendermint node --proxy_app=kvstore
|
||||
tendermint node --proxy-app=kvstore
|
||||
```
|
||||
|
||||
> Note: `kvstore` is a non persistent app, if you would like to run an application with persistence run `--proxy_app=persistent_kvstore`
|
||||
> Note: `kvstore` is a non persistent app, if you would like to run an application with persistence run `--proxy-app=persistent_kvstore`
|
||||
|
||||
and blocks will start to stream in:
|
||||
|
||||
@@ -134,10 +134,10 @@ tendermint show_node_id --home ./mytestnet/node3
|
||||
Finally, from each machine, run:
|
||||
|
||||
```sh
|
||||
tendermint node --home ./mytestnet/node0 --proxy_app=kvstore --p2p.persistent_peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node1 --proxy_app=kvstore --p2p.persistent_peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node2 --proxy_app=kvstore --p2p.persistent_peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node3 --proxy_app=kvstore --p2p.persistent_peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node0 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node1 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node2 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
tendermint node --home ./mytestnet/node3 --proxy-app=kvstore --p2p.persistent-peers="ID1@IP1:26656,ID2@IP2:26656,ID3@IP3:26656,ID4@IP4:26656"
|
||||
```
|
||||
|
||||
Note that after the third node is started, blocks will start to stream in
|
||||
|
||||
@@ -158,7 +158,7 @@ Override the [command](https://github.com/tendermint/tendermint/blob/master/netw
|
||||
- LOG=$${LOG:-tendermint.log}
|
||||
volumes:
|
||||
- ./build:/tendermint:Z
|
||||
command: node --proxy_app=tcp://abci0:26658
|
||||
command: node --proxy-app=tcp://abci0:26658
|
||||
networks:
|
||||
localnet:
|
||||
ipv4_address: 192.167.10.2
|
||||
|
||||
@@ -92,7 +92,7 @@ ansible-playbook -i inventory/digital_ocean.py -l sentrynet install.yml
|
||||
```
|
||||
|
||||
which as you'll see below, executes
|
||||
`tendermint node --proxy_app=kvstore` on all droplets. Although we'll
|
||||
`tendermint node --proxy-app=kvstore` on all droplets. Although we'll
|
||||
soon be modifying this role and running it again, this first execution
|
||||
allows us to get each `node_info.id` that corresponds to each
|
||||
`node_info.listen_addr`. (This part will be automated in the future). In
|
||||
@@ -105,10 +105,10 @@ Next, open `roles/install/templates/systemd.service.j2` and look for the
|
||||
line `ExecStart` which should look something like:
|
||||
|
||||
```sh
|
||||
ExecStart=/usr/bin/tendermint node --proxy_app=kvstore
|
||||
ExecStart=/usr/bin/tendermint node --proxy-app=kvstore
|
||||
```
|
||||
|
||||
and add the `--p2p.persistent_peers` flag with the relevant information
|
||||
and add the `--p2p.persistent-peers` flag with the relevant information
|
||||
for each node. The resulting file should look something like:
|
||||
|
||||
```sh
|
||||
@@ -122,7 +122,7 @@ Restart=on-failure
|
||||
User={{service}}
|
||||
Group={{service}}
|
||||
PermissionsStartOnly=true
|
||||
ExecStart=/usr/bin/tendermint node --proxy_app=kvstore --p2p.persistent_peers=167b80242c300bf0ccfb3ced3dec60dc2a81776e@165.227.41.206:26656,3c7a5920811550c04bf7a0b2f1e02ab52317b5e6@165.227.43.146:26656,303a1a4312c30525c99ba66522dd81cca56a361a@159.89.115.32:26656,b686c2a7f4b1b46dca96af3a0f31a6a7beae0be4@159.89.119.125:26656
|
||||
ExecStart=/usr/bin/tendermint node --proxy-app=kvstore --p2p.persistent-peers=167b80242c300bf0ccfb3ced3dec60dc2a81776e@165.227.41.206:26656,3c7a5920811550c04bf7a0b2f1e02ab52317b5e6@165.227.43.146:26656,303a1a4312c30525c99ba66522dd81cca56a361a@159.89.115.32:26656,b686c2a7f4b1b46dca96af3a0f31a6a7beae0be4@159.89.119.125:26656
|
||||
ExecReload=/bin/kill -HUP $MAINPID
|
||||
KillSignal=SIGTERM
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ like the file below, however, double check by inspecting the
|
||||
|
||||
# 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:26658"
|
||||
proxy-app = "tcp://127.0.0.1:26658"
|
||||
|
||||
# A custom human readable name for this node
|
||||
moniker = "anonymous"
|
||||
@@ -39,7 +39,7 @@ 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
|
||||
fast-sync = true
|
||||
|
||||
# Database backend: goleveldb | cleveldb | boltdb | rocksdb | badgerdb
|
||||
# * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
|
||||
@@ -60,41 +60,41 @@ fast_sync = true
|
||||
# * badgerdb (uses github.com/dgraph-io/badger)
|
||||
# - EXPERIMENTAL
|
||||
# - use badgerdb build tag (go build -tags badgerdb)
|
||||
db_backend = "goleveldb"
|
||||
db-backend = "goleveldb"
|
||||
|
||||
# Database directory
|
||||
db_dir = "data"
|
||||
db-dir = "data"
|
||||
|
||||
# Output level for logging, including package level options
|
||||
log_level = "main:info,state:info,statesync:info,*:error"
|
||||
log-level = "main:info,state:info,statesync:info,*:error"
|
||||
|
||||
# Output format: 'plain' (colored text) or 'json'
|
||||
log_format = "plain"
|
||||
log-format = "plain"
|
||||
|
||||
##### additional base config options #####
|
||||
|
||||
# Path to the JSON file containing the initial validator set and other meta data
|
||||
genesis_file = "config/genesis.json"
|
||||
genesis-file = "config/genesis.json"
|
||||
|
||||
# Path to the JSON file containing the private key to use as a validator in the consensus protocol
|
||||
priv_validator_key_file = "config/priv_validator_key.json"
|
||||
priv-validator-key-file = "config/priv_validator_key.json"
|
||||
|
||||
# Path to the JSON file containing the last sign state of a validator
|
||||
priv_validator_state_file = "data/priv_validator_state.json"
|
||||
priv-validator-state-file = "data/priv_validator_state.json"
|
||||
|
||||
# TCP or UNIX socket address for Tendermint to listen on for
|
||||
# connections from an external PrivValidator process
|
||||
priv_validator_laddr = ""
|
||||
priv-validator-laddr = ""
|
||||
|
||||
# Path to the JSON file containing the private key to use for node authentication in the p2p protocol
|
||||
node_key_file = "config/node_key.json"
|
||||
node-key-file = "config/node_key.json"
|
||||
|
||||
# Mechanism to connect to the ABCI application: socket | grpc
|
||||
abci = "socket"
|
||||
|
||||
# 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
|
||||
filter-peers = false
|
||||
|
||||
|
||||
#######################################################################
|
||||
@@ -112,78 +112,78 @@ laddr = "tcp://127.0.0.1:26657"
|
||||
# A list of origins a cross-domain request can be executed from
|
||||
# Default value '[]' disables cors support
|
||||
# Use '["*"]' to allow any origin
|
||||
cors_allowed_origins = []
|
||||
cors-allowed-origins = []
|
||||
|
||||
# A list of methods the client is allowed to use with cross-domain requests
|
||||
cors_allowed_methods = ["HEAD", "GET", "POST", ]
|
||||
cors-allowed-methods = ["HEAD", "GET", "POST", ]
|
||||
|
||||
# A list of non simple headers the client is allowed to use with cross-domain requests
|
||||
cors_allowed_headers = ["Origin", "Accept", "Content-Type", "X-Requested-With", "X-Server-Time", ]
|
||||
cors-allowed-headers = ["Origin", "Accept", "Content-Type", "X-Requested-With", "X-Server-Time", ]
|
||||
|
||||
# TCP or UNIX socket address for the gRPC server to listen on
|
||||
# NOTE: This server only supports /broadcast_tx_commit
|
||||
grpc_laddr = ""
|
||||
grpc-laddr = ""
|
||||
|
||||
# Maximum number of simultaneous connections.
|
||||
# Does not include RPC (HTTP&WebSocket) connections. See max_open_connections
|
||||
# Does not include RPC (HTTP&WebSocket) connections. See max-open-connections
|
||||
# If you want to accept a larger number than the default, make sure
|
||||
# you increase your OS limits.
|
||||
# 0 - unlimited.
|
||||
# Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
|
||||
# 1024 - 40 - 10 - 50 = 924 = ~900
|
||||
grpc_max_open_connections = 900
|
||||
grpc-max-open-connections = 900
|
||||
|
||||
# Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
|
||||
unsafe = false
|
||||
|
||||
# Maximum number of simultaneous connections (including WebSocket).
|
||||
# Does not include gRPC connections. See grpc_max_open_connections
|
||||
# Does not include gRPC connections. See grpc-max-open-connections
|
||||
# If you want to accept a larger number than the default, make sure
|
||||
# you increase your OS limits.
|
||||
# 0 - unlimited.
|
||||
# Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
|
||||
# 1024 - 40 - 10 - 50 = 924 = ~900
|
||||
max_open_connections = 900
|
||||
max-open-connections = 900
|
||||
|
||||
# Maximum number of unique clientIDs that can /subscribe
|
||||
# If you're using /broadcast_tx_commit, set to the estimated maximum number
|
||||
# of broadcast_tx_commit calls per block.
|
||||
max_subscription_clients = 100
|
||||
max-subscription-clients = 100
|
||||
|
||||
# Maximum number of unique queries a given client can /subscribe to
|
||||
# If you're using GRPC (or Local RPC client) and /broadcast_tx_commit, set to
|
||||
# the estimated # maximum number of broadcast_tx_commit calls per block.
|
||||
max_subscriptions_per_client = 5
|
||||
max-subscriptions-per-client = 5
|
||||
|
||||
# How long to wait for a tx to be committed during /broadcast_tx_commit.
|
||||
# WARNING: Using a value larger than 10s will result in increasing the
|
||||
# global HTTP write timeout, which applies to all connections and endpoints.
|
||||
# See https://github.com/tendermint/tendermint/issues/3435
|
||||
timeout_broadcast_tx_commit = "10s"
|
||||
timeout-broadcast-tx-commit = "10s"
|
||||
|
||||
# Maximum size of request body, in bytes
|
||||
max_body_bytes = 1000000
|
||||
max-body-bytes = 1000000
|
||||
|
||||
# Maximum size of request header, in bytes
|
||||
max_header_bytes = 1048576
|
||||
max-header-bytes = 1048576
|
||||
|
||||
# The path to a file containing certificate that is used to create the HTTPS server.
|
||||
# Migth be either absolute path or path related to tendermint's config directory.
|
||||
# If the certificate is signed by a certificate authority,
|
||||
# the certFile should be the concatenation of the server's certificate, any intermediates,
|
||||
# and the CA's certificate.
|
||||
# NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server.
|
||||
# NOTE: both tls-cert-file and tls-key-file must be present for Tendermint to create HTTPS server.
|
||||
# Otherwise, HTTP server is run.
|
||||
tls_cert_file = ""
|
||||
tls-cert-file = ""
|
||||
|
||||
# The path to a file containing matching private key that is used to create the HTTPS server.
|
||||
# Migth be either absolute path or path related to tendermint's config directory.
|
||||
# NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server.
|
||||
# NOTE: both tls-cert-file and tls-key-file must be present for Tendermint to create HTTPS server.
|
||||
# Otherwise, HTTP server is run.
|
||||
tls_key_file = ""
|
||||
tls-key-file = ""
|
||||
|
||||
# pprof listen address (https://golang.org/pkg/net/http/pprof)
|
||||
pprof_laddr = ""
|
||||
pprof-laddr = ""
|
||||
|
||||
#######################################################
|
||||
### P2P Configuration Options ###
|
||||
@@ -197,47 +197,47 @@ laddr = "tcp://0.0.0.0:26656"
|
||||
# If empty, will use the same port as the laddr,
|
||||
# and will introspect on the listener or use UPnP
|
||||
# to figure out the address.
|
||||
external_address = ""
|
||||
external-address = ""
|
||||
|
||||
# Comma separated list of seed nodes to connect to
|
||||
seeds = ""
|
||||
|
||||
# Comma separated list of nodes to keep persistent connections to
|
||||
persistent_peers = ""
|
||||
persistent-peers = ""
|
||||
|
||||
# UPNP port forwarding
|
||||
upnp = false
|
||||
|
||||
# Path to address book
|
||||
addr_book_file = "config/addrbook.json"
|
||||
addr-book-file = "config/addrbook.json"
|
||||
|
||||
# Set true for strict address routability rules
|
||||
# Set false for private or local networks
|
||||
addr_book_strict = true
|
||||
addr-book-strict = true
|
||||
|
||||
# Maximum number of inbound peers
|
||||
max_num_inbound_peers = 40
|
||||
max-num-inbound-peers = 40
|
||||
|
||||
# Maximum number of outbound peers to connect to, excluding persistent peers
|
||||
max_num_outbound_peers = 10
|
||||
max-num-outbound-peers = 10
|
||||
|
||||
# List of node IDs, to which a connection will be (re)established ignoring any existing limits
|
||||
unconditional_peer_ids = ""
|
||||
unconditional-peer-ids = ""
|
||||
|
||||
# Maximum pause when redialing a persistent peer (if zero, exponential backoff is used)
|
||||
persistent_peers_max_dial_period = "0s"
|
||||
persistent-peers-max-dial-period = "0s"
|
||||
|
||||
# Time to wait before flushing messages out on the connection
|
||||
flush_throttle_timeout = "100ms"
|
||||
flush-throttle-timeout = "100ms"
|
||||
|
||||
# Maximum size of a message packet payload, in bytes
|
||||
max_packet_msg_payload_size = 1024
|
||||
max-packet-msg-payload-size = 1024
|
||||
|
||||
# Rate at which packets can be sent, in bytes/second
|
||||
send_rate = 5120000
|
||||
send-rate = 5120000
|
||||
|
||||
# Rate at which packets can be received, in bytes/second
|
||||
recv_rate = 5120000
|
||||
recv-rate = 5120000
|
||||
|
||||
# Set true to enable the peer-exchange reactor
|
||||
pex = true
|
||||
@@ -246,17 +246,17 @@ pex = true
|
||||
# peers. If another node asks it for addresses, it responds and disconnects.
|
||||
#
|
||||
# Does not work if the peer-exchange reactor is disabled.
|
||||
seed_mode = false
|
||||
seed-mode = false
|
||||
|
||||
# Comma separated list of peer IDs to keep private (will not be gossiped to other peers)
|
||||
private_peer_ids = ""
|
||||
private-peer-ids = ""
|
||||
|
||||
# Toggle to disable guard against peers connecting from the same ip.
|
||||
allow_duplicate_ip = false
|
||||
allow-duplicate-ip = false
|
||||
|
||||
# Peer connection configuration.
|
||||
handshake_timeout = "20s"
|
||||
dial_timeout = "3s"
|
||||
handshake-timeout = "20s"
|
||||
dial-timeout = "3s"
|
||||
|
||||
#######################################################
|
||||
### Mempool Configurattion Option ###
|
||||
@@ -265,26 +265,26 @@ dial_timeout = "3s"
|
||||
|
||||
recheck = true
|
||||
broadcast = true
|
||||
wal_dir = ""
|
||||
wal-dir = ""
|
||||
|
||||
# Maximum number of transactions in the mempool
|
||||
size = 5000
|
||||
|
||||
# Limit the total size of all txs in the mempool.
|
||||
# This only accounts for raw transactions (e.g. given 1MB transactions and
|
||||
# max_txs_bytes=5MB, mempool will only accept 5 transactions).
|
||||
max_txs_bytes = 1073741824
|
||||
# max-txs-bytes=5MB, mempool will only accept 5 transactions).
|
||||
max-txs-bytes = 1073741824
|
||||
|
||||
# Size of the cache (used to filter transactions we saw earlier) in transactions
|
||||
cache_size = 10000
|
||||
cache-size = 10000
|
||||
|
||||
# Maximum size of a single transaction.
|
||||
# NOTE: the max size of a tx transmitted over the network is {max_tx_bytes}.
|
||||
max_tx_bytes = 1048576
|
||||
# NOTE: the max size of a tx transmitted over the network is {max-tx-bytes}.
|
||||
max-tx-bytes = 1048576
|
||||
|
||||
# Maximum size of a batch of transactions to send to a peer
|
||||
# Including space needed by encoding (one varint per transaction).
|
||||
max_batch_bytes = 10485760
|
||||
max-batch-bytes = 10485760
|
||||
|
||||
#######################################################
|
||||
### State Sync Configuration Options ###
|
||||
@@ -301,19 +301,19 @@ enable = false
|
||||
# retrieval of state data for node bootstrapping. Also needs a trusted height and corresponding
|
||||
# header hash obtained from a trusted source, and a period during which validators can be trusted.
|
||||
#
|
||||
# For Cosmos SDK-based chains, trust_period should usually be about 2/3 of the unbonding time (~2
|
||||
# For Cosmos SDK-based chains, trust-period should usually be about 2/3 of the unbonding time (~2
|
||||
# weeks) during which they can be financially punished (slashed) for misbehavior.
|
||||
rpc_servers = ""
|
||||
trust_height = 0
|
||||
trust_hash = ""
|
||||
trust_period = "168h0m0s"
|
||||
rpc-servers = ""
|
||||
trust-height = 0
|
||||
trust-hash = ""
|
||||
trust-period = "168h0m0s"
|
||||
|
||||
# Time to spend discovering snapshots before initiating a restore.
|
||||
discovery_time = "15s"
|
||||
discovery-time = "15s"
|
||||
|
||||
# Temporary directory for state sync snapshot chunks, defaults to the OS tempdir (typically /tmp).
|
||||
# Will create a new, randomly named directory within, and remove it when done.
|
||||
temp_dir = ""
|
||||
temp-dir = ""
|
||||
|
||||
#######################################################
|
||||
### Fast Sync Configuration Connections ###
|
||||
@@ -330,46 +330,46 @@ version = "v0"
|
||||
#######################################################
|
||||
[consensus]
|
||||
|
||||
wal_file = "data/cs.wal/wal"
|
||||
wal-file = "data/cs.wal/wal"
|
||||
|
||||
# How long we wait for a proposal block before prevoting nil
|
||||
timeout_propose = "3s"
|
||||
# How much timeout_propose increases with each round
|
||||
timeout_propose_delta = "500ms"
|
||||
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)
|
||||
timeout_prevote = "1s"
|
||||
# How much the timeout_prevote increases with each round
|
||||
timeout_prevote_delta = "500ms"
|
||||
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)
|
||||
timeout_precommit = "1s"
|
||||
# How much the timeout_precommit increases with each round
|
||||
timeout_precommit_delta = "500ms"
|
||||
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).
|
||||
timeout_commit = "1s"
|
||||
timeout-commit = "1s"
|
||||
|
||||
# How many blocks to look back to check existence of the node's consensus votes before joining consensus
|
||||
# When non-zero, the node will panic upon restart
|
||||
# if the same consensus key was used to sign {double_sign_check_height} last blocks.
|
||||
# if the same consensus key was used to sign {double-sign-check-height} last blocks.
|
||||
# So, validators should stop the state machine, wait for some blocks, and then restart the state machine to avoid panic.
|
||||
double_sign_check_height = 0
|
||||
double-sign-check-height = 0
|
||||
|
||||
# Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
|
||||
skip_timeout_commit = false
|
||||
skip-timeout-commit = false
|
||||
|
||||
# EmptyBlocks mode and possible interval between empty blocks
|
||||
create_empty_blocks = true
|
||||
create_empty_blocks_interval = "0s"
|
||||
create-empty-blocks = true
|
||||
create-empty-blocks-interval = "0s"
|
||||
|
||||
# Reactor sleep duration parameters
|
||||
peer_gossip_sleep_duration = "100ms"
|
||||
peer_query_maj23_sleep_duration = "2s"
|
||||
peer-gossip-sleep-duration = "100ms"
|
||||
peer-query-maj23-sleep-duration = "2s"
|
||||
|
||||
#######################################################
|
||||
### Transaction Indexer Configuration Options ###
|
||||
#######################################################
|
||||
[tx_index]
|
||||
[tx-index]
|
||||
|
||||
# What indexer to use for transactions
|
||||
#
|
||||
@@ -393,13 +393,13 @@ indexer = "kv"
|
||||
prometheus = false
|
||||
|
||||
# Address to listen for Prometheus collector(s) connections
|
||||
prometheus_listen_addr = ":26660"
|
||||
prometheus-listen-addr = ":26660"
|
||||
|
||||
# Maximum number of simultaneous connections.
|
||||
# If you want to accept a larger number than the default, make sure
|
||||
# you increase your OS limits.
|
||||
# 0 - unlimited.
|
||||
max_open_connections = 3
|
||||
max-open-connections = 3
|
||||
|
||||
# Instrumentation namespace
|
||||
namespace = "tendermint"
|
||||
@@ -408,13 +408,13 @@ namespace = "tendermint"
|
||||
|
||||
## Empty blocks VS no empty blocks
|
||||
|
||||
### create_empty_blocks = true
|
||||
### create-empty-blocks = true
|
||||
|
||||
If `create_empty_blocks` is set to `true` in your config, blocks will be
|
||||
If `create-empty-blocks` is set to `true` in your config, blocks will be
|
||||
created ~ every second (with default consensus parameters). You can regulate
|
||||
the delay between blocks by changing the `timeout_commit`. E.g. `timeout_commit = "10s"` should result in ~ 10 second blocks.
|
||||
the delay between blocks by changing the `timeout-commit`. E.g. `timeout-commit = "10s"` should result in ~ 10 second blocks.
|
||||
|
||||
### create_empty_blocks = false
|
||||
### create-empty-blocks = false
|
||||
|
||||
In this setting, blocks are created when transactions received.
|
||||
|
||||
@@ -428,17 +428,17 @@ block has the new application hash for the state X. That's why we make a new
|
||||
(empty) block if the application hash changes. Otherwise, you won't be able to
|
||||
make a proof for the new state.
|
||||
|
||||
Plus, if you set `create_empty_blocks_interval` to something other than the
|
||||
Plus, if you set `create-empty-blocks-interval` to something other than the
|
||||
default (`0`), Tendermint will be creating empty blocks even in the absence of
|
||||
transactions every `create_empty_blocks_interval`. For instance, with
|
||||
`create_empty_blocks = false` and `create_empty_blocks_interval = "30s"`,
|
||||
transactions every `create-empty-blocks-interval`. For instance, with
|
||||
`create-empty-blocks = false` and `create-empty-blocks-interval = "30s"`,
|
||||
Tendermint will only create blocks if there are transactions, or after waiting
|
||||
30 seconds without receiving any transactions.
|
||||
|
||||
## Consensus timeouts explained
|
||||
|
||||
There's a variety of information about timeouts in [Running in
|
||||
production](./running-in-production.md)
|
||||
production](../tendermint-core/running-in-production.md)
|
||||
|
||||
You can also find more detailed technical explanation in the spec: [The latest
|
||||
gossip on BFT consensus](https://arxiv.org/abs/1807.04938).
|
||||
@@ -447,32 +447,32 @@ gossip on BFT consensus](https://arxiv.org/abs/1807.04938).
|
||||
[consensus]
|
||||
...
|
||||
|
||||
timeout_propose = "3s"
|
||||
timeout_propose_delta = "500ms"
|
||||
timeout_prevote = "1s"
|
||||
timeout_prevote_delta = "500ms"
|
||||
timeout_precommit = "1s"
|
||||
timeout_precommit_delta = "500ms"
|
||||
timeout_commit = "1s"
|
||||
timeout-propose = "3s"
|
||||
timeout-propose-delta = "500ms"
|
||||
timeout-prevote = "1s"
|
||||
timeout-prevote-delta = "500ms"
|
||||
timeout-precommit = "1s"
|
||||
timeout-precommit-delta = "500ms"
|
||||
timeout-commit = "1s"
|
||||
```
|
||||
|
||||
Note that in a successful round, the only timeout that we absolutely wait no
|
||||
matter what is `timeout_commit`.
|
||||
matter what is `timeout-commit`.
|
||||
|
||||
Here's a brief summary of the timeouts:
|
||||
|
||||
- `timeout_propose` = how long we wait for a proposal block before prevoting
|
||||
- `timeout-propose` = how long we wait for a proposal block before prevoting
|
||||
nil
|
||||
- `timeout_propose_delta` = how much timeout_propose increases with each round
|
||||
- `timeout_prevote` = how long we wait after receiving +2/3 prevotes for
|
||||
- `timeout-propose-delta` = how much timeout-propose increases with each round
|
||||
- `timeout-prevote` = how long we wait after receiving +2/3 prevotes for
|
||||
anything (ie. not a single block or nil)
|
||||
- `timeout_prevote_delta` = how much the timeout_prevote increases with each
|
||||
- `timeout-prevote-delta` = how much the timeout-prevote increases with each
|
||||
round
|
||||
- `timeout_precommit` = how long we wait after receiving +2/3 precommits for
|
||||
- `timeout-precommit` = how long we wait after receiving +2/3 precommits for
|
||||
anything (ie. not a single block or nil)
|
||||
- `timeout_precommit_delta` = how much the timeout_precommit increases with
|
||||
- `timeout-precommit-delta` = how much the timeout-precommit increases with
|
||||
each round
|
||||
- `timeout_commit` = how long we wait after committing a block, before starting
|
||||
- `timeout-commit` = 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)
|
||||
|
||||
@@ -480,12 +480,12 @@ Here's a brief summary of the timeouts:
|
||||
|
||||
This section will cover settings within the p2p section of the `config.toml`.
|
||||
|
||||
- `external_address` = is the address that will be advertised for other nodes to use. We recommend setting this field with your public IP and p2p port.
|
||||
- `external-address` = is the address that will be advertised for other nodes to use. We recommend setting this field with your public IP and p2p port.
|
||||
- `seeds` = is a list of comma separated seed nodes that you will connect upon a start and ask for peers. A seed node is a node that does not participate in consensus but only helps propagate peers to nodes in the networks
|
||||
- `persistent_peers` = is a list of comma separated peers that you will always want to be connected to. If you're already connected to the maximum number of peers, persistent peers will not be added.
|
||||
- `max_num_inbound_peers` = is the maximum number of peers you will accept inbound connections from at one time (where they dial your address and initiate the connection).
|
||||
- `max_num_outbound_peers` = is the maximum number of peers you will initiate outbound connects to at one time (where you dial their address and initiate the connection).
|
||||
- `unconditional_peer_ids` = is similar to `persistent_peers` except that these peers will be connected to even if you are already connected to the maximum number of peers. This can be a validator node ID on your sentry node.
|
||||
- `persistent-peers` = is a list of comma separated peers that you will always want to be connected to. If you're already connected to the maximum number of peers, persistent peers will not be added.
|
||||
- `max-num-inbound-peers` = is the maximum number of peers you will accept inbound connections from at one time (where they dial your address and initiate the connection).
|
||||
- `max-num-outbound-peers` = is the maximum number of peers you will initiate outbound connects to at one time (where you dial their address and initiate the connection).
|
||||
- `unconditional-peer-ids` = is similar to `persistent-peers` except that these peers will be connected to even if you are already connected to the maximum number of peers. This can be a validator node ID on your sentry node.
|
||||
- `pex` = turns the peer exchange reactor on or off. Validator node will want the `pex` turned off so it would not begin gossiping to unknown peers on the network. PeX can also be turned off for statically configured networks with fixed network connectivity. For full nodes on open, dynamic networks, it should be turned on.
|
||||
- `seed_mode` = is used for when node operators want to run their node as a seed node. Seed node's run a variation of the PeX protocol that disconnects from peers after sending them a list of peers to connect to. To minimize the servers usage, it is recommended to set the mempool's size to 0.
|
||||
- `private_peer_ids` = is a comma separated list of node ids that you would not like exposed to other peers (ie. you will not tell other peers about the private_peer_ids). This can be filled with a validators node id.
|
||||
- `seed-mode` = is used for when node operators want to run their node as a seed node. Seed node's run a variation of the PeX protocol that disconnects from peers after sending them a list of peers to connect to. To minimize the servers usage, it is recommended to set the mempool's size to 0.
|
||||
- `private-peer-ids` = is a comma separated list of node ids that you would not like exposed to other peers (ie. you will not tell other peers about the private-peer-ids). This can be filled with a validators node id.
|
||||
|
||||
@@ -26,7 +26,7 @@ Validators have a cryptographic key-pair and an associated amount of
|
||||
|
||||
There are two ways to become validator.
|
||||
|
||||
1. They can be pre-established in the [genesis state](./using-tendermint.md#genesis)
|
||||
1. They can be pre-established in the [genesis state](../tendermint-core/using-tendermint.md#genesis)
|
||||
2. The ABCI app responds to the EndBlock message with changes to the
|
||||
existing validator set.
|
||||
|
||||
@@ -56,23 +56,23 @@ The validator will only talk to the sentry that are provided, the sentry nodes w
|
||||
|
||||
When initializing nodes there are five parameters in the `config.toml` that may need to be altered.
|
||||
|
||||
- `pex:` boolean. This turns the peer exchange reactor on or off for a node. When `pex=false`, only the `persistent_peers` list is available for connection.
|
||||
- `persistent_peers:` a comma separated list of `nodeID@ip:port` values that define a list of peers that are expected to be online at all times. This is necessary at first startup because by setting `pex=false` the node will not be able to join the network.
|
||||
- `unconditional_peer_ids:` comma separated list of nodeID's. These nodes will be connected to no matter the limits of inbound and outbound peers. This is useful for when sentry nodes have full address books.
|
||||
- `private_peer_ids:` comma separated list of nodeID's. These nodes will not be gossiped to the network. This is an important field as you do not want your validator IP gossiped to the network.
|
||||
- `addr_book_strict:` boolean. By default nodes with a routable address will be considered for connection. If this setting is turned off (false), non-routable IP addresses, like addresses in a private network can be added to the address book.
|
||||
- `double_sign_check_height` int64 height. How many blocks to look back to check existence of the node's consensus votes before joining consensus When non-zero, the node will panic upon restart if the same consensus key was used to sign {double_sign_check_height} last blocks. So, validators should stop the state machine, wait for some blocks, and then restart the state machine to avoid panic.
|
||||
- `pex:` boolean. This turns the peer exchange reactor on or off for a node. When `pex=false`, only the `persistent-peers` list is available for connection.
|
||||
- `persistent-peers:` a comma separated list of `nodeID@ip:port` values that define a list of peers that are expected to be online at all times. This is necessary at first startup because by setting `pex=false` the node will not be able to join the network.
|
||||
- `unconditional-peer-ids:` comma separated list of nodeID's. These nodes will be connected to no matter the limits of inbound and outbound peers. This is useful for when sentry nodes have full address books.
|
||||
- `private-peer-ids:` comma separated list of nodeID's. These nodes will not be gossiped to the network. This is an important field as you do not want your validator IP gossiped to the network.
|
||||
- `addr-book-strict:` boolean. By default nodes with a routable address will be considered for connection. If this setting is turned off (false), non-routable IP addresses, like addresses in a private network can be added to the address book.
|
||||
- `double-sign-check-height` int64 height. How many blocks to look back to check existence of the node's consensus votes before joining consensus When non-zero, the node will panic upon restart if the same consensus key was used to sign {double_sign_check_height} last blocks. So, validators should stop the state machine, wait for some blocks, and then restart the state machine to avoid panic.
|
||||
|
||||
#### Validator Node Configuration
|
||||
|
||||
| Config Option | Setting |
|
||||
| ------------------------ | -------------------------- |
|
||||
| pex | false |
|
||||
| persistent_peers | list of sentry nodes |
|
||||
| private_peer_ids | none |
|
||||
| unconditional_peer_ids | optionally sentry node IDs |
|
||||
| addr_book_strict | false |
|
||||
| double_sign_check_height | 10 |
|
||||
| persistent-peers | list of sentry nodes |
|
||||
| private-peer-ids | none |
|
||||
| unconditional-peer-ids | optionally sentry node IDs |
|
||||
| addr-book-strict | false |
|
||||
| double-sign-check-height | 10 |
|
||||
|
||||
The validator node should have `pex=false` so it does not gossip to the entire network. The persistent peers will be your sentry nodes. Private peers can be left empty as the validator is not trying to hide who it is communicating with. Setting unconditional peers is optional for a validator because they will not have a full address books.
|
||||
|
||||
@@ -81,10 +81,10 @@ The validator node should have `pex=false` so it does not gossip to the entire n
|
||||
| Config Option | Setting |
|
||||
| ---------------------- | --------------------------------------------- |
|
||||
| pex | true |
|
||||
| persistent_peers | validator node, optionally other sentry nodes |
|
||||
| private_peer_ids | validator node ID |
|
||||
| unconditional_peer_ids | validator node ID, optionally sentry node IDs |
|
||||
| addr_book_strict | false |
|
||||
| persistent-peers | validator node, optionally other sentry nodes |
|
||||
| private-peer-ids | validator node ID |
|
||||
| unconditional-peer-ids | validator node ID, optionally sentry node IDs |
|
||||
| addr-book-strict | false |
|
||||
|
||||
The sentry nodes should be able to talk to the entire network hence why `pex=true`. The persistent peers of a sentry node will be the validator, and optionally other sentry nodes. The sentry nodes should make sure that they do not gossip the validator's ip, to do this you must put the validators nodeID as a private peer. The unconditional peer IDs will be the validator ID and optionally other sentry nodes.
|
||||
|
||||
|
||||
@@ -4,4 +4,4 @@ order: false
|
||||
|
||||
# Configuration
|
||||
|
||||
This file has moved to the [node_operators section](../node_operators/configuration.md).
|
||||
This file has moved to the [nodes section](../nodes/configuration.md).
|
||||
|
||||
@@ -4,4 +4,4 @@ order: false
|
||||
|
||||
# Metrics
|
||||
|
||||
This file has moved to the [node_operators section](../node_operators/metrics.md).
|
||||
This file has moved to the [node section](../node/metrics.md).
|
||||
|
||||
@@ -36,14 +36,14 @@ Applications can use [state sync](state-sync.md) to help nodes bootstrap quickly
|
||||
|
||||
## Logging
|
||||
|
||||
Default logging level (`log_level = "main:info,state:info,statesync:info,*:error"`) should suffice for
|
||||
Default logging level (`log-level = "main:info,state:info,statesync:info,*:error"`) should suffice for
|
||||
normal operation mode. Read [this
|
||||
post](https://blog.cosmos.network/one-of-the-exciting-new-features-in-0-10-0-release-is-smart-log-level-flag-e2506b4ab756)
|
||||
for details on how to configure `log_level` config variable. Some of the
|
||||
for details on how to configure `log-level` config variable. Some of the
|
||||
modules can be found [here](./how-to-read-logs.md#list-of-modules). If
|
||||
you're trying to debug Tendermint or asked to provide logs with debug
|
||||
logging level, you can do so by running Tendermint with
|
||||
`--log_level="*:debug"`.
|
||||
`--log-level="*:debug"`.
|
||||
|
||||
## Write Ahead Logs (WAL)
|
||||
|
||||
@@ -73,7 +73,7 @@ polling for them, or using `/broadcast_tx_commit`. In the worst case, txs can be
|
||||
resent from the mempool WAL manually.
|
||||
|
||||
For the above reasons, the `mempool.wal` is disabled by default. To enable, set
|
||||
`mempool.wal_dir` to where you want the WAL to be located (e.g.
|
||||
`mempool.wal-dir` to where you want the WAL to be located (e.g.
|
||||
`data/mempool.wal`).
|
||||
|
||||
## DOS Exposure and Mitigation
|
||||
@@ -296,10 +296,10 @@ Cosmos network.
|
||||
|
||||
## Configuration parameters
|
||||
|
||||
- `p2p.flush_throttle_timeout`
|
||||
- `p2p.max_packet_msg_payload_size`
|
||||
- `p2p.send_rate`
|
||||
- `p2p.recv_rate`
|
||||
- `p2p.flush-throttle-timeout`
|
||||
- `p2p.max-packet-msg-payload-size`
|
||||
- `p2p.send-rate`
|
||||
- `p2p.recv-rate`
|
||||
|
||||
If you are going to use Tendermint in a private domain and you have a
|
||||
private high-speed network among your peers, it makes sense to lower
|
||||
@@ -308,10 +308,10 @@ flush throttle timeout and increase other params.
|
||||
```toml
|
||||
[p2p]
|
||||
|
||||
send_rate=20000000 # 2MB/s
|
||||
recv_rate=20000000 # 2MB/s
|
||||
flush_throttle_timeout=10
|
||||
max_packet_msg_payload_size=10240 # 10KB
|
||||
send-rate=20000000 # 2MB/s
|
||||
recv-rate=20000000 # 2MB/s
|
||||
flush-throttle-timeout=10
|
||||
max-packet-msg-payload-size=10240 # 10KB
|
||||
```
|
||||
|
||||
- `mempool.recheck`
|
||||
@@ -328,26 +328,26 @@ Setting this to false will stop the mempool from relaying transactions
|
||||
to other peers until they are included in a block. It means only the
|
||||
peer you send the tx to will see it until it is included in a block.
|
||||
|
||||
- `consensus.skip_timeout_commit`
|
||||
- `consensus.skip-timeout-commit`
|
||||
|
||||
We want `skip_timeout_commit=false` when there is economics on the line
|
||||
We want `skip-timeout-commit=false` when there is economics on the line
|
||||
because proposers should wait to hear for more votes. But if you don't
|
||||
care about that and want the fastest consensus, you can skip it. It will
|
||||
be kept false by default for public deployments (e.g. [Cosmos
|
||||
Hub](https://cosmos.network/intro/hub)) while for enterprise
|
||||
applications, setting it to true is not a problem.
|
||||
|
||||
- `consensus.peer_gossip_sleep_duration`
|
||||
- `consensus.peer-gossip-sleep-duration`
|
||||
|
||||
You can try to reduce the time your node sleeps before checking if
|
||||
theres something to send its peers.
|
||||
|
||||
- `consensus.timeout_commit`
|
||||
- `consensus.timeout-commit`
|
||||
|
||||
You can also try lowering `timeout_commit` (time we sleep before
|
||||
You can also try lowering `timeout-commit` (time we sleep before
|
||||
proposing the next block).
|
||||
|
||||
- `p2p.addr_book_strict`
|
||||
- `p2p.addr-book-strict`
|
||||
|
||||
By default, Tendermint checks whenever a peer's address is routable before
|
||||
saving it to the address book. The address is considered as routable if the IP
|
||||
@@ -355,10 +355,10 @@ is [valid and within allowed
|
||||
ranges](https://github.com/tendermint/tendermint/blob/27bd1deabe4ba6a2d9b463b8f3e3f1e31b993e61/p2p/netaddress.go#L209).
|
||||
|
||||
This may not be the case for private or local networks, where your IP range is usually
|
||||
strictly limited and private. If that case, you need to set `addr_book_strict`
|
||||
strictly limited and private. If that case, you need to set `addr-book-strict`
|
||||
to `false` (turn it off).
|
||||
|
||||
- `rpc.max_open_connections`
|
||||
- `rpc.max-open-connections`
|
||||
|
||||
By default, the number of simultaneous connections is limited because most OS
|
||||
give you limited number of file descriptors.
|
||||
@@ -392,4 +392,4 @@ echo $((N/8)) > /sys/module/nf_conntrack/parameters/hashsize
|
||||
```
|
||||
|
||||
The similar option exists for limiting the number of gRPC connections -
|
||||
`rpc.grpc_max_open_connections`.
|
||||
`rpc.grpc-max-open-connections`.
|
||||
|
||||
@@ -138,7 +138,7 @@ another window. If you don't, kill Tendermint and run an in-process version of
|
||||
the `kvstore` app:
|
||||
|
||||
```bash
|
||||
tendermint node --proxy_app=kvstore
|
||||
tendermint node --proxy-app=kvstore
|
||||
```
|
||||
|
||||
After a few seconds, you should see blocks start streaming in. Note that blocks
|
||||
@@ -148,11 +148,11 @@ Blocks_, below, to modify this setting.
|
||||
Tendermint supports in-process versions of the `counter`, `kvstore`, and `noop`
|
||||
apps that ship as examples with `abci-cli`. It's easy to compile your app
|
||||
in-process with Tendermint if it's written in Go. If your app is not written in
|
||||
Go, run it in another process, and use the `--proxy_app` flag to specify the
|
||||
Go, run it in another process, and use the `--proxy-app` flag to specify the
|
||||
address of the socket it is listening on, for instance:
|
||||
|
||||
```bash
|
||||
tendermint node --proxy_app=/var/run/abci.sock
|
||||
tendermint node --proxy-app=/var/run/abci.sock
|
||||
```
|
||||
|
||||
You can find out what flags are supported by running `tendermint node --help`.
|
||||
@@ -254,7 +254,7 @@ Tendermint uses a `config.toml` for configuration. For details, see [the
|
||||
config specification](./configuration.md).
|
||||
|
||||
Notable options include the socket address of the application
|
||||
(`proxy_app`), the listening address of the Tendermint peer
|
||||
(`proxy-app`), the listening address of the Tendermint peer
|
||||
(`p2p.laddr`), and the listening address of the RPC server
|
||||
(`rpc.laddr`).
|
||||
|
||||
@@ -441,7 +441,7 @@ have to use a seed node if you have a live persistent peer.
|
||||
To connect to peers on start-up, specify them in the
|
||||
`$TMHOME/config/config.toml` or on the command line. Use `seeds` to
|
||||
specify seed nodes, and
|
||||
`persistent_peers` to specify peers that your node will maintain
|
||||
`persistent-peers` to specify peers that your node will maintain
|
||||
persistent connections with.
|
||||
|
||||
For example,
|
||||
@@ -462,12 +462,12 @@ should not need seeds after the first start.
|
||||
|
||||
If you want Tendermint to connect to specific set of addresses and
|
||||
maintain a persistent connection with each, you can use the
|
||||
`--p2p.persistent_peers` flag or the corresponding setting in the
|
||||
`--p2p.persistent-peers` flag or the corresponding setting in the
|
||||
`config.toml` or the `/dial_peers` RPC endpoint to do it without
|
||||
stopping Tendermint core instance.
|
||||
|
||||
```sh
|
||||
tendermint node --p2p.persistent_peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
|
||||
tendermint node --p2p.persistent-peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
|
||||
|
||||
curl 'localhost:26657/dial_peers?persistent=true&peers=\["429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656","96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"\]'
|
||||
```
|
||||
@@ -546,7 +546,7 @@ file and the new `priv_validator_key.json` to the `~/.tendermint/config` on
|
||||
a new machine.
|
||||
|
||||
Now run `tendermint node` on both machines, and use either
|
||||
`--p2p.persistent_peers` or the `/dial_peers` to get them to peer up.
|
||||
`--p2p.persistent-peers` or the `/dial_peers` to get them to peer up.
|
||||
They should start making blocks, and will only continue to do so as long
|
||||
as both of them are online.
|
||||
|
||||
|
||||
@@ -4,4 +4,4 @@ order: false
|
||||
|
||||
# Validators
|
||||
|
||||
This file has moved to the [node_operators section](../node_operators/validators.md).
|
||||
This file has moved to the [node section](../node/validators.md).
|
||||
|
||||
@@ -9,7 +9,7 @@ parent:
|
||||
|
||||
Tendermint has some tools that are associated with it for:
|
||||
|
||||
- [Debugging](./debugging.md)
|
||||
- [Debugging](./debugging/pro.md)
|
||||
- [Benchmarking](#benchmarking)
|
||||
- [Testnets](#testnets)
|
||||
- [Validation of remote signers](./remote-signer-validation.md)
|
||||
|
||||
@@ -46,7 +46,7 @@ To ease the burden of collecting different pieces of data Tendermint Core (since
|
||||
tendermint debug kill <pid> </path/to/out.zip> — home=</path/to/app.d>
|
||||
```
|
||||
|
||||
Here’s the official documentation page — <https://docs.tendermint.com/master/tools/debugging.html>
|
||||
Here’s the official documentation page — <https://docs.tendermint.com/master/tools/debugging>
|
||||
|
||||
If you’re using a process supervisor, like systemd, it will restart the Tendermint automatically. We strongly advise you to have one in production. If not, you will need to restart the node by hand.
|
||||
|
||||
@@ -491,7 +491,7 @@ Then we need to start Tendermint Core and point it to our application. Staying
|
||||
within the application directory execute:
|
||||
|
||||
```bash
|
||||
TMHOME="/tmp/example" tendermint node --proxy_app=unix://example.sock
|
||||
TMHOME="/tmp/example" tendermint node --proxy-app=unix://example.sock
|
||||
|
||||
I[2019-07-16|18:26:20.362] Version info module=main software=0.32.1 block=10 p2p=7
|
||||
I[2019-07-16|18:26:20.383] Starting Node module=main impl=Node
|
||||
|
||||
@@ -573,7 +573,7 @@ Then we need to start Tendermint Core and point it to our application. Staying
|
||||
within the application directory execute:
|
||||
|
||||
```bash
|
||||
$ TMHOME="/tmp/example" tendermint node --abci grpc --proxy_app tcp://127.0.0.1:26658
|
||||
$ TMHOME="/tmp/example" tendermint node --abci grpc --proxy-app tcp://127.0.0.1:26658
|
||||
|
||||
I[2019-07-28|15:44:53.632] Version info module=main software=0.32.1 block=10 p2p=7
|
||||
I[2019-07-28|15:44:53.677] Starting Node module=main impl=Node
|
||||
|
||||
@@ -547,7 +547,7 @@ Then we need to start Tendermint Core and point it to our application. Staying
|
||||
within the application directory execute:
|
||||
|
||||
```bash
|
||||
TMHOME="/tmp/example" tendermint node --abci grpc --proxy_app tcp://127.0.0.1:26658
|
||||
TMHOME="/tmp/example" tendermint node --abci grpc --proxy-app tcp://127.0.0.1:26658
|
||||
|
||||
I[2019-07-28|15:44:53.632] Version info module=main software=0.32.1 block=10 p2p=7
|
||||
I[2019-07-28|15:44:53.677] Starting Node module=main impl=Node
|
||||
|
||||
@@ -8,7 +8,7 @@ Restart=on-failure
|
||||
User={{service}}
|
||||
Group={{service}}
|
||||
PermissionsStartOnly=true
|
||||
ExecStart=/usr/bin/tendermint node --proxy_app=kvstore
|
||||
ExecStart=/usr/bin/tendermint node --proxy-app=kvstore
|
||||
ExecReload=/bin/kill -HUP $MAINPID
|
||||
KillSignal=SIGTERM
|
||||
|
||||
|
||||
@@ -113,7 +113,7 @@ id3=$(strip $id3)
|
||||
old_ansible_file=$GOPATH/src/github.com/tendermint/tendermint/networks/remote/ansible/roles/install/templates/systemd.service.j2
|
||||
rm $old_ansible_file
|
||||
|
||||
# need to populate the `--p2p.persistent_peers` flag
|
||||
# need to populate the `--p2p.persistent-peers` flag
|
||||
echo "[Unit]
|
||||
Description={{service}}
|
||||
Requires=network-online.target
|
||||
@@ -124,7 +124,7 @@ Restart=on-failure
|
||||
User={{service}}
|
||||
Group={{service}}
|
||||
PermissionsStartOnly=true
|
||||
ExecStart=/usr/bin/tendermint node --proxy_app=kvstore --p2p.persistent_peers=$id0@$ip0:26656,$id1@$ip1:26656,$id2@$ip2:26656,$id3@$ip3:26656
|
||||
ExecStart=/usr/bin/tendermint node --proxy-app=kvstore --p2p.persistent-peers=$id0@$ip0:26656,$id1@$ip1:26656,$id2@$ip2:26656,$id3@$ip3:26656
|
||||
ExecReload=/bin/kill -HUP \$MAINPID
|
||||
KillSignal=SIGTERM
|
||||
|
||||
|
||||
@@ -774,7 +774,7 @@ func NewNode(config *cfg.Config,
|
||||
|
||||
err = sw.AddPersistentPeers(splitAndTrimEmpty(config.P2P.PersistentPeers, ",", " "))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not add peers from persistent_peers field: %w", err)
|
||||
return nil, fmt.Errorf("could not add peers from persistent-peers field: %w", err)
|
||||
}
|
||||
|
||||
err = sw.AddUnconditionalPeerIDs(splitAndTrimEmpty(config.P2P.UnconditionalPeerIDs, ",", " "))
|
||||
@@ -908,7 +908,7 @@ func (n *Node) OnStart() error {
|
||||
// Always connect to persistent peers
|
||||
err = n.sw.DialPeersAsync(splitAndTrimEmpty(n.config.P2P.PersistentPeers, ",", " "))
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not dial peers from persistent_peers field: %w", err)
|
||||
return fmt.Errorf("could not dial peers from persistent-peers field: %w", err)
|
||||
}
|
||||
|
||||
// Run state sync
|
||||
|
||||
@@ -45,7 +45,7 @@ go build
|
||||
Use `maverick init` to initialize a single node and `maverick node` to run it. This will run it normally unless you use the misbehaviors flag as follows:
|
||||
|
||||
```bash
|
||||
maverick node --proxy_app persistent_kvstore --misbehaviors double-vote,10
|
||||
maverick node --proxy-app persistent_kvstore --misbehaviors double-vote,10
|
||||
```
|
||||
|
||||
This would cause the node to vote twice in every round at height 10. To add more misbehaviors at different heights, append the next misbehavior and height after the first (with comma separation).
|
||||
|
||||
@@ -818,7 +818,7 @@ func NewNode(config *cfg.Config,
|
||||
|
||||
err = sw.AddPersistentPeers(splitAndTrimEmpty(config.P2P.PersistentPeers, ",", " "))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("could not add peers from persistent_peers field: %w", err)
|
||||
return nil, fmt.Errorf("could not add peers from persistent-peers field: %w", err)
|
||||
}
|
||||
|
||||
err = sw.AddUnconditionalPeerIDs(splitAndTrimEmpty(config.P2P.UnconditionalPeerIDs, ",", " "))
|
||||
@@ -952,7 +952,7 @@ func (n *Node) OnStart() error {
|
||||
// Always connect to persistent peers
|
||||
err = n.sw.DialPeersAsync(splitAndTrimEmpty(n.config.P2P.PersistentPeers, ",", " "))
|
||||
if err != nil {
|
||||
return fmt.Errorf("could not dial peers from persistent_peers field: %w", err)
|
||||
return fmt.Errorf("could not dial peers from persistent-peers field: %w", err)
|
||||
}
|
||||
|
||||
// Run state sync
|
||||
|
||||
@@ -152,7 +152,7 @@ spec:
|
||||
done
|
||||
seeds=$(IFS=','; echo "${seeds[*]}")
|
||||
|
||||
tendermint node --p2p.seeds="$seeds" --moniker="`hostname`" --proxy_app="unix:///socks/app.sock"
|
||||
tendermint node --p2p.seeds="$seeds" --moniker="`hostname`" --proxy-app="unix:///socks/app.sock"
|
||||
volumeMounts:
|
||||
- name: tmdir
|
||||
mountPath: /tendermint
|
||||
|
||||
@@ -144,7 +144,7 @@ spec:
|
||||
done
|
||||
seeds=$(IFS=','; echo "${seeds[*]}")
|
||||
|
||||
tendermint node --p2p.seeds="$seeds" --moniker="`hostname`" --proxy_app="unix:///socks/app.sock"
|
||||
tendermint node --p2p.seeds="$seeds" --moniker="`hostname`" --proxy-app="unix:///socks/app.sock"
|
||||
volumeMounts:
|
||||
- name: tmdir
|
||||
mountPath: /tendermint
|
||||
|
||||
@@ -144,7 +144,7 @@ spec:
|
||||
done
|
||||
seeds=$(IFS=','; echo "${seeds[*]}")
|
||||
|
||||
tendermint node --p2p.seeds="$seeds" --moniker="`hostname`" --proxy_app="dummy"
|
||||
tendermint node --p2p.seeds="$seeds" --moniker="`hostname`" --proxy-app="dummy"
|
||||
volumeMounts:
|
||||
- name: tmdir
|
||||
mountPath: /tendermint
|
||||
|
||||
Reference in New Issue
Block a user