Enum WalletKitError 

pub enum WalletKitError {
    InvalidInput {
        attribute: String,
        reason: String,
    },
    InvalidNumber,
    SerializationError {
        error: String,
    },
    NetworkError {
        url: String,
        error: String,
        status: Option<u16>,
    },
    Reqwest {
        error: String,
    },
    ProofGeneration {
        error: String,
    },
    SemaphoreNotEnabled,
    CredentialNotIssued,
    CredentialNotMined,
    AccountDoesNotExist,
    UnauthorizedAuthenticator,
    AuthenticatorError {
        error: String,
    },
    UnfulfillableRequest,
    ResponseValidation(String),
    NullifierReplay,
    InvalidRpSignature,
    DuplicateNonce,
    UnknownRp,
    InactiveRp,
    TimestampTooOld,
    TimestampTooFarInFuture,
    InvalidTimestamp,
    RpSignatureExpired,
    Groth16MaterialCacheInvalid {
        path: String,
        error: String,
    },
    Groth16MaterialEmbeddedLoad {
        error: String,
    },
    Generic {
        error: String,
    },
    RecoveryBindingDoesNotExist,
    SessionIdMismatch,
    NfcNonRetryable {
        error_code: String,
    },
    DebugReportNotFound,
    NotEligibleForRecovery,
    OhttpError {
        error: String,
    },
    InvalidActionSession,
}

Error outputs from WalletKit

Variants

InvalidInput

Invalid input provided (e.g., incorrect length, format, etc.)

Fields

attribute: String

The attribute that is invalid

reason: String

The reason the input is invalid

InvalidNumber

The presented data is not a valid U256 integer

SerializationError

Unexpected error serializing information

Fields

error: String

The error message from the serialization

NetworkError

Network connection error with details

Fields

url: String

The URL of the request

error: String

The error message from the request

status: Option<u16>

The HTTP status code of the request, if available

Reqwest

HTTP request failure

Fields

error: String

The error message from the request

ProofGeneration

Unhandled error generating a Zero-Knowledge Proof

Fields

error: String

The error message from the proof generation

SemaphoreNotEnabled

The semaphore feature flag is not enabled

CredentialNotIssued

The requested credential is not issued for this World ID

CredentialNotMined

The requested credential has not been submitted on-chain

AccountDoesNotExist

This operation requires a registered account and an account is not registered for this authenticator. Call create_account first to register it.

UnauthorizedAuthenticator

The public key was not found in the batch, i.e. the authenticator is not authorized to sign for this action

AuthenticatorError

An unexpected error occurred with the Authenticator

Fields

error: String

The error message from the authenticator

UnfulfillableRequest

The request could not be fulfilled with the credentials the user has available

ResponseValidation(String)

The response generated didn’t match the request

This occurs if the response doesn’t match the requested proofs - e.g. by ids or doesn’t satisfy the contraints declared in the request

NullifierReplay

The generated nullifier has already been used in a proof submission and cannot be used again

InvalidRpSignature

The RP’s signature on the proof request could not be verified.

DuplicateNonce

The RP reused a signature nonce.

UnknownRp

The RP is unknown to the World ID registry.

InactiveRp

The RP is inactive and cannot request proofs.

TimestampTooOld

The RP’s request timestamp is too old.

TimestampTooFarInFuture

The RP’s request timestamp is too far in the future.

InvalidTimestamp

The RP’s request timestamp could not be parsed.

RpSignatureExpired

The RP’s signature has expired.

Groth16MaterialCacheInvalid

Cached Groth16 material could not be parsed or verified.

Fields

path: String

Input path(s) used for loading.

error: String

Underlying error message.

Groth16MaterialEmbeddedLoad

Failed to load embedded Groth16 material.

Fields

error: String

Underlying error message.

Generic

An unexpected error occurred

Fields

error: String

The details of the error

RecoveryBindingDoesNotExist

The recovery binding does not exist

SessionIdMismatch

The session ID computed for this proof does not match the expected session ID from the proof request.

This indicates the session_id provided by the RP is invalid or compromised, as the only other failure option is OPRFs not having performed correct computations.

NfcNonRetryable

The NFC uniqueness service rejected the request with a permanent error that will not resolve on retry (e.g. expired document).

Fields

error_code: String

The error code from the NFC service (e.g. document_expired)

DebugReportNotFound

The debug report was not found

NotEligibleForRecovery

The user is not eligible for recovery

OhttpError

An error occurred in the OHTTP privacy layer (relay, encapsulation, or framing).

Fields

error: String

The error message from the OHTTP layer

InvalidActionSession

The session proof action or session OPRF seed is not valid for the session OPRF module.

Trait Implementations

impl<UT> ConvertError<UT> for WalletKitError

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for WalletKitError

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

Formats the value using the given formatter.

impl Display for WalletKitError

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

Formats the value using the given formatter.

impl Error for WalletKitError

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<UT> FfiConverter<UT> for WalletKitError

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<AuthenticatorError> for WalletKitError

fn from(error: AuthenticatorError) -> Self

Converts to this type from the input type.

impl From<Error> for WalletKitError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<PrimitiveError> for WalletKitError

fn from(error: PrimitiveError) -> Self

Converts to this type from the input type.

impl From<ProofError> for WalletKitError

fn from(error: ProofError) -> Self

Converts to this type from the input type.

impl From<StorageError> for WalletKitError

fn from(error: StorageError) -> Self

Converts to this type from the input type.

impl From<WorldIdRequestAuthError> for WalletKitError

fn from(error: WorldIdRequestAuthError) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for WalletKitError

type FfiType = <WalletKitError as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for WalletKitError

type LiftType = WalletKitError

impl<UT> LiftReturn<UT> for WalletKitError

type ReturnType = <WalletKitError as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for WalletKitError

type FfiType = <WalletKitError as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for WalletKitError

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for WalletKitError

type ReturnType = <WalletKitError as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for WalletKitError

const TYPE_ID_META: MetadataBuffer