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.

563 lines
21 KiB

blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
  1. package config
  2. import (
  3. "bytes"
  4. "fmt"
  5. "io/ioutil"
  6. "os"
  7. "path/filepath"
  8. "strings"
  9. "text/template"
  10. tmos "github.com/tendermint/tendermint/libs/os"
  11. )
  12. // DefaultDirPerm is the default permissions used when creating directories.
  13. const DefaultDirPerm = 0700
  14. var configTemplate *template.Template
  15. func init() {
  16. var err error
  17. tmpl := template.New("configFileTemplate").Funcs(template.FuncMap{
  18. "StringsJoin": strings.Join,
  19. })
  20. if configTemplate, err = tmpl.Parse(defaultConfigTemplate); err != nil {
  21. panic(err)
  22. }
  23. }
  24. /****** these are for production settings ***********/
  25. // EnsureRoot creates the root, config, and data directories if they don't exist,
  26. // and panics if it fails.
  27. func EnsureRoot(rootDir string) {
  28. if err := tmos.EnsureDir(rootDir, DefaultDirPerm); err != nil {
  29. panic(err.Error())
  30. }
  31. if err := tmos.EnsureDir(filepath.Join(rootDir, defaultConfigDir), DefaultDirPerm); err != nil {
  32. panic(err.Error())
  33. }
  34. if err := tmos.EnsureDir(filepath.Join(rootDir, defaultDataDir), DefaultDirPerm); err != nil {
  35. panic(err.Error())
  36. }
  37. configFilePath := filepath.Join(rootDir, defaultConfigFilePath)
  38. // Write default config file if missing.
  39. if !tmos.FileExists(configFilePath) {
  40. writeDefaultConfigFile(configFilePath)
  41. }
  42. }
  43. // XXX: this func should probably be called by cmd/tendermint/commands/init.go
  44. // alongside the writing of the genesis.json and priv_validator.json
  45. func writeDefaultConfigFile(configFilePath string) {
  46. WriteConfigFile(configFilePath, DefaultConfig())
  47. }
  48. // WriteConfigFile renders config using the template and writes it to configFilePath.
  49. func WriteConfigFile(configFilePath string, config *Config) {
  50. var buffer bytes.Buffer
  51. if err := configTemplate.Execute(&buffer, config); err != nil {
  52. panic(err)
  53. }
  54. mustWriteFile(configFilePath, buffer.Bytes(), 0644)
  55. }
  56. // Note: any changes to the comments/variables/mapstructure
  57. // must be reflected in the appropriate struct in config/config.go
  58. const defaultConfigTemplate = `# This is a TOML config file.
  59. # For more information, see https://github.com/toml-lang/toml
  60. # NOTE: Any path below can be absolute (e.g. "/var/myawesomeapp/data") or
  61. # relative to the home directory (e.g. "data"). The home directory is
  62. # "$HOME/.tendermint" by default, but could be changed via $TMHOME env variable
  63. # or --home cmd flag.
  64. #######################################################################
  65. ### Main Base Config Options ###
  66. #######################################################################
  67. # TCP or UNIX socket address of the ABCI application,
  68. # or the name of an ABCI application compiled in with the Tendermint binary
  69. proxy_app = "{{ .BaseConfig.ProxyApp }}"
  70. # A custom human readable name for this node
  71. moniker = "{{ .BaseConfig.Moniker }}"
  72. # If this node is many blocks behind the tip of the chain, FastSync
  73. # allows them to catchup quickly by downloading blocks in parallel
  74. # and verifying their commits
  75. fast_sync = {{ .BaseConfig.FastSyncMode }}
  76. # Database backend: goleveldb | cleveldb | boltdb | rocksdb | badgerdb
  77. # * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
  78. # - pure go
  79. # - stable
  80. # * cleveldb (uses levigo wrapper)
  81. # - fast
  82. # - requires gcc
  83. # - use cleveldb build tag (go build -tags cleveldb)
  84. # * boltdb (uses etcd's fork of bolt - github.com/etcd-io/bbolt)
  85. # - EXPERIMENTAL
  86. # - may be faster is some use-cases (random reads - indexer)
  87. # - use boltdb build tag (go build -tags boltdb)
  88. # * rocksdb (uses github.com/tecbot/gorocksdb)
  89. # - EXPERIMENTAL
  90. # - requires gcc
  91. # - use rocksdb build tag (go build -tags rocksdb)
  92. # * badgerdb (uses github.com/dgraph-io/badger)
  93. # - EXPERIMENTAL
  94. # - use badgerdb build tag (go build -tags badgerdb)
  95. db_backend = "{{ .BaseConfig.DBBackend }}"
  96. # Database directory
  97. db_dir = "{{ js .BaseConfig.DBPath }}"
  98. # Output level for logging, including package level options
  99. log_level = "{{ .BaseConfig.LogLevel }}"
  100. # Output format: 'plain' (colored text) or 'json'
  101. log_format = "{{ .BaseConfig.LogFormat }}"
  102. ##### additional base config options #####
  103. # Path to the JSON file containing the initial validator set and other meta data
  104. genesis_file = "{{ js .BaseConfig.Genesis }}"
  105. # Path to the JSON file containing the private key to use as a validator in the consensus protocol
  106. priv_validator_key_file = "{{ js .BaseConfig.PrivValidatorKey }}"
  107. # Path to the JSON file containing the last sign state of a validator
  108. priv_validator_state_file = "{{ js .BaseConfig.PrivValidatorState }}"
  109. # TCP or UNIX socket address for Tendermint to listen on for
  110. # connections from an external PrivValidator process
  111. priv_validator_laddr = "{{ .BaseConfig.PrivValidatorListenAddr }}"
  112. # Path to the JSON file containing the private key to use for node authentication in the p2p protocol
  113. node_key_file = "{{ js .BaseConfig.NodeKey }}"
  114. # Mechanism to connect to the ABCI application: socket | grpc
  115. abci = "{{ .BaseConfig.ABCI }}"
  116. # If true, query the ABCI app on connecting to a new peer
  117. # so the app can decide if we should keep the connection or not
  118. filter_peers = {{ .BaseConfig.FilterPeers }}
  119. #######################################################################
  120. ### Advanced Configuration Options ###
  121. #######################################################################
  122. #######################################################
  123. ### RPC Server Configuration Options ###
  124. #######################################################
  125. [rpc]
  126. # TCP or UNIX socket address for the RPC server to listen on
  127. laddr = "{{ .RPC.ListenAddress }}"
  128. # A list of origins a cross-domain request can be executed from
  129. # Default value '[]' disables cors support
  130. # Use '["*"]' to allow any origin
  131. cors_allowed_origins = [{{ range .RPC.CORSAllowedOrigins }}{{ printf "%q, " . }}{{end}}]
  132. # A list of methods the client is allowed to use with cross-domain requests
  133. cors_allowed_methods = [{{ range .RPC.CORSAllowedMethods }}{{ printf "%q, " . }}{{end}}]
  134. # A list of non simple headers the client is allowed to use with cross-domain requests
  135. cors_allowed_headers = [{{ range .RPC.CORSAllowedHeaders }}{{ printf "%q, " . }}{{end}}]
  136. # TCP or UNIX socket address for the gRPC server to listen on
  137. # NOTE: This server only supports /broadcast_tx_commit
  138. grpc_laddr = "{{ .RPC.GRPCListenAddress }}"
  139. # Maximum number of simultaneous connections.
  140. # Does not include RPC (HTTP&WebSocket) connections. See max_open_connections
  141. # If you want to accept a larger number than the default, make sure
  142. # you increase your OS limits.
  143. # 0 - unlimited.
  144. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  145. # 1024 - 40 - 10 - 50 = 924 = ~900
  146. grpc_max_open_connections = {{ .RPC.GRPCMaxOpenConnections }}
  147. # Activate unsafe RPC commands like /dial_seeds and /unsafe_flush_mempool
  148. unsafe = {{ .RPC.Unsafe }}
  149. # Maximum number of simultaneous connections (including WebSocket).
  150. # Does not include gRPC connections. See grpc_max_open_connections
  151. # If you want to accept a larger number than the default, make sure
  152. # you increase your OS limits.
  153. # 0 - unlimited.
  154. # Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  155. # 1024 - 40 - 10 - 50 = 924 = ~900
  156. max_open_connections = {{ .RPC.MaxOpenConnections }}
  157. # Maximum number of unique clientIDs that can /subscribe
  158. # If you're using /broadcast_tx_commit, set to the estimated maximum number
  159. # of broadcast_tx_commit calls per block.
  160. max_subscription_clients = {{ .RPC.MaxSubscriptionClients }}
  161. # Maximum number of unique queries a given client can /subscribe to
  162. # If you're using GRPC (or Local RPC client) and /broadcast_tx_commit, set to
  163. # the estimated # maximum number of broadcast_tx_commit calls per block.
  164. max_subscriptions_per_client = {{ .RPC.MaxSubscriptionsPerClient }}
  165. # How long to wait for a tx to be committed during /broadcast_tx_commit.
  166. # WARNING: Using a value larger than 10s will result in increasing the
  167. # global HTTP write timeout, which applies to all connections and endpoints.
  168. # See https://github.com/tendermint/tendermint/issues/3435
  169. timeout_broadcast_tx_commit = "{{ .RPC.TimeoutBroadcastTxCommit }}"
  170. # Maximum size of request body, in bytes
  171. max_body_bytes = {{ .RPC.MaxBodyBytes }}
  172. # Maximum size of request header, in bytes
  173. max_header_bytes = {{ .RPC.MaxHeaderBytes }}
  174. # The path to a file containing certificate that is used to create the HTTPS server.
  175. # Migth be either absolute path or path related to tendermint's config directory.
  176. # If the certificate is signed by a certificate authority,
  177. # the certFile should be the concatenation of the server's certificate, any intermediates,
  178. # and the CA's certificate.
  179. # NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server.
  180. # Otherwise, HTTP server is run.
  181. tls_cert_file = "{{ .RPC.TLSCertFile }}"
  182. # The path to a file containing matching private key that is used to create the HTTPS server.
  183. # Migth be either absolute path or path related to tendermint's config directory.
  184. # NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server.
  185. # Otherwise, HTTP server is run.
  186. tls_key_file = "{{ .RPC.TLSKeyFile }}"
  187. # pprof listen address (https://golang.org/pkg/net/http/pprof)
  188. pprof_laddr = "{{ .RPC.PprofListenAddress }}"
  189. #######################################################
  190. ### P2P Configuration Options ###
  191. #######################################################
  192. [p2p]
  193. # Address to listen for incoming connections
  194. laddr = "{{ .P2P.ListenAddress }}"
  195. # Address to advertise to peers for them to dial
  196. # If empty, will use the same port as the laddr,
  197. # and will introspect on the listener or use UPnP
  198. # to figure out the address.
  199. external_address = "{{ .P2P.ExternalAddress }}"
  200. # Comma separated list of seed nodes to connect to
  201. seeds = "{{ .P2P.Seeds }}"
  202. # Comma separated list of nodes to keep persistent connections to
  203. persistent_peers = "{{ .P2P.PersistentPeers }}"
  204. # UPNP port forwarding
  205. upnp = {{ .P2P.UPNP }}
  206. # Path to address book
  207. addr_book_file = "{{ js .P2P.AddrBook }}"
  208. # Set true for strict address routability rules
  209. # Set false for private or local networks
  210. addr_book_strict = {{ .P2P.AddrBookStrict }}
  211. # Maximum number of inbound peers
  212. max_num_inbound_peers = {{ .P2P.MaxNumInboundPeers }}
  213. # Maximum number of outbound peers to connect to, excluding persistent peers
  214. max_num_outbound_peers = {{ .P2P.MaxNumOutboundPeers }}
  215. # List of node IDs, to which a connection will be (re)established ignoring any existing limits
  216. unconditional_peer_ids = "{{ .P2P.UnconditionalPeerIDs }}"
  217. # Maximum pause when redialing a persistent peer (if zero, exponential backoff is used)
  218. persistent_peers_max_dial_period = "{{ .P2P.PersistentPeersMaxDialPeriod }}"
  219. # Time to wait before flushing messages out on the connection
  220. flush_throttle_timeout = "{{ .P2P.FlushThrottleTimeout }}"
  221. # Maximum size of a message packet payload, in bytes
  222. max_packet_msg_payload_size = {{ .P2P.MaxPacketMsgPayloadSize }}
  223. # Rate at which packets can be sent, in bytes/second
  224. send_rate = {{ .P2P.SendRate }}
  225. # Rate at which packets can be received, in bytes/second
  226. recv_rate = {{ .P2P.RecvRate }}
  227. # Set true to enable the peer-exchange reactor
  228. pex = {{ .P2P.PexReactor }}
  229. # Seed mode, in which node constantly crawls the network and looks for
  230. # peers. If another node asks it for addresses, it responds and disconnects.
  231. #
  232. # Does not work if the peer-exchange reactor is disabled.
  233. seed_mode = {{ .P2P.SeedMode }}
  234. # Comma separated list of peer IDs to keep private (will not be gossiped to other peers)
  235. private_peer_ids = "{{ .P2P.PrivatePeerIDs }}"
  236. # Toggle to disable guard against peers connecting from the same ip.
  237. allow_duplicate_ip = {{ .P2P.AllowDuplicateIP }}
  238. # Peer connection configuration.
  239. handshake_timeout = "{{ .P2P.HandshakeTimeout }}"
  240. dial_timeout = "{{ .P2P.DialTimeout }}"
  241. #######################################################
  242. ### Mempool Configurattion Option ###
  243. #######################################################
  244. [mempool]
  245. recheck = {{ .Mempool.Recheck }}
  246. broadcast = {{ .Mempool.Broadcast }}
  247. wal_dir = "{{ js .Mempool.WalPath }}"
  248. # Maximum number of transactions in the mempool
  249. size = {{ .Mempool.Size }}
  250. # Limit the total size of all txs in the mempool.
  251. # This only accounts for raw transactions (e.g. given 1MB transactions and
  252. # max_txs_bytes=5MB, mempool will only accept 5 transactions).
  253. max_txs_bytes = {{ .Mempool.MaxTxsBytes }}
  254. # Size of the cache (used to filter transactions we saw earlier) in transactions
  255. cache_size = {{ .Mempool.CacheSize }}
  256. # Maximum size of a single transaction.
  257. # NOTE: the max size of a tx transmitted over the network is {max_tx_bytes}.
  258. max_tx_bytes = {{ .Mempool.MaxTxBytes }}
  259. # Maximum size of a batch of transactions to send to a peer
  260. # Including space needed by encoding (one varint per transaction).
  261. max_batch_bytes = {{ .Mempool.MaxBatchBytes }}
  262. #######################################################
  263. ### State Sync Configuration Options ###
  264. #######################################################
  265. [statesync]
  266. # State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine
  267. # snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in
  268. # the network to take and serve state machine snapshots. State sync is not attempted if the node
  269. # has any local state (LastBlockHeight > 0). The node will have a truncated block history,
  270. # starting from the height of the snapshot.
  271. enable = {{ .StateSync.Enable }}
  272. # RPC servers (comma-separated) for light client verification of the synced state machine and
  273. # retrieval of state data for node bootstrapping. Also needs a trusted height and corresponding
  274. # header hash obtained from a trusted source, and a period during which validators can be trusted.
  275. #
  276. # For Cosmos SDK-based chains, trust_period should usually be about 2/3 of the unbonding time (~2
  277. # weeks) during which they can be financially punished (slashed) for misbehavior.
  278. rpc_servers = "{{ StringsJoin .StateSync.RPCServers "," }}"
  279. trust_height = {{ .StateSync.TrustHeight }}
  280. trust_hash = "{{ .StateSync.TrustHash }}"
  281. trust_period = "{{ .StateSync.TrustPeriod }}"
  282. # Time to spend discovering snapshots before initiating a restore.
  283. discovery_time = "{{ .StateSync.DiscoveryTime }}"
  284. # Temporary directory for state sync snapshot chunks, defaults to the OS tempdir (typically /tmp).
  285. # Will create a new, randomly named directory within, and remove it when done.
  286. temp_dir = "{{ .StateSync.TempDir }}"
  287. #######################################################
  288. ### Fast Sync Configuration Connections ###
  289. #######################################################
  290. [fastsync]
  291. # Fast Sync version to use:
  292. # 1) "v0" (default) - the legacy fast sync implementation
  293. # 2) "v1" - refactor of v0 version for better testability
  294. # 2) "v2" - complete redesign of v0, optimized for testability & readability
  295. version = "{{ .FastSync.Version }}"
  296. #######################################################
  297. ### Consensus Configuration Options ###
  298. #######################################################
  299. [consensus]
  300. wal_file = "{{ js .Consensus.WalPath }}"
  301. # How long we wait for a proposal block before prevoting nil
  302. timeout_propose = "{{ .Consensus.TimeoutPropose }}"
  303. # How much timeout_propose increases with each round
  304. timeout_propose_delta = "{{ .Consensus.TimeoutProposeDelta }}"
  305. # How long we wait after receiving +2/3 prevotes for anything (ie. not a single block or nil)
  306. timeout_prevote = "{{ .Consensus.TimeoutPrevote }}"
  307. # How much the timeout_prevote increases with each round
  308. timeout_prevote_delta = "{{ .Consensus.TimeoutPrevoteDelta }}"
  309. # How long we wait after receiving +2/3 precommits for anything (ie. not a single block or nil)
  310. timeout_precommit = "{{ .Consensus.TimeoutPrecommit }}"
  311. # How much the timeout_precommit increases with each round
  312. timeout_precommit_delta = "{{ .Consensus.TimeoutPrecommitDelta }}"
  313. # How long we wait after committing a block, before starting on the new
  314. # height (this gives us a chance to receive some more precommits, even
  315. # though we already have +2/3).
  316. timeout_commit = "{{ .Consensus.TimeoutCommit }}"
  317. # How many blocks to look back to check existence of the node's consensus votes before joining consensus
  318. # When non-zero, the node will panic upon restart
  319. # if the same consensus key was used to sign {double_sign_check_height} last blocks.
  320. # So, validators should stop the state machine, wait for some blocks, and then restart the state machine to avoid panic.
  321. double_sign_check_height = {{ .Consensus.DoubleSignCheckHeight }}
  322. # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  323. skip_timeout_commit = {{ .Consensus.SkipTimeoutCommit }}
  324. # EmptyBlocks mode and possible interval between empty blocks
  325. create_empty_blocks = {{ .Consensus.CreateEmptyBlocks }}
  326. create_empty_blocks_interval = "{{ .Consensus.CreateEmptyBlocksInterval }}"
  327. # Reactor sleep duration parameters
  328. peer_gossip_sleep_duration = "{{ .Consensus.PeerGossipSleepDuration }}"
  329. peer_query_maj23_sleep_duration = "{{ .Consensus.PeerQueryMaj23SleepDuration }}"
  330. #######################################################
  331. ### Transaction Indexer Configuration Options ###
  332. #######################################################
  333. [tx_index]
  334. # What indexer to use for transactions
  335. #
  336. # The application will set which txs to index. In some cases a node operator will be able
  337. # to decide which txs to index based on configuration set in the application.
  338. #
  339. # Options:
  340. # 1) "null"
  341. # 2) "kv" (default) - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
  342. # - When "kv" is chosen "tx.height" and "tx.hash" will always be indexed.
  343. indexer = "{{ .TxIndex.Indexer }}"
  344. #######################################################
  345. ### Instrumentation Configuration Options ###
  346. #######################################################
  347. [instrumentation]
  348. # When true, Prometheus metrics are served under /metrics on
  349. # PrometheusListenAddr.
  350. # Check out the documentation for the list of available metrics.
  351. prometheus = {{ .Instrumentation.Prometheus }}
  352. # Address to listen for Prometheus collector(s) connections
  353. prometheus_listen_addr = "{{ .Instrumentation.PrometheusListenAddr }}"
  354. # Maximum number of simultaneous connections.
  355. # If you want to accept a larger number than the default, make sure
  356. # you increase your OS limits.
  357. # 0 - unlimited.
  358. max_open_connections = {{ .Instrumentation.MaxOpenConnections }}
  359. # Instrumentation namespace
  360. namespace = "{{ .Instrumentation.Namespace }}"
  361. `
  362. /****** these are for test settings ***********/
  363. func ResetTestRoot(testName string) *Config {
  364. return ResetTestRootWithChainID(testName, "")
  365. }
  366. func ResetTestRootWithChainID(testName string, chainID string) *Config {
  367. // create a unique, concurrency-safe test directory under os.TempDir()
  368. rootDir, err := ioutil.TempDir("", fmt.Sprintf("%s-%s_", chainID, testName))
  369. if err != nil {
  370. panic(err)
  371. }
  372. // ensure config and data subdirs are created
  373. if err := tmos.EnsureDir(filepath.Join(rootDir, defaultConfigDir), DefaultDirPerm); err != nil {
  374. panic(err)
  375. }
  376. if err := tmos.EnsureDir(filepath.Join(rootDir, defaultDataDir), DefaultDirPerm); err != nil {
  377. panic(err)
  378. }
  379. baseConfig := DefaultBaseConfig()
  380. configFilePath := filepath.Join(rootDir, defaultConfigFilePath)
  381. genesisFilePath := filepath.Join(rootDir, baseConfig.Genesis)
  382. privKeyFilePath := filepath.Join(rootDir, baseConfig.PrivValidatorKey)
  383. privStateFilePath := filepath.Join(rootDir, baseConfig.PrivValidatorState)
  384. // Write default config file if missing.
  385. if !tmos.FileExists(configFilePath) {
  386. writeDefaultConfigFile(configFilePath)
  387. }
  388. if !tmos.FileExists(genesisFilePath) {
  389. if chainID == "" {
  390. chainID = "tendermint_test"
  391. }
  392. testGenesis := fmt.Sprintf(testGenesisFmt, chainID)
  393. mustWriteFile(genesisFilePath, []byte(testGenesis), 0644)
  394. }
  395. // we always overwrite the priv val
  396. mustWriteFile(privKeyFilePath, []byte(testPrivValidatorKey), 0644)
  397. mustWriteFile(privStateFilePath, []byte(testPrivValidatorState), 0644)
  398. config := TestConfig().SetRoot(rootDir)
  399. return config
  400. }
  401. func mustWriteFile(filePath string, contents []byte, mode os.FileMode) {
  402. if err := ioutil.WriteFile(filePath, contents, mode); err != nil {
  403. tmos.Exit(fmt.Sprintf("failed to write file: %v", err))
  404. }
  405. }
  406. var testGenesisFmt = `{
  407. "genesis_time": "2018-10-10T08:20:13.695936996Z",
  408. "chain_id": "%s",
  409. "initial_height": "1",
  410. "consensus_params": {
  411. "block": {
  412. "max_bytes": "22020096",
  413. "max_gas": "-1",
  414. "time_iota_ms": "10"
  415. },
  416. "evidence": {
  417. "max_age_num_blocks": "100000",
  418. "max_age_duration": "172800000000000",
  419. "max_bytes": "1048576"
  420. },
  421. "validator": {
  422. "pub_key_types": [
  423. "ed25519"
  424. ]
  425. },
  426. "version": {}
  427. },
  428. "validators": [
  429. {
  430. "pub_key": {
  431. "type": "tendermint/PubKeyEd25519",
  432. "value":"AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE="
  433. },
  434. "power": "10",
  435. "name": ""
  436. }
  437. ],
  438. "app_hash": ""
  439. }`
  440. var testPrivValidatorKey = `{
  441. "address": "A3258DCBF45DCA0DF052981870F2D1441A36D145",
  442. "pub_key": {
  443. "type": "tendermint/PubKeyEd25519",
  444. "value": "AT/+aaL1eB0477Mud9JMm8Sh8BIvOYlPGC9KkIUmFaE="
  445. },
  446. "priv_key": {
  447. "type": "tendermint/PrivKeyEd25519",
  448. "value": "EVkqJO/jIXp3rkASXfh9YnyToYXRXhBr6g9cQVxPFnQBP/5povV4HTjvsy530kybxKHwEi85iU8YL0qQhSYVoQ=="
  449. }
  450. }`
  451. var testPrivValidatorState = `{
  452. "height": "0",
  453. "round": 0,
  454. "step": 0
  455. }`