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.

306 lines
9.6 KiB

8 years ago
8 years ago
p2p: introduce peerConn to simplify peer creation (#1226) * expose AuthEnc in the P2P config if AuthEnc is true, dialed peers must have a node ID in the address and it must match the persistent pubkey from the secret handshake. Refs #1157 * fixes after my own review * fix docs * fix build failure ``` p2p/pex/pex_reactor_test.go:288:88: cannot use seed.NodeInfo().NetAddress() (type *p2p.NetAddress) as type string in array or slice literal ``` * p2p: introduce peerConn to simplify peer creation * Introduce `peerConn` containing the known fields of `peer` * `peer` only created in `sw.addPeer` once handshake is complete and NodeInfo is checked * Eliminates some mutable variables and makes the code flow better * Simplifies the `newXxxPeer` funcs * Use ID instead of PubKey where possible. * SetPubKeyFilter -> SetIDFilter * nodeInfo.Validate takes ID * remove peer.PubKey() * persistent node ids * fixes from review * test: use ip_plus_id.sh more * fix invalid memory panic during fast_sync test ``` 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: panic: runtime error: invalid memory address or nil pointer dereference 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: [signal SIGSEGV: segmentation violation code=0x1 addr=0x20 pc=0x98dd3e] 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: goroutine 3432 [running]: 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: github.com/tendermint/tendermint/p2p.newOutboundPeerConn(0xc423fd1380, 0xc420933e00, 0x1, 0x1239a60, 0 xc420128c40, 0x2, 0x42caf6, 0xc42001f300, 0xc422831d98, 0xc4227951c0, ...) 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: #011/go/src/github.com/tendermint/tendermint/p2p/peer.go:123 +0x31e 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: github.com/tendermint/tendermint/p2p.(*Switch).addOutboundPeerWithConfig(0xc4200ad040, 0xc423fd1380, 0 xc420933e00, 0xc423f48801, 0x28, 0x2) 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: #011/go/src/github.com/tendermint/tendermint/p2p/switch.go:455 +0x12b 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: github.com/tendermint/tendermint/p2p.(*Switch).DialPeerWithAddress(0xc4200ad040, 0xc423fd1380, 0x1, 0x 0, 0x0) 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: #011/go/src/github.com/tendermint/tendermint/p2p/switch.go:371 +0xdc 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: github.com/tendermint/tendermint/p2p.(*Switch).reconnectToPeer(0xc4200ad040, 0x123e000, 0xc42007bb00) 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: #011/go/src/github.com/tendermint/tendermint/p2p/switch.go:290 +0x25f 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: created by github.com/tendermint/tendermint/p2p.(*Switch).StopPeerForError 2018-02-21T06:30:05Z box887.localdomain docker/local_testnet_4[14907]: #011/go/src/github.com/tendermint/tendermint/p2p/switch.go:256 +0x1b7 ```
7 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. # Do not add private peers to this list if you don't want them advertised
  96. persistent_peers = ""
  97. # Path to address book
  98. addr_book_file = "{{ .P2P.AddrBook }}"
  99. # Set true for strict address routability rules
  100. addr_book_strict = {{ .P2P.AddrBookStrict }}
  101. # Time to wait before flushing messages out on the connection, in ms
  102. flush_throttle_timeout = {{ .P2P.FlushThrottleTimeout }}
  103. # Maximum number of peers to connect to
  104. max_num_peers = {{ .P2P.MaxNumPeers }}
  105. # Maximum size of a message packet payload, in bytes
  106. max_msg_packet_payload_size = {{ .P2P.MaxMsgPacketPayloadSize }}
  107. # Rate at which packets can be sent, in bytes/second
  108. send_rate = {{ .P2P.SendRate }}
  109. # Rate at which packets can be received, in bytes/second
  110. recv_rate = {{ .P2P.RecvRate }}
  111. # Set true to enable the peer-exchange reactor
  112. pex = {{ .P2P.PexReactor }}
  113. # Seed mode, in which node constantly crawls the network and looks for
  114. # peers. If another node asks it for addresses, it responds and disconnects.
  115. #
  116. # Does not work if the peer-exchange reactor is disabled.
  117. seed_mode = {{ .P2P.SeedMode }}
  118. # Authenticated encryption
  119. auth_enc = {{ .P2P.AuthEnc }}
  120. # Comma separated list of peer IDs to keep private (will not be gossiped to other peers)
  121. private_peer_ids = "{{ .P2P.PrivatePeerIDs }}"
  122. ##### mempool configuration options #####
  123. [mempool]
  124. recheck = {{ .Mempool.Recheck }}
  125. recheck_empty = {{ .Mempool.RecheckEmpty }}
  126. broadcast = {{ .Mempool.Broadcast }}
  127. wal_dir = "{{ .Mempool.WalPath }}"
  128. ##### consensus configuration options #####
  129. [consensus]
  130. wal_file = "{{ .Consensus.WalPath }}"
  131. wal_light = {{ .Consensus.WalLight }}
  132. # All timeouts are in milliseconds
  133. timeout_propose = {{ .Consensus.TimeoutPropose }}
  134. timeout_propose_delta = {{ .Consensus.TimeoutProposeDelta }}
  135. timeout_prevote = {{ .Consensus.TimeoutPrevote }}
  136. timeout_prevote_delta = {{ .Consensus.TimeoutPrevoteDelta }}
  137. timeout_precommit = {{ .Consensus.TimeoutPrecommit }}
  138. timeout_precommit_delta = {{ .Consensus.TimeoutPrecommitDelta }}
  139. timeout_commit = {{ .Consensus.TimeoutCommit }}
  140. # Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  141. skip_timeout_commit = {{ .Consensus.SkipTimeoutCommit }}
  142. # BlockSize
  143. max_block_size_txs = {{ .Consensus.MaxBlockSizeTxs }}
  144. max_block_size_bytes = {{ .Consensus.MaxBlockSizeBytes }}
  145. # EmptyBlocks mode and possible interval between empty blocks in seconds
  146. create_empty_blocks = {{ .Consensus.CreateEmptyBlocks }}
  147. create_empty_blocks_interval = {{ .Consensus.CreateEmptyBlocksInterval }}
  148. # Reactor sleep duration parameters are in milliseconds
  149. peer_gossip_sleep_duration = {{ .Consensus.PeerGossipSleepDuration }}
  150. peer_query_maj23_sleep_duration = {{ .Consensus.PeerQueryMaj23SleepDuration }}
  151. ##### transactions indexer configuration options #####
  152. [tx_index]
  153. # What indexer to use for transactions
  154. #
  155. # Options:
  156. # 1) "null" (default)
  157. # 2) "kv" - the simplest possible indexer, backed by key-value storage (defaults to levelDB; see DBBackend).
  158. indexer = "{{ .TxIndex.Indexer }}"
  159. # Comma-separated list of tags to index (by default the only tag is tx hash)
  160. #
  161. # It's recommended to index only a subset of tags due to possible memory
  162. # bloat. This is, of course, depends on the indexer's DB and the volume of
  163. # transactions.
  164. index_tags = "{{ .TxIndex.IndexTags }}"
  165. # When set to true, tells indexer to index all tags. Note this may be not
  166. # desirable (see the comment above). IndexTags has a precedence over
  167. # IndexAllTags (i.e. when given both, IndexTags will be indexed).
  168. index_all_tags = {{ .TxIndex.IndexAllTags }}
  169. `
  170. /****** these are for test settings ***********/
  171. func ResetTestRoot(testName string) *Config {
  172. rootDir := os.ExpandEnv("$HOME/.tendermint_test")
  173. rootDir = filepath.Join(rootDir, testName)
  174. // Remove ~/.tendermint_test_bak
  175. if cmn.FileExists(rootDir + "_bak") {
  176. if err := os.RemoveAll(rootDir + "_bak"); err != nil {
  177. cmn.PanicSanity(err.Error())
  178. }
  179. }
  180. // Move ~/.tendermint_test to ~/.tendermint_test_bak
  181. if cmn.FileExists(rootDir) {
  182. if err := os.Rename(rootDir, rootDir+"_bak"); err != nil {
  183. cmn.PanicSanity(err.Error())
  184. }
  185. }
  186. // Create new dir
  187. if err := cmn.EnsureDir(rootDir, 0700); err != nil {
  188. cmn.PanicSanity(err.Error())
  189. }
  190. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultConfigDir), 0700); err != nil {
  191. cmn.PanicSanity(err.Error())
  192. }
  193. if err := cmn.EnsureDir(filepath.Join(rootDir, defaultDataDir), 0700); err != nil {
  194. cmn.PanicSanity(err.Error())
  195. }
  196. baseConfig := DefaultBaseConfig()
  197. configFilePath := filepath.Join(rootDir, defaultConfigFilePath)
  198. genesisFilePath := filepath.Join(rootDir, baseConfig.Genesis)
  199. privFilePath := filepath.Join(rootDir, baseConfig.PrivValidator)
  200. // Write default config file if missing.
  201. if !cmn.FileExists(configFilePath) {
  202. writeConfigFile(configFilePath)
  203. }
  204. if !cmn.FileExists(genesisFilePath) {
  205. cmn.MustWriteFile(genesisFilePath, []byte(testGenesis), 0644)
  206. }
  207. // we always overwrite the priv val
  208. cmn.MustWriteFile(privFilePath, []byte(testPrivValidator), 0644)
  209. config := TestConfig().SetRoot(rootDir)
  210. return config
  211. }
  212. var testGenesis = `{
  213. "genesis_time": "0001-01-01T00:00:00.000Z",
  214. "chain_id": "tendermint_test",
  215. "validators": [
  216. {
  217. "pub_key": {
  218. "type": "ed25519",
  219. "data":"3B3069C422E19688B45CBFAE7BB009FC0FA1B1EA86593519318B7214853803C8"
  220. },
  221. "power": 10,
  222. "name": ""
  223. }
  224. ],
  225. "app_hash": ""
  226. }`
  227. var testPrivValidator = `{
  228. "address": "D028C9981F7A87F3093672BF0D5B0E2A1B3ED456",
  229. "pub_key": {
  230. "type": "ed25519",
  231. "data": "3B3069C422E19688B45CBFAE7BB009FC0FA1B1EA86593519318B7214853803C8"
  232. },
  233. "priv_key": {
  234. "type": "ed25519",
  235. "data": "27F82582AEFAE7AB151CFB01C48BB6C1A0DA78F9BDDA979A9F70A84D074EB07D3B3069C422E19688B45CBFAE7BB009FC0FA1B1EA86593519318B7214853803C8"
  236. },
  237. "last_height": 0,
  238. "last_round": 0,
  239. "last_step": 0
  240. }`