Release v1.6.1 (#8396)

* Updates crates versions * Updates end of support height * Updates README * Updates CHANGELOG * Updates Known Issues in README * Updates Changelog * updates release-crates-dry-run.sh * updates install.md and docker.md * Update CHANGELOG.md Co-authored-by: Marek <[email protected]> --------- Co-authored-by: Marek <[email protected]>
ZcashFoundation · Apr 15, 2024 · 1498f8e · 1498f8e
1 parent 1534442
commit 1498f8e
Show file tree

Hide file tree

Showing 21 changed files with 122 additions and 107 deletions.
diff --git a/.github/workflows/scripts/release-crates-dry-run.sh b/.github/workflows/scripts/release-crates-dry-run.sh
@@ -23,8 +23,8 @@ fi
 cargo release version --verbose --execute --no-confirm --allow-branch '*' --workspace --exclude zebrad --exclude zebra-scan --exclude zebra-grpc beta
 
 # Due to a bug in cargo-release, we need to pass exact versions for alpha crates:
-cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebra-scan 0.1.0-alpha.5
-cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebra-grpc 0.1.0-alpha.3
+cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebra-scan 0.1.0-alpha.6
+cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebra-grpc 0.1.0-alpha.4
 
 # Update zebrad:
 cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebrad patch

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,19 +5,34 @@ All notable changes to Zebra are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org).
 
-## Unreleased
+## [Zebra 1.6.1](https://github.com/ZcashFoundation/zebra/releases/tag/v1.6.1) - 2024-04-15
 
-### Added 
-- `zebra_chain::Network` methods:
-  - `b58_pubkey_address_prefix`, `b58_script_address_prefix`, `num_funding_streams`
+This release adds an OpenAPI specification for Zebra's RPC methods and startup logs about Zebra's storage usage and other database information. 
+
+It also includes:
+- Bug fixes and improved error messages for some zebra-scan gRPC methods
+- A performance improvement in Zebra's `getblock` RPC method  
+
+### Added
+
+- Log database information such as storage usage on startup and shutdown ([#8336](https://github.com/ZcashFoundation/zebra/pull/8336), [#8389](https://github.com/ZcashFoundation/zebra/pull/8389))
+- OpenAPI specification for Zebra's RPC methods ([#8342](https://github.com/ZcashFoundation/zebra/pull/8342))
+- Add block times to output of getblock RPC method when called with `verbosity = 2` ([#8384](https://github.com/ZcashFoundation/zebra/pull/8384))
 
 ### Changed
-- Functions that take a `zebra_chain::Network` as an argument have been moved to be methods of `Network`, including
-  - `zebra_chain::parameters`: 
-    - `genesis::genesis_hash`, `NetworkUpgrade::activation_list`, `NetworkUpgrade::is_max_block_time_enforced`, 
-  - `zebra_chain::work::difficulty::ExpandedDifficulty::target_difficutly_limit`
-  - `zebra_consensus::height_for_first_halving`
-  - `zebra_consensus::checkpoint::CheckpointList::new` (now `Network::checkpoint_list`)
+
+- Removed `Copy` trait impl for `Network` ([#8354](https://github.com/ZcashFoundation/zebra/pull/8354))
+- Refactored code for network consensus parameters to `Network` methods ([#8340](https://github.com/ZcashFoundation/zebra/pull/8340))
+
+### Fixed
+
+- Improve zebra-scan gRPC method errors and add timeout to scan service to avoid hanging ([#8318](https://github.com/ZcashFoundation/zebra/pull/8318))
+- Await state service requests in `getblock` method in parallel ([#8376](https://github.com/ZcashFoundation/zebra/pull/8376))
+
+### Contributors
+
+Thank you to everyone who contributed to this release, we couldn't make Zebra without you:
+@arya2, @elijahhampton, @gustavovalverde, @idky137, @mpguerra, @oxarbitrage, @upbqdn and @zancas
 
 ## [Zebra 1.6.0](https://github.com/ZcashFoundation/zebra/releases/tag/v1.6.0) - 2024-02-23
 

diff --git a/Cargo.lock b/Cargo.lock
@@ -4812,7 +4812,7 @@ dependencies = [
 
 [[package]]
 name = "tower-batch-control"
-version = "0.2.41-beta.11"
+version = "0.2.41-beta.12"
 dependencies = [
  "color-eyre",
  "ed25519-zebra",
@@ -4835,7 +4835,7 @@ dependencies = [
 
 [[package]]
 name = "tower-fallback"
-version = "0.2.41-beta.11"
+version = "0.2.41-beta.12"
 dependencies = [
  "futures-core",
  "pin-project",
@@ -5825,7 +5825,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-chain"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "bitflags 2.4.2",
  "bitflags-serde-legacy",
@@ -5887,7 +5887,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-consensus"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "bellman",
  "blake2b_simd",
@@ -5933,7 +5933,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-grpc"
-version = "0.1.0-alpha.2"
+version = "0.1.0-alpha.3"
 dependencies = [
  "color-eyre",
  "futures-util",
@@ -5955,7 +5955,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-network"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "bitflags 2.4.2",
  "byteorder",
@@ -5996,7 +5996,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-node-services"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "color-eyre",
  "jsonrpc-core",
@@ -6009,7 +6009,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-rpc"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "chrono",
  "futures",
@@ -6040,7 +6040,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-scan"
-version = "0.1.0-alpha.4"
+version = "0.1.0-alpha.5"
 dependencies = [
  "bls12_381",
  "chrono",
@@ -6072,7 +6072,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-script"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "displaydoc",
  "hex",
@@ -6085,7 +6085,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-state"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "bincode",
  "chrono",
@@ -6130,7 +6130,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-test"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "color-eyre",
  "futures",
@@ -6158,7 +6158,7 @@ dependencies = [
 
 [[package]]
 name = "zebra-utils"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 dependencies = [
  "color-eyre",
  "hex",
@@ -6187,7 +6187,7 @@ dependencies = [
 
 [[package]]
 name = "zebrad"
-version = "1.6.0"
+version = "1.6.1"
 dependencies = [
  "abscissa_core",
  "atty",

diff --git a/README.md b/README.md
@@ -185,9 +185,9 @@ There are a few bugs in Zebra that we're still working on fixing:
 
 - Block download and verification sometimes times out during Zebra's initial sync [#5709](https://github.com/ZcashFoundation/zebra/issues/5709). The full sync still finishes reasonably quickly.
 
-- No Windows support [#3801](https://github.com/ZcashFoundation/zebra/issues/3801). We used to test with Windows Server 2019, but not any more; see the issue for details.
+- No Windows support [#3801](https://github.com/ZcashFoundation/zebra/issues/3801). We used to test with Windows Server 2019, but not any more; `zcash_script` has recently been updated to compile with MSVC, we're now waiting on a `zcash_script` release and dependency update, see the issue for details.
 
-- Experimental Tor support is disabled until [Zebra upgrades to the latest `arti-client`](https://github.com/ZcashFoundation/zebra/issues/5492). This happened due to a Rust dependency conflict, which could only be resolved by `arti` upgrading to a version of `x25519-dalek` with the dependency fix.
+- Experimental Tor support is disabled until Zebra upgrades to the latest `arti-client`. This happened due to a Rust dependency conflict ([#5492](https://github.com/ZcashFoundation/zebra/issues/5492)) and is still an issue due to [another dependency conflict](https://github.com/ZcashFoundation/zebra/issues/8328#issuecomment-1969989648).
 
 ## Documentation
 

diff --git a/book/src/user/docker.md b/book/src/user/docker.md
@@ -37,7 +37,7 @@ docker run -d --platform linux/amd64 \
 ### Build it locally
 
 ```shell
-git clone --depth 1 --branch v1.6.0 https://github.com/ZcashFoundation/zebra.git
+git clone --depth 1 --branch v1.6.1 https://github.com/ZcashFoundation/zebra.git
 docker build --file docker/Dockerfile --target runtime --tag zebra:local .
 docker run --detach zebra:local
 ```

diff --git a/book/src/user/install.md b/book/src/user/install.md
@@ -19,7 +19,7 @@ To compile Zebra directly from GitHub, or from a GitHub release source archive:
 ```sh
 git clone https://github.com/ZcashFoundation/zebra.git
 cd zebra
-git checkout v1.6.0
+git checkout v1.6.1
 ```
 
 3. Build and Run `zebrad`
@@ -32,7 +32,7 @@ target/release/zebrad start
 ### Compiling from git using cargo install
 
 ```sh
-cargo install --git https://github.com/ZcashFoundation/zebra --tag v1.6.0 zebrad
+cargo install --git https://github.com/ZcashFoundation/zebra --tag v1.6.1 zebrad
 ```
 
 ### Compiling on ARM

diff --git a/tower-batch-control/Cargo.toml b/tower-batch-control/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tower-batch-control"
-version = "0.2.41-beta.11"
+version = "0.2.41-beta.12"
 authors = ["Zcash Foundation <[email protected]>", "Tower Maintainers <[email protected]>"]
 description = "Tower middleware for batch request processing"
 # # Legal
@@ -43,7 +43,7 @@ rand = "0.8.5"
 
 tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }
 tokio-test = "0.4.4"
-tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.11" }
+tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.12" }
 tower-test = "0.4.0"
 
-zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
+zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.36" }
diff --git a/tower-fallback/Cargo.toml b/tower-fallback/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tower-fallback"
-version = "0.2.41-beta.11"
+version = "0.2.41-beta.12"
 authors = ["Zcash Foundation <[email protected]>"]
 description = "A Tower service combinator that sends requests to a first service, then retries processing on a second fallback service if the first service errors."
 license = "MIT OR Apache-2.0"
@@ -24,4 +24,4 @@ tracing = "0.1.39"
 [dev-dependencies]
 tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }
 
-zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
+zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.36" }
diff --git a/zebra-chain/Cargo.toml b/zebra-chain/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zebra-chain"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 authors = ["Zcash Foundation <[email protected]>"]
 description = "Core Zcash data structures"
 license = "MIT OR Apache-2.0"
@@ -143,7 +143,7 @@ proptest-derive = { version = "0.4.0", optional = true }
 rand = { version = "0.8.5", optional = true }
 rand_chacha = { version = "0.3.1", optional = true }
 
-zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35", optional = true }
+zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.36", optional = true }
 
 [dev-dependencies]
 # Benchmarks
@@ -166,7 +166,7 @@ rand_chacha = "0.3.1"
 
 tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }
 
-zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
+zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.36" }
 
 [[bench]]
 name = "block"

diff --git a/zebra-consensus/Cargo.toml b/zebra-consensus/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zebra-consensus"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 authors = ["Zcash Foundation <[email protected]>"]
 description = "Implementation of Zcash consensus checks"
 license = "MIT OR Apache-2.0"
@@ -63,13 +63,13 @@ orchard = "0.6.0"
 zcash_proofs = { version = "0.13.0-rc.1", features = ["multicore" ] }
 wagyu-zcash-parameters = "0.2.0"
 
-tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.11" }
-tower-batch-control = { path = "../tower-batch-control/", version = "0.2.41-beta.11" }
+tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.12" }
+tower-batch-control = { path = "../tower-batch-control/", version = "0.2.41-beta.12" }
 
-zebra-script = { path = "../zebra-script", version = "1.0.0-beta.35" }
-zebra-state = { path = "../zebra-state", version = "1.0.0-beta.35" }
-zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.35" }
-zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.35" }
+zebra-script = { path = "../zebra-script", version = "1.0.0-beta.36" }
+zebra-state = { path = "../zebra-state", version = "1.0.0-beta.36" }
+zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.36" }
+zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36" }
 
 # prod feature progress-bar
 howudoin = { version = "0.1.2", optional = true }
@@ -94,6 +94,6 @@ tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }
 tracing-error = "0.2.0"
 tracing-subscriber = "0.3.18"
 
-zebra-state = { path = "../zebra-state", version = "1.0.0-beta.35", features = ["proptest-impl"] }
-zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.35", features = ["proptest-impl"] }
-zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
+zebra-state = { path = "../zebra-state", version = "1.0.0-beta.36", features = ["proptest-impl"] }
+zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36", features = ["proptest-impl"] }
+zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.36" }
diff --git a/zebra-grpc/Cargo.toml b/zebra-grpc/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zebra-grpc"
-version = "0.1.0-alpha.2"
+version = "0.1.0-alpha.3"
 authors = ["Zcash Foundation <[email protected]>"]
 description = "Zebra gRPC interface"
 license = "MIT OR Apache-2.0"
@@ -28,8 +28,8 @@ color-eyre = "0.6.3"
 
 zcash_primitives = { version = "0.13.0-rc.1" }
 
-zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.35", features = ["shielded-scan"] }
-zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.35" }
+zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.36", features = ["shielded-scan"] }
+zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.36" }
 
 [build-dependencies]
 tonic-build = "0.11.0"

diff --git a/zebra-network/Cargo.toml b/zebra-network/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zebra-network"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 authors = ["Zcash Foundation <[email protected]>", "Tower Maintainers <[email protected]>"]
 description = "Networking code for Zebra"
 # # Legal
@@ -83,7 +83,7 @@ howudoin = { version = "0.1.2", optional = true }
 proptest = { version = "1.4.0", optional = true }
 proptest-derive = { version = "0.4.0", optional = true }
 
-zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.35", features = ["async-error"] }
+zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36", features = ["async-error"] }
 
 [dev-dependencies]
 proptest = "1.4.0"

diff --git a/zebra-node-services/Cargo.toml b/zebra-node-services/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zebra-node-services"
-version = "1.0.0-beta.35"
+version = "1.0.0-beta.36"
 authors = ["Zcash Foundation <[email protected]>"]
 description = "The interfaces of some Zebra node services"
 license = "MIT OR Apache-2.0"
@@ -37,7 +37,7 @@ rpc-client = [
 shielded-scan = ["tokio"]
 
 [dependencies]
-zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.35" }
+zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.36" }
 
 # Optional dependencies