Skip to main content

dash_platform_queries/documents/
document_split_sums.rs

1//! `FromProof` + `Fetch` for [`DocumentSplitSums`] — the
2//! per-group-entry view of the unified `getDocuments` endpoint
3//! for sum queries.
4//!
5//! Sum-side analog of [`super::document_split_counts`]. Returns
6//! the full `entries` list (keyed by the splitting property's
7//! serialized value); aggregate sums use
8//! [`super::document_sum::DocumentSum`] instead.
9//!
10//! Per-shape proof dispatch lives in
11//! [`super::sum_proof_helpers::verify_sum_query`] — this impl
12//! passes the verified entries through unchanged, mapping
13//! `SumEntry` to `SplitSumEntry`.
14
15use crate::documents::document_query::DocumentQuery;
16use crate::documents::sum_proof_helpers::{
17    assert_select_is_sum, check_sum_request, verify_sum_query,
18};
19use dapi_grpc::platform::v0::{GetDocumentsResponse, Proof, ResponseMetadata};
20use dash_context_provider::ContextProvider;
21use dpp::dashcore::Network;
22use dpp::version::PlatformVersion;
23use drive_proof_verifier::{DocumentSplitSums, FromProof, SplitSumEntry};
24
25impl FromProof<DocumentQuery> for DocumentSplitSums {
26    type Request = DocumentQuery;
27    type Response = GetDocumentsResponse;
28
29    fn check_request(
30        request: &Self::Request,
31        platform_version: &PlatformVersion,
32    ) -> Result<(), drive_proof_verifier::Error> {
33        check_sum_request(request, false, platform_version)
34    }
35
36    fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
37        request: I,
38        response: O,
39        _network: Network,
40        platform_version: &PlatformVersion,
41        provider: &'a dyn ContextProvider,
42    ) -> Result<(Option<Self>, ResponseMetadata, Proof), drive_proof_verifier::Error>
43    where
44        Self: 'a,
45    {
46        let request: Self::Request = request.into();
47        assert_select_is_sum(&request)?;
48        let response: Self::Response = response.into();
49        let (entries, mtd, proof) =
50            verify_sum_query(request, response, false, platform_version, provider)?;
51        let split = entries.map(|es| {
52            DocumentSplitSums(
53                es.into_iter()
54                    .map(|e| SplitSumEntry {
55                        in_key: e.in_key,
56                        key: e.key,
57                        sum: e.sum,
58                    })
59                    .collect(),
60            )
61        });
62        Ok((split, mtd, proof))
63    }
64}