Trait FromProof 

pub trait FromProof<Req> {
    type Request;
    type Response;

    // Required method
    fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
        request: I,
        response: O,
        network: Network,
        platform_version: &PlatformVersion,
        provider: &'a dyn ContextProvider,
    ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>
       where Self: Sized + 'a;

    // Provided methods
    fn maybe_from_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
        request: I,
        response: O,
        network: Network,
        platform_version: &PlatformVersion,
        provider: &'a dyn ContextProvider,
    ) -> Result<Option<Self>, Error>
       where Self: Sized + 'a { ... }
    fn from_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
        request: I,
        response: O,
        network: Network,
        platform_version: &PlatformVersion,
        provider: &'a dyn ContextProvider,
    ) -> Result<Self, Error>
       where Self: Sized + 'a { ... }
    fn from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
        request: I,
        response: O,
        network: Network,
        platform_version: &PlatformVersion,
        provider: &'a dyn ContextProvider,
    ) -> Result<(Self, ResponseMetadata), Error>
       where Self: Sized + 'a { ... }
    fn from_proof_with_metadata_and_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>(
        request: I,
        response: O,
        network: Network,
        platform_version: &PlatformVersion,
        provider: &'a dyn ContextProvider,
    ) -> Result<(Self, ResponseMetadata, Proof), Error>
       where Self: Sized + 'a { ... }
}

Parse and verify the received proof and retrieve the requested object, if any.

Use FromProof::maybe_from_proof() or FromProof::from_proof() to parse and verify proofs received from the Dash Platform (including verification of grovedb-generated proofs and cryptographic proofs generated by Tenderdash).

gRPC responses, received from the Dash Platform in response to requests containing prove: true, contain GroveDB proof structure (including encapsulated objects) and metadata required to verify cryptographic proof generated by the Tenderdash. This trait provides methods that parse and verify the proof and retrieve the requested object (or information that the object does not exist) in one step.

This trait is implemented by several objects defined in Dash Platform Protocol, like [Identity], [DataContract], Documents, etc. It is also implemented by several helper objects from [types] module.

Required Associated Types

type Request

Request type for which this trait is implemented.

type Response

Response type for which this trait is implemented.

Required Methods

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

Arguments

• request: The request sent to the server.
• response: The response received from the server.
• network: The network we are using, Mainnet/Testnet/Devnet or Regtest
• platform_version: The platform version that should be used.
• provider: A callback implementing ContextProvider that provides quorum details required to verify the proof.

Returns

• Ok(Some((object, metadata))) when the requested object was found in the proof.
• Ok(None) when the requested object was not found in the proof; this can be interpreted as proof of non-existence. For collections, returns Ok(None) if none of the requested objects were found.
• Err(Error) when either the provided data is invalid or proof validation failed.

Provided Methods

fn maybe_from_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Option<Self>, Error>

where Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

Arguments

• request: The request sent to the server.
• response: The response received from the server.
• network: The network we are using, Mainnet/Testnet/Devnet or Regtest
• platform_version: The platform version that should be used.
• provider: A callback implementing ContextProvider that provides quorum details required to verify the proof.

Returns

• Ok(Some(object, metadata)) when the requested object was found in the proof.
• Ok(None) when the requested object was not found in the proof; this can be interpreted as proof of non-existence. For collections, returns Ok(None) if none of the requested objects were found.
• Err(Error) when either the provided data is invalid or proof validation failed.

fn from_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Self, Error>

where Self: Sized + 'a,

Retrieve the requested object from the proof.

Runs full verification of the proof and retrieves enclosed objects.

This method uses FromProof::maybe_from_proof() internally and throws an error if the requested object does not exist in the proof.

Arguments

• request: The request sent to the server.
• response: The response received from the server.
• network: The network we are using, Mainnet/Testnet/Devnet or Regtest
• platform_version: The platform version that should be used.
• provider: A callback implementing ContextProvider that provides quorum details required to verify the proof.

Returns

• Ok(object) when the requested object was found in the proof.
• Err(Error::DocumentMissingInProof) when the requested object was not found in the proof.
• Err(Error) when either the provided data is invalid or proof validation failed.

fn from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata), Error>

where Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

Runs full verification of the proof and retrieves enclosed objects.

This method uses FromProof::maybe_from_proof_with_metadata() internally and throws an error if the requested object does not exist in the proof.

Arguments

• request: The request sent to the server.
• response: The response received from the server.
• network: The network we are using, Mainnet/Testnet/Devnet or Regtest
• platform_version: The platform version that should be used.
• provider: A callback implementing ContextProvider that provides quorum details required to verify the proof.

Returns

• Ok(Some(object, metadata)) when the requested object was found in the proof.
• Err(Error::DocumentMissingInProof) when the requested object was not found in the proof.
• Err(Error) when either the provided data is invalid or proof validation failed.

fn from_proof_with_metadata_and_proof<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

Runs full verification of the proof and retrieves enclosed objects.

This method uses FromProof::maybe_from_proof_with_metadata() internally and throws an error if the requested object does not exist in the proof.

Arguments

• request: The request sent to the server.
• response: The response received from the server.
• network: The network we are using, Mainnet/Testnet/Devnet or Regtest
• platform_version: The platform version that should be used.
• provider: A callback implementing ContextProvider that provides quorum details required to verify the proof.

Returns

• Ok(Some(object, metadata, proof)) when the requested object was found in the proof.
• Err(Error::DocumentMissingInProof) when the requested object was not found in the proof.
• Err(Error) when either the provided data is invalid or proof validation failed.

Implementations on Foreign Types

impl FromProof<BroadcastStateTransitionRequest> for StateTransitionProofResult

type Request = BroadcastStateTransitionRequest

type Response = WaitForStateTransitionResultResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

impl FromProof<GetAddressesTrunkStateRequest> for GroveTrunkQueryResult

type Request = GetAddressesTrunkStateRequest

type Response = GetAddressesTrunkStateResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( _request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where GroveTrunkQueryResult: 'a,

impl FromProof<GetContestedResourceIdentityVotesRequest> for Vote

type Request = GetContestedResourceIdentityVotesRequest

type Response = GetContestedResourceIdentityVotesResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

impl FromProof<GetDataContractRequest> for (DataContract, Vec<u8>)

type Request = GetDataContractRequest

type Response = GetDataContractResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where DataContract: 'a,

impl FromProof<GetDataContractRequest> for DataContract

type Request = GetDataContractRequest

type Response = GetDataContractResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where DataContract: 'a,

impl FromProof<GetEpochsInfoRequest> for ExtendedEpochInfo

type Request = GetEpochsInfoRequest

type Response = GetEpochsInfoResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

impl FromProof<GetGroupInfoRequest> for Group

type Request = GetGroupInfoRequest

type Response = GetGroupInfoResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

impl FromProof<GetIdentitiesContractKeysRequest> for IdentitiesContractKeys

type Request = GetIdentitiesContractKeysRequest

type Response = GetIdentitiesContractKeysResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: 'a,

impl FromProof<GetIdentityByNonUniquePublicKeyHashRequest> for Identity

type Request = GetIdentityByNonUniquePublicKeyHashRequest

type Response = GetIdentityByNonUniquePublicKeyHashResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

impl FromProof<GetIdentityByPublicKeyHashRequest> for Identity

type Request = GetIdentityByPublicKeyHashRequest

type Response = GetIdentityByPublicKeyHashResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Identity: 'a,

impl FromProof<GetIdentityRequest> for Identity

type Request = GetIdentityRequest

type Response = GetIdentityResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Identity: Sized + 'a,

impl FromProof<GetTokenContractInfoRequest> for TokenContractInfo

type Request = GetTokenContractInfoRequest

type Response = GetTokenContractInfoResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

impl FromProof<GetTokenPerpetualDistributionLastClaimRequest> for RewardDistributionMoment

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

Parse & verify the last‑claim proof returned by Platform.

type Request = GetTokenPerpetualDistributionLastClaimRequest

type Response = GetTokenPerpetualDistributionLastClaimResponse

impl FromProof<GetTokenTotalSupplyRequest> for TotalSingleTokenBalance

type Request = GetTokenTotalSupplyRequest

type Response = GetTokenTotalSupplyResponse

fn maybe_from_proof_with_metadata<'a, I: Into<Self::Request>, O: Into<Self::Response>>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Self>, ResponseMetadata, Proof), Error>

where Self: Sized + 'a,

Implementors

impl FromProof<GetAddressInfoRequest> for AddressInfo

type Request = GetAddressInfoRequest

type Response = GetAddressInfoResponse

impl FromProof<GetAddressesInfosRequest> for AddressInfos

type Request = GetAddressesInfosRequest

type Response = GetAddressesInfosResponse

impl FromProof<GetAddressesTrunkStateRequest> for PlatformAddressTrunkState

type Request = GetAddressesTrunkStateRequest

type Response = GetAddressesTrunkStateResponse

impl FromProof<GetContestedResourceIdentityVotesRequest> for ResourceVotesByIdentity

type Request = GetContestedResourceIdentityVotesRequest

type Response = GetContestedResourceIdentityVotesResponse

impl FromProof<GetContestedResourceVoteStateRequest> for Contenders

type Request = GetContestedResourceVoteStateRequest

type Response = GetContestedResourceVoteStateResponse

impl FromProof<GetContestedResourceVotersForIdentityRequest> for Voters

type Request = GetContestedResourceVotersForIdentityRequest

type Response = GetContestedResourceVotersForIdentityResponse

impl FromProof<GetContestedResourcesRequest> for ContestedResources

type Request = GetContestedResourcesRequest

type Response = GetContestedResourcesResponse

impl FromProof<GetDataContractHistoryRequest> for DataContractHistory

type Request = GetDataContractHistoryRequest

type Response = GetDataContractHistoryResponse

impl FromProof<GetDataContractsRequest> for DataContracts

type Request = GetDataContractsRequest

type Response = GetDataContractsResponse

impl FromProof<GetDocumentHistoryRequest> for DocumentHistory

type Request = GetDocumentHistoryRequest

type Response = GetDocumentHistoryResponse

impl FromProof<GetEpochsInfoRequest> for ExtendedEpochInfos

type Request = GetEpochsInfoRequest

type Response = GetEpochsInfoResponse

impl FromProof<GetEvonodesProposedEpochBlocksByIdsRequest> for ProposerBlockCounts

type Request = GetEvonodesProposedEpochBlocksByIdsRequest

type Response = GetEvonodesProposedEpochBlocksResponse

impl FromProof<GetEvonodesProposedEpochBlocksByRangeRequest> for ProposerBlockCounts

type Request = GetEvonodesProposedEpochBlocksByRangeRequest

type Response = GetEvonodesProposedEpochBlocksResponse

impl FromProof<GetFinalizedEpochInfosRequest> for FinalizedEpochInfos

type Request = GetFinalizedEpochInfosRequest

type Response = GetFinalizedEpochInfosResponse

impl FromProof<GetGroupActionSignersRequest> for GroupActionSigners

type Request = GetGroupActionSignersRequest

type Response = GetGroupActionSignersResponse

impl FromProof<GetGroupActionsRequest> for GroupActions

type Request = GetGroupActionsRequest

type Response = GetGroupActionsResponse

impl FromProof<GetGroupInfosRequest> for Groups

type Request = GetGroupInfosRequest

type Response = GetGroupInfosResponse

impl FromProof<GetIdentitiesBalancesRequest> for IdentityBalances

type Request = GetIdentitiesBalancesRequest

type Response = GetIdentitiesBalancesResponse

impl FromProof<GetIdentitiesTokenBalancesRequest> for IdentitiesTokenBalances

type Request = GetIdentitiesTokenBalancesRequest

type Response = GetIdentitiesTokenBalancesResponse

impl FromProof<GetIdentitiesTokenInfosRequest> for IdentitiesTokenInfos

type Request = GetIdentitiesTokenInfosRequest

type Response = GetIdentitiesTokenInfosResponse

impl FromProof<GetIdentityBalanceAndRevisionRequest> for IdentityBalanceAndRevision

type Request = GetIdentityBalanceAndRevisionRequest

type Response = GetIdentityBalanceAndRevisionResponse

impl FromProof<GetIdentityBalanceRequest> for IdentityBalance

type Request = GetIdentityBalanceRequest

type Response = GetIdentityBalanceResponse

impl FromProof<GetIdentityContractNonceRequest> for IdentityContractNonceFetcher

type Request = GetIdentityContractNonceRequest

type Response = GetIdentityContractNonceResponse

impl FromProof<GetIdentityKeysRequest> for IdentityPublicKeys

type Request = GetIdentityKeysRequest

type Response = GetIdentityKeysResponse

impl FromProof<GetIdentityNonceRequest> for IdentityNonceFetcher

type Request = GetIdentityNonceRequest

type Response = GetIdentityNonceResponse

impl FromProof<GetIdentityTokenBalancesRequest> for IdentityTokenBalances

type Request = GetIdentityTokenBalancesRequest

type Response = GetIdentityTokenBalancesResponse

impl FromProof<GetIdentityTokenInfosRequest> for IdentityTokenInfos

type Request = GetIdentityTokenInfosRequest

type Response = GetIdentityTokenInfosResponse

impl FromProof<GetMostRecentShieldedAnchorRequest> for MostRecentShieldedAnchor

type Request = GetMostRecentShieldedAnchorRequest

type Response = GetMostRecentShieldedAnchorResponse

impl FromProof<GetPathElementsRequest> for Elements

type Request = GetPathElementsRequest

type Response = GetPathElementsResponse

impl FromProof<GetPrefundedSpecializedBalanceRequest> for PrefundedSpecializedBalance

type Request = GetPrefundedSpecializedBalanceRequest

type Response = GetPrefundedSpecializedBalanceResponse

impl FromProof<GetProtocolVersionUpgradeStateRequest> for ProtocolVersionUpgrades

type Request = GetProtocolVersionUpgradeStateRequest

type Response = GetProtocolVersionUpgradeStateResponse

impl FromProof<GetProtocolVersionUpgradeVoteStatusRequest> for MasternodeProtocolVotes

type Request = GetProtocolVersionUpgradeVoteStatusRequest

type Response = GetProtocolVersionUpgradeVoteStatusResponse

impl FromProof<GetRecentAddressBalanceChangesRequest> for RecentAddressBalanceChanges

type Request = GetRecentAddressBalanceChangesRequest

type Response = GetRecentAddressBalanceChangesResponse

impl FromProof<GetRecentCompactedAddressBalanceChangesRequest> for RecentCompactedAddressBalanceChanges

type Request = GetRecentCompactedAddressBalanceChangesRequest

type Response = GetRecentCompactedAddressBalanceChangesResponse

impl FromProof<GetShieldedAnchorsRequest> for ShieldedAnchors

type Request = GetShieldedAnchorsRequest

type Response = GetShieldedAnchorsResponse

impl FromProof<GetShieldedEncryptedNotesRequest> for ShieldedEncryptedNotes

type Request = GetShieldedEncryptedNotesRequest

type Response = GetShieldedEncryptedNotesResponse

impl FromProof<GetShieldedNotesCountRequest> for ShieldedNotesCount

type Request = GetShieldedNotesCountRequest

type Response = GetShieldedNotesCountResponse

impl FromProof<GetShieldedNullifiersRequest> for ShieldedNullifierStatuses

type Request = GetShieldedNullifiersRequest

type Response = GetShieldedNullifiersResponse

impl FromProof<GetShieldedPoolStateRequest> for ShieldedPoolState

type Request = GetShieldedPoolStateRequest

type Response = GetShieldedPoolStateResponse

impl FromProof<GetTokenDirectPurchasePricesRequest> for TokenDirectPurchasePrices

type Request = GetTokenDirectPurchasePricesRequest

type Response = GetTokenDirectPurchasePricesResponse

impl FromProof<GetTokenPreProgrammedDistributionsRequest> for TokenPreProgrammedDistributions

type Request = GetTokenPreProgrammedDistributionsRequest

type Response = GetTokenPreProgrammedDistributionsResponse

impl FromProof<GetTokenStatusesRequest> for TokenStatuses

type Request = GetTokenStatusesRequest

type Response = GetTokenStatusesResponse

impl FromProof<GetTotalCreditsInPlatformRequest> for TotalCreditsInPlatform

type Request = GetTotalCreditsInPlatformRequest

type Response = GetTotalCreditsInPlatformResponse

impl FromProof<GetVotePollsByEndDateRequest> for VotePollsGroupedByTimestamp

type Request = GetVotePollsByEndDateRequest

type Response = GetVotePollsByEndDateResponse

impl<'dq, Q> FromProof<Q> for DocumentCount

where Q: TryInto<DriveDocumentQuery<'dq>> + Clone + 'dq, Q::Error: Display,

type Request = Q

type Response = GetDocumentsResponse

impl<'dq, Q> FromProof<Q> for DocumentSplitCounts

where Q: TryInto<DriveDocumentQuery<'dq>> + Clone + 'dq, Q::Error: Display,

Reject the generic FromProof entry point for DocumentSplitCounts.

DocumentSplitCounts is reached from rs-sdk via the FromProof<DocumentQuery> impl defined alongside the SDK’s DocumentQuery type (see rs-sdk/src/platform/documents/document_count.rs), which dispatches to the right proof shape (CountTree element / aggregate-count / distinct-count) based on (group_by, where_clauses, prove). The generic FromProof<Q: TryInto<DriveDocumentQuery>> path doesn’t carry enough information to pick a proof shape, so it errors out explicitly — calling this impl directly is a programmer mistake.

type Request = Q

type Response = GetDocumentsResponse

impl<'dq, Q> FromProof<Q> for Documents

where Q: TryInto<DriveDocumentQuery<'dq>> + Clone + 'dq, Q::Error: Display,

type Request = Q

type Response = GetDocumentsResponse