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.

536 lines
17 KiB

6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
  1. # Using Tendermint
  2. This is a guide to using the `tendermint` program from the command line.
  3. It assumes only that you have the `tendermint` binary installed and have
  4. some rudimentary idea of what Tendermint and ABCI are.
  5. You can see the help menu with `tendermint --help`, and the version
  6. number with `tendermint version`.
  7. ## Directory Root
  8. The default directory for blockchain data is `~/.tendermint`. Override
  9. this by setting the `TMHOME` environment variable.
  10. ## Initialize
  11. Initialize the root directory by running:
  12. ```
  13. tendermint init
  14. ```
  15. This will create a new private key (`priv_validator.json`), and a
  16. genesis file (`genesis.json`) containing the associated public key, in
  17. `$TMHOME/config`. This is all that's necessary to run a local testnet
  18. with one validator.
  19. For more elaborate initialization, see the tesnet command:
  20. ```
  21. tendermint testnet --help
  22. ```
  23. ### Genesis
  24. The `genesis.json` file in `$TMHOME/config/` defines the initial
  25. TendermintCore state upon genesis of the blockchain ([see
  26. definition](https://github.com/tendermint/tendermint/blob/master/types/genesis.go)).
  27. #### Fields
  28. - `genesis_time`: Official time of blockchain start.
  29. - `chain_id`: ID of the blockchain. This must be unique for
  30. every blockchain. If your testnet blockchains do not have unique
  31. chain IDs, you will have a bad time. The ChainID must be less than 50 symbols.
  32. - `validators`: List of initial validators. Note this may be overridden entirely by the
  33. application, and may be left empty to make explicit that the
  34. application will initialize the validator set with ResponseInitChain.
  35. - `pub_key`: The first element specifies the `pub_key` type. 1
  36. == Ed25519. The second element are the pubkey bytes.
  37. - `power`: The validator's voting power.
  38. - `name`: Name of the validator (optional).
  39. - `app_hash`: The expected application hash (as returned by the
  40. `ResponseInfo` ABCI message) upon genesis. If the app's hash does
  41. not match, Tendermint will panic.
  42. - `app_state`: The application state (e.g. initial distribution
  43. of tokens).
  44. #### Sample genesis.json
  45. ```
  46. {
  47. "genesis_time": "2018-11-13T18:11:50.277637Z",
  48. "chain_id": "test-chain-s4ui7D",
  49. "consensus_params": {
  50. "block_size": {
  51. "max_bytes": "22020096",
  52. "max_gas": "-1"
  53. },
  54. "evidence": {
  55. "max_age": "100000"
  56. },
  57. "validator": {
  58. "pub_key_types": [
  59. "ed25519"
  60. ]
  61. }
  62. },
  63. "validators": [
  64. {
  65. "address": "39C04A480B54AB258A45355A5E48ADDED9956C65",
  66. "pub_key": {
  67. "type": "tendermint/PubKeyEd25519",
  68. "value": "DMEMMj1+thrkUCGocbvvKzXeaAtRslvX9MWtB+smuIA="
  69. },
  70. "power": "10",
  71. "name": ""
  72. }
  73. ],
  74. "app_hash": ""
  75. }
  76. ```
  77. ## Run
  78. To run a Tendermint node, use
  79. ```
  80. tendermint node
  81. ```
  82. By default, Tendermint will try to connect to an ABCI application on
  83. [127.0.0.1:26658](127.0.0.1:26658). If you have the `kvstore` ABCI app
  84. installed, run it in another window. If you don't, kill Tendermint and
  85. run an in-process version of the `kvstore` app:
  86. ```
  87. tendermint node --proxy_app=kvstore
  88. ```
  89. After a few seconds you should see blocks start streaming in. Note that
  90. blocks are produced regularly, even if there are no transactions. See
  91. _No Empty Blocks_, below, to modify this setting.
  92. Tendermint supports in-process versions of the `counter`, `kvstore` and
  93. `nil` apps that ship as examples with `abci-cli`. It's easy to compile
  94. your own app in-process with Tendermint if it's written in Go. If your
  95. app is not written in Go, simply run it in another process, and use the
  96. `--proxy_app` flag to specify the address of the socket it is listening
  97. on, for instance:
  98. ```
  99. tendermint node --proxy_app=/var/run/abci.sock
  100. ```
  101. ## Transactions
  102. To send a transaction, use `curl` to make requests to the Tendermint RPC
  103. server, for example:
  104. ```
  105. curl http://localhost:26657/broadcast_tx_commit?tx=\"abcd\"
  106. ```
  107. We can see the chain's status at the `/status` end-point:
  108. ```
  109. curl http://localhost:26657/status | json_pp
  110. ```
  111. and the `latest_app_hash` in particular:
  112. ```
  113. curl http://localhost:26657/status | json_pp | grep latest_app_hash
  114. ```
  115. Visit http://localhost:26657 in your browser to see the list of other
  116. endpoints. Some take no arguments (like `/status`), while others specify
  117. the argument name and use `_` as a placeholder.
  118. ::: tip
  119. Find the RPC Documentation [here](https://tendermint.com/rpc/)
  120. :::
  121. ### Formatting
  122. The following nuances when sending/formatting transactions should be
  123. taken into account:
  124. With `GET`:
  125. To send a UTF8 string byte array, quote the value of the tx pramater:
  126. ```
  127. curl 'http://localhost:26657/broadcast_tx_commit?tx="hello"'
  128. ```
  129. which sends a 5 byte transaction: "h e l l o" \[68 65 6c 6c 6f\].
  130. Note the URL must be wrapped with single quoes, else bash will ignore
  131. the double quotes. To avoid the single quotes, escape the double quotes:
  132. ```
  133. curl http://localhost:26657/broadcast_tx_commit?tx=\"hello\"
  134. ```
  135. Using a special character:
  136. ```
  137. curl 'http://localhost:26657/broadcast_tx_commit?tx="€5"'
  138. ```
  139. sends a 4 byte transaction: "€5" (UTF8) \[e2 82 ac 35\].
  140. To send as raw hex, omit quotes AND prefix the hex string with `0x`:
  141. ```
  142. curl http://localhost:26657/broadcast_tx_commit?tx=0x01020304
  143. ```
  144. which sends a 4 byte transaction: \[01 02 03 04\].
  145. With `POST` (using `json`), the raw hex must be `base64` encoded:
  146. ```
  147. curl --data-binary '{"jsonrpc":"2.0","id":"anything","method":"broadcast_tx_commit","params": {"tx": "AQIDBA=="}}' -H 'content-type:text/plain;' http://localhost:26657
  148. ```
  149. which sends the same 4 byte transaction: \[01 02 03 04\].
  150. Note that raw hex cannot be used in `POST` transactions.
  151. ## Reset
  152. **WARNING: UNSAFE** Only do this in development and only if you can
  153. afford to lose all blockchain data!
  154. To reset a blockchain, stop the node and run:
  155. ```
  156. tendermint unsafe_reset_all
  157. ```
  158. This command will remove the data directory and reset private validator and
  159. address book files.
  160. ## Configuration
  161. Tendermint uses a `config.toml` for configuration. For details, see [the
  162. config specification](./configuration.md).
  163. Notable options include the socket address of the application
  164. (`proxy_app`), the listening address of the Tendermint peer
  165. (`p2p.laddr`), and the listening address of the RPC server
  166. (`rpc.laddr`).
  167. Some fields from the config file can be overwritten with flags.
  168. ## No Empty Blocks
  169. While the default behaviour of `tendermint` is still to create blocks
  170. approximately once per second, it is possible to disable empty blocks or
  171. set a block creation interval. In the former case, blocks will be
  172. created when there are new transactions or when the AppHash changes.
  173. To configure Tendermint to not produce empty blocks unless there are
  174. transactions or the app hash changes, run Tendermint with this
  175. additional flag:
  176. ```
  177. tendermint node --consensus.create_empty_blocks=false
  178. ```
  179. or set the configuration via the `config.toml` file:
  180. ```
  181. [consensus]
  182. create_empty_blocks = false
  183. ```
  184. Remember: because the default is to _create empty blocks_, avoiding
  185. empty blocks requires the config option to be set to `false`.
  186. The block interval setting allows for a delay (in seconds) between the
  187. creation of each new empty block. It is set via the `config.toml`:
  188. ```
  189. [consensus]
  190. create_empty_blocks_interval = 5
  191. ```
  192. With this setting, empty blocks will be produced every 5s if no block
  193. has been produced otherwise, regardless of the value of
  194. `create_empty_blocks`.
  195. ## Broadcast API
  196. Earlier, we used the `broadcast_tx_commit` endpoint to send a
  197. transaction. When a transaction is sent to a Tendermint node, it will
  198. run via `CheckTx` against the application. If it passes `CheckTx`, it
  199. will be included in the mempool, broadcasted to other peers, and
  200. eventually included in a block.
  201. Since there are multiple phases to processing a transaction, we offer
  202. multiple endpoints to broadcast a transaction:
  203. ```
  204. /broadcast_tx_async
  205. /broadcast_tx_sync
  206. /broadcast_tx_commit
  207. ```
  208. These correspond to no-processing, processing through the mempool, and
  209. processing through a block, respectively. That is, `broadcast_tx_async`,
  210. will return right away without waiting to hear if the transaction is
  211. even valid, while `broadcast_tx_sync` will return with the result of
  212. running the transaction through `CheckTx`. Using `broadcast_tx_commit`
  213. will wait until the transaction is committed in a block or until some
  214. timeout is reached, but will return right away if the transaction does
  215. not pass `CheckTx`. The return value for `broadcast_tx_commit` includes
  216. two fields, `check_tx` and `deliver_tx`, pertaining to the result of
  217. running the transaction through those ABCI messages.
  218. The benefit of using `broadcast_tx_commit` is that the request returns
  219. after the transaction is committed (i.e. included in a block), but that
  220. can take on the order of a second. For a quick result, use
  221. `broadcast_tx_sync`, but the transaction will not be committed until
  222. later, and by that point its effect on the state may change.
  223. Note the mempool does not provide strong guarantees - just because a tx passed
  224. CheckTx (ie. was accepted into the mempool), doesn't mean it will be committed,
  225. as nodes with the tx in their mempool may crash before they get to propose.
  226. For more information, see the [mempool
  227. write-ahead-log](../tendermint-core/running-in-production.md#mempool-wal)
  228. ## Tendermint Networks
  229. When `tendermint init` is run, both a `genesis.json` and
  230. `priv_validator.json` are created in `~/.tendermint/config`. The
  231. `genesis.json` might look like:
  232. ```
  233. {
  234. "validators" : [
  235. {
  236. "pub_key" : {
  237. "value" : "h3hk+QE8c6QLTySp8TcfzclJw/BG79ziGB/pIA+DfPE=",
  238. "type" : "tendermint/PubKeyEd25519"
  239. },
  240. "power" : 10,
  241. "name" : ""
  242. }
  243. ],
  244. "app_hash" : "",
  245. "chain_id" : "test-chain-rDlYSN",
  246. "genesis_time" : "0001-01-01T00:00:00Z"
  247. }
  248. ```
  249. And the `priv_validator.json`:
  250. ```
  251. {
  252. "last_step" : 0,
  253. "last_round" : "0",
  254. "address" : "B788DEDE4F50AD8BC9462DE76741CCAFF87D51E2",
  255. "pub_key" : {
  256. "value" : "h3hk+QE8c6QLTySp8TcfzclJw/BG79ziGB/pIA+DfPE=",
  257. "type" : "tendermint/PubKeyEd25519"
  258. },
  259. "last_height" : "0",
  260. "priv_key" : {
  261. "value" : "JPivl82x+LfVkp8i3ztoTjY6c6GJ4pBxQexErOCyhwqHeGT5ATxzpAtPJKnxNx/NyUnD8Ebv3OIYH+kgD4N88Q==",
  262. "type" : "tendermint/PrivKeyEd25519"
  263. }
  264. }
  265. ```
  266. The `priv_validator.json` actually contains a private key, and should
  267. thus be kept absolutely secret; for now we work with the plain text.
  268. Note the `last_` fields, which are used to prevent us from signing
  269. conflicting messages.
  270. Note also that the `pub_key` (the public key) in the
  271. `priv_validator.json` is also present in the `genesis.json`.
  272. The genesis file contains the list of public keys which may participate
  273. in the consensus, and their corresponding voting power. Greater than 2/3
  274. of the voting power must be active (i.e. the corresponding private keys
  275. must be producing signatures) for the consensus to make progress. In our
  276. case, the genesis file contains the public key of our
  277. `priv_validator.json`, so a Tendermint node started with the default
  278. root directory will be able to make progress. Voting power uses an int64
  279. but must be positive, thus the range is: 0 through 9223372036854775807.
  280. Because of how the current proposer selection algorithm works, we do not
  281. recommend having voting powers greater than 10\^12 (ie. 1 trillion).
  282. If we want to add more nodes to the network, we have two choices: we can
  283. add a new validator node, who will also participate in the consensus by
  284. proposing blocks and voting on them, or we can add a new non-validator
  285. node, who will not participate directly, but will verify and keep up
  286. with the consensus protocol.
  287. ### Peers
  288. #### Seed
  289. A seed node is a node who relays the addresses of other peers which they know
  290. of. These nodes constantly crawl the network to try to get more peers. The
  291. addresses which the seed node relays get saved into a local address book. Once
  292. these are in the address book, you will connect to those addresses directly.
  293. Basically the seed nodes job is just to relay everyones addresses. You won't
  294. connect to seed nodes once you have received enough addresses, so typically you
  295. only need them on the first start. The seed node will immediately disconnect
  296. from you after sending you some addresses.
  297. #### Persistent Peer
  298. Persistent peers are people you want to be constantly connected with. If you
  299. disconnect you will try to connect directly back to them as opposed to using
  300. another address from the address book. On restarts you will always try to
  301. connect to these peers regardless of the size of your address book.
  302. All peers relay peers they know of by default. This is called the peer exchange
  303. protocol (PeX). With PeX, peers will be gossipping about known peers and forming
  304. a network, storing peer addresses in the addrbook. Because of this, you don't
  305. have to use a seed node if you have a live persistent peer.
  306. #### Connecting to Peers
  307. To connect to peers on start-up, specify them in the
  308. `$TMHOME/config/config.toml` or on the command line. Use `seeds` to
  309. specify seed nodes, and
  310. `persistent_peers` to specify peers that your node will maintain
  311. persistent connections with.
  312. For example,
  313. ```
  314. tendermint node --p2p.seeds "f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656,0491d373a8e0fcf1023aaf18c51d6a1d0d4f31bd@5.6.7.8:26656"
  315. ```
  316. Alternatively, you can use the `/dial_seeds` endpoint of the RPC to
  317. specify seeds for a running node to connect to:
  318. ```
  319. curl 'localhost:26657/dial_seeds?seeds=\["f9baeaa15fedf5e1ef7448dd60f46c01f1a9e9c4@1.2.3.4:26656","0491d373a8e0fcf1023aaf18c51d6a1d0d4f31bd@5.6.7.8:26656"\]'
  320. ```
  321. Note, with PeX enabled, you
  322. should not need seeds after the first start.
  323. If you want Tendermint to connect to specific set of addresses and
  324. maintain a persistent connection with each, you can use the
  325. `--p2p.persistent_peers` flag or the corresponding setting in the
  326. `config.toml` or the `/dial_peers` RPC endpoint to do it without
  327. stopping Tendermint core instance.
  328. ```
  329. tendermint node --p2p.persistent_peers "429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656,96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"
  330. curl 'localhost:26657/dial_peers?persistent=true&peers=\["429fcf25974313b95673f58d77eacdd434402665@10.11.12.13:26656","96663a3dd0d7b9d17d4c8211b191af259621c693@10.11.12.14:26656"\]'
  331. ```
  332. ### Adding a Non-Validator
  333. Adding a non-validator is simple. Just copy the original `genesis.json`
  334. to `~/.tendermint/config` on the new machine and start the node,
  335. specifying seeds or persistent peers as necessary. If no seeds or
  336. persistent peers are specified, the node won't make any blocks, because
  337. it's not a validator, and it won't hear about any blocks, because it's
  338. not connected to the other peer.
  339. ### Adding a Validator
  340. The easiest way to add new validators is to do it in the `genesis.json`,
  341. before starting the network. For instance, we could make a new
  342. `priv_validator.json`, and copy it's `pub_key` into the above genesis.
  343. We can generate a new `priv_validator.json` with the command:
  344. ```
  345. tendermint gen_validator
  346. ```
  347. Now we can update our genesis file. For instance, if the new
  348. `priv_validator.json` looks like:
  349. ```
  350. {
  351. "address" : "5AF49D2A2D4F5AD4C7C8C4CC2FB020131E9C4902",
  352. "pub_key" : {
  353. "value" : "l9X9+fjkeBzDfPGbUM7AMIRE6uJN78zN5+lk5OYotek=",
  354. "type" : "tendermint/PubKeyEd25519"
  355. },
  356. "priv_key" : {
  357. "value" : "EDJY9W6zlAw+su6ITgTKg2nTZcHAH1NMTW5iwlgmNDuX1f35+OR4HMN88ZtQzsAwhETq4k3vzM3n6WTk5ii16Q==",
  358. "type" : "tendermint/PrivKeyEd25519"
  359. },
  360. "last_step" : 0,
  361. "last_round" : "0",
  362. "last_height" : "0"
  363. }
  364. ```
  365. then the new `genesis.json` will be:
  366. ```
  367. {
  368. "validators" : [
  369. {
  370. "pub_key" : {
  371. "value" : "h3hk+QE8c6QLTySp8TcfzclJw/BG79ziGB/pIA+DfPE=",
  372. "type" : "tendermint/PubKeyEd25519"
  373. },
  374. "power" : 10,
  375. "name" : ""
  376. },
  377. {
  378. "pub_key" : {
  379. "value" : "l9X9+fjkeBzDfPGbUM7AMIRE6uJN78zN5+lk5OYotek=",
  380. "type" : "tendermint/PubKeyEd25519"
  381. },
  382. "power" : 10,
  383. "name" : ""
  384. }
  385. ],
  386. "app_hash" : "",
  387. "chain_id" : "test-chain-rDlYSN",
  388. "genesis_time" : "0001-01-01T00:00:00Z"
  389. }
  390. ```
  391. Update the `genesis.json` in `~/.tendermint/config`. Copy the genesis
  392. file and the new `priv_validator.json` to the `~/.tendermint/config` on
  393. a new machine.
  394. Now run `tendermint node` on both machines, and use either
  395. `--p2p.persistent_peers` or the `/dial_peers` to get them to peer up.
  396. They should start making blocks, and will only continue to do so as long
  397. as both of them are online.
  398. To make a Tendermint network that can tolerate one of the validators
  399. failing, you need at least four validator nodes (e.g., 2/3).
  400. Updating validators in a live network is supported but must be
  401. explicitly programmed by the application developer. See the [application
  402. developers guide](../app-dev/app-development.md) for more details.
  403. ### Local Network
  404. To run a network locally, say on a single machine, you must change the
  405. `_laddr` fields in the `config.toml` (or using the flags) so that the
  406. listening addresses of the various sockets don't conflict. Additionally,
  407. you must set `addr_book_strict=false` in the `config.toml`, otherwise
  408. Tendermint's p2p library will deny making connections to peers with the
  409. same IP address.
  410. ### Upgrading
  411. The Tendermint development cycle currently includes a lot of breaking changes.
  412. Upgrading from an old version to a new version usually means throwing
  413. away the chain data. Try out the
  414. [tm-migrate](https://github.com/hxzqlh/tm-tools) tool written by
  415. [@hxzqlh](https://github.com/hxzqlh) if you are keen to preserve the
  416. state of your chain when upgrading to newer versions.