Enum schnorrkel::errors::SignatureError

pub enum SignatureError {
    EquationFalse,
    PointDecompressionError,
    ScalarFormatError,
    InvalidKey,
    BytesLengthError {
        name: &'static str,
        description: &'static str,
        length: usize,
    },
    NotMarkedSchnorrkel,
    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 signature, 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.

InvalidKey

The provided key is not valid.

BytesLengthError

Fields

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

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.

NotMarkedSchnorrkel

Signature not marked as schnorrkel, maybe try ed25519 instead.

MuSigAbsent

Fields

musig_stage: MultiSignatureStage

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

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

MuSigInconsistent

Fields

musig_stage: MultiSignatureStage

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

duplicate: bool

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

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

Trait Implementations

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 Debug for SignatureError

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

Formats the value using the given formatter.

impl Display for SignatureError

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

Formats the value using the given formatter.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SignatureError

impl Eq for SignatureError

impl StructuralEq for SignatureError

impl StructuralPartialEq for SignatureError