Skip to content

Commit

Permalink
Release v0.22.0 (informalsystems#987)
Browse files Browse the repository at this point in the history
* Fix changelog entry naming

Signed-off-by: Thane Thomson <[email protected]>

* Clean up and format changelog entries

Signed-off-by: Thane Thomson <[email protected]>

* Build changelog for v0.22.0 release

Signed-off-by: Thane Thomson <[email protected]>

* Add date to release in changelog

Signed-off-by: Thane Thomson <[email protected]>

* Bump version to v0.22.0

Signed-off-by: Thane Thomson <[email protected]>

* Clarify wording in v0.22.0 release summary in changelog

Signed-off-by: Thane Thomson <[email protected]>
  • Loading branch information
thanethomson authored Sep 23, 2021
1 parent dd37137 commit 979b7b5
Show file tree
Hide file tree
Showing 37 changed files with 151 additions and 42 deletions.

This file was deleted.

1 change: 0 additions & 1 deletion .changelog/unreleased/features/939-secp256k1-signatures.md

This file was deleted.

This file was deleted.

2 changes: 0 additions & 2 deletions .changelog/unreleased/improvements/ws-config.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- `[tendermint_light_client]` The light client verification functionality has
- `[tendermint-light-client]` The light client verification functionality has
been refactored (including breaking changes to the API) such that it can be
more easily used from both `tendermint_light_client` and `ibc-rs`
([#956](https://github.com/informalsystems/tendermint-rs/issues/956))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[tendermint-light-client]` Disable the `lightstore-sled` feature by default
([#976](https://github.com/informalsystems/tendermint-rs/issues/976))
2 changes: 2 additions & 0 deletions .changelog/v0.22.0/features/939-secp256k1-signatures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[tendermint, tendermint-light-client]` Add support for Secp256k1 signatures
([#939](https://github.com/informalsystems/tendermint-rs/issues/939))
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- `[tendermint-light-client]` Model-based tests are now disabled
by default and can be enabled through the `mbt` feature
- `[tendermint-light-client]` Model-based tests are now disabled by default and
can be enabled through the `mbt` feature
([#968](https://github.com/informalsystems/tendermint-rs/issues/968))
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- `[tendermint, tendermint-rpc]` Derive `Eq` on `SignedHeader` and `Commit`
([#969](https://github.com/informalsystems/tendermint-rs/issues/969))
3 changes: 3 additions & 0 deletions .changelog/v0.22.0/improvements/974-ws-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- `[tendermint-light-client]` Add `WebSocketClient::new_with_config` to specify
the WebSocket connection settings
([#974](https://github.com/informalsystems/tendermint-rs/issues/974))
22 changes: 22 additions & 0 deletions .changelog/v0.22.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
*Sep 23, 2021*

This release targets numerous issues largely in support of
[ibc-rs](https://github.com/informalsystems/ibc-rs). The major breaking change
in this regard is in the
[API](https://github.com/informalsystems/tendermint-rs/blob/dd371372da58921efe1b48a4dd24a2597225df11/light-client/src/components/verifier.rs#L143)
we use to perform verification in the `tendermint-light-client` crate.

Toward `no_std` compatibility and flexibility in the way we handle error tracing
and reporting, we have also refactored the entire error handling system in
`tendermint-rs` to make use of
[flex-error](https://github.com/informalsystems/flex-error).

Finally, we are also (painfully) aware of the fact that our documentation does
not build for this release and apologize for this. We currently still depend on
Prost v0.7.0 and are awaiting a new release of Prost after v0.8.0 that does not
break our builds. We have
[\#978](https://github.com/informalsystems/tendermint-rs/pull/978) open in
preparation for this upgrade and will release a new version of `tendermint-rs`
as soon as a new Prost release is available.

See below for more specific detail as to what has changed in this release.
83 changes: 83 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,87 @@
# CHANGELOG

## v0.22.0

*Sep 23, 2021*

This release targets numerous issues largely in support of
[ibc-rs](https://github.com/informalsystems/ibc-rs). The major breaking change
in this regard is in the
[API](https://github.com/informalsystems/tendermint-rs/blob/dd371372da58921efe1b48a4dd24a2597225df11/light-client/src/components/verifier.rs#L143)
we use to perform verification in the `tendermint-light-client` crate.

Toward `no_std` compatibility and flexibility in the way we handle error tracing
and reporting, we have also refactored the entire error handling system in
`tendermint-rs` to make use of
[flex-error](https://github.com/informalsystems/flex-error).

Finally, we are also (painfully) aware of the fact that our documentation does
not build for this release and apologize for this. We currently still depend on
Prost v0.7.0 and are awaiting a new release of Prost after v0.8.0 that does not
break our builds. We have
[\#978](https://github.com/informalsystems/tendermint-rs/pull/978) open in
preparation for this upgrade and will release a new version of `tendermint-rs`
as soon as a new Prost release is available.

See below for more specific detail as to what has changed in this release.

### BREAKING CHANGES

- All crates' error handling has been refactored to make use of
[`flex-error`](https://github.com/informalsystems/flex-error/). This gives
users greater flexibility in terms of the error handling/reporting systems
they want to use and is a critical step towards `no_std` support.
([#923](https://github.com/informalsystems/tendermint-rs/pull/923))
- `[tendermint-rpc]` The `/tx` endpoint's `Request::hash` field has been changed
from `String` to `tendermint::abci::transaction::Hash`
([#942](https://github.com/informalsystems/tendermint-rs/issues/942))
- `[tendermint-light-client]` The light client verification functionality has
been refactored (including breaking changes to the API) such that it can be
more easily used from both `tendermint_light_client` and `ibc-rs`
([#956](https://github.com/informalsystems/tendermint-rs/issues/956))
- `[tendermint-light-client]` Disable the `lightstore-sled` feature by default
([#976](https://github.com/informalsystems/tendermint-rs/issues/976))

### BUG FIXES

- `[tendermint-rpc]` The encoding of the `hash` field for requests to the `/tx`
endpoint has been changed to base64 (from hex) to accommodate discrepancies in
how the Tendermint RPC encodes this field for different RPC interfaces
([#942](https://github.com/informalsystems/tendermint-rs/issues/942))

### FEATURES

- `[tendermint-rpc]` Add support for the `/consensus_params` RPC endpoint. See
<https://docs.tendermint.com/master/rpc/\#/Info/consensus_params> for details
([#832](https://github.com/informalsystems/tendermint-rs/issues/832))
- `[tendermint-rpc]` Runtime query parsing (relevant to the `/subscribe` and
`/tx_search` endpoints) has been reintroduced. This allows for client-side
validation of queries prior to submitting them to a remote Tendermint node. An
example of how to use this is available in the `tendermint-rpc` CLI (see [the
README](https://github.com/informalsystems/tendermint-rs/tree/master/rpc#cli)
for details).
([#859](https://github.com/informalsystems/tendermint-rs/issues/859))
- `[tendermint, tendermint-light-client]` Add support for Secp256k1 signatures
([#939](https://github.com/informalsystems/tendermint-rs/issues/939))

### IMPROVEMENTS

- `[tendermint-p2p]` The `SecretConnection` can now be split into two halves to
facilitate full-duplex communication (must be facilitated by using each half
in a separate thread).
([#938](https://github.com/informalsystems/tendermint-rs/pull/938))
- `[tendermint-light-client]` Model-based tests are now disabled by default and
can be enabled through the `mbt` feature
([#968](https://github.com/informalsystems/tendermint-rs/issues/968))
- `[tendermint, tendermint-rpc]` Derive `Eq` on `SignedHeader` and `Commit`
([#969](https://github.com/informalsystems/tendermint-rs/issues/969))
- `[tendermint-light-client]` Add `WebSocketClient::new_with_config` to specify
the WebSocket connection settings
([#974](https://github.com/informalsystems/tendermint-rs/issues/974))
- `[tendermint-p2p]` Amino support is now implemented using the upstream
`prost` crate, eliminating a dependency on `prost-amino`
([#979](https://github.com/informalsystems/tendermint-rs/pull/979))

## v0.21.0

*Jul 20, 2021*
Expand Down Expand Up @@ -863,3 +945,4 @@ https://github.com/interchainio/tendermint-rs/commit/566dfb6a9ef9659a504b43fb8cc
[#90]: https://github.com/interchainio/tendermint-rs/pull/90
[#83]: https://github.com/interchainio/tendermint-rs/pull/83
[#91]: https://github.com/interchainio/tendermint-rs/pull/91

4 changes: 2 additions & 2 deletions abci/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-abci"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
license = "Apache-2.0"
Expand Down Expand Up @@ -34,7 +34,7 @@ std = [
[dependencies]
bytes = "1.0"
prost = "0.7"
tendermint-proto = { version = "0.21.0", path = "../proto" }
tendermint-proto = { version = "0.22.0", path = "../proto" }
tracing = "0.1"
flex-error = { version = "0.4.1", default-features = false }

Expand Down
6 changes: 3 additions & 3 deletions light-client-js/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-light-client-js"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
license = "Apache-2.0"
Expand All @@ -24,8 +24,8 @@ serde = { version = "1.0", features = [ "derive" ] }
serde_json = "1.0"
# TODO(thane): Remove once https://github.com/rustwasm/wasm-bindgen/issues/2508 is resolved
syn = "=1.0.65"
tendermint = { version = "0.21.0", path = "../tendermint" }
tendermint-light-client = { version = "0.21.0", path = "../light-client", default-features = false }
tendermint = { version = "0.22.0", path = "../tendermint" }
tendermint-light-client = { version = "0.22.0", path = "../light-client", default-features = false }
wasm-bindgen = { version = "0.2.63", features = [ "serde-serialize" ] }

# The `console_error_panic_hook` crate provides better debugging of panics by
Expand Down
6 changes: 3 additions & 3 deletions light-client/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-light-client"
version = "0.21.0"
version = "0.22.0"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
Expand Down Expand Up @@ -41,8 +41,8 @@ std = [
mbt = []

[dependencies]
tendermint = { version = "0.21.0", path = "../tendermint" }
tendermint-rpc = { version = "0.21.0", path = "../rpc", default-features = false }
tendermint = { version = "0.22.0", path = "../tendermint" }
tendermint-rpc = { version = "0.22.0", path = "../rpc", default-features = false }

contracts = "0.4.0"
crossbeam-channel = "0.4.2"
Expand Down
2 changes: 1 addition & 1 deletion light-client/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
nonstandard_style
)]
#![doc(
html_root_url = "https://docs.rs/tendermint-light-client/0.21.0",
html_root_url = "https://docs.rs/tendermint-light-client/0.22.0",
html_logo_url = "https://raw.githubusercontent.com/informalsystems/tendermint-rs/master/img/logo-tendermint-rs_3961x4001.png"
)]
#![cfg_attr(docsrs, feature(doc_cfg))]
Expand Down
8 changes: 4 additions & 4 deletions p2p/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-p2p"
version = "0.21.0"
version = "0.22.0"
edition = "2018"
license = "Apache-2.0"
repository = "https://github.com/informalsystems/tendermint-rs"
Expand Down Expand Up @@ -48,9 +48,9 @@ aead = "0.4.1"
flex-error = { version = "0.4.1", default-features = false }

# path dependencies
tendermint = { path = "../tendermint", version = "0.21.0" }
tendermint-proto = { path = "../proto", version = "0.21.0" }
tendermint-std-ext = { path = "../std-ext", version = "0.21.0" }
tendermint = { path = "../tendermint", version = "0.22.0" }
tendermint-proto = { path = "../proto", version = "0.22.0" }
tendermint-std-ext = { path = "../std-ext", version = "0.22.0" }

# optional dependencies
prost-derive = { version = "0.7", optional = true }
2 changes: 1 addition & 1 deletion p2p/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
unused_qualifications
)]
#![doc(
html_root_url = "https://docs.rs/tendermint-p2p/0.21.0",
html_root_url = "https://docs.rs/tendermint-p2p/0.22.0",
html_logo_url = "https://raw.githubusercontent.com/informalsystems/tendermint-rs/master/img/logo-tendermint-rs_3961x4001.png"
)]

Expand Down
2 changes: 1 addition & 1 deletion pbt-gen/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-pbt-gen"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion proto/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-proto"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion proto/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#![deny(warnings, trivial_casts, trivial_numeric_casts, unused_import_braces)]
#![allow(clippy::large_enum_variant)]
#![forbid(unsafe_code)]
#![doc(html_root_url = "https://docs.rs/tendermint-proto/0.21.0")]
#![doc(html_root_url = "https://docs.rs/tendermint-proto/0.22.0")]

/// Built-in prost_types with slight customization to enable JSON-encoding
#[allow(warnings)]
Expand Down
6 changes: 3 additions & 3 deletions rpc/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-rpc"
version = "0.21.0"
version = "0.22.0"
edition = "2018"
license = "Apache-2.0"
homepage = "https://www.tendermint.com/"
Expand Down Expand Up @@ -73,8 +73,8 @@ pin-project = "1.0.1"
serde = { version = "1", features = [ "derive" ] }
serde_bytes = "0.11"
serde_json = "1"
tendermint = { version = "0.21.0", path = "../tendermint" }
tendermint-proto = { version = "0.21.0", path = "../proto" }
tendermint = { version = "0.22.0", path = "../tendermint" }
tendermint-proto = { version = "0.22.0", path = "../proto" }
thiserror = "1"
uuid = { version = "0.8", default-features = false }
subtle-encoding = { version = "0.5", features = ["bech32-preview"] }
Expand Down
2 changes: 1 addition & 1 deletion std-ext/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-std-ext"
version = "0.21.0"
version = "0.22.0"
edition = "2018"
license = "Apache-2.0"
homepage = "https://www.tendermint.com/"
Expand Down
4 changes: 2 additions & 2 deletions tendermint/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint"
version = "0.21.0" # Also update `html_root_url` in lib.rs and
version = "0.22.0" # Also update `html_root_url` in lib.rs and
# depending crates (rpc, light-node, ..) when bumping this
license = "Apache-2.0"
homepage = "https://www.tendermint.com/"
Expand Down Expand Up @@ -51,7 +51,7 @@ sha2 = { version = "0.9", default-features = false }
signature = "1.2"
subtle = "2"
subtle-encoding = { version = "0.5", features = ["bech32-preview"] }
tendermint-proto = { version = "0.21.0", path = "../proto" }
tendermint-proto = { version = "0.22.0", path = "../proto" }
toml = { version = "0.5" }
url = { version = "2.2" }
zeroize = { version = "1.1", features = ["zeroize_derive"] }
Expand Down
2 changes: 1 addition & 1 deletion tendermint/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
)]
#![forbid(unsafe_code)]
#![doc(
html_root_url = "https://docs.rs/tendermint/0.21.0",
html_root_url = "https://docs.rs/tendermint/0.22.0",
html_logo_url = "https://raw.githubusercontent.com/informalsystems/tendermint-rs/master/img/logo-tendermint-rs_3961x4001.png"
)]

Expand Down
2 changes: 1 addition & 1 deletion test/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "tendermint-test"
description = "Tendermint workspace tests and common utilities for testing."
version = "0.21.0"
version = "0.22.0"
edition = "2018"
license = "Apache-2.0"
categories = ["development", "test", "tools"]
Expand Down
4 changes: 2 additions & 2 deletions testgen/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-testgen"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
readme = "README.md"
Expand All @@ -16,7 +16,7 @@ description = """
"""

[dependencies]
tendermint = { version = "0.21.0", path = "../tendermint" }
tendermint = { version = "0.22.0", path = "../tendermint" }
serde = { version = "1", features = ["derive"] }
serde_json = "1"
ed25519-dalek = "1"
Expand Down
6 changes: 3 additions & 3 deletions tools/abci-test/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "abci-test"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
description = """
Expand All @@ -13,8 +13,8 @@ description = """
[dependencies]
futures = "0.3"
structopt = "0.3"
tendermint = { version = "0.21.0", path = "../../tendermint" }
tendermint-rpc = { version = "0.21.0", path = "../../rpc", features = [ "websocket-client" ] }
tendermint = { version = "0.22.0", path = "../../tendermint" }
tendermint-rpc = { version = "0.22.0", path = "../../rpc", features = [ "websocket-client" ] }
tracing = "0.1"
tracing-subscriber = "0.2"
tokio = { version = "1", features = ["full"] }
6 changes: 3 additions & 3 deletions tools/kvstore-test/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ edition = "2018"

[dev-dependencies]
futures = "0.3"
tendermint = { version = "0.21.0", path = "../../tendermint" }
tendermint-light-client = { version = "0.21.0", path = "../../light-client", features = ["unstable"] }
tendermint-rpc = { version = "0.21.0", path = "../../rpc", features = [ "http-client", "websocket-client" ] }
tendermint = { version = "0.22.0", path = "../../tendermint" }
tendermint-light-client = { version = "0.22.0", path = "../../light-client", features = ["unstable"] }
tendermint-rpc = { version = "0.22.0", path = "../../rpc", features = [ "http-client", "websocket-client" ] }
tokio = { version = "1.0", features = [ "rt-multi-thread", "macros" ] }
tracing = "0.1"
tracing-subscriber = "0.2"
Expand Down
2 changes: 1 addition & 1 deletion tools/rpc-probe/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tendermint-rpc-probe"
version = "0.21.0"
version = "0.22.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2018"
license = "Apache-2.0"
Expand Down

0 comments on commit 979b7b5

Please sign in to comment.