Enum Error 

pub enum Error {
    Config(String),
    InvalidRequest(String),
    Drive(Error),
    DriveProofError(ProofError, Vec<u8>, BlockInfo),
    Protocol(ProtocolError),
    Proof(Error),
    InvalidProvedResponse(String),
    ExecutionNotProved(String),
    DapiClientError(DapiClientError),
    DapiMocksError(MockError),
    CoreError(Error),
    MerkleBlockError(MerkleBlockError),
    CoreClientError(Error),
    MissingDependency(String, String),
    TotalCreditsNotFound,
    EpochNotFound,
    TimeoutReached(Duration, String),
    AlreadyExists(String),
    InvalidCreditTransfer(String),
    NonceOverflow(u64),
    IdentityNonceNotFound(String),
    DriveInternalError(String),
    Generic(String),
    ContextProviderError(ContextProviderError),
    Cancelled(String),
    StaleNode(StaleNodeError),
    StateTransitionBroadcastError(StateTransitionBroadcastError),
    NoAvailableAddressesToRetry(Box<Error>),
    EncryptedFor(EncryptedForError),
    ProtocolVersionNotActive {
        method: &'static str,
        required: u32,
        network: u32,
        pinned: bool,
        cause: Option<Box<Error>>,
    },
}

Error type for the SDK

Variants

Config(String)

SDK is not configured properly

InvalidRequest(String)

The request cannot succeed as written on any node: the SDK refused it before sending it, because no node serves it or no answer to it verifies as the requested result type, or a fresh verified answer showed that the result cannot be returned as that type (for example several documents for a single-document fetch).

Every honest node answers it alike, so the SDK neither retries it on another node nor bans the node that answered. The request has to change. A node’s own refusal of a request (an INVALID_ARGUMENT status) stays an Error::DapiClientError.

Drive(Error)

Drive error

DriveProofError(ProofError, Vec<u8>, BlockInfo)

Drive proof error with associated proof bytes and block info

Protocol(ProtocolError)

DPP error

Proof(Error)

Proof verification error

InvalidProvedResponse(String)

Invalid Proved Response error

ExecutionNotProved(String)

The proof authenticated only the state the transition affects (a height-pinned snapshot), while the caller required evidence that this specific transition executed. Use the *_affected_state wait APIs to accept snapshot outcomes explicitly.

DapiClientError(DapiClientError)

DAPI client error, for example, connection error

DapiMocksError(MockError)

DAPI mocks error

CoreError(Error)

Dash core error

MerkleBlockError(MerkleBlockError)

MerkleBlockError

CoreClientError(Error)

Core client error, for example, connection error

MissingDependency(String, String)

Dependency not found, for example data contract for a document not found

TotalCreditsNotFound

Total credits in Platform are not found; we must always have credits in Platform

EpochNotFound

Epoch not found; we must have at least one epoch

TimeoutReached(Duration, String)

SDK operation timeout reached error

AlreadyExists(String)

Returned when an attempt is made to create an object that already exists in the system

InvalidCreditTransfer(String)

Invalid credit transfer configuration

NonceOverflow(u64)

Identity nonce overflow: the nonce has reached its maximum value and cannot be incremented further without wrapping to zero.

IdentityNonceNotFound(String)

Identity nonce not found on Platform.

Platform returned no nonce for the requested identity (or identity– contract pair). This usually means the queried DAPI node has not yet indexed the identity — for example right after identity creation or when the node is lagging behind the chain tip.

Recovery: retry the state transition; the SDK will re-fetch the nonce from a (potentially different) DAPI node on the next attempt.

DriveInternalError(String)

Drive returned an internal error that is not a consensus error.

Contains the decoded human-readable message extracted from the drive-error-data-bin gRPC metadata (CBOR map, message field). Typically a storage-level failure (e.g., GroveDB constraint violation).

Generic(String)

Generic error

ContextProviderError(ContextProviderError)

Context provider error

Cancelled(String)

Operation cancelled - cancel token was triggered, timeout, etc.

StaleNode(StaleNodeError)

Remote node is stale; try another server

StateTransitionBroadcastError(StateTransitionBroadcastError)

Error returned when trying to broadcast a state transition

NoAvailableAddressesToRetry(Box<Error>)

All available addresses have been exhausted (banned due to errors). Contains the last meaningful error that caused addresses to be banned.

EncryptedFor(EncryptedForError)

A property declared encryptedFor could not be encrypted or decrypted

ProtocolVersionNotActive

The request uses a feature that not every node of the network serves yet, so the SDK refused it without sending it: nodes of an older release would answer UNIMPLEMENTED or a different question, and get banned for it.

Retrying another node cannot help. The same request succeeds once a verified answer shows the network runs required, and this SDK’s own version is at least required. See TransportRequest::needs_protocol_version.

Fields

method: &'static str

gRPC method of the refused request, e.g. get_contract_fee_pots.

required: u32

Protocol version from which every node serves the request.

network: u32

Protocol version the SDK could rely on: the lower of its own version and the newest version a verified answer was signed with; 0 before any verified answer.

pinned: bool

Whether the SDK is pinned to a version below required (SdkBuilder::with_version): then no answer can lift the refusal, whatever the network runs.

cause: Option<Box<Error>>

Why the network’s version could not be confirmed, when a query for it failed. The refusal may then be transient.

Implementations

impl Error

pub fn is_transient_protocol_version_refusal(&self) -> bool

Whether this is an Error::ProtocolVersionNotActive refusal that may lift soon: the SDK could not learn the network’s version for a reason that can pass, such as nodes or a quorum source not answering, so the network may serve the request already.

False for any other error, for a refusal the network’s verified version explains, and for one caused by this SDK’s own setup: no context provider, or one configured so that it cannot give quorum keys at all (ContextProviderError::Config). Retrying cannot change those. A provider’s other failures, such as a quorum service not answering, may pass.

pub fn is_quorum_source_unavailable(&self) -> bool

Whether this error is a trusted quorum-source failure, looking through nested retry-exhaustion wrappers. This is distinct from [CanRetry::can_retry] and does not affect node-ban attribution.

pub fn consensus_error(&self) -> Option<&ConsensusError>

The consensus verdict this error carries, from the shapes that can carry one: StateTransitionBroadcastError (wait-stream), Protocol(ConsensusError) (CheckTx), and the dapi-client’s exhausted-retry envelope, which it recurses into. Re-audit when this enum gains another consensus-carrying variant.

Trait Implementations

impl CanRetry for Error

fn can_retry(&self) -> bool

Returns true if the operation can be retried safely.

fn is_no_available_addresses(&self) -> bool

Returns true if this error represents a “no available addresses” condition.

fn rate_limit_ban_duration(&self) -> Option<Duration>

If this error is a gRPC ResourceExhausted (Envoy rate-limit) that carries a RateLimit-Reset metadata header, returns the server-advertised ban duration (clamped to a safe range). Returns None for all other errors and for rate-limit errors that carry no usable header (the caller falls back to the normal exponential ban ladder in that case).

fn is_node_failure(&self) -> bool

👎Deprecated:

Use !can_retry() instead

Get boolean flag that indicates if the error is retryable.

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AddressDoesNotExistError> for Error

fn from(value: AddressDoesNotExistError) -> Self

Converts to this type from the input type.

impl From<AddressNotEnoughFundsError> for Error

fn from(value: AddressNotEnoughFundsError) -> Self

Converts to this type from the input type.

impl From<AsyncError> for Error

fn from(error: AsyncError) -> Self

Converts to this type from the input type.

impl From<ConsensusError> for Error

fn from(value: ConsensusError) -> Self

Converts to this type from the input type.

impl From<ContextProviderError> for Error

fn from(source: ContextProviderError) -> Self

Converts to this type from the input type.

impl From<DapiClientError> for Error

fn from(value: DapiClientError) -> Self

Converts to this type from the input type.

impl From<EncryptedForError> for Error

fn from(source: EncryptedForError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

A trusted source outage is not the responding node’s fault. Preserve that attribution and quorum context. A verified result no node can return as the requested type is the request’s to change (Error::InvalidRequest); every other verifier failure stays Proof.

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for InvitationError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl<T> From<ExecutionError<T>> for Error

where ExecutionError<T>: ToString,

fn from(value: ExecutionError<T>) -> Self

Converts to this type from the input type.

impl From<MerkleBlockError> for Error

fn from(source: MerkleBlockError) -> Self

Converts to this type from the input type.

impl From<MockError> for Error

fn from(source: MockError) -> Self

Converts to this type from the input type.

impl From<OutputBelowMinimumError> for Error

fn from(value: OutputBelowMinimumError) -> Self

Converts to this type from the input type.

impl From<PlatformVersionError> for Error

fn from(value: PlatformVersionError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for Error

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.

impl From<StaleNodeError> for Error

fn from(source: StaleNodeError) -> Self

Converts to this type from the input type.

impl From<StateTransitionBroadcastError> for Error

fn from(source: StateTransitionBroadcastError) -> Self

Converts to this type from the input type.

impl From<StateTransitionMaxSizeExceededError> for Error

fn from(value: StateTransitionMaxSizeExceededError) -> Self

Converts to this type from the input type.

impl From<TransitionNoInputsError> for Error

fn from(value: TransitionNoInputsError) -> Self

Converts to this type from the input type.

impl From<TransitionNoOutputsError> for Error

fn from(value: TransitionNoOutputsError) -> Self

Converts to this type from the input type.

impl From<ValidationResult<(), ConsensusError>> for Error

fn from(value: SimpleConsensusValidationResult) -> Self

Converts to this type from the input type.