LightningApi.Invoice (lightningj 0.10.1-Beta API)

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_KEYSEND_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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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_KEYSEND_FIELD_NUMBER
```
public static final int IS_KEYSEND_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;

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;

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;

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;

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;

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;

Specified by:: getValueMsat in interface LightningApi.InvoiceOrBuilder

getSettled
```
@Deprecated
public boolean getSettled()
```
Deprecated.
```
/ Whether this invoice has been fulfilled
 
```
bool settled = 6 [deprecated = true];
Specified by:

getSettled in interface LightningApi.InvoiceOrBuilder

getCreationDate
```
public long getCreationDate()
```
```
/ When this invoice was created
 
```
int64 creation_date = 7;
Specified by:

getCreationDate in interface LightningApi.InvoiceOrBuilder

getSettleDate
```
public long getSettleDate()
```
```
/ When this invoice was settled
 
```
int64 settle_date = 8;
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;

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;

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;

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;

Specified by:: getExpiry in interface LightningApi.InvoiceOrBuilder

getFallbackAddr
```
public java.lang.String getFallbackAddr()
```
```
/ Fallback on-chain address.
 
```
string fallback_addr = 12;
Specified by:

getFallbackAddr in interface LightningApi.InvoiceOrBuilder

getFallbackAddrBytes
```
public com.google.protobuf.ByteString getFallbackAddrBytes()
```
```
/ Fallback on-chain address.
 
```
string fallback_addr = 12;
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;

Specified by:: getCltvExpiry in interface LightningApi.InvoiceOrBuilder