Enum fedimint_ln_common::LightningOutputV0

pub enum LightningOutputV0 {
    Contract(ContractOutput),
    Offer(IncomingContractOffer),
    CancelOutgoing {
        contract: ContractId,
        gateway_signature: Signature,
    },
}

Represents an output of the Lightning module.

There are three sub-types:

• Normal contracts users may lock funds in
• Offers to buy preimages (see contracts::incoming docs)
• Early cancellation of outgoing contracts before their timeout

The offer type exists to register IncomingContractOffers. Instead of patching in a second way of letting clients submit consensus items outside of transactions we let offers be a 0-amount output. We need to take care to allow 0-input, 1-output transactions for that to allow users to receive their first notes via LN without already having notes.

Variants

Contract(ContractOutput)

Fund contract

Offer(IncomingContractOffer)

Create incoming contract offer

CancelOutgoing

Fields

contract: ContractId

Contract to update

gateway_signature: Signature

Signature of gateway

Allow early refund of outgoing contract

Trait Implementations

impl Clone for LightningOutputV0

fn clone(&self) -> LightningOutputV0

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LightningOutputV0

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

Formats the value using the given formatter.

impl Decodable for LightningOutputV0

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

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

impl<'de> Deserialize<'de> for LightningOutputV0

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LightningOutputV0

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

Formats the value using the given formatter.

impl Encodable for LightningOutputV0

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) -> Result<Vec<u8>, Error>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> Result<String, Error>

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 LightningOutputV0

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 LightningOutputV0

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LightningOutputV0

impl StructuralEq for LightningOutputV0

impl StructuralPartialEq for LightningOutputV0