Enum LightningReceiveStates

pub enum LightningReceiveStates {
    SubmittedOffer(LightningReceiveSubmittedOffer),
    Canceled(LightningReceiveError),
    ConfirmedInvoice(LightningReceiveConfirmedInvoice),
    Funded(LightningReceiveFunded),
    Success(Vec<OutPoint>),
}

State machine that waits on the receipt of a Lightning payment.

graph LR classDef virtual fill:#fff,stroke-dasharray: 5 5 SubmittedOffer -- await transaction rejection --> Canceled SubmittedOffer -- await invoice confirmation --> ConfirmedInvoice ConfirmedInvoice -- await contract creation + decryption --> Funded ConfirmedInvoice -- await offer timeout --> Canceled Funded -- await claim tx acceptance --> Success Funded -- await claim tx rejection --> Canceled

Variants

SubmittedOffer(LightningReceiveSubmittedOffer)

Canceled(LightningReceiveError)

ConfirmedInvoice(LightningReceiveConfirmedInvoice)

Funded(LightningReceiveFunded)

Success(Vec<OutPoint>)

Trait Implementations

impl Clone for LightningReceiveStates

fn clone(&self) -> LightningReceiveStates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LightningReceiveStates

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

Formats the value using the given formatter.

impl Decodable for LightningReceiveStates

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl Encodable for LightningReceiveStates

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl Hash for LightningReceiveStates

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 LightningReceiveStates

fn eq(&self, other: &LightningReceiveStates) -> 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 Eq for LightningReceiveStates

impl StructuralPartialEq for LightningReceiveStates