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.

467 lines
15 KiB

7 years ago
  1. Using Tendermint
  2. ================
  3. This is a guide to using the ``tendermint`` program from the command
  4. line. It assumes only that you have the ``tendermint`` binary installed
  5. and have some rudimentary idea of what Tendermint and ABCI are.
  6. You can see the help menu with ``tendermint --help``, and the version
  7. number with ``tendermint version``.
  8. Directory Root
  9. --------------
  10. The default directory for blockchain data is ``~/.tendermint``. Override
  11. this by setting the ``TMHOME`` environment variable.
  12. Initialize
  13. ----------
  14. Initialize the root directory by running:
  15. ::
  16. tendermint init
  17. This will create a new private key (``priv_validator.json``), and a
  18. genesis file (``genesis.json``) containing the associated public key,
  19. in ``$TMHOME/config``.
  20. This is all that's necessary to run a local testnet with one validator.
  21. For more elaborate initialization, see our `testnet deployment
  22. tool <https://github.com/tendermint/tools/tree/master/mintnet-kubernetes>`__.
  23. Run
  24. ---
  25. To run a tendermint node, use
  26. ::
  27. tendermint node
  28. By default, Tendermint will try to connect to an ABCI application on
  29. `127.0.0.1:46658 <127.0.0.1:46658>`__. If you have the ``dummy`` ABCI
  30. app installed, run it in another window. If you don't, kill tendermint
  31. and run an in-process version with
  32. ::
  33. tendermint node --proxy_app=dummy
  34. After a few seconds you should see blocks start streaming in. Note that
  35. blocks are produced regularly, even if there are no transactions. See *No Empty Blocks*, below, to modify this setting.
  36. Tendermint supports in-process versions of the dummy, counter, and nil
  37. apps that ship as examples in the `ABCI
  38. repository <https://github.com/tendermint/abci>`__. It's easy to compile
  39. your own app in-process with tendermint if it's written in Go. If your
  40. app is not written in Go, simply run it in another process, and use the
  41. ``--proxy_app`` flag to specify the address of the socket it is
  42. listening on, for instance:
  43. ::
  44. tendermint node --proxy_app=/var/run/abci.sock
  45. Transactions
  46. ------------
  47. To send a transaction, use ``curl`` to make requests to the Tendermint
  48. RPC server, for example:
  49. ::
  50. curl http://localhost:46657/broadcast_tx_commit?tx=\"abcd\"
  51. For handling responses, we recommend you `install the jsonpp
  52. tool <http://jmhodges.github.io/jsonpp/>`__ to pretty print the JSON.
  53. We can see the chain's status at the ``/status`` end-point:
  54. ::
  55. curl http://localhost:46657/status | jsonpp
  56. and the ``latest_app_hash`` in particular:
  57. ::
  58. curl http://localhost:46657/status | jsonpp | grep app_hash
  59. Visit http://localhost:46657 in your browser to see the list of other
  60. endpoints. Some take no arguments (like ``/status``), while others
  61. specify the argument name and use ``_`` as a placeholder.
  62. Formatting
  63. ~~~~~~~~~~
  64. The following nuances when sending/formatting transactions should
  65. be taken into account:
  66. With ``GET``:
  67. To send a UTF8 string byte array, quote the value of the tx pramater:
  68. ::
  69. curl 'http://localhost:46657/broadcast_tx_commit?tx="hello"'
  70. which sends a 5 byte transaction: "h e l l o" [68 65 6c 6c 6f].
  71. Note the URL must be wrapped with single quoes, else bash will ignore the double quotes.
  72. To avoid the single quotes, escape the double quotes:
  73. ::
  74. curl http://localhost:46657/broadcast_tx_commit?tx=\"hello\"
  75. Using a special character:
  76. ::
  77. curl 'http://localhost:46657/broadcast_tx_commit?tx="€5"'
  78. sends a 4 byte transaction: "€5" (UTF8) [e2 82 ac 35].
  79. To send as raw hex, omit quotes AND prefix the hex string with ``0x``:
  80. ::
  81. curl http://localhost:46657/broadcast_tx_commit?tx=0x01020304
  82. which sends a 4 byte transaction: [01 02 03 04].
  83. With ``POST`` (using ``json``), the raw hex must be ``base64`` encoded:
  84. ::
  85. curl --data-binary '{"jsonrpc":"2.0","id":"anything","method":"broadcast_tx_commit","params": {"tx": "AQIDBA=="}}' -H 'content-type:text/plain;' http://localhost:46657
  86. which sends the same 4 byte transaction: [01 02 03 04].
  87. Note that raw hex cannot be used in ``POST`` transactions.
  88. Reset
  89. -----
  90. **WARNING: UNSAFE** Only do this in development and only if you can
  91. afford to lose all blockchain data!
  92. To reset a blockchain, stop the node, remove the ``~/.tendermint/data``
  93. directory and run
  94. ::
  95. tendermint unsafe_reset_priv_validator
  96. This final step is necessary to reset the ``priv_validator.json``, which
  97. otherwise prevents you from making conflicting votes in the consensus
  98. (something that could get you in trouble if you do it on a real
  99. blockchain). If you don't reset the ``priv_validator.json``, your fresh
  100. new blockchain will not make any blocks.
  101. Configuration
  102. -------------
  103. Tendermint uses a ``config.toml`` for configuration. For details, see
  104. `the config specification <./specification/configuration.html>`__.
  105. Notable options include the socket address of the application
  106. (``proxy_app``), the listenting address of the tendermint peer
  107. (``p2p.laddr``), and the listening address of the rpc server
  108. (``rpc.laddr``).
  109. Some fields from the config file can be overwritten with flags.
  110. No Empty Blocks
  111. ---------------
  112. This much requested feature was implemented in version 0.10.3. While the
  113. default behaviour of ``tendermint`` is still to create blocks approximately
  114. once per second, it is possible to disable empty blocks or set a block creation
  115. interval. In the former case, blocks will be created when there are new
  116. transactions or when the AppHash changes.
  117. To configure tendermint to not produce empty blocks unless there are
  118. transactions or the app hash changes, run tendermint with this additional flag:
  119. ::
  120. tendermint node --consensus.create_empty_blocks=false
  121. or set the configuration via the ``config.toml`` file:
  122. ::
  123. [consensus]
  124. create_empty_blocks = false
  125. Remember: because the default is to *create empty blocks*, avoiding empty blocks requires the config option to be set to ``false``.
  126. The block interval setting allows for a delay (in seconds) between the creation of each new empty block. It is set via the ``config.toml``:
  127. ::
  128. [consensus]
  129. create_empty_blocks_interval = 5
  130. With this setting, empty blocks will be produced every 5s if no block has been produced otherwise,
  131. regardless of the value of ``create_empty_blocks``.
  132. Broadcast API
  133. -------------
  134. Earlier, we used the ``broadcast_tx_commit`` endpoint to send a
  135. transaction. When a transaction is sent to a tendermint node, it will
  136. run via ``CheckTx`` against the application. If it passes ``CheckTx``,
  137. it will be included in the mempool, broadcast to other peers, and
  138. eventually included in a block.
  139. Since there are multiple phases to processing a transaction, we offer
  140. multiple endpoints to broadcast a transaction:
  141. ::
  142. /broadcast_tx_async
  143. /broadcast_tx_sync
  144. /broadcast_tx_commit
  145. These correspond to no-processing, processing through the mempool, and
  146. processing through a block, respectively. That is,
  147. ``broadcast_tx_async``, will return right away without waiting to hear
  148. if the transaction is even valid, while ``broadcast_tx_sync`` will
  149. return with the result of running the transaction through ``CheckTx``.
  150. Using ``broadcast_tx_commit`` will wait until the transaction is
  151. committed in a block or until some timeout is reached, but will return
  152. right away if the transaction does not pass ``CheckTx``. The return
  153. value for ``broadcast_tx_commit`` includes two fields, ``check_tx`` and
  154. ``deliver_tx``, pertaining to the result of running the transaction
  155. through those ABCI messages.
  156. The benefit of using ``broadcast_tx_commit`` is that the request returns
  157. after the transaction is committed (ie. included in a block), but that
  158. can take on the order of a second. For a quick result, use
  159. ``broadcast_tx_sync``, but the transaction will not be committed until
  160. later, and by that point its effect on the state may change.
  161. Note: see the Transactions => Formatting section for details about
  162. transaction formating.
  163. Tendermint Networks
  164. -------------------
  165. When ``tendermint init`` is run, both a ``genesis.json`` and
  166. ``priv_validator.json`` are created in ``~/.tendermint/config``. The
  167. ``genesis.json`` might look like:
  168. ::
  169. {
  170. "app_hash": "",
  171. "chain_id": "test-chain-HZw6TB",
  172. "genesis_time": "0001-01-01T00:00:00.000Z",
  173. "validators": [
  174. {
  175. "power": 10,
  176. "name": "",
  177. "pub_key": [
  178. 1,
  179. "5770B4DD55B3E08B7F5711C48B516347D8C33F47C30C226315D21AA64E0DFF2E"
  180. ]
  181. }
  182. ]
  183. }
  184. And the ``priv_validator.json``:
  185. ::
  186. {
  187. "address": "4F4D895F882A18E1D1FC608D102601DA8D3570E5",
  188. "last_height": 0,
  189. "last_round": 0,
  190. "last_signature": null,
  191. "last_signbytes": "",
  192. "last_step": 0,
  193. "priv_key": [
  194. 1,
  195. "F9FA3CD435BDAE54D0BCA8F1BC289D718C23D855C6DB21E8543F5E4F457E62805770B4DD55B3E08B7F5711C48B516347D8C33F47C30C226315D21AA64E0DFF2E"
  196. ],
  197. "pub_key": [
  198. 1,
  199. "5770B4DD55B3E08B7F5711C48B516347D8C33F47C30C226315D21AA64E0DFF2E"
  200. ]
  201. }
  202. The ``priv_validator.json`` actually contains a private key, and should
  203. thus be kept absolutely secret; for now we work with the plain text.
  204. Note the ``last_`` fields, which are used to prevent us from signing
  205. conflicting messages.
  206. Note also that the ``pub_key`` (the public key) in the
  207. ``priv_validator.json`` is also present in the ``genesis.json``.
  208. The genesis file contains the list of public keys which may participate in the
  209. consensus, and their corresponding voting power. Greater than 2/3 of the voting
  210. power must be active (ie. the corresponding private keys must be producing
  211. signatures) for the consensus to make progress. In our case, the genesis file
  212. contains the public key of our ``priv_validator.json``, so a tendermint node
  213. started with the default root directory will be able to make progress. Voting
  214. power uses an `int64` but must be positive, thus the range is: 0 through
  215. 9223372036854775807. Because of how the current proposer selection algorithm works,
  216. we do not recommend having voting powers greater than 10^12 (ie. 1 trillion)
  217. (see `Proposals section of Byzantine Consensus Algorithm
  218. <./specification/byzantine-consensus-algorithm.html#proposals>`__ for details).
  219. If we want to add more nodes to the network, we have two choices: we can
  220. add a new validator node, who will also participate in the consensus by
  221. proposing blocks and voting on them, or we can add a new non-validator
  222. node, who will not participate directly, but will verify and keep up
  223. with the consensus protocol.
  224. Peers
  225. ~~~~~
  226. To connect to peers on start-up, specify them in the ``$TMHOME/config/config.toml`` or
  227. on the command line. Use `seeds` to specify seed nodes from which you can get many other
  228. peer addresses, and ``persistent_peers`` to specify peers that your node will maintain
  229. persistent connections with.
  230. For instance,
  231. ::
  232. tendermint node --p2p.seeds "1.2.3.4:46656,5.6.7.8:46656"
  233. Alternatively, you can use the ``/dial_seeds`` endpoint of the RPC to
  234. specify seeds for a running node to connect to:
  235. ::
  236. curl 'localhost:46657/dial_seeds?seeds=\["1.2.3.4:46656","5.6.7.8:46656"\]'
  237. Note, if the peer-exchange protocol (PEX) is enabled (default), you should not
  238. normally need seeds after the first start. Peers will be gossipping about known
  239. peers and forming a network, storing peer addresses in the addrbook.
  240. If you want Tendermint to connect to specific set of addresses and maintain a
  241. persistent connection with each, you can use the ``--p2p.persistent_peers``
  242. flag or the corresponding setting in the ``config.toml`` or the
  243. ``/dial_peers`` RPC endpoint to do it without stopping Tendermint
  244. core instance.
  245. ::
  246. tendermint node --p2p.persistent_peers "10.11.12.13:46656,10.11.12.14:46656"
  247. curl 'localhost:46657/dial_peers?persistent=true&peers=\["1.2.3.4:46656","5.6.7.8:46656"\]'
  248. Adding a Non-Validator
  249. ~~~~~~~~~~~~~~~~~~~~~~
  250. Adding a non-validator is simple. Just copy the original
  251. ``genesis.json`` to ``~/.tendermint/config`` on the new machine and start the
  252. node, specifying seeds or persistent peers as necessary. If no seeds or persistent
  253. peers are specified, the node won't make any blocks, because it's not a validator,
  254. and it won't hear about any blocks, because it's not connected to the other peer.
  255. Adding a Validator
  256. ~~~~~~~~~~~~~~~~~~
  257. The easiest way to add new validators is to do it in the
  258. ``genesis.json``, before starting the network. For instance, we could
  259. make a new ``priv_validator.json``, and copy it's ``pub_key`` into the
  260. above genesis.
  261. We can generate a new ``priv_validator.json`` with the command:
  262. ::
  263. tendermint gen_validator
  264. Now we can update our genesis file. For instance, if the new
  265. ``priv_validator.json`` looks like:
  266. ::
  267. {
  268. "address": "AC379688105901436A34A65F185C115B8BB277A1",
  269. "last_height": 0,
  270. "last_round": 0,
  271. "last_signature": null,
  272. "last_signbytes": "",
  273. "last_step": 0,
  274. "priv_key": [
  275. 1,
  276. "0D2ED337D748ADF79BE28559B9E59EBE1ABBA0BAFE6D65FCB9797985329B950C8F2B5AACAACC9FCE41881349743B0CFDE190DF0177744568D4E82A18F0B7DF94"
  277. ],
  278. "pub_key": [
  279. 1,
  280. "8F2B5AACAACC9FCE41881349743B0CFDE190DF0177744568D4E82A18F0B7DF94"
  281. ]
  282. }
  283. then the new ``genesis.json`` will be:
  284. ::
  285. {
  286. "app_hash": "",
  287. "chain_id": "test-chain-HZw6TB",
  288. "genesis_time": "0001-01-01T00:00:00.000Z",
  289. "validators": [
  290. {
  291. "power": 10,
  292. "name": "",
  293. "pub_key": [
  294. 1,
  295. "5770B4DD55B3E08B7F5711C48B516347D8C33F47C30C226315D21AA64E0DFF2E"
  296. ]
  297. },
  298. {
  299. "power": 10,
  300. "name": "",
  301. "pub_key": [
  302. 1,
  303. "8F2B5AACAACC9FCE41881349743B0CFDE190DF0177744568D4E82A18F0B7DF94"
  304. ]
  305. }
  306. ]
  307. }
  308. Update the ``genesis.json`` in ``~/.tendermint/config``. Copy the genesis file
  309. and the new ``priv_validator.json`` to the ``~/.tendermint/config`` on a new
  310. machine.
  311. Now run ``tendermint node`` on both machines, and use either
  312. ``--p2p.persistent_peers`` or the ``/dial_peers`` to get them to peer up. They
  313. should start making blocks, and will only continue to do so as long as
  314. both of them are online.
  315. To make a Tendermint network that can tolerate one of the validators
  316. failing, you need at least four validator nodes (> 2/3).
  317. Updating validators in a live network is supported but must be
  318. explicitly programmed by the application developer. See the `application
  319. developers guide <./app-development.html>`__ for more
  320. details.
  321. Local Network
  322. ~~~~~~~~~~~~~
  323. To run a network locally, say on a single machine, you must change the
  324. ``_laddr`` fields in the ``config.toml`` (or using the flags) so that
  325. the listening addresses of the various sockets don't conflict.
  326. Additionally, you must set ``addrbook_strict=false`` in the
  327. ``config.toml``, otherwise Tendermint's p2p library will deny making
  328. connections to peers with the same IP address.
  329. Upgrading
  330. ~~~~~~~~~
  331. The tendermint development cycle includes a lot of breaking changes. Upgrading from
  332. an old version to a new version usually means throwing away the chain data. Try out
  333. the `tm-migrate <https://github.com/hxzqlh/tm-tools>`__ tool written by @hxqlh if
  334. you are keen to preserve the state of your chain when upgrading to newer versions.