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.

870 lines
34 KiB

  1. # Upgrading Tendermint Core
  2. This guide provides instructions for upgrading to specific versions of Tendermint Core.
  3. ## Unreleased
  4. ### ABCI Changes
  5. * Added `AbciVersion` to `RequestInfo`. Applications should check that the ABCI version they expect is being used in order to avoid unimplemented changes errors.
  6. * The method `SetOption` has been removed from the ABCI.Client interface. This feature was used in the early ABCI implementation's.
  7. * Messages are written to a byte stream using uin64 length delimiters instead of int64.
  8. * When mempool `v1` is enabled, transactions broadcasted via `sync` mode may return a successful
  9. response with a transaction hash indicating that the transaction was successfully inserted into
  10. the mempool. While this is true for `v0`, the `v1` mempool reactor may at a later point in time
  11. evict or even drop this transaction after a hash has been returned. Thus, the user or client must
  12. query for that transaction to check if it is still in the mempool.
  13. ### Config Changes
  14. * `fast_sync = "v1"` and `fast_sync = "v2"` are no longer supported. Please use `v0` instead.
  15. * All config parameters are now hyphen-case (also known as kebab-case) instead of snake_case. Before restarting the node make sure
  16. you have updated all the variables in your `config.toml` file.
  17. * Added `--mode` flag and `mode` config variable on `config.toml` for setting Mode of the Node: `full` | `validator` | `seed` (default: `full`)
  18. [ADR-52](https://github.com/tendermint/tendermint/blob/master/docs/architecture/adr-052-tendermint-mode.md)
  19. * `BootstrapPeers` has been added as part of the new p2p stack. This will eventually replace
  20. `Seeds`. Bootstrap peers are connected with on startup if needed for peer discovery. Unlike
  21. persistent peers, there's no gaurantee that the node will remain connected with these peers.
  22. * configuration values starting with `priv-validator-` have moved to the new
  23. `priv-validator` section, without the `priv-validator-` prefix.
  24. * The fast sync process as well as the blockchain package and service has all
  25. been renamed to block sync
  26. ### Key Format Changes
  27. The format of all tendermint on-disk database keys changes in
  28. 0.35. Upgrading nodes must either re-sync all data or run a migration
  29. script provided in this release. The script located in
  30. `github.com/tendermint/tendermint/scripts/keymigrate/migrate.go`
  31. provides the function `Migrate(context.Context, db.DB)` which you can
  32. operationalize as makes sense for your deployment.
  33. For ease of use the `tendermint` command includes a CLI version of the
  34. migration script, which you can invoke, as in:
  35. tendermint key-migrate
  36. This reads the configuration file as normal and allows the
  37. `--db-backend` and `--db-dir` flags to change database operations as
  38. needed.
  39. The migration operation is idempotent and can be run more than once,
  40. if needed.
  41. ### CLI Changes
  42. * You must now specify the node mode (validator|full|seed) in `tendermint init [mode]`
  43. * If you had previously used `tendermint gen_node_key` to generate a new node
  44. key, keep in mind that it no longer saves the output to a file. You can use
  45. `tendermint init validator` or pipe the output of `tendermint gen_node_key` to
  46. `$TMHOME/config/node_key.json`:
  47. ```
  48. $ tendermint gen_node_key > $TMHOME/config/node_key.json
  49. ```
  50. * CLI commands and flags are all now hyphen-case instead of snake_case.
  51. Make sure to adjust any scripts that calls a cli command with snake_casing
  52. ### API Changes
  53. The p2p layer was reimplemented as part of the 0.35 release cycle, and
  54. all reactors were refactored. As part of that work these
  55. implementations moved into the `internal` package and are no longer
  56. considered part of the public Go API of tendermint. These packages
  57. are:
  58. - `p2p`
  59. - `mempool`
  60. - `consensus`
  61. - `statesync`
  62. - `blockchain`
  63. - `evidence`
  64. Accordingly, the `node` package was changed to reduce access to
  65. tendermint internals: applications that use tendermint as a library
  66. will need to change to accommodate these changes. Most notably:
  67. - The `Node` type has become internal, and all constructors return a
  68. `service.Service` implementation.
  69. - The `node.DefaultNewNode` and `node.NewNode` constructors are no
  70. longer exported and have been replaced with `node.New` and
  71. `node.NewDefault` which provide more functional interfaces.
  72. ### RPC changes
  73. #### gRPC Support
  74. Mark gRPC in the RPC layer as deprecated and to be removed in 0.36.
  75. #### Peer Management Interface
  76. When running with the new P2P Layer, the methods `UnsafeDialSeeds` and
  77. `UnsafeDialPeers` RPC methods will always return an error. They are
  78. deprecated and will be removed in 0.36 when the legacy peer stack is
  79. removed.
  80. Additionally the format of the Peer list returned in the `NetInfo`
  81. method changes in this release to accommodate the different way that
  82. the new stack tracks data about peers. This change affects users of
  83. both stacks.
  84. ### Support for Custom Reactor and Mempool Implementations
  85. The changes to p2p layer removed existing support for custom
  86. reactors. Based on our understanding of how this functionality was
  87. used, the introduction of the prioritized mempool covers nearly all of
  88. the use cases for custom reactors. If you are currently running custom
  89. reactors and mempools and are having trouble seeing the migration path
  90. for your project please feel free to reach out to the Tendermint Core
  91. development team directly.
  92. ## v0.34.0
  93. **Upgrading to Tendermint 0.34 requires a blockchain restart.**
  94. This release is not compatible with previous blockchains due to changes to
  95. the encoding format (see "Protocol Buffers," below) and the block header (see "Blockchain Protocol").
  96. Note also that Tendermint 0.34 also requires Go 1.16 or higher.
  97. ### ABCI Changes
  98. * The `ABCIVersion` is now `0.17.0`.
  99. * New ABCI methods (`ListSnapshots`, `LoadSnapshotChunk`, `OfferSnapshot`, and `ApplySnapshotChunk`)
  100. were added to support the new State Sync feature.
  101. Previously, syncing a new node to a preexisting network could take days; but with State Sync,
  102. new nodes are able to join a network in a matter of seconds.
  103. Read [the spec](https://docs.tendermint.com/master/spec/abci/apps.html#state-sync)
  104. if you want to learn more about State Sync, or if you'd like your application to use it.
  105. (If you don't want to support State Sync in your application, you can just implement these new
  106. ABCI methods as no-ops, leaving them empty.)
  107. * `KV.Pair` has been replaced with `abci.EventAttribute`. The `EventAttribute.Index` field
  108. allows ABCI applications to dictate which events should be indexed.
  109. * The blockchain can now start from an arbitrary initial height,
  110. provided to the application via `RequestInitChain.InitialHeight`.
  111. * ABCI evidence type is now an enum with two recognized types of evidence:
  112. `DUPLICATE_VOTE` and `LIGHT_CLIENT_ATTACK`.
  113. Applications should be able to handle these evidence types
  114. (i.e., through slashing or other accountability measures).
  115. * The [`PublicKey` type](https://github.com/tendermint/tendermint/blob/master/proto/tendermint/crypto/keys.proto#L13-L15)
  116. (used in ABCI as part of `ValidatorUpdate`) now uses a `oneof` protobuf type.
  117. Note that since Tendermint only supports ed25519 validator keys, there's only one
  118. option in the `oneof`. For more, see "Protocol Buffers," below.
  119. * The field `Proof`, on the ABCI type `ResponseQuery`, is now named `ProofOps`.
  120. For more, see "Crypto," below.
  121. * The method `SetOption` has been removed from the ABCI.Client interface. This feature was used in the early ABCI implementation's.
  122. ### P2P Protocol
  123. The default codec is now proto3, not amino. The schema files can be found in the `/proto`
  124. directory. For more, see "Protobuf," below.
  125. ### Blockchain Protocol
  126. * `Header#LastResultsHash`, which is the root hash of a Merkle tree built from
  127. `ResponseDeliverTx(Code, Data)` as of v0.34 also includes `GasWanted` and `GasUsed`
  128. fields.
  129. * Merkle hashes of empty trees previously returned nothing, but now return the hash of an empty input,
  130. to conform with [RFC-6962](https://tools.ietf.org/html/rfc6962).
  131. This mainly affects `Header#DataHash`, `Header#LastResultsHash`, and
  132. `Header#EvidenceHash`, which are often empty. Non-empty hashes can also be affected, e.g. if their
  133. inputs depend on other (empty) Merkle hashes, giving different results.
  134. ### Transaction Indexing
  135. Tendermint now relies on the application to tell it which transactions to index. This means that
  136. in the `config.toml`, generated by Tendermint, there is no longer a way to specify which
  137. transactions to index. `tx.height` and `tx.hash` will always be indexed when using the `kv` indexer.
  138. Applications must now choose to either a) enable indexing for all transactions, or
  139. b) allow node operators to decide which transactions to index.
  140. Applications can notify Tendermint to index a specific transaction by setting
  141. `Index: bool` to `true` in the Event Attribute:
  142. ```go
  143. []types.Event{
  144. {
  145. Type: "app",
  146. Attributes: []types.EventAttribute{
  147. {Key: []byte("creator"), Value: []byte("Cosmoshi Netowoko"), Index: true},
  148. },
  149. },
  150. }
  151. ```
  152. ### Protocol Buffers
  153. Tendermint 0.34 replaces Amino with Protocol Buffers for encoding.
  154. This migration is extensive and results in a number of changes, however,
  155. Tendermint only uses the types generated from Protocol Buffers for disk and
  156. wire serialization.
  157. **This means that these changes should not affect you as a Tendermint user.**
  158. However, Tendermint users and contributors may note the following changes:
  159. * Directory layout changes: All proto files have been moved under one directory, `/proto`.
  160. This is in line with the recommended file layout by [Buf](https://buf.build).
  161. For more, see the [Buf documentation](https://buf.build/docs/lint-checkers#file_layout).
  162. * ABCI Changes: As noted in the "ABCI Changes" section above, the `PublicKey` type now uses
  163. a `oneof` type.
  164. For more on the Protobuf changes, please see our [blog post on this migration](https://medium.com/tendermint/tendermint-0-34-protocol-buffers-and-you-8c40558939ae).
  165. ### Consensus Parameters
  166. Tendermint 0.34 includes new and updated consensus parameters.
  167. #### Version Parameters (New)
  168. * `AppVersion`, which is the version of the ABCI application.
  169. #### Evidence Parameters
  170. * `MaxBytes`, which caps the total amount of evidence. The default is 1048576 (1 MB).
  171. ### Crypto
  172. #### Keys
  173. * Keys no longer include a type prefix. For example, ed25519 pubkeys have been renamed from
  174. `PubKeyEd25519` to `PubKey`. This reduces stutter (e.g., `ed25519.PubKey`).
  175. * Keys are now byte slices (`[]byte`) instead of byte arrays (`[<size>]byte`).
  176. * The multisig functionality that was previously in Tendermint now has
  177. a new home within the Cosmos SDK:
  178. [`cosmos/cosmos-sdk/types/multisig`](https://github.com/cosmos/cosmos-sdk/blob/master/crypto/types/multisig/multisignature.go).
  179. #### `merkle` Package
  180. * `SimpleHashFromMap()` and `SimpleProofsFromMap()` were removed.
  181. * The prefix `Simple` has been removed. (For example, `SimpleProof` is now called `Proof`.)
  182. * All protobuf messages have been moved to the `/proto` directory.
  183. * The protobuf message `Proof` that contained multiple ProofOp's has been renamed to `ProofOps`.
  184. As noted above, this affects the ABCI type `ResponseQuery`:
  185. The field that was named Proof is now named `ProofOps`.
  186. * `HashFromByteSlices` and `ProofsFromByteSlices` now return a hash for empty inputs, to conform with
  187. [RFC-6962](https://tools.ietf.org/html/rfc6962).
  188. ### `libs` Package
  189. The `bech32` package has moved to the Cosmos SDK:
  190. [`cosmos/cosmos-sdk/types/bech32`](https://github.com/cosmos/cosmos-sdk/tree/4173ea5ebad906dd9b45325bed69b9c655504867/types/bech32).
  191. ### CLI
  192. The `tendermint lite` command has been renamed to `tendermint light` and has a slightly different API.
  193. See [the docs](https://docs.tendermint.com/master/tendermint-core/light-client-protocol.html#http-proxy) for details.
  194. ### Light Client
  195. We have a new, rewritten light client! You can
  196. [read more](https://medium.com/tendermint/everything-you-need-to-know-about-the-tendermint-light-client-f80d03856f98)
  197. about the justifications and details behind this change.
  198. Other user-relevant changes include:
  199. * The old `lite` package was removed; the new light client uses the `light` package.
  200. * The `Verifier` was broken up into two pieces:
  201. * Core verification logic (pure `VerifyX` functions)
  202. * `Client` object, which represents the complete light client
  203. * The new light clients stores headers & validator sets as `LightBlock`s
  204. * The RPC client can be found in the `/rpc` directory.
  205. * The HTTP(S) proxy is located in the `/proxy` directory.
  206. ### `state` Package
  207. * A new field `State.InitialHeight` has been added to record the initial chain height, which must be `1`
  208. (not `0`) if starting from height `1`. This can be configured via the genesis field `initial_height`.
  209. * The `state` package now has a `Store` interface. All functions in
  210. [state/store.go](https://github.com/tendermint/tendermint/blob/56911ee35298191c95ef1c7d3d5ec508237aaff4/state/store.go#L42-L42)
  211. are now part of the interface. The interface returns errors on all methods and can be used by calling `state.NewStore(dbm.DB)`.
  212. ### `privval` Package
  213. All requests are now accompanied by the chain ID from the network.
  214. This is a optional field and can be ignored by key management systems;
  215. however, if you are using the same key management system for multiple different
  216. blockchains, we recommend that you check the chain ID.
  217. ### RPC
  218. * `/unsafe_start_cpu_profiler`, `/unsafe_stop_cpu_profiler` and
  219. `/unsafe_write_heap_profile` were removed.
  220. For profiling, please use the pprof server, which can
  221. be enabled through `--rpc.pprof_laddr=X` flag or `pprof_laddr=X` config setting
  222. in the rpc section.
  223. * The `Content-Type` header returned on RPC calls is now (correctly) set as `application/json`.
  224. ### Version
  225. Version is now set through Go linker flags `ld_flags`. Applications that are using tendermint as a library should set this at compile time.
  226. Example:
  227. ```sh
  228. go install -mod=readonly -ldflags "-X github.com/tendermint/tendermint/version.TMCoreSemVer=$(go list -m github.com/tendermint/tendermint | sed 's/ /\@/g') -s -w " -trimpath ./cmd
  229. ```
  230. Additionally, the exported constant `version.Version` is now `version.TMCoreSemVer`.
  231. ## v0.33.4
  232. ### Go API
  233. * `rpc/client` HTTP and local clients have been moved into `http` and `local`
  234. subpackages, and their constructors have been renamed to `New()`.
  235. ### Protobuf Changes
  236. When upgrading to version 0.33.4 you will have to fetch the `third_party`
  237. directory along with the updated proto files.
  238. ### Block Retention
  239. ResponseCommit added a field for block retention. The application can provide information to Tendermint on how to prune blocks.
  240. If an application would like to not prune any blocks pass a `0` in this field.
  241. ```proto
  242. message ResponseCommit {
  243. // reserve 1
  244. bytes data = 2; // the Merkle root hash
  245. ++ uint64 retain_height = 3; // the oldest block height to retain ++
  246. }
  247. ```
  248. ## v0.33.0
  249. This release is not compatible with previous blockchains due to commit becoming
  250. signatures only and fields in the header have been removed.
  251. ### Blockchain Protocol
  252. `TotalTxs` and `NumTxs` were removed from the header. `Commit` now consists
  253. mostly of just signatures.
  254. ```go
  255. type Commit struct {
  256. Height int64
  257. Round int
  258. BlockID BlockID
  259. Signatures []CommitSig
  260. }
  261. ```
  262. ```go
  263. type BlockIDFlag byte
  264. const (
  265. // BlockIDFlagAbsent - no vote was received from a validator.
  266. BlockIDFlagAbsent BlockIDFlag = 0x01
  267. // BlockIDFlagCommit - voted for the Commit.BlockID.
  268. BlockIDFlagCommit = 0x02
  269. // BlockIDFlagNil - voted for nil.
  270. BlockIDFlagNil = 0x03
  271. )
  272. type CommitSig struct {
  273. BlockIDFlag BlockIDFlag
  274. ValidatorAddress Address
  275. Timestamp time.Time
  276. Signature []byte
  277. }
  278. ```
  279. See [\#63](https://github.com/tendermint/spec/pull/63) for the complete spec
  280. change.
  281. ### P2P Protocol
  282. The secret connection now includes a transcript hashing. If you want to
  283. implement a handshake (or otherwise have an existing implementation), you'll
  284. need to make the same changes that were made
  285. [here](https://github.com/tendermint/tendermint/pull/3668).
  286. ### Config Changes
  287. You will need to generate a new config if you have used a prior version of tendermint.
  288. Tags have been entirely renamed throughout the codebase to events and there
  289. keys are called
  290. [compositeKeys](https://github.com/tendermint/tendermint/blob/6d05c531f7efef6f0619155cf10ae8557dd7832f/docs/app-dev/indexing-transactions.md).
  291. Evidence Params has been changed to include duration.
  292. * `consensus_params.evidence.max_age_duration`.
  293. * Renamed `consensus_params.evidence.max_age` to `max_age_num_blocks`.
  294. ### Go API
  295. * `libs/common` has been removed in favor of specific pkgs.
  296. * `async`
  297. * `service`
  298. * `rand`
  299. * `net`
  300. * `strings`
  301. * `cmap`
  302. * removal of `errors` pkg
  303. ### RPC Changes
  304. * `/validators` is now paginated (default: 30 vals per page)
  305. * `/block_results` response format updated [see RPC docs for details](https://docs.tendermint.com/master/rpc/#/Info/block_results)
  306. * Event suffix has been removed from the ID in event responses
  307. * IDs are now integers not `json-client-XYZ`
  308. ## v0.32.0
  309. This release is compatible with previous blockchains,
  310. however the new ABCI Events mechanism may create some complexity
  311. for nodes wishing to continue operation with v0.32 from a previous version.
  312. There are some minor breaking changes to the RPC.
  313. ### Config Changes
  314. If you have `db_backend` set to `leveldb` in your config file, please change it
  315. to `goleveldb` or `cleveldb`.
  316. ### RPC Changes
  317. The default listen address for the RPC is now `127.0.0.1`. If you want to expose
  318. it publicly, you have to explicitly configure it. Note exposing the RPC to the
  319. public internet may not be safe - endpoints which return a lot of data may
  320. enable resource exhaustion attacks on your node, causing the process to crash.
  321. Any consumers of `/block_results` need to be mindful of the change in all field
  322. names from CamelCase to Snake case, eg. `results.DeliverTx` is now `results.deliver_tx`.
  323. This is a fix, but it's breaking.
  324. ### ABCI Changes
  325. ABCI responses which previously had a `Tags` field now have an `Events` field
  326. instead. The original `Tags` field was simply a list of key-value pairs, where
  327. each key effectively represented some attribute of an event occuring in the
  328. blockchain, like `sender`, `receiver`, or `amount`. However, it was difficult to
  329. represent the occurence of multiple events (for instance, multiple transfers) in a single list.
  330. The new `Events` field contains a list of `Event`, where each `Event` is itself a list
  331. of key-value pairs, allowing for more natural expression of multiple events in
  332. eg. a single DeliverTx or EndBlock. Note each `Event` also includes a `Type`, which is meant to categorize the
  333. event.
  334. For transaction indexing, the index key is
  335. prefixed with the event type: `{eventType}.{attributeKey}`.
  336. If the same event type and attribute key appear multiple times, the values are
  337. appended in a list.
  338. To make queries, include the event type as a prefix. For instance if you
  339. previously queried for `recipient = 'XYZ'`, and after the upgrade you name your event `transfer`,
  340. the new query would be for `transfer.recipient = 'XYZ'`.
  341. Note that transactions indexed on a node before upgrading to v0.32 will still be indexed
  342. using the old scheme. For instance, if a node upgraded at height 100,
  343. transactions before 100 would be queried with `recipient = 'XYZ'` and
  344. transactions after 100 would be queried with `transfer.recipient = 'XYZ'`.
  345. While this presents additional complexity to clients, it avoids the need to
  346. reindex. Of course, you can reset the node and sync from scratch to re-index
  347. entirely using the new scheme.
  348. We illustrate further with a more complete example.
  349. Prior to the update, suppose your `ResponseDeliverTx` look like:
  350. ```go
  351. abci.ResponseDeliverTx{
  352. Tags: []kv.Pair{
  353. {Key: []byte("sender"), Value: []byte("foo")},
  354. {Key: []byte("recipient"), Value: []byte("bar")},
  355. {Key: []byte("amount"), Value: []byte("35")},
  356. }
  357. }
  358. ```
  359. The following queries would match this transaction:
  360. ```go
  361. query.MustParse("tm.event = 'Tx' AND sender = 'foo'")
  362. query.MustParse("tm.event = 'Tx' AND recipient = 'bar'")
  363. query.MustParse("tm.event = 'Tx' AND sender = 'foo' AND recipient = 'bar'")
  364. ```
  365. Following the upgrade, your `ResponseDeliverTx` would look something like:
  366. the following `Events`:
  367. ```go
  368. abci.ResponseDeliverTx{
  369. Events: []abci.Event{
  370. {
  371. Type: "transfer",
  372. Attributes: kv.Pairs{
  373. {Key: []byte("sender"), Value: []byte("foo")},
  374. {Key: []byte("recipient"), Value: []byte("bar")},
  375. {Key: []byte("amount"), Value: []byte("35")},
  376. },
  377. }
  378. }
  379. ```
  380. Now the following queries would match this transaction:
  381. ```go
  382. query.MustParse("tm.event = 'Tx' AND transfer.sender = 'foo'")
  383. query.MustParse("tm.event = 'Tx' AND transfer.recipient = 'bar'")
  384. query.MustParse("tm.event = 'Tx' AND transfer.sender = 'foo' AND transfer.recipient = 'bar'")
  385. ```
  386. For further documentation on `Events`, see the [docs](https://github.com/tendermint/tendermint/blob/60827f75623b92eff132dc0eff5b49d2025c591e/docs/spec/abci/abci.md#events).
  387. ### Go Applications
  388. The ABCI Application interface changed slightly so the CheckTx and DeliverTx
  389. methods now take Request structs. The contents of these structs are just the raw
  390. tx bytes, which were previously passed in as the argument.
  391. ## v0.31.6
  392. There are no breaking changes in this release except Go API of p2p and
  393. mempool packages. Hovewer, if you're using cleveldb, you'll need to change
  394. the compilation tag:
  395. Use `cleveldb` tag instead of `gcc` to compile Tendermint with CLevelDB or
  396. use `make build_c` / `make install_c` (full instructions can be found at
  397. <https://tendermint.com/docs/introduction/install.html#compile-with-cleveldb-support>)
  398. ## v0.31.0
  399. This release contains a breaking change to the behaviour of the pubsub system.
  400. It also contains some minor breaking changes in the Go API and ABCI.
  401. There are no changes to the block or p2p protocols, so v0.31.0 should work fine
  402. with blockchains created from the v0.30 series.
  403. ### RPC
  404. The pubsub no longer blocks on publishing. This may cause some WebSocket (WS) clients to stop working as expected.
  405. If your WS client is not consuming events fast enough, Tendermint can terminate the subscription.
  406. In this case, the WS client will receive an error with description:
  407. ```json
  408. {
  409. "jsonrpc": "2.0",
  410. "id": "{ID}#event",
  411. "error": {
  412. "code": -32000,
  413. "msg": "Server error",
  414. "data": "subscription was canceled (reason: client is not pulling messages fast enough)" // or "subscription was canceled (reason: Tendermint exited)"
  415. }
  416. }
  417. Additionally, there are now limits on the number of subscribers and
  418. subscriptions that can be active at once. See the new
  419. `rpc.max_subscription_clients` and `rpc.max_subscriptions_per_client` values to
  420. configure this.
  421. ```
  422. ### Applications
  423. Simple rename of `ConsensusParams.BlockSize` to `ConsensusParams.Block`.
  424. The `ConsensusParams.Block.TimeIotaMS` field was also removed. It's configured
  425. in the ConsensusParsm in genesis.
  426. ### Go API
  427. See the [CHANGELOG](CHANGELOG.md). These are relatively straight forward.
  428. ## v0.30.0
  429. This release contains a breaking change to both the block and p2p protocols,
  430. however it may be compatible with blockchains created with v0.29.0 depending on
  431. the chain history. If your blockchain has not included any pieces of evidence,
  432. or no piece of evidence has been included in more than one block,
  433. and if your application has never returned multiple updates
  434. for the same validator in a single block, then v0.30.0 will work fine with
  435. blockchains created with v0.29.0.
  436. The p2p protocol change is to fix the proposer selection algorithm again.
  437. Note that proposer selection is purely a p2p concern right
  438. now since the algorithm is only relevant during real time consensus.
  439. This change is thus compatible with v0.29.0, but
  440. all nodes must be upgraded to avoid disagreements on the proposer.
  441. ### Applications
  442. Applications must ensure they do not return duplicates in
  443. `ResponseEndBlock.ValidatorUpdates`. A pubkey must only appear once per set of
  444. updates. Duplicates will cause irrecoverable failure. If you have a very good
  445. reason why we shouldn't do this, please open an issue.
  446. ## v0.29.0
  447. This release contains some breaking changes to the block and p2p protocols,
  448. and will not be compatible with any previous versions of the software, primarily
  449. due to changes in how various data structures are hashed.
  450. Any implementations of Tendermint blockchain verification, including lite clients,
  451. will need to be updated. For specific details:
  452. * [Merkle tree](https://github.com/tendermint/spec/blob/master/spec/blockchain/encoding.md#merkle-trees)
  453. * [ConsensusParams](https://github.com/tendermint/spec/blob/master/spec/blockchain/state.md#consensusparams)
  454. There was also a small change to field ordering in the vote struct. Any
  455. implementations of an out-of-process validator (like a Key-Management Server)
  456. will need to be updated. For specific details:
  457. * [Vote](https://github.com/tendermint/spec/blob/master/spec/consensus/signing.md#votes)
  458. Finally, the proposer selection algorithm continues to evolve. See the
  459. [work-in-progress
  460. specification](https://github.com/tendermint/tendermint/pull/3140).
  461. For everything else, please see the [CHANGELOG](./CHANGELOG.md#v0.29.0).
  462. ## v0.28.0
  463. This release breaks the format for the `priv_validator.json` file
  464. and the protocol used for the external validator process.
  465. It is compatible with v0.27.0 blockchains (neither the BlockProtocol nor the
  466. P2PProtocol have changed).
  467. Please read carefully for details about upgrading.
  468. **Note:** Backup your `config/priv_validator.json`
  469. before proceeding.
  470. ### `priv_validator.json`
  471. The `config/priv_validator.json` is now two files:
  472. `config/priv_validator_key.json` and `data/priv_validator_state.json`.
  473. The former contains the key material, the later contains the details on the last
  474. message signed.
  475. When running v0.28.0 for the first time, it will back up any pre-existing
  476. `priv_validator.json` file and proceed to split it into the two new files.
  477. Upgrading should happen automatically without problem.
  478. To upgrade manually, use the provided `privValUpgrade.go` script, with exact paths for the old
  479. `priv_validator.json` and the locations for the two new files. It's recomended
  480. to use the default paths, of `config/priv_validator_key.json` and
  481. `data/priv_validator_state.json`, respectively:
  482. ```sh
  483. go run scripts/privValUpgrade.go <old-path> <new-key-path> <new-state-path>
  484. ```
  485. ### External validator signers
  486. The Unix and TCP implementations of the remote signing validator
  487. have been consolidated into a single implementation.
  488. Thus in both cases, the external process is expected to dial
  489. Tendermint. This is different from how Unix sockets used to work, where
  490. Tendermint dialed the external process.
  491. The `PubKeyMsg` was also split into separate `Request` and `Response` types
  492. for consistency with other messages.
  493. Note that the TCP sockets don't yet use a persistent key,
  494. so while they're encrypted, they can't yet be properly authenticated.
  495. See [#3105](https://github.com/tendermint/tendermint/issues/3105).
  496. Note the Unix socket has neither encryption nor authentication, but will
  497. add a shared-secret in [#3099](https://github.com/tendermint/tendermint/issues/3099).
  498. ## v0.27.0
  499. This release contains some breaking changes to the block and p2p protocols,
  500. but does not change any core data structures, so it should be compatible with
  501. existing blockchains from the v0.26 series that only used Ed25519 validator keys.
  502. Blockchains using Secp256k1 for validators will not be compatible. This is due
  503. to the fact that we now enforce which key types validators can use as a
  504. consensus param. The default is Ed25519, and Secp256k1 must be activated
  505. explicitly.
  506. It is recommended to upgrade all nodes at once to avoid incompatibilities at the
  507. peer layer - namely, the heartbeat consensus message has been removed (only
  508. relevant if `create_empty_blocks=false` or `create_empty_blocks_interval > 0`),
  509. and the proposer selection algorithm has changed. Since proposer information is
  510. never included in the blockchain, this change only affects the peer layer.
  511. ### Go API Changes
  512. #### libs/db
  513. The ReverseIterator API has changed the meaning of `start` and `end`.
  514. Before, iteration was from `start` to `end`, where
  515. `start > end`. Now, iteration is from `end` to `start`, where `start < end`.
  516. The iterator also excludes `end`. This change allows a simplified and more
  517. intuitive logic, aligning the semantic meaning of `start` and `end` in the
  518. `Iterator` and `ReverseIterator`.
  519. ### Applications
  520. This release enforces a new consensus parameter, the
  521. ValidatorParams.PubKeyTypes. Applications must ensure that they only return
  522. validator updates with the allowed PubKeyTypes. If a validator update includes a
  523. pubkey type that is not included in the ConsensusParams.Validator.PubKeyTypes,
  524. block execution will fail and the consensus will halt.
  525. By default, only Ed25519 pubkeys may be used for validators. Enabling
  526. Secp256k1 requires explicit modification of the ConsensusParams.
  527. Please update your application accordingly (ie. restrict validators to only be
  528. able to use Ed25519 keys, or explicitly add additional key types to the genesis
  529. file).
  530. ## v0.26.0
  531. This release contains a lot of changes to core data types and protocols. It is not
  532. compatible to the old versions and there is no straight forward way to update
  533. old data to be compatible with the new version.
  534. To reset the state do:
  535. ```sh
  536. tendermint unsafe_reset_all
  537. ```
  538. Here we summarize some other notable changes to be mindful of.
  539. ### Config Changes
  540. All timeouts must be changed from integers to strings with their duration, for
  541. instance `flush_throttle_timeout = 100` would be changed to
  542. `flush_throttle_timeout = "100ms"` and `timeout_propose = 3000` would be changed
  543. to `timeout_propose = "3s"`.
  544. ### RPC Changes
  545. The default behaviour of `/abci_query` has been changed to not return a proof,
  546. and the name of the parameter that controls this has been changed from `trusted`
  547. to `prove`. To get proofs with your queries, ensure you set `prove=true`.
  548. Various version fields like `amino_version`, `p2p_version`, `consensus_version`,
  549. and `rpc_version` have been removed from the `node_info.other` and are
  550. consolidated under the tendermint semantic version (ie. `node_info.version`) and
  551. the new `block` and `p2p` protocol versions under `node_info.protocol_version`.
  552. ### ABCI Changes
  553. Field numbers were bumped in the `Header` and `ResponseInfo` messages to make
  554. room for new `version` fields. It should be straight forward to recompile the
  555. protobuf file for these changes.
  556. #### Proofs
  557. The `ResponseQuery.Proof` field is now structured as a `[]ProofOp` to support
  558. generalized Merkle tree constructions where the leaves of one Merkle tree are
  559. the root of another. If you don't need this functionality, and you used to
  560. return `<proof bytes>` here, you should instead return a single `ProofOp` with
  561. just the `Data` field set:
  562. ```go
  563. []ProofOp{
  564. ProofOp{
  565. Data: <proof bytes>,
  566. }
  567. }
  568. ```
  569. For more information, see:
  570. * [ADR-026](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/docs/architecture/adr-026-general-merkle-proof.md)
  571. * [Relevant ABCI
  572. documentation](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/docs/spec/abci/apps.md#query-proofs)
  573. * [Description of
  574. keys](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/crypto/merkle/proof_key_path.go#L14)
  575. ### Go API Changes
  576. #### crypto/merkle
  577. The `merkle.Hasher` interface was removed. Functions which used to take `Hasher`
  578. now simply take `[]byte`. This means that any objects being Merklized should be
  579. serialized before they are passed in.
  580. #### node
  581. The `node.RunForever` function was removed. Signal handling and running forever
  582. should instead be explicitly configured by the caller. See how we do it
  583. [here](https://github.com/tendermint/tendermint/blob/30519e8361c19f4bf320ef4d26288ebc621ad725/cmd/tendermint/commands/run_node.go#L60).
  584. ### Other
  585. All hashes, except for public key addresses, are now 32-bytes.
  586. ## v0.25.0
  587. This release has minimal impact.
  588. If you use GasWanted in ABCI and want to enforce it, set the MaxGas in the genesis file (default is no max).
  589. ## v0.24.0
  590. New 0.24.0 release contains a lot of changes to the state and types. It's not
  591. compatible to the old versions and there is no straight forward way to update
  592. old data to be compatible with the new version.
  593. To reset the state do:
  594. ```sh
  595. tendermint unsafe_reset_all
  596. ```
  597. Here we summarize some other notable changes to be mindful of.
  598. ### Config changes
  599. `p2p.max_num_peers` was removed in favor of `p2p.max_num_inbound_peers` and
  600. `p2p.max_num_outbound_peers`.
  601. ```toml
  602. # Maximum number of inbound peers
  603. max_num_inbound_peers = 40
  604. # Maximum number of outbound peers to connect to, excluding persistent peers
  605. max_num_outbound_peers = 10
  606. ```
  607. As you can see, the default ratio of inbound/outbound peers is 4/1. The reason
  608. is we want it to be easier for new nodes to connect to the network. You can
  609. tweak these parameters to alter the network topology.
  610. ### RPC Changes
  611. The result of `/commit` used to contain `header` and `commit` fields at the top level. These are now contained under the `signed_header` field.
  612. ### ABCI Changes
  613. The header has been upgraded and contains new fields, but none of the existing
  614. fields were changed, except their order.
  615. The `Validator` type was split into two, one containing an `Address` and one
  616. containing a `PubKey`. When processing `RequestBeginBlock`, use the `Validator`
  617. type, which contains just the `Address`. When returning `ResponseEndBlock`, use
  618. the `ValidatorUpdate` type, which contains just the `PubKey`.
  619. ### Validator Set Updates
  620. Validator set updates returned in ResponseEndBlock for height `H` used to take
  621. effect immediately at height `H+1`. Now they will be delayed one block, to take
  622. effect at height `H+2`. Note this means that the change will be seen by the ABCI
  623. app in the `RequestBeginBlock.LastCommitInfo` at block `H+3`. Apps were already
  624. required to maintain a map from validator addresses to pubkeys since v0.23 (when
  625. pubkeys were removed from RequestBeginBlock), but now they may need to track
  626. multiple validator sets at once to accomodate this delay.
  627. ### Block Size
  628. The `ConsensusParams.BlockSize.MaxTxs` was removed in favour of
  629. `ConsensusParams.BlockSize.MaxBytes`, which is now enforced. This means blocks
  630. are limitted only by byte-size, not by number of transactions.