Struct OutgoingContract

pub struct OutgoingContract {
    pub hash: Hash,
    pub gateway_key: PublicKey,
    pub timelock: u32,
    pub user_key: PublicKey,
    pub cancelled: bool,
}

Specialized smart contract for outgoing payments.

A user locks up funds that can be claimed by a lightning gateway if it pays the invoice and thus receives the preimage to the payment hash and can thereby prove the payment. If the gateway is not able to do so before the timelock expires the user can claim back the funds.

Fields

hash: Hash

Hash that can be used to spend the output before the timelock expires

gateway_key: PublicKey

Public key of the LN gateway allowed to claim the HTLC before the timelock expires

timelock: u32

Block height at which the money will be spendable by the pubkey

user_key: PublicKey

Public key of the user that can claim the money back after the timelock expires

cancelled: bool

Flag that can be set by the gateway and allows the client to claim an early refund

Implementations

impl OutgoingContract

pub fn cancellation_message(&self) -> Hash

Trait Implementations

impl Clone for OutgoingContract

fn clone(&self) -> OutgoingContract

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OutgoingContract

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

Formats the value using the given formatter.

impl Decodable for OutgoingContract

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_whole( slice: &[u8], modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

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<'de> Deserialize<'de> for OutgoingContract

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for OutgoingContract

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.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl Hash for OutgoingContract

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 IdentifiableContract for OutgoingContract

fn contract_id(&self) -> ContractId

impl PartialEq for OutgoingContract

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

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 OutgoingContract

impl StructuralPartialEq for OutgoingContract