public static interface LightningApi.InvoiceOrBuilder
extends com.google.protobuf.MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
boolean |
containsAmpInvoiceState(java.lang.String key)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
boolean |
containsFeatures(int key)
List of features advertised on the invoice.
|
long |
getAddIndex()
The "add" index of this invoice.
|
java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> |
getAmpInvoiceState()
Deprecated.
|
int |
getAmpInvoiceStateCount()
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> |
getAmpInvoiceStateMap()
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.AMPInvoiceState |
getAmpInvoiceStateOrDefault(java.lang.String key,
LightningApi.AMPInvoiceState defaultValue)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.AMPInvoiceState |
getAmpInvoiceStateOrThrow(java.lang.String key)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
long |
getAmtPaid()
Deprecated.
lnrpc.Invoice.amt_paid is deprecated.
See lightning.api.proto;l=3595
|
long |
getAmtPaidMsat()
The amount that was accepted for this invoice, in millisatoshis.
|
long |
getAmtPaidSat()
The amount that was accepted for this invoice, in satoshis.
|
long |
getCltvExpiry()
Delta to use for the time-lock of the CLTV extended to the final hop.
|
long |
getCreationDate()
When this invoice was created.
|
com.google.protobuf.ByteString |
getDescriptionHash()
Hash (SHA-256) of a description of the payment.
|
long |
getExpiry()
Payment request expiry time in seconds.
|
java.lang.String |
getFallbackAddr()
Fallback on-chain address.
|
com.google.protobuf.ByteString |
getFallbackAddrBytes()
Fallback on-chain address.
|
java.util.Map<java.lang.Integer,LightningApi.Feature> |
getFeatures()
Deprecated.
|
int |
getFeaturesCount()
List of features advertised on the invoice.
|
java.util.Map<java.lang.Integer,LightningApi.Feature> |
getFeaturesMap()
List of features advertised on the invoice.
|
LightningApi.Feature |
getFeaturesOrDefault(int key,
LightningApi.Feature defaultValue)
List of features advertised on the invoice.
|
LightningApi.Feature |
getFeaturesOrThrow(int key)
List of features advertised on the invoice.
|
LightningApi.InvoiceHTLC |
getHtlcs(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
int |
getHtlcsCount()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
java.util.List<LightningApi.InvoiceHTLC> |
getHtlcsList()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.InvoiceHTLCOrBuilder |
getHtlcsOrBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
java.util.List<? extends LightningApi.InvoiceHTLCOrBuilder> |
getHtlcsOrBuilderList()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
boolean |
getIsAmp()
Signals whether or not this is an AMP invoice.
|
boolean |
getIsKeysend()
Indicates if this invoice was a spontaneous payment that arrived via keysend
[EXPERIMENTAL].
|
java.lang.String |
getMemo()
An optional memo to attach along with the invoice.
|
com.google.protobuf.ByteString |
getMemoBytes()
An optional memo to attach along with the invoice.
|
com.google.protobuf.ByteString |
getPaymentAddr()
The payment address of this invoice.
|
java.lang.String |
getPaymentRequest()
A bare-bones invoice for a payment within the Lightning Network.
|
com.google.protobuf.ByteString |
getPaymentRequestBytes()
A bare-bones invoice for a payment within the Lightning Network.
|
boolean |
getPrivate()
Whether this invoice should include routing hints for private channels.
|
com.google.protobuf.ByteString |
getRHash()
The hash of the preimage.
|
LightningApi.RouteHint |
getRouteHints(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
int |
getRouteHintsCount()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
java.util.List<LightningApi.RouteHint> |
getRouteHintsList()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.RouteHintOrBuilder |
getRouteHintsOrBuilder(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
java.util.List<? extends LightningApi.RouteHintOrBuilder> |
getRouteHintsOrBuilderList()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
com.google.protobuf.ByteString |
getRPreimage()
The hex-encoded preimage (32 byte) which will allow settling an incoming
HTLC payable to this preimage.
|
boolean |
getSettled()
Deprecated.
lnrpc.Invoice.settled is deprecated.
See lightning.api.proto;l=3524
|
long |
getSettleDate()
When this invoice was settled.
|
long |
getSettleIndex()
The "settle" index of this invoice.
|
LightningApi.Invoice.InvoiceState |
getState()
The state the invoice is in.
|
int |
getStateValue()
The state the invoice is in.
|
long |
getValue()
The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.
|
long |
getValueMsat()
The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
java.lang.String getMemo()
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.
string memo = 1;
com.google.protobuf.ByteString getMemoBytes()
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.
string memo = 1;
com.google.protobuf.ByteString getRPreimage()
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.
bytes r_preimage = 3;
com.google.protobuf.ByteString getRHash()
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.
bytes r_hash = 4;
long getValue()
The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
int64 value = 5;
long getValueMsat()
The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
int64 value_msat = 23;
@Deprecated boolean getSettled()
Whether this invoice has been fulfilled. The field is deprecated. Use the state field instead (compare to SETTLED).
bool settled = 6 [deprecated = true];
long getCreationDate()
When this invoice was created. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 creation_date = 7;
long getSettleDate()
When this invoice was settled. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 settle_date = 8;
java.lang.String getPaymentRequest()
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.
string payment_request = 9;
com.google.protobuf.ByteString getPaymentRequestBytes()
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.
string payment_request = 9;
com.google.protobuf.ByteString getDescriptionHash()
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.
bytes description_hash = 10;
long getExpiry()
Payment request expiry time in seconds. Default is 86400 (24 hours).
int64 expiry = 11;
java.lang.String getFallbackAddr()
Fallback on-chain address.
string fallback_addr = 12;
com.google.protobuf.ByteString getFallbackAddrBytes()
Fallback on-chain address.
string fallback_addr = 12;
long getCltvExpiry()
Delta to use for the time-lock of the CLTV extended to the final hop.
uint64 cltv_expiry = 13;
java.util.List<LightningApi.RouteHint> getRouteHintsList()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;
LightningApi.RouteHint getRouteHints(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;
int getRouteHintsCount()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;
java.util.List<? extends LightningApi.RouteHintOrBuilder> getRouteHintsOrBuilderList()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;
LightningApi.RouteHintOrBuilder getRouteHintsOrBuilder(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;
boolean getPrivate()
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.
bool private = 15;
long getAddIndex()
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.
uint64 add_index = 16;
long getSettleIndex()
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.
uint64 settle_index = 17;
@Deprecated long getAmtPaid()
Deprecated, use amt_paid_sat or amt_paid_msat.
int64 amt_paid = 18 [deprecated = true];
long getAmtPaidSat()
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.
int64 amt_paid_sat = 19;
long getAmtPaidMsat()
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.
int64 amt_paid_msat = 20;
int getStateValue()
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;
LightningApi.Invoice.InvoiceState getState()
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;
java.util.List<LightningApi.InvoiceHTLC> getHtlcsList()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;
LightningApi.InvoiceHTLC getHtlcs(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;
int getHtlcsCount()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;
java.util.List<? extends LightningApi.InvoiceHTLCOrBuilder> getHtlcsOrBuilderList()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;
LightningApi.InvoiceHTLCOrBuilder getHtlcsOrBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;
int getFeaturesCount()
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;
boolean containsFeatures(int key)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;
@Deprecated java.util.Map<java.lang.Integer,LightningApi.Feature> getFeatures()
getFeaturesMap()
instead.java.util.Map<java.lang.Integer,LightningApi.Feature> getFeaturesMap()
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;
LightningApi.Feature getFeaturesOrDefault(int key, LightningApi.Feature defaultValue)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;
LightningApi.Feature getFeaturesOrThrow(int key)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;
boolean getIsKeysend()
Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
bool is_keysend = 25;
com.google.protobuf.ByteString getPaymentAddr()
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.
bytes payment_addr = 26;
boolean getIsAmp()
Signals whether or not this is an AMP invoice.
bool is_amp = 27;
int getAmpInvoiceStateCount()
[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.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;
boolean containsAmpInvoiceState(java.lang.String key)
[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.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;
@Deprecated java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> getAmpInvoiceState()
getAmpInvoiceStateMap()
instead.java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> getAmpInvoiceStateMap()
[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.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;
LightningApi.AMPInvoiceState getAmpInvoiceStateOrDefault(java.lang.String key, LightningApi.AMPInvoiceState defaultValue)
[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.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;
LightningApi.AMPInvoiceState getAmpInvoiceStateOrThrow(java.lang.String key)
[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.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;