Enum SqliteClientError 

#[non_exhaustive]
pub enum SqliteClientError {
    CorruptedData(String),
    Protobuf(DecodeError),
    InvalidNote,
    TableNotEmpty,
    DecodingError(ParseError),
    TransparentDerivation(Error),
    TransparentAddress(TransparentCodecError),
    DbError(Error),
    Io(Error),
    InvalidMemo(Error),
    BlockConflict(BlockHeight),
    NonSequentialBlocks,
    RequestedRewindInvalid {
        safe_rewind_height: Option<BlockHeight>,
        requested_height: BlockHeight,
    },
    AddressGeneration(AddressGenerationError),
    AccountUnknown,
    AccountCollision(AccountUuid),
    UnknownZip32Derivation,
    KeyDerivationError(AccountId),
    BadAccountData(String),
    Zip32AccountIndexOutOfRange,
    AddressNotRecognized(TransparentAddress),
    CommitmentTree(ShardTreeError<Error>),
    PutBlocksCommitmentTree {
        pool: ShieldedPool,
        block_range: Range<BlockHeight>,
        error: ShardTreeError<Error>,
    },
    TruncateCommitmentTree {
        pool: ShieldedPool,
        height: BlockHeight,
        error: ShardTreeError<Error>,
    },
    CacheMiss(BlockHeight),
    ChainHeightUnknown,
    UnsupportedPoolType(PoolType),
    BalanceError(BalanceError),
    NoteFilterInvalid(NoteFilter),
    ReachedGapLimit(TransparentKeyScope, u32),
    DiversifierIndexReuse(DiversifierIndex, Box<UnifiedAddress>),
    AddressReuse(String, NonEmpty<TxId>),
    IneligibleNotes,
    Scheduling(SchedulingError),
    NotificationMismatch {
        expected: BlockHeight,
        actual: BlockHeight,
    },
    FeeRuleError(Box<dyn Error + Send + Sync>),
    BackendError(BackendError),
}

The primary error type for the SQLite wallet backend.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CorruptedData(String)

Decoding of a stored value from its serialized form has failed.

Protobuf(DecodeError)

An error occurred decoding a protobuf message.

InvalidNote

The rcm value for a note cannot be decoded to a valid JubJub point.

TableNotEmpty

Illegal attempt to reinitialize an already-initialized wallet database.

DecodingError(ParseError)

A Zcash key or address decoding error

TransparentDerivation(Error)

Available on crate feature transparent-inputs only.

An error produced in legacy transparent address derivation

TransparentAddress(TransparentCodecError)

Available on crate feature transparent-inputs only.

An error encountered in decoding a transparent address from its serialized form.

DbError(Error)

Wrapper for rusqlite errors.

Io(Error)

Wrapper for errors from the IO subsystem

InvalidMemo(Error)

A received memo cannot be interpreted as a UTF-8 string.

BlockConflict(BlockHeight)

An attempt to update block data would overwrite the current hash for a block with a different hash. This indicates that a required rewind was not performed.

NonSequentialBlocks

A range of blocks provided to the database as a unit was non-sequential

RequestedRewindInvalid

A requested rewind would violate invariants of the storage layer. The payload returned with this error is (safe rewind height, requested height). If no safe rewind height can be determined, the safe rewind height member will be None.

Fields

safe_rewind_height: Option<BlockHeight>

The height to which it is possible to safely rewind, or None if no safe rewind height could be determined.

requested_height: BlockHeight

The block height that was requested for the rewind.

AddressGeneration(AddressGenerationError)

An error occurred in generating a Zcash address.

AccountUnknown

The account for which information was requested does not belong to the wallet.

AccountCollision(AccountUuid)

The account being added collides with an existing account in the wallet with the given ID. The collision can be on the seed and ZIP-32 account index, or a shared IVK component.

UnknownZip32Derivation

The account was imported, and ZIP-32 derivation information is not known for it.

KeyDerivationError(AccountId)

An error occurred deriving a spending key from a seed and a ZIP-32 account index.

BadAccountData(String)

An error occurred while processing an account due to a failure in deriving the account’s keys.

Zip32AccountIndexOutOfRange

A caller attempted to construct a new account with an invalid ZIP 32 account identifier.

AddressNotRecognized(TransparentAddress)

Available on crate feature transparent-inputs only.

The address associated with a record being inserted was not recognized as belonging to the wallet.

CommitmentTree(ShardTreeError<Error>)

An error occurred in inserting data into or accessing data from one of the wallet’s note commitment trees.

PutBlocksCommitmentTree

An error occurred while inserting the note commitment data for a range of scanned blocks into one of the wallet’s note commitment trees during a put_blocks operation. The pool and block_range fields record the shielded pool whose note commitment tree was being updated and the range of block heights (start-inclusive, end-exclusive) that were being added to the wallet when the error occurred.

Fields

pool: ShieldedPool

The shielded pool whose note commitment tree was being updated when the error occurred.

block_range: Range<BlockHeight>

The range of block heights that were being added to the wallet when the error occurred.

error: ShardTreeError<Error>

The underlying note commitment tree error.

TruncateCommitmentTree

An error occurred in one of the wallet’s note commitment trees while truncating the wallet to the specified block height. The pool and height fields record the shielded pool whose note commitment tree was being updated and the block height that the wallet was being truncated to when the error occurred.

Fields

pool: ShieldedPool

The shielded pool whose note commitment tree was being updated when the error occurred.

height: BlockHeight

The block height that the wallet was being truncated to when the error occurred.

error: ShardTreeError<Error>

The underlying note commitment tree error.

CacheMiss(BlockHeight)

The block at the specified height was not available from the block cache.

ChainHeightUnknown

The height of the chain was not available; a call to WalletWrite::update_chain_tip is required before the requested operation can succeed.

UnsupportedPoolType(PoolType)

Unsupported pool type

BalanceError(BalanceError)

An error occurred in computing wallet balance

NoteFilterInvalid(NoteFilter)

A note selection query contained an invalid constant or was otherwise not supported.

ReachedGapLimit(TransparentKeyScope, u32)

Available on crate feature transparent-inputs only.

An address cannot be reserved, or a proposal cannot be constructed until a transaction containing outputs belonging to a previously reserved address has been mined. The error contains the index that could not safely be reserved.

DiversifierIndexReuse(DiversifierIndex, Box<UnifiedAddress>)

The backend encountered an attempt to reuse a diversifier index to generate an address having different receivers from an address that had previously been exposed for that diversifier index. Returns the previously exposed address.

AddressReuse(String, NonEmpty<TxId>)

The wallet attempted to create a transaction that would use of one of the wallet’s previously-used addresses, potentially creating a problem with on-chain transaction linkability. The returned value contains the string encoding of the address and the txid(s) of the transactions in which it is known to have been used.

IneligibleNotes

The wallet found one or more notes that given a certain context would be ineligible and shouldn’t be considered in the involved db operation.

Scheduling(SchedulingError)

Available on crate feature transparent-inputs only.

The wallet encountered an error when attempting to schedule wallet operations.

NotificationMismatch

Available on crate feature transparent-inputs only.

The caller responded to a TransactionsInvolvingAddress request by querying a range of block heights ending at a height that did not match the (exclusive) end of the requested range.

Fields

expected: BlockHeight

The expected ending block height.

actual: BlockHeight

The actual ending block height returned.

FeeRuleError(Box<dyn Error + Send + Sync>)

Available on crate feature transparent-inputs only.

An error returned by a FeeRule during transparent input selection. The underlying error is boxed so the storage layer does not need to know every fee rule’s error type.

BackendError(BackendError)

A zcash_client_backend error value carried a variant that this crate has no translation for; the wrapped value carries the error itself.

Those error types are #[non_exhaustive], so a variant introduced by a future zcash_client_backend release can reach this crate before there is a specific SqliteClientError counterpart for it. This error is therefore unreachable with the zcash_client_backend release this crate is built against; encountering it means this crate needs updating to translate the new variant.

Trait Implementations

impl Debug for SqliteClientError

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

Formats the value using the given formatter.

impl Display for SqliteClientError

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

Formats the value using the given formatter.

impl Error for SqliteClientError

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<AddressGenerationError> for SqliteClientError

fn from(e: AddressGenerationError) -> Self

Converts to this type from the input type.

impl From<BalanceError> for SqliteClientError

fn from(e: BalanceError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for SqliteClientError

fn from(e: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for SqliteClientError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SqliteClientError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SqliteClientError

Available on crate feature transparent-inputs only.

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SqliteClientError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<FeeError> for SqliteClientError

Available on crate feature transparent-inputs only.

fn from(e: FeeError) -> Self

Converts to this type from the input type.

impl From<GapAddressesError<SqliteClientError>> for SqliteClientError

Available on crate feature transparent-inputs only.

fn from(err: GapAddressesError<SqliteClientError>) -> Self

Converts to this type from the input type.

impl From<ParseError> for SqliteClientError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<PutBlocksError<SqliteClientError, Error>> for SqliteClientError

fn from(value: PutBlocksError<SqliteClientError, Error>) -> Self

Converts to this type from the input type.

impl From<ShardTreeError<Error>> for SqliteClientError

fn from(e: ShardTreeError<Error>) -> Self

Converts to this type from the input type.

impl From<SqliteClientError> for WalletMigrationError

fn from(value: SqliteClientError) -> Self

Converts to this type from the input type.

impl From<TransparentCodecError> for SqliteClientError

Available on crate feature transparent-inputs only.

fn from(e: TransparentCodecError) -> Self

Converts to this type from the input type.