Merge #367: Add a feature for serde deny unknown fields

14c3dd6 Feature gate serde(deny_unknown_fields) (Jamil Lambert, PhD)
ba366fd Add a feature for serde deny unknown fields (Jamil Lambert, PhD)
2406d12 Remove serde deny_unknown_fields from client (Jamil Lambert, PhD)
ced1f4f Use relative path dependencies for corepc crates (Jamil Lambert, PhD)
f8fa8d6 Reorder dependencies in Cargo.toml files (Jamil Lambert, PhD)

Pull request description:

  Currently there is no way to turn off the deny unknown fields attribute. This can cause issues when using the crate in cases where there are fields returned by the RPC that are not yet in the types structs, e.g. in unmerged Core PRs (see #366).

  - Reorder the dependencies in the `Cargo.toml` files to make checking for consistency across the crates easier.
  - Use relative paths for the `corepc` crates dependencies.
  - Remove one case of `#[serde(deny_unknown_fields)]` in `client` that is not needed.
  - Add a feature that can be used to enable the attribute, which is off by default since it is only needed in testing. Enable the feature in `integration_test` by adding a `types` dependency.
  - Search and replace all occurrences of `#[serde(deny_unknown_fields)]` with `#[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]`

  Closes #366

ACKs for top commit:
  tcharding:
    ACK 14c3dd6

Tree-SHA512: 519ab2218685aeedfad737339a5907793c3ce0d80d5a5a5b6c56385af924bca6b13ae94e68baeb1c7a66a4f090eac3254f6137adcbdbde2393dc0ebf5a14e440

Author: tcharding

Cargo.toml

@@ -1,16 +1,16 @@
 [workspace]
-members = ["client", "types", "node", "jsonrpc"]
+members = ["client", "jsonrpc", "node", "types"]
 exclude = ["integration_test", "verify"]
 resolver = "2"
 
 [patch.crates-io.corepc-client]
 path = "client"
 
-[patch.crates-io.corepc-types]
-path = "types"
+[patch.crates-io.jsonrpc]
+path = "jsonrpc"
 
 [patch.crates-io.corepc-node]
 path = "node"
 
-[patch.crates-io.jsonrpc]
-path = "jsonrpc"
+[patch.crates-io.corepc-types]
+path = "types"

client/Cargo.toml

@@ -22,11 +22,11 @@ client-sync = ["jsonrpc"]
 
 [dependencies]
 bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
-types = { package = "corepc-types", version = "0.9.0", default-features = false, features = ["std"] }
 log = "0.4"
 serde = { version = "1.0.103", default-features = false, features = [ "derive", "alloc" ] }
 serde_json = { version = "1.0.117" }
+types = { package = "corepc-types", path = "../types", default-features = false, features = ["std"] }
 
-jsonrpc = { version = "0.18.0", features = ["minreq_http"], optional = true }
+jsonrpc = { path = "../jsonrpc", features = ["minreq_http"], optional = true }
 
 [dev-dependencies]

client/src/client_sync/v21/mod.rs

@@ -192,7 +192,6 @@ crate::impl_client_v17__get_zmq_notifications!();
 
 /// Request object for the `importdescriptors` method.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
-#[serde(deny_unknown_fields)]
 pub struct ImportDescriptorsRequest {
     /// Descriptor to import.
     #[serde(rename = "desc")]

integration_test/Cargo.toml

@@ -56,17 +56,10 @@ TODO = []                       # This is a dirty hack while writing the tests.
 
 [dependencies]
 bitcoin = { version = "0.32.0", default-features = false, features = ["std", "serde"] }
-node = { package = "corepc-node", version = "0.9.0", default-features = false }
-rand = "0.8.5"
 env_logger = "0.9.0"
+node = { package = "corepc-node", path = "../node", default-features = false }
+rand = "0.8.5"
+# Just so we can enable the feature.
+types = { package = "corepc-types", path = "../types", features = ["serde-deny-unknown-fields"] }
 
 [dev-dependencies]
-
-[patch.crates-io.corepc-client]
-path = "../client"
-
-[patch.crates-io.corepc-types]
-path = "../types"
-
-[patch.crates-io.corepc-node]
-path = "../node"

node/Cargo.toml

@@ -13,12 +13,12 @@ rust-version = "1.63.0"
 exclude = ["tests", "contrib"]
 
 [dependencies]
-corepc-client = { version = "0.9.0", features = ["client-sync"] }
-log = { version = "0.4", default-features = false }
-which = { version = "3.1.1", default-features = false }
 anyhow = { version = "1.0.66", default-features = false, features = ["std"] }
-tempfile = {version = "3", default-features = false }
+corepc-client = { path = "../client", features = ["client-sync"] }
+log = { version = "0.4", default-features = false }
 serde_json = { version = "1.0.117", default-features = false }
+tempfile = { version = "3", default-features = false }
+which = { version = "3.1.1", default-features = false }
 
 [dev-dependencies]
 env_logger = { version = "0.9.3", default-features = false }
@@ -27,8 +27,8 @@ env_logger = { version = "0.9.3", default-features = false }
 anyhow = { version = "1.0.66", optional = true }
 bitcoin_hashes = { version = ">= 0.13, <= 0.14", optional = true }
 flate2 = { version = "1.0", optional = true }
-tar = { version = "0.4", optional = true }
 minreq = { version = "2.9.1", default-features = false, features = ["https"], optional = true }
+tar = { version = "0.4", optional = true }
 zip = { version = "0.6.6", default-features = false, features = ["bzip2", "deflate"], optional = true }
 
 # Please note, it is expected that a single version feature will be enabled however if you enable

types/Cargo.toml

@@ -15,6 +15,7 @@ exclude = ["tests", "contrib"]
 [features]
 default = ["std"]
 std = ["bitcoin/std"]
+serde-deny-unknown-fields = []
 
 [dependencies]
 bitcoin = { version = "0.32.0", default-features = false, features = ["serde", "base64", "secp-recovery"] }

types/src/lib.rs

@@ -180,7 +180,7 @@ pub fn compact_size_decode(slice: &mut &[u8]) -> u64 {
 /// backwards compatible so we only provide it not a v0.17 specific type. The `mtype::ScriptPubkey`
 /// mirrors this design (but with concrete `rust-bitcoin` types).
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
 pub struct ScriptPubkey {
     /// Script assembly.
     pub asm: String,
@@ -219,7 +219,7 @@ impl ScriptPubkey {
 
 /// Data returned by Core for a script signature.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
 pub struct ScriptSig {
     /// Assembly representation of the script.
     pub asm: String,