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

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

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 occured.

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

MuSigInconsistent

Fields

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.

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.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.