p

invoicesrpc

package invoicesrpc

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class AddHoldInvoiceRequest(memo: String = "", hash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, value: Long = 0L, valueMsat: Long = 0L, 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, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddHoldInvoiceRequest] with Product with Serializable

    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.

    hash

    The hash of the preimage

    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.

    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.

    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.

    Annotations
    @SerialVersionUID()
  2. final case class AddHoldInvoiceResp(paymentRequest: String = "", addIndex: Long = 0L, paymentAddr: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AddHoldInvoiceResp] with Product with Serializable

    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.

    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.

    paymentAddr

    The payment address of the generated invoice. This value should be used in all payments for this invoice as we require it for end to end security.

    Annotations
    @SerialVersionUID()
  3. final case class CancelInvoiceMsg(paymentHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CancelInvoiceMsg] with Product with Serializable

    paymentHash

    Hash corresponding to the (hold) invoice to cancel. When using REST, this field must be encoded as base64.

    Annotations
    @SerialVersionUID()
  4. final case class CancelInvoiceResp(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[CancelInvoiceResp] with Product with Serializable
    Annotations
    @SerialVersionUID()
  5. trait Invoices extends AnyRef

    Invoices is a service that can be used to create, accept, settle and cancel invoices.

    Invoices is a service that can be used to create, accept, settle and cancel invoices.

    Annotations
    @PekkoGrpcGenerated()
  6. trait InvoicesClient extends Invoices with InvoicesClientPowerApi with PekkoGrpcClient
    Annotations
    @PekkoGrpcGenerated()
  7. trait InvoicesClientPowerApi extends AnyRef
    Annotations
    @PekkoGrpcGenerated()
  8. final case class LookupInvoiceMsg(invoiceRef: InvoiceRef = invoicesrpc.LookupInvoiceMsg.InvoiceRef.Empty, lookupModifier: LookupModifier = invoicesrpc.LookupModifier.DEFAULT, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LookupInvoiceMsg] with Product with Serializable
    Annotations
    @SerialVersionUID()
  9. sealed abstract class LookupModifier extends GeneratedEnum
  10. final case class SettleInvoiceMsg(preimage: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SettleInvoiceMsg] with Product with Serializable

    preimage

    Externally discovered pre-image that should be used to settle the hold invoice.

    Annotations
    @SerialVersionUID()
  11. final case class SettleInvoiceResp(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SettleInvoiceResp] with Product with Serializable
    Annotations
    @SerialVersionUID()
  12. final case class SubscribeSingleInvoiceRequest(rHash: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SubscribeSingleInvoiceRequest] with Product with Serializable

    rHash

    Hash corresponding to the (hold) invoice to subscribe to. When using REST, this field must be encoded as base64url.

    Annotations
    @SerialVersionUID()

Ungrouped