You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

365 lines
12 KiB

  1. package config
  2. import (
  3. "bytes"
  4. "os"
  5. "path/filepath"
  6. "text/template"
  7. cmn "github.com/tendermint/tendermint/libs/common"
  8. )
  9. var configTemplate *template.Template
  10. func init() {
  11. var err error
  12. if configTemplate, err = template.New("configFileTemplate").Parse(defaultConfigTemplate); err != nil {
  13. panic(err)
  14. }
  15. }
  16. /****** these are for production settings ***********/
  17. // EnsureRoot creates the root, config, and data directories if they don't exist,
  18. // and panics if it fails.
  19. func EnsureRoot(rootDir string) {
  20. if err := cmn.EnsureDir(rootDir, 0700); err != nil {
  21. cmn.PanicSanity(err.Error())
  22. }
  23. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultConfigDir), 0700); err != nil {
  24. cmn.PanicSanity(err.Error())
  25. }
  26. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultDataDir), 0700); err != nil {
  27. cmn.PanicSanity(err.Error())
  28. }
  29. configFilePath := filepath.Join(rootDir, defaultConfigFilePath)
  30. // Write default config file if missing.
  31. if !cmn.FileExists(configFilePath) {
  32. writeDefaultConfigFile(configFilePath)
  33. }
  34. }
  35. // XXX: this func should probably be called by cmd/tendermint/commands/init.go
  36. // alongside the writing of the genesis.json and priv_validator.json
  37. func writeDefaultConfigFile(configFilePath string) {
  38. WriteConfigFile(configFilePath, DefaultConfig())
  39. }
  40. // WriteConfigFile renders config using the template and writes it to configFilePath.
  41. func WriteConfigFile(configFilePath string, config *Config) {
  42. var buffer bytes.Buffer
  43. if err := configTemplate.Execute(&buffer, config); err != nil {
  44. panic(err)
  45. }
  46. cmn.MustWriteFile(configFilePath, buffer.Bytes(), 0644)
  47. }
  48. // Note: any changes to the comments/variables/mapstructure
  49. // must be reflected in the appropriate struct in config/config.go
  50. const defaultConfigTemplate = `# This is a TOML config file.
  51. # For more information, see https://github.com/toml-lang/toml
  52. ##### main base config options #####
  53. # TCP or UNIX socket address of the ABCI application,
  54. # or the name of an ABCI application compiled in with the Tendermint binary
  55. proxy_app = "{{ .BaseConfig.ProxyApp }}"
  56. # A custom human readable name for this node
  57. moniker = "{{ .BaseConfig.Moniker }}"
  58. # If this node is many blocks behind the tip of the chain, FastSync
  59. # allows them to catchup quickly by downloading blocks in parallel
  60. # and verifying their commits
  61. fast_sync = {{ .BaseConfig.FastSync }}
  62. # Database backend: leveldb | memdb | cleveldb
  63. db_backend = "{{ .BaseConfig.DBBackend }}"
  64. # Database directory
  65. db_dir = "{{ js .BaseConfig.DBPath }}"
  66. # Output level for logging, including package level options
  67. log_level = "{{ .BaseConfig.LogLevel }}"
  68. ##### additional base config options #####
  69. # Path to the JSON file containing the initial validator set and other meta data
  70. genesis_file = "{{ js .BaseConfig.Genesis }}"
  71. # Path to the JSON file containing the private key to use as a validator in the consensus protocol
  72. priv_validator_file = "{{ js .BaseConfig.PrivValidator }}"
  73. # TCP or UNIX socket address for Tendermint to listen on for
  74. # connections from an external PrivValidator process
  75. priv_validator_laddr = "{{ .BaseConfig.PrivValidatorListenAddr }}"
  76. # Path to the JSON file containing the private key to use for node authentication in the p2p protocol
  77. node_key_file = "{{ js .BaseConfig.NodeKey}}"
  78. # Mechanism to connect to the ABCI application: socket | grpc
  79. abci = "{{ .BaseConfig.ABCI }}"
  80. # TCP or UNIX socket address for the profiling server to listen on
  81. prof_laddr = "{{ .BaseConfig.ProfListenAddress }}"
  82. # If true, query the ABCI app on connecting to a new peer
  83. # so the app can decide if we should keep the connection or not
  84. filter_peers = {{ .BaseConfig.FilterPeers }}
  85. ##### advanced configuration options #####
  86. ##### rpc server configuration options #####
  87. [rpc]
  88. # TCP or UNIX socket address for the RPC server to listen on
  89. laddr = "{{ .RPC.ListenAddress }}"
  90. # TCP or UNIX socket address for the gRPC server to listen on
  91. # NOTE: This server only supports /broadcast_tx_commit
  92. grpc_laddr = "{{ .RPC.GRPCListenAddress }}"
  93. # Maximum number of simultaneous connections.
  94. # Does not include RPC (HTTP&WebSocket) connections. See max_open_connections
  95. # If you want to accept more significant number than the default, make sure
  96. # you increase your OS limits.
  97. # 0 - unlimited.
  98. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  99. # 1024 - 40 - 10 - 50 = 924 = ~900
  100. grpc_max_open_connections = {{ .RPC.GRPCMaxOpenConnections }}
  101. # Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
  102. unsafe = {{ .RPC.Unsafe }}
  103. # Maximum number of simultaneous connections (including WebSocket).
  104. # Does not include gRPC connections. See grpc_max_open_connections
  105. # If you want to accept more significant number than the default, make sure
  106. # you increase your OS limits.
  107. # 0 - unlimited.
  108. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  109. # 1024 - 40 - 10 - 50 = 924 = ~900
  110. max_open_connections = {{ .RPC.MaxOpenConnections }}
  111. ##### peer to peer configuration options #####
  112. [p2p]
  113. # Address to listen for incoming connections
  114. laddr = "{{ .P2P.ListenAddress }}"
  115. # Address to advertise to peers for them to dial
  116. # If empty, will use the same port as the laddr,
  117. # and will introspect on the listener or use UPnP
  118. # to figure out the address.
  119. external_address = "{{ .P2P.ExternalAddress }}"
  120. # Comma separated list of seed nodes to connect to
  121. seeds = "{{ .P2P.Seeds }}"
  122. # Comma separated list of nodes to keep persistent connections to
  123. persistent_peers = "{{ .P2P.PersistentPeers }}"
  124. # UPNP port forwarding
  125. upnp = {{ .P2P.UPNP }}
  126. # Path to address book
  127. addr_book_file = "{{ js .P2P.AddrBook }}"
  128. # Set true for strict address routability rules
  129. # Set false for private or local networks
  130. addr_book_strict = {{ .P2P.AddrBookStrict }}
  131. # Time to wait before flushing messages out on the connection, in ms
  132. flush_throttle_timeout = {{ .P2P.FlushThrottleTimeout }}
  133. # Maximum number of inbound peers
  134. max_num_inbound_peers = {{ .P2P.MaxNumInboundPeers }}
  135. # Maximum number of outbound peers to connect to, excluding persistent peers
  136. max_num_outbound_peers = {{ .P2P.MaxNumOutboundPeers }}
  137. # Maximum size of a message packet payload, in bytes
  138. max_packet_msg_payload_size = {{ .P2P.MaxPacketMsgPayloadSize }}
  139. # Rate at which packets can be sent, in bytes/second
  140. send_rate = {{ .P2P.SendRate }}
  141. # Rate at which packets can be received, in bytes/second
  142. recv_rate = {{ .P2P.RecvRate }}
  143. # Set true to enable the peer-exchange reactor
  144. pex = {{ .P2P.PexReactor }}
  145. # Seed mode, in which node constantly crawls the network and looks for
  146. # peers. If another node asks it for addresses, it responds and disconnects.
  147. #
  148. # Does not work if the peer-exchange reactor is disabled.
  149. seed_mode = {{ .P2P.SeedMode }}
  150. # Comma separated list of peer IDs to keep private (will not be gossiped to other peers)
  151. private_peer_ids = "{{ .P2P.PrivatePeerIDs }}"
  152. ##### mempool configuration options #####
  153. [mempool]
  154. recheck = {{ .Mempool.Recheck }}
  155. recheck_empty = {{ .Mempool.RecheckEmpty }}
  156. broadcast = {{ .Mempool.Broadcast }}
  157. wal_dir = "{{ js .Mempool.WalPath }}"
  158. # size of the mempool
  159. size = {{ .Mempool.Size }}
  160. # size of the cache (used to filter transactions we saw earlier)
  161. cache_size = {{ .Mempool.CacheSize }}
  162. ##### consensus configuration options #####
  163. [consensus]
  164. wal_file = "{{ js .Consensus.WalPath }}"
  165. # All timeouts are in milliseconds
  166. timeout_propose = {{ .Consensus.TimeoutPropose }}
  167. timeout_propose_delta = {{ .Consensus.TimeoutProposeDelta }}
  168. timeout_prevote = {{ .Consensus.TimeoutPrevote }}
  169. timeout_prevote_delta = {{ .Consensus.TimeoutPrevoteDelta }}
  170. timeout_precommit = {{ .Consensus.TimeoutPrecommit }}
  171. timeout_precommit_delta = {{ .Consensus.TimeoutPrecommitDelta }}
  172. timeout_commit = {{ .Consensus.TimeoutCommit }}
  173. # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  174. skip_timeout_commit = {{ .Consensus.SkipTimeoutCommit }}
  175. # EmptyBlocks mode and possible interval between empty blocks in seconds
  176. create_empty_blocks = {{ .Consensus.CreateEmptyBlocks }}
  177. create_empty_blocks_interval = {{ .Consensus.CreateEmptyBlocksInterval }}
  178. # Reactor sleep duration parameters are in milliseconds
  179. peer_gossip_sleep_duration = {{ .Consensus.PeerGossipSleepDuration }}
  180. peer_query_maj23_sleep_duration = {{ .Consensus.PeerQueryMaj23SleepDuration }}
  181. ##### transactions indexer configuration options #####
  182. [tx_index]
  183. # What indexer to use for transactions
  184. #
  185. # Options:
  186. # 1) "null" (default)
  187. # 2) "kv" - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
  188. indexer = "{{ .TxIndex.Indexer }}"
  189. # Comma-separated list of tags to index (by default the only tag is "tx.hash")
  190. #
  191. # You can also index transactions by height by adding "tx.height" tag here.
  192. #
  193. # It's recommended to index only a subset of tags due to possible memory
  194. # bloat. This is, of course, depends on the indexer's DB and the volume of
  195. # transactions.
  196. index_tags = "{{ .TxIndex.IndexTags }}"
  197. # When set to true, tells indexer to index all tags (predefined tags:
  198. # "tx.hash", "tx.height" and all tags from DeliverTx responses).
  199. #
  200. # Note this may be not desirable (see the comment above). IndexTags has a
  201. # precedence over IndexAllTags (i.e. when given both, IndexTags will be
  202. # indexed).
  203. index_all_tags = {{ .TxIndex.IndexAllTags }}
  204. ##### instrumentation configuration options #####
  205. [instrumentation]
  206. # When true, Prometheus metrics are served under /metrics on
  207. # PrometheusListenAddr.
  208. # Check out the documentation for the list of available metrics.
  209. prometheus = {{ .Instrumentation.Prometheus }}
  210. # Address to listen for Prometheus collector(s) connections
  211. prometheus_listen_addr = "{{ .Instrumentation.PrometheusListenAddr }}"
  212. # Maximum number of simultaneous connections.
  213. # If you want to accept more significant number than the default, make sure
  214. # you increase your OS limits.
  215. # 0 - unlimited.
  216. max_open_connections = {{ .Instrumentation.MaxOpenConnections }}
  217. `
  218. /****** these are for test settings ***********/
  219. func ResetTestRoot(testName string) *Config {
  220. rootDir := os.ExpandEnv("$HOME/.tendermint_test")
  221. rootDir = filepath.Join(rootDir, testName)
  222. // Remove ~/.tendermint_test_bak
  223. if cmn.FileExists(rootDir + "_bak") {
  224. if err := os.RemoveAll(rootDir + "_bak"); err != nil {
  225. cmn.PanicSanity(err.Error())
  226. }
  227. }
  228. // Move ~/.tendermint_test to ~/.tendermint_test_bak
  229. if cmn.FileExists(rootDir) {
  230. if err := os.Rename(rootDir, rootDir+"_bak"); err != nil {
  231. cmn.PanicSanity(err.Error())
  232. }
  233. }
  234. // Create new dir
  235. if err := cmn.EnsureDir(rootDir, 0700); err != nil {
  236. cmn.PanicSanity(err.Error())
  237. }
  238. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultConfigDir), 0700); err != nil {
  239. cmn.PanicSanity(err.Error())
  240. }
  241. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultDataDir), 0700); err != nil {
  242. cmn.PanicSanity(err.Error())
  243. }
  244. baseConfig := DefaultBaseConfig()
  245. configFilePath := filepath.Join(rootDir, defaultConfigFilePath)
  246. genesisFilePath := filepath.Join(rootDir, baseConfig.Genesis)
  247. privFilePath := filepath.Join(rootDir, baseConfig.PrivValidator)
  248. // Write default config file if missing.
  249. if !cmn.FileExists(configFilePath) {
  250. writeDefaultConfigFile(configFilePath)
  251. }
  252. if !cmn.FileExists(genesisFilePath) {
  253. cmn.MustWriteFile(genesisFilePath, []byte(testGenesis), 0644)
  254. }
  255. // we always overwrite the priv val
  256. cmn.MustWriteFile(privFilePath, []byte(testPrivValidator), 0644)
  257. config := TestConfig().SetRoot(rootDir)
  258. return config
  259. }
  260. var testGenesis = `{
  261. "genesis_time": "0001-01-01T00:00:00.000Z",
  262. "chain_id": "tendermint_test",
  263. "validators": [
  264. {
  265. "pub_key": {
  266. "type": "tendermint/PubKeyEd25519",
  267. "value":"AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE="
  268. },
  269. "power": "10",
  270. "name": ""
  271. }
  272. ],
  273. "app_hash": ""
  274. }`
  275. var testPrivValidator = `{
  276. "address": "A3258DCBF45DCA0DF052981870F2D1441A36D145",
  277. "pub_key": {
  278. "type": "tendermint/PubKeyEd25519",
  279. "value": "AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE="
  280. },
  281. "priv_key": {
  282. "type": "tendermint/PrivKeyEd25519",
  283. "value": "EVkqJO/jIXp3rkASXfh9YnyToYXRXhBr6g9cQVxPFnQBP/5povV4HTjvsy530kybxKHwEi85iU8YL0qQhSYVoQ=="
  284. },
  285. "last_height": "0",
  286. "last_round": "0",
  287. "last_step": 0
  288. }`