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.

746 lines
29 KiB

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