Enum APIError

pub enum APIError {
    APIMisuseError {
        err: String,
    },
    FeeRateTooHigh {
        err: String,
        feerate: u32,
    },
    InvalidRoute {
        err: String,
    },
    ChannelUnavailable {
        err: String,
    },
    MonitorUpdateInProgress,
    IncompatibleShutdownScript {
        script: ShutdownScript,
    },
}

Indicates an error on the client’s part (usually some variant of attempting to use too-low or too-high values)

Variants

APIMisuseError

Indicates the API was wholly misused (see err for more). Cases where these can be returned are documented, but generally indicates some precondition of a function was violated.

Fields

err: String

A human-readable error message

FeeRateTooHigh

Due to a high feerate, we were unable to complete the request. For example, this may be returned if the feerate implies we cannot open a channel at the requested value, but opening a larger channel would succeed.

Fields

err: String

A human-readable error message

feerate: u32

The feerate which was too high.

InvalidRoute

A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route, too-many-hops, etc).

Fields

err: String

A human-readable error message

ChannelUnavailable

We were unable to complete the request as the Channel required to do so is unable to complete the request (or was not found). This can take many forms, including disconnected peer, channel at capacity, channel shutting down, etc.

Fields

err: String

A human-readable error message

MonitorUpdateInProgress

An attempt to call chain::Watch::watch_channel/chain::Watch::update_channel returned a ChannelMonitorUpdateStatus::InProgress indicating the persistence of a monitor update is awaiting async resolution. Once it resolves the attempted action should complete automatically.

IncompatibleShutdownScript

SignerProvider::get_shutdown_scriptpubkey returned a shutdown scriptpubkey incompatible with the channel counterparty as negotiated in InitFeatures.

Using a SegWit v0 script should resolve this issue. If you cannot, you won’t be able to open a channel or cooperatively close one with this peer (and will have to force-close instead).

Fields

script: ShutdownScript

The incompatible shutdown script.

Trait Implementations

impl Clone for APIError

fn clone(&self) -> APIError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for APIError

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

Formats the value using the given formatter.

impl MaybeReadable for APIError

fn read<R>(reader: &mut R) -> Result<Option<APIError>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl PartialEq for APIError

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Writeable for APIError

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for APIError

impl StructuralPartialEq for APIError