package config import ( "bytes" "fmt" "io/ioutil" "os" "path/filepath" "strings" "text/template" tmos "github.com/tendermint/tendermint/libs/os" ) // DefaultDirPerm is the default permissions used when creating directories. const DefaultDirPerm = 0700 var configTemplate *template.Template func init() { var err error tmpl := template.New("configFileTemplate").Funcs(template.FuncMap{ "StringsJoin": strings.Join, }) if configTemplate, err = tmpl.Parse(defaultConfigTemplate); err != nil { panic(err) } } /****** these are for production settings ***********/ // EnsureRoot creates the root, config, and data directories if they don't exist, // and panics if it fails. func EnsureRoot(rootDir string) { if err := tmos.EnsureDir(rootDir, DefaultDirPerm); err != nil { panic(err.Error()) } if err := tmos.EnsureDir(filepath.Join(rootDir, defaultConfigDir), DefaultDirPerm); err != nil { panic(err.Error()) } if err := tmos.EnsureDir(filepath.Join(rootDir, defaultDataDir), DefaultDirPerm); err != nil { panic(err.Error()) } } // WriteConfigFile renders config using the template and writes it to configFilePath. // This function is called by cmd/tendermint/commands/init.go func WriteConfigFile(rootDir string, config *Config) { var buffer bytes.Buffer if err := configTemplate.Execute(&buffer, config); err != nil { panic(err) } configFilePath := filepath.Join(rootDir, defaultConfigFilePath) mustWriteFile(configFilePath, buffer.Bytes(), 0644) } func writeDefaultConfigFileIfNone(rootDir string) { configFilePath := filepath.Join(rootDir, defaultConfigFilePath) if !tmos.FileExists(configFilePath) { WriteConfigFile(rootDir, DefaultConfig()) } } // Note: any changes to the comments/variables/mapstructure // must be reflected in the appropriate struct in config/config.go const defaultConfigTemplate = `# This is a TOML config file. # For more information, see https://github.com/toml-lang/toml # NOTE: Any path below can be absolute (e.g. "/var/myawesomeapp/data") or # relative to the home directory (e.g. "data"). The home directory is # "$HOME/.tendermint" by default, but could be changed via $TMHOME env variable # or --home cmd flag. ####################################################################### ### Main Base Config Options ### ####################################################################### # TCP or UNIX socket address of the ABCI application, # or the name of an ABCI application compiled in with the Tendermint binary proxy-app = "{{ .BaseConfig.ProxyApp }}" # A custom human readable name for this node moniker = "{{ .BaseConfig.Moniker }}" # Mode of Node: full | validator | seed # * validator node # - all reactors # - with priv_validator_key.json, priv_validator_state.json # * full node # - all reactors # - No priv_validator_key.json, priv_validator_state.json # * seed node # - only P2P, PEX Reactor # - No priv_validator_key.json, priv_validator_state.json mode = "{{ .BaseConfig.Mode }}" # 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 = {{ .BaseConfig.FastSyncMode }} # Database backend: goleveldb | cleveldb | boltdb | rocksdb | badgerdb # * goleveldb (github.com/syndtr/goleveldb - most popular implementation) # - pure go # - stable # * cleveldb (uses levigo wrapper) # - fast # - requires gcc # - use cleveldb build tag (go build -tags cleveldb) # * boltdb (uses etcd's fork of bolt - github.com/etcd-io/bbolt) # - EXPERIMENTAL # - may be faster is some use-cases (random reads - indexer) # - use boltdb build tag (go build -tags boltdb) # * rocksdb (uses github.com/tecbot/gorocksdb) # - EXPERIMENTAL # - requires gcc # - use rocksdb build tag (go build -tags rocksdb) # * badgerdb (uses github.com/dgraph-io/badger) # - EXPERIMENTAL # - use badgerdb build tag (go build -tags badgerdb) db-backend = "{{ .BaseConfig.DBBackend }}" # Database directory db-dir = "{{ js .BaseConfig.DBPath }}" # Output level for logging, including package level options log-level = "{{ .BaseConfig.LogLevel }}" # Output format: 'plain' (colored text) or 'json' log-format = "{{ .BaseConfig.LogFormat }}" ##### additional base config options ##### # Path to the JSON file containing the initial validator set and other meta data genesis-file = "{{ js .BaseConfig.Genesis }}" # Path to the JSON file containing the private key to use for node authentication in the p2p protocol node-key-file = "{{ js .BaseConfig.NodeKey }}" # Mechanism to connect to the ABCI application: socket | grpc abci = "{{ .BaseConfig.ABCI }}" # 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 = {{ .BaseConfig.FilterPeers }} ####################################################### ### Priv Validator Configuration ### ####################################################### [priv-validator] # Path to the JSON file containing the private key to use as a validator in the consensus protocol key-file = "{{ js .PrivValidator.Key }}" # Path to the JSON file containing the last sign state of a validator state-file = "{{ js .PrivValidator.State }}" # TCP or UNIX socket address for Tendermint to listen on for # connections from an external PrivValidator process # when the listenAddr is prefixed with grpc instead of tcp it will use the gRPC Client laddr = "{{ .PrivValidator.ListenAddr }}" # Client certificate generated while creating needed files for secure connection. # If a remote validator address is provided but no certificate, the connection will be insecure client-certificate-file = "{{ js .PrivValidator.ClientCertificate }}" # Client key generated while creating certificates for secure connection validator-client-key-file = "{{ js .PrivValidator.ClientKey }}" # Path Root Certificate Authority used to sign both client and server certificates certificate-authority = "{{ js .PrivValidator.RootCA }}" ####################################################################### ### Advanced Configuration Options ### ####################################################################### ####################################################### ### RPC Server Configuration Options ### ####################################################### [rpc] # TCP or UNIX socket address for the RPC server to listen on laddr = "{{ .RPC.ListenAddress }}" # 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 = [{{ range .RPC.CORSAllowedOrigins }}{{ printf "%q, " . }}{{end}}] # A list of methods the client is allowed to use with cross-domain requests cors-allowed-methods = [{{ range .RPC.CORSAllowedMethods }}{{ printf "%q, " . }}{{end}}] # A list of non simple headers the client is allowed to use with cross-domain requests cors-allowed-headers = [{{ range .RPC.CORSAllowedHeaders }}{{ printf "%q, " . }}{{end}}] # TCP or UNIX socket address for the gRPC server to listen on # NOTE: This server only supports /broadcast_tx_commit # Deprecated gRPC in the RPC layer of Tendermint will be deprecated in 0.36. grpc-laddr = "{{ .RPC.GRPCListenAddress }}" # Maximum number of simultaneous 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 # Deprecated gRPC in the RPC layer of Tendermint will be deprecated in 0.36. grpc-max-open-connections = {{ .RPC.GRPCMaxOpenConnections }} # Activate unsafe RPC commands like /dial-seeds and /unsafe-flush-mempool unsafe = {{ .RPC.Unsafe }} # Maximum number of simultaneous connections (including WebSocket). # 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 = {{ .RPC.MaxOpenConnections }} # 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 = {{ .RPC.MaxSubscriptionClients }} # 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 = {{ .RPC.MaxSubscriptionsPerClient }} # 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 = "{{ .RPC.TimeoutBroadcastTxCommit }}" # Maximum size of request body, in bytes max-body-bytes = {{ .RPC.MaxBodyBytes }} # Maximum size of request header, in bytes max-header-bytes = {{ .RPC.MaxHeaderBytes }} # The path to a file containing certificate that is used to create the HTTPS server. # Might 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. # Otherwise, HTTP server is run. tls-cert-file = "{{ .RPC.TLSCertFile }}" # The path to a file containing matching private key that is used to create the HTTPS server. # Might 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. # Otherwise, HTTP server is run. tls-key-file = "{{ .RPC.TLSKeyFile }}" # pprof listen address (https://golang.org/pkg/net/http/pprof) pprof-laddr = "{{ .RPC.PprofListenAddress }}" ####################################################### ### P2P Configuration Options ### ####################################################### [p2p] # Enable the new p2p layer. disable-legacy = {{ .P2P.DisableLegacy }} # Select the p2p internal queue queue-type = "{{ .P2P.QueueType }}" # Address to listen for incoming connections laddr = "{{ .P2P.ListenAddress }}" # Address to advertise to peers for them to dial # If empty, will use the same port as the laddr, # and will introspect on the listener or use UPnP # to figure out the address. ip and port are required # example: 159.89.10.97:26656 external-address = "{{ .P2P.ExternalAddress }}" # Comma separated list of seed nodes to connect to # We only use these if we can’t connect to peers in the addrbook # NOTE: not used by the new PEX reactor. Please use BootstrapPeers instead. # TODO: Remove once p2p refactor is complete # ref: https:#github.com/tendermint/tendermint/issues/5670 seeds = "{{ .P2P.Seeds }}" # Comma separated list of peers to be added to the peer store # on startup. Either BootstrapPeers or PersistentPeers are # needed for peer discovery bootstrap-peers = "{{ .P2P.BootstrapPeers }}" # Comma separated list of nodes to keep persistent connections to persistent-peers = "{{ .P2P.PersistentPeers }}" # UPNP port forwarding upnp = {{ .P2P.UPNP }} # Path to address book addr-book-file = "{{ js .P2P.AddrBook }}" # Set true for strict address routability rules # Set false for private or local networks addr-book-strict = {{ .P2P.AddrBookStrict }} # Maximum number of inbound peers # # TODO: Remove once p2p refactor is complete in favor of MaxConnections. # ref: https://github.com/tendermint/tendermint/issues/5670 max-num-inbound-peers = {{ .P2P.MaxNumInboundPeers }} # Maximum number of outbound peers to connect to, excluding persistent peers # # TODO: Remove once p2p refactor is complete in favor of MaxConnections. # ref: https://github.com/tendermint/tendermint/issues/5670 max-num-outbound-peers = {{ .P2P.MaxNumOutboundPeers }} # Maximum number of connections (inbound and outbound). max-connections = {{ .P2P.MaxConnections }} # Rate limits the number of incoming connection attempts per IP address. max-incoming-connection-attempts = {{ .P2P.MaxIncomingConnectionAttempts }} # List of node IDs, to which a connection will be (re)established ignoring any existing limits unconditional-peer-ids = "{{ .P2P.UnconditionalPeerIDs }}" # Maximum pause when redialing a persistent peer (if zero, exponential backoff is used) persistent-peers-max-dial-period = "{{ .P2P.PersistentPeersMaxDialPeriod }}" # Time to wait before flushing messages out on the connection flush-throttle-timeout = "{{ .P2P.FlushThrottleTimeout }}" # Maximum size of a message packet payload, in bytes max-packet-msg-payload-size = {{ .P2P.MaxPacketMsgPayloadSize }} # Rate at which packets can be sent, in bytes/second send-rate = {{ .P2P.SendRate }} # Rate at which packets can be received, in bytes/second recv-rate = {{ .P2P.RecvRate }} # Set true to enable the peer-exchange reactor pex = {{ .P2P.PexReactor }} # Comma separated list of peer IDs to keep private (will not be gossiped to other peers) # Warning: IPs will be exposed at /net_info, for more information https://github.com/tendermint/tendermint/issues/3055 private-peer-ids = "{{ .P2P.PrivatePeerIDs }}" # Toggle to disable guard against peers connecting from the same ip. allow-duplicate-ip = {{ .P2P.AllowDuplicateIP }} # Peer connection configuration. handshake-timeout = "{{ .P2P.HandshakeTimeout }}" dial-timeout = "{{ .P2P.DialTimeout }}" ####################################################### ### Mempool Configuration Option ### ####################################################### [mempool] # Mempool version to use: # 1) "v0" - The legacy non-prioritized mempool reactor. # 2) "v1" (default) - The prioritized mempool reactor. version = "{{ .Mempool.Version }}" recheck = {{ .Mempool.Recheck }} broadcast = {{ .Mempool.Broadcast }} # Maximum number of transactions in the mempool size = {{ .Mempool.Size }} # 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 = {{ .Mempool.MaxTxsBytes }} # Size of the cache (used to filter transactions we saw earlier) in transactions cache-size = {{ .Mempool.CacheSize }} # Do not remove invalid transactions from the cache (default: false) # Set to true if it's not possible for any invalid transaction to become valid # again in the future. keep-invalid-txs-in-cache = {{ .Mempool.KeepInvalidTxsInCache }} # Maximum size of a single transaction. # NOTE: the max size of a tx transmitted over the network is {max-tx-bytes}. max-tx-bytes = {{ .Mempool.MaxTxBytes }} # Maximum size of a batch of transactions to send to a peer # Including space needed by encoding (one varint per transaction). # XXX: Unused due to https://github.com/tendermint/tendermint/issues/5796 max-batch-bytes = {{ .Mempool.MaxBatchBytes }} ####################################################### ### State Sync Configuration Options ### ####################################################### [statesync] # State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine # snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in # the network to take and serve state machine snapshots. State sync is not attempted if the node # has any local state (LastBlockHeight > 0). The node will have a truncated block history, # starting from the height of the snapshot. enable = {{ .StateSync.Enable }} # RPC servers (comma-separated) for light client verification of the synced state machine and # 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 # weeks) during which they can be financially punished (slashed) for misbehavior. rpc-servers = "{{ StringsJoin .StateSync.RPCServers "," }}" trust-height = {{ .StateSync.TrustHeight }} trust-hash = "{{ .StateSync.TrustHash }}" trust-period = "{{ .StateSync.TrustPeriod }}" # Time to spend discovering snapshots before initiating a restore. discovery-time = "{{ .StateSync.DiscoveryTime }}" # 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 = "{{ .StateSync.TempDir }}" # The timeout duration before re-requesting a chunk, possibly from a different # peer (default: 15 seconds). chunk-request-timeout = "{{ .StateSync.ChunkRequestTimeout }}" # The number of concurrent chunk and block fetchers to run (default: 4). fetchers = "{{ .StateSync.Fetchers }}" ####################################################### ### Fast Sync Configuration Connections ### ####################################################### [fastsync] # Fast Sync version to use: # 1) "v0" (default) - the legacy fast sync implementation # 2) "v2" - complete redesign of v0, optimized for testability & readability version = "{{ .FastSync.Version }}" ####################################################### ### Consensus Configuration Options ### ####################################################### [consensus] wal-file = "{{ js .Consensus.WalPath }}" # How long we wait for a proposal block before prevoting nil timeout-propose = "{{ .Consensus.TimeoutPropose }}" # How much timeout-propose increases with each round timeout-propose-delta = "{{ .Consensus.TimeoutProposeDelta }}" # How long we wait after receiving +2/3 prevotes for “anything” (ie. not a single block or nil) timeout-prevote = "{{ .Consensus.TimeoutPrevote }}" # How much the timeout-prevote increases with each round timeout-prevote-delta = "{{ .Consensus.TimeoutPrevoteDelta }}" # How long we wait after receiving +2/3 precommits for “anything” (ie. not a single block or nil) timeout-precommit = "{{ .Consensus.TimeoutPrecommit }}" # How much the timeout-precommit increases with each round timeout-precommit-delta = "{{ .Consensus.TimeoutPrecommitDelta }}" # 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 = "{{ .Consensus.TimeoutCommit }}" # 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. double-sign-check-height = {{ .Consensus.DoubleSignCheckHeight }} # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0) skip-timeout-commit = {{ .Consensus.SkipTimeoutCommit }} # EmptyBlocks mode and possible interval between empty blocks create-empty-blocks = {{ .Consensus.CreateEmptyBlocks }} create-empty-blocks-interval = "{{ .Consensus.CreateEmptyBlocksInterval }}" # Reactor sleep duration parameters peer-gossip-sleep-duration = "{{ .Consensus.PeerGossipSleepDuration }}" peer-query-maj23-sleep-duration = "{{ .Consensus.PeerQueryMaj23SleepDuration }}" ####################################################### ### Transaction Indexer Configuration Options ### ####################################################### [tx-index] # The backend database list to back the indexer. # If list contains null, meaning no indexer service will be used. # # The application will set which txs to index. In some cases a node operator will be able # to decide which txs to index based on configuration set in the application. # # Options: # 1) "null" # 2) "kv" (default) - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend). # - When "kv" is chosen "tx.height" and "tx.hash" will always be indexed. # 3) "psql" - the indexer services backed by PostgreSQL. indexer = [{{ range $i, $e := .TxIndex.Indexer }}{{if $i}}, {{end}}{{ printf "%q" $e}}{{end}}] # The PostgreSQL connection configuration, the connection format: # postgresql://:@:/? psql-conn = "{{ .TxIndex.PsqlConn }}" ####################################################### ### Instrumentation Configuration Options ### ####################################################### [instrumentation] # When true, Prometheus metrics are served under /metrics on # PrometheusListenAddr. # Check out the documentation for the list of available metrics. prometheus = {{ .Instrumentation.Prometheus }} # Address to listen for Prometheus collector(s) connections prometheus-listen-addr = "{{ .Instrumentation.PrometheusListenAddr }}" # 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 = {{ .Instrumentation.MaxOpenConnections }} # Instrumentation namespace namespace = "{{ .Instrumentation.Namespace }}" ` /****** these are for test settings ***********/ func ResetTestRoot(testName string) *Config { return ResetTestRootWithChainID(testName, "") } func ResetTestRootWithChainID(testName string, chainID string) *Config { // create a unique, concurrency-safe test directory under os.TempDir() rootDir, err := ioutil.TempDir("", fmt.Sprintf("%s-%s_", chainID, testName)) if err != nil { panic(err) } // ensure config and data subdirs are created if err := tmos.EnsureDir(filepath.Join(rootDir, defaultConfigDir), DefaultDirPerm); err != nil { panic(err) } if err := tmos.EnsureDir(filepath.Join(rootDir, defaultDataDir), DefaultDirPerm); err != nil { panic(err) } conf := DefaultConfig() genesisFilePath := filepath.Join(rootDir, conf.Genesis) privKeyFilePath := filepath.Join(rootDir, conf.PrivValidator.Key) privStateFilePath := filepath.Join(rootDir, conf.PrivValidator.State) // Write default config file if missing. writeDefaultConfigFileIfNone(rootDir) if !tmos.FileExists(genesisFilePath) { if chainID == "" { chainID = "tendermint_test" } testGenesis := fmt.Sprintf(testGenesisFmt, chainID) mustWriteFile(genesisFilePath, []byte(testGenesis), 0644) } // we always overwrite the priv val mustWriteFile(privKeyFilePath, []byte(testPrivValidatorKey), 0644) mustWriteFile(privStateFilePath, []byte(testPrivValidatorState), 0644) config := TestConfig().SetRoot(rootDir) return config } func mustWriteFile(filePath string, contents []byte, mode os.FileMode) { if err := ioutil.WriteFile(filePath, contents, mode); err != nil { tmos.Exit(fmt.Sprintf("failed to write file: %v", err)) } } var testGenesisFmt = `{ "genesis_time": "2018-10-10T08:20:13.695936996Z", "chain_id": "%s", "initial_height": "1", "consensus_params": { "block": { "max_bytes": "22020096", "max_gas": "-1", "time_iota_ms": "10" }, "evidence": { "max_age_num_blocks": "100000", "max_age_duration": "172800000000000", "max_bytes": "1048576" }, "validator": { "pub_key_types": [ "ed25519" ] }, "version": {} }, "validators": [ { "pub_key": { "type": "tendermint/PubKeyEd25519", "value":"AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE=" }, "power": "10", "name": "" } ], "app_hash": "" }` var testPrivValidatorKey = `{ "address": "A3258DCBF45DCA0DF052981870F2D1441A36D145", "pub_key": { "type": "tendermint/PubKeyEd25519", "value": "AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE=" }, "priv_key": { "type": "tendermint/PrivKeyEd25519", "value": "EVkqJO/jIXp3rkASXfh9YnyToYXRXhBr6g9cQVxPFnQBP/5povV4HTjvsy530kybxKHwEi85iU8YL0qQhSYVoQ==" } }` var testPrivValidatorState = `{ "height": "0", "round": 0, "step": 0 }`