2021-05-01 18:33:34 +00:00
<!DOCTYPE html > < html > < head > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < meta content = "width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name = "viewport" / > < title > < / title > < meta content = "" name = "description" / > < meta content = "" name = "keywords" / > < meta http-equiv = "content-type" content = "text/html; charset=UTF-8" / > < link href = "../lib/index.css" media = "screen" type = "text/css" rel = "stylesheet" / > < link href = "../lib/template.css" media = "screen" type = "text/css" rel = "stylesheet" / > < link href = "../lib/print.css" media = "print" type = "text/css" rel = "stylesheet" / > < link href = "../lib/diagrams.css" media = "screen" type = "text/css" rel = "stylesheet" id = "diagrams-css" / > < script type = "text/javascript" src = "../lib/jquery.min.js" > < / script > < script type = "text/javascript" src = "../lib/index.js" > < / script > < script type = "text/javascript" src = "../index.js" > < / script > < script type = "text/javascript" src = "../lib/scheduler.js" > < / script > < script type = "text/javascript" src = "../lib/template.js" > < / script > < script type = "text/javascript" > / * t h i s v a r i a b l e c a n b e u s e d b y t h e J S t o d e t e r m i n e t h e p a t h t o t h e r o o t d o c u m e n t * /
2022-05-11 10:31:34 +00:00
var toRoot = '../';< / script > < / head > < body > < div id = "search" > < span id = "doc-title" > < span id = "doc-version" > < / span > < / span > < span class = "close-results" > < span class = "left" > < < / span > Back< / span > < div id = "textfilter" > < span class = "input" > < input autocapitalize = "none" placeholder = "Search" id = "index-input" type = "text" accesskey = "/" / > < i class = "clear material-icons" > < / i > < i id = "search-icon" class = "material-icons" > < / i > < / span > < / div > < / div > < div id = "search-results" > < div id = "search-progress" > < div id = "progress-fill" > < / div > < / div > < div id = "results-content" > < div id = "entity-results" > < / div > < div id = "member-results" > < / div > < / div > < / div > < div id = "content-scroll-container" style = "-webkit-overflow-scrolling: touch;" > < div id = "content-container" style = "-webkit-overflow-scrolling: touch;" > < div id = "subpackage-spacer" > < div id = "packages" > < h1 > Packages< / h1 > < ul > < li class = "indented0 " name = "_root_.root" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "_root_" class = "anchorToMember" > < / a > < a id = "root:_root_" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../index.html" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > < / span > < span class = "kind" > package< / span > < / span > < span class = "symbol" > < a href = "../index.html" title = "" > < span class = "name" > root< / span > < / a > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > < a href = "../index.html" name = "_root_" id = "_root_" class = "extype" > root< / a > < / dd > < / dl > < / div > < / li > < li class = "indented1 " name = "_root_.lnrpc" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "lnrpc" class = "anchorToMember" > < / a > < a id = "lnrpc:lnrpc" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/index.html" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > < / span > < span class = "kind" > package< / span > < / span > < span class = "symbol" > < a href = "index.html" title = "" > < span class = "name" > lnrpc< / span > < / a > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > < a href = "../index.html" name = "_root_" id = "_root_" class = "extype" > root< / a > < / dd > < / dl > < / div > < / li > < li class = "current-entities indented1" > < a href = "AMP$.html" title = "" class = "object" > < / a > < a href = "AMP.html" title = "Details specific to AMP HTLCs." class = "class" > < / a > < a href = "AMP.html" title = "Details specific to AMP HTLCs." > AMP< / a > < / li > < li class = "current-entities indented1" > < a href = "AMPInvoiceState$.html" title = "" class = "object" > < / a > < a href = "AMPInvoiceState.html" title = "" class = "class" > < / a > < a href = "AMPInvoiceState.html" title = "" > AMPInvoiceState< / a > < / li > < li class = "current-entities indented1" > < a href = "AMPRecord$.html" title = "" class = "object" > < / a > < a href = "AMPRecord.html" title = "" class = "class" > < / a > < a href = "AMPRecord.html" title = "" > AMPRecord< / a > < / li > < li class = "current-entities indented1" > < a href = "AbandonChannelRequest$.html" title = "" class = "object" > < / a > < a href = "AbandonChannelRequest.html" title = "" class = "class" > < / a > < a href = "AbandonChannelRequest.html" title = "" > AbandonChannelRequest< / a > < / li > < li class = "current-entities indented1" > < a href = "AbandonChannelResponse$.html" title = "" class = "object" > < / a > < a href = "AbandonChannelResponse.html" title = "" class = "class" > < / a > < a href = "AbandonChannelResponse.html" title = "" > AbandonChannelResponse< / a > < / li > < li class = "current-entities indented1" > < a href = "AddInvoiceResponse$.html" title = "" class = "object" > < / a > < a href = "AddInvoiceResponse.html" title = "" class = "class" > < / a > < a href = "AddInvoiceResponse.html" title = "" > AddInvoiceResponse< / a > < / li > < li class = "current-entities indented1" > < a href = "AddressType$.html" title = "" class = "object" > < / a > < a href = "AddressType.html" title = "AddressType has to be one of:" class = "class" > < / a > < a href = "AddressType.html" title = "AddressType has to be one of:" > AddressType< / a > < / li > < li class = "current-entities indented1" > < a href = "Amount$.html" title = "" class = "object" > < / a > < a href = "Amount.html" title = "" class = "class" > < / a > < a href = "Amount.html" title = "" > Amount< / a > < / li > < li class = "current-entities indented1" > < a href = "BakeMac
2021-05-01 18:33:34 +00:00
The identity pubkey of the payment recipient. When using REST, this field
must be encoded as base64.< / p > < / dd > < dt class = "param" > destString< / dt > < dd class = "cmt" > < p >
The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.< / p > < / dd > < dt class = "param" > amt< / dt > < dd class = "cmt" > < p >
The amount to send expressed in satoshis.
The fields amt and amt_msat are mutually exclusive.< / p > < / dd > < dt class = "param" > amtMsat< / dt > < dd class = "cmt" > < p >
The amount to send expressed in millisatoshis.
The fields amt and amt_msat are mutually exclusive.< / p > < / dd > < dt class = "param" > paymentHash< / dt > < dd class = "cmt" > < p >
The hash to use within the payment's HTLC. When using REST, this field
must be encoded as base64.< / p > < / dd > < dt class = "param" > paymentHashString< / dt > < dd class = "cmt" > < p >
The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.< / p > < / dd > < dt class = "param" > paymentRequest< / dt > < dd class = "cmt" > < p >
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.< / p > < / dd > < dt class = "param" > finalCltvDelta< / dt > < dd class = "cmt" > < p >
The CLTV delta from the current height that should be used to set the
timelock for the final hop.< / p > < / dd > < dt class = "param" > feeLimit< / dt > < dd class = "cmt" > < p >
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
2022-02-04 12:38:32 +00:00
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.< / p > < / dd > < dt class = "param" > outgoingChanId< / dt > < dd class = "cmt" > < p >
2021-05-01 18:33:34 +00:00
The channel id of the channel that must be taken to the first hop. If zero,
any channel may be used.< / p > < / dd > < dt class = "param" > lastHopPubkey< / dt > < dd class = "cmt" > < p >
The pubkey of the last hop of the route. If empty, any hop may be used.< / p > < / dd > < dt class = "param" > cltvLimit< / dt > < dd class = "cmt" > < p >
An optional maximum total time lock for the route. This should not exceed
lnd's < code > --max-cltv-expiry< / code > setting. If zero, then the value of
< code > --max-cltv-expiry< / code > is enforced.< / p > < / dd > < dt class = "param" > destCustomRecords< / dt > < dd class = "cmt" > < p >
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.< / p > < / dd > < dt class = "param" > allowSelfPayment< / dt > < dd class = "cmt" > < p >
If set, circular payments to self are permitted.< / p > < / dd > < dt class = "param" > destFeatures< / dt > < dd class = "cmt" > < p >
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.< / p > < / dd > < dt class = "param" > paymentAddr< / dt > < dd class = "cmt" > < p >
2022-05-11 10:31:34 +00:00
The payment address of the generated invoice.< / p > < / dd > < / dl > < dl class = "attributes block" > < dt > Annotations< / dt > < dd > < span class = "name" > @SerialVersionUID< / span > < span class = "args" > ()< / span > < / dd > < / dl > < div class = "toggleContainer" > < div class = "toggle block" > < span > Linear Supertypes< / span > < div class = "superTypes hiddenContent" > < a href = "https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.10/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name = "scalapb.lenses.Updatable" id = "scalapb.lenses.Updatable" class = "extype" > Updatable< / a > [< a href = "" name = "lnrpc.SendRequest" id = "lnrpc.SendRequest" class = "extype" > SendRequest< / a > ], < a href = "https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.10/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name = "scalapb.GeneratedMessage" id = "scalapb.GeneratedMessage" class = "extype" > GeneratedMessage< / a > , < a href = "https://docs.oracle.com/en/java/javase/17/docs/api/java/io/Serializable.html#java.io.Serializable" name = "java.io.Serializable" id = "java.io.Serializable" class = "extype" > Serializable< / a > , < a href = "https://www.scala-lang.org/api/2.13.8/scala/Product.html#scala.Product" name = "scala.Product" id = "scala.Product" class = "extype" > Product< / a > , < a href = "https://www.scala-lang.org/api/2.13.8/scala/Equals.html#scala.Equals" name = "scala.Equals" id = "scala.Equals" class = "extype" > Equals< / a > , < a href = "../scala/index.html#AnyRef=Object" name = "scala.AnyRef" id = "scala.AnyRef" class = "extmbr" > AnyRef< / a > , < a href = "https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name = "scala.Any" id = "scala.Any" class = "extype" > Any< / a > < / div > < / div > < / div > < / div > < div id = "mbrsel" > < div class = "toggle" > < / div > < div id = "memberfilter" > < i class = "material-icons arrow" > < / i > < span class = "input" > < input placeholder = "Filter all members" id = "mbrsel-input" type = "text" accesskey = "/" / > < / span > < i class = "clear material-icons" > < / i > < / div > < div id = "filterby" > < div id = "order" > < span class = "filtertype" > Ordering< / span > < ol > < li class = "alpha in" > < span > Alphabetic< / span > < / li > < li class = "inherit out" > < span > By Inheritance< / span > < / li > < / ol > < / div > < div class = "ancestors" > < span class = "filtertype" > Inherited< br / > < / span > < ol id = "linearization" > < li class = "in" name = "lnrpc.SendRequest" > < span > SendRequest< / span > < / li > < li class = "in" name = "scalapb.lenses.Updatable" > < span > Updatable< / span > < / li > < li class = "in" name = "scalapb.GeneratedMessage" > < span > GeneratedMessage< / span > < / li > < li class = "in" name = "java.io.Serializable" > < span > Serializable< / span > < / li > < li class = "in" name = "scala.Product" > < span > Product< / span > < / li > < li class = "in" name = "scala.Equals" > < span > Equals< / span > < / li > < li class = "in" name = "scala.AnyRef" > < span > AnyRef< / span > < / li > < li class = "in" name = "scala.Any" > < span > Any< / span > < / li > < / ol > < / div > < div class = "ancestors" > < span class = "filtertype" > < / span > < ol > < li class = "hideall out" > < span > Hide All< / span > < / li > < li class = "showall in" > < span > Show All< / span > < / li > < / ol > < / div > < div id = "visbl" > < span class = "filtertype" > Visibility< / span > < ol > < li class = "public in" > < span > Public< / span > < / li > < li class = "protected out" > < span > Protected< / span > < / li > < / ol > < / div > < / div > < / div > < div id = "template" > < div id = "allMembers" > < div id = "constructors" class = "members" > < h3 > Instance Constructors< / h3 > < ol > < li class = "indented0 " name = "lnrpc.SendRequest#<init>" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "<init>(dest:com.google.protobuf.ByteString,destString:String,amt:Long,amtMsat:Long,paymentHash:com.google.protobuf.ByteString,paymentHashString:String,paymentRequest:String,finalCltvDelta:Int,feeLimit:Option[lnrpc.FeeLimit],outgoingChanId:org.bitcoins.core.number.UInt64,lastHopPubkey:com.google.protobuf.ByteString,cltvLimit:org.bitcoins.core.number.UInt32,destCustomRecords:scala.collection.immutable.Map[org.bitcoins.core.number.UInt64,com.google.protobuf.ByteString],allowSelfPayment:Boolean,destFeatures:Seq[lnrpc.FeatureBit],paymentAddr:com.google.protobuf.ByteString,unknownFields:scalapb.UnknownFieldSet):lnrpc.SendRequest" class = "anchorToMember" > < / a > < a id = "<init>:SendRequest" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/SendRequest.html#<
2021-05-01 18:33:34 +00:00
The identity pubkey of the payment recipient. When using REST, this field
must be encoded as base64.< / p > < / dd > < dt class = "param" > destString< / dt > < dd class = "cmt" > < p >
The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.< / p > < / dd > < dt class = "param" > amt< / dt > < dd class = "cmt" > < p >
The amount to send expressed in satoshis.
The fields amt and amt_msat are mutually exclusive.< / p > < / dd > < dt class = "param" > amtMsat< / dt > < dd class = "cmt" > < p >
The amount to send expressed in millisatoshis.
The fields amt and amt_msat are mutually exclusive.< / p > < / dd > < dt class = "param" > paymentHash< / dt > < dd class = "cmt" > < p >
The hash to use within the payment's HTLC. When using REST, this field
must be encoded as base64.< / p > < / dd > < dt class = "param" > paymentHashString< / dt > < dd class = "cmt" > < p >
The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.< / p > < / dd > < dt class = "param" > paymentRequest< / dt > < dd class = "cmt" > < p >
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.< / p > < / dd > < dt class = "param" > finalCltvDelta< / dt > < dd class = "cmt" > < p >
The CLTV delta from the current height that should be used to set the
timelock for the final hop.< / p > < / dd > < dt class = "param" > feeLimit< / dt > < dd class = "cmt" > < p >
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
2022-02-04 12:38:32 +00:00
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.< / p > < / dd > < dt class = "param" > outgoingChanId< / dt > < dd class = "cmt" > < p >
2021-05-01 18:33:34 +00:00
The channel id of the channel that must be taken to the first hop. If zero,
any channel may be used.< / p > < / dd > < dt class = "param" > lastHopPubkey< / dt > < dd class = "cmt" > < p >
The pubkey of the last hop of the route. If empty, any hop may be used.< / p > < / dd > < dt class = "param" > cltvLimit< / dt > < dd class = "cmt" > < p >
An optional maximum total time lock for the route. This should not exceed
lnd's < code > --max-cltv-expiry< / code > setting. If zero, then the value of
< code > --max-cltv-expiry< / code > is enforced.< / p > < / dd > < dt class = "param" > destCustomRecords< / dt > < dd class = "cmt" > < p >
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.< / p > < / dd > < dt class = "param" > allowSelfPayment< / dt > < dd class = "cmt" > < p >
If set, circular payments to self are permitted.< / p > < / dd > < dt class = "param" > destFeatures< / dt > < dd class = "cmt" > < p >
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.< / p > < / dd > < dt class = "param" > paymentAddr< / dt > < dd class = "cmt" > < p >
2022-05-11 10:31:34 +00:00
The payment address of the generated invoice.< / p > < / dd > < / dl > < / div > < / li > < / ol > < / div > < div class = "values members" > < h3 > Value Members< / h3 > < ol > < li class = "indented0 " name = "scala.AnyRef#!=" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "!=(x$1:Any):Boolean" class = "anchorToMember" > < / a > < a id = "!=(Any):Boolean" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/SendRequest.html#!=(x$1:Any):Boolean" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" title = "gt4s: $bang$eq" > !=< / span > < span class = "params" > (< span name = "arg0" > arg0: < a href = "https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name = "scala.Any" id = "scala.Any" class = "extype" > Any< / a > < / span > )< / span > < span class = "result" > : < a href = "https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name = "scala.Boolean" id = "scala.Boolean" class = "extype" > Boolean< / a > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > AnyRef → Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "scala.AnyRef###" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "##:Int" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/SendRequest.html###:Int" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" title = "gt4s: $hash$hash" > ##< / span > < span class = "result" > : < a href = "https://www.scala-lang.org/api/2.13.8/scala/Int.html#scala.Int" name = "scala.Int" id = "scala.Int" class = "extype" > Int< / a > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > AnyRef → Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "scala.AnyRef#==" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "==(x$1:Any):Boolean" class = "anchorToMember" > < / a > < a id = "==(Any):Boolean" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/SendRequest.html#==(x$1:Any):Boolean" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" title = "gt4s: $eq$eq" > ==< / span > < span class = "params" > (< span name = "arg0" > arg0: < a href = "https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name = "scala.Any" id = "scala.Any" class = "extype" > Any< / a > < / span > )< / span > < span class = "result" > : < a href = "https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name = "scala.Boolean" id = "scala.Boolean" class = "extype" > Boolean< / a > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > AnyRef → Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "lnrpc.SendRequest#addAllDestCustomRecords" group = "Ungrouped" fullComment = "no" data-isabs = "false" visbl = "pub" > < a id = "addAllDestCustomRecords(__vs:Iterable[(org.bitcoins.core.number.UInt64,com.google.protobuf.ByteString)]):lnrpc.SendRequest" class = "anchorToMember" > < / a > < a id = "addAllDestCustomRecords(Iterable[(UInt64,ByteString)]):SendRequest" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/SendRequest.html#addAllDestCustomRecords(__vs:Iterable[(org.bitcoins.core.number.UInt64,com.google.protobuf.ByteString)]):lnrpc.SendRequest" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" > addAllDestCustomRecords< / span > < span class = "params" > (< span name = "__vs" > __vs: < a href = "../scala/index.html#Iterable[+A]=Iterable[A]" name = "scala.Iterable" id = "scala.Iterable" class = "extmbr" > Iterable< / a > [(< a href = "../org/bitcoins/core/number/UInt64.html" name = "org.bitcoins.core.number.UInt64" id = "org.bitcoins.core.number.UInt64" class = "extype" > UInt64< / a > , < a href = "https://java
