Release v0.17.0-rc2 (#668)

* Update CHANGELOG for v0.17.0-rc2 release Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add note to wait until v0.17.0-rc3 to upgrade Signed-off-by: Thane Thomson <connect@thanethomson.com> * Bump versions to v0.17.0-rc2 Signed-off-by: Thane Thomson <connect@thanethomson.com> * Fix docs to avoid recurring line wrap problem Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add explicit dependency version for proto from rpc crate Signed-off-by: Thane Thomson <connect@thanethomson.com>
informalsystems · Nov 11, 2020 · 0ad5f50 · 0ad5f50
1 parent 7ab136c
commit 0ad5f50
Show file tree

Hide file tree

Showing 13 changed files with 60 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,26 @@
-## Unreleased
+## v0.17.0-rc2
+
+*Nov 11, 2020*
+
+The primary focal points for this release are supporting [ibc-rs] and 
+increasing compatibility with
+[Tendermint v0.34.0](https://github.com/tendermint/tendermint/blob/master/UPGRADING.md#v0340).
+
+We are also progressively refactoring the codebase to facilitate a clearer 
+separation between our domain types (where we want to ensure correctness of the
+data structures) and our serialization types. See [#654] for the ongoing work
+on this front.
+
+**NB**: more breaking changes are anticipated for the v0.17.0-rc3 release in
+terms of our data structures and serialization approach. We would generally
+recommend waiting until v0.17.0-rc3 to upgrade.
 
 ### BREAKING CHANGES:
 
-- `[tendermint]` - Direct serialization capabilities have been removed from the
+- `[tendermint]` Direct serialization capabilities have been removed from the
   domain types. They are temporarily available in the `protos` crate. **NB:
   this is unstable and is planned to change again in v0.17.0-rc3**. ([#639])
-- `[tendermint]` - Work has started on making it compulsory to construct domain
+- `[tendermint]` Work has started on making it compulsory to construct domain
   types by way of their constructors to ensure validity. This work is scheduled
   for completion in v0.17.0-rc3. ([#639])
 
@@ -28,9 +43,11 @@
 [#650]: https://github.com/informalsystems/tendermint-rs/issues/650
 [#652]: https://github.com/informalsystems/tendermint-rs/pulls/652
 [#639]: https://github.com/informalsystems/tendermint-rs/pull/639
+[#654]: https://github.com/informalsystems/tendermint-rs/issues/654
 [#660]: https://github.com/informalsystems/tendermint-rs/issues/660
 [#663]: https://github.com/informalsystems/tendermint-rs/issues/663
 [#665]: https://github.com/informalsystems/tendermint-rs/issues/665
+[ibc-rs]: https://github.com/informalsystems/ibc-rs/
 
 ## v0.17.0-rc1
 

diff --git a/light-client/Cargo.toml b/light-client/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name       = "tendermint-light-client"
-version    = "0.17.0-rc1"
+version    = "0.17.0-rc2"
 edition    = "2018"
 license    = "Apache-2.0"
 readme     = "README.md"
@@ -27,8 +27,8 @@ rpc-client = ["tendermint-rpc/http-client"]
 secp256k1 = ["tendermint/secp256k1", "tendermint-rpc/secp256k1"]
 
 [dependencies]
-tendermint = { version = "0.17.0-rc1", path = "../tendermint" }
-tendermint-rpc = { version = "0.17.0-rc1", path = "../rpc", default-features = false }
+tendermint = { version = "0.17.0-rc2", path = "../tendermint" }
+tendermint-rpc = { version = "0.17.0-rc2", path = "../rpc", default-features = false }
 
 anomaly = { version = "0.2.0", features = ["serializer"] }
 contracts = "0.4.0"

diff --git a/light-client/src/lib.rs b/light-client/src/lib.rs
@@ -10,7 +10,7 @@
     nonstandard_style
 )]
 #![doc(
-    html_root_url = "https://docs.rs/tendermint-light-client/0.17.0-rc1",
+    html_root_url = "https://docs.rs/tendermint-light-client/0.17.0-rc2",
     html_logo_url = "https://raw.githubusercontent.com/informalsystems/tendermint-rs/master/img/logo-tendermint-rs_3961x4001.png"
 )]
 

diff --git a/light-node/Cargo.toml b/light-node/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name       = "tendermint-light-node"
-version    = "0.17.0-rc1"
+version    = "0.17.0-rc2"
 edition    = "2018"
 license    = "Apache-2.0"
 repository = "https://github.com/informalsystems/tendermint-rs"
@@ -38,9 +38,9 @@ jsonrpc-derive = "14.2"
 serde = { version = "1", features = ["serde_derive"] }
 serde_json = "1.0"
 sled = "0.34.3"
-tendermint = { version = "0.17.0-rc1", path = "../tendermint" }
-tendermint-light-client = { version = "0.17.0-rc1", path = "../light-client" }
-tendermint-rpc = { version = "0.17.0-rc1", path = "../rpc", features = [ "http-client" ] }
+tendermint = { version = "0.17.0-rc2", path = "../tendermint" }
+tendermint-light-client = { version = "0.17.0-rc2", path = "../light-client" }
+tendermint-rpc = { version = "0.17.0-rc2", path = "../rpc", features = [ "http-client" ] }
 thiserror = "1.0"
 tokio = { version = "0.2", features = ["full"] }
 

diff --git a/light-node/src/lib.rs b/light-node/src/lib.rs
@@ -15,7 +15,7 @@
     unused_qualifications
 )]
 #![doc(
-    html_root_url = "https://docs.rs/tendermint-light-node/0.17.0-rc1",
+    html_root_url = "https://docs.rs/tendermint-light-node/0.17.0-rc2",
     html_logo_url = "https://raw.githubusercontent.com/informalsystems/tendermint-rs/master/img/logo-tendermint-rs_3961x4001.png"
 )]
 

diff --git a/proto/Cargo.toml b/proto/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tendermint-proto"
-version = "0.17.0-rc1"
+version = "0.17.0-rc2"
 authors = ["Greg Szabo <greg@informal.systems>"]
 edition = "2018"
 license = "Apache-2.0"

diff --git a/proto/src/lib.rs b/proto/src/lib.rs
@@ -5,7 +5,7 @@
 
 #![deny(warnings, trivial_casts, trivial_numeric_casts, unused_import_braces)]
 #![forbid(unsafe_code)]
-#![doc(html_root_url = "https://docs.rs/tendermint-proto/0.17.0-rc1")]
+#![doc(html_root_url = "https://docs.rs/tendermint-proto/0.17.0-rc2")]
 
 // Built-in prost_types with slight customization to enable JSON-encoding
 pub mod google {

diff --git a/rpc/Cargo.toml b/rpc/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name       = "tendermint-rpc"
-version    = "0.17.0-rc1"
+version    = "0.17.0-rc2"
 edition    = "2018"
 license    = "Apache-2.0"
 homepage   = "https://www.tendermint.com/"
@@ -46,8 +46,8 @@ getrandom = "0.1"
 serde = { version = "1", features = [ "derive" ] }
 serde_bytes = "0.11"
 serde_json = "1"
-tendermint = { version = "0.17.0-rc1", path = "../tendermint" }
-tendermint-proto = { path = "../proto" }
+tendermint = { version = "0.17.0-rc2", path = "../tendermint" }
+tendermint-proto = { version = "0.17.0-rc2", path = "../proto" }
 thiserror = "1"
 uuid = { version = "0.8", default-features = false }
 subtle-encoding = { version = "0.5", features = ["bech32-preview"] }

diff --git a/rpc/README.md b/rpc/README.md
@@ -21,12 +21,17 @@ This crate optionally provides access to different types of RPC client
 functionality and different client transports based on which features you
 select when using it.
 
-Two features are provided at present.
-
-| Feature | Description |
-| ------- | ----------- |
-| `http-client` | Provides `HttpClient`, which is a basic RPC client that interacts with remote Tendermint nodes via **JSON-RPC over HTTP**. This client does not provide `Event` subscription functionality. See the [Tendermint RPC] for more details. |
-| `websocket-client` | Provides `WebSocketClient`, which currently only provides `Event` subscription functionality over a WebSocket connection. See the [`/subscribe` endpoint] in the Tendermint RPC for more details. This client does not yet provide access to the RPC methods provided by the `Client` trait (this is planned for a future release). |
+Two features are provided at present:
+
+* `http-client` - Provides `HttpClient`, which is a basic RPC client that
+  interacts with remote Tendermint nodes via **JSON-RPC over HTTP**. This
+  client does not provide `Event` subscription functionality. See the 
+  [Tendermint RPC] for more details.
+* `websocket-client` - Provides `WebSocketClient`, which currently only 
+  provides `Event` subscription functionality over a WebSocket connection. See
+  the [`/subscribe` endpoint] in the Tendermint RPC for more details. This 
+  client does not yet provide access to the RPC methods provided by the
+  `Client` trait (this is planned for a future release).
 
 ### Mock Clients
 

diff --git a/rpc/src/lib.rs b/rpc/src/lib.rs
@@ -6,17 +6,17 @@
 //! functionality and different client transports based on which features you
 //! select when using it.
 //!
-//! Two features are provided at present.
+//! Two features are provided at present:
 //!
-//! | Feature | Description |
-//! | ------- | ----------- |
-//! | `http-client` | Provides [`HttpClient`], which is a basic RPC client that interacts with
-//! remote Tendermint nodes via **JSON-RPC over HTTP**. This client does not provide [`Event`]
-//! subscription functionality. See the [Tendermint RPC] for more details. | | `websocket-client` |
-//! Provides [`WebSocketClient`], which currently only provides [`Event`] subscription functionality
-//! over a WebSocket connection. See the [`/subscribe` endpoint] in the Tendermint RPC for more
-//! details. This client does not yet provide access to the RPC methods provided by the [`Client`]
-//! trait (this is planned for a future release). |
+//! * `http-client` - Provides [`HttpClient`], which is a basic RPC client that
+//!   interacts with remote Tendermint nodes via **JSON-RPC over HTTP**. This
+//!   client does not provide [`Event`] subscription functionality. See the
+//!   [Tendermint RPC] for more details.
+//! * `websocket-client` - Provides [`WebSocketClient`], which currently only
+//!   provides `Event` subscription functionality over a WebSocket connection.
+//!   See the [`/subscribe` endpoint] in the Tendermint RPC for more details.
+//!   This client does not yet provide access to the RPC methods provided by
+//!   the [`Client`] trait (this is planned for a future release).
 //!
 //! ### Mock Clients
 //!

diff --git a/tendermint/Cargo.toml b/tendermint/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name       = "tendermint"
-version    = "0.17.0-rc1" # Also update `html_root_url` in lib.rs and
+version    = "0.17.0-rc2" # 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/"
@@ -53,7 +53,7 @@ signature = "1.2"
 subtle = "2"
 subtle-encoding = { version = "0.5", features = ["bech32-preview"] }
 thiserror = "1"
-tendermint-proto = { version = "0.17.0-rc1", path = "../proto" }
+tendermint-proto = { version = "0.17.0-rc2", path = "../proto" }
 toml = { version = "0.5" }
 zeroize = { version = "1.1", features = ["zeroize_derive"] }
 

diff --git a/tendermint/src/lib.rs b/tendermint/src/lib.rs
@@ -15,7 +15,7 @@
 )]
 #![forbid(unsafe_code)]
 #![doc(
-    html_root_url = "https://docs.rs/tendermint/0.17.0-rc1",
+    html_root_url = "https://docs.rs/tendermint/0.17.0-rc2",
     html_logo_url = "https://raw.githubusercontent.com/informalsystems/tendermint-rs/master/img/logo-tendermint-rs_3961x4001.png"
 )]
 

diff --git a/testgen/Cargo.toml b/testgen/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
 name = "tendermint-testgen"
-version = "0.17.0-rc1"
+version = "0.17.0-rc2"
 authors = ["Andrey Kuprianov <andrey@informal.systems>"]
 edition = "2018"
 publish = false
 
 [dependencies]
-tendermint = { version = "0.17.0-rc1", path = "../tendermint" }
+tendermint = { version = "0.17.0-rc2", path = "../tendermint" }
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 ed25519-dalek = "1"