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: UInt64 = lnrpc.Invoice._typemapper_cltvExpiry.toCustom(0L), routeHints: Seq[RouteHint] = _root_.scala.Seq.empty, private: Boolean = false, addIndex: UInt64 = lnrpc.Invoice._typemapper_addIndex.toCustom(0L), settleIndex: UInt64 = lnrpc.Invoice._typemapper_settleIndex.toCustom(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[UInt32, Feature] = _root_.scala.collection.immutable.Map.empty, isKeysend: Boolean = false, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, isAmp: Boolean = false, ampInvoiceState: Map[String, AMPInvoiceState] = _root_.scala.collection.immutable.Map.empty, 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. Note: Output only, don't specify for creating an invoice.

   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. The field is deprecated. Use the state field instead (compare to SETTLED).

   creationDate

   When this invoice was created. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.

   settleDate

   When this invoice was settled. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.

   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. Note: Output only, don't specify for creating an invoice.

   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 86400 (24 hours).

   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. Note: When enabled, if value and value_msat are zero, a large number of hints with these channels can be included, which might not be desirable.

   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. Note: Output only, don't specify for creating an invoice.

   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. Note: Output only, don't specify for creating an invoice.

   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 or accepted. 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. Note: Output only, don't specify for creating an invoice.

   amtPaidMsat

   The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled or accepted. 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. Note: Output only, don't specify for creating an invoice.

   state

   The state the invoice is in. Note: Output only, don't specify for creating an invoice.

   htlcs

   List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.

   features

   List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.

   isKeysend

   Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.

   paymentAddr

   The payment address of this invoice. This value will be used in MPP payments, and also for newer invoices that always require the MPP payload for added end-to-end security. Note: Output only, don't specify for creating an invoice.

   isAmp

   Signals whether or not this is an AMP invoice.

   ampInvoiceState

   [EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.