Struct lnrpc::Invoice

pub struct Invoice {
    pub memo: String,
    pub r_preimage: Vec<u8>,
    pub r_hash: Vec<u8>,
    pub value: i64,
    pub value_msat: i64,
    pub settled: bool,
    pub creation_date: i64,
    pub settle_date: i64,
    pub payment_request: String,
    pub description_hash: Vec<u8>,
    pub expiry: i64,
    pub fallback_addr: String,
    pub cltv_expiry: u64,
    pub route_hints: Vec<RouteHint>,
    pub private: bool,
    pub add_index: u64,
    pub settle_index: u64,
    pub amt_paid: i64,
    pub amt_paid_sat: i64,
    pub amt_paid_msat: i64,
    pub state: i32,
    pub htlcs: Vec<InvoiceHtlc>,
    pub features: HashMap<u32, Feature>,
    pub is_keysend: bool,
}

Fields

memo: String

An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.

r_preimage: Vec<u8>

The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. When using REST, this field must be encoded as base64.

r_hash: Vec<u8>

The hash of the preimage. When using REST, this field must be encoded as base64.

value: i64

The value of this invoice in satoshis

The fields value and value_msat are mutually exclusive.

value_msat: i64

The value of this invoice in millisatoshis

The fields value and value_msat are mutually exclusive.

settled: bool

creation_date: i64

settle_date: i64

payment_request: String

A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient.

description_hash: Vec<u8>

Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. When using REST, this field must be encoded as base64.

expiry: i64

fallback_addr: String

cltv_expiry: u64

route_hints: Vec<RouteHint>

Route hints that can each be individually used to assist in reaching the invoice's destination.

private: bool

add_index: u64

The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one.

settle_index: u64

The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one.

amt_paid: i64

amt_paid_sat: i64

The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.

amt_paid_msat: i64

The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well.

state: i32

The state the invoice is in.

htlcs: Vec<InvoiceHtlc>

features: HashMap<u32, Feature>

is_keysend: bool

Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL].

Implementations

impl Invoice

pub fn state(&self) -> InvoiceState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: InvoiceState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

impl Default for Invoice

fn default() -> Invoice

Returns the "default value" for a type.

impl Message for Invoice

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Invoice> for Invoice

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Invoice