Merge branch 'main' into ci-refactor-actions

ZcashFoundation · Jan 24, 2022 · 7703c7b · 7703c7b
2 parents 4fd0064 + 9101e9a
commit 7703c7b
Show file tree

Hide file tree

Showing 33 changed files with 153 additions and 208 deletions.
diff --git a/.cargo/config.toml b/.cargo/config.toml
@@ -0,0 +1,19 @@
+
+[target.'cfg(all())']
+rustflags = [
+    # Zebra standard lints for Rust 1.58+
+    "-Dunsafe_code",
+    "-Drust_2021_compatibility",
+    "-Dclippy::await_holding_lock",
+
+    "-Wmissing_docs",
+    "-Wnonstandard_style",
+    "-Wfuture_incompatible",
+
+    "-Aclippy::try_err",
+
+    # TODOs:
+
+    # fix hidden lifetime parameters
+    #"-Wrust_2018_idioms",
+]
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,5 @@
 # Vscode detrius
 .vscode/
 .zebra-state/
-.cargo/
 # Nix configs
 shell.nix
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/book/src/dev/rfcs/0005-state-updates.md b/book/src/dev/rfcs/0005-state-updates.md
@@ -608,7 +608,7 @@ We use the following rocksdb column families:
 | `tx_by_location`               | `TransactionLocation`  | `Transaction`                       | Never   |
 | `hash_by_tx`                   | `TransactionLocation`  | `transaction::Hash`                 | Never   |
 | `tx_by_hash`                   | `transaction::Hash`    | `TransactionLocation`               | Never   |
-| `utxo_by_outpoint`             | `OutLocation`          | `transparent::Utxo`                 | Delete  |
+| `utxo_by_outpoint`             | `OutLocation`          | `transparent::Output`               | Delete  |
 | `balance_by_transparent_addr`  | `transparent::Address` | `Amount \|\| FirstOutLocation`      | Update  |
 | `utxo_by_transparent_addr_loc` | `FirstOutLocation`     | `AtLeastOne<OutLocation>`           | Up/Del  |
 | `tx_by_transparent_addr_loc`   | `FirstOutLocation`     | `AtLeastOne<TransactionLocation>`   | Append  |

diff --git a/book/src/dev/rfcs/0011-async-rust-in-zebra.md b/book/src/dev/rfcs/0011-async-rust-in-zebra.md
@@ -564,6 +564,13 @@ For example, [`tokio::sync::watch::Receiver::borrow`](https://docs.rs/tokio/1.15
 holds a read lock, so the borrowed data should always be cloned.
 Use `Arc` for efficient clones if needed.
 
+Never have two active watch borrow guards in the same scope, because that can cause a deadlock. The
+`watch::Sender` may start acquiring a write lock while the first borrow guard is active but the
+second one isn't. That means that the first read lock was acquired, but the second never will be
+because starting to acquire the write lock blocks any other read locks from being acquired. At the
+same time, the write lock will also never finish acquiring, because it waits for all read locks to
+be released, and the first read lock won't be released before the second read lock is acquired.
+
 In all of these cases:
 - make critical sections as short as possible, and
 - do not depend on other tasks or locks inside the critical section.

diff --git a/tower-batch/src/lib.rs b/tower-batch/src/lib.rs
@@ -85,13 +85,6 @@
 //! control logic, as it will receive explicit [`Flush`](BatchControl::Flush)
 //! requests from the wrapper.
 
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
-
 pub mod error;
 pub mod future;
 mod layer;

diff --git a/tower-batch/tests/ed25519.rs b/tower-batch/tests/ed25519.rs
@@ -1,9 +1,3 @@
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![forbid(unsafe_code)]
-
 use std::{
     future::Future,
     mem,

diff --git a/tower-batch/tests/worker.rs b/tower-batch/tests/worker.rs
@@ -1,9 +1,3 @@
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![forbid(unsafe_code)]
-
 use std::time::Duration;
 use tokio_test::{assert_pending, assert_ready, assert_ready_err, task};
 use tower::{Service, ServiceExt};

diff --git a/tower-fallback/src/lib.rs b/tower-fallback/src/lib.rs
@@ -10,13 +10,6 @@
 //!
 //! [aws-fallback]: https://aws.amazon.com/builders-library/avoiding-fallback-in-distributed-systems/
 
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
-
 pub mod future;
 mod service;
 

diff --git a/tower-fallback/tests/fallback.rs b/tower-fallback/tests/fallback.rs
@@ -1,9 +1,3 @@
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![forbid(unsafe_code)]
-
 use tower::{service_fn, Service, ServiceExt};
 use tower_fallback::Fallback;
 

diff --git a/zebra-chain/benches/block.rs b/zebra-chain/benches/block.rs
@@ -1,9 +1,5 @@
-// Standard lints
 // Disabled due to warnings in criterion macros
-//#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![forbid(unsafe_code)]
+#![allow(missing_docs)]
 
 use std::io::Cursor;
 

diff --git a/zebra-chain/benches/redpallas.rs b/zebra-chain/benches/redpallas.rs
@@ -1,6 +1,7 @@
 //! Benchmarks for batch verifiication of RedPallas signatures.
 
-use std::convert::TryFrom;
+// Disabled due to warnings in criterion macros
+#![allow(missing_docs)]
 
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion, Throughput};
 use rand::{thread_rng, Rng};

diff --git a/zebra-chain/build.rs b/zebra-chain/build.rs
@@ -1,3 +1,8 @@
+//! Build script for zebra-chain.
+//!
+//! Turns the environmental variable `$TEST_FAKE_ACTIVATION_HEIGHTS`
+//! into the Rust configuration `cfg(test_fake_activation_heights)`.
+
 use std::env;
 
 fn main() {

diff --git a/zebra-chain/src/lib.rs b/zebra-chain/src/lib.rs
@@ -6,12 +6,6 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_chain")]
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
 // Required by bitvec! macro
 #![recursion_limit = "256"]
 

diff --git a/zebra-client/src/lib.rs b/zebra-client/src/lib.rs
@@ -3,9 +3,3 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_client")]
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
diff --git a/zebra-consensus/src/lib.rs b/zebra-consensus/src/lib.rs
@@ -33,13 +33,6 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_consensus")]
-// Standard lints
-// Warn on missing docs for all modules after cleaning the API surface
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
 
 mod block;
 mod checkpoint;

diff --git a/zebra-network/src/lib.rs b/zebra-network/src/lib.rs
@@ -119,12 +119,6 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_network")]
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
 
 #[macro_use]
 extern crate pin_project;

diff --git a/zebra-rpc/src/lib.rs b/zebra-rpc/src/lib.rs
@@ -3,9 +3,3 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_rpc")]
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
diff --git a/zebra-script/src/lib.rs b/zebra-script/src/lib.rs
@@ -2,14 +2,10 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_script")]
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-// we allow unsafe code, so we can call zcash_script
-
-use std::{convert::TryInto, sync::Arc};
+// We allow unsafe code, so we can call zcash_script
+#![allow(unsafe_code)]
+
+use std::sync::Arc;
 
 use displaydoc::Display;
 use thiserror::Error;

diff --git a/zebra-state/build.rs b/zebra-state/build.rs
@@ -1,3 +1,8 @@
+//! Build script for zebra-state.
+//!
+//! Turns the environmental variable `$TEST_FAKE_ACTIVATION_HEIGHTS`
+//! into the Rust configuration `cfg(test_fake_activation_heights)`.
+
 use std::env;
 
 fn main() {

diff --git a/zebra-state/src/lib.rs b/zebra-state/src/lib.rs
@@ -11,12 +11,6 @@
 #![doc(html_favicon_url = "https://www.zfnd.org/images/zebra-favicon-128.png")]
 #![doc(html_logo_url = "https://www.zfnd.org/images/zebra-icon.png")]
 #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_state")]
-// Standard lints
-#![warn(missing_docs)]
-#![allow(clippy::try_err)]
-#![deny(clippy::await_holding_lock)]
-#![deny(rust_2021_compatibility)]
-#![forbid(unsafe_code)]
 
 #[cfg(any(test, feature = "proptest-impl"))]
 mod arbitrary;