CI: add cargo hack

.github/workflows/ci.yml

@@ -133,7 +133,12 @@ jobs:
     - name: Test
       run: |
         cargo test --all-features --workspace
-        cargo test --package cuprate-blockchain --no-default-features --features redb --features service
+        cargo test --package cuprate-blockchain --no-default-features --features redb
+
+    - name: Hack Check
+      run: |
+        cargo install cargo-hack --locked
+        cargo hack --workspace check --feature-powerset --no-dev-deps
 
     # TODO: upload binaries with `actions/upload-artifact@v3`
     - name: Build

CONTRIBUTING.md

@@ -120,12 +120,15 @@ Before pushing your code, please run the following at the root of the repository
 
 After that, ensure all other CI passes by running:
 
-| Command                                                                | Does what |
-|------------------------------------------------------------------------|-----------|
-| `RUSTDOCFLAGS='-D warnings' cargo doc --workspace --all-features`      | Checks documentation is OK
-| `cargo clippy --workspace --all-features --all-targets -- -D warnings` | Checks clippy lints are satisfied
-| `cargo test --all-features --workspace`                                | Runs all tests
-| `cargo build --all-features --all-targets --workspace`                 | Builds all code
+| Command                                                                | Does what                                                               |
+|------------------------------------------------------------------------|-------------------------------------------------------------------------|
+| `RUSTDOCFLAGS='-D warnings' cargo doc --workspace --all-features`      | Checks documentation is OK                                              |
+| `cargo clippy --workspace --all-features --all-targets -- -D warnings` | Checks clippy lints are satisfied                                       |
+| `cargo test --all-features --workspace`                                | Runs all tests                                                          |
+| `cargo build --all-features --all-targets --workspace`                 | Builds all code                                                         |
+| `cargo hack --workspace check --feature-powerset --no-dev-deps`        | Uses `cargo hack` to check our crates build with different features set |
+
+`cargo hack` can be installed with `cargo` from: https://github.com/taiki-e/cargo-hack.
 
 **Note: in order for some tests to work, you will need to place a [`monerod`](https://www.getmonero.org/downloads/) binary at the root of the repository.**
 

binaries/cuprated/Cargo.toml

@@ -24,7 +24,7 @@ cuprate-p2p-core         = { workspace = true }
 cuprate-dandelion-tower  = { workspace = true, features = ["txpool"] }
 cuprate-async-buffer     = { workspace = true }
 cuprate-address-book     = { workspace = true }
-cuprate-blockchain       = { workspace = true, features = ["service"] }
+cuprate-blockchain       = { workspace = true }
 cuprate-database-service = { workspace = true }
 cuprate-txpool           = { workspace = true }
 cuprate-database         = { workspace = true }

helper/Cargo.toml

@@ -17,7 +17,7 @@ asynch    = ["dep:futures", "dep:rayon"]
 cast      = []
 constants = []
 crypto    = ["dep:curve25519-dalek", "dep:monero-serai", "std"]
-fs        = ["dep:dirs"]
+fs        = ["dep:dirs", "std"]
 num       = []
 map       = ["cast", "dep:monero-serai", "dep:cuprate-constants"]
 time      = ["dep:chrono", "std"]

helper/src/lib.rs

@@ -11,7 +11,7 @@ pub mod atomic;
 #[cfg(feature = "cast")]
 pub mod cast;
 
-#[cfg(feature = "fs")]
+#[cfg(all(feature = "fs", feature = "std"))]
 pub mod fs;
 
 pub mod network;

net/epee-encoding/src/container_as_blob.rs

@@ -1,3 +1,5 @@
+use alloc::{string::ToString, vec, vec::Vec};
+
 use bytes::{Buf, BufMut, Bytes, BytesMut};
 use ref_cast::RefCast;
 

net/epee-encoding/src/error.rs

@@ -1,3 +1,4 @@
+use alloc::string::{String, ToString};
 use core::{
     fmt::{Debug, Formatter},
     num::TryFromIntError,

net/epee-encoding/src/lib.rs

@@ -64,6 +64,7 @@ use hex as _;
 
 extern crate alloc;
 
+use alloc::string::ToString;
 use core::str::from_utf8 as str_from_utf8;
 
 use bytes::{Buf, BufMut, Bytes, BytesMut};

net/epee-encoding/src/value.rs

@@ -1,7 +1,7 @@
 //! This module contains a [`EpeeValue`] trait and
 //! impls for some possible base epee values.
 
-use alloc::{string::String, vec::Vec};
+use alloc::{string::String, vec, vec::Vec};
 use core::fmt::Debug;
 
 use bytes::{Buf, BufMut, Bytes, BytesMut};

p2p/address-book/Cargo.toml

@@ -9,7 +9,7 @@ authors = ["Boog900"]
 [dependencies]
 cuprate-constants   = { workspace = true }
 cuprate-pruning     = { workspace = true }
-cuprate-p2p-core    = { workspace = true }
+cuprate-p2p-core    = { workspace = true, features = ["borsh"] }
 
 tower = { workspace = true, features = ["util"] }
 tokio = { workspace = true, features = ["time", "fs", "rt"]}

pruning/Cargo.toml

@@ -10,7 +10,7 @@ default = []
 borsh = ["dep:borsh"]
 
 [dependencies]
-cuprate-constants = { workspace = true }
+cuprate-constants = { workspace = true, features = ["block"] }
 
 thiserror = { workspace = true }
 

rpc/interface/Cargo.toml

@@ -10,20 +10,20 @@ keywords    = ["cuprate", "rpc", "interface"]
 
 [features]
 default  = ["dummy", "serde"]
-dummy    = []
+dummy    = ["dep:cuprate-helper", "dep:futures"]
 
 [dependencies]
 cuprate-epee-encoding = { workspace = true, default-features = false }
 cuprate-json-rpc      = { workspace = true, default-features = false }
 cuprate-rpc-types     = { workspace = true, features = ["serde", "epee"], default-features = false }
-cuprate-helper        = { workspace = true, features = ["asynch"], default-features = false }
+cuprate-helper        = { workspace = true, features = ["asynch"], default-features = false, optional = true }
 
 anyhow     = { workspace = true }
 axum       = { version = "0.7.5", features = ["json"], default-features = false }
 serde      = { workspace = true, optional = true }
-tower      = { workspace = true }
+tower      = { workspace = true, features = ["util"] }
 paste      = { workspace = true }
-futures    = { workspace = true }
+futures    = { workspace = true, optional = true }
 
 [dev-dependencies]
 cuprate-test-utils = { workspace = true }

rpc/types/src/bin.rs

@@ -20,12 +20,16 @@ use cuprate_types::BlockCompleteEntry;
 
 use crate::{
     base::AccessResponseBase,
-    defaults::{default_false, default_zero},
     macros::{define_request, define_request_and_response, define_request_and_response_doc},
-    misc::{BlockOutputIndices, GetOutputsOut, OutKeyBin, PoolInfoExtent, PoolTxInfo, Status},
+    misc::{BlockOutputIndices, GetOutputsOut, OutKeyBin, PoolTxInfo, Status},
     rpc_call::RpcCallValue,
 };
 
+#[cfg(any(feature = "epee", feature = "serde"))]
+use crate::defaults::{default_false, default_zero};
+#[cfg(feature = "epee")]
+use crate::misc::PoolInfoExtent;
+
 //---------------------------------------------------------------------------------------------------- Definitions
 define_request_and_response! {
     get_blocks_by_heightbin,

rpc/types/src/json.rs

@@ -8,10 +8,6 @@ use serde::{Deserialize, Serialize};
 
 use crate::{
     base::{AccessResponseBase, ResponseBase},
-    defaults::{
-        default_false, default_height, default_one, default_string, default_true, default_vec,
-        default_zero,
-    },
     macros::define_request_and_response,
     misc::{
         AuxPow, BlockHeader, ChainInfo, ConnectionInfo, Distribution, GetBan,
@@ -21,6 +17,12 @@ use crate::{
     rpc_call::RpcCallValue,
 };
 
+#[cfg(any(feature = "epee", feature = "serde"))]
+use crate::defaults::{
+    default_false, default_height, default_one, default_string, default_true, default_vec,
+    default_zero,
+};
+
 //---------------------------------------------------------------------------------------------------- Macro
 /// Adds a (de)serialization doc-test to a type in `json.rs`.
 ///

rpc/types/src/lib.rs

@@ -6,6 +6,7 @@
 )]
 
 mod constants;
+#[cfg(any(feature = "serde", feature = "epee"))]
 mod defaults;
 mod free;
 mod macros;

rpc/types/src/misc/distribution.rs

@@ -20,8 +20,8 @@ use cuprate_epee_encoding::{
     "rpc/core_rpc_server_commands_defs.h",
     45..=55
 )]
-#[cfg(feature = "epee")]
-fn compress_integer_array(_: &[u64]) -> error::Result<Vec<u8>> {
+#[cfg(any(feature = "epee", feature = "serde"))]
+fn compress_integer_array(_: &[u64]) -> Vec<u8> {
     todo!()
 }
 
@@ -33,6 +33,7 @@ fn compress_integer_array(_: &[u64]) -> error::Result<Vec<u8>> {
     "rpc/core_rpc_server_commands_defs.h",
     57..=72
 )]
+#[cfg(any(feature = "epee", feature = "serde"))]
 fn decompress_integer_array(_: &[u8]) -> Vec<u64> {
     todo!()
 }
@@ -135,12 +136,7 @@ fn serialize_distribution_as_compressed_data<S>(v: &Vec<u64>, s: S) -> Result<S:
 where
     S: serde::Serializer,
 {
-    match compress_integer_array(v) {
-        Ok(compressed_data) => compressed_data.serialize(s),
-        Err(_) => Err(serde::ser::Error::custom(
-            "error compressing distribution array",
-        )),
-    }
+    compress_integer_array(v).serialize(s)
 }
 
 /// Deserializer function for [`DistributionCompressedBinary::distribution`].
@@ -256,7 +252,7 @@ impl EpeeObject for Distribution {
                 distribution,
                 amount,
             }) => {
-                let compressed_data = compress_integer_array(&distribution)?;
+                let compressed_data = compress_integer_array(&distribution);
 
                 start_height.write(w)?;
                 base.write(w)?;

rpc/types/src/misc/misc.rs

@@ -11,10 +11,10 @@ use serde::{Deserialize, Serialize};
 #[cfg(feature = "epee")]
 use cuprate_epee_encoding::epee_object;
 
-use crate::{
-    defaults::{default_string, default_zero},
-    macros::monero_definition_link,
-};
+use crate::macros::monero_definition_link;
+
+#[cfg(any(feature = "epee", feature = "serde"))]
+use crate::defaults::default_zero;
 
 //---------------------------------------------------------------------------------------------------- Macros
 /// This macro (local to this file) defines all the misc types.
@@ -148,7 +148,7 @@ define_struct_and_impl_epee! {
     )]
     /// Used in [`crate::json::SetBansRequest`].
     SetBan {
-        #[cfg_attr(feature = "serde", serde(default = "default_string"))]
+        #[cfg_attr(feature = "serde", serde(default = "crate::defaults::default_string"))]
         host: String,
         #[cfg_attr(feature = "serde", serde(default = "default_zero"))]
         ip: u32,

rpc/types/src/other.rs

@@ -8,7 +8,6 @@ use serde::{Deserialize, Serialize};
 
 use crate::{
     base::{AccessResponseBase, ResponseBase},
-    defaults::{default_false, default_string, default_true, default_vec, default_zero},
     macros::define_request_and_response,
     misc::{
         GetOutputsOut, OutKey, Peer, PublicNode, SpentKeyImageInfo, Status, TxEntry, TxInfo,
@@ -17,6 +16,9 @@ use crate::{
     RpcCallValue,
 };
 
+#[cfg(any(feature = "serde", feature = "epee"))]
+use crate::defaults::{default_false, default_string, default_true, default_vec, default_zero};
+
 //---------------------------------------------------------------------------------------------------- Macro
 /// Adds a (de)serialization doc-test to a type in `other.rs`.
 ///

storage/blockchain/Cargo.toml

@@ -9,32 +9,31 @@ repository  = "https://github.com/Cuprate/cuprate/tree/main/storage/cuprate-bloc
 keywords    = ["cuprate", "blockchain", "database"]
 
 [features]
-default     = ["heed", "service"]
+default     = ["heed"]
 # default     = ["redb", "service"]
 # default     = ["redb-memory", "service"]
 heed        = ["cuprate-database/heed"]
 redb        = ["cuprate-database/redb"]
 redb-memory = ["cuprate-database/redb-memory"]
-service     = ["dep:thread_local", "dep:rayon", "cuprate-helper/thread"]
+serde       = ["dep:serde", "cuprate-database/serde", "cuprate-database-service/serde"]
 
 [dependencies]
 cuprate-database         = { workspace = true }
 cuprate-database-service = { workspace = true }
-cuprate-helper           = { workspace = true, features = ["fs", "map", "crypto"] }
+cuprate-helper           = { workspace = true, features = ["fs", "map", "crypto", "tx", "thread"] }
 cuprate-types            = { workspace = true, features = ["blockchain"] }
 cuprate-pruning          = { workspace = true }
 
 bitflags         = { workspace = true, features = ["std", "serde", "bytemuck"] }
 bytemuck         = { workspace = true, features = ["must_cast", "derive", "min_const_generics", "extern_crate_alloc"] }
 curve25519-dalek = { workspace = true }
-rand             = { workspace = true }
+rand             = { workspace = true, features = ["std", "std_rng"] }
 monero-serai     = { workspace = true, features = ["std"] }
 serde            = { workspace = true, optional = true }
 
-# `service` feature.
 tower        = { workspace = true }
-thread_local = { workspace = true, optional = true }
-rayon        = { workspace = true, optional = true }
+thread_local = { workspace = true }
+rayon        = { workspace = true }
 
 [dev-dependencies]
 cuprate-constants  = { workspace = true }

storage/blockchain/README.md

@@ -32,9 +32,6 @@ use cuprate_blockchain::{
 This ensures the types/traits used from `cuprate_database` are the same ones used by `cuprate_blockchain` internally.
 
 # Feature flags
-The `service` module requires the `service` feature to be enabled.
-See the module for more documentation.
-
 Different database backends are enabled by the feature flags:
 - `heed` (LMDB)
 - `redb`
@@ -45,7 +42,7 @@ The default is `heed`.
 <!-- FIXME: tracing should be behind a feature flag -->
 
 # Invariants when not using `service`
-`cuprate_blockchain` can be used without the `service` feature enabled but
+`cuprate_blockchain` can be used without the `service` module but
 there are some things that must be kept in mind when doing so.
 
 Failing to uphold these invariants may cause panics.

storage/blockchain/src/lib.rs

@@ -29,16 +29,12 @@ pub use free::open;
 
 pub mod config;
 pub mod ops;
+pub mod service;
 pub mod tables;
 pub mod types;
 
-//---------------------------------------------------------------------------------------------------- Feature-gated
-#[cfg(feature = "service")]
-pub mod service;
-
 //---------------------------------------------------------------------------------------------------- Private
 #[cfg(test)]
 pub(crate) mod tests;
 
-#[cfg(feature = "service")] // only needed in `service` for now
 pub(crate) mod unsafe_sendable;

storage/blockchain/src/service/mod.rs

@@ -10,8 +10,6 @@
 //!
 //! The system is managed by this crate, and only requires [`init`] by the user.
 //!
-//! This module must be enabled with the `service` feature.
-//!
 //! ## Handles
 //! The 2 handles to the database are:
 //! - [`BlockchainReadHandle`]

storage/database/Cargo.toml

@@ -9,10 +9,10 @@ repository  = "https://github.com/Cuprate/cuprate/tree/main/storage/database"
 keywords    = ["cuprate", "database"]
 
 [features]
-# default     = ["heed"]
+default     = ["heed"]
 # default     = ["redb"]
 # default     = ["redb-memory"]
-heed        = ["dep:heed"]
+heed        = []
 redb        = ["dep:redb"]
 redb-memory = ["redb"]
 
@@ -25,7 +25,7 @@ paste     = { workspace = true }
 thiserror = { workspace = true }
 
 # Optional features.
-heed  = { version = "0.20.5", features = ["read-txn-no-tls"], optional = true }
+heed  = { version = "0.20.5", features = ["read-txn-no-tls"] }
 redb  = { version = "2.1.3", optional = true }
 serde = { workspace = true, optional = true }
 

storage/database/src/backend/mod.rs

@@ -4,6 +4,8 @@ cfg_if::cfg_if! {
     // If both backends are enabled, fallback to `heed`.
     // This is useful when using `--all-features`.
     if #[cfg(all(feature = "redb", not(feature = "heed")))] {
+        use heed as _;
+
         mod redb;
         pub use redb::ConcreteEnv;
     } else {