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.

290 lines
9.0 KiB

8 years ago
8 years ago
8 years ago
8 years ago
  1. package config
  2. import (
  3. "bytes"
  4. "os"
  5. "path/filepath"
  6. "text/template"
  7. cmn "github.com/tendermint/tmlibs/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. writeConfigFile(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 writeConfigFile(configFilePath string) {
  38. var buffer bytes.Buffer
  39. if err := configTemplate.Execute(&buffer, DefaultConfig()); err != nil {
  40. panic(err)
  41. }
  42. cmn.MustWriteFile(configFilePath, buffer.Bytes(), 0644)
  43. }
  44. // Note: any changes to the comments/variables/mapstructure
  45. // must be reflected in the appropriate struct in config/config.go
  46. const defaultConfigTemplate = `# This is a TOML config file.
  47. # For more information, see https://github.com/toml-lang/toml
  48. ##### main base config options #####
  49. # TCP or UNIX socket address of the ABCI application,
  50. # or the name of an ABCI application compiled in with the Tendermint binary
  51. proxy_app = "{{ .BaseConfig.ProxyApp }}"
  52. # A custom human readable name for this node
  53. moniker = "{{ .BaseConfig.Moniker }}"
  54. # If this node is many blocks behind the tip of the chain, FastSync
  55. # allows them to catchup quickly by downloading blocks in parallel
  56. # and verifying their commits
  57. fast_sync = {{ .BaseConfig.FastSync }}
  58. # Database backend: leveldb | memdb
  59. db_backend = "{{ .BaseConfig.DBBackend }}"
  60. # Database directory
  61. db_path = "{{ .BaseConfig.DBPath }}"
  62. # Output level for logging, including package level options
  63. log_level = "{{ .BaseConfig.LogLevel }}"
  64. ##### additional base config options #####
  65. # Path to the JSON file containing the initial validator set and other meta data
  66. genesis_file = "{{ .BaseConfig.Genesis }}"
  67. # Path to the JSON file containing the private key to use as a validator in the consensus protocol
  68. priv_validator_file = "{{ .BaseConfig.PrivValidator }}"
  69. # Path to the JSON file containing the private key to use for node authentication in the p2p protocol
  70. node_key_file = "{{ .BaseConfig.NodeKey}}"
  71. # Mechanism to connect to the ABCI application: socket | grpc
  72. abci = "{{ .BaseConfig.ABCI }}"
  73. # TCP or UNIX socket address for the profiling server to listen on
  74. prof_laddr = "{{ .BaseConfig.ProfListenAddress }}"
  75. # If true, query the ABCI app on connecting to a new peer
  76. # so the app can decide if we should keep the connection or not
  77. filter_peers = {{ .BaseConfig.FilterPeers }}
  78. ##### advanced configuration options #####
  79. ##### rpc server configuration options #####
  80. [rpc]
  81. # TCP or UNIX socket address for the RPC server to listen on
  82. laddr = "{{ .RPC.ListenAddress }}"
  83. # TCP or UNIX socket address for the gRPC server to listen on
  84. # NOTE: This server only supports /broadcast_tx_commit
  85. grpc_laddr = "{{ .RPC.GRPCListenAddress }}"
  86. # Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
  87. unsafe = {{ .RPC.Unsafe }}
  88. ##### peer to peer configuration options #####
  89. [p2p]
  90. # Address to listen for incoming connections
  91. laddr = "{{ .P2P.ListenAddress }}"
  92. # Comma separated list of seed nodes to connect to
  93. seeds = ""
  94. # Comma separated list of nodes to keep persistent connections to
  95. persistent_peers = ""
  96. # Path to address book
  97. addr_book_file = "{{ .P2P.AddrBook }}"
  98. # Set true for strict address routability rules
  99. addr_book_strict = {{ .P2P.AddrBookStrict }}
  100. # Time to wait before flushing messages out on the connection, in ms
  101. flush_throttle_timeout = {{ .P2P.FlushThrottleTimeout }}
  102. # Maximum number of peers to connect to
  103. max_num_peers = {{ .P2P.MaxNumPeers }}
  104. # Maximum size of a message packet payload, in bytes
  105. max_msg_packet_payload_size = {{ .P2P.MaxMsgPacketPayloadSize }}
  106. # Rate at which packets can be sent, in bytes/second
  107. send_rate = {{ .P2P.SendRate }}
  108. # Rate at which packets can be received, in bytes/second
  109. recv_rate = {{ .P2P.RecvRate }}
  110. ##### mempool configuration options #####
  111. [mempool]
  112. recheck = {{ .Mempool.Recheck }}
  113. recheck_empty = {{ .Mempool.RecheckEmpty }}
  114. broadcast = {{ .Mempool.Broadcast }}
  115. wal_dir = "{{ .Mempool.WalPath }}"
  116. ##### consensus configuration options #####
  117. [consensus]
  118. wal_file = "{{ .Consensus.WalPath }}"
  119. wal_light = {{ .Consensus.WalLight }}
  120. # All timeouts are in milliseconds
  121. timeout_propose = {{ .Consensus.TimeoutPropose }}
  122. timeout_propose_delta = {{ .Consensus.TimeoutProposeDelta }}
  123. timeout_prevote = {{ .Consensus.TimeoutPrevote }}
  124. timeout_prevote_delta = {{ .Consensus.TimeoutPrevoteDelta }}
  125. timeout_precommit = {{ .Consensus.TimeoutPrecommit }}
  126. timeout_precommit_delta = {{ .Consensus.TimeoutPrecommitDelta }}
  127. timeout_commit = {{ .Consensus.TimeoutCommit }}
  128. # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  129. skip_timeout_commit = {{ .Consensus.SkipTimeoutCommit }}
  130. # BlockSize
  131. max_block_size_txs = {{ .Consensus.MaxBlockSizeTxs }}
  132. max_block_size_bytes = {{ .Consensus.MaxBlockSizeBytes }}
  133. # EmptyBlocks mode and possible interval between empty blocks in seconds
  134. create_empty_blocks = {{ .Consensus.CreateEmptyBlocks }}
  135. create_empty_blocks_interval = {{ .Consensus.CreateEmptyBlocksInterval }}
  136. # Reactor sleep duration parameters are in milliseconds
  137. peer_gossip_sleep_duration = {{ .Consensus.PeerGossipSleepDuration }}
  138. peer_query_maj23_sleep_duration = {{ .Consensus.PeerQueryMaj23SleepDuration }}
  139. ##### transactions indexer configuration options #####
  140. [tx_index]
  141. # What indexer to use for transactions
  142. #
  143. # Options:
  144. # 1) "null" (default)
  145. # 2) "kv" - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
  146. indexer = "{{ .TxIndex.Indexer }}"
  147. # Comma-separated list of tags to index (by default the only tag is tx hash)
  148. #
  149. # It's recommended to index only a subset of tags due to possible memory
  150. # bloat. This is, of course, depends on the indexer's DB and the volume of
  151. # transactions.
  152. index_tags = "{{ .TxIndex.IndexTags }}"
  153. # When set to true, tells indexer to index all tags. Note this may be not
  154. # desirable (see the comment above). IndexTags has a precedence over
  155. # IndexAllTags (i.e. when given both, IndexTags will be indexed).
  156. index_all_tags = {{ .TxIndex.IndexAllTags }}
  157. `
  158. /****** these are for test settings ***********/
  159. func ResetTestRoot(testName string) *Config {
  160. rootDir := os.ExpandEnv("$HOME/.tendermint_test")
  161. rootDir = filepath.Join(rootDir, testName)
  162. // Remove ~/.tendermint_test_bak
  163. if cmn.FileExists(rootDir + "_bak") {
  164. if err := os.RemoveAll(rootDir + "_bak"); err != nil {
  165. cmn.PanicSanity(err.Error())
  166. }
  167. }
  168. // Move ~/.tendermint_test to ~/.tendermint_test_bak
  169. if cmn.FileExists(rootDir) {
  170. if err := os.Rename(rootDir, rootDir+"_bak"); err != nil {
  171. cmn.PanicSanity(err.Error())
  172. }
  173. }
  174. // Create new dir
  175. if err := cmn.EnsureDir(rootDir, 0700); err != nil {
  176. cmn.PanicSanity(err.Error())
  177. }
  178. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultConfigDir), 0700); err != nil {
  179. cmn.PanicSanity(err.Error())
  180. }
  181. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultDataDir), 0700); err != nil {
  182. cmn.PanicSanity(err.Error())
  183. }
  184. baseConfig := DefaultBaseConfig()
  185. configFilePath := filepath.Join(rootDir, defaultConfigFilePath)
  186. genesisFilePath := filepath.Join(rootDir, baseConfig.Genesis)
  187. privFilePath := filepath.Join(rootDir, baseConfig.PrivValidator)
  188. // Write default config file if missing.
  189. if !cmn.FileExists(configFilePath) {
  190. writeConfigFile(configFilePath)
  191. }
  192. if !cmn.FileExists(genesisFilePath) {
  193. cmn.MustWriteFile(genesisFilePath, []byte(testGenesis), 0644)
  194. }
  195. // we always overwrite the priv val
  196. cmn.MustWriteFile(privFilePath, []byte(testPrivValidator), 0644)
  197. config := TestConfig().SetRoot(rootDir)
  198. return config
  199. }
  200. var testGenesis = `{
  201. "genesis_time": "0001-01-01T00:00:00.000Z",
  202. "chain_id": "tendermint_test",
  203. "validators": [
  204. {
  205. "pub_key": {
  206. "type": "ed25519",
  207. "data":"3B3069C422E19688B45CBFAE7BB009FC0FA1B1EA86593519318B7214853803C8"
  208. },
  209. "power": 10,
  210. "name": ""
  211. }
  212. ],
  213. "app_hash": ""
  214. }`
  215. var testPrivValidator = `{
  216. "address": "D028C9981F7A87F3093672BF0D5B0E2A1B3ED456",
  217. "pub_key": {
  218. "type": "ed25519",
  219. "data": "3B3069C422E19688B45CBFAE7BB009FC0FA1B1EA86593519318B7214853803C8"
  220. },
  221. "priv_key": {
  222. "type": "ed25519",
  223. "data": "27F82582AEFAE7AB151CFB01C48BB6C1A0DA78F9BDDA979A9F70A84D074EB07D3B3069C422E19688B45CBFAE7BB009FC0FA1B1EA86593519318B7214853803C8"
  224. },
  225. "last_height": 0,
  226. "last_round": 0,
  227. "last_step": 0
  228. }`