feat: optional feature no_unknown_fields (xJonathanLEI#267)

9oelM · Jan 11, 2023 · d35867a · d35867a
1 parent a6d864f
commit d35867a
Show file tree

Hide file tree

Showing 17 changed files with 118 additions and 63 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -48,3 +48,4 @@ url = "2.2.2"
 [features]
 default = ["bigdecimal"]
 bigdecimal = ["starknet-core/bigdecimal"]
+no_unknown_fields = ["starknet-core/no_unknown_fields", "starknet-providers/no_unknown_fields"]
diff --git a/starknet-core/Cargo.toml b/starknet-core/Cargo.toml
@@ -30,13 +30,15 @@ thiserror = "1.0.30"
 
 [dev-dependencies]
 criterion = { version = "0.4.0", default-features = false }
+starknet-core = { path = ".", features = ["no_unknown_fields"] }
 
 [target.'cfg(target_arch = "wasm32")'.dev-dependencies]
 wasm-bindgen-test = "0.3.29"
 
 [features]
 default = ["bigdecimal"]
 bigdecimal = ["starknet-ff/bigdecimal"]
+no_unknown_fields = []
 
 [[bench]]
 name = "class_hash"

diff --git a/starknet-core/src/types/block.rs b/starknet-core/src/types/block.rs
@@ -15,7 +15,7 @@ pub enum BlockId {
 
 #[derive(Debug, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "SCREAMING_SNAKE_CASE")]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub enum BlockStatus {
     /// Block that is yet to be closed
     Pending,
@@ -31,7 +31,7 @@ pub enum BlockStatus {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Block {
     #[serde(default)]
     #[serde_as(as = "UfeHexOption")]

diff --git a/starknet-core/src/types/call_contract.rs b/starknet-core/src/types/call_contract.rs
@@ -5,7 +5,7 @@ use serde_with::serde_as;
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct CallContractResult {
     #[serde_as(as = "Vec<UfeHex>")]
     pub result: Vec<FieldElement>,

diff --git a/starknet-core/src/types/contract_addresses.rs b/starknet-core/src/types/contract_addresses.rs
@@ -3,7 +3,7 @@ use serde::Deserialize;
 
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "PascalCase")]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct ContractAddresses {
     pub starknet: Address,
     pub gps_statement_verifier: Address,

diff --git a/starknet-core/src/types/contract_artifact.rs b/starknet-core/src/types/contract_artifact.rs
@@ -15,7 +15,7 @@ use std::{collections::BTreeMap, io::Write};
 const API_VERSION: FieldElement = FieldElement::ZERO;
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct ContractArtifact {
     pub abi: Vec<AbiEntry>,
     pub entry_points_by_type: EntryPointsByType,
@@ -40,7 +40,7 @@ pub enum CompressProgramError {
 
 #[serde_as]
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Program {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub attributes: Option<Vec<Attribute>>,
@@ -62,7 +62,7 @@ pub struct Program {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Attribute {
     pub accessible_scopes: Vec<String>,
     pub end_pc: u64,
@@ -74,7 +74,7 @@ pub struct Attribute {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct DebugInfo {
     /// A partial map from file name to its content. Files that are not in the map, are assumed to
     /// exist in the file system.
@@ -84,15 +84,15 @@ pub struct DebugInfo {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Hint {
     pub accessible_scopes: Vec<String>,
     pub code: String,
     pub flow_tracking_data: FlowTrackingData,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Identifier {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub decorators: Option<Vec<String>>,
@@ -116,13 +116,13 @@ pub struct Identifier {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct ReferenceManager {
     pub references: Vec<Reference>,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct InstructionLocation {
     pub accessible_scopes: Vec<String>,
     // This field is serialized as `null` instead of skipped
@@ -132,37 +132,37 @@ pub struct InstructionLocation {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct IdentifierMember {
     pub cairo_type: String,
     pub offset: u64,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Reference {
     pub ap_tracking_data: ApTrackingData,
     pub pc: u64,
     pub value: String,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct FlowTrackingData {
     pub ap_tracking: ApTrackingData,
     pub reference_ids: BTreeMap<String, u64>,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct HintLocation {
     pub location: Location,
     /// The number of new lines following the "%{" symbol
     pub n_prefix_newlines: u64,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Location {
     pub end_col: u64,
     pub end_line: u64,
@@ -174,14 +174,14 @@ pub struct Location {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct ApTrackingData {
     pub group: u64,
     pub offset: u64,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-#[serde(deny_unknown_fields)]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct InputFile {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub filename: Option<String>,

diff --git a/starknet-core/src/types/contract_code.rs b/starknet-core/src/types/contract_code.rs
@@ -5,7 +5,7 @@ use serde_with::serde_as;
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct ContractCode {
     #[serde_as(as = "Vec<UfeHex>")]
     pub bytecode: Vec<FieldElement>,
@@ -60,28 +60,28 @@ pub struct Event {
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Input {
     pub name: String,
     pub r#type: String,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Output {
     pub name: String,
     pub r#type: String,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct EventData {
     pub name: String,
     pub r#type: String,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Member {
     pub name: String,
     pub offset: u64,

diff --git a/starknet-core/src/types/fee.rs b/starknet-core/src/types/fee.rs
@@ -3,7 +3,7 @@ use serde::Deserialize;
 use super::TransactionTrace;
 
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct FeeEstimate {
     pub overall_fee: u64,
     pub unit: FeeUnit,
@@ -13,14 +13,14 @@ pub struct FeeEstimate {
 
 /// Represents the information regarding a StarkNet transaction's simulation.
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct TransactionSimulationInfo {
     pub trace: TransactionTrace,
     pub fee_estimation: FeeEstimate,
 }
 
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub enum FeeUnit {
     #[serde(rename = "wei")]
     Wei,

diff --git a/starknet-core/src/types/starknet_error.rs b/starknet-core/src/types/starknet_error.rs
@@ -1,7 +1,7 @@
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct Error {
     pub code: ErrorCode,
     pub message: String,
@@ -16,7 +16,7 @@ impl std::fmt::Display for Error {
 }
 
 #[derive(Debug, PartialEq, Eq, Deserialize, Serialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub enum ErrorCode {
     #[serde(rename = "StarknetErrorCode.BLOCK_NOT_FOUND")]
     BlockNotFound,

diff --git a/starknet-core/src/types/state_update.rs b/starknet-core/src/types/state_update.rs
@@ -6,7 +6,7 @@ use std::collections::HashMap;
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct StateUpdate {
     #[serde(default)]
     #[serde_as(as = "Option<UfeHex>")]
@@ -20,7 +20,7 @@ pub struct StateUpdate {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct StateDiff {
     #[serde_as(as = "HashMap<UfeHex, _>")]
     pub storage_diffs: HashMap<FieldElement, Vec<StorageDiff>>,
@@ -34,7 +34,7 @@ pub struct StateDiff {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct StorageDiff {
     #[serde_as(as = "UfeHex")]
     pub key: FieldElement,
@@ -44,7 +44,7 @@ pub struct StorageDiff {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct DeployedContract {
     #[serde_as(as = "UfeHex")]
     pub address: FieldElement,

diff --git a/starknet-core/src/types/trace.rs b/starknet-core/src/types/trace.rs
@@ -7,15 +7,15 @@ use starknet_crypto::FieldElement;
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct BlockTraces {
     pub traces: Vec<TransactionTraceWithHash>,
 }
 
 /// Represents the trace of a StarkNet transaction execution, including internal calls.
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct TransactionTrace {
     /// An object describing the invocation of a specific function.
     pub function_invocation: FunctionInvocation,
@@ -31,7 +31,7 @@ pub struct TransactionTrace {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct TransactionTraceWithHash {
     #[serde(flatten)]
     pub trace: TransactionTrace,
@@ -41,7 +41,7 @@ pub struct TransactionTraceWithHash {
 
 #[derive(Debug, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "SCREAMING_SNAKE_CASE")]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub enum CallType {
     Call,
     Delegate,
@@ -50,7 +50,7 @@ pub enum CallType {
 /// A lean version of CallInfo class, containing merely the information relevant for the user.
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct FunctionInvocation {
     #[serde_as(as = "UfeHex")]
     pub caller_address: FieldElement,
@@ -80,7 +80,7 @@ pub struct FunctionInvocation {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct OrderedEventResponse {
     pub order: u64,
     #[serde_as(as = "Vec<UfeHex>")]
@@ -91,7 +91,7 @@ pub struct OrderedEventResponse {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[cfg_attr(test, serde(deny_unknown_fields))]
+#[cfg_attr(feature = "no_unknown_fields", serde(deny_unknown_fields))]
 pub struct OrderedL2ToL1MessageResponse {
     pub order: u64,
     pub to_address: Address,