refactor(sdk): contested resource as struct type (#2225)

Co-authored-by: Lukasz Klimek <[email protected]>
dashpay · Oct 9, 2024 · a646669 · a646669
1 parent de5236e
commit a646669
Show file tree

Hide file tree

Showing 36 changed files with 38 additions and 33 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/packages/rs-dapi-client/Cargo.toml b/packages/rs-dapi-client/Cargo.toml
@@ -5,6 +5,7 @@ edition = "2021"
 
 [features]
 default = ["mocks", "offline-testing"]
+tokio-sleep = ["backon/tokio-sleep"]
 mocks = [
     "dep:sha2",
     "dep:hex",
@@ -19,9 +20,7 @@ dump = ["mocks"]
 offline-testing = []
 
 [dependencies]
-backon = { version = "1.2", default-features = false, features = [
-    "tokio-sleep",
-] }
+backon = { version = "1.2"}
 dapi-grpc = { path = "../dapi-grpc", features = [
     "core",
     "platform",

diff --git a/packages/rs-drive-proof-verifier/src/proof.rs b/packages/rs-drive-proof-verifier/src/proof.rs
@@ -1379,7 +1379,7 @@ impl FromProof<platform::GetContestedResourcesRequest> for ContestedResources {
         verify_tenderdash_proof(proof, mtd, &root_hash, provider)?;
 
         let resources: ContestedResources =
-            items.into_iter().map(ContestedResource::Value).collect();
+            items.into_iter().map(|v| ContestedResource(v)).collect();
 
         Ok((resources.into_option(), mtd.clone(), proof.clone()))
     }

diff --git a/packages/rs-drive-proof-verifier/src/types.rs b/packages/rs-drive-proof-verifier/src/types.rs
@@ -224,11 +224,8 @@ pub struct ElementFetchRequestItem(pub Element);
 pub type IdentityBalanceAndRevision = (u64, Revision);
 
 /// Contested resource values.
-#[derive(Debug, derive_more::From, Clone, PartialEq)]
-pub enum ContestedResource {
-    /// Generic [Value]
-    Value(Value),
-}
+#[derive(Debug, Clone, PartialEq)]
+pub struct ContestedResource(pub Value);
 
 impl ContestedResource {
     /// Get the value.
@@ -244,13 +241,9 @@ impl ContestedResource {
     }
 }
 
-impl TryInto<Value> for ContestedResource {
-    type Error = crate::Error;
-
-    fn try_into(self) -> Result<Value, Self::Error> {
-        match self {
-            ContestedResource::Value(value) => Ok(value),
-        }
+impl Into<Value> for ContestedResource {
+    fn into(self) -> Value {
+        self.0
     }
 }
 
@@ -261,9 +254,7 @@ impl PlatformVersionEncode for ContestedResource {
         encoder: &mut E,
         _platform_version: &platform_version::PlatformVersion,
     ) -> Result<(), bincode::error::EncodeError> {
-        match self {
-            ContestedResource::Value(value) => value.encode(encoder),
-        }
+        self.0.encode(encoder)
     }
 }
 
@@ -273,7 +264,7 @@ impl PlatformVersionedDecode for ContestedResource {
         decoder: &mut D,
         _platform_version: &platform_version::PlatformVersion,
     ) -> Result<Self, bincode::error::DecodeError> {
-        Ok(ContestedResource::Value(Value::decode(decoder)?))
+        Ok(ContestedResource(Value::decode(decoder)?))
     }
 }
 

diff --git a/packages/rs-sdk/Cargo.toml b/packages/rs-sdk/Cargo.toml
@@ -57,6 +57,7 @@ test-case = { version = "3.3.1" }
 
 [features]
 default = ["mocks", "offline-testing"]
+tokio-sleep = ["rs-dapi-client/tokio-sleep"]
 
 mocks = [
   "dep:serde",

diff --git a/packages/rs-sdk/src/lib.rs b/packages/rs-sdk/src/lib.rs
@@ -76,6 +76,7 @@ pub use sdk::{RequestSettings, Sdk, SdkBuilder};
 pub use dashcore_rpc;
 pub use dpp;
 pub use drive;
+pub use drive_proof_verifier::types as query_types;
 pub use rs_dapi_client as dapi_client;
 
 /// Version of the SDK

diff --git a/packages/rs-sdk/tests/fetch/contested_resource.rs b/packages/rs-sdk/tests/fetch/contested_resource.rs
@@ -105,7 +105,7 @@ async fn contested_resources_start_at_value() {
         for inclusive in [true, false] {
             // when I set start_at_value to some value,
             for (i, start) in all.0.iter().enumerate() {
-                let ContestedResource::Value(start_value) = start.clone();
+                let ContestedResource(start_value) = start.clone();
 
                 let query = VotePollsByDocumentTypeQuery {
                     start_at_value: Some((start_value, inclusive)),
@@ -217,7 +217,7 @@ async fn contested_resources_limit_PLAN_656() {
                 );
             }
 
-            let ContestedResource::Value(last) =
+            let ContestedResource(last) =
                 rss.0.into_iter().last().expect("last contested resource");
             start_at_value = Some((last, false));
 
@@ -231,14 +231,14 @@ async fn contested_resources_limit_PLAN_656() {
 /// ## Preconditions
 ///
 /// None
-#[test_case::test_case(|_q| {}, Ok("ContestedResources([Value(Text(".into()); "unmodified base query is Ok")]
+#[test_case::test_case(|_q| {}, Ok("ContestedResources([ContestedResource(Text(".into()); "unmodified base query is Ok")]
 #[test_case::test_case(|q| q.start_index_values = vec![Value::Text("".to_string())], Ok("".into()); "index value empty string is Ok")]
 #[test_case::test_case(|q| q.document_type_name = "some random non-existing name".to_string(), Err(r#"code: InvalidArgument, message: "document type some random non-existing name not found"#); "non existing document type returns InvalidArgument")]
 #[test_case::test_case(|q| q.index_name = "nx index".to_string(), Err(r#"code: InvalidArgument, message: "index with name nx index is not the contested index"#); "non existing index returns InvalidArgument")]
 #[test_case::test_case(|q| q.index_name = "dashIdentityId".to_string(), Err(r#"code: InvalidArgument, message: "index with name dashIdentityId is not the contested index"#); "existing non-contested index returns InvalidArgument")]
 // Disabled due to bug PLAN-653
 // #[test_case::test_case(|q| q.start_at_value = Some((Value::Array(vec![]), true)), Err(r#"code: InvalidArgument"#); "start_at_value wrong index type returns InvalidArgument PLAN-653")]
-#[test_case::test_case(|q| q.start_index_values = vec![], Ok(r#"ContestedResources([Value(Text("dash"))])"#.into()); "start_index_values empty vec returns top-level keys")]
+#[test_case::test_case(|q| q.start_index_values = vec![], Ok(r#"ContestedResources([ContestedResource(Text("dash"))])"#.into()); "start_index_values empty vec returns top-level keys")]
 #[test_case::test_case(|q| q.start_index_values = vec![Value::Text("".to_string())], Ok(r#"ContestedResources([])"#.into()); "start_index_values empty string returns zero results")]
 #[test_case::test_case(|q| {
     q.start_index_values = vec![
@@ -249,7 +249,7 @@ async fn contested_resources_limit_PLAN_656() {
 #[test_case::test_case(|q| {
     q.start_index_values = vec![];
     q.end_index_values = vec![Value::Text(TEST_DPNS_NAME.to_string())];
-}, Ok(r#"ContestedResources([Value(Text("dash"))])"#.into()); "end_index_values one value with empty start_index_values returns 'dash'")]
+}, Ok(r#"ContestedResources([ContestedResource(Text("dash"))])"#.into()); "end_index_values one value with empty start_index_values returns 'dash'")]
 #[test_case::test_case(|q| {
     q.start_index_values = vec![];
     q.end_index_values = vec![Value::Text(TEST_DPNS_NAME.to_string()), Value::Text("non existing".to_string())];
@@ -278,7 +278,7 @@ async fn contested_resources_limit_PLAN_656() {
 }, Ok("ContestedResources([])".into()); "Non-existing end_index_values returns error")]
 #[test_case::test_case(|q| q.end_index_values = vec![Value::Array(vec![0.into(), 1.into()])], Err("incorrect index values error: too many end index values were provided"); "wrong type of end_index_values should return InvalidArgument")]
 #[test_case::test_case(|q| q.limit = Some(0), Err(r#"code: InvalidArgument"#); "limit 0 returns InvalidArgument")]
-#[test_case::test_case(|q| q.limit = Some(std::u16::MAX), Err(r#"code: InvalidArgument"#); "limit std::u16::MAX returns InvalidArgument")]
+#[test_case::test_case(|q| q.limit = Some(u16::MAX), Err(r#"code: InvalidArgument"#); "limit u16::MAX returns InvalidArgument")]
 // Disabled due to bug PLAN-656
 // #[test_case::test_case(|q| {
 //     q.start_index_values = vec![Value::Text("dash".to_string())];

diff --git a/...rceVoteStateRequest_aaaa80ce4fdfc75252132a85e6c12bea6a47c9f7bf30133713b6b5cfec3a4d57.json b/...rceVoteStateRequest_aaaa80ce4fdfc75252132a85e6c12bea6a47c9f7bf30133713b6b5cfec3a4d57.json
diff --git a/...tedResourcesRequest_8f71462d5f438e1b12fedf94ad5799af81392b7b0cbb7e86412da37ab13aef4b.json b/...tedResourcesRequest_8f71462d5f438e1b12fedf94ad5799af81392b7b0cbb7e86412da37ab13aef4b.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...s/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...s/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...s/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...s/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json
diff --git a/...tedResourcesRequest_25a3f1603510228a22726e0b4c35bce08c84a0cf72b34f6a408982f7babce2c2.json b/...tedResourcesRequest_25a3f1603510228a22726e0b4c35bce08c84a0cf72b34f6a408982f7babce2c2.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...4/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...4/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...4/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...4/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json
diff --git a/...tedResourcesRequest_80ba1d11caa6442b39ab0f05e7fd84b9984fd04a4ca40a146aea81c3ea5c39ef.json b/...tedResourcesRequest_80ba1d11caa6442b39ab0f05e7fd84b9984fd04a4ca40a146aea81c3ea5c39ef.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...3/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...3/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...3/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...3/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json
diff --git a/...tedResourcesRequest_5396ff2dd55051d854e18e406fbbfa6b1eff43954af904bce8f123fed7515132.json b/...tedResourcesRequest_5396ff2dd55051d854e18e406fbbfa6b1eff43954af904bce8f123fed7515132.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...0/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...0/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...0/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...0/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json
diff --git a/...tedResourcesRequest_f06ea270a508a9d9c386b8da170f67620695a23f63dc7376bd4a509e93335ce9.json b/...tedResourcesRequest_f06ea270a508a9d9c386b8da170f67620695a23f63dc7376bd4a509e93335ce9.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...7/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...7/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...7/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...7/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json
diff --git a/...tedResourcesRequest_c8608f7aed7bbe4ced03c9c23f1ce28a227def58e23c39e0384e0cc02fe6360b.json b/...tedResourcesRequest_c8608f7aed7bbe4ced03c9c23f1ce28a227def58e23c39e0384e0cc02fe6360b.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...f/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...f/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...f/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...f/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json
diff --git a/...tedResourcesRequest_7dd3b1061a019dac5fa1f385b8bd5387b9cca48a3062a4db8bf0341a839f2bae.json b/...tedResourcesRequest_7dd3b1061a019dac5fa1f385b8bd5387b9cca48a3062a4db8bf0341a839f2bae.json
diff --git a/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json b/...DataContractRequest_e87a2e6acef76975c30eb7272da71733fb6ad13495beb7ca1b6a6c4ceb30e0f7.json
diff --git a/...7/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json b/...7/quorum_pubkey-106-41ef25a6baff2c7a3cf388c77c826c1ffa6fb229b31c0802b1808d2c85dbc248.json
@@ -0,0 +1 @@
+9192c1fc0db514525cac97f9afc0bd811b64d9cfbe81c62afdc4568238bb27e72fa397498db6a0869b4ff55be912edc3
diff --git a/...7/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json b/...7/quorum_pubkey-106-74bc78bfed100cb1c7da3b1aeeaff1e5767efb0daf93c69cc8294ee246526a09.json