Instance Constructors

1.  new Invoice(memo: String = "", rPreimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, rHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, value: Long = 0L, valueMsat: Long = 0L, settled: Boolean = false, creationDate: Long = 0L, settleDate: Long = 0L, paymentRequest: String = "", descriptionHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, expiry: Long = 0L, fallbackAddr: String = "", cltvExpiry: Long = 0L, routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, private: Boolean = false, addIndex: Long = 0L, settleIndex: Long = 0L, amtPaid: Long = 0L, amtPaidSat: Long = 0L, amtPaidMsat: Long = 0L, state: InvoiceState = lnrpc.Invoice.InvoiceState.OPEN, htlcs: Seq[InvoiceHTLC] = _root_.scala.Seq.empty, features: Map[Int, Feature] = _root_.scala.collection.immutable.Map.empty, isKeysend: Boolean = false, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, isAmp: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
   memo

   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.

   rPreimage

   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.

   rHash

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

   value

   The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.

   valueMsat

   The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.

   settled

   Whether this invoice has been fulfilled

   creationDate

   When this invoice was created

   settleDate

   When this invoice was settled

   paymentRequest

   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.

   descriptionHash

   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

   Payment request expiry time in seconds. Default is 3600 (1 hour).

   fallbackAddr

   Fallback on-chain address.

   cltvExpiry

   Delta to use for the time-lock of the CLTV extended to the final hop.

   routeHints

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

   private

   Whether this invoice should include routing hints for private channels.

   addIndex

   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.

   settleIndex

   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.

   amtPaid

   Deprecated, use amt_paid_sat or amt_paid_msat.

   amtPaidSat

   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.

   amtPaidMsat

   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

   The state the invoice is in.

   htlcs

   List of HTLCs paying to this invoice [EXPERIMENTAL].

   features

   List of features advertised on the invoice.

   isKeysend

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

   paymentAddr

   The payment address of this invoice. This value will be used in MPP payments, and also for newer invoies that always require the MPP paylaod for added end-to-end security.

   isAmp

   Signals whether or not this is an AMP invoice.