Enum OffboardForfeitError 

pub enum OffboardForfeitError {
    NoInputs,
    WrongCount {
        vector: &'static str,
        expected: usize,
        received: usize,
    },
    MissingConnectorOutput,
    InvalidUserPartialSignature(InvalidUserPartialSignatureError),
}

Something is wrong with what was handed to an OffboardForfeitContext.

Every variant is a condition the counterparty can cause: a server picks how many cosign nonces it sends and what offboard tx it builds, a client picks how many nonces and partial signatures it sends. None of them may panic, because the side rejecting a malformed message would be the side that goes down.

Variants

NoInputs

There is nothing to forfeit. Every offboard spends at least one VTXO.

WrongCount

A vector holding one entry per input VTXO has a different length.

Fields

vector: &'static str

Names the vector that was the wrong length.

expected: usize

How many entries were needed: one per input VTXO.

received: usize

How many entries were actually supplied.

MissingConnectorOutput

The offboard tx has no connector output for the forfeits to spend. OffboardForfeitContext::validate_offboard_tx reports this in more detail; it shows up here only if that check was skipped.

InvalidUserPartialSignature(InvalidUserPartialSignatureError)

Implementations

impl OffboardForfeitError

pub fn check_count( vector: &'static str, expected: usize, received: usize, ) -> Result<(), OffboardForfeitError>

Returns Self::WrongCount unless received is exactly expected.

vector names what was counted, for the error message.

Trait Implementations

impl Clone for OffboardForfeitError

fn clone(&self) -> OffboardForfeitError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffboardForfeitError

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

Formats the value using the given formatter.

impl Display for OffboardForfeitError

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

Formats the value using the given formatter.

impl Eq for OffboardForfeitError

impl Error for OffboardForfeitError

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<InvalidUserPartialSignatureError> for OffboardForfeitError

fn from(source: InvalidUserPartialSignatureError) -> Self

Converts to this type from the input type.

impl Hash for OffboardForfeitError

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 OffboardForfeitError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OffboardForfeitError