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.

485 lines
18 KiB

  1. # Upgrading Tendermint Core
  2. This guide provides steps to be followed when you upgrade your applications to
  3. a newer version of Tendermint Core.
  4. ## Unreleased
  5. <Overview>
  6. ### Protobuf Changes
  7. When upgrading to version <version #> you will have to fetch the `third_party` directory along with the updated proto files.
  8. ## v0.33.0
  9. This release is not compatible with previous blockchains due to commit becoming signatures only and fields in the header have been removed.
  10. ### Config Changes
  11. You will need to generate a new config if you have used a prior version of tendermint.
  12. - Tags have been entirely renamed throughout the codebase to events and there keys are called [compositeKeys](https://github.com/tendermint/tendermint/blob/6d05c531f7efef6f0619155cf10ae8557dd7832f/docs/app-dev/indexing-transactions.md).
  13. - Evidence Params has been changed to include duration.
  14. - `consensus_params.evidence.max_age_duration`.
  15. - Renamed `consensus_params.evidence.max_age` to `max_age_num_blocks`.
  16. ### Go API
  17. - `libs/common` has been removed in favor of specific pkgs.
  18. - `async`
  19. - `service`
  20. - `rand`
  21. - `net`
  22. - `strings`
  23. - `cmap`
  24. - removal of `errors` pkg
  25. ### RPC Changes
  26. - `/validators` is now paginated (default: 30 vals per page)
  27. - `/block_results` response format updated [see RPC docs for details](https://docs.tendermint.com/master/rpc/#/Info/block_results)
  28. - Event suffix has been removed from the ID in event responses
  29. - IDs are now integers not `json-client-XYZ`
  30. ## v0.32.0
  31. This release is compatible with previous blockchains,
  32. however the new ABCI Events mechanism may create some complexity
  33. for nodes wishing to continue operation with v0.32 from a previous version.
  34. There are some minor breaking changes to the RPC.
  35. ### Config Changes
  36. If you have `db_backend` set to `leveldb` in your config file, please change it
  37. to `goleveldb` or `cleveldb`.
  38. ### RPC Changes
  39. The default listen address for the RPC is now `127.0.0.1`. If you want to expose
  40. it publicly, you have to explicitly configure it. Note exposing the RPC to the
  41. public internet may not be safe - endpoints which return a lot of data may
  42. enable resource exhaustion attacks on your node, causing the process to crash.
  43. Any consumers of `/block_results` need to be mindful of the change in all field
  44. names from CamelCase to Snake case, eg. `results.DeliverTx` is now `results.deliver_tx`.
  45. This is a fix, but it's breaking.
  46. ### ABCI Changes
  47. ABCI responses which previously had a `Tags` field now have an `Events` field
  48. instead. The original `Tags` field was simply a list of key-value pairs, where
  49. each key effectively represented some attribute of an event occuring in the
  50. blockchain, like `sender`, `receiver`, or `amount`. However, it was difficult to
  51. represent the occurence of multiple events (for instance, multiple transfers) in a single list.
  52. The new `Events` field contains a list of `Event`, where each `Event` is itself a list
  53. of key-value pairs, allowing for more natural expression of multiple events in
  54. eg. a single DeliverTx or EndBlock. Note each `Event` also includes a `Type`, which is meant to categorize the
  55. event.
  56. For transaction indexing, the index key is
  57. prefixed with the event type: `{eventType}.{attributeKey}`.
  58. If the same event type and attribute key appear multiple times, the values are
  59. appended in a list.
  60. To make queries, include the event type as a prefix. For instance if you
  61. previously queried for `recipient = 'XYZ'`, and after the upgrade you name your event `transfer`,
  62. the new query would be for `transfer.recipient = 'XYZ'`.
  63. Note that transactions indexed on a node before upgrading to v0.32 will still be indexed
  64. using the old scheme. For instance, if a node upgraded at height 100,
  65. transactions before 100 would be queried with `recipient = 'XYZ'` and
  66. transactions after 100 would be queried with `transfer.recipient = 'XYZ'`.
  67. While this presents additional complexity to clients, it avoids the need to
  68. reindex. Of course, you can reset the node and sync from scratch to re-index
  69. entirely using the new scheme.
  70. We illustrate further with a more complete example.
  71. Prior to the update, suppose your `ResponseDeliverTx` look like:
  72. ```go
  73. abci.ResponseDeliverTx{
  74. Tags: []kv.Pair{
  75. {Key: []byte("sender"), Value: []byte("foo")},
  76. {Key: []byte("recipient"), Value: []byte("bar")},
  77. {Key: []byte("amount"), Value: []byte("35")},
  78. }
  79. }
  80. ```
  81. The following queries would match this transaction:
  82. ```go
  83. query.MustParse("tm.event = 'Tx' AND sender = 'foo'")
  84. query.MustParse("tm.event = 'Tx' AND recipient = 'bar'")
  85. query.MustParse("tm.event = 'Tx' AND sender = 'foo' AND recipient = 'bar'")
  86. ```
  87. Following the upgrade, your `ResponseDeliverTx` would look something like:
  88. the following `Events`:
  89. ```go
  90. abci.ResponseDeliverTx{
  91. Events: []abci.Event{
  92. {
  93. Type: "transfer",
  94. Attributes: kv.Pairs{
  95. {Key: []byte("sender"), Value: []byte("foo")},
  96. {Key: []byte("recipient"), Value: []byte("bar")},
  97. {Key: []byte("amount"), Value: []byte("35")},
  98. },
  99. }
  100. }
  101. ```
  102. Now the following queries would match this transaction:
  103. ```go
  104. query.MustParse("tm.event = 'Tx' AND transfer.sender = 'foo'")
  105. query.MustParse("tm.event = 'Tx' AND transfer.recipient = 'bar'")
  106. query.MustParse("tm.event = 'Tx' AND transfer.sender = 'foo' AND transfer.recipient = 'bar'")
  107. ```
  108. For further documentation on `Events`, see the [docs](https://github.com/tendermint/tendermint/blob/60827f75623b92eff132dc0eff5b49d2025c591e/docs/spec/abci/abci.md#events).
  109. ### Go Applications
  110. The ABCI Application interface changed slightly so the CheckTx and DeliverTx
  111. methods now take Request structs. The contents of these structs are just the raw
  112. tx bytes, which were previously passed in as the argument.
  113. ## v0.31.6
  114. There are no breaking changes in this release except Go API of p2p and
  115. mempool packages. Hovewer, if you're using cleveldb, you'll need to change
  116. the compilation tag:
  117. Use `cleveldb` tag instead of `gcc` to compile Tendermint with CLevelDB or
  118. use `make build_c` / `make install_c` (full instructions can be found at
  119. https://tendermint.com/docs/introduction/install.html#compile-with-cleveldb-support)
  120. ## v0.31.0
  121. This release contains a breaking change to the behaviour of the pubsub system.
  122. It also contains some minor breaking changes in the Go API and ABCI.
  123. There are no changes to the block or p2p protocols, so v0.31.0 should work fine
  124. with blockchains created from the v0.30 series.
  125. ### RPC
  126. The pubsub no longer blocks on publishing. This may cause some WebSocket (WS) clients to stop working as expected.
  127. If your WS client is not consuming events fast enough, Tendermint can terminate the subscription.
  128. In this case, the WS client will receive an error with description:
  129. ```json
  130. {
  131. "jsonrpc": "2.0",
  132. "id": "{ID}#event",
  133. "error": {
  134. "code": -32000,
  135. "msg": "Server error",
  136. "data": "subscription was cancelled (reason: client is not pulling messages fast enough)" // or "subscription was cancelled (reason: Tendermint exited)"
  137. }
  138. }
  139. Additionally, there are now limits on the number of subscribers and
  140. subscriptions that can be active at once. See the new
  141. `rpc.max_subscription_clients` and `rpc.max_subscriptions_per_client` values to
  142. configure this.
  143. ```
  144. ### Applications
  145. Simple rename of `ConsensusParams.BlockSize` to `ConsensusParams.Block`.
  146. The `ConsensusParams.Block.TimeIotaMS` field was also removed. It's configured
  147. in the ConsensusParsm in genesis.
  148. ### Go API
  149. See the [CHANGELOG](CHANGELOG.md). These are relatively straight forward.
  150. ## v0.30.0
  151. This release contains a breaking change to both the block and p2p protocols,
  152. however it may be compatible with blockchains created with v0.29.0 depending on
  153. the chain history. If your blockchain has not included any pieces of evidence,
  154. or no piece of evidence has been included in more than one block,
  155. and if your application has never returned multiple updates
  156. for the same validator in a single block, then v0.30.0 will work fine with
  157. blockchains created with v0.29.0.
  158. The p2p protocol change is to fix the proposer selection algorithm again.
  159. Note that proposer selection is purely a p2p concern right
  160. now since the algorithm is only relevant during real time consensus.
  161. This change is thus compatible with v0.29.0, but
  162. all nodes must be upgraded to avoid disagreements on the proposer.
  163. ### Applications
  164. Applications must ensure they do not return duplicates in
  165. `ResponseEndBlock.ValidatorUpdates`. A pubkey must only appear once per set of
  166. updates. Duplicates will cause irrecoverable failure. If you have a very good
  167. reason why we shouldn't do this, please open an issue.
  168. ## v0.29.0
  169. This release contains some breaking changes to the block and p2p protocols,
  170. and will not be compatible with any previous versions of the software, primarily
  171. due to changes in how various data structures are hashed.
  172. Any implementations of Tendermint blockchain verification, including lite clients,
  173. will need to be updated. For specific details:
  174. - [Merkle tree](https://github.com/tendermint/spec/blob/master/spec/blockchain/encoding.md#merkle-trees)
  175. - [ConsensusParams](https://github.com/tendermint/spec/blob/master/spec/blockchain/state.md#consensusparams)
  176. There was also a small change to field ordering in the vote struct. Any
  177. implementations of an out-of-process validator (like a Key-Management Server)
  178. will need to be updated. For specific details:
  179. - [Vote](https://github.com/tendermint/spec/blob/master/spec/consensus/signing.md#votes)
  180. Finally, the proposer selection algorithm continues to evolve. See the
  181. [work-in-progress
  182. specification](https://github.com/tendermint/tendermint/pull/3140).
  183. For everything else, please see the [CHANGELOG](./CHANGELOG.md#v0.29.0).
  184. ## v0.28.0
  185. This release breaks the format for the `priv_validator.json` file
  186. and the protocol used for the external validator process.
  187. It is compatible with v0.27.0 blockchains (neither the BlockProtocol nor the
  188. P2PProtocol have changed).
  189. Please read carefully for details about upgrading.
  190. **Note:** Backup your `config/priv_validator.json`
  191. before proceeding.
  192. ### `priv_validator.json`
  193. The `config/priv_validator.json` is now two files:
  194. `config/priv_validator_key.json` and `data/priv_validator_state.json`.
  195. The former contains the key material, the later contains the details on the last
  196. message signed.
  197. When running v0.28.0 for the first time, it will back up any pre-existing
  198. `priv_validator.json` file and proceed to split it into the two new files.
  199. Upgrading should happen automatically without problem.
  200. To upgrade manually, use the provided `privValUpgrade.go` script, with exact paths for the old
  201. `priv_validator.json` and the locations for the two new files. It's recomended
  202. to use the default paths, of `config/priv_validator_key.json` and
  203. `data/priv_validator_state.json`, respectively:
  204. ```
  205. go run scripts/privValUpgrade.go <old-path> <new-key-path> <new-state-path>
  206. ```
  207. ### External validator signers
  208. The Unix and TCP implementations of the remote signing validator
  209. have been consolidated into a single implementation.
  210. Thus in both cases, the external process is expected to dial
  211. Tendermint. This is different from how Unix sockets used to work, where
  212. Tendermint dialed the external process.
  213. The `PubKeyMsg` was also split into separate `Request` and `Response` types
  214. for consistency with other messages.
  215. Note that the TCP sockets don't yet use a persistent key,
  216. so while they're encrypted, they can't yet be properly authenticated.
  217. See [#3105](https://github.com/tendermint/tendermint/issues/3105).
  218. Note the Unix socket has neither encryption nor authentication, but will
  219. add a shared-secret in [#3099](https://github.com/tendermint/tendermint/issues/3099).
  220. ## v0.27.0
  221. This release contains some breaking changes to the block and p2p protocols,
  222. but does not change any core data structures, so it should be compatible with
  223. existing blockchains from the v0.26 series that only used Ed25519 validator keys.
  224. Blockchains using Secp256k1 for validators will not be compatible. This is due
  225. to the fact that we now enforce which key types validators can use as a
  226. consensus param. The default is Ed25519, and Secp256k1 must be activated
  227. explicitly.
  228. It is recommended to upgrade all nodes at once to avoid incompatibilities at the
  229. peer layer - namely, the heartbeat consensus message has been removed (only
  230. relevant if `create_empty_blocks=false` or `create_empty_blocks_interval > 0`),
  231. and the proposer selection algorithm has changed. Since proposer information is
  232. never included in the blockchain, this change only affects the peer layer.
  233. ### Go API Changes
  234. #### libs/db
  235. The ReverseIterator API has changed the meaning of `start` and `end`.
  236. Before, iteration was from `start` to `end`, where
  237. `start > end`. Now, iteration is from `end` to `start`, where `start < end`.
  238. The iterator also excludes `end`. This change allows a simplified and more
  239. intuitive logic, aligning the semantic meaning of `start` and `end` in the
  240. `Iterator` and `ReverseIterator`.
  241. ### Applications
  242. This release enforces a new consensus parameter, the
  243. ValidatorParams.PubKeyTypes. Applications must ensure that they only return
  244. validator updates with the allowed PubKeyTypes. If a validator update includes a
  245. pubkey type that is not included in the ConsensusParams.Validator.PubKeyTypes,
  246. block execution will fail and the consensus will halt.
  247. By default, only Ed25519 pubkeys may be used for validators. Enabling
  248. Secp256k1 requires explicit modification of the ConsensusParams.
  249. Please update your application accordingly (ie. restrict validators to only be
  250. able to use Ed25519 keys, or explicitly add additional key types to the genesis
  251. file).
  252. ## v0.26.0
  253. This release contains a lot of changes to core data types and protocols. It is not
  254. compatible to the old versions and there is no straight forward way to update
  255. old data to be compatible with the new version.
  256. To reset the state do:
  257. ```
  258. $ tendermint unsafe_reset_all
  259. ```
  260. Here we summarize some other notable changes to be mindful of.
  261. ### Config Changes
  262. All timeouts must be changed from integers to strings with their duration, for
  263. instance `flush_throttle_timeout = 100` would be changed to
  264. `flush_throttle_timeout = "100ms"` and `timeout_propose = 3000` would be changed
  265. to `timeout_propose = "3s"`.
  266. ### RPC Changes
  267. The default behaviour of `/abci_query` has been changed to not return a proof,
  268. and the name of the parameter that controls this has been changed from `trusted`
  269. to `prove`. To get proofs with your queries, ensure you set `prove=true`.
  270. Various version fields like `amino_version`, `p2p_version`, `consensus_version`,
  271. and `rpc_version` have been removed from the `node_info.other` and are
  272. consolidated under the tendermint semantic version (ie. `node_info.version`) and
  273. the new `block` and `p2p` protocol versions under `node_info.protocol_version`.
  274. ### ABCI Changes
  275. Field numbers were bumped in the `Header` and `ResponseInfo` messages to make
  276. room for new `version` fields. It should be straight forward to recompile the
  277. protobuf file for these changes.
  278. #### Proofs
  279. The `ResponseQuery.Proof` field is now structured as a `[]ProofOp` to support
  280. generalized Merkle tree constructions where the leaves of one Merkle tree are
  281. the root of another. If you don't need this functionality, and you used to
  282. return `<proof bytes>` here, you should instead return a single `ProofOp` with
  283. just the `Data` field set:
  284. ```
  285. []ProofOp{
  286. ProofOp{
  287. Data: <proof bytes>,
  288. }
  289. }
  290. ```
  291. For more information, see:
  292. - [ADR-026](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/docs/architecture/adr-026-general-merkle-proof.md)
  293. - [Relevant ABCI
  294. documentation](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/docs/spec/abci/apps.md#query-proofs)
  295. - [Description of
  296. keys](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/crypto/merkle/proof_key_path.go#L14)
  297. ### Go API Changes
  298. #### crypto/merkle
  299. The `merkle.Hasher` interface was removed. Functions which used to take `Hasher`
  300. now simply take `[]byte`. This means that any objects being Merklized should be
  301. serialized before they are passed in.
  302. #### node
  303. The `node.RunForever` function was removed. Signal handling and running forever
  304. should instead be explicitly configured by the caller. See how we do it
  305. [here](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/cmd/tendermint/commands/run_node.go#L60).
  306. ### Other
  307. All hashes, except for public key addresses, are now 32-bytes.
  308. ## v0.25.0
  309. This release has minimal impact.
  310. If you use GasWanted in ABCI and want to enforce it, set the MaxGas in the genesis file (default is no max).
  311. ## v0.24.0
  312. New 0.24.0 release contains a lot of changes to the state and types. It's not
  313. compatible to the old versions and there is no straight forward way to update
  314. old data to be compatible with the new version.
  315. To reset the state do:
  316. ```
  317. $ tendermint unsafe_reset_all
  318. ```
  319. Here we summarize some other notable changes to be mindful of.
  320. ### Config changes
  321. `p2p.max_num_peers` was removed in favor of `p2p.max_num_inbound_peers` and
  322. `p2p.max_num_outbound_peers`.
  323. ```
  324. # Maximum number of inbound peers
  325. max_num_inbound_peers = 40
  326. # Maximum number of outbound peers to connect to, excluding persistent peers
  327. max_num_outbound_peers = 10
  328. ```
  329. As you can see, the default ratio of inbound/outbound peers is 4/1. The reason
  330. is we want it to be easier for new nodes to connect to the network. You can
  331. tweak these parameters to alter the network topology.
  332. ### RPC Changes
  333. The result of `/commit` used to contain `header` and `commit` fields at the top level. These are now contained under the `signed_header` field.
  334. ### ABCI Changes
  335. The header has been upgraded and contains new fields, but none of the existing
  336. fields were changed, except their order.
  337. The `Validator` type was split into two, one containing an `Address` and one
  338. containing a `PubKey`. When processing `RequestBeginBlock`, use the `Validator`
  339. type, which contains just the `Address`. When returning `ResponseEndBlock`, use
  340. the `ValidatorUpdate` type, which contains just the `PubKey`.
  341. ### Validator Set Updates
  342. Validator set updates returned in ResponseEndBlock for height `H` used to take
  343. effect immediately at height `H+1`. Now they will be delayed one block, to take
  344. effect at height `H+2`. Note this means that the change will be seen by the ABCI
  345. app in the `RequestBeginBlock.LastCommitInfo` at block `H+3`. Apps were already
  346. required to maintain a map from validator addresses to pubkeys since v0.23 (when
  347. pubkeys were removed from RequestBeginBlock), but now they may need to track
  348. multiple validator sets at once to accomodate this delay.
  349. ### Block Size
  350. The `ConsensusParams.BlockSize.MaxTxs` was removed in favour of
  351. `ConsensusParams.BlockSize.MaxBytes`, which is now enforced. This means blocks
  352. are limitted only by byte-size, not by number of transactions.