org.lightningj.lnd.proto

Class LightningApi.Invoice

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.proto.LightningApi.Invoice

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, LightningApi.InvoiceOrBuilder

Enclosing class:

LightningApi

public static final class LightningApi.Invoice
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.InvoiceOrBuilder

Protobuf type lnrpc.Invoice

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightningApi.Invoice.Builder Protobuf type lnrpc.Invoice
static class	LightningApi.Invoice.InvoiceState Protobuf enum lnrpc.Invoice.InvoiceState

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD_INDEX_FIELD_NUMBER
static int	AMT_PAID_FIELD_NUMBER
static int	AMT_PAID_MSAT_FIELD_NUMBER
static int	AMT_PAID_SAT_FIELD_NUMBER
static int	CLTV_EXPIRY_FIELD_NUMBER
static int	CREATION_DATE_FIELD_NUMBER
static int	DESCRIPTION_HASH_FIELD_NUMBER
static int	EXPIRY_FIELD_NUMBER
static int	FALLBACK_ADDR_FIELD_NUMBER
static int	FEATURES_FIELD_NUMBER
static int	HTLCS_FIELD_NUMBER
static int	IS_KEY_SEND_FIELD_NUMBER
static int	MEMO_FIELD_NUMBER
static int	PAYMENT_REQUEST_FIELD_NUMBER
static int	PRIVATE_FIELD_NUMBER
static int	R_HASH_FIELD_NUMBER
static int	R_PREIMAGE_FIELD_NUMBER
static int	ROUTE_HINTS_FIELD_NUMBER
static int	SETTLE_DATE_FIELD_NUMBER
static int	SETTLE_INDEX_FIELD_NUMBER
static int	SETTLED_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	VALUE_FIELD_NUMBER
static int	VALUE_MSAT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsFeatures(int key) / List of features advertised on the invoice.
boolean	equals(java.lang.Object obj)
long	getAddIndex() The "add" index of this invoice.
long	getAmtPaid() Deprecated.
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
static LightningApi.Invoice	getDefaultInstance()
LightningApi.Invoice	getDefaultInstanceForType()
com.google.protobuf.ByteString	getDescriptionHash() Hash (SHA-256) of a description of the payment.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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	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.Parser<LightningApi.Invoice>	getParserForType()
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.
int	getSerializedSize()
boolean	getSettled() Deprecated.
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static LightningApi.Invoice.Builder	newBuilder()
static LightningApi.Invoice.Builder	newBuilder(LightningApi.Invoice prototype)
LightningApi.Invoice.Builder	newBuilderForType()
protected LightningApi.Invoice.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static LightningApi.Invoice	parseDelimitedFrom(java.io.InputStream input)
static LightningApi.Invoice	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Invoice	parseFrom(byte[] data)
static LightningApi.Invoice	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Invoice	parseFrom(java.nio.ByteBuffer data)
static LightningApi.Invoice	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Invoice	parseFrom(com.google.protobuf.ByteString data)
static LightningApi.Invoice	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Invoice	parseFrom(com.google.protobuf.CodedInputStream input)
static LightningApi.Invoice	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Invoice	parseFrom(java.io.InputStream input)
static LightningApi.Invoice	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LightningApi.Invoice>	parser()
LightningApi.Invoice.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MEMO_FIELD_NUMBER

public static final int MEMO_FIELD_NUMBER

See Also:

Constant Field Values

R_PREIMAGE_FIELD_NUMBER

public static final int R_PREIMAGE_FIELD_NUMBER

See Also:

Constant Field Values

R_HASH_FIELD_NUMBER

public static final int R_HASH_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_MSAT_FIELD_NUMBER

public static final int VALUE_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

SETTLED_FIELD_NUMBER

public static final int SETTLED_FIELD_NUMBER

See Also:

Constant Field Values

CREATION_DATE_FIELD_NUMBER

public static final int CREATION_DATE_FIELD_NUMBER

See Also:

Constant Field Values

SETTLE_DATE_FIELD_NUMBER

public static final int SETTLE_DATE_FIELD_NUMBER

See Also:

Constant Field Values

PAYMENT_REQUEST_FIELD_NUMBER

public static final int PAYMENT_REQUEST_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_HASH_FIELD_NUMBER

public static final int DESCRIPTION_HASH_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRY_FIELD_NUMBER

public static final int EXPIRY_FIELD_NUMBER

See Also:

Constant Field Values

FALLBACK_ADDR_FIELD_NUMBER

public static final int FALLBACK_ADDR_FIELD_NUMBER

See Also:

Constant Field Values

CLTV_EXPIRY_FIELD_NUMBER

public static final int CLTV_EXPIRY_FIELD_NUMBER

See Also:

Constant Field Values

ROUTE_HINTS_FIELD_NUMBER

public static final int ROUTE_HINTS_FIELD_NUMBER

See Also:

Constant Field Values

PRIVATE_FIELD_NUMBER

public static final int PRIVATE_FIELD_NUMBER

See Also:

Constant Field Values

ADD_INDEX_FIELD_NUMBER

public static final int ADD_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

SETTLE_INDEX_FIELD_NUMBER

public static final int SETTLE_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

AMT_PAID_FIELD_NUMBER

public static final int AMT_PAID_FIELD_NUMBER

See Also:

Constant Field Values

AMT_PAID_SAT_FIELD_NUMBER

public static final int AMT_PAID_SAT_FIELD_NUMBER

See Also:

Constant Field Values

AMT_PAID_MSAT_FIELD_NUMBER

public static final int AMT_PAID_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

HTLCS_FIELD_NUMBER

public static final int HTLCS_FIELD_NUMBER

See Also:

Constant Field Values

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER

See Also:

Constant Field Values

IS_KEY_SEND_FIELD_NUMBER

public static final int IS_KEY_SEND_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getMemo

public 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[json_name = "memo"];

Specified by:

getMemo in interface LightningApi.InvoiceOrBuilder

getMemoBytes

public 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[json_name = "memo"];

Specified by:

getMemoBytes in interface LightningApi.InvoiceOrBuilder

getRPreimage

public 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[json_name = "r_preimage"];

Specified by:

getRPreimage in interface LightningApi.InvoiceOrBuilder

getRHash

public com.google.protobuf.ByteString getRHash()

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

bytes r_hash = 4[json_name = "r_hash"];

Specified by:

getRHash in interface LightningApi.InvoiceOrBuilder

getValue

public long getValue()

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

int64 value = 5[json_name = "value"];

Specified by:

getValue in interface LightningApi.InvoiceOrBuilder

getValueMsat

public long getValueMsat()

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

int64 value_msat = 23[json_name = "value_msat"];

Specified by:

getValueMsat in interface LightningApi.InvoiceOrBuilder

getSettled

@Deprecated
public boolean getSettled()

Deprecated.

/ Whether this invoice has been fulfilled
 

bool settled = 6[json_name = "settled", deprecated = true];

Specified by:

getSettled in interface LightningApi.InvoiceOrBuilder

getCreationDate

public long getCreationDate()

/ When this invoice was created
 

int64 creation_date = 7[json_name = "creation_date"];

Specified by:

getCreationDate in interface LightningApi.InvoiceOrBuilder

getSettleDate

public long getSettleDate()

/ When this invoice was settled
 

int64 settle_date = 8[json_name = "settle_date"];

Specified by:

getSettleDate in interface LightningApi.InvoiceOrBuilder

getPaymentRequest

public 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.
 

string payment_request = 9[json_name = "payment_request"];

Specified by:

getPaymentRequest in interface LightningApi.InvoiceOrBuilder

getPaymentRequestBytes

public 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.
 

string payment_request = 9[json_name = "payment_request"];

Specified by:

getPaymentRequestBytes in interface LightningApi.InvoiceOrBuilder

getDescriptionHash

public 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[json_name = "description_hash"];

Specified by:

getDescriptionHash in interface LightningApi.InvoiceOrBuilder

getExpiry

public long getExpiry()

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

int64 expiry = 11[json_name = "expiry"];

Specified by:

getExpiry in interface LightningApi.InvoiceOrBuilder

getFallbackAddr

public java.lang.String getFallbackAddr()

/ Fallback on-chain address.
 

string fallback_addr = 12[json_name = "fallback_addr"];

Specified by:

getFallbackAddr in interface LightningApi.InvoiceOrBuilder

getFallbackAddrBytes

public com.google.protobuf.ByteString getFallbackAddrBytes()

/ Fallback on-chain address.
 

string fallback_addr = 12[json_name = "fallback_addr"];

Specified by:

getFallbackAddrBytes in interface LightningApi.InvoiceOrBuilder

getCltvExpiry

public long getCltvExpiry()

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

uint64 cltv_expiry = 13[json_name = "cltv_expiry"];

Specified by:

getCltvExpiry in interface LightningApi.InvoiceOrBuilder

getRouteHintsList

public 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[json_name = "route_hints"];

Specified by:

getRouteHintsList in interface LightningApi.InvoiceOrBuilder

getRouteHintsOrBuilderList

public 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[json_name = "route_hints"];

Specified by:

getRouteHintsOrBuilderList in interface LightningApi.InvoiceOrBuilder

getRouteHintsCount

public int getRouteHintsCount()

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

repeated .lnrpc.RouteHint route_hints = 14[json_name = "route_hints"];

Specified by:

getRouteHintsCount in interface LightningApi.InvoiceOrBuilder

getRouteHints

public 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[json_name = "route_hints"];

Specified by:

getRouteHints in interface LightningApi.InvoiceOrBuilder

getRouteHintsOrBuilder

public 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[json_name = "route_hints"];

Specified by:

getRouteHintsOrBuilder in interface LightningApi.InvoiceOrBuilder

getPrivate

public boolean getPrivate()

/ Whether this invoice should include routing hints for private channels.
 

bool private = 15[json_name = "private"];

Specified by:

getPrivate in interface LightningApi.InvoiceOrBuilder

getAddIndex

public 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.
 

uint64 add_index = 16[json_name = "add_index"];

Specified by:

getAddIndex in interface LightningApi.InvoiceOrBuilder

getSettleIndex

public 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.
 

uint64 settle_index = 17[json_name = "settle_index"];

Specified by:

getSettleIndex in interface LightningApi.InvoiceOrBuilder

getAmtPaid

@Deprecated
public long getAmtPaid()

Deprecated.

/ Deprecated, use amt_paid_sat or amt_paid_msat.
 

int64 amt_paid = 18[json_name = "amt_paid", deprecated = true];

Specified by:

getAmtPaid in interface LightningApi.InvoiceOrBuilder

getAmtPaidSat

public long getAmtPaidSat()

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.
 

int64 amt_paid_sat = 19[json_name = "amt_paid_sat"];

Specified by:

getAmtPaidSat in interface LightningApi.InvoiceOrBuilder

getAmtPaidMsat

public long getAmtPaidMsat()

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.
 

int64 amt_paid_msat = 20[json_name = "amt_paid_msat"];

Specified by:

getAmtPaidMsat in interface LightningApi.InvoiceOrBuilder

getStateValue

public int getStateValue()

The state the invoice is in.
 

.lnrpc.Invoice.InvoiceState state = 21[json_name = "state"];

Specified by:

getStateValue in interface LightningApi.InvoiceOrBuilder

getState

public LightningApi.Invoice.InvoiceState getState()

The state the invoice is in.
 

.lnrpc.Invoice.InvoiceState state = 21[json_name = "state"];

Specified by:

getState in interface LightningApi.InvoiceOrBuilder

getHtlcsList

public java.util.List<LightningApi.InvoiceHTLC> getHtlcsList()

/ List of HTLCs paying to this invoice [EXPERIMENTAL].
 

repeated .lnrpc.InvoiceHTLC htlcs = 22[json_name = "htlcs"];

Specified by:

getHtlcsList in interface LightningApi.InvoiceOrBuilder

getHtlcsOrBuilderList

public java.util.List<? extends LightningApi.InvoiceHTLCOrBuilder> getHtlcsOrBuilderList()

/ List of HTLCs paying to this invoice [EXPERIMENTAL].
 

repeated .lnrpc.InvoiceHTLC htlcs = 22[json_name = "htlcs"];

Specified by:

getHtlcsOrBuilderList in interface LightningApi.InvoiceOrBuilder

getHtlcsCount

public int getHtlcsCount()

/ List of HTLCs paying to this invoice [EXPERIMENTAL].
 

repeated .lnrpc.InvoiceHTLC htlcs = 22[json_name = "htlcs"];

Specified by:

getHtlcsCount in interface LightningApi.InvoiceOrBuilder

getHtlcs

public LightningApi.InvoiceHTLC getHtlcs(int index)

/ List of HTLCs paying to this invoice [EXPERIMENTAL].
 

repeated .lnrpc.InvoiceHTLC htlcs = 22[json_name = "htlcs"];

Specified by:

getHtlcs in interface LightningApi.InvoiceOrBuilder

getHtlcsOrBuilder

public LightningApi.InvoiceHTLCOrBuilder getHtlcsOrBuilder(int index)

/ List of HTLCs paying to this invoice [EXPERIMENTAL].
 

repeated .lnrpc.InvoiceHTLC htlcs = 22[json_name = "htlcs"];

Specified by:

getHtlcsOrBuilder in interface LightningApi.InvoiceOrBuilder

getFeaturesCount

public int getFeaturesCount()

Description copied from interface: LightningApi.InvoiceOrBuilder

/ List of features advertised on the invoice.
 

map<uint32, .lnrpc.Feature> features = 24[json_name = "features"];

Specified by:

getFeaturesCount in interface LightningApi.InvoiceOrBuilder

containsFeatures

public boolean containsFeatures(int key)

/ List of features advertised on the invoice.
 

map<uint32, .lnrpc.Feature> features = 24[json_name = "features"];

Specified by:

containsFeatures in interface LightningApi.InvoiceOrBuilder

getFeatures

@Deprecated
public java.util.Map<java.lang.Integer,LightningApi.Feature> getFeatures()

Deprecated.

Use getFeaturesMap() instead.

Specified by:

getFeatures in interface LightningApi.InvoiceOrBuilder

getFeaturesMap

public java.util.Map<java.lang.Integer,LightningApi.Feature> getFeaturesMap()

/ List of features advertised on the invoice.
 

map<uint32, .lnrpc.Feature> features = 24[json_name = "features"];

Specified by:

getFeaturesMap in interface LightningApi.InvoiceOrBuilder

getFeaturesOrDefault

public LightningApi.Feature getFeaturesOrDefault(int key,
                                                 LightningApi.Feature defaultValue)

/ List of features advertised on the invoice.
 

map<uint32, .lnrpc.Feature> features = 24[json_name = "features"];

Specified by:

getFeaturesOrDefault in interface LightningApi.InvoiceOrBuilder

getFeaturesOrThrow

public LightningApi.Feature getFeaturesOrThrow(int key)

/ List of features advertised on the invoice.
 

map<uint32, .lnrpc.Feature> features = 24[json_name = "features"];

Specified by:

getFeaturesOrThrow in interface LightningApi.InvoiceOrBuilder

getIsKeySend

public boolean getIsKeySend()

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

bool is_key_send = 25[json_name = "is_key_send"];

Specified by:

getIsKeySend in interface LightningApi.InvoiceOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LightningApi.Invoice parseFrom(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Invoice parseFrom(java.nio.ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Invoice parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Invoice parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Invoice parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Invoice parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Invoice parseFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Invoice parseFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.Invoice parseDelimitedFrom(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.Invoice parseDelimitedFrom(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Invoice parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Invoice parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LightningApi.Invoice.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LightningApi.Invoice.Builder newBuilder()

newBuilder

public static LightningApi.Invoice.Builder newBuilder(LightningApi.Invoice prototype)

toBuilder

public LightningApi.Invoice.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LightningApi.Invoice.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LightningApi.Invoice getDefaultInstance()

parser

public static com.google.protobuf.Parser<LightningApi.Invoice> parser()

getParserForType

public com.google.protobuf.Parser<LightningApi.Invoice> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LightningApi.Invoice getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder