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.

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