Enum schnorrkel::errors::SignatureError

pub enum SignatureError {
    EquationFalse,
    PointDecompressionError,
    ScalarFormatError,
    BytesLengthError {
        name: &'static str,
        description: &'static str,
        length: usize,
    },
    MuSigAbsent {
        musig_stage: MultiSignatureStage,
    },
    MuSigInconsistent {
        musig_stage: MultiSignatureStage,
        duplicate: bool,
    },
}

Errors which may occur while processing signatures and keypairs.

All these errors represent a failed signature when they occur in the context of verifying a sitgnature, including in deserializaing for verification. We expose the distinction among them primarily for debugging purposes.

This error may arise due to:

• Being given bytes with a length different to what was expected.

• A problem decompressing r, a curve point, in the Signature, or the curve point for a PublicKey.

• A problem with the format of s, a scalar, in the Signature. This is only raised if the high-bit of the scalar was set. (Scalars must only be constructed from 255-bit integers.)

• Multi-signature protocol errors

Variants

EquationFalse

A signature verification equation failed.

We emphasise that all variants represent a failed signature, not only this one.

PointDecompressionError

Invalid point provided, usually to verify methods.

ScalarFormatError

Invalid scalar provided, usually to Signature::from_bytes.

BytesLengthError

An error in the length of bytes handed to a constructor.

To use this, pass a string specifying the name of the type which is returning the error, and the length in bytes which its constructor expects.

Fields of BytesLengthError

name: &'static str

Identifies the type returning the error

description: &'static str

Describes the type returning the error

length: usize

Length expected by the constructor in bytes

MuSigAbsent

There is no record of the preceeding multi-signautre protocol stage for the specified public key.

Fields of MuSigAbsent

musig_stage: MultiSignatureStage

Identifies the multi-signature protocol stage during which the error occured.

MuSigInconsistent

For this public key, there are either conflicting records for the preceeding multi-signautre protocol stage or else duplicate duplicate records for the current stage.

Fields of MuSigInconsistent

musig_stage: MultiSignatureStage

Identifies the multi-signature protocol stage during which the error occured.

duplicate: bool

Set true if the stage was reached correctly once but this duplicate disagrees.

Trait Implementations

impl Display for SignatureError

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

Formats the value using the given formatter.

impl Debug for SignatureError

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

Formats the value using the given formatter.

impl PartialEq<SignatureError> for SignatureError

fn eq(&self, other: &SignatureError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SignatureError) -> bool

This method tests for !=.

impl Eq for SignatureError

impl Hash for SignatureError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Copy for SignatureError

impl Clone for SignatureError

fn clone(&self) -> SignatureError

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Fail for SignatureError

fn name(&self) -> Option<&str>

Returns the "name" of the error.

fn cause(&self) -> Option<&(dyn Fail + 'static)>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors.

fn backtrace(&self) -> Option<&Backtrace>

Returns a reference to the Backtrace carried by this failure, if it carries one.

fn context<D>(self, context: D) -> Context<D> where
    D: Display + Send + Sync + 'static, 

Provides context for this failure.

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error.