public static interface RouterOuterClass.SendPaymentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
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.
|
boolean |
getAmp()
If set, an AMP-payment will be attempted.
|
long |
getAmt()
Number of satoshis to send.
|
long |
getAmtMsat()
Number of millisatoshis to send.
|
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.
|
long |
getFeeLimitMsat()
The maximum number of millisatoshis that will be paid as a fee of the
payment.
|
long |
getFeeLimitSat()
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.
|
int |
getMaxParts()
The maximum number of partial payments that may be use to complete the full
amount.
|
long |
getMaxShardSizeMsat()
The largest payment split that should be attempted when making a payment if
splitting is necessary.
|
boolean |
getNoInflightUpdates()
If set, only the final payment update is streamed back.
|
long |
getOutgoingChanId()
Deprecated.
routerrpc.SendPaymentRequest.outgoing_chan_id is deprecated.
See router.proto;l=234
|
long |
getOutgoingChanIds(int index)
The channel ids of the channels are allowed for the first hop.
|
int |
getOutgoingChanIdsCount()
The channel ids of the channels are allowed for the first hop.
|
java.util.List<java.lang.Long> |
getOutgoingChanIdsList()
The channel ids of the channels are allowed for the first hop.
|
com.google.protobuf.ByteString |
getPaymentAddr()
An optional payment addr to be included within the last hop of the route.
|
com.google.protobuf.ByteString |
getPaymentHash()
The hash to use within the payment's HTLC
|
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.
|
LightningApi.RouteHint |
getRouteHints(int index)
Optional route hints to reach the destination through private channels.
|
int |
getRouteHintsCount()
Optional route hints to reach the destination through private channels.
|
java.util.List<LightningApi.RouteHint> |
getRouteHintsList()
Optional route hints to reach the destination through private channels.
|
LightningApi.RouteHintOrBuilder |
getRouteHintsOrBuilder(int index)
Optional route hints to reach the destination through private channels.
|
java.util.List<? extends LightningApi.RouteHintOrBuilder> |
getRouteHintsOrBuilderList()
Optional route hints to reach the destination through private channels.
|
int |
getTimeoutSeconds()
An upper limit on the amount of time we should spend when attempting to
fulfill the payment.
|
double |
getTimePref()
The time preference for this payment.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
com.google.protobuf.ByteString getDest()
The identity pubkey of the payment recipient
bytes dest = 1;
long getAmt()
Number of satoshis to send. The fields amt and amt_msat are mutually exclusive.
int64 amt = 2;
long getAmtMsat()
Number of millisatoshis to send. The fields amt and amt_msat are mutually exclusive.
int64 amt_msat = 12;
com.google.protobuf.ByteString getPaymentHash()
The hash to use within the payment's HTLC
bytes payment_hash = 3;
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 = 4;
com.google.protobuf.ByteString getPaymentAddr()
An optional payment addr to be included within the last hop of the route.
bytes payment_addr = 20;
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. The amount in the payment request may be zero. In that case it is required to set the amt field as well. If no payment request is specified, the following fields are required: dest, amt and payment_hash.
string payment_request = 5;
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. The amount in the payment request may be zero. In that case it is required to set the amt field as well. If no payment request is specified, the following fields are required: dest, amt and payment_hash.
string payment_request = 5;
int getTimeoutSeconds()
An upper limit on the amount of time we should spend when attempting to fulfill the payment. This is expressed in seconds. If we cannot make a successful payment within this time frame, an error will be returned. This field must be non-zero.
int32 timeout_seconds = 6;
long getFeeLimitSat()
The maximum number of satoshis that will be paid as a fee of the payment. If this field is left to the default value of 0, only zero-fee routes will be considered. This usually means single hop routes connecting directly to the destination. To send the payment without a fee limit, use max int here. The fields fee_limit_sat and fee_limit_msat are mutually exclusive.
int64 fee_limit_sat = 7;
long getFeeLimitMsat()
The maximum number of millisatoshis that will be paid as a fee of the payment. If this field is left to the default value of 0, only zero-fee routes will be considered. This usually means single hop routes connecting directly to the destination. To send the payment without a fee limit, use max int here. The fields fee_limit_sat and fee_limit_msat are mutually exclusive.
int64 fee_limit_msat = 13;
@Deprecated long getOutgoingChanId()
Deprecated, use outgoing_chan_ids. The channel id of the channel that must be taken to the first hop. If zero, any channel may be used (unless outgoing_chan_ids are set).
uint64 outgoing_chan_id = 8 [deprecated = true, jstype = JS_STRING];
java.util.List<java.lang.Long> getOutgoingChanIdsList()
The channel ids of the channels are allowed for the first hop. If empty, any channel may be used.
repeated uint64 outgoing_chan_ids = 19;
int getOutgoingChanIdsCount()
The channel ids of the channels are allowed for the first hop. If empty, any channel may be used.
repeated uint64 outgoing_chan_ids = 19;
long getOutgoingChanIds(int index)
The channel ids of the channels are allowed for the first hop. If empty, any channel may be used.
repeated uint64 outgoing_chan_ids = 19;
index
- The index of the element to return.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 = 14;
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.
int32 cltv_limit = 9;
java.util.List<LightningApi.RouteHint> getRouteHintsList()
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 10;
LightningApi.RouteHint getRouteHints(int index)
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 10;
int getRouteHintsCount()
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 10;
java.util.List<? extends LightningApi.RouteHintOrBuilder> getRouteHintsOrBuilderList()
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 10;
LightningApi.RouteHintOrBuilder getRouteHintsOrBuilder(int index)
Optional route hints to reach the destination through private channels.
repeated .lnrpc.RouteHint route_hints = 10;
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;
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;
@Deprecated java.util.Map<java.lang.Long,com.google.protobuf.ByteString> getDestCustomRecords()
getDestCustomRecordsMap()
instead.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;
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;
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;
boolean getAllowSelfPayment()
If set, circular payments to self are permitted.
bool allow_self_payment = 15;
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 = 16;
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 = 16;
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 = 16;
index
- The index of the element to return.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 = 16;
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 = 16;
index
- The index of the value to return.int getMaxParts()
The maximum number of partial payments that may be use to complete the full amount.
uint32 max_parts = 17;
boolean getNoInflightUpdates()
If set, only the final payment update is streamed back. Intermediate updates that show which htlcs are still in flight are suppressed.
bool no_inflight_updates = 18;
long getMaxShardSizeMsat()
The largest payment split that should be attempted when making a payment if splitting is necessary. Setting this value will effectively cause lnd to split more aggressively, vs only when it thinks it needs to. Note that this value is in milli-satoshis.
uint64 max_shard_size_msat = 21;
boolean getAmp()
If set, an AMP-payment will be attempted.
bool amp = 22;
double getTimePref()
The time preference for this payment. Set to -1 to optimize for fees only, to 1 to optimize for reliability only or a value inbetween for a mix.
double time_pref = 23;