org.lightningj.lnd.proto

Interface LightningApi.SendRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LightningApi.SendRequest, LightningApi.SendRequest.Builder

Enclosing class:

LightningApi

public static interface LightningApi.SendRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsDestCustomRecords(long key) An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
boolean	getAllowSelfPayment() If set, circular payments to self are permitted.
long	getAmt() The amount to send expressed in satoshis.
long	getAmtMsat() The amount to send expressed in millisatoshis.
int	getCltvLimit() An optional maximum total time lock for the route.
com.google.protobuf.ByteString	getDest() The identity pubkey of the payment recipient.
java.util.Map<java.lang.Long,com.google.protobuf.ByteString>	getDestCustomRecords() Deprecated.
int	getDestCustomRecordsCount() An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
java.util.Map<java.lang.Long,com.google.protobuf.ByteString>	getDestCustomRecordsMap() An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
com.google.protobuf.ByteString	getDestCustomRecordsOrDefault(long key, com.google.protobuf.ByteString defaultValue) An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
com.google.protobuf.ByteString	getDestCustomRecordsOrThrow(long key) An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
LightningApi.FeatureBit	getDestFeatures(int index) Features assumed to be supported by the final node.
int	getDestFeaturesCount() Features assumed to be supported by the final node.
java.util.List<LightningApi.FeatureBit>	getDestFeaturesList() Features assumed to be supported by the final node.
int	getDestFeaturesValue(int index) Features assumed to be supported by the final node.
java.util.List<java.lang.Integer>	getDestFeaturesValueList() Features assumed to be supported by the final node.
java.lang.String	getDestString() Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796
com.google.protobuf.ByteString	getDestStringBytes() Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796
LightningApi.FeeLimit	getFeeLimit() The maximum number of satoshis that will be paid as a fee of the payment.
LightningApi.FeeLimitOrBuilder	getFeeLimitOrBuilder() The maximum number of satoshis that will be paid as a fee of the payment.
int	getFinalCltvDelta() The CLTV delta from the current height that should be used to set the timelock for the final hop.
com.google.protobuf.ByteString	getLastHopPubkey() The pubkey of the last hop of the route.
long	getOutgoingChanId() The channel id of the channel that must be taken to the first hop.
com.google.protobuf.ByteString	getPaymentAddr() The payment address of the generated invoice.
com.google.protobuf.ByteString	getPaymentHash() The hash to use within the payment's HTLC.
java.lang.String	getPaymentHashString() Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822
com.google.protobuf.ByteString	getPaymentHashStringBytes() Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822
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	hasFeeLimit() The maximum number of satoshis that will be paid as a fee of the payment.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDest

com.google.protobuf.ByteString getDest()

The identity pubkey of the payment recipient. When using REST, this field
must be encoded as base64.
 

bytes dest = 1;

Returns:

The dest.

getDestString

@Deprecated
java.lang.String getDestString()

Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796

The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 

string dest_string = 2 [deprecated = true];

Returns:

The destString.

getDestStringBytes

@Deprecated
com.google.protobuf.ByteString getDestStringBytes()

Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796

The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 

string dest_string = 2 [deprecated = true];

Returns:

The bytes for destString.

getAmt

long getAmt()

The amount to send expressed in satoshis.

The fields amt and amt_msat are mutually exclusive.
 

int64 amt = 3;

Returns:

The amt.

getAmtMsat

long getAmtMsat()

The amount to send expressed in millisatoshis.

The fields amt and amt_msat are mutually exclusive.
 

int64 amt_msat = 12;

Returns:

The amtMsat.

getPaymentHash

com.google.protobuf.ByteString getPaymentHash()

The hash to use within the payment's HTLC. When using REST, this field
must be encoded as base64.
 

bytes payment_hash = 4;

Returns:

The paymentHash.

getPaymentHashString

@Deprecated
java.lang.String getPaymentHashString()

Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822

The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 

string payment_hash_string = 5 [deprecated = true];

Returns:

The paymentHashString.

getPaymentHashStringBytes

@Deprecated
com.google.protobuf.ByteString getPaymentHashStringBytes()

Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822

The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 

string payment_hash_string = 5 [deprecated = true];

Returns:

The bytes for paymentHashString.

getPaymentRequest

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 = 6;

Returns:

The paymentRequest.

getPaymentRequestBytes

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 = 6;

Returns:

The bytes for paymentRequest.

getFinalCltvDelta

int getFinalCltvDelta()

The CLTV delta from the current height that should be used to set the
timelock for the final hop.
 

int32 final_cltv_delta = 7;

Returns:

The finalCltvDelta.

hasFeeLimit

boolean hasFeeLimit()

The maximum number of satoshis that will be paid as a fee of the payment.
This value can be represented either as a percentage of the amount being
sent, or as a fixed amount of the maximum fee the user is willing the pay to
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (<=1k sat) or 5% fees for larger amounts.
 

.lnrpc.FeeLimit fee_limit = 8;

Returns:

Whether the feeLimit field is set.

getFeeLimit

LightningApi.FeeLimit getFeeLimit()

The maximum number of satoshis that will be paid as a fee of the payment.
This value can be represented either as a percentage of the amount being
sent, or as a fixed amount of the maximum fee the user is willing the pay to
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (<=1k sat) or 5% fees for larger amounts.
 

.lnrpc.FeeLimit fee_limit = 8;

Returns:

The feeLimit.

getFeeLimitOrBuilder

LightningApi.FeeLimitOrBuilder getFeeLimitOrBuilder()

The maximum number of satoshis that will be paid as a fee of the payment.
This value can be represented either as a percentage of the amount being
sent, or as a fixed amount of the maximum fee the user is willing the pay to
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (<=1k sat) or 5% fees for larger amounts.
 

.lnrpc.FeeLimit fee_limit = 8;

getOutgoingChanId

long getOutgoingChanId()

The channel id of the channel that must be taken to the first hop. If zero,
any channel may be used.
 

uint64 outgoing_chan_id = 9 [jstype = JS_STRING];

Returns:

The outgoingChanId.

getLastHopPubkey

com.google.protobuf.ByteString getLastHopPubkey()

The pubkey of the last hop of the route. If empty, any hop may be used.
 

bytes last_hop_pubkey = 13;

Returns:

The lastHopPubkey.

getCltvLimit

int getCltvLimit()

An optional maximum total time lock for the route. This should not exceed
lnd's `--max-cltv-expiry` setting. If zero, then the value of
`--max-cltv-expiry` is enforced.
 

uint32 cltv_limit = 10;

Returns:

The cltvLimit.

getDestCustomRecordsCount

int getDestCustomRecordsCount()

An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. Record types are
required to be in the custom range >= 65536. When using REST, the values
must be encoded as base64.
 

map<uint64, bytes> dest_custom_records = 11;

containsDestCustomRecords

boolean containsDestCustomRecords(long key)

An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. Record types are
required to be in the custom range >= 65536. When using REST, the values
must be encoded as base64.
 

map<uint64, bytes> dest_custom_records = 11;

getDestCustomRecords

@Deprecated
java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getDestCustomRecords()

Deprecated.

Use getDestCustomRecordsMap() instead.

getDestCustomRecordsMap

java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getDestCustomRecordsMap()

An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. Record types are
required to be in the custom range >= 65536. When using REST, the values
must be encoded as base64.
 

map<uint64, bytes> dest_custom_records = 11;

getDestCustomRecordsOrDefault

com.google.protobuf.ByteString getDestCustomRecordsOrDefault(long key,
                                                             com.google.protobuf.ByteString defaultValue)

An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. Record types are
required to be in the custom range >= 65536. When using REST, the values
must be encoded as base64.
 

map<uint64, bytes> dest_custom_records = 11;

getDestCustomRecordsOrThrow

com.google.protobuf.ByteString getDestCustomRecordsOrThrow(long key)

An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. Record types are
required to be in the custom range >= 65536. When using REST, the values
must be encoded as base64.
 

map<uint64, bytes> dest_custom_records = 11;

getAllowSelfPayment

boolean getAllowSelfPayment()

 If set, circular payments to self are permitted.
 

bool allow_self_payment = 14;

Returns:

The allowSelfPayment.

getDestFeaturesList

java.util.List<LightningApi.FeatureBit> getDestFeaturesList()

Features assumed to be supported by the final node. All transitive feature
dependencies must also be set properly. For a given feature bit pair, either
optional or remote may be set, but not both. If this field is nil or empty,
the router will try to load destination features from the graph as a
fallback.
 

repeated .lnrpc.FeatureBit dest_features = 15;

Returns:

A list containing the destFeatures.

getDestFeaturesCount

int getDestFeaturesCount()

Features assumed to be supported by the final node. All transitive feature
dependencies must also be set properly. For a given feature bit pair, either
optional or remote may be set, but not both. If this field is nil or empty,
the router will try to load destination features from the graph as a
fallback.
 

repeated .lnrpc.FeatureBit dest_features = 15;

Returns:

The count of destFeatures.

getDestFeatures

LightningApi.FeatureBit getDestFeatures(int index)

Features assumed to be supported by the final node. All transitive feature
dependencies must also be set properly. For a given feature bit pair, either
optional or remote may be set, but not both. If this field is nil or empty,
the router will try to load destination features from the graph as a
fallback.
 

repeated .lnrpc.FeatureBit dest_features = 15;

Parameters:

index - The index of the element to return.

Returns:

The destFeatures at the given index.

getDestFeaturesValueList

java.util.List<java.lang.Integer> getDestFeaturesValueList()

Features assumed to be supported by the final node. All transitive feature
dependencies must also be set properly. For a given feature bit pair, either
optional or remote may be set, but not both. If this field is nil or empty,
the router will try to load destination features from the graph as a
fallback.
 

repeated .lnrpc.FeatureBit dest_features = 15;

Returns:

A list containing the enum numeric values on the wire for destFeatures.

getDestFeaturesValue

int getDestFeaturesValue(int index)

Features assumed to be supported by the final node. All transitive feature
dependencies must also be set properly. For a given feature bit pair, either
optional or remote may be set, but not both. If this field is nil or empty,
the router will try to load destination features from the graph as a
fallback.
 

repeated .lnrpc.FeatureBit dest_features = 15;

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of destFeatures at the given index.

getPaymentAddr

com.google.protobuf.ByteString getPaymentAddr()

The payment address of the generated invoice.
 

bytes payment_addr = 16;

Returns:

The paymentAddr.