mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-19 13:35:17 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/api/lnrpc/index.html

1311 lines
1.1 MiB
HTML
Raw Normal View History

Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
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">/* this variable can be used by the JS to determine the path to the root document */
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +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">&lt;</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 current" 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"><span class="name">lnrpc</span></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="AliasMap$.html" title="" class="object"></a> <a href="AliasMap.html" title="" class="class"></a><a href="AliasMap.html" title="">AliasMap</a></li><li class="current-entities indented1"><a href="Amount$.html" title="" cla
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
</p></div><dl class="paramcmts block"><dt class="param">rootShare</dt><dd class="cmt"><p>
An n-of-n secret share of the root seed from which child payment hashes
and preimages are derived.</p></dd><dt class="param">setId</dt><dd class="cmt"><p>
An identifier for the HTLC set that this HTLC belongs to.</p></dd><dt class="param">childIndex</dt><dd class="cmt"><p>
A nonce used to randomize the child preimage and child hash from a given
root_share.</p></dd><dt class="param">hash</dt><dd class="cmt"><p>
The payment hash of the AMP HTLC.</p></dd><dt class="param">preimage</dt><dd class="cmt"><p>
The preimage used to settle this AMP htlc. This field will only be
populated if the invoice is in InvoiceState_ACCEPTED or
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
InvoiceState_SETTLED.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.AMPInvoiceState" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AMPInvoiceStateextendsGeneratedMessagewithUpdatable[lnrpc.AMPInvoiceState]withProductwithSerializable" class="anchorToMember"></a><a id="AMPInvoiceState:AMPInvoiceState" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AMPInvoiceState.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AMPInvoiceState.html" title=""><span class="name">AMPInvoiceState</span></a><span class="params">(<span name="state">state: <a href="InvoiceHTLCState.html" name="lnrpc.InvoiceHTLCState" id="lnrpc.InvoiceHTLCState" class="extype">InvoiceHTLCState</a> = <span class="symbol"><span class="name"><a href="">lnrpc.InvoiceHTLCState.ACCEPTED</a></span></span></span>, <span name="settleIndex">settleIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.AMPInvoiceState._typemapper_settleIndex.toCustom(0L)</a></span></span></span>, <span name="settleTime">settleTime: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="amtPaidMsat">amtPaidMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="AMPInvoiceState.html" name="lnrpc.AMPInvoiceState" id="lnrpc.AMPInvoiceState" class="extype">AMPInvoiceState</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">state</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The state the HTLCs associated with this setID are in.</p></dd><dt class="param">settleIndex</dt><dd class="cmt"><p>
The settle index of this HTLC set, if the invoice state is settled.</p></dd><dt class="param">settleTime</dt><dd class="cmt"><p>
The time this HTLC set was settled expressed in unix epoch.</p></dd><dt class="param">amtPaidMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The total amount paid for the sub-invoice expressed in milli satoshis.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.AMPRecord" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AMPRecordextendsGeneratedMessagewithUpdatable[lnrpc.AMPRecord]withProductwithSerializable" class="anchorToMember"></a><a id="AMPRecord:AMPRecord" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AMPRecord.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AMPRecord.html" title=""><span class="name">AMPRecord</span></a><span class="params">(<span name="rootShare">rootShare: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="setId">setId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="childIndex">childIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.AMPRecord._typemapper_childIndex.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="AMPRecord.html" name="lnrpc.AMPRecord" id="lnrpc.AMPRecord" class="extype">AMPRecord</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.AbandonChannelRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AbandonChannelRequestextendsGeneratedMessagewithUpdatable[lnrpc.AbandonChannelRequest]withProductwithSerializable" class="anchorToMember"></a><a id="AbandonChannelRequest:AbandonChannelRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AbandonChannelRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AbandonChan
Deploy website Deploy website version based on 35d2c6db4ef1752940d418e805a9572f33ea556e
2021-07-21 20:44:43 +00:00
Override the requirement for being in dev mode by setting this to true and
confirming the user knows what they are doing and this is a potential foot
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
gun to lose funds if used on active channels.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.AbandonChannelResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AbandonChannelResponseextendsGeneratedMessagewithUpdatable[lnrpc.AbandonChannelResponse]withProductwithSerializable" class="anchorToMember"></a><a id="AbandonChannelResponse:AbandonChannelResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AbandonChannelResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AbandonChannelResponse.html" title=""><span class="name">AbandonChannelResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="AbandonChannelResponse.html" name="lnrpc.AbandonChannelResponse" id="lnrpc.AbandonChannelResponse" class="extype">AbandonChannelResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.AddInvoiceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddInvoiceResponseextendsGeneratedMessagewithUpdatable[lnrpc.AddInvoiceResponse]withProductwithSerializable" class="anchorToMember"></a><a id="AddInvoiceResponse:AddInvoiceResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AddInvoiceResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AddInvoiceResponse.html" title=""><span class="name">AddInvoiceResponse</span></a><span class="params">(<span name="rHash">rHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="paymentRequest">paymentRequest: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="addIndex">addIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.AddInvoiceResponse._typemapper_addIndex.toCustom(0L)</a></span></span></span>, <span name="paymentAddr">paymentAddr: <a href="https://javadoc.i
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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">addIndex</dt><dd class="cmt"><p>
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.</p></dd><dt class="param">paymentAddr</dt><dd class="cmt"><p>
The payment address of the generated invoice. This value should be used
in all payments for this invoice as we require it for end to end
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
security.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.AddressType" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="AddressTypeextendsGeneratedEnum" class="anchorToMember"></a><a id="AddressType:AddressType" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AddressType.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="AddressType.html" title="AddressType has to be one of:"><span class="name">AddressType</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span><p class="shortcomment cmt"><code>AddressType</code> has to be one of:</p><div class="fullcomment"><div class="comment cmt"><p><code>AddressType</code> has to be one of:</p><p>- <code>p2wkh</code>: Pay to witness key hash (<code>WITNESS_PUBKEY_HASH</code> = 0)
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
- <code>np2wkh</code>: Pay to nested witness key hash (<code>NESTED_PUBKEY_HASH</code> = 1)
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
- <code>p2tr</code>: Pay to taproot pubkey (<code>TAPROOT_PUBKEY</code> = 4)
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.AliasMap" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AliasMapextendsGeneratedMessagewithUpdatable[lnrpc.AliasMap]withProductwithSerializable" class="anchorToMember"></a><a id="AliasMap:AliasMap" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AliasMap.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="AliasMap.html" title=""><span class="name">AliasMap</span></a><span class="params">(<span name="baseScid">baseScid: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.AliasMap._typemapper_baseScid.toCustom(0L)</a></span></span></span>, <span name="aliases">aliases: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</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>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="AliasMap.html" name="lnrpc.AliasMap" id="lnrpc.AliasMap" class="extype">AliasMap</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">baseScid</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
For non-zero-conf channels, this is the confirmed SCID. Otherwise, this is
the first assigned "base" alias.</p></dd><dt class="param">aliases</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The set of all aliases stored for the base SCID.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Amount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AmountextendsGeneratedMessagewithUpdatable[lnrpc.Amount]withProductwithSerializable" class="anchorToMember"></a><a id="Amount:Amount" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Amount.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Amount.html" title=""><span class="name">Amount</span></a><span class="params">(<span name="sat">sat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Amount._typemapper_sat.toCustom(0L)</a></span></span></span>, <span name="msat">msat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Amount._typemapper_msat.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="Amount.html" name="lnrpc.Amount" id="lnrpc.Amount" class="extype">Amount</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">sat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Value denominated in satoshis.</p></dd><dt class="param">msat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Value denominated in milli-satoshis.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.BakeMacaroonRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BakeMacaroonRequestextendsGeneratedMessagewithUpdatable[lnrpc.BakeMacaroonRequest]withProductwithSerializable" class="anchorToMember"></a><a id="BakeMacaroonRequest:BakeMacaroonRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/BakeMacaroonRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BakeMacaroonRequest.html" title=""><span class="name">BakeMacaroonRequest</span></a><span class="params">(<span name="permissions">permissions: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="MacaroonPermission.html" name="lnrpc.MacaroonPermission" id="lnrpc.MacaroonPermission" class="extype">MacaroonPermission</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="rootKeyId">rootKeyId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.BakeMacaroonRequest._typemapper_rootKeyId.toCustom(0L)</a></span></span></span>, <span name="allowExternalPermissions">allowExternalPermissions: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BakeMacaroonRequest.html" name="lnrpc.BakeMacaroonRequest" id="lnrpc.BakeMacaroonRequest" class="extype">BakeMacaroonRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">permissions</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The list of permissions the new macaroon should grant.</p></dd><dt class="param">rootKeyId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The root key ID used to create the macaroon, must be a positive integer.</p></dd><dt class="param">allowExternalPermissions</dt><dd class="cmt"><p>
Informs the RPC on whether to allow external permissions that LND is not
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
aware of.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.BakeMacaroonResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BakeMacaroonResponseextendsGeneratedMessagewithUpdatable[lnrpc.BakeMacaroonResponse]withProductwithSerializable" class="anchorToMember"></a><a id="BakeMacaroonResponse:BakeMacaroonResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/BakeMacaroonResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BakeMacaroonResponse.html" title=""><span class="name">BakeMacaroonResponse</span></a><span class="params">(<span name="macaroon">macaroon: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BakeMacaroonResponse.html" name="lnrpc.BakeMacaroonResponse" id="lnrpc.BakeMacaroonResponse" class="extype">BakeMacaroonResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">macaroon</dt><dd class="cmt"><p>
The hex encoded macaroon, serialized in binary format.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.BatchOpenChannel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BatchOpenChannelextendsGeneratedMessagewithUpdatable[lnrpc.BatchOpenChannel]withProductwithSerializable" class="anchorToMember"></a><a id="BatchOpenChannel:BatchOpenChannel" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/BatchOpenChannel.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BatchOpenChannel.html" title=""><span class="name">BatchOpenChannel</span></a><span class="params">(<span name="nodePubkey">nodePubkey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="localFundingAmount">localFundingAmount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="pushSat">pushSat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="private">private: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="minHtlcMsat">minHtlcMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="remoteCsvDelay">remoteCsvDelay: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.BatchOpenChannel._typemapper_remoteCsvDelay.toCustom(0)</a></span></span></span>, <span name="closeAddress">closeAddress: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="commitmentType">commitmentType: <a href="CommitmentType.html" name="lnrpc.CommitmentType" id="lnrpc.CommitmentType" class="extype">CommitmentType</a> = <span class="defval"><span class="name"><a href="">lnrpc.CommitmentType.UNKNOWN_COMMITMENT_TYPE</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.1
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The pubkey of the node to open a channel with. When using REST, this
field must be encoded as base64.</p></dd><dt class="param">localFundingAmount</dt><dd class="cmt"><p>
The number of satoshis the wallet should commit to the channel.</p></dd><dt class="param">pushSat</dt><dd class="cmt"><p>
The number of satoshis to push to the remote side as part of the initial
commitment state.</p></dd><dt class="param">private</dt><dd class="cmt"><p>
Whether this channel should be private, not announced to the greater
network.</p></dd><dt class="param">minHtlcMsat</dt><dd class="cmt"><p>
The minimum value in millisatoshi we will require for incoming HTLCs on
the channel.</p></dd><dt class="param">remoteCsvDelay</dt><dd class="cmt"><p>
The delay we require on the remote's commitment transaction. If this is
not set, it will be scaled automatically with the channel size.</p></dd><dt class="param">closeAddress</dt><dd class="cmt"><p>
Close address is an optional address which specifies the address to which
funds should be paid out to upon cooperative close. This field may only be
set if the peer supports the option upfront feature bit (call listpeers
to check). The remote peer will only accept cooperative closes to this
address if it is set.
Note: If this value is set on channel creation, you will *not* be able to
cooperatively close out to a different address.</p></dd><dt class="param">pendingChanId</dt><dd class="cmt"><p>
An optional, unique identifier of 32 random bytes that will be used as the
pending channel ID to identify the channel while it is in the pre-pending
state.</p></dd><dt class="param">commitmentType</dt><dd class="cmt"><p>
The explicit commitment type to use. Note this field will only be used if
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
the remote peer supports explicit channel negotiation.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.BatchOpenChannelRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BatchOpenChannelRequestextendsGeneratedMessagewithUpdatable[lnrpc.BatchOpenChannelRequest]withProductwithSerializable" class="anchorToMember"></a><a id="BatchOpenChannelRequest:BatchOpenChannelRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/BatchOpenChannelRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BatchOpenChannelRequest.html" title=""><span class="name">BatchOpenChannelRequest</span></a><span class="params">(<span name="channels">channels: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="BatchOpenChannel.html" name="lnrpc.BatchOpenChannel" id="lnrpc.BatchOpenChannel" class="extype">BatchOpenChannel</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="targetConf">targetConf: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="satPerVbyte">satPerVbyte: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="minConfs">minConfs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="spendUnconfirmed">spendUnconfirmed: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="label">label: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BatchOpenChannelRequest.html" name="lnrpc.BatchOpenChannelRequest" id="lnrpc.BatchOpenChannelRequest" class="extype">BatchOpenChannelRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">channels</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The list of channels to open.</p></dd><dt class="param">targetConf</dt><dd class="cmt"><p>
The target number of blocks that the funding transaction should be
confirmed by.</p></dd><dt class="param">satPerVbyte</dt><dd class="cmt"><p>
A manual fee rate set in sat/vByte that should be used when crafting the
funding transaction.</p></dd><dt class="param">minConfs</dt><dd class="cmt"><p>
The minimum number of confirmations each one of your outputs used for
the funding transaction must satisfy.</p></dd><dt class="param">spendUnconfirmed</dt><dd class="cmt"><p>
Whether unconfirmed outputs should be used as inputs for the funding
transaction.</p></dd><dt class="param">label</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
An optional label for the batch transaction, limited to 500 characters.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.BatchOpenChannelResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="BatchOpenChannelResponseextendsGeneratedMessagewithUpdatable[lnrpc.BatchOpenChannelResponse]withProductwithSerializable" class="anchorToMember"></a><a id="BatchOpenChannelResponse:BatchOpenChannelResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/BatchOpenChannelResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="BatchOpenChannelResponse.html" title=""><span class="name">BatchOpenChannelResponse</span></a><span class="params">(<span name="pendingChannels">pendingChannels: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="PendingUpdate.html" name="lnrpc.PendingUpdate" id="lnrpc.PendingUpdate" class="extype">PendingUpdate</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="BatchOpenChannelResponse.html" name="lnrpc.BatchOpenChannelResponse" id="lnrpc.BatchOpenChannelResponse" class="extype">BatchOpenChannelResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Chain" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChainextendsGeneratedMessagewithUpdatable[lnrpc.Chain]withProductwithSerializable" class="anchorToMember"></a><a id="Chain:Chain" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Chain.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Chain.html" title=""><span class="name">Chain</span></a><span class="params">(<span name="chain">chain: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="network">network: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The blockchain the node is on (eg bitcoin, litecoin)</p></dd><dt class="param">network</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The network the node is on (eg regtest, testnet, mainnet)</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChanBackupExportRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChanBackupExportRequestextendsGeneratedMessagewithUpdatable[lnrpc.ChanBackupExportRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ChanBackupExportRequest:ChanBackupExportRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChanBackupExportRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChanBackupExportRequest.html" title=""><span class="name">ChanBackupExportRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChanBackupExportRequest.html" name="lnrpc.ChanBackupExportRequest" id="lnrpc.ChanBackupExportRequest" class="extype">ChanBackupExportRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChanBackupSnapshot" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChanBackupSnapshotextendsGeneratedMessagewithUpdatable[lnrpc.ChanBackupSnapshot]withProductwithSerializable" class="anchorToMember"></a><a id="ChanBackupSnapshot:ChanBackupSnapshot" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChanBackupSnapshot.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChanBackupSnapshot.html" title=""><span class="name">ChanBackupSnapshot</span></a><span class="params">(<span name="singleChanBackups">singleChanBackups: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelBackups.html" name="lnrpc.ChannelBackups" id="lnrpc.ChannelBackups" class="extype">ChannelBackups</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="multiChanBackup">multiChanBackup: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="MultiChanBackup.html" name="lnrpc.MultiChanBackup" id="lnrpc.MultiChanBackup" class="extype">MultiChanBackup</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://jav
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The set of new channels that have been added since the last channel backup
snapshot was requested.</p></dd><dt class="param">multiChanBackup</dt><dd class="cmt"><p>
A multi-channel backup that covers all open channels currently known to
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
lnd.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChanInfoRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChanInfoRequestextendsGeneratedMessagewithUpdatable[lnrpc.ChanInfoRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ChanInfoRequest:ChanInfoRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChanInfoRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChanInfoRequest.html" title=""><span class="name">ChanInfoRequest</span></a><span class="params">(<span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChanInfoRequest._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChanInfoRequest.html" name="lnrpc.ChanInfoRequest" id="lnrpc.ChanInfoRequest" class="extype">ChanInfoRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">chanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
output index for the channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChanPointShim" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChanPointShimextendsGeneratedMessagewithUpdatable[lnrpc.ChanPointShim]withProductwithSerializable" class="anchorToMember"></a><a id="ChanPointShim:ChanPointShim" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChanPointShim.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChanPointShim.html" title=""><span class="name">ChanPointShim</span></a><span class="params">(<span name="amt">amt: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="chanPoint">chanPoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="localKey">localKey: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyDescriptor.html" name="lnrpc.KeyDescriptor" id="lnrpc.KeyDescriptor" class="extype">KeyDescriptor</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="remoteKey">remoteKey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="thawHeight">thawHeight: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChanPointShim._typemapper_thawHeight.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChanPointShim.html" name="lnrpc.ChanPointShim" id="lnrpc.ChanPointShim" class="extype">ChanPointShim</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The size of the pre-crafted output to be used as the channel point for this
channel funding.</p></dd><dt class="param">chanPoint</dt><dd class="cmt"><p>
The target channel point to refrence in created commitment transactions.</p></dd><dt class="param">localKey</dt><dd class="cmt"><p>
Our local key to use when creating the multi-sig output.</p></dd><dt class="param">remoteKey</dt><dd class="cmt"><p>
The key of the remote party to use when creating the multi-sig output.</p></dd><dt class="param">pendingChanId</dt><dd class="cmt"><p>
If non-zero, then this will be used as the pending channel ID on the wire
protocol to initate the funding request. This is an optional field, and
should only be set if the responder is already expecting a specific pending
channel ID.</p></dd><dt class="param">thawHeight</dt><dd class="cmt"><p>
This uint32 indicates if this channel is to be considered 'frozen'. A frozen
channel does not allow a cooperative channel close by the initiator. The
thaw_height is the height that this restriction stops applying to the
channel. The height can be interpreted in two ways: as a relative height if
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
the value is less than 500,000, or as an absolute height otherwise.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChangePasswordRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChangePasswordRequestextendsGeneratedMessagewithUpdatable[lnrpc.ChangePasswordRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ChangePasswordRequest:ChangePasswordRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChangePasswordRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChangePasswordRequest.html" title=""><span class="name">ChangePasswordRequest</span></a><span class="params">(<span name="currentPassword">currentPassword: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="newPassword">newPassword: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="statelessInit">statelessInit: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="newMacaroonRootKey">newMacaroonRootKey: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChangePasswordRequest.html" name="lnrpc.ChangePasswordRequest" id="lnrpc.ChangePasswordRequest" class="extype">ChangePasswordRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">currentPassword</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
current_password should be the current valid passphrase used to unlock the
daemon. When using REST, this field must be encoded as base64.</p></dd><dt class="param">newPassword</dt><dd class="cmt"><p>
new_password should be the new passphrase that will be needed to unlock the
daemon. When using REST, this field must be encoded as base64.</p></dd><dt class="param">statelessInit</dt><dd class="cmt"><p>
stateless_init is an optional argument instructing the daemon NOT to create
any *.macaroon files in its filesystem. If this parameter is set, then the
admin macaroon returned in the response MUST be stored by the caller of the
RPC as otherwise all access to the daemon will be lost!</p></dd><dt class="param">newMacaroonRootKey</dt><dd class="cmt"><p>
new_macaroon_root_key is an optional argument instructing the daemon to
rotate the macaroon root key when set to true. This will invalidate all
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
previously generated macaroons.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChangePasswordResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChangePasswordResponseextendsGeneratedMessagewithUpdatable[lnrpc.ChangePasswordResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ChangePasswordResponse:ChangePasswordResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChangePasswordResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChangePasswordResponse.html" title=""><span class="name">ChangePasswordResponse</span></a><span class="params">(<span name="adminMacaroon">adminMacaroon: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChangePasswordResponse.html" name="lnrpc.ChangePasswordResponse" id="lnrpc.ChangePasswordResponse" class="extype">ChangePasswordResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">adminMacaroon</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The binary serialized admin macaroon that can be used to access the daemon
after rotating the macaroon root key. If both the stateless_init and
new_macaroon_root_key parameter were set to true, this is the ONLY copy of
the macaroon that was created from the new root key and MUST be stored
safely by the caller. Otherwise a copy of this macaroon is also persisted on
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
disk by the daemon, together with other macaroon files.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Channel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelextendsGeneratedMessagewithUpdatable[lnrpc.Channel]withProductwithSerializable" class="anchorToMember"></a><a id="Channel:Channel" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Channel.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Channel.html" title=""><span class="name">Channel</span></a><span class="params">(<span name="active">active: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="remotePubkey">remotePubkey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="channelPoint">channelPoint: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Channel._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="capacity">capacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="localBalance">localBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="remoteBalance">remoteBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="commitFee">commitFee: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="commitWeight">commitWeight: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="feePerKw">feePerKw: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unsettledBalance">unsettledBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="totalSatoshisSent">totalSatoshisSent: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="totalSatoshisReceived">totalSatoshisReceived: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="numUpdates">numUpdates: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Channel._typemapper_numUpdates.toCustom(0L)</a></span></span></span>, <span name="pendingHtlcs">pendingHtlcs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="HTLC.html" name="lnrpc.HTL
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Whether this channel is active or not</p></dd><dt class="param">remotePubkey</dt><dd class="cmt"><p>
The identity pubkey of the remote node</p></dd><dt class="param">channelPoint</dt><dd class="cmt"><p>
The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.</p></dd><dt class="param">chanId</dt><dd class="cmt"><p>
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
output index for the channel.</p></dd><dt class="param">capacity</dt><dd class="cmt"><p>
The total amount of funds held in this channel</p></dd><dt class="param">localBalance</dt><dd class="cmt"><p>
This node's current balance in this channel</p></dd><dt class="param">remoteBalance</dt><dd class="cmt"><p>
The counterparty's current balance in this channel</p></dd><dt class="param">commitFee</dt><dd class="cmt"><p>
The amount calculated to be paid in fees for the current set of commitment
transactions. The fee amount is persisted with the channel in order to
allow the fee amount to be removed and recalculated with each channel state
update, including updates that happen after a system restart.</p></dd><dt class="param">commitWeight</dt><dd class="cmt"><p>
The weight of the commitment transaction</p></dd><dt class="param">feePerKw</dt><dd class="cmt"><p>
The required number of satoshis per kilo-weight that the requester will pay
at all times, for both the funding transaction and commitment transaction.
This value can later be updated once the channel is open.</p></dd><dt class="param">unsettledBalance</dt><dd class="cmt"><p>
The unsettled balance in this channel</p></dd><dt class="param">totalSatoshisSent</dt><dd class="cmt"><p>
The total number of satoshis we've sent within this channel.</p></dd><dt class="param">totalSatoshisReceived</dt><dd class="cmt"><p>
The total number of satoshis we've received within this channel.</p></dd><dt class="param">numUpdates</dt><dd class="cmt"><p>
The total number of updates conducted within this channel.</p></dd><dt class="param">pendingHtlcs</dt><dd class="cmt"><p>
The list of active, uncleared HTLCs currently pending within the channel.</p></dd><dt class="param">csvDelay</dt><dd class="cmt"><p>
Deprecated. The CSV delay expressed in relative blocks. If the channel is
force closed, we will need to wait for this many blocks before we can regain
our funds.</p></dd><dt class="param">private</dt><dd class="cmt"><p>
Whether this channel is advertised to the network or not.</p></dd><dt class="param">initiator</dt><dd class="cmt"><p>
True if we were the ones that created the channel.</p></dd><dt class="param">chanStatusFlags</dt><dd class="cmt"><p>
A set of flags showing the current state of the channel.</p></dd><dt class="param">localChanReserveSat</dt><dd class="cmt"><p>
Deprecated. The minimum satoshis this node is required to reserve in its
balance.</p></dd><dt class="param">remoteChanReserveSat</dt><dd class="cmt"><p>
Deprecated. The minimum satoshis the other node is required to reserve in
its balance.</p></dd><dt class="param">staticRemoteKey</dt><dd class="cmt"><p>
Deprecated. Use commitment_type.</p></dd><dt class="param">commitmentType</dt><dd class="cmt"><p>
The commitment type used by this channel.</p></dd><dt class="param">lifetime</dt><dd class="cmt"><p>
The number of seconds that the channel has been monitored by the channel
scoring system. Scores are currently not persisted, so this value may be
less than the lifetime of the channel [EXPERIMENTAL].</p></dd><dt class="param">uptime</dt><dd class="cmt"><p>
The number of seconds that the remote peer has been observed as being online
by the channel scoring system over the lifetime of the channel
[EXPERIMENTAL].</p></dd><dt class="param">closeAddress</dt><dd class="cmt"><p>
Close address is the address that we will enforce payout to on cooperative
close if the channel was opened utilizing option upfront shutdown. This
value can be set on channel open by setting close_address in an open channel
request. If this value is not set, you can still choose a payout address by
cooperatively closing with the delivery_address field set.</p></dd><dt class="param">pushAmountSat</dt><dd class="cmt"><p>
The amount that the initiator of the channel optionally pushed to the remote
party on channel open. This amount will be zero if the channel initiator did
not push any funds to the remote peer. If the initiator field is true, we
pushed this amount to our peer, if it is false, the remote peer pushed this
amount to us.</p></dd><dt class="param">thawHeight</dt><dd class="cmt"><p>
This uint32 indicates if this channel is to be considered 'frozen'. A
frozen channel doest not allow a cooperative channel close by the
initiator. The thaw_height is the height that this restriction stops
applying to the channel. This field is optional, not setting it or using a
value of zero will mean the channel has no additional restrictions. The
height can be interpreted in two ways: as a relative height if the value is
less than 500,000, or as an absolute height otherwise.</p></dd><dt class="param">localConstraints</dt><dd class="cmt"><p>
List constraints for the local node.</p></dd><dt class="param">remoteConstraints</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
List constraints for the remote node.</p></dd><dt class="param">aliasScids</dt><dd class="cmt"><p>
This lists out the set of alias short channel ids that exist for a channel.
This may be empty.</p></dd><dt class="param">zeroConf</dt><dd class="cmt"><p>
Whether or not this is a zero-conf channel.</p></dd><dt class="param">zeroConfConfirmedScid</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
This is the confirmed / on-chain zero-conf SCID.</p></dd><dt class="param">peerAlias</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The configured alias name of our peer.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelAcceptRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelAcceptRequestextendsGeneratedMessagewithUpdatable[lnrpc.ChannelAcceptRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelAcceptRequest:ChannelAcceptRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelAcceptRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelAcceptRequest.html" title=""><span class="name">ChannelAcceptRequest</span></a><span class="params">(<span name="nodePubkey">nodePubkey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="chainHash">chainHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="fundingAmt">fundingAmt: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptRequest._typemapper_fundingAmt.toCustom(0L)</a></span></span></span>, <span name="pushAmt">pushAmt: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptRequest._typemapper_pushAmt.toCustom(0L)</a></span></span></span>, <span name="dustLimit">dustLimit: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptRequest._typemapper_dustLimit.toCustom(0L)</a></span></span></span>, <span name="maxValueInFlight">maxValueInFlight: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptRequest._typemapper_maxValueInFlight.toCustom(0L)</a></span></span></span>, <span name="channelReserve">channelReserve: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptRequest._typemapper_channelReserve.toCustom(0L)</a></span></span></span>, <span name="minHtlc">minHtlc: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a hr
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The pubkey of the node that wishes to open an inbound channel.</p></dd><dt class="param">chainHash</dt><dd class="cmt"><p>
The hash of the genesis block that the proposed channel resides in.</p></dd><dt class="param">pendingChanId</dt><dd class="cmt"><p>
The pending channel id.</p></dd><dt class="param">fundingAmt</dt><dd class="cmt"><p>
The funding amount in satoshis that initiator wishes to use in the
channel.</p></dd><dt class="param">pushAmt</dt><dd class="cmt"><p>
The push amount of the proposed channel in millisatoshis.</p></dd><dt class="param">dustLimit</dt><dd class="cmt"><p>
The dust limit of the initiator's commitment tx.</p></dd><dt class="param">maxValueInFlight</dt><dd class="cmt"><p>
The maximum amount of coins in millisatoshis that can be pending in this
channel.</p></dd><dt class="param">channelReserve</dt><dd class="cmt"><p>
The minimum amount of satoshis the initiator requires us to have at all
times.</p></dd><dt class="param">minHtlc</dt><dd class="cmt"><p>
The smallest HTLC in millisatoshis that the initiator will accept.</p></dd><dt class="param">feePerKw</dt><dd class="cmt"><p>
The initial fee rate that the initiator suggests for both commitment
transactions.</p></dd><dt class="param">csvDelay</dt><dd class="cmt"><p>
The number of blocks to use for the relative time lock in the pay-to-self
output of both commitment transactions.</p></dd><dt class="param">maxAcceptedHtlcs</dt><dd class="cmt"><p>
The total number of incoming HTLC's that the initiator will accept.</p></dd><dt class="param">channelFlags</dt><dd class="cmt"><p>
A bit-field which the initiator uses to specify proposed channel
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
behavior.</p></dd><dt class="param">commitmentType</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
The commitment type the initiator wishes to use for the proposed channel.</p></dd><dt class="param">wantsZeroConf</dt><dd class="cmt"><p>
Whether the initiator wants to open a zero-conf channel via the channel
type.</p></dd><dt class="param">wantsScidAlias</dt><dd class="cmt"><p>
Whether the initiator wants to use the scid-alias channel type. This is
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
separate from the feature bit.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelAcceptResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelAcceptResponseextendsGeneratedMessagewithUpdatable[lnrpc.ChannelAcceptResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelAcceptResponse:ChannelAcceptResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelAcceptResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelAcceptResponse.html" title=""><span class="name">ChannelAcceptResponse</span></a><span class="params">(<span name="accept">accept: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="error">error: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="upfrontShutdown">upfrontShutdown: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="csvDelay">csvDelay: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptResponse._typemapper_csvDelay.toCustom(0)</a></span></span></span>, <span name="reserveSat">reserveSat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptResponse._typemapper_reserveSat.toCustom(0L)</a></span></span></span>, <span name="inFlightMaxMsat">inFlightMaxMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptResponse._typemapper_inFlightMaxMsat.toCustom(0L)</a></span></span></span>, <span name="maxHtlcCount">maxHtlcCount: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptResponse._typemapper_maxHtlcCount.toCustom(0)</a></span></span></span>, <span name="minHtlcIn">minHtlcIn: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptResponse._typemapper_minHtlcIn.toCustom(0L)</a></span></span></span>, <span name="minAcceptDepth">minAcceptDepth: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelAcceptResponse._typemapper_minAcceptDepth.toCustom(0)</a></span></span></span>, <span name="zeroConf">zeroConf: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span na
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Whether or not the client accepts the channel.</p></dd><dt class="param">pendingChanId</dt><dd class="cmt"><p>
The pending channel id to which this response applies.</p></dd><dt class="param">error</dt><dd class="cmt"><p>
An optional error to send the initiating party to indicate why the channel
was rejected. This field *should not* contain sensitive information, it will
be sent to the initiating party. This field should only be set if accept is
false, the channel will be rejected if an error is set with accept=true
because the meaning of this response is ambiguous. Limited to 500
characters.</p></dd><dt class="param">upfrontShutdown</dt><dd class="cmt"><p>
The upfront shutdown address to use if the initiating peer supports option
upfront shutdown script (see ListPeers for the features supported). Note
that the channel open will fail if this value is set for a peer that does
not support this feature bit.</p></dd><dt class="param">csvDelay</dt><dd class="cmt"><p>
The csv delay (in blocks) that we require for the remote party.</p></dd><dt class="param">reserveSat</dt><dd class="cmt"><p>
The reserve amount in satoshis that we require the remote peer to adhere to.
We require that the remote peer always have some reserve amount allocated to
them so that there is always a disincentive to broadcast old state (if they
hold 0 sats on their side of the channel, there is nothing to lose).</p></dd><dt class="param">inFlightMaxMsat</dt><dd class="cmt"><p>
The maximum amount of funds in millisatoshis that we allow the remote peer
to have in outstanding htlcs.</p></dd><dt class="param">maxHtlcCount</dt><dd class="cmt"><p>
The maximum number of htlcs that the remote peer can offer us.</p></dd><dt class="param">minHtlcIn</dt><dd class="cmt"><p>
The minimum value in millisatoshis for incoming htlcs on the channel.</p></dd><dt class="param">minAcceptDepth</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
The number of confirmations we require before we consider the channel open.</p></dd><dt class="param">zeroConf</dt><dd class="cmt"><p>
Whether the responder wants this to be a zero-conf channel. This will fail
if either side does not have the scid-alias feature bit set. The minimum
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
depth field must be zero if this is true.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelBackup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelBackupextendsGeneratedMessagewithUpdatable[lnrpc.ChannelBackup]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelBackup:ChannelBackup" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelBackup.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelBackup.html" title=""><span class="name">ChannelBackup</span></a><span class="params">(<span name="chanPoint">chanPoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="chanBackup">chanBackup: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelBackup.html" name="lnrpc.ChannelBackup" id="lnrpc.ChannelBackup" class="extype">ChannelBackup</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">chanPoint</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Identifies the channel that this backup belongs to.</p></dd><dt class="param">chanBackup</dt><dd class="cmt"><p>
Is an encrypted single-chan backup. this can be passed to
RestoreChannelBackups, or the WalletUnlocker Init and Unlock methods in
order to trigger the recovery protocol. When using REST, this field must be
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
encoded as base64.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelBackupSubscription" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelBackupSubscriptionextendsGeneratedMessagewithUpdatable[lnrpc.ChannelBackupSubscription]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelBackupSubscription:ChannelBackupSubscription" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelBackupSubscription.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelBackupSubscription.html" title=""><span class="name">ChannelBackupSubscription</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelBackupSubscription.html" name="lnrpc.ChannelBackupSubscription" id="lnrpc.ChannelBackupSubscription" class="extype">ChannelBackupSubscription</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelBackups" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelBackupsextendsGeneratedMessagewithUpdatable[lnrpc.ChannelBackups]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelBackups:ChannelBackups" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelBackups.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelBackups.html" title=""><span class="name">ChannelBackups</span></a><span class="params">(<span name="chanBackups">chanBackups: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="ChannelBackup.html" name="lnrpc.ChannelBackup" id="lnrpc.ChannelBackup" class="extype">ChannelBackup</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="e
A set of single-chan static channel backups.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelBalanceRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelBalanceRequestextendsGeneratedMessagewithUpdatable[lnrpc.ChannelBalanceRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelBalanceRequest:ChannelBalanceRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelBalanceRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelBalanceRequest.html" title=""><span class="name">ChannelBalanceRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelBalanceRequest.html" name="lnrpc.ChannelBalanceRequest" id="lnrpc.ChannelBalanceRequest" class="extype">ChannelBalanceRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelBalanceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelBalanceResponseextendsGeneratedMessagewithUpdatable[lnrpc.ChannelBalanceResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelBalanceResponse:ChannelBalanceResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelBalanceResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelBalanceResponse.html" title=""><span class="name">ChannelBalanceResponse</span></a><span class="params">(<span name="balance">balance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="pendingOpenBalance">pendingOpenBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="localBalance">localBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="Amount.html" name="lnrpc.Amount" id="lnrpc.Amount" class="extype">Amount</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="remoteBalance">remoteBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Deprecated. Sum of channels balances denominated in satoshis</p></dd><dt class="param">pendingOpenBalance</dt><dd class="cmt"><p>
Deprecated. Sum of channels pending balances denominated in satoshis</p></dd><dt class="param">localBalance</dt><dd class="cmt"><p>
Sum of channels local balances.</p></dd><dt class="param">remoteBalance</dt><dd class="cmt"><p>
Sum of channels remote balances.</p></dd><dt class="param">unsettledLocalBalance</dt><dd class="cmt"><p>
Sum of channels local unsettled balances.</p></dd><dt class="param">unsettledRemoteBalance</dt><dd class="cmt"><p>
Sum of channels remote unsettled balances.</p></dd><dt class="param">pendingOpenLocalBalance</dt><dd class="cmt"><p>
Sum of channels pending local balances.</p></dd><dt class="param">pendingOpenRemoteBalance</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Sum of channels pending remote balances.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelCloseSummary" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelCloseSummaryextendsGeneratedMessagewithUpdatable[lnrpc.ChannelCloseSummary]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelCloseSummary:ChannelCloseSummary" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelCloseSummary.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelCloseSummary.html" title=""><span class="name">ChannelCloseSummary</span></a><span class="params">(<span name="channelPoint">channelPoint: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelCloseSummary._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="chainHash">chainHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="closingTxHash">closingTxHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="remotePubkey">remotePubkey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="capacity">capacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="closeHeight">closeHeight: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelCloseSummary._typemapper_closeHeight.toCustom(0)</a></span></span></span>, <span name="settledBalance">settledBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="timeLockedBalance">timeLockedBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="closeType">closeType: <a href="ChannelCloseSummary$$ClosureType.html" name="lnrpc.ChannelCloseSummary.ClosureType" id="lnrpc.ChannelCloseSummary.ClosureType" class="extype">ClosureType</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelCloseSummary.ClosureType.COOPERATIVE_CLOSE</a></span></span></span>, <span name="openInitiator">openInitiator: <a href="Initiator.html" name="lnrpc.Initiator" id="lnrpc.Initiator" class="extype">Initiator</a> = <span class="symbol"><span class="name"><a href="">lnrpc.Initiator.INITIATOR_UNKNOWN</a></span></span></span>, <span name="closeInitiator">closeInitiator: <a href="Initiator.html" name="lnrpc.Initiator" id="lnrpc.Initiator" class="extype">Initiator</a> = <span class="symbol"><span class="name"><a href="">lnrpc.Initiator.INITIATOR_UNKNOWN</a></span></span></span>, <span name="resolutions">resolutions: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Resolution.html" name="lnrpc.Resolution" id="lnrpc.Resolution" class="extype">Resolution</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="aliasScids">aliasScids: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The outpoint (txid:index) of the funding transaction.</p></dd><dt class="param">chanId</dt><dd class="cmt"><p>
The unique channel ID for the channel.</p></dd><dt class="param">chainHash</dt><dd class="cmt"><p>
The hash of the genesis block that this channel resides within.</p></dd><dt class="param">closingTxHash</dt><dd class="cmt"><p>
The txid of the transaction which ultimately closed this channel.</p></dd><dt class="param">remotePubkey</dt><dd class="cmt"><p>
Public key of the remote peer that we formerly had a channel with.</p></dd><dt class="param">capacity</dt><dd class="cmt"><p>
Total capacity of the channel.</p></dd><dt class="param">closeHeight</dt><dd class="cmt"><p>
Height at which the funding transaction was spent.</p></dd><dt class="param">settledBalance</dt><dd class="cmt"><p>
Settled balance at the time of channel closure</p></dd><dt class="param">timeLockedBalance</dt><dd class="cmt"><p>
The sum of all the time-locked outputs at the time of channel closure</p></dd><dt class="param">closeType</dt><dd class="cmt"><p>
Details on how the channel was closed.</p></dd><dt class="param">openInitiator</dt><dd class="cmt"><p>
Open initiator is the party that initiated opening the channel. Note that
this value may be unknown if the channel was closed before we migrated to
store open channel information after close.</p></dd><dt class="param">closeInitiator</dt><dd class="cmt"><p>
Close initiator indicates which party initiated the close. This value will
be unknown for channels that were cooperatively closed before we started
tracking cooperative close initiators. Note that this indicates which party
initiated a close, and it is possible for both to initiate cooperative or
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
force closes, although only one party's close will be confirmed on chain.</p></dd><dt class="param">aliasScids</dt><dd class="cmt"><p>
This lists out the set of alias short channel ids that existed for the
closed channel. This may be empty.</p></dd><dt class="param">zeroConfConfirmedScid</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The confirmed SCID for a zero-conf channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelCloseUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelCloseUpdateextendsGeneratedMessagewithUpdatable[lnrpc.ChannelCloseUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelCloseUpdate:ChannelCloseUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelCloseUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelCloseUpdate.html" title=""><span class="name">ChannelCloseUpdate</span></a><span class="params">(<span name="closingTxid">closingTxid: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="success">success: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelCloseUpdate.html" name="lnrpc.ChannelCloseUpdate" id="lnrpc.ChannelCloseUpdate" class="extype">ChannelCloseUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelConstraints" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelConstraintsextendsGeneratedMessagewithUpdatable[lnrpc.ChannelConstraints]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelConstraints:ChannelConstraints" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelConstraints.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelConstraints.html" title=""><span class="name">ChannelConstraints</span></a><span class="params">(<span name="csvDelay">csvDelay: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelConstraints._typemapper_csvDelay.toCustom(0)</a></span></span></span>, <span name="chanReserveSa
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The CSV delay expressed in relative blocks. If the channel is force closed,
we will need to wait for this many blocks before we can regain our funds.</p></dd><dt class="param">chanReserveSat</dt><dd class="cmt"><p>
The minimum satoshis this node is required to reserve in its balance.</p></dd><dt class="param">dustLimitSat</dt><dd class="cmt"><p>
The dust limit (in satoshis) of the initiator's commitment tx.</p></dd><dt class="param">maxPendingAmtMsat</dt><dd class="cmt"><p>
The maximum amount of coins in millisatoshis that can be pending in this
channel.</p></dd><dt class="param">minHtlcMsat</dt><dd class="cmt"><p>
The smallest HTLC in millisatoshis that the initiator will accept.</p></dd><dt class="param">maxAcceptedHtlcs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The total number of incoming HTLC's that the initiator will accept.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelEdge" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelEdgeextendsGeneratedMessagewithUpdatable[lnrpc.ChannelEdge]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelEdge:ChannelEdge" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelEdge.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelEdge.html" title="A fully authenticated channel along with all its unique attributes."><span class="name">ChannelEdge</span></a><span class="params">(<span name="channelId">channelId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelEdge._typemapper_channelId.toCustom(0L)</a></span></span></span>, <span name="chanPoint">chanPoint: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="lastUpdate">lastUpdate: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelEdge._typemapper_lastUpdate.toCustom(0)</a></span></span></span>, <span name="node1Pub">node1Pub: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="node2Pub">node2Pub: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="capacity">capacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="node1Policy">node1Policy: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="RoutingPolicy.html" name="lnrpc.RoutingPolicy" id="lnrpc.RoutingPolicy" class="extype">RoutingPolicy</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="node2Policy">node2Policy: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="RoutingPolicy.html" name="lnrpc.RoutingPolicy" id="lnrpc.RoutingPolicy" class="extype">RoutingPolicy</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="customRecords">customRecords: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</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://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSe
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Once an authenticated channel announcement has been processed on the network,
then an instance of ChannelEdgeInfo encapsulating the channels attributes is
stored. The other portions relevant to routing policy of a channel are stored
within a ChannelEdgePolicy for each direction of the channel.
</p></div><dl class="paramcmts block"><dt class="param">channelId</dt><dd class="cmt"><p>
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
output index for the channel.</p></dd><dt class="param">customRecords</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Custom channel announcement tlv records.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelEdgeUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelEdgeUpdateextendsGeneratedMessagewithUpdatable[lnrpc.ChannelEdgeUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelEdgeUpdate:ChannelEdgeUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelEdgeUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelEdgeUpdate.html" title=""><span class="name">ChannelEdgeUpdate</span></a><span class="params">(<span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelEdgeUpdate._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="chanPoint">chanPoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="capacity">capacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="routingPolicy">routingPolicy: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="RoutingPolicy.html" name="lnrpc.RoutingPolicy" id="lnrpc.RoutingPolicy" class="extype">RoutingPolicy</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="advertisingNode">advertisingNode: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="connectingNode">connectingNode: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelEdgeUpdate.html" name="lnrpc.ChannelEdgeUpdate" id="lnrpc.ChannelEdgeUpdate" class="extype">ChannelEdgeUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">chanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
output index for the channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelEventSubscription" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelEventSubscriptionextendsGeneratedMessagewithUpdatable[lnrpc.ChannelEventSubscription]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelEventSubscription:ChannelEventSubscription" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelEventSubscription.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelEventSubscription.html" title=""><span class="name">ChannelEventSubscription</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelEventSubscription.html" name="lnrpc.ChannelEventSubscription" id="lnrpc.ChannelEventSubscription" class="extype">ChannelEventSubscription</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelEventUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelEventUpdateextendsGeneratedMessagewithUpdatable[lnrpc.ChannelEventUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelEventUpdate:ChannelEventUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelEventUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelEventUpdate.html" title=""><span class="name">ChannelEventUpdate</span></a><span class="params">(<span name="channel">channel: <a href="ChannelEventUpdate$$Channel.html" name="lnrpc.ChannelEventUpdate.Channel" id="lnrpc.ChannelEventUpdate.Channel" class="extype">ChannelEventUpdate.Channel</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelEventUpdate.Channel.Empty</a></span></span></span>, <span name="type">type: <a href="ChannelEventUpdate$$UpdateType.html" name="lnrpc.ChannelEventUpdate.UpdateType" id="lnrpc.ChannelEventUpdate.UpdateType" class="extype">UpdateType</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelEventUpdate.UpdateType.OPEN_CHANNEL</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalap
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The short channel id that this fee report belongs to.</p></dd><dt class="param">channelPoint</dt><dd class="cmt"><p>
The channel that this fee report belongs to.</p></dd><dt class="param">baseFeeMsat</dt><dd class="cmt"><p>
The base fee charged regardless of the number of milli-satoshis sent.</p></dd><dt class="param">feePerMil</dt><dd class="cmt"><p>
The amount charged per milli-satoshis transferred expressed in
millionths of a satoshi.</p></dd><dt class="param">feeRate</dt><dd class="cmt"><p>
The effective fee rate in milli-satoshis. Computed by dividing the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
fee_per_mil value by 1 million.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelGraph" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelGraphextendsGeneratedMessagewithUpdatable[lnrpc.ChannelGraph]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelGraph:ChannelGraph" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelGraph.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelGraph.html" title="Returns a new instance of the directed channel graph."><span class="name">ChannelGraph</span></a><span class="params">(<span name="nodes">nodes: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="LightningNode.html" name="lnrpc.LightningNode" id="lnrpc.LightningNode" class="extype">LightningNode</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="edges">edges: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="ChannelEdge.html" name="lnrpc.ChannelEdge" id="lnrpc.ChannelEdge" class="extype">ChannelEdge</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelGraph.html" name="lnrpc.ChannelGraph" id="lnrpc.ChannelGraph" class="extype">ChannelGraph</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt">Returns a new instance of the directed channel graph.</p><div class="fullcomment"><div class="comment cmt"><p>Returns a new instance of the directed channel graph.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
</p></div><dl class="paramcmts block"><dt class="param">nodes</dt><dd class="cmt"><p>
The list of <code>LightningNode</code>s in this channel graph</p></dd><dt class="param">edges</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The list of <code>ChannelEdge</code>s in this channel graph</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelGraphRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelGraphRequestextendsGeneratedMessagewithUpdatable[lnrpc.ChannelGraphRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelGraphRequest:ChannelGraphRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelGraphRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelGraphRequest.html" title=""><span class="name">ChannelGraphRequest</span></a><span class="params">(<span name="includeUnannounced">includeUnannounced: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelGraphRequest.html" name="lnrpc.ChannelGraphRequest" id="lnrpc.ChannelGraphRequest" class="extype">ChannelGraphRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">includeUnannounced</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Whether unannounced channels are included in the response or not. If set,
unannounced channels are included. Unannounced channels are both private
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
channels, and public channels that are not yet announced to the network.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelOpenUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelOpenUpdateextendsGeneratedMessagewithUpdatable[lnrpc.ChannelOpenUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelOpenUpdate:ChannelOpenUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelOpenUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelOpenUpdate.html" title=""><span class="name">ChannelOpenUpdate</span></a><span class="params">(<span name="channelPoint">channelPoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ChannelOpenUpdate.html" name="lnrpc.ChannelOpenUpdate" id="lnrpc.ChannelOpenUpdate" class="extype">ChannelOpenUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelPoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelPointextendsGeneratedMessagewithUpdatable[lnrpc.ChannelPoint]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelPoint:ChannelPoint" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelPoint.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelPoint.html" title=""><span class="name">ChannelPoint</span></a><span class="params">(<span name="fundingTxid">fundingTxid: <a href="ChannelPoint$$FundingTxid.html" name="lnrpc.ChannelPoint.FundingTxid" id="lnrpc.ChannelPoint.FundingTxid" class="extype">FundingTxid</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelPoint.FundingTxid.Empty</a></span></span></span>, <span name="outputIndex">outputIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelPoint._typemapper_outputIndex.toCustom(0)</a></span></span>
The index of the output of the funding transaction</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ChannelUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChannelUpdateextendsGeneratedMessagewithUpdatable[lnrpc.ChannelUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="ChannelUpdate:ChannelUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ChannelUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ChannelUpdate.html" title=""><span class="name">ChannelUpdate</span></a><span class="params">(<span name="signature">signature: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="chainHash">chainHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="timestamp">timestamp: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_timestamp.toCustom(0)</a></span></span></span>, <span name="messageFlags">messageFlags: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_messageFlags.toCustom(0)</a></span></span></span>, <span name="channelFlags">channelFlags: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_channelFlags.toCustom(0)</a></span></span></span>, <span name="timeLockDelta">timeLockDelta: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_timeLockDelta.toCustom(0)</a></span></span></span>, <span name="htlcMinimumMsat">htlcMinimumMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_htlcMinimumMsat.toCustom(0L)</a></span></span></span>, <span name="baseFee">baseFee: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ChannelUpdate._typemapper_baseFee.toCustom(0)</a></span></span></span>, <span name="feeRate">feeRate: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The signature that validates the announced data and proves the ownership
of node id.</p></dd><dt class="param">chainHash</dt><dd class="cmt"><p>
The target chain that this channel was opened within. This value
should be the genesis hash of the target chain. Along with the short
channel ID, this uniquely identifies the channel globally in a
blockchain.</p></dd><dt class="param">chanId</dt><dd class="cmt"><p>
The unique description of the funding transaction.</p></dd><dt class="param">timestamp</dt><dd class="cmt"><p>
A timestamp that allows ordering in the case of multiple announcements.
We should ignore the message if timestamp is not greater than the
last-received.</p></dd><dt class="param">messageFlags</dt><dd class="cmt"><p>
The bitfield that describes whether optional fields are present in this
update. Currently, the least-significant bit must be set to 1 if the
optional field MaxHtlc is present.</p></dd><dt class="param">channelFlags</dt><dd class="cmt"><p>
The bitfield that describes additional meta-data concerning how the
update is to be interpreted. Currently, the least-significant bit must be
set to 0 if the creating node corresponds to the first node in the
previously sent channel announcement and 1 otherwise. If the second bit
is set, then the channel is set to be disabled.</p></dd><dt class="param">timeLockDelta</dt><dd class="cmt"><p>
The minimum number of blocks this node requires to be added to the expiry
of HTLCs. This is a security parameter determined by the node operator.
This value represents the required gap between the time locks of the
incoming and outgoing HTLC's set to this node.</p></dd><dt class="param">htlcMinimumMsat</dt><dd class="cmt"><p>
The minimum HTLC value which will be accepted.</p></dd><dt class="param">baseFee</dt><dd class="cmt"><p>
The base fee that must be used for incoming HTLC's to this particular
channel. This value will be tacked onto the required for a payment
independent of the size of the payment.</p></dd><dt class="param">feeRate</dt><dd class="cmt"><p>
The fee rate that will be charged per millionth of a satoshi.</p></dd><dt class="param">htlcMaximumMsat</dt><dd class="cmt"><p>
The maximum HTLC value which will be accepted.</p></dd><dt class="param">extraOpaqueData</dt><dd class="cmt"><p>
The set of data that was appended to this message, some of which we may
not actually know how to iterate or parse. By holding onto this data, we
ensure that we're able to properly validate the set of signatures that
cover these new fields, and ensure we're able to make upgrades to the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
network in a forwards compatible manner.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.CheckMacPermRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CheckMacPermRequestextendsGeneratedMessagewithUpdatable[lnrpc.CheckMacPermRequest]withProductwithSerializable" class="anchorToMember"></a><a id="CheckMacPermRequest:CheckMacPermRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/CheckMacPermRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CheckMacPermRequest.html" title=""><span class="name">CheckMacPermRequest</span></a><span class="params">(<span name="macaroon">macaroon: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="permissions">permissions: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="MacaroonPermission.html" name="lnrpc.MacaroonPermission" id="lnrpc.MacaroonPermission" class="extype">MacaroonPermission</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="fullMethod">fullMethod: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="CheckMacPermRequest.html" name="lnrpc.CheckMacPermRequest" id="lnrpc.CheckMacPermRequest" class="extype">CheckMacPermRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.CheckMacPermResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CheckMacPermResponseextendsGeneratedMessagewithUpdatable[lnrpc.CheckMacPermResponse]withProductwithSerializable" class="anchorToMember"></a><a id="CheckMacPermResponse:CheckMacPermResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/CheckMacPermResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CheckMacPermResponse.html" title=""><span class="name">CheckMacPermResponse</span></a><span class="params">(<span name="valid">
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.</p></dd><dt class="param">force</dt><dd class="cmt"><p>
If true, then the channel will be closed forcibly. This means the
current commitment transaction will be signed and broadcast.</p></dd><dt class="param">targetConf</dt><dd class="cmt"><p>
The target number of blocks that the closure transaction should be
confirmed by.</p></dd><dt class="param">satPerByte</dt><dd class="cmt"><p>
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
Deprecated, use sat_per_vbyte.
A manual fee rate set in sat/vbyte that should be used when crafting the
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
closure transaction.</p></dd><dt class="param">deliveryAddress</dt><dd class="cmt"><p>
An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
to the upfront shutdown addresss.</p></dd><dt class="param">satPerVbyte</dt><dd class="cmt"><p>
A manual fee rate set in sat/vbyte that should be used when crafting the
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
closure transaction.</p></dd><dt class="param">maxFeePerVbyte</dt><dd class="cmt"><p>
The maximum fee rate the closer is willing to pay.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
NOTE: This field is only respected if we're the initiator of the channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.CloseStatusUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CloseStatusUpdateextendsGeneratedMessagewithUpdatable[lnrpc.CloseStatusUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="CloseStatusUpdate:CloseStatusUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/CloseStatusUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CloseStatusUpdate.html" title=""><span class="name">CloseStatusUpdate</span></a><span class="params">(<span name="update">update: <a href="CloseStatusUpdate$$Update.html" name="lnrpc.CloseStatusUpdate.Update" id="lnrpc.CloseStatusUpdate.Update" class="extype">Update</a> = <span class="defval"><span class="name"><a href="">lnrpc.CloseStatusUpdate.Update.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="CloseStatusUpdate.html" name="lnrpc.CloseStatusUpdate" id="lnrpc.CloseStatusUpdate" class="extype">CloseStatusUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ClosedChannelUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ClosedChannelUpdateextendsGeneratedMessagewithUpdatable[lnrpc.ClosedChannelUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="ClosedChannelUpdate:ClosedChannelUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ClosedChannelUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ClosedChannelUpdate.html" title=""><span class="name">ClosedChannelUpdate</span></a><span class="params">(<span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ClosedChannelUpdate._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="capacity">capacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="closedHeight">closedHeight: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.U
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
output index for the channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ClosedChannelsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ClosedChannelsRequestextendsGeneratedMessagewithUpdatable[lnrpc.ClosedChannelsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ClosedChannelsRequest:ClosedChannelsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ClosedChannelsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ClosedChannelsRequest.html" title=""><span class="name">ClosedChannelsRequest</span></a><span class="params">(<span name="cooperative">cooperative: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="localForce">localForce: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="remoteForce">remoteForce: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="breach">breach: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="fundingCanceled">fundingCanceled: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="abandoned">abandoned: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ClosedChannelsRequest.html" name="lnrpc.ClosedChannelsRequest" id="lnrpc.ClosedChannelsRequest" class="extype">ClosedChannelsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ClosedChannelsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ClosedChannelsResponseextendsGeneratedMessagewithUpdatable[lnrpc.ClosedChannelsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ClosedChannelsResponse:
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
Lightning address of the peer to connect to.</p></dd><dt class="param">perm</dt><dd class="cmt"><p>
If set, the daemon will attempt to persistently connect to the target
peer. Otherwise, the call will be synchronous.</p></dd><dt class="param">timeout</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The connection timeout value (in seconds) for this request. It won't affect
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
other requests.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ConnectPeerResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ConnectPeerResponseextendsGeneratedMessagewithUpdatable[lnrpc.ConnectPeerResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ConnectPeerResponse:ConnectPeerResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ConnectPeerResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ConnectPeerResponse.html" title=""><span class="name">ConnectPeerResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ConnectPeerResponse.html" name="lnrpc.ConnectPeerResponse" id="lnrpc.ConnectPeerResponse" class="extype">ConnectPeerResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.CustomMessage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="CustomMessageextendsGeneratedMessagewithUpdatable[lnrpc.CustomMessage]withProductwithSerializable" class="anchorToMember"></a><a id="CustomMessage:CustomMessage" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/CustomMessage.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="CustomMessage.html" title=""><span class="name">CustomMessage</span></a><span class="params">(<span name="peer">peer: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="type">type: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.CustomMessage._typemapper_type.toCustom(0)</a></span></span></span>, <span name="data">data: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.htm
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
Peer from which the message originates</p></dd><dt class="param">type</dt><dd class="cmt"><p>
Message type. This value will be in the custom range (&gt;= 32768).</p></dd><dt class="param">data</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Raw message data</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DebugLevelRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DebugLevelRequestextendsGeneratedMessagewithUpdatable[lnrpc.DebugLevelRequest]withProductwithSerializable" class="anchorToMember"></a><a id="DebugLevelRequest:DebugLevelRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DebugLevelRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DebugLevelRequest.html" title=""><span class="name">DebugLevelRequest</span></a><span class="params">(<span name="show">show: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="levelSpec">levelSpec: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="DebugLevelRequest.html" name="lnrpc.DebugLevelRequest" id="lnrpc.DebugLevelRequest" class="extype">DebugLevelRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DebugLevelResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DebugLevelResponseextendsGeneratedMessagewithUpdatable[lnrpc.DebugLevelResponse]withProductwithSerializable" class="anchorToMember"></a><a id="DebugLevelResponse:DebugLevelResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DebugLevelResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DebugLevelResponse.html" title=""><span class="name">DebugLevelResponse</span></a><span class="params">(<span name="subSystems">subSystems: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.Ge
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Only delete failed payments.</p></dd><dt class="param">failedHtlcsOnly</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Only delete failed HTLCs from payments, not the payment itself.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DeleteAllPaymentsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeleteAllPaymentsResponseextendsGeneratedMessagewithUpdatable[lnrpc.DeleteAllPaymentsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="DeleteAllPaymentsResponse:DeleteAllPaymentsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DeleteAllPaymentsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeleteAllPaymentsResponse.html" title=""><span class="name">DeleteAllPaymentsResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="DeleteAllPaymentsResponse.html" name="lnrpc.DeleteAllPaymentsResponse" id="lnrpc.DeleteAllPaymentsResponse" class="extype">DeleteAllPaymentsResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DeleteMacaroonIDRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeleteMacaroonIDRequestextendsGeneratedMessagewithUpdatable[lnrpc.DeleteMacaroonIDRequest]withProductwithSerializable" class="anchorToMember"></a><a id="DeleteMacaroonIDRequest:DeleteMacaroonIDRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DeleteMacaroonIDRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeleteMacaroonIDRequest.html" title=""><span class="name">DeleteMacaroonIDRequest</span></a><span class="params">(<span name="rootKeyId">rootKeyId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.DeleteMacaroonIDRequest._typemapper_rootKeyId.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessag
The root key ID to be removed.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DeleteMacaroonIDResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeleteMacaroonIDResponseextendsGeneratedMessagewithUpdatable[lnrpc.DeleteMacaroonIDResponse]withProductwithSerializable" class="anchorToMember"></a><a id="DeleteMacaroonIDResponse:DeleteMacaroonIDResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DeleteMacaroonIDResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeleteMacaroonIDResponse.html" title=""><span class="name">DeleteMacaroonIDResponse</span></a><span class="params">(<span name="deleted">deleted: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="DeleteMacaroonIDResponse.html" name="lnrpc.DeleteMacaroonIDResponse" id="lnrpc.DeleteMacaroonIDResponse" class="extype">DeleteMacaroonIDResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">deleted</dt><dd class="cmt"><p>
A boolean indicates that the deletion is successful.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DeletePaymentRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeletePaymentRequestextendsGeneratedMessagewithUpdatable[lnrpc.DeletePaymentRequest]withProductwithSerializable" class="anchorToMember"></a><a id="DeletePaymentRequest:DeletePaymentRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DeletePaymentRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeletePaymentRequest.html" title=""><span class="name">DeletePaymentRequest</span></a><span class="params">(<span name="paymentHash">paymentHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="failedHtlcsOnly">failedHtlcsOnly: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="DeletePaymentRequest.html" name="lnrpc.DeletePaymentRequest" id="lnrpc.DeletePaymentRequest" class="extype">DeletePaymentRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">paymentHash</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
Payment hash to delete.</p></dd><dt class="param">failedHtlcsOnly</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Only delete failed HTLCs from the payment, not the payment itself.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DeletePaymentResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DeletePaymentResponseextendsGeneratedMessagewithUpdatable[lnrpc.DeletePaymentResponse]withProductwithSerializable" class="anchorToMember"></a><a id="DeletePaymentResponse:DeletePaymentResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DeletePaymentResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DeletePaymentResponse.html" title=""><span class="name">DeletePaymentResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="DeletePaymentResponse.html" name="lnrpc.DeletePaymentResponse" id="lnrpc.DeletePaymentResponse" class="extype">DeletePaymentResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DisconnectPeerRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DisconnectPeerRequestextendsGeneratedMessagewithUpdatable[lnrpc.DisconnectPeerRequest]withProductwithSerializable" class="anchorToMember"></a><a id="DisconnectPeerRequest:DisconnectPeerRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DisconnectPeerRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DisconnectPeerRequest.html" title=""><span class="name">DisconnectPeerRequest</span></a><span class="params">(<span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Upd
The pubkey of the node to disconnect from</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.DisconnectPeerResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="DisconnectPeerResponseextendsGeneratedMessagewithUpdatable[lnrpc.DisconnectPeerResponse]withProductwithSerializable" class="anchorToMember"></a><a id="DisconnectPeerResponse:DisconnectPeerResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/DisconnectPeerResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="DisconnectPeerResponse.html" title=""><span class="name">DisconnectPeerResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="DisconnectPeerResponse.html" name="lnrpc.DisconnectPeerResponse" id="lnrpc.DisconnectPeerResponse" class="extype">DisconnectPeerResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.EdgeLocator" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EdgeLocatorextendsGeneratedMessagewithUpdatable[lnrpc.EdgeLocator]withProductwithSerializable" class="anchorToMember"></a><a id="EdgeLocator:EdgeLocator" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/EdgeLocator.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="EdgeLocator.html" title=""><span class="name">EdgeLocator</span></a><span class="params">(<span name="channelId">channelId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.EdgeLocator._typemapper_channelId.toCustom(0L)</a></span></span></span>, <span name="directionReverse">directionReverse: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalap
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The short channel id of this edge.</p></dd><dt class="param">directionReverse</dt><dd class="cmt"><p>
The direction of this edge. If direction_reverse is false, the direction
of this edge is from the channel endpoint with the lexicographically smaller
pub key to the endpoint with the larger pub key. If direction_reverse is
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
is true, the edge goes the other way.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.EstimateFeeRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EstimateFeeRequestextendsGeneratedMessagewithUpdatable[lnrpc.EstimateFeeRequest]withProductwithSerializable" class="anchorToMember"></a><a id="EstimateFeeRequest:EstimateFeeRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/EstimateFeeRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="EstimateFeeRequest.html" title=""><span class="name">EstimateFeeRequest</span></a><span class="params">(<span name="addrToAmount">addrToAmount: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</a>[<span name="scala.Predef.String" class="extype">String</span>, <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="targetConf">targetConf: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="minConfs">minConfs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="spendUnconfirmed">spendUnconfirmed: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="EstimateFeeRequest.html" name="lnrpc.EstimateFeeRequest" id="lnrpc.EstimateFeeRequest" class="extype">EstimateFeeRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">addrToAmount</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The map from addresses to amounts for the transaction.</p></dd><dt class="param">targetConf</dt><dd class="cmt"><p>
The target number of blocks that this transaction should be confirmed
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
by.</p></dd><dt class="param">minConfs</dt><dd class="cmt"><p>
The minimum number of confirmations each one of your outputs used for
the transaction must satisfy.</p></dd><dt class="param">spendUnconfirmed</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Whether unconfirmed outputs should be used as inputs for the transaction.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.EstimateFeeResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="EstimateFeeResponseextendsGeneratedMessagewithUpdatable[lnrpc.EstimateFeeResponse]withProductwithSerializable" class="anchorToMember"></a><a id="EstimateFeeResponse:EstimateFeeResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/EstimateFeeResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="EstimateFeeResponse.html" title=""><span class="name">EstimateFeeResponse</span></a><span class="params">(<span name="feeSat">feeSat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="feerateSatPerByte">feerateSatPerByte: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="satPerVbyte">satPerVbyte: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.EstimateFeeResponse._typemapper_satPerVbyte.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="EstimateFeeResponse.html" name="lnrpc.EstimateFeeResponse" id="lnrpc.EstimateFeeResponse" class="extype">EstimateFeeResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">feeSat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The total fee in satoshis.</p></dd><dt class="param">feerateSatPerByte</dt><dd class="cmt"><p>
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
Deprecated, use sat_per_vbyte.
The fee rate in satoshi/vbyte.</p></dd><dt class="param">satPerVbyte</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The fee rate in satoshi/vbyte.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ExportChannelBackupRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ExportChannelBackupRequestextendsGeneratedMessagewithUpdatable[lnrpc.ExportChannelBackupRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ExportChannelBackupRequest:ExportChannelBackupRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ExportChannelBackupRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ExportChannelBackupRequest.html" title=""><span class="name">ExportChannelBackupRequest</span></a><span class="params">(<span name="chanPoint">chanPoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ExportChannelBackupRequest.html" name="lnrpc.ExportChannelBackupRequest" id="lnrpc.ExportChannelBackupRequest" class="extype">ExportChannelBackupRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">chanPoint</dt><dd class="cmt"><p>
The target channel point to obtain a back up for.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FailedUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FailedUpdateextendsGeneratedMessagewithUpdatable[lnrpc.FailedUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="FailedUpdate:FailedUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FailedUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FailedUpdate.html" title=""><span class="name">FailedUpdate</span></a><span class="params">(<span name="outpoint">outpoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="OutPoint.html" name="lnrpc.OutPoint" id="lnrpc.OutPoint" class="extype">OutPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="reason">reason: <a href="UpdateFailure.html" name="lnrpc.UpdateFailure" id="lnrpc.UpdateFailure" class="extype">UpdateFailure</a> = <span class="defval"><span class="name"><a href="">lnrpc.UpdateFailure.UPDATE_FAILURE_UNKNOWN</a></span></span></span>, <span name="updateError">updateError: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FailedUpdate.html" name="lnrpc.FailedUpdate" id="lnrpc.FailedUpdate" class="extype">FailedUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">outpoint</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The outpoint in format txid:n</p></dd><dt class="param">reason</dt><dd class="cmt"><p>
Reason for the policy update failure.</p></dd><dt class="param">updateError</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
A string representation of the policy update error.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Failure" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FailureextendsGeneratedMessagewithUpdatable[lnrpc.Failure]withProductwithSerializable" class="anchorToMember"></a><a id="Failure:Failure" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Failure.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Failure.html" title=""><span class="name">Failure</span></a><span class="params">(<span name="code">code: <a href="Failure$$FailureCode.html" name="lnrpc.Failure.FailureCode" id="lnrpc.Failure.FailureCode" class="extype">FailureCode</a> = <span class="symbol"><span class="name"><a href="">lnrpc.Failure.FailureCode.RESERVED</a></span></span></span>, <span name="channelUpdate">channelUpdate: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChannelUpdate.html" name="lnrpc.ChannelUpdate" id="lnrpc.ChannelUpdate" class="extype">ChannelUpdate</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="htlcMsat">htlcMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Failure._typemapper_htlcMsat.toCustom(0L)</a></span></span></span>, <span name="onionSha256">onionSha256: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="cltvExpiry">cltvExpiry: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.Failure._typemapper_cltvExpiry.toCustom(0)</a></span></span></span>, <span name="flags">flags: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.Failure._typemapper_flags.toCustom(0)</a></span></span></span>, <span name="failureSourceIndex">failureSourceIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.Failure._typemapper_failureSourceIndex.toCustom(0)</a></span></span></span>, <span name="height">height: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.Failure._typemapper_height.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.Generate
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Failure code as defined in the Lightning spec</p></dd><dt class="param">channelUpdate</dt><dd class="cmt"><p>
An optional channel update message.</p></dd><dt class="param">htlcMsat</dt><dd class="cmt"><p>
A failure type-dependent htlc value.</p></dd><dt class="param">onionSha256</dt><dd class="cmt"><p>
The sha256 sum of the onion payload.</p></dd><dt class="param">cltvExpiry</dt><dd class="cmt"><p>
A failure type-dependent cltv expiry value.</p></dd><dt class="param">flags</dt><dd class="cmt"><p>
A failure type-dependent flags value.</p></dd><dt class="param">failureSourceIndex</dt><dd class="cmt"><p>
The position in the path of the intermediate or final node that generated
the failure message. Position zero is the sender node.</p></dd><dt class="param">height</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
A failure type-dependent block height.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Feature" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FeatureextendsGeneratedMessagewithUpdatable[lnrpc.Feature]withProductwithSerializable" class="anchorToMember"></a><a id="Feature:Feature" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Feature.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Feature.html" title=""><span class="name">Feature</span></a><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="isRequired">isRequired: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="isKnown">isKnown: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="Feature.html" name="lnrpc.Feature" id="lnrpc.Feature" class="extype">Feature</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FeatureBit" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="FeatureBitextendsGeneratedEnum" class="anchorToMember"></a><a id="FeatureBit:FeatureBit" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FeatureBit.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="FeatureBit.html" title=""><span class="name">FeatureBit</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.FeeLimit" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FeeLimitextendsGeneratedMessagewithUpdatable[lnrpc.FeeLimit]withProductwithSerializable" class="anchorToMember"></a><a id="FeeLimit:FeeLimit" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FeeLimit.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modi
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
An array of channel fee reports which describes the current fee schedule
for each channel.</p></dd><dt class="param">dayFeeSum</dt><dd class="cmt"><p>
The total amount of fee revenue (in satoshis) the switch has collected
over the past 24 hrs.</p></dd><dt class="param">weekFeeSum</dt><dd class="cmt"><p>
The total amount of fee revenue (in satoshis) the switch has collected
over the past 1 week.</p></dd><dt class="param">monthFeeSum</dt><dd class="cmt"><p>
The total amount of fee revenue (in satoshis) the switch has collected
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
over the past 1 month.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FloatMetric" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FloatMetricextendsGeneratedMessagewithUpdatable[lnrpc.FloatMetric]withProductwithSerializable" class="anchorToMember"></a><a id="FloatMetric:FloatMetric" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FloatMetric.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FloatMetric.html" title=""><span class="name">FloatMetric</span></a><span class="params">(<span name="value">value: <a href="https://www.scala-lang.org/api/2.13.11/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="normalizedValue">normalizedValue: <a href="https://www.scala-lang.org/api/2.13.11/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FloatMetric.html" name="lnrpc.FloatMetric" id="lnrpc.FloatMetric" class="extype">FloatMetric</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">value</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Arbitrary float value.</p></dd><dt class="param">normalizedValue</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The value normalized to [0,1] or [-1,1].</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ForwardingEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardingEventextendsGeneratedMessagewithUpdatable[lnrpc.ForwardingEvent]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardingEvent:ForwardingEvent" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ForwardingEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ForwardingEvent.html" title=""><span class="name">ForwardingEvent</span></a><span class="params">(<span name="timestamp">timestamp: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_timestamp.toCustom(0L)</a></span></span></span>, <span name="chanIdIn">chanIdIn: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_chanIdIn.toCustom(0L)</a></span></span></span>, <span name="chanIdOut">chanIdOut: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_chanIdOut.toCustom(0L)</a></span></span></span>, <span name="amtIn">amtIn: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_amtIn.toCustom(0L)</a></span></span></span>, <span name="amtOut">amtOut: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_amtOut.toCustom(0L)</a></span></span></span>, <span name="fee">fee: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_fee.toCustom(0L)</a></span></span></span>, <span name="feeMsat">feeMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_feeMsat.toCustom(0L)</a></span></span></span>, <span name="amtInMsat">amtInMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_amtInMsat.toCustom(0L)</a></span></span></span>, <span name="amtOutMsat">amtOutMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_amtOutMsat.toCustom(0L)</a></span></span></span>, <span name="timestampNs">timestampNs: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingEvent._typemapper_timestampNs.toCustom(0L)</a></span></span></span>, <span name="peerAliasIn"
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Timestamp is the time (unix epoch offset) that this circuit was
completed. Deprecated by timestamp_ns.</p></dd><dt class="param">chanIdIn</dt><dd class="cmt"><p>
The incoming channel ID that carried the HTLC that created the circuit.</p></dd><dt class="param">chanIdOut</dt><dd class="cmt"><p>
The outgoing channel ID that carried the preimage that completed the
circuit.</p></dd><dt class="param">amtIn</dt><dd class="cmt"><p>
The total amount (in satoshis) of the incoming HTLC that created half
the circuit.</p></dd><dt class="param">amtOut</dt><dd class="cmt"><p>
The total amount (in satoshis) of the outgoing HTLC that created the
second half of the circuit.</p></dd><dt class="param">fee</dt><dd class="cmt"><p>
The total fee (in satoshis) that this payment circuit carried.</p></dd><dt class="param">feeMsat</dt><dd class="cmt"><p>
The total fee (in milli-satoshis) that this payment circuit carried.</p></dd><dt class="param">amtInMsat</dt><dd class="cmt"><p>
The total amount (in milli-satoshis) of the incoming HTLC that created
half the circuit.</p></dd><dt class="param">amtOutMsat</dt><dd class="cmt"><p>
The total amount (in milli-satoshis) of the outgoing HTLC that created
the second half of the circuit.</p></dd><dt class="param">timestampNs</dt><dd class="cmt"><p>
The number of nanoseconds elapsed since January 1, 1970 UTC when this
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
circuit was completed.</p></dd><dt class="param">peerAliasIn</dt><dd class="cmt"><p>
The peer alias of the incoming channel.</p></dd><dt class="param">peerAliasOut</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The peer alias of the outgoing channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ForwardingHistoryRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardingHistoryRequestextendsGeneratedMessagewithUpdatable[lnrpc.ForwardingHistoryRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardingHistoryRequest:ForwardingHistoryRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ForwardingHistoryRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ForwardingHistoryRequest.html" title=""><span class="name">ForwardingHistoryRequest</span></a><span class="params">(<span name="startTime">startTime: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingHistoryRequest._typemapper_startTime.toCustom(0L)</a></span></span></span>, <span name="endTime">endTime: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingHistoryRequest._typemapper_endTime.toCustom(0L)</a></span></span></span>, <span name="indexOffset">indexOffset: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingHistoryRequest._typemapper_indexOffset.toCustom(0)</a></span></span></span>, <span name="numMaxEvents">numMaxEvents: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingHistoryRequest._typemapper_numMaxEvents.toCustom(0)</a></span></span></span>, <span name="peerAliasLookup">peerAliasLookup: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ForwardingHistoryRequest.html" name="lnrpc.ForwardingHistoryRequest" id="lnrpc.ForwardingHistoryRequest" class="extype">ForwardingHistoryRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">startTime</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Start time is the starting point of the forwarding history request. All
records beyond this point will be included, respecting the end time, and
the index offset.</p></dd><dt class="param">endTime</dt><dd class="cmt"><p>
End time is the end point of the forwarding history request. The
response will carry at most 50k records between the start time and the
end time. The index offset can be used to implement pagination.</p></dd><dt class="param">indexOffset</dt><dd class="cmt"><p>
Index offset is the offset in the time series to start at. As each
response can only contain 50k records, callers can use this to skip
around within a packed time series.</p></dd><dt class="param">numMaxEvents</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
The max number of events to return in the response to this query.</p></dd><dt class="param">peerAliasLookup</dt><dd class="cmt"><p>
Informs the server if the peer alias should be looked up for each
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
forwarding event.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ForwardingHistoryResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ForwardingHistoryResponseextendsGeneratedMessagewithUpdatable[lnrpc.ForwardingHistoryResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ForwardingHistoryResponse:ForwardingHistoryResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ForwardingHistoryResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ForwardingHistoryResponse.html" title=""><span class="name">ForwardingHistoryResponse</span></a><span class="params">(<span name="forwardingEvents">forwardingEvents: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="ForwardingEvent.html" name="lnrpc.ForwardingEvent" id="lnrpc.ForwardingEvent" class="extype">ForwardingEvent</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="lastOffsetIndex">lastOffsetIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.ForwardingHistoryResponse._typemapper_lastOffsetIndex.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ForwardingHistoryResponse.html" name="lnrpc.ForwardingHistoryResponse" id="lnrpc.ForwardingHistoryResponse" class="extype">ForwardingHistoryResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">forwardingEvents</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of forwarding events from the time slice of the time series
specified in the request.</p></dd><dt class="param">lastOffsetIndex</dt><dd class="cmt"><p>
The index of the last time in the set of returned forwarding events. Can
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
be used to seek further, pagination style.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FundingPsbtFinalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FundingPsbtFinalizeextendsGeneratedMessagewithUpdatable[lnrpc.FundingPsbtFinalize]withProductwithSerializable" class="anchorToMember"></a><a id="FundingPsbtFinalize:FundingPsbtFinalize" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FundingPsbtFinalize.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FundingPsbtFinalize.html" title=""><span class="name">FundingPsbtFinalize</span></a><span class="params">(<span name="signedPsbt">signedPsbt: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="finalRawTx">finalRawTx: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FundingPsbtFinalize.html" name="lnrpc.FundingPsbtFinalize" id="lnrpc.FundingPsbtFinalize" class="extype">FundingPsbtFinalize</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">signedPsbt</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The funded PSBT that contains all witness data to send the exact channel
capacity amount to the PK script returned in the open channel message in a
previous step. Cannot be set at the same time as final_raw_tx.</p></dd><dt class="param">pendingChanId</dt><dd class="cmt"><p>
The pending channel ID of the channel to get the PSBT for.</p></dd><dt class="param">finalRawTx</dt><dd class="cmt"><p>
As an alternative to the signed PSBT with all witness data, the final raw
wire format transaction can also be specified directly. Cannot be set at the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
same time as signed_psbt.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FundingPsbtVerify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FundingPsbtVerifyextendsGeneratedMessagewithUpdatable[lnrpc.FundingPsbtVerify]withProductwithSerializable" class="anchorToMember"></a><a id="FundingPsbtVerify:FundingPsbtVerify" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FundingPsbtVerify.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FundingPsbtVerify.html" title=""><span class="name">FundingPsbtVerify</span></a><span class="params">(<span name="fundedPsbt">fundedPsbt: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="skipFinalize">skipFinalize: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FundingPsbtVerify.html" name="lnrpc.FundingPsbtVerify" id="lnrpc.FundingPsbtVerify" class="extype">FundingPsbtVerify</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">fundedPsbt</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The funded but not yet signed PSBT that sends the exact channel capacity
amount to the PK script returned in the open channel message in a previous
step.</p></dd><dt class="param">pendingChanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The pending channel ID of the channel to get the PSBT for.</p></dd><dt class="param">skipFinalize</dt><dd class="cmt"><p>
Can only be used if the no_publish flag was set to true in the OpenChannel
call meaning that the caller is solely responsible for publishing the final
funding transaction. If skip_finalize is set to true then lnd will not wait
for a FundingPsbtFinalize state step and instead assumes that a transaction
with the same TXID as the passed in PSBT will eventually confirm.
IT IS ABSOLUTELY IMPERATIVE that the TXID of the transaction that is
eventually published does have the _same TXID_ as the verified PSBT. That
means no inputs or outputs can change, only signatures can be added. If the
TXID changes between this call and the publish step then the channel will
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
never be created and the funds will be in limbo.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FundingShim" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FundingShimextendsGeneratedMessagewithUpdatable[lnrpc.FundingShim]withProductwithSerializable" class="anchorToMember"></a><a id="FundingShim:FundingShim" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FundingShim.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FundingShim.html" title=""><span class="name">FundingShim</span></a><span class="params">(<span name="shim">shim: <a href="FundingShim$$Shim.html" name="lnrpc.FundingShim.Shim" id="lnrpc.FundingShim.Shim" class="extype">Shim</a> = <span class="symbol"><span class="name"><a href="">lnrpc.FundingShim.Shim.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FundingShim.html" name="lnrpc.FundingShim" id="lnrpc.FundingShim" class="extype">FundingShim</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FundingShimCancel" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FundingShimCancelextendsGeneratedMessagewithUpdatable[lnrpc.FundingShimCancel]withProductwithSerializable" class="anchorToMember"></a><a id="FundingShimCancel:FundingShimCancel" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FundingShimCancel.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FundingShimCancel.html" title=""><span class="name">FundingShimCancel</span></a><span class="params">(<span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javad
The pending channel ID of the channel to cancel the funding shim for.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FundingStateStepResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FundingStateStepRespextendsGeneratedMessagewithUpdatable[lnrpc.FundingStateStepResp]withProductwithSerializable" class="anchorToMember"></a><a id="FundingStateStepResp:FundingStateStepResp" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FundingStateStepResp.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FundingStateStepResp.html" title=""><span class="name">FundingStateStepResp</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="FundingStateStepResp.html" name="lnrpc.FundingStateStepResp" id="lnrpc.FundingStateStepResp" class="extype">FundingStateStepResp</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.FundingTransitionMsg" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FundingTransitionMsgextendsGeneratedMessagewithUpdatable[lnrpc.FundingTransitionMsg]withProductwithSerializable" class="anchorToMember"></a><a id="FundingTransitionMsg:FundingTransitionMsg" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/FundingTransitionMsg.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="FundingTransitionMsg.html" title=""><span class="name">FundingTransitionMsg</span></a><span class="params">(<span name="trigger">trigger: <a href="FundingTransitionMsg$$Trigger.html" name="lnrpc.FundingTransitionMsg.Trigger" id="lnrpc.FundingTransitionMsg.Trigger" class="extype">Trigger</a> = <span class="defval"><span class="name"><a href="">lnrpc.FundingTransitionMsg.Trigger.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> wi
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed. When using REST, this field
must be encoded as base64.</p></dd><dt class="param">seedEntropy</dt><dd class="cmt"><p>
seed_entropy is an optional 16-bytes generated via CSPRNG. If not
specified, then a fresh set of randomness will be used to create the seed.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
When using REST, this field must be encoded as base64.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GenSeedResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GenSeedResponseextendsGeneratedMessagewithUpdatable[lnrpc.GenSeedResponse]withProductwithSerializable" class="anchorToMember"></a><a id="GenSeedResponse:GenSeedResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GenSeedResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GenSeedResponse.html" title=""><span class="name">GenSeedResponse</span></a><span class="params">(<span name="cipherSeedMnemonic">cipherSeedMnemonic: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="encipheredSeed">encipheredSeed: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="GenSeedResponse.html" name="lnrpc.GenSeedResponse" id="lnrpc.GenSeedResponse" class="extype">GenSeedResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">cipherSeedMnemonic</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user. This field is optional, as if not
provided, then the daemon will generate a new cipher seed for the user.
Otherwise, then the daemon will attempt to recover the wallet state linked
to this cipher seed.</p></dd><dt class="param">encipheredSeed</dt><dd class="cmt"><p>
enciphered_seed are the raw aezeed cipher seed bytes. This is the raw
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
cipher text before run through our mnemonic encoding scheme.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GetInfoRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetInfoRequestextendsGeneratedMessagewithUpdatable[lnrpc.GetInfoRequest]withProductwithSerializable" class="anchorToMember"></a><a id="GetInfoRequest:GetInfoRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GetInfoRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetInfoRequest.html" title=""><span class="name">GetInfoRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="GetInfoRequest.html" name="lnrpc.GetInfoRequest" id="lnrpc.GetInfoRequest" class="extype">GetInfoRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GetInfoResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetInfoResponseextendsGeneratedMessagewithUpdatable[lnrpc.GetInfoResponse]withProductwithSerializable" class="anchorToMember"></a><a id="GetInfoResponse:GetInfoResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GetInfoResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetInfoResponse.html" title=""><span class="name">GetInfoResponse</span></a><span class="params">(<span name="version">version: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="commitHash">commitHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="identityPubkey">identityPubkey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="alias">alias: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="color">color: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="numPendingChannels">numPendingChannels: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.GetInfoResponse._typemapper_numPendingChannels.toCustom(0)</a></span></span></span>, <span name="numActiveChan
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The version of the LND software that the node is running.</p></dd><dt class="param">commitHash</dt><dd class="cmt"><p>
The SHA1 commit hash that the daemon is compiled with.</p></dd><dt class="param">identityPubkey</dt><dd class="cmt"><p>
The identity pubkey of the current node.</p></dd><dt class="param">alias</dt><dd class="cmt"><p>
If applicable, the alias of the current node, e.g. "bob"</p></dd><dt class="param">color</dt><dd class="cmt"><p>
The color of the current node in hex code format</p></dd><dt class="param">numPendingChannels</dt><dd class="cmt"><p>
Number of pending channels</p></dd><dt class="param">numActiveChannels</dt><dd class="cmt"><p>
Number of active channels</p></dd><dt class="param">numInactiveChannels</dt><dd class="cmt"><p>
Number of inactive channels</p></dd><dt class="param">numPeers</dt><dd class="cmt"><p>
Number of peers</p></dd><dt class="param">blockHeight</dt><dd class="cmt"><p>
The node's current view of the height of the best block</p></dd><dt class="param">blockHash</dt><dd class="cmt"><p>
The node's current view of the hash of the best block</p></dd><dt class="param">bestHeaderTimestamp</dt><dd class="cmt"><p>
Timestamp of the block best known to the wallet</p></dd><dt class="param">syncedToChain</dt><dd class="cmt"><p>
Whether the wallet's view is synced to the main chain</p></dd><dt class="param">syncedToGraph</dt><dd class="cmt"><p>
Whether we consider ourselves synced with the public channel graph.</p></dd><dt class="param">testnet</dt><dd class="cmt"><p>
Whether the current node is connected to testnet. This field is
deprecated and the network field should be used instead</p></dd><dt class="param">chains</dt><dd class="cmt"><p>
A list of active chains the node is connected to</p></dd><dt class="param">uris</dt><dd class="cmt"><p>
The URIs of the current node.</p></dd><dt class="param">features</dt><dd class="cmt"><p>
Features that our node has advertised in our init message, node
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
announcements and invoices.</p></dd><dt class="param">requireHtlcInterceptor</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Indicates whether the HTLC interceptor API is in always-on mode.</p></dd><dt class="param">storeFinalHtlcResolutions</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Indicates whether final htlc resolutions are stored on disk.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GetRecoveryInfoRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetRecoveryInfoRequestextendsGeneratedMessagewithUpdatable[lnrpc.GetRecoveryInfoRequest]withProductwithSerializable" class="anchorToMember"></a><a id="GetRecoveryInfoRequest:GetRecoveryInfoRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GetRecoveryInfoRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetRecoveryInfoRequest.html" title=""><span class="name">GetRecoveryInfoRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="GetRecoveryInfoRequest.html" name="lnrpc.GetRecoveryInfoRequest" id="lnrpc.GetRecoveryInfoRequest" class="extype">GetRecoveryInfoRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GetRecoveryInfoResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetRecoveryInfoResponseextendsGeneratedMessagewithUpdatable[lnrpc.GetRecoveryInfoResponse]withProductwithSerializable" class="anchorToMember"></a><a id="GetRecoveryInfoResponse:GetRecoveryInfoResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GetRecoveryInfoResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetRecoveryInfoResponse.html" title=""><span class="name">GetRecoveryInfoResponse</span></a><span class="params">(<span name="recoveryMode">recoveryMode: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="recoveryFinished">recoveryFinished: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="progress">progress: <a href="https://www.scala-lang.org/api/2.13.11/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.Unkn
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Whether the wallet is in recovery mode</p></dd><dt class="param">recoveryFinished</dt><dd class="cmt"><p>
Whether the wallet recovery progress is finished</p></dd><dt class="param">progress</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The recovery progress, ranging from 0 to 1.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GetStateRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetStateRequestextendsGeneratedMessagewithUpdatable[lnrpc.GetStateRequest]withProductwithSerializable" class="anchorToMember"></a><a id="GetStateRequest:GetStateRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GetStateRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetStateRequest.html" title=""><span class="name">GetStateRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="GetStateRequest.html" name="lnrpc.GetStateRequest" id="lnrpc.GetStateRequest" class="extype">GetStateRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GetStateResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetStateResponseextendsGeneratedMessagewithUpdatable[lnrpc.GetStateResponse]withProductwithSerializable" class="anchorToMember"></a><a id="GetStateResponse:GetStateResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GetStateResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GetStateResponse.html" title=""><span class="name">GetStateResponse</span></a><span class="params">(<span name="state">state: <a href="WalletState.html" name="lnrpc.WalletState" id="lnrpc.WalletState" class="extype">WalletState</a> = <span class="symbol"><span class="name"><a href="">lnrpc.WalletState.NON_EXISTING</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.len
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The height from which to list transactions, inclusive. If this value is
greater than end_height, transactions will be read in reverse.</p></dd><dt class="param">endHeight</dt><dd class="cmt"><p>
The height until which to list transactions, inclusive. To include
unconfirmed transactions, this value should be set to -1, which will
return transactions from start_height until the current chain tip and
unconfirmed transactions. If no end_height is provided, the call will
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
default to this option.</p></dd><dt class="param">account</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
An optional filter to only include transactions relevant to an account.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GraphTopologySubscription" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GraphTopologySubscriptionextendsGeneratedMessagewithUpdatable[lnrpc.GraphTopologySubscription]withProductwithSerializable" class="anchorToMember"></a><a id="GraphTopologySubscription:GraphTopologySubscription" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GraphTopologySubscription.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GraphTopologySubscription.html" title=""><span class="name">GraphTopologySubscription</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="GraphTopologySubscription.html" name="lnrpc.GraphTopologySubscription" id="lnrpc.GraphTopologySubscription" class="extype">GraphTopologySubscription</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.GraphTopologyUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GraphTopologyUpdateextendsGeneratedMessagewithUpdatable[lnrpc.GraphTopologyUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="GraphTopologyUpdate:GraphTopologyUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/GraphTopologyUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="GraphTopologyUpdate.html" title=""><span class="name">GraphTopologyUpdate</span></a><span class="params">(<span name="nodeUpdates">nodeUpdates: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="NodeUpdate.html" name="lnrpc.NodeUpdate" id="lnrpc.NodeUpdate" class="extype">NodeUpdate</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="channelUpdates">channelUpdates: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="ChannelEdgeUpdate.html" name="lnrpc.ChannelEdgeUpdate" id="lnrpc.ChannelEdgeUpdate" class="extype">ChannelEdgeUpdate</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="closedChans">closedChans: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" c
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Index identifying the htlc on the channel.</p></dd><dt class="param">forwardingChannel</dt><dd class="cmt"><p>
If this HTLC is involved in a forwarding operation, this field indicates
the forwarding channel. For an outgoing htlc, it is the incoming channel.
For an incoming htlc, it is the outgoing channel. When the htlc
originates from this node or this node is the final destination,
forwarding_channel will be zero. The forwarding channel will also be zero
for htlcs that need to be forwarded but don't have a forwarding decision
persisted yet.</p></dd><dt class="param">forwardingHtlcIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Index identifying the htlc on the forwarding channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.HTLCAttempt" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HTLCAttemptextendsGeneratedMessagewithUpdatable[lnrpc.HTLCAttempt]withProductwithSerializable" class="anchorToMember"></a><a id="HTLCAttempt:HTLCAttempt" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/HTLCAttempt.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="HTLCAttempt.html" title=""><span class="name">HTLCAttempt</span></a><span class="params">(<span name="attemptId">attemptId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.HTLCAttempt._typemapper_attemptId.toCustom(0L)</a></span></span></span>, <span name="status">status: <a href="HTLCAttempt$$HTLCStatus.html" name="lnrpc.HTLCAttempt.HTLCStatus" id="lnrpc.HTLCAttempt.HTLCStatus" class="extype">HTLCStatus</a> = <span class="defval"><span class="name"><a href="">lnrpc.HTLCAttempt.HTLCStatus.IN_FLIGHT</a></span></span></span>, <span name="route">route: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="Route.html" name="lnrpc.Route" id="lnrpc.Route" class="extype">Route</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="attemptTimeNs">attemptTimeNs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="resolveTimeNs">resolveTimeNs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="failure">failure: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="Failure.html" name="lnrpc.Failure" id="lnrpc.Failure" class="extype">Failure</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="preimage">preimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="HTLCAttempt.html" name="lnrpc.HTLCAttempt" id="lnrpc.HTLCAttempt" class="extype">HTLCAttempt</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Produ
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The unique ID that is used for this attempt.</p></dd><dt class="param">status</dt><dd class="cmt"><p>
The status of the HTLC.</p></dd><dt class="param">route</dt><dd class="cmt"><p>
The route taken by this HTLC.</p></dd><dt class="param">attemptTimeNs</dt><dd class="cmt"><p>
The time in UNIX nanoseconds at which this HTLC was sent.</p></dd><dt class="param">resolveTimeNs</dt><dd class="cmt"><p>
The time in UNIX nanoseconds at which this HTLC was settled or failed.
This value will not be set if the HTLC is still IN_FLIGHT.</p></dd><dt class="param">failure</dt><dd class="cmt"><p>
Detailed htlc failure info.</p></dd><dt class="param">preimage</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The preimage that was used to settle the HTLC.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Hop" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HopextendsGeneratedMessagewithUpdatable[lnrpc.Hop]withProductwithSerializable" class="anchorToMember"></a><a id="Hop:Hop" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Hop.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Hop.html" title=""><span class="name">Hop</span></a><span class="params">(<span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Hop._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="chanCapacity">chanCapacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="amtToForward">amtToForward: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="fee">fee: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="expiry">expiry: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.Hop._typemapper_expiry.toCustom(0)</a></span></span></span>, <span name="amtToForwardMsat">amtToForwardMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="feeMsat">feeMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="tlvPayload">tlvPayload: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="mppRecord">mppRecord: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="MPPRecord.html" name="lnrpc.MPPRecord" id="lnrpc.MPPRecord" class="extype">MPPRecord</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="ampRecord">ampRecord: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="AMPRecord.html" name="lnrpc.AMPRecord" id="lnrpc.AMPRecord" class="extype">AMPRecord</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="customRecords">customRecords: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</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://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
output index for the channel.</p></dd><dt class="param">pubKey</dt><dd class="cmt"><p>
An optional public key of the hop. If the public key is given, the payment
can be executed without relying on a copy of the channel graph.</p></dd><dt class="param">tlvPayload</dt><dd class="cmt"><p>
If set to true, then this hop will be encoded using the new variable length
TLV format. Note that if any custom tlv_records below are specified, then
this field MUST be set to true for them to be encoded properly.</p></dd><dt class="param">mppRecord</dt><dd class="cmt"><p>
An optional TLV record that signals the use of an MPP payment. If present,
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
the receiver will enforce that the same mpp_record is included in the final
hop payload of all non-zero payments in the HTLC set. If empty, a regular
single-shot payment is or was attempted.</p></dd><dt class="param">ampRecord</dt><dd class="cmt"><p>
An optional TLV record that signals the use of an AMP payment. If present,
the receiver will treat all received payments including the same
(payment_addr, set_id) pair as being part of one logical payment. The
payment will be settled by XORing the root_share's together and deriving the
child hashes and preimages according to BOLT XX. Must be used in conjunction
with mpp_record.</p></dd><dt class="param">customRecords</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
An optional set of key-value TLV records. This is useful within the context
of the SendToRoute call as it allows callers to specify arbitrary K-V pairs
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
to drop off at each hop within the onion.</p></dd><dt class="param">metadata</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The payment metadata to send along with the payment to the payee.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.HopHint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="HopHintextendsGeneratedMessagewithUpdatable[lnrpc.HopHint]withProductwithSerializable" class="anchorToMember"></a><a id="HopHint:HopHint" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/HopHint.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="HopHint.html" title=""><span class="name">HopHint</span></a><span class="params">(<span name="nodeId">nodeId: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.HopHint._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="feeBaseMsat">feeBaseMsat: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.HopHint._typemapper_feeBaseMsat.toCustom(0)</a></span></span></span>, <span name="feeProportionalMillionths">feeProportionalMillionths: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.HopHint._typemapper_feeProportionalMillionths.toCustom(0)</a></span></span></span>, <span name="cltvExpiryDelta">cltvExpiryDelta: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.HopHint._typemapper_cltvExpiryDelta.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="HopHint.html" name="lnrpc.HopHint" id="lnrpc.HopHint" class="extype">HopHint</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">nodeId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The public key of the node at the start of the channel.</p></dd><dt class="param">chanId</dt><dd class="cmt"><p>
The unique identifier of the channel.</p></dd><dt class="param">feeBaseMsat</dt><dd class="cmt"><p>
The base fee of the channel denominated in millisatoshis.</p></dd><dt class="param">feeProportionalMillionths</dt><dd class="cmt"><p>
The fee rate of the channel for sending one satoshi across it denominated in
millionths of a satoshi.</p></dd><dt class="param">cltvExpiryDelta</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The time-lock delta of the channel.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.InitWalletRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitWalletRequestextendsGeneratedMessagewithUpdatable[lnrpc.InitWalletRequest]withProductwithSerializable" class="anchorToMember"></a><a id="InitWalletRequest:InitWalletRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/InitWalletRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="InitWalletRequest.html" title=""><span class="name">InitWalletRequest</span></a><span class="params">(<span name="walletPassword">walletPassword: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="cipherSeedMnemonic">cipherSeedMnemonic: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="aezeedPassphrase">aezeedPassphrase: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="recoveryWindow">recoveryWindow: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="channelBackups">channelBackups: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChanBackupSnapshot.html" name="lnrpc.ChanBackupSnapshot" id="lnrpc.ChanBackupSnapshot" class="extype">ChanBackupSnapshot</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="statelessInit">statelessInit: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="extendedMasterKey">extendedMasterKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="extendedMasterKeyBirthdayTimestamp">extendedMasterKeyBirthdayTimestamp: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InitWalletRequest._typemapper_extendedMasterKeyBirthdayTimestamp.toCustom(0L)</a></span></span></span>, <span name="watchOnly">watchOnly: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="WatchOnly.html" name="lnrpc.WatchOnly" id="lnrpc.WatchOnly" class="extype">WatchOnly</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="macaroonRootKey">macaroonRootKey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.go
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
wallet_password is the passphrase that should be used to encrypt the
wallet. This MUST be at least 8 chars in length. After creation, this
password is required to unlock the daemon. When using REST, this field
must be encoded as base64.</p></dd><dt class="param">cipherSeedMnemonic</dt><dd class="cmt"><p>
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user. This may have been generated by the
GenSeed method, or be an existing seed.</p></dd><dt class="param">aezeedPassphrase</dt><dd class="cmt"><p>
aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed. When using REST, this field
must be encoded as base64.</p></dd><dt class="param">recoveryWindow</dt><dd class="cmt"><p>
recovery_window is an optional argument specifying the address lookahead
when restoring a wallet seed. The recovery window applies to each
individual branch of the BIP44 derivation paths. Supplying a recovery
window of zero indicates that no addresses should be recovered, such after
the first initialization of the wallet.</p></dd><dt class="param">channelBackups</dt><dd class="cmt"><p>
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels. This should be populated if the
user was unable to close out all channels and sweep funds before partial or
total data loss occurred. If specified, then after on-chain recovery of
funds, lnd begin to carry out the data loss recovery protocol in order to
recover the funds in each channel from a remote force closed transaction.</p></dd><dt class="param">statelessInit</dt><dd class="cmt"><p>
stateless_init is an optional argument instructing the daemon NOT to create
any *.macaroon files in its filesystem. If this parameter is set, then the
admin macaroon returned in the response MUST be stored by the caller of the
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
RPC as otherwise all access to the daemon will be lost!</p></dd><dt class="param">extendedMasterKey</dt><dd class="cmt"><p>
extended_master_key is an alternative to specifying cipher_seed_mnemonic and
aezeed_passphrase. Instead of deriving the master root key from the entropy
of an aezeed cipher seed, the given extended master root key is used
directly as the wallet's master key. This allows users to import/use a
master key from another wallet. When doing so, lnd still uses its default
SegWit only (BIP49/84) derivation paths and funds from custom/non-default
derivation paths will not automatically appear in the on-chain wallet. Using
an 'xprv' instead of an aezeed also has the disadvantage that the wallet's
birthday is not known as that is an information that's only encoded in the
aezeed, not the xprv. Therefore a birthday needs to be specified in
extended_master_key_birthday_timestamp or a "safe" default value will be
used.</p></dd><dt class="param">extendedMasterKeyBirthdayTimestamp</dt><dd class="cmt"><p>
extended_master_key_birthday_timestamp is the optional unix timestamp in
seconds to use as the wallet's birthday when using an extended master key
to restore the wallet. lnd will only start scanning for funds in blocks that
are after the birthday which can speed up the process significantly. If the
birthday is not known, this should be left at its default value of 0 in
which case lnd will start scanning from the first SegWit block (481824 on
mainnet).</p></dd><dt class="param">watchOnly</dt><dd class="cmt"><p>
watch_only is the third option of initializing a wallet: by importing
account xpubs only and therefore creating a watch-only wallet that does not
contain any private keys. That means the wallet won't be able to sign for
any of the keys and _needs_ to be run with a remote signer that has the
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
corresponding private keys and can serve signing RPC requests.</p></dd><dt class="param">macaroonRootKey</dt><dd class="cmt"><p>
macaroon_root_key is an optional 32 byte macaroon root key that can be
provided when initializing the wallet rather than letting lnd generate one
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
on its own.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.InitWalletResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitWalletResponseextendsGeneratedMessagewithUpdatable[lnrpc.InitWalletResponse]withProductwithSerializable" class="anchorToMember"></a><a id="InitWalletResponse:InitWalletResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/InitWalletResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="InitWalletResponse.html" title=""><span class="name">InitWalletResponse</span></a><span class="params">(<span name="adminMacaroon">adminMacaroon: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="InitWalletResponse.html" name="lnrpc.InitWalletResponse" id="lnrpc.InitWalletResponse" class="extype">InitWalletResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">adminMacaroon</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The binary serialized admin macaroon that can be used to access the daemon
after creating the wallet. If the stateless_init parameter was set to true,
this is the ONLY copy of the macaroon and MUST be stored safely by the
caller. Otherwise a copy of this macaroon is also persisted on disk by the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
daemon, together with other macaroon files.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Initiator" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="InitiatorextendsGeneratedEnum" class="anchorToMember"></a><a id="Initiator:Initiator" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Initiator.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="Initiator.html" title=""><span class="name">Initiator</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.InterceptFeedback" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InterceptFeedbackextendsGeneratedMessagewithUpdatable[lnrpc.InterceptFeedback]withProductwithSerializable" class="anchorToMember"></a><a id="InterceptFeedback:InterceptFeedback" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/InterceptFeedback.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="InterceptFeedback.html" title=""><span class="name">InterceptFeedback</span></a><span class="params">(<span name="error">error: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="replaceResponse">replaceResponse: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="replacementSerialized">replacementSerialized: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="InterceptFeedback.html" name="lnrpc.InterceptFeedback" id="lnrpc.InterceptFeedback" class="extype">InterceptFeedback</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">error</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The error to return to the user. If this is non-empty, the incoming gRPC
stream/request is aborted and the error is returned to the gRPC client. If
this value is empty, it means the middleware accepts the stream/request/
response and the processing of it can continue.</p></dd><dt class="param">replaceResponse</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
A boolean indicating that the gRPC message should be replaced/overwritten.
This boolean is needed because in protobuf an empty message is serialized as
a 0-length or nil byte slice and we wouldn't be able to distinguish between
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
an empty replacement message and the "don't replace anything" case.</p></dd><dt class="param">replacementSerialized</dt><dd class="cmt"><p>
If the replace_response field is set to true, this field must contain the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
binary serialized gRPC message in the protobuf format.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Invoice" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InvoiceextendsGeneratedMessagewithUpdatable[lnrpc.Invoice]withProductwithSerializable" class="anchorToMember"></a><a id="Invoice:Invoice" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Invoice.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Invoice.html" title=""><span class="name">Invoice</span></a><span class="params">(<span name="memo">memo: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="rPreimage">rPreimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="rHash">rHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="value">value: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="valueMsat">valueMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="settled">settled: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="creationDate">creationDate: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="settleDate">settleDate: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="paymentRequest">paymentRequest: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="descriptionHash">descriptionHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="expiry">expiry: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="fallbackAddr">fallbackAddr: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="cltvExpiry">cltvExpiry: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Invoice._typemapper_cltvExpiry.toCustom(0L)</a></span></span></spa
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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.</p></dd><dt class="param">rPreimage</dt><dd class="cmt"><p>
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.</p></dd><dt class="param">rHash</dt><dd class="cmt"><p>
The hash of the preimage. When using REST, this field must be encoded as
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
base64.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">value</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.</p></dd><dt class="param">valueMsat</dt><dd class="cmt"><p>
The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.</p></dd><dt class="param">settled</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Whether this invoice has been fulfilled.
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
The field is deprecated. Use the state field instead (compare to SETTLED).</p></dd><dt class="param">creationDate</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
When this invoice was created.
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Measured in seconds since the unix epoch.
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">settleDate</dt><dd class="cmt"><p>
When this invoice was settled.
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Measured in seconds since the unix epoch.
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">paymentRequest</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
payment to the recipient.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">descriptionHash</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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.</p></dd><dt class="param">expiry</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Payment request expiry time in seconds. Default is 86400 (24 hours).</p></dd><dt class="param">fallbackAddr</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Fallback on-chain address.</p></dd><dt class="param">cltvExpiry</dt><dd class="cmt"><p>
Delta to use for the time-lock of the CLTV extended to the final hop.</p></dd><dt class="param">routeHints</dt><dd class="cmt"><p>
Route hints that can each be individually used to assist in reaching the
invoice's destination.</p></dd><dt class="param">private</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Whether this invoice should include routing hints for private channels.
Note: When enabled, if value and value_msat are zero, a large number of
hints with these channels can be included, which might not be desirable.</p></dd><dt class="param">addIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
invoices with an add_index greater than this one.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">settleIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
settled invoices with an settle_index greater than this one.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">amtPaid</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Deprecated, use amt_paid_sat or amt_paid_msat.</p></dd><dt class="param">amtPaidSat</dt><dd class="cmt"><p>
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
as well.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">amtPaidMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
here as well.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">state</dt><dd class="cmt"><p>
The state the invoice is in.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">htlcs</dt><dd class="cmt"><p>
List of HTLCs paying to this invoice [EXPERIMENTAL].
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">features</dt><dd class="cmt"><p>
List of features advertised on the invoice.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">isKeysend</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Indicates if this invoice was a spontaneous payment that arrived via keysend
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
[EXPERIMENTAL].
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">paymentAddr</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The payment address of this invoice. This value will be used in MPP
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
payments, and also for newer invoices that always require the MPP payload
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
for added end-to-end security.
Note: Output only, don't specify for creating an invoice.</p></dd><dt class="param">isAmp</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
Signals whether or not this is an AMP invoice.</p></dd><dt class="param">ampInvoiceState</dt><dd class="cmt"><p>
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID. This field is always populated for AMP invoices, and can be
used along side LookupInvoice to obtain the HTLC information related to a
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
given sub-invoice.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Note: Output only, don't specify for creating an invoice.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.InvoiceHTLC" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InvoiceHTLCextendsGeneratedMessagewithUpdatable[lnrpc.InvoiceHTLC]withProductwithSerializable" class="anchorToMember"></a><a id="InvoiceHTLC:InvoiceHTLC" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/InvoiceHTLC.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="InvoiceHTLC.html" title="Details of an HTLC that paid to an invoice"><span class="name">InvoiceHTLC</span></a><span class="params">(<span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InvoiceHTLC._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="htlcIndex">htlcIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InvoiceHTLC._typemapper_htlcIndex.toCustom(0L)</a></span></span></span>, <span name="amtMsat">amtMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InvoiceHTLC._typemapper_amtMsat.toCustom(0L)</a></span></span></span>, <span name="acceptHeight">acceptHeight: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="acceptTime">acceptTime: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="resolveTime">resolveTime: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="expiryHeight">expiryHeight: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="state">state: <a href="InvoiceHTLCState.html" name="lnrpc.InvoiceHTLCState" id="lnrpc.InvoiceHTLCState" class="extype">InvoiceHTLCState</a> = <span class="symbol"><span class="name"><a href="">lnrpc.InvoiceHTLCState.ACCEPTED</a></span></span></span>, <span name="customRecords">customRecords: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</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://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="mppTotalAmtMsat">mppTotalAmtMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InvoiceHTLC._typemapper_mppTotalAmtMsat.toCustom(0L)</a></span></span></span>, <s
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
</p><div class="fullcomment"><div class="comment cmt"><p>Details of an HTLC that paid to an invoice
</p></div><dl class="paramcmts block"><dt class="param">chanId</dt><dd class="cmt"><p>
Short channel id over which the htlc was received.</p></dd><dt class="param">htlcIndex</dt><dd class="cmt"><p>
Index identifying the htlc on the channel.</p></dd><dt class="param">amtMsat</dt><dd class="cmt"><p>
The amount of the htlc in msat.</p></dd><dt class="param">acceptHeight</dt><dd class="cmt"><p>
Block height at which this htlc was accepted.</p></dd><dt class="param">acceptTime</dt><dd class="cmt"><p>
Time at which this htlc was accepted.</p></dd><dt class="param">resolveTime</dt><dd class="cmt"><p>
Time at which this htlc was settled or canceled.</p></dd><dt class="param">expiryHeight</dt><dd class="cmt"><p>
Block height at which this htlc expires.</p></dd><dt class="param">state</dt><dd class="cmt"><p>
Current state the htlc is in.</p></dd><dt class="param">customRecords</dt><dd class="cmt"><p>
Custom tlv records.</p></dd><dt class="param">mppTotalAmtMsat</dt><dd class="cmt"><p>
The total amount of the mpp payment in msat.</p></dd><dt class="param">amp</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Details relevant to AMP HTLCs, only populated if this is an AMP HTLC.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.InvoiceHTLCState" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="InvoiceHTLCStateextendsGeneratedEnum" class="anchorToMember"></a><a id="InvoiceHTLCState:InvoiceHTLCState" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/InvoiceHTLCState.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="InvoiceHTLCState.html" title=""><span class="name">InvoiceHTLCState</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.InvoiceSubscription" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InvoiceSubscriptionextendsGeneratedMessagewithUpdatable[lnrpc.InvoiceSubscription]withProductwithSerializable" class="anchorToMember"></a><a id="InvoiceSubscription:InvoiceSubscription" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/InvoiceSubscription.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="InvoiceSubscription.html" title=""><span class="name">InvoiceSubscription</span></a><span class="params">(<span name="addIndex">addIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InvoiceSubscription._typemapper_addIndex.toCustom(0L)</a></span></span></span>, <span name="settleIndex">settleIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.InvoiceSubscription._typemapper_settleIndex.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="InvoiceSubscription.html" name="lnrpc.InvoiceSubscription" id="lnrpc.InvoiceSubscription" class="extype">InvoiceSubscription</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">addIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
If specified (non-zero), then we'll first start by sending out
notifications for all added indexes with an add_index greater than this
value. This allows callers to catch up on any events they missed while they
weren't connected to the streaming RPC.</p></dd><dt class="param">settleIndex</dt><dd class="cmt"><p>
If specified (non-zero), then we'll first start by sending out
notifications for all settled indexes with an settle_index greater than
this value. This allows callers to catch up on any events they missed while
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
they weren't connected to the streaming RPC.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.KeyDescriptor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="KeyDescriptorextendsGeneratedMessagewithUpdatable[lnrpc.KeyDescriptor]withProductwithSerializable" class="anchorToMember"></a><a id="KeyDescriptor:KeyDescriptor" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/KeyDescriptor.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="KeyDescriptor.html" title=""><span class="name">KeyDescriptor</span></a><span class="params">(<span name="rawKeyBytes">rawKeyBytes: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="keyLoc">keyLoc: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyLocator.html" name="lnrpc.KeyLocator" id="lnrpc.KeyLocator" class="extype">KeyLocator</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="KeyDescriptor.html" name="lnrpc.KeyDescriptor" id="lnrpc.KeyDescriptor" class="extype">KeyDescriptor</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">rawKeyBytes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The raw bytes of the key being identified.</p></dd><dt class="param">keyLoc</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The key locator that identifies which key to use for signing.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.KeyLocator" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="KeyLocatorextendsGeneratedMessagewithUpdatable[lnrpc.KeyLocator]withProductwithSerializable" class="anchorToMember"></a><a id="KeyLocator:KeyLocator" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/KeyLocator.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="KeyLocator.html" title=""><span class="name">KeyLocator</span></a><span class="params">(<span name="keyFamily">keyFamily: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="keyIndex">keyIndex: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="KeyLocator.html" name="lnrpc.KeyLocator" id="lnrpc.KeyLocator" class="extype">KeyLocator</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">keyFamily</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The family of key being identified.</p></dd><dt class="param">keyIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 011fdc2cdb36aae5b370cfd2abdc08ca2ca00041
2022-01-21 00:10:54 +00:00
The precise index of the key being identified.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Lightning" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="LightningextendsAnyRef" class="anchorToMember"></a><a id="Lightning:Lightning" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="Lightning.html" title="Lightning is the main RPC server of the daemon."><span class="name">Lightning</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><p class="shortcomment cmt">Lightning is the main RPC server of the daemon.</p><div class="fullcomment"><div class="comment cmt"><p>Lightning is the main RPC server of the daemon.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.LightningAddress" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LightningAddressextendsGeneratedMessagewithUpdatable[lnrpc.LightningAddress]withProductwithSerializable" class="anchorToMember"></a><a id="LightningAddress:LightningAddress" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/LightningAddress.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="LightningAddress.html" title=""><span class="name">LightningAddress</span></a><span class="params">(<span name="pubkey">pubkey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="host">host: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="LightningAddress.html" name="lnrpc.LightningAddress" id="lnrpc.LightningAddress" class="extype">LightningAddress</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">pubkey</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
The identity pubkey of the Lightning node.</p></dd><dt class="param">host</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The network location of the lightning node, e.g. <code>69.69.69.69:1337</code> or
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
<code>localhost:10011</code>.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.LightningClient" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="LightningClientextendsLightningwithLightningClientPowerApiwithAkkaGrpcClient" class="anchorToMember"></a><a id="LightningClient:LightningClient" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/LightningClient.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="LightningClient.html" title=""><span class="name">LightningClient</span></a><span class="result"> extends <a href="Lightning.html" name="lnrpc.Lightning" id="lnrpc.Lightning" class="extype">Lightning</a> with <a href="LightningClientPowerApi.html" name="lnrpc.LightningClientPowerApi" id="lnrpc.LightningClientPowerApi" class="extype">LightningClientPowerApi</a> with <a href="https://doc.akka.io/api/akka-grpc/2.1.6/akka/grpc/akka/grpc/scaladsl/AkkaGrpcClient.html#akka.grpc.scaladsl.AkkaGrpcClient" name="akka.grpc.scaladsl.AkkaGrpcClient" id="akka.grpc.scaladsl.AkkaGrpcClient" class="extype">AkkaGrpcClient</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.LightningClientPowerApi" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="LightningClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="LightningClientPowerApi:LightningClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/LightningClientPowerApi.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="LightningClientPowerApi.html" title=""><span class="name">LightningClientPowerApi</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.LightningNode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LightningNodeextendsGeneratedMessagewithUpdatable[lnrpc.LightningNode]withProductwithSerializable" class="anchorToMember"></a><a id="LightningNode:LightningNode" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/LightningNode.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="LightningNode.html" title="An individual vertex/node within the channel graph."><span class="name">LightningNode</span></a><span class="params">(<span name="lastUpdate">lastUpdate: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.LightningNode._typemapper_lastUpdate.toCustom(0)</a></span></span></span>, <span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="alias">alias: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="addresses">addresses: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="NodeAddress.html" name="lnrpc.NodeAddress" id="lnrpc.NodeAddress" class="extype">NodeAddress</a>] = <span class="symbol"><span class="name"><a
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
connected to other nodes by one or more channel edges emanating from it. As the
graph is directed, a node will also have an incoming edge attached to it for
each outgoing edge.
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
</p></div><dl class="paramcmts block"><dt class="param">customRecords</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Custom node announcement tlv records.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListAliasesRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListAliasesRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListAliasesRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListAliasesRequest:ListAliasesRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListAliasesRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListAliasesRequest.html" title=""><span class="name">ListAliasesRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListAliasesRequest.html" name="lnrpc.ListAliasesRequest" id="lnrpc.ListAliasesRequest" class="extype">ListAliasesRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListAliasesResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListAliasesResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListAliasesResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListAliasesResponse:ListAliasesResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListAliasesResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListAliasesResponse.html" title=""><span class="name">ListAliasesResponse</span></a><span class="params">(<span name="aliasMaps">aliasMaps: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="AliasMap.html" name="lnrpc.AliasMap" id="lnrpc.AliasMap" class="extype">AliasMap</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https:
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Filters the response for channels with a target peer's pubkey. If peer is
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
empty, all channels will be returned.</p></dd><dt class="param">peerAliasLookup</dt><dd class="cmt"><p>
Informs the server if the peer alias lookup per channel should be
enabled. It is turned off by default in order to avoid degradation of
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
performance for existing clients.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListChannelsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListChannelsResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListChannelsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListChannelsResponse:ListChannelsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListChannelsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListChannelsResponse.html" title=""><span class="name">ListChannelsResponse</span></a><span class="params">(<span name="channels">channels: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Channel.html" name="lnrpc.Channel" id="lnrpc.Channel" class="extype">Channel</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListChannelsResponse.html" name="lnrpc.ListChannelsResponse" id="lnrpc.ListChannelsResponse" class="extype">ListChannelsResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">channels</dt><dd class="cmt"><p>
The list of active channels</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListInvoiceRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListInvoiceRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListInvoiceRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListInvoiceRequest:ListInvoiceRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListInvoiceRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListInvoiceRequest.html" title=""><span class="name">ListInvoiceRequest</span></a><span class="params">(<span name="pendingOnly">pendingOnly: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="indexOffset">indexOffset: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListInvoiceRequest._typemapper_indexOffset.toCustom(0L)</a></span></span></span>, <span name="numMaxInvoices">numMaxInvoices: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListInvoiceRequest._typemapper_numMaxInvoices.toCustom(0L)</a></span></span></span>, <span name="reversed">reversed: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="creationDateStart">creationDateStart: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListInvoiceRequest._typemapper_creationDateStart.toCustom(0L)</a></span></span></span>, <span name="creationDateEnd">creationDateEnd: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListInvoiceRequest._typemapper_creationDateEnd.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListInvoiceRequest.html" name="lnrpc.ListInvoiceRequest" id="lnrpc.ListInvoiceRequest" class="extype">ListInvoiceRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comme
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
If set, only invoices that are not settled and not canceled will be returned
in the response.</p></dd><dt class="param">indexOffset</dt><dd class="cmt"><p>
The index of an invoice that will be used as either the start or end of a
query to determine which invoices should be returned in the response.</p></dd><dt class="param">numMaxInvoices</dt><dd class="cmt"><p>
The max number of invoices to return in the response to this query.</p></dd><dt class="param">reversed</dt><dd class="cmt"><p>
If set, the invoices returned will result from seeking backwards from the
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
specified index offset. This can be used to paginate backwards.</p></dd><dt class="param">creationDateStart</dt><dd class="cmt"><p>
If set, returns all invoices with a creation date greater than or equal
to it. Measured in seconds since the unix epoch.</p></dd><dt class="param">creationDateEnd</dt><dd class="cmt"><p>
If set, returns all invoices with a creation date less than or equal to
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
it. Measured in seconds since the unix epoch.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListInvoiceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListInvoiceResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListInvoiceResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListInvoiceResponse:ListInvoiceResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListInvoiceResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListInvoiceResponse.html" title=""><span class="name">ListInvoiceResponse</span></a><span class="params">(<span name="invoices">invoices: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Invoice.html" name="lnrpc.Invoice" id="lnrpc.Invoice" class="extype">Invoice</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="lastIndexOffset">lastIndexOffset: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListInvoiceResponse._typemapper_lastIndexOffset.toCustom(0L)</a></span></span></span>, <span name="firstIndexOffset">firstIndexOffset: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListInvoiceResponse._typemapper_firstIndexOffset.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListInvoiceResponse.html" name="lnrpc.ListInvoiceResponse" id="lnrpc.ListInvoiceResponse" class="extype">ListInvoiceResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">invoices</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of invoices from the time slice of the time series specified in the
request.</p></dd><dt class="param">lastIndexOffset</dt><dd class="cmt"><p>
The index of the last item in the set of returned invoices. This can be used
to seek further, pagination style.</p></dd><dt class="param">firstIndexOffset</dt><dd class="cmt"><p>
The index of the last item in the set of returned invoices. This can be used
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
to seek backwards, pagination style.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListMacaroonIDsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListMacaroonIDsRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListMacaroonIDsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListMacaroonIDsRequest:ListMacaroonIDsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListMacaroonIDsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListMacaroonIDsRequest.html" title=""><span class="name">ListMacaroonIDsRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListMacaroonIDsRequest.html" name="lnrpc.ListMacaroonIDsRequest" id="lnrpc.ListMacaroonIDsRequest" class="extype">ListMacaroonIDsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListMacaroonIDsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListMacaroonIDsResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListMacaroonIDsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListMacaroonIDsResponse:ListMacaroonIDsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListMacaroonIDsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListMacaroonIDsResponse.html" title=""><span class="name">ListMacaroonIDsResponse</span></a><span class="params">(<span name="rootKeyIds">rootKeyIds: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</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>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalap
The list of root key IDs that are in use.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListPaymentsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListPaymentsRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListPaymentsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListPaymentsRequest:ListPaymentsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListPaymentsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListPaymentsRequest.html" title=""><span class="name">ListPaymentsRequest</span></a><span class="params">(<span name="includeIncomplete">includeIncomplete: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="indexOffset">indexOffset: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsRequest._typemapper_indexOffset.toCustom(0L)</a></span></span></span>, <span name="maxPayments">maxPayments: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsRequest._typemapper_maxPayments.toCustom(0L)</a></span></span></span>, <span name="reversed">reversed: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="countTotalPayments">countTotalPayments: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="creationDateStart">creationDateStart: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsRequest._typemapper_creationDateStart.toCustom(0L)</a></span></span></span>, <span name="creationDateEnd">creationDateEnd: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsRequest._typemapper_creationDateEnd.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListPaymentsRequest.html" name="lnrpc.ListPaymentsRequest" id="lnrpc.ListPaymentsRequest" class="extype">ListPaymentsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="sc
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
If true, then return payments that have not yet fully completed. This means
that pending payments, as well as failed payments will show up if this
field is set to true. This flag doesn't change the meaning of the indices,
which are tied to individual payments.</p></dd><dt class="param">indexOffset</dt><dd class="cmt"><p>
The index of a payment that will be used as either the start or end of a
query to determine which payments should be returned in the response. The
index_offset is exclusive. In the case of a zero index_offset, the query
will start with the oldest payment when paginating forwards, or will end
with the most recent payment when paginating backwards.</p></dd><dt class="param">maxPayments</dt><dd class="cmt"><p>
The maximal number of payments returned in the response to this query.</p></dd><dt class="param">reversed</dt><dd class="cmt"><p>
If set, the payments returned will result from seeking backwards from the
specified index offset. This can be used to paginate backwards. The order
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
of the returned payments is always oldest first (ascending index order).</p></dd><dt class="param">countTotalPayments</dt><dd class="cmt"><p>
If set, all payments (complete and incomplete, independent of the
max_payments parameter) will be counted. Note that setting this to true will
increase the run time of the call significantly on systems that have a lot
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
of payments, as all of them have to be iterated through to be counted.</p></dd><dt class="param">creationDateStart</dt><dd class="cmt"><p>
If set, returns all invoices with a creation date greater than or equal
to it. Measured in seconds since the unix epoch.</p></dd><dt class="param">creationDateEnd</dt><dd class="cmt"><p>
If set, returns all invoices with a creation date less than or equal to
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
it. Measured in seconds since the unix epoch.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListPaymentsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListPaymentsResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListPaymentsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListPaymentsResponse:ListPaymentsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListPaymentsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListPaymentsResponse.html" title=""><span class="name">ListPaymentsResponse</span></a><span class="params">(<span name="payments">payments: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Payment.html" name="lnrpc.Payment" id="lnrpc.Payment" class="extype">Payment</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="firstIndexOffset">firstIndexOffset: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsResponse._typemapper_firstIndexOffset.toCustom(0L)</a></span></span></span>, <span name="lastIndexOffset">lastIndexOffset: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsResponse._typemapper_lastIndexOffset.toCustom(0L)</a></span></span></span>, <span name="totalNumPayments">totalNumPayments: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.ListPaymentsResponse._typemapper_totalNumPayments.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListPaymentsResponse.html" name="lnrpc.ListPaymentsResponse" id="lnrpc.ListPaymentsResponse" class="extype">ListPaymentsResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">payments</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The list of payments</p></dd><dt class="param">firstIndexOffset</dt><dd class="cmt"><p>
The index of the first item in the set of returned payments. This can be
used as the index_offset to continue seeking backwards in the next request.</p></dd><dt class="param">lastIndexOffset</dt><dd class="cmt"><p>
The index of the last item in the set of returned payments. This can be used
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
as the index_offset to continue seeking forwards in the next request.</p></dd><dt class="param">totalNumPayments</dt><dd class="cmt"><p>
Will only be set if count_total_payments in the request was set. Represents
the total number of payments (complete and incomplete, independent of the
number of payments requested in the query) currently present in the payments
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
database.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListPeersRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListPeersRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListPeersRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListPeersRequest:ListPeersRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListPeersRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListPeersRequest.html" title=""><span class="name">ListPeersRequest</span></a><span class="params">(<span name="latestError">latestError: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListPeersRequest.html" name="lnrpc.ListPeersRequest" id="lnrpc.ListPeersRequest" class="extype">ListPeersRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">latestError</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
If true, only the last error that our peer sent us will be returned with
the peer's information, rather than the full set of historic errors we have
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
stored.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListPeersResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListPeersResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListPeersResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListPeersResponse:ListPeersResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListPeersResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListPeersResponse.html" title=""><span class="name">ListPeersResponse</span></a><span class="params">(<span name="peers">peers: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Peer.html" name="lnrpc.Peer" id="lnrpc.Peer" class="extype">Peer</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListPeersResponse.html" name="lnrpc.ListPeersResponse" id="lnrpc.ListPeersResponse" class="extype">ListPeersResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">peers</dt><dd class="cmt"><p>
The list of currently connected peers</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListPermissionsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListPermissionsRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListPermissionsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListPermissionsRequest:ListPermissionsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListPermissionsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListPermissionsRequest.html" title=""><span class="name">ListPermissionsRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListPermissionsRequest.html" name="lnrpc.ListPermissionsRequest" id="lnrpc.ListPermissionsRequest" class="extype">ListPermissionsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListPermissionsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListPermissionsResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListPermissionsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListPermissionsResponse:ListPermissionsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListPermissionsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListPermissionsResponse.html" title=""><span class="name">ListPermissionsResponse</span></a><span class="params">(<span name="methodPermissions">methodPermissions: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</a>[<span name="scala.Predef.String" class="extype">String</span>, <a href="MacaroonPermissionList.html" name="lnrpc.MacaroonPermissionList" id="lnrpc.MacaroonPermissionList" class="extype">MacaroonPermissionList</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defv
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A map between all RPC method URIs and their required macaroon permissions to
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
access them.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListUnspentRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListUnspentRequestextendsGeneratedMessagewithUpdatable[lnrpc.ListUnspentRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ListUnspentRequest:ListUnspentRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListUnspentRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListUnspentRequest.html" title=""><span class="name">ListUnspentRequest</span></a><span class="params">(<span name="minConfs">minConfs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="maxConfs">maxConfs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="account">account: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListUnspentRequest.html" name="lnrpc.ListUnspentRequest" id="lnrpc.ListUnspentRequest" class="extype">ListUnspentRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">minConfs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The minimum number of confirmations to be included.</p></dd><dt class="param">maxConfs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
The maximum number of confirmations to be included.</p></dd><dt class="param">account</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
An optional filter to only include outputs belonging to an account.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ListUnspentResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ListUnspentResponseextendsGeneratedMessagewithUpdatable[lnrpc.ListUnspentResponse]withProductwithSerializable" class="anchorToMember"></a><a id="ListUnspentResponse:ListUnspentResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ListUnspentResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ListUnspentResponse.html" title=""><span class="name">ListUnspentResponse</span></a><span class="params">(<span name="utxos">utxos: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Utxo.html" name="lnrpc.Utxo" id="lnrpc.Utxo" class="extype">Utxo</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ListUnspentResponse.html" name="lnrpc.ListUnspentResponse" id="lnrpc.ListUnspentResponse" class="extype">ListUnspentResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">utxos</dt><dd class="cmt"><p>
A list of utxos</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.LookupHtlcResolutionRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LookupHtlcResolutionRequestextendsGeneratedMessagewithUpdatable[lnrpc.LookupHtlcResolutionRequest]withProductwithSerializable" class="anchorToMember"></a><a id="LookupHtlcResolutionRequest:LookupHtlcResolutionRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/LookupHtlcResolutionRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="LookupHtlcResolutionRequest.html" title=""><span class="name">LookupHtlcResolutionRequest</span></a><span class="params">(<span name="chanId">chanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.LookupHtlcResolutionRequest._typemapper_chanId.toCustom(0L)</a></span></span></span>, <span name="htlcIndex">htlcIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.LookupHtlcResolutionRequest._typemapper_htlcIndex.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="LookupHtlcResolutionRequest.html" name="lnrpc.LookupHtlcResolutionRequest" id="lnrpc.LookupHtlcResolutionRequest" class="extype">LookupHtlcResolutionRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.LookupHtlcResolutionResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="LookupHtlcResolutionResponseextendsGeneratedMessagewithUpdatable[lnrpc.LookupHtlcResolutionResponse]withProductwithSerializable" class="anchorToMember"></a><a id="LookupHtlcResolutionResponse:LookupHtlcResolutionResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/LookupHtlcResolutionResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="LookupHtlcResolutionResponse.html" title=""><span class="name">LookupHtlcResolutionResponse</span></a><span class="params">(<span name="settled">settled: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean<
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Settled is true is the htlc was settled. If false, the htlc was failed.</p></dd><dt class="param">offchain</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Offchain indicates whether the htlc was resolved off-chain or on-chain.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.MPPRecord" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MPPRecordextendsGeneratedMessagewithUpdatable[lnrpc.MPPRecord]withProductwithSerializable" class="anchorToMember"></a><a id="MPPRecord:MPPRecord" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/MPPRecord.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MPPRecord.html" title=""><span class="name">MPPRecord</span></a><span class="params">(<span name="paymentAddr">paymentAddr: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="totalAmtMsat">totalAmtMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="MPPRecord.html" name="lnrpc.MPPRecord" id="lnrpc.MPPRecord" class="extype">MPPRecord</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">paymentAddr</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A unique, random identifier used to authenticate the sender as the intended
payer of a multi-path payment. The payment_addr must be the same for all
subpayments, and match the payment_addr provided in the receiver's invoice.
The same payment_addr must be used on all subpayments.</p></dd><dt class="param">totalAmtMsat</dt><dd class="cmt"><p>
The total amount in milli-satoshis being sent as part of a larger multi-path
payment. The caller is responsible for ensuring subpayments to the same node
and payment_hash sum exactly to total_amt_msat. The same
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
total_amt_msat must be used on all subpayments.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.MacaroonId" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MacaroonIdextendsGeneratedMessagewithUpdatable[lnrpc.MacaroonId]withProductwithSerializable" class="anchorToMember"></a><a id="MacaroonId:MacaroonId" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/MacaroonId.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MacaroonId.html" title=""><span class="name">MacaroonId</span></a><span class="params">(<span name="nonce">nonce: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="storageId">storageId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="ops">ops: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Op.html" name="lnrpc.Op" id="lnrpc.Op" class="extype">Op</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="MacaroonId.html" name="lnrpc.MacaroonId" id="lnrpc.MacaroonId" class="extype">MacaroonId</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.MacaroonPermission" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MacaroonPermissionextendsGeneratedMessagewithUpdatable[lnrpc.MacaroonPermission]withProductwithSerializable" class="anchorToMember"></a><a id="MacaroonPermission:MacaroonPermission" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/MacaroonPermission.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MacaroonPermission.html" title=""><span class
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The entity a permission grants access to.</p></dd><dt class="param">action</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The action that is granted.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.MacaroonPermissionList" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MacaroonPermissionListextendsGeneratedMessagewithUpdatable[lnrpc.MacaroonPermissionList]withProductwithSerializable" class="anchorToMember"></a><a id="MacaroonPermissionList:MacaroonPermissionList" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/MacaroonPermissionList.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MacaroonPermissionList.html" title=""><span class="name">MacaroonPermissionList</span></a><span class="params">(<span name="permissions">permissions: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="MacaroonPermission.html" name="lnrpc.MacaroonPermission" id="lnrpc.MacaroonPermission" class="extype">MacaroonPermission</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="MacaroonPermissionList.html" name="lnrpc.MacaroonPermissionList" id="lnrpc.MacaroonPermissionList" class="extype">MacaroonPermissionList</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">permissions</dt><dd class="cmt"><p>
A list of macaroon permissions.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.MiddlewareRegistration" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MiddlewareRegistrationextendsGeneratedMessagewithUpdatable[lnrpc.MiddlewareRegistration]withProductwithSerializable" class="anchorToMember"></a><a id="MiddlewareRegistration:MiddlewareRegistration" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/MiddlewareRegistration.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MiddlewareRegistration.html" title=""><span class="name">MiddlewareRegistration</span></a><span class="params">(<span name="middlewareName">middlewareName: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="customMacaroonCaveatName">customMacaroonCaveatName: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="readOnlyMode">readOnlyMode: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="MiddlewareRegistration.html" name="lnrpc.MiddlewareRegistration" id="lnrpc.MiddlewareRegistration" class="extype">MiddlewareRegistration</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">middlewareName</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The name of the middleware to register. The name should be as informative
as possible and is logged on registration.</p></dd><dt class="param">customMacaroonCaveatName</dt><dd class="cmt"><p>
The name of the custom macaroon caveat that this middleware is responsible
for. Only requests/responses that contain a macaroon with the registered
custom caveat are forwarded for interception to the middleware. The
exception being the read-only mode: All requests/responses are forwarded to
a middleware that requests read-only access but such a middleware won't be
allowed to _alter_ responses. As a security measure, _no_ middleware can
change responses to requests made with _unencumbered_ macaroons!
NOTE: Cannot be used at the same time as read_only_mode.</p></dd><dt class="param">readOnlyMode</dt><dd class="cmt"><p>
Instead of defining a custom macaroon caveat name a middleware can register
itself for read-only access only. In that mode all requests/responses are
forwarded to the middleware but the middleware isn't allowed to alter any of
the responses.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.MultiChanBackup" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MultiChanBackupextendsGeneratedMessagewithUpdatable[lnrpc.MultiChanBackup]withProductwithSerializable" class="anchorToMember"></a><a id="MultiChanBackup:MultiChanBackup" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/MultiChanBackup.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="MultiChanBackup.html" title=""><span class="name">MultiChanBackup</span></a><span class="params">(<span name="chanPoints">chanPoints: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="multiChanBackup">multiChanBackup: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="MultiChanBackup.html" name="lnrpc.MultiChanBackup" id="lnrpc.MultiChanBackup" class="extype">MultiChanBackup</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">chanPoints</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Is the set of all channels that are included in this multi-channel backup.</p></dd><dt class="param">multiChanBackup</dt><dd class="cmt"><p>
A single encrypted blob containing all the static channel backups of the
channel listed above. This can be stored as a single file or blob, and
safely be replaced with any prior/future versions. When using REST, this
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
field must be encoded as base64.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NetworkInfo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NetworkInfoextendsGeneratedMessagewithUpdatable[lnrpc.NetworkInfo]withProductwithSerializable" class="anchorToMember"></a><a id="NetworkInfo:NetworkInfo" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NetworkInfo.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NetworkInfo.html" title=""><span class="name">NetworkInfo</span></a><span class="params">(<span name="graphDiameter">graphDiameter: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.NetworkInfo._typemapper_graphDiameter.toCustom(0)</a></span></span></span>, <span name="avgOutDegree">avgOutDegree: <a href="https://www.scala-lang.org/api/2.13.11/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="maxOutDegree">maxOutDegree: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.NetworkInfo._typemapper_maxOutDegree.toCustom(0)</a></span></span></span>, <span name="numNodes">numNodes: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.NetworkInfo._typemapper_numNodes.toCustom(0)</a></span></span></span>, <span name="numChannels">numChannels: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.NetworkInfo._typemapper_numChannels.toCustom(0)</a></span></span></span>, <span name="totalNetworkCapacity">totalNetworkCapacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="avgChannelSize">avgChannelSize: <a href="https://www.scala-lang.org/api/2.13.11/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="minChannelSize">minChannelSize: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="maxChannelSize">maxChannelSize: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="medianChannelSizeSat">medianChannelSizeSat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="numZombieChans">numZombieChans: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.NetworkInfo._typemapper_numZombieChans.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFiel
The number of edges marked as zombies.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NetworkInfoRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NetworkInfoRequestextendsGeneratedMessagewithUpdatable[lnrpc.NetworkInfoRequest]withProductwithSerializable" class="anchorToMember"></a><a id="NetworkInfoRequest:NetworkInfoRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NetworkInfoRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NetworkInfoRequest.html" title=""><span class="name">NetworkInfoRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NetworkInfoRequest.html" name="lnrpc.NetworkInfoRequest" id="lnrpc.NetworkInfoRequest" class="extype">NetworkInfoRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NewAddressRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NewAddressRequestextendsGeneratedMessagewithUpdatable[lnrpc.NewAddressRequest]withProductwithSerializable" class="anchorToMember"></a><a id="NewAddressRequest:NewAddressRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NewAddressRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NewAddressRequest.html" title=""><span class="name">NewAddressRequest</span></a><span class="params">(<span name="type">type: <a href="AddressType.html" name="lnrpc.AddressType" id="lnrpc.AddressType" class="extype">AddressType</a> = <span class="defval"><span class="name"><a href="">lnrpc.AddressType.WITNESS_PUBKEY_HASH</a></span></span></span>, <span name="account">account: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
The type of address to generate.</p></dd><dt class="param">account</dt><dd class="cmt"><p>
The name of the account to generate a new address for. If empty, the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
default wallet account is used.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NewAddressResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NewAddressResponseextendsGeneratedMessagewithUpdatable[lnrpc.NewAddressResponse]withProductwithSerializable" class="anchorToMember"></a><a id="NewAddressResponse:NewAddressResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NewAddressResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NewAddressResponse.html" title=""><span class="name">NewAddressResponse</span></a><span class="params">(<span name="address">address: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NewAddressResponse.html" name="lnrpc.NewAddressResponse" id="lnrpc.NewAddressResponse" class="extype">NewAddressResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">address</dt><dd class="cmt"><p>
The newly generated wallet address</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodeAddress" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeAddressextendsGeneratedMessagewithUpdatable[lnrpc.NodeAddress]withProductwithSerializable" class="anchorToMember"></a><a id="NodeAddress:NodeAddress" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeAddress.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeAddress.html" title=""><span class="name">NodeAddress</span></a><span class="params">(<span name="network">network: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="addr">addr: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodeAddress.html" name="lnrpc.NodeAddress" id="lnrpc.NodeAddress" class="extype">NodeAddress</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodeInfo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeInfoextendsGeneratedMessagewithUpdatable[lnrpc.NodeInfo]withProductwithSerializable" class="anchorToMember"></a><a id="NodeInfo:NodeInfo" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeInfo.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeInfo.html" title=""><span class="name">NodeInfo</span></a><span class="params">(<span name="node">node: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="LightningNode.html" name="lnrpc.LightningNode" id="lnrpc.LightningNode" class="extype">LightningNode</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="numChannels">numChannels: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.NodeInfo._typemapper_numChannels.toCustom(0)</a></span></span></span>, <span name="totalCapacity">totalCapacity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span clas
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
An individual vertex/node within the channel graph. A node is
connected to other nodes by one or more channel edges emanating from it. As
the graph is directed, a node will also have an incoming edge attached to
it for each outgoing edge.</p></dd><dt class="param">numChannels</dt><dd class="cmt"><p>
The total number of channels for the node.</p></dd><dt class="param">totalCapacity</dt><dd class="cmt"><p>
The sum of all channels capacity for the node, denominated in satoshis.</p></dd><dt class="param">channels</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
A list of all public channels for the node.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodeInfoRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeInfoRequestextendsGeneratedMessagewithUpdatable[lnrpc.NodeInfoRequest]withProductwithSerializable" class="anchorToMember"></a><a id="NodeInfoRequest:NodeInfoRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeInfoRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeInfoRequest.html" title=""><span class="name">NodeInfoRequest</span></a><span class="params">(<span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="includeChannels">includeChannels: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodeInfoRequest.html" name="lnrpc.NodeInfoRequest" id="lnrpc.NodeInfoRequest" class="extype">NodeInfoRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">pubKey</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The 33-byte hex-encoded compressed public of the target node</p></dd><dt class="param">includeChannels</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
If true, will include all known channels associated with the node.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodeMetricType" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="NodeMetricTypeextendsGeneratedEnum" class="anchorToMember"></a><a id="NodeMetricType:NodeMetricType" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeMetricType.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="NodeMetricType.html" title=""><span class="name">NodeMetricType</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.NodeMetricsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeMetricsRequestextendsGeneratedMessagewithUpdatable[lnrpc.NodeMetricsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="NodeMetricsRequest:NodeMetricsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeMetricsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeMetricsRequest.html" title=""><span class="name">NodeMetricsRequest</span></a><span class="params">(<span name="types">types: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="NodeMetricType.html" name="lnrpc.NodeMetricType" id="lnrpc.NodeMetricType" class="extype">NodeMetricType</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodeMetricsRequest.html" name="lnrpc.NodeMetricsRequest" id="lnrpc.NodeMetricsRequest" class="extype">NodeMetricsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">types</dt><dd class="cmt"><p>
The requested node metrics.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodeMetricsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeMetricsResponseextendsGeneratedMessagewithUpdatable[lnrpc.NodeMetricsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="NodeMetricsResponse:NodeMetricsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeMetricsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeMetricsResponse.html" title=""><span class="name">NodeMetricsResponse</span></a><span class="params">(<span name="betweennessCentrality">betweennessCentrality: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</a>[<span name="scala.Predef.String" class="extype">String</span>, <a href="FloatMetric.html" name="lnrpc.FloatMetric" id="lnrpc.FloatMetric" class="extype">FloatMetric</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodeMetricsResponse.html" name="lnrpc.NodeMetricsResponse" id="lnrpc.NodeMetricsResponse" class="extype">NodeMetricsResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">betweennessCentrality</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Betweenness centrality is the sum of the ratio of shortest paths that pass
through the node for each pair of nodes in the graph (not counting paths
starting or ending at this node).
Map of node pubkey to betweenness centrality of the node. Normalized
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
values are in the [0,1] closed interval.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodePair" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodePairextendsGeneratedMessagewithUpdatable[lnrpc.NodePair]withProductwithSerializable" class="anchorToMember"></a><a id="NodePair:NodePair" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodePair.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodePair.html" title=""><span class="name">NodePair</span></a><span class="params">(<span name="from">from: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="to">to: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodePair.html" name="lnrpc.NodePair" id="lnrpc.NodePair" class="extype">NodePair</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">from</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The sending node of the pair. When using REST, this field must be encoded as
base64.</p></dd><dt class="param">to</dt><dd class="cmt"><p>
The receiving node of the pair. When using REST, this field must be encoded
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
as base64.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.NodeUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeUpdateextendsGeneratedMessagewithUpdatable[lnrpc.NodeUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="NodeUpdate:NodeUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/NodeUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeUpdate.html" title=""><span class="name">NodeUpdate</span></a><span class="params">(<span name="addresses">addresses: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="identityKey">identityKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="globalFeatures">globalFeatures: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="alias">alias: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="color">color: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="nodeAddresses">nodeAddresses: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="NodeAddress.html" name="lnrpc.NodeAddress" id="lnrpc.NodeAddress" class="extype">NodeAddress</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="features">features: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</a>[<a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a>, <a href="Feature.html" name="lnrpc.Feature" id="lnrpc.Feature" class="extype">Feature</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodeUpdate.html" name="lnrpc.NodeUpdate" id="lnrpc.NodeUpdate" class="extype">NodeUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
Deprecated, use node_addresses.</p></dd><dt class="param">globalFeatures</dt><dd class="cmt"><p>
Deprecated, use features.</p></dd><dt class="param">features</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Features that the node has advertised in the init message, node
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
announcements and invoices.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Op" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OpextendsGeneratedMessagewithUpdatable[lnrpc.Op]withProductwithSerializable" class="anchorToMember"></a><a id="Op:Op" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Op.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Op.html" title=""><span class="name">Op</span></a><span class="params">(<span name="entity">entity: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="actions">actions: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="Op.html" name="lnrpc.Op" id="lnrpc.Op" class="extype">Op</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.OpenChannelRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OpenChannelRequestextendsGeneratedMessagewithUpdatable[lnrpc.OpenChannelRequest]withProductwithSerializable" class="anchorToMember"></a><a id="OpenChannelRequest:OpenChannelRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/OpenChannelRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="OpenChannelRequest.html" title=""><span class="name">OpenChannelRequest</span></a><span class="params">(<span name="satPerVbyte">satPerVbyte: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.OpenChannelRequest._typemapper_satPerVbyte.toCustom(0L)</a></span></span></span>, <span name="nodePubkey">nodePubkey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
A manual fee rate set in sat/vbyte that should be used when crafting the
funding transaction.</p></dd><dt class="param">nodePubkey</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The pubkey of the node to open a channel with. When using REST, this field
must be encoded as base64.</p></dd><dt class="param">nodePubkeyString</dt><dd class="cmt"><p>
The hex encoded pubkey of the node to open a channel with. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.</p></dd><dt class="param">localFundingAmount</dt><dd class="cmt"><p>
The number of satoshis the wallet should commit to the channel</p></dd><dt class="param">pushSat</dt><dd class="cmt"><p>
The number of satoshis to push to the remote side as part of the initial
commitment state</p></dd><dt class="param">targetConf</dt><dd class="cmt"><p>
The target number of blocks that the funding transaction should be
confirmed by.</p></dd><dt class="param">satPerByte</dt><dd class="cmt"><p>
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
Deprecated, use sat_per_vbyte.
A manual fee rate set in sat/vbyte that should be used when crafting the
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
funding transaction.</p></dd><dt class="param">private</dt><dd class="cmt"><p>
Whether this channel should be private, not announced to the greater
network.</p></dd><dt class="param">minHtlcMsat</dt><dd class="cmt"><p>
The minimum value in millisatoshi we will require for incoming HTLCs on
the channel.</p></dd><dt class="param">remoteCsvDelay</dt><dd class="cmt"><p>
The delay we require on the remote's commitment transaction. If this is
not set, it will be scaled automatically with the channel size.</p></dd><dt class="param">minConfs</dt><dd class="cmt"><p>
The minimum number of confirmations each one of your outputs used for
the funding transaction must satisfy.</p></dd><dt class="param">spendUnconfirmed</dt><dd class="cmt"><p>
Whether unconfirmed outputs should be used as inputs for the funding
transaction.</p></dd><dt class="param">closeAddress</dt><dd class="cmt"><p>
Close address is an optional address which specifies the address to which
funds should be paid out to upon cooperative close. This field may only be
set if the peer supports the option upfront feature bit (call listpeers
to check). The remote peer will only accept cooperative closes to this
address if it is set.
Note: If this value is set on channel creation, you will *not* be able to
cooperatively close out to a different address.</p></dd><dt class="param">fundingShim</dt><dd class="cmt"><p>
Funding shims are an optional argument that allow the caller to intercept
certain funding functionality. For example, a shim can be provided to use a
particular key for the commitment key (ideally cold) rather than use one
that is generated by the wallet as normal, or signal that signing will be
carried out in an interactive manner (PSBT based).</p></dd><dt class="param">remoteMaxValueInFlightMsat</dt><dd class="cmt"><p>
The maximum amount of coins in millisatoshi that can be pending within
the channel. It only applies to the remote party.</p></dd><dt class="param">remoteMaxHtlcs</dt><dd class="cmt"><p>
The maximum number of concurrent HTLCs we will allow the remote party to add
to the commitment transaction.</p></dd><dt class="param">maxLocalCsv</dt><dd class="cmt"><p>
Max local csv is the maximum csv delay we will allow for our own commitment
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
transaction.</p></dd><dt class="param">commitmentType</dt><dd class="cmt"><p>
The explicit commitment type to use. Note this field will only be used if
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
the remote peer supports explicit channel negotiation.</p></dd><dt class="param">zeroConf</dt><dd class="cmt"><p>
If this is true, then a zero-conf channel open will be attempted.</p></dd><dt class="param">scidAlias</dt><dd class="cmt"><p>
If this is true, then an option-scid-alias channel-type open will be
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
attempted.</p></dd><dt class="param">baseFee</dt><dd class="cmt"><p>
The base fee charged regardless of the number of milli-satoshis sent.</p></dd><dt class="param">feeRate</dt><dd class="cmt"><p>
The fee rate in ppm (parts per million) that will be charged in
proportion of the value of each forwarded HTLC.</p></dd><dt class="param">useBaseFee</dt><dd class="cmt"><p>
If use_base_fee is true the open channel announcement will update the
channel base fee with the value specified in base_fee. In the case of
a base_fee of 0 use_base_fee is needed downstream to distinguish whether
to use the default base fee value specified in the config or 0.</p></dd><dt class="param">useFeeRate</dt><dd class="cmt"><p>
If use_fee_rate is true the open channel announcement will update the
channel fee rate with the value specified in fee_rate. In the case of
a fee_rate of 0 use_fee_rate is needed downstream to distinguish whether
to use the default fee rate value specified in the config or 0.</p></dd><dt class="param">remoteChanReserveSat</dt><dd class="cmt"><p>
The number of satoshis we require the remote peer to reserve. This value,
if specified, must be above the dust limit and below 20% of the channel
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
capacity.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.OpenStatusUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OpenStatusUpdateextendsGeneratedMessagewithUpdatable[lnrpc.OpenStatusUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="OpenStatusUpdate:OpenStatusUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/OpenStatusUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="OpenStatusUpdate.html" title=""><span class="name">OpenStatusUpdate</span></a><span class="params">(<span name="update">update: <a href="OpenStatusUpdate$$Update.html" name="lnrpc.OpenStatusUpdate.Update" id="lnrpc.OpenStatusUpdate.Update" class="extype">Update</a> = <span class="symbol"><span class="name"><a href="">lnrpc.OpenStatusUpdate.Update.Empty</a></span></span></span>, <span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="OpenStatusUpdate.html" name="lnrpc.OpenStatusUpdate" id="lnrpc.OpenStatusUpdate" class="extype">OpenStatusUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">pendingChanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The pending channel ID of the created channel. This value may be used to
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
further the funding flow manually via the FundingStateStep method.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.OutPoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OutPointextendsGeneratedMessagewithUpdatable[lnrpc.OutPoint]withProductwithSerializable" class="anchorToMember"></a><a id="OutPoint:OutPoint" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/OutPoint.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="OutPoint.html" title=""><span class="name">OutPoint</span></a><span class="params">(<span name="txidBytes">txidBytes: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="txidStr">txidStr: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="outputIndex">outputIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.OutPoint._typemapper_outputIndex.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="OutPoint.html" name="lnrpc.OutPoint" id="lnrpc.OutPoint" class="extype">OutPoint</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">txidBytes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Raw bytes representing the transaction id.</p></dd><dt class="param">txidStr</dt><dd class="cmt"><p>
Reversed, hex-encoded string representing the transaction id.</p></dd><dt class="param">outputIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The index of the output on the transaction.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.OutputDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OutputDetailextendsGeneratedMessagewithUpdatable[lnrpc.OutputDetail]withProductwithSerializable" class="anchorToMember"></a><a id="OutputDetail:OutputDetail" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/OutputDetail.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="OutputDetail.html" title=""><span class="name">OutputDetail</span></a><span class="params">(<span name="outputType">outputType: <a href="OutputScriptType.html" name="lnrpc.OutputScriptType" id="lnrpc.OutputScriptType" class="extype">OutputScriptType</a> = <span class="defval"><span class="name"><a href="">lnrpc.OutputScriptType.SCRIPT_TYPE_PUBKEY_HASH</a></span></span></span>, <span name="address">address: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="pkScript">pkScript: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="outputIndex">outputIndex: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="amount">amount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="isOurAddress">isOurAddress: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="OutputDetail.html" name="lnrpc.OutputDetail" id="lnrpc.OutputDetail" class="extype">OutputDetail</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">outputType</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
The type of the output</p></dd><dt class="param">address</dt><dd class="cmt"><p>
The address</p></dd><dt class="param">pkScript</dt><dd class="cmt"><p>
The pkscript in hex</p></dd><dt class="param">outputIndex</dt><dd class="cmt"><p>
The output index used in the raw transaction</p></dd><dt class="param">amount</dt><dd class="cmt"><p>
The value of the output coin in satoshis</p></dd><dt class="param">isOurAddress</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Denotes if the output is controlled by the internal wallet</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.OutputScriptType" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="OutputScriptTypeextendsGeneratedEnum" class="anchorToMember"></a><a id="OutputScriptType:OutputScriptType" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/OutputScriptType.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="OutputScriptType.html" title=""><span class="name">OutputScriptType</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.PayReq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PayReqextendsGeneratedMessagewithUpdatable[lnrpc.PayReq]withProductwithSerializable" class="anchorToMember"></a><a id="PayReq:PayReq" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PayReq.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PayReq.html" title=""><span class="name">PayReq</span></a><span class="params">(<span name="destination">destination: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="paymentHash">paymentHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="numSatoshis">numSatoshis: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="timestamp">timestamp: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="expiry">expiry: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="description">description: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="descriptionHash">descriptionHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="fallbackAddr">fallbackAddr: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="cltvExpiry">cltvExpiry: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="routeHints">routeHints: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="RouteHint.html" name="lnrpc.RouteHint" id="lnrpc.RouteHint" class="extype">RouteHint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="paymentAddr">paymentAddr: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="numMsat">numMsat: <a href="https://w
The payment request string to be decoded</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Payment" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PaymentextendsGeneratedMessagewithUpdatable[lnrpc.Payment]withProductwithSerializable" class="anchorToMember"></a><a id="Payment:Payment" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Payment.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Payment.html" title=""><span class="name">Payment</span></a><span class="params">(<span name="paymentHash">paymentHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="value">value: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="creationDate">creationDate: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="fee">fee: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="paymentPreimage">paymentPreimage: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="valueSat">valueSat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="valueMsat">valueMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="paymentRequest">paymentRequest: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="status">status: <a href="Payment$$PaymentStatus.html" name="lnrpc.Payment.PaymentStatus" id="lnrpc.Payment.PaymentStatus" class="extype">PaymentStatus</a> = <span class="symbol"><span class="name"><a href="">lnrpc.Payment.PaymentStatus.UNKNOWN</a></span></span></span>, <span name="feeSat">feeSat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="feeMsat">feeMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="creationTimeNs">creationTimeNs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="htlcs">htlcs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="HTLCAttempt.html" name="lnrpc.HTLCAttempt" id="lnrpc.HTLCAttempt" class="extype">HTLCAttempt</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="paymentIndex">paymentIndex: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Payment._typemapper_paymentIndex.toCustom(0L)</a></span></span></span>, <span name="failureReason">failureReason: <a href="PaymentFailureReason.html" name="lnrpc.PaymentFailureReason" id="lnrpc.PaymentFailureReason" class="extype">PaymentFailureReason</a> = <span class="defval"><span clas
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The payment hash</p></dd><dt class="param">value</dt><dd class="cmt"><p>
Deprecated, use value_sat or value_msat.</p></dd><dt class="param">creationDate</dt><dd class="cmt"><p>
Deprecated, use creation_time_ns</p></dd><dt class="param">fee</dt><dd class="cmt"><p>
Deprecated, use fee_sat or fee_msat.</p></dd><dt class="param">paymentPreimage</dt><dd class="cmt"><p>
The payment preimage</p></dd><dt class="param">valueSat</dt><dd class="cmt"><p>
The value of the payment in satoshis</p></dd><dt class="param">valueMsat</dt><dd class="cmt"><p>
The value of the payment in milli-satoshis</p></dd><dt class="param">paymentRequest</dt><dd class="cmt"><p>
The optional payment request being fulfilled.</p></dd><dt class="param">status</dt><dd class="cmt"><p>
The status of the payment.</p></dd><dt class="param">feeSat</dt><dd class="cmt"><p>
The fee paid for this payment in satoshis</p></dd><dt class="param">feeMsat</dt><dd class="cmt"><p>
The fee paid for this payment in milli-satoshis</p></dd><dt class="param">creationTimeNs</dt><dd class="cmt"><p>
The time in UNIX nanoseconds at which the payment was created.</p></dd><dt class="param">htlcs</dt><dd class="cmt"><p>
The HTLCs made in attempt to settle the payment.</p></dd><dt class="param">paymentIndex</dt><dd class="cmt"><p>
The creation index of this payment. Each payment can be uniquely identified
by this index, which may not strictly increment by 1 for payments made in
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
older versions of lnd.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PaymentFailureReason" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="PaymentFailureReasonextendsGeneratedEnum" class="anchorToMember"></a><a id="PaymentFailureReason:PaymentFailureReason" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PaymentFailureReason.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="PaymentFailureReason.html" title=""><span class="name">PaymentFailureReason</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.PaymentHash" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PaymentHashextendsGeneratedMessagewithUpdatable[lnrpc.PaymentHash]withProductwithSerializable" class="anchorToMember"></a><a id="PaymentHash:PaymentHash" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PaymentHash.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PaymentHash.html" title=""><span class="name">PaymentHash</span></a><span class="params">(<span name="rHashStr">rHashStr: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="rHash">rHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PaymentHash.html" name="lnrpc.PaymentHash" id="lnrpc.PaymentHash" class="extype">PaymentHash</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">rHashStr</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The hex-encoded payment hash of the invoice to be looked up. The passed
payment hash must be exactly 32 bytes, otherwise an error is returned.
Deprecated now that the REST gateway supports base64 encoding of bytes
fields.</p></dd><dt class="param">rHash</dt><dd class="cmt"><p>
The payment hash of the invoice to be looked up. When using REST, this field
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
must be encoded as base64.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Peer" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PeerextendsGeneratedMessagewithUpdatable[lnrpc.Peer]withProductwithSerializable" class="anchorToMember"></a><a id="Peer:Peer" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Peer.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Peer.html" title=""><span class="name">Peer</span></a><span class="params">(<span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="address">address: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="bytesSent">bytesSent: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Peer._typemapper_bytesSent.toCustom(0L)</a></span></span></span>, <span name="bytesRecv">bytesRecv: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Peer._typemapper_bytesRecv.toCustom(0L)</a></span></span></span>, <span name="satSent">satSent: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="satRecv">satRecv: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="inbound">inbound: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="pingTime">pingTime: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="syncType">syncType: <a href="Peer$$SyncType.html" name="lnrpc.Peer.SyncType" id="lnrpc.Peer.SyncType" class="extype">SyncType</a> = <span class="symbol"><span class="name"><a href="">lnrpc.Peer.SyncType.UNKNOWN_SYNC</a></span></span></span>, <span name="features">features: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</a>[<a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a>, <a href="Feature.html" name="lnrpc.Feature" id="lnrpc.Feature" class="extype">Feature</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="errors">errors: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="TimestampedError.html" name="lnrpc.TimestampedError" id="lnrpc.TimestampedError" class="extype">TimestampedError</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="flapCount">flapCount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="lastFlapNs">lastFlapNs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The identity pubkey of the peer</p></dd><dt class="param">address</dt><dd class="cmt"><p>
Network address of the peer; eg <code>127.0.0.1:10011</code></p></dd><dt class="param">bytesSent</dt><dd class="cmt"><p>
Bytes of data transmitted to this peer</p></dd><dt class="param">bytesRecv</dt><dd class="cmt"><p>
Bytes of data transmitted from this peer</p></dd><dt class="param">satSent</dt><dd class="cmt"><p>
Satoshis sent to this peer</p></dd><dt class="param">satRecv</dt><dd class="cmt"><p>
Satoshis received from this peer</p></dd><dt class="param">inbound</dt><dd class="cmt"><p>
A channel is inbound if the counterparty initiated the channel</p></dd><dt class="param">pingTime</dt><dd class="cmt"><p>
Ping time to this peer</p></dd><dt class="param">syncType</dt><dd class="cmt"><p>
The type of sync we are currently performing with this peer.</p></dd><dt class="param">features</dt><dd class="cmt"><p>
Features advertised by the remote peer in their init message.</p></dd><dt class="param">errors</dt><dd class="cmt"><p>
The latest errors received from our peer with timestamps, limited to the 10
most recent errors. These errors are tracked across peer connections, but
are not persisted across lnd restarts. Note that these errors are only
stored for peers that we have channels open with, to prevent peers from
spamming us with errors at no cost.</p></dd><dt class="param">flapCount</dt><dd class="cmt"><p>
The number of times we have recorded this peer going offline or coming
online, recorded across restarts. Note that this value is decreased over
time if the peer has not recently flapped, so that we can forgive peers
with historically high flap counts.</p></dd><dt class="param">lastFlapNs</dt><dd class="cmt"><p>
The timestamp of the last flap we observed for this peer. If this value is
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
zero, we have not observed any flaps for this peer.</p></dd><dt class="param">lastPingPayload</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The last ping payload the peer has sent to us.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PeerEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PeerEventextendsGeneratedMessagewithUpdatable[lnrpc.PeerEvent]withProductwithSerializable" class="anchorToMember"></a><a id="PeerEvent:PeerEvent" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PeerEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PeerEvent.html" title=""><span class="name">PeerEvent</span></a><span class="params">(<span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="type">type: <a href="PeerEvent$$EventType.html" name="lnrpc.PeerEvent.EventType" id="lnrpc.PeerEvent.EventType" class="extype">EventType</a> = <span class="defval"><span class="name"><a href="">lnrpc.PeerEvent.EventType.PEER_ONLINE</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PeerEvent.html" name="lnrpc.PeerEvent" id="lnrpc.PeerEvent" class="extype">PeerEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">pubKey</dt><dd class="cmt"><p>
The identity pubkey of the peer.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PeerEventSubscription" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PeerEventSubscriptionextendsGeneratedMessagewithUpdatable[lnrpc.PeerEventSubscription]withProductwithSerializable" class="anchorToMember"></a><a id="PeerEventSubscription:PeerEventSubscription" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PeerEventSubscription.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PeerEventSubscription.html" title=""><span class="name">PeerEventSubscription</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PeerEventSubscription.html" name="lnrpc.PeerEventSubscription" id="lnrpc.PeerEventSubscription" class="extype">PeerEventSubscription</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PendingChannelsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PendingChannelsRequestextendsGeneratedMessagewithUpdatable[lnrpc.PendingChannelsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="PendingChannelsRequest:PendingChannelsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PendingChannelsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PendingChannelsRequest.html" title=""><span class="name">PendingChannelsRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PendingChannelsRequest.html" name="lnrpc.PendingChannelsRequest" id="lnrpc.Pendi
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The balance in satoshis encumbered in pending channels</p></dd><dt class="param">pendingOpenChannels</dt><dd class="cmt"><p>
Channels pending opening</p></dd><dt class="param">pendingClosingChannels</dt><dd class="cmt"><p>
Deprecated: Channels pending closing previously contained cooperatively
closed channels with a single confirmation. These channels are now
considered closed from the time we see them on chain.</p></dd><dt class="param">pendingForceClosingChannels</dt><dd class="cmt"><p>
Channels pending force closing</p></dd><dt class="param">waitingCloseChannels</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Channels waiting for closing tx to confirm</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PendingHTLC" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PendingHTLCextendsGeneratedMessagewithUpdatable[lnrpc.PendingHTLC]withProductwithSerializable" class="anchorToMember"></a><a id="PendingHTLC:PendingHTLC" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PendingHTLC.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PendingHTLC.html" title=""><span class="name">PendingHTLC</span></a><span class="params">(<span name="incoming">incoming: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="amount">amount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="outpoint">outpoint: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="maturityHeight">maturityHeight: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.PendingHTLC._typemapper_maturityHeight.toCustom(0)</a></span></span></span>, <span name="blocksTilMaturity">blocksTilMaturity: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="stage">stage: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.PendingHTLC._typemapper_stage.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PendingHTLC.html" name="lnrpc.PendingHTLC" id="lnrpc.PendingHTLC" class="extype">PendingHTLC</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">incoming</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The direction within the channel that the htlc was sent</p></dd><dt class="param">amount</dt><dd class="cmt"><p>
The total value of the htlc</p></dd><dt class="param">outpoint</dt><dd class="cmt"><p>
The final output to be swept back to the user's wallet</p></dd><dt class="param">maturityHeight</dt><dd class="cmt"><p>
The next block height at which we can spend the current stage</p></dd><dt class="param">blocksTilMaturity</dt><dd class="cmt"><p>
The number of blocks remaining until the current stage can be swept.
Negative values indicate how many blocks have passed since becoming
mature.</p></dd><dt class="param">stage</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Indicates whether the htlc is in its first or second stage of recovery</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PendingUpdate" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PendingUpdateextendsGeneratedMessagewithUpdatable[lnrpc.PendingUpdate]withProductwithSerializable" class="anchorToMember"></a><a id="PendingUpdate:PendingUpdate" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PendingUpdate.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PendingUpdate.html" title=""><span class="name">PendingUpdate</span></a><span class="params">(<span name="txid">txid: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="outputIndex">outputIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.PendingUpdate._typemapper_outputIndex.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PendingUpdate.html" name="lnrpc.PendingUpdate" id="lnrpc.PendingUpdate" class="extype">PendingUpdate</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PolicyUpdateRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PolicyUpdateRequestextendsGeneratedMessagewithUpdatable[lnrpc.PolicyUpdateRequest]withProductwithSerializable" class="anchorToMember"></a><a id="PolicyUpdateRequest:PolicyUpdateRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PolicyUpdateRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PolicyUpdateRequest.html" title=""><span class="name">PolicyUpdateRequest</span></a><span class="params">(<span name="scope">scope: <a href="PolicyUpdateRequest$$Scope.html" name="lnrpc.PolicyUpdateRequest.Scope" id="lnrpc.PolicyUpdateRequest.Scope" class="extype">Scope</a> = <span class="defval"><span class="name"><a href="">lnrpc.PolicyUpdateRequest.Scope.Empty</a></span></span></span>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The base fee charged regardless of the number of milli-satoshis sent.</p></dd><dt class="param">feeRate</dt><dd class="cmt"><p>
The effective fee rate in milli-satoshis. The precision of this value
Deploy website Deploy website version based on 142612f0342f3bd1fc9021b72c384bae9b9475ba
2022-02-04 12:38:32 +00:00
goes up to 6 decimal places, so 1e-6.</p></dd><dt class="param">feeRatePpm</dt><dd class="cmt"><p>
The effective fee rate in micro-satoshis (parts per million).</p></dd><dt class="param">timeLockDelta</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The required timelock delta for HTLCs forwarded over the channel.</p></dd><dt class="param">maxHtlcMsat</dt><dd class="cmt"><p>
If set, the maximum HTLC size in milli-satoshis. If unset, the maximum
HTLC will be unchanged.</p></dd><dt class="param">minHtlcMsat</dt><dd class="cmt"><p>
The minimum HTLC size in milli-satoshis. Only applied if
min_htlc_msat_specified is true.</p></dd><dt class="param">minHtlcMsatSpecified</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
If true, min_htlc_msat is applied.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PolicyUpdateResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PolicyUpdateResponseextendsGeneratedMessagewithUpdatable[lnrpc.PolicyUpdateResponse]withProductwithSerializable" class="anchorToMember"></a><a id="PolicyUpdateResponse:PolicyUpdateResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PolicyUpdateResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PolicyUpdateResponse.html" title=""><span class="name">PolicyUpdateResponse</span></a><span class="params">(<span name="failedUpdates">failedUpdates: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="FailedUpdate.html" name="lnrpc.FailedUpdate" id="lnrpc.FailedUpdate" class="extype">FailedUpdate</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PolicyUpdateResponse.html" name="lnrpc.PolicyUpdateResponse" id="lnrpc.PolicyUpdateResponse" class="extype">PolicyUpdateResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">failedUpdates</dt><dd class="cmt"><p>
List of failed policy updates.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PreviousOutPoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PreviousOutPointextendsGeneratedMessagewithUpdatable[lnrpc.PreviousOutPoint]withProductwithSerializable" class="anchorToMember"></a><a id="PreviousOutPoint:PreviousOutPoint" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PreviousOutPoint.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PreviousOutPoint.html" title=""><span class="name">PreviousOutPoint</span></a><span class="params">(<span name="outpoint">outpoint: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="isOurOutput">isOurOutput: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PreviousOutPoint.html" name="lnrpc.PreviousOutPoint" id="lnrpc.PreviousOutPoint" class="extype">PreviousOutPoint</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">outpoint</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
The outpoint in format txid:n.</p></dd><dt class="param">isOurOutput</dt><dd class="cmt"><p>
Denotes if the outpoint is controlled by the internal wallet.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The flag will only detect p2wkh, np2wkh and p2tr inputs as its own.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.PsbtShim" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PsbtShimextendsGeneratedMessagewithUpdatable[lnrpc.PsbtShim]withProductwithSerializable" class="anchorToMember"></a><a id="PsbtShim:PsbtShim" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PsbtShim.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="PsbtShim.html" title=""><span class="name">PsbtShim</span></a><span class="params">(<span name="pendingChanId">pendingChanId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="basePsbt">basePsbt: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="noPublish">noPublish: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="PsbtShim.html" name="lnrpc.PsbtShim" id="lnrpc.PsbtShim" class="extype">PsbtShim</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">pendingChanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A unique identifier of 32 random bytes that will be used as the pending
channel ID to identify the PSBT state machine when interacting with it and
on the wire protocol to initiate the funding request.</p></dd><dt class="param">basePsbt</dt><dd class="cmt"><p>
An optional base PSBT the new channel output will be added to. If this is
non-empty, it must be a binary serialized PSBT.</p></dd><dt class="param">noPublish</dt><dd class="cmt"><p>
If a channel should be part of a batch (multiple channel openings in one
transaction), it can be dangerous if the whole batch transaction is
published too early before all channel opening negotiations are completed.
This flag prevents this particular channel from broadcasting the transaction
after the negotiation with the remote peer. In a batch of channel openings
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
this flag should be set to true for every channel but the very last.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.QueryRoutesRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueryRoutesRequestextendsGeneratedMessagewithUpdatable[lnrpc.QueryRoutesRequest]withProductwithSerializable" class="anchorToMember"></a><a id="QueryRoutesRequest:QueryRoutesRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/QueryRoutesRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="QueryRoutesRequest.html" title=""><span class="name">QueryRoutesRequest</span></a><span class="params">(<span name="pubKey">pubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="amt">amt: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="amtMsat">amtMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="finalCltvDelta">finalCltvDelta: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="feeLimit">feeLimit: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="FeeLimit.html" name="lnrpc.FeeLimit" id="lnrpc.FeeLimit" class="extype">FeeLimit</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="ignoredNodes">ignoredNodes: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="ignoredEdges">ignoredEdges: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="EdgeLocator.html" name="lnrpc.EdgeLocator" id="lnrpc.EdgeLocator" class="extype">EdgeLocator</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="sourcePubKey">sourcePubKey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="useMissionControl">useMissionControl: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="ignoredPairs">ignoredPairs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="NodePair.html" name="lnrpc.NodePair" id="lnrpc.NodePair" class="extype">NodePair</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="cltvLimit">cltvLimit: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.QueryRoutesRequest._typemapper_cltvLimit.toCustom(0)</a></span></span></span>, <span name="destCustomRecords">destCustomRecords: <a href="https://www.scala-la
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The 33-byte hex-encoded public key for the payment destination</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">finalCltvDelta</dt><dd class="cmt"><p>
An optional CLTV delta from the current height that should be used for the
timelock of the final hop. Note that unlike SendPayment, QueryRoutes does
not add any additional block padding on top of final_ctlv_delta. This
padding of a few blocks needs to be added manually or otherwise failures may
happen when a block comes in while the payment is in flight.</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
Deploy website Deploy website version based on 142612f0342f3bd1fc9021b72c384bae9b9475ba
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 (&lt;=1k sat) or 5% fees for larger amounts.</p></dd><dt class="param">ignoredNodes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of nodes to ignore during path finding. When using REST, these fields
must be encoded as base64.</p></dd><dt class="param">ignoredEdges</dt><dd class="cmt"><p>
Deprecated. A list of edges to ignore during path finding.</p></dd><dt class="param">sourcePubKey</dt><dd class="cmt"><p>
The source node where the request route should originated from. If empty,
self is assumed.</p></dd><dt class="param">useMissionControl</dt><dd class="cmt"><p>
If set to true, edge probabilities from mission control will be used to get
the optimal route.</p></dd><dt class="param">ignoredPairs</dt><dd class="cmt"><p>
A list of directed node pairs that will be ignored during path finding.</p></dd><dt class="param">cltvLimit</dt><dd class="cmt"><p>
An optional maximum total time lock for the route. If the source is empty or
ourselves, this should not exceed lnd's <code>--max-cltv-expiry</code> setting. If
zero, then the value of <code>--max-cltv-expiry</code> is used as the limit.</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. If the destination
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
does not support the specified records, an error will be returned.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Record types are required to be in the custom range &gt;= 65536. When using
REST, the values must be encoded as base64.</p></dd><dt class="param">outgoingChanId</dt><dd class="cmt"><p>
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">routeHints</dt><dd class="cmt"><p>
Optional route hints to reach the destination through private channels.</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
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
fallback.</p></dd><dt class="param">timePref</dt><dd class="cmt"><p>
The time preference for this payment. Set to -1 to optimize for fees
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
only, to 1 to optimize for reliability only or a value inbetween for a mix.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.QueryRoutesResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="QueryRoutesResponseextendsGeneratedMessagewithUpdatable[lnrpc.QueryRoutesResponse]withProductwithSerializable" class="anchorToMember"></a><a id="QueryRoutesResponse:QueryRoutesResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/QueryRoutesResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="QueryRoutesResponse.html" title=""><span class="name">QueryRoutesResponse</span></a><span class="params">(<span name="routes">routes: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Route.html" name="lnrpc.Route" id="lnrpc.Route" class="extype">Route</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="successProb">successProb: <a href="https://www.scala-lang.org/api/2.13.11/scala/Double.html#scala.Double" name="scala.Double" id="scala.Double" class="extype">Double</a> = <span class="symbol">0.0</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="QueryRoutesResponse.html" name="lnrpc.QueryRoutesResponse" id="lnrpc.QueryRoutesResponse" class="extype">QueryRoutesResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">routes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The route that results from the path finding operation. This is still a
repeated field to retain backwards compatibility.</p></dd><dt class="param">successProb</dt><dd class="cmt"><p>
The success probability of the returned route based on the current mission
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
control state. [EXPERIMENTAL]</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.RPCMessage" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RPCMessageextendsGeneratedMessagewithUpdatable[lnrpc.RPCMessage]withProductwithSerializable" class="anchorToMember"></a><a id="RPCMessage:RPCMessage" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/RPCMessage.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RPCMessage.html" title=""><span class="name">RPCMessage</span></a><span class="params">(<span name="methodFullUri">methodFullUri: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="streamRpc">streamRpc: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="typeName">typeName: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="serialized">serialized: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="isError">isError: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="RPCMessage.html" name="lnrpc.RPCMessage" id="lnrpc.RPCMessage" class="extype">RPCMessage</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">methodFullUri</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The full URI (in the format /&lt;rpcpackage&gt;.&lt;ServiceName&gt;/MethodName, for
example /lnrpc.Lightning/GetInfo) of the RPC method the message was sent
to/from.</p></dd><dt class="param">streamRpc</dt><dd class="cmt"><p>
Indicates whether the message was sent over a streaming RPC method or not.</p></dd><dt class="param">typeName</dt><dd class="cmt"><p>
The full canonical gRPC name of the message type (in the format
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
&lt;rpcpackage&gt;.TypeName, for example lnrpc.GetInfoRequest). In case of an
error being returned from lnd, this simply contains the string "error".</p></dd><dt class="param">serialized</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The full content of the gRPC message, serialized in the binary protobuf
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
format.</p></dd><dt class="param">isError</dt><dd class="cmt"><p>
Indicates that the response from lnd was an error, not a gRPC response. If
this is set to true then the type_name contains the string "error" and
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
serialized contains the error string.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.RPCMiddlewareRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RPCMiddlewareRequestextendsGeneratedMessagewithUpdatable[lnrpc.RPCMiddlewareRequest]withProductwithSerializable" class="anchorToMember"></a><a id="RPCMiddlewareRequest:RPCMiddlewareRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/RPCMiddlewareRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RPCMiddlewareRequest.html" title=""><span class="name">RPCMiddlewareRequest</span></a><span class="params">(<span name="requestId">requestId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.RPCMiddlewareRequest._typemapper_requestId.toCustom(0L)</a></span></span></span>, <span name="rawMacaroon">rawMacaroon: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="customCaveatCondition">customCaveatCondition: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="interceptType">interceptType: <a href="RPCMiddlewareRequest$$InterceptType.html" name="lnrpc.RPCMiddlewareRequest.InterceptType" id="lnrpc.RPCMiddlewareRequest.InterceptType" class="extype">InterceptType</a> = <span class="defval"><span class="name"><a href="">lnrpc.RPCMiddlewareRequest.InterceptType.Empty</a></span></span></span>, <span name="msgId">msgId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.RPCMiddlewareRequest._typemapper_msgId.toCustom(0L)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="RPCMiddlewareRequest.html" name="lnrpc.RPCMiddlewareRequest" id="lnrpc.RPCMiddlewareRequest" class="extype">RPCMiddlewareRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">requestId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The unique ID of the intercepted original gRPC request. Useful for mapping
request to response when implementing full duplex message interception. For
streaming requests, this will be the same ID for all incoming and outgoing
middleware intercept messages of the _same_ stream.</p></dd><dt class="param">rawMacaroon</dt><dd class="cmt"><p>
The raw bytes of the complete macaroon as sent by the gRPC client in the
original request. This might be empty for a request that doesn't require
macaroons such as the wallet unlocker RPCs.</p></dd><dt class="param">customCaveatCondition</dt><dd class="cmt"><p>
The parsed condition of the macaroon's custom caveat for convenient access.
This field only contains the value of the custom caveat that the handling
middleware has registered itself for. The condition _must_ be validated for
messages of intercept_type stream_auth and request!</p></dd><dt class="param">msgId</dt><dd class="cmt"><p>
The unique message ID of this middleware intercept message. There can be
multiple middleware intercept messages per single gRPC request (one for the
incoming request and one for the outgoing response) or gRPC stream (one for
each incoming message and one for each outgoing response). This message ID
must be referenced when responding (accepting/rejecting/modifying) to an
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
intercept message.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.RPCMiddlewareResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RPCMiddlewareResponseextendsGeneratedMessagewithUpdatable[lnrpc.RPCMiddlewareResponse]withProductwithSerializable" class="anchorToMember"></a><a id="RPCMiddlewareResponse:RPCMiddlewareResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/RPCMiddlewareResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RPCMiddlewareResponse.html" title=""><span class="name">RPCMiddlewareResponse</span></a><span class="params">(<span name="refMsgId">refMsgId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.RPCMiddlewareResponse._typemapper_refMsgId.toCustom(0L)</a></span></span></span>, <span name="middlewareMessage">middlewareMessage: <a href="RPCMiddlewareResponse$$MiddlewareMessage.html" name="lnrpc.RPCMiddlewareResponse.MiddlewareMessage" id="lnrpc.RPCMiddlewareResponse.MiddlewareMessage" class="extype">MiddlewareMessage</a> = <span class="defval"><span class="name"><a href="">lnrpc.RPCMiddlewareResponse.MiddlewareMessage.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="RPCMiddlewareResponse.html" name="lnrpc.RPCMiddlewareResponse" id="lnrpc.RPCMiddlewareResponse" class="extype">RPCMiddlewareResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">refMsgId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The request message ID this response refers to. Must always be set when
giving feedback to an intercept but is ignored for the initial registration
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
message.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ReadyForPsbtFunding" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ReadyForPsbtFundingextendsGeneratedMessagewithUpdatable[lnrpc.ReadyForPsbtFunding]withProductwithSerializable" class="anchorToMember"></a><a id="ReadyForPsbtFunding:ReadyForPsbtFunding" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ReadyForPsbtFunding.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ReadyForPsbtFunding.html" title=""><span class="name">ReadyForPsbtFunding</span></a><span class="params">(<span name="fundingAddress">fundingAddress: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="fundingAmount">fundingAmount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="psbt">psbt: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ReadyForPsbtFunding.html" name="lnrpc.ReadyForPsbtFunding" id="lnrpc.ReadyForPsbtFunding" class="extype">ReadyForPsbtFunding</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">fundingAddress</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The P2WSH address of the channel funding multisig address that the below
specified amount in satoshis needs to be sent to.</p></dd><dt class="param">fundingAmount</dt><dd class="cmt"><p>
The exact amount in satoshis that needs to be sent to the above address to
fund the pending channel.</p></dd><dt class="param">psbt</dt><dd class="cmt"><p>
A raw PSBT that contains the pending channel output. If a base PSBT was
provided in the PsbtShim, this is the base PSBT with one additional output.
If no base PSBT was specified, this is an otherwise empty PSBT with exactly
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
one output.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Resolution" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ResolutionextendsGeneratedMessagewithUpdatable[lnrpc.Resolution]withProductwithSerializable" class="anchorToMember"></a><a id="Resolution:Resolution" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Resolution.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Resolution.html" title=""><span class="name">Resolution</span></a><span class="params">(<span name="resolutionType">resolutionType: <a href="ResolutionType.html" name="lnrpc.ResolutionType" id="lnrpc.ResolutionType" class="extype">ResolutionType</a> = <span class="symbol"><span class="name"><a href="">lnrpc.ResolutionType.TYPE_UNKNOWN</a></span></span></span>, <span name="outcome">outcome: <a href="ResolutionOutcome.html" name="lnrpc.ResolutionOutcome" id="lnrpc.ResolutionOutcome" class="extype">ResolutionOutcome</a> = <span class="defval"><span class="name"><a href="">lnrpc.ResolutionOutcome.OUTCOME_UNKNOWN</a></span></span></span>, <span name="outpoint">outpoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="OutPoint.html" name="lnrpc.OutPoint" id="lnrpc.OutPoint" class="extype">OutPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="amountSat">amountSat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.Resolution._typemapper_amountSat.toCustom(0L)</a></span></span></span>, <span name="sweepTxid">sweepTxid: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="Resolution.html" name="lnrpc.Resolution" id="lnrpc.Resolution" class="extype">Resolution</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">resolutionType</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The type of output we are resolving.</p></dd><dt class="param">outcome</dt><dd class="cmt"><p>
The outcome of our on chain action that resolved the outpoint.</p></dd><dt class="param">outpoint</dt><dd class="cmt"><p>
The outpoint that was spent by the resolution.</p></dd><dt class="param">amountSat</dt><dd class="cmt"><p>
The amount that was claimed by the resolution.</p></dd><dt class="param">sweepTxid</dt><dd class="cmt"><p>
The hex-encoded transaction ID of the sweep transaction that spent the
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
output.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.ResolutionOutcome" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ResolutionOutcomeextendsGeneratedEnum" class="anchorToMember"></a><a id="ResolutionOutcome:ResolutionOutcome" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ResolutionOutcome.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="ResolutionOutcome.html" title=""><span class="name">ResolutionOutcome</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.ResolutionType" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="ResolutionTypeextendsGeneratedEnum" class="anchorToMember"></a><a id="ResolutionType:ResolutionType" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/ResolutionType.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="ResolutionType.html" title=""><span class="name">ResolutionType</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.RestoreBackupResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RestoreBackupResponseextendsGeneratedMessagewithUpdatable[lnrpc.RestoreBackupResponse]withProductwithSerializable" class="anchorToMember"></a><a id="RestoreBackupResponse:RestoreBackupResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/RestoreBackupResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RestoreBackupResponse.html" title=""><span class="name">RestoreBackupResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="RestoreBackupResponse.html" name="lnrpc.RestoreBackupResponse" id="lnrpc.RestoreBackupResponse" class="extype">RestoreBackupResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><sp
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
succession.</p><div class="fullcomment"><div class="comment cmt"><p>A path through the channel graph which runs over one or more channels in
succession. This struct carries all the information required to craft the
Sphinx onion packet, and send the payment along the first hop in the path. A
route is only selected as valid if all the channels have sufficient capacity to
carry the initial payment amount after fees are accounted for.
</p></div><dl class="paramcmts block"><dt class="param">totalTimeLock</dt><dd class="cmt"><p>
The cumulative (final) time lock across the entire route. This is the CLTV
value that should be extended to the first hop in the route. All other hops
will decrement the time-lock as advertised, leaving enough time for all
hops to wait for or present the payment preimage to complete the payment.</p></dd><dt class="param">totalFees</dt><dd class="cmt"><p>
The sum of the fees paid at each hop within the final route. In the case
of a one-hop payment, this value will be zero as we don't need to pay a fee
to ourselves.</p></dd><dt class="param">totalAmt</dt><dd class="cmt"><p>
The total amount of funds required to complete a payment over this route.
This value includes the cumulative fees at each hop. As a result, the HTLC
extended to the first-hop in the route will need to have at least this many
satoshis, otherwise the route will fail at an intermediate node due to an
insufficient amount of fees.</p></dd><dt class="param">hops</dt><dd class="cmt"><p>
Contains details concerning the specific forwarding details at each hop.</p></dd><dt class="param">totalFeesMsat</dt><dd class="cmt"><p>
The total fees in millisatoshis.</p></dd><dt class="param">totalAmtMsat</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The total amount in millisatoshis.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.RouteHint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RouteHintextendsGeneratedMessagewithUpdatable[lnrpc.RouteHint]withProductwithSerializable" class="anchorToMember"></a><a id="RouteHint:RouteHint" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/RouteHint.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RouteHint.html" title=""><span class="name">RouteHint</span></a><span class="params">(<span name="hopHints">hopHints: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="HopHint.html" name="lnrpc.HopHint" id="lnrpc.HopHint" class="extype">HopHint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="RouteHint.html" name="lnrpc.RouteHint" id="lnrpc.RouteHint" class="extype">RouteHint</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">hopHints</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of hop hints that when chained together can assist in reaching a
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
specific destination.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.RoutingPolicy" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RoutingPolicyextendsGeneratedMessagewithUpdatable[lnrpc.RoutingPolicy]withProductwithSerializable" class="anchorToMember"></a><a id="RoutingPolicy:RoutingPolicy" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/RoutingPolicy.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="RoutingPolicy.html" title=""><span class="name">RoutingPolicy</span></a><span class="params">(<span name="timeLockDelta">timeLockDelta: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.RoutingPolicy._typemapper_timeLockDelta.toCustom(0)</a></span></span></span>, <span name="minHtlc">minHtlc: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="feeBaseMsat">feeBaseMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="feeRateMilliMsat">feeRateMilliMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="disabled">disabled: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="maxHtlcMsat">maxHtlcMsat: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.RoutingPolicy._typemapper_maxHtlcMsat.toCustom(0L)</a></span></span></span>, <span name="lastUpdate">lastUpdate: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.RoutingPolicy._typemapper_lastUpdate.toCustom(0)</a></span></span></span>, <span name="customRecords">customRecords: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</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://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype
Custom channel update tlv records.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendCoinsRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendCoinsRequestextendsGeneratedMessagewithUpdatable[lnrpc.SendCoinsRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendCoinsRequest:SendCoinsRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendCoinsRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendCoinsRequest.html" title=""><span class="name">SendCoinsRequest</span></a><span class="params">(<span name="addr">addr: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="amount">amount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="targetConf">targetConf: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="satPerVbyte">satPerVbyte: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.SendCoinsRequest._typemapper_satPerVbyte.toCustom(0L)</a></span></span></span>, <span name="satPerByte">satPerByte: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="sendAll">sendAll: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="label">label: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="minConfs">minConfs: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="spendUnconfirmed">spendUnconfirmed: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendCoinsRequest.html" name="lnrpc.SendCoinsRequest" id="lnrpc.SendCoinsRequest" class="extype">SendCoinsRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div clas
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The address to send coins to</p></dd><dt class="param">amount</dt><dd class="cmt"><p>
The amount in satoshis to send</p></dd><dt class="param">targetConf</dt><dd class="cmt"><p>
The target number of blocks that this transaction should be confirmed
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
by.</p></dd><dt class="param">satPerVbyte</dt><dd class="cmt"><p>
A manual fee rate set in sat/vbyte that should be used when crafting the
transaction.</p></dd><dt class="param">satPerByte</dt><dd class="cmt"><p>
Deprecated, use sat_per_vbyte.
A manual fee rate set in sat/vbyte that should be used when crafting the
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
transaction.</p></dd><dt class="param">sendAll</dt><dd class="cmt"><p>
If set, then the amount field will be ignored, and lnd will attempt to
send all the coins under control of the internal wallet to the specified
address.</p></dd><dt class="param">label</dt><dd class="cmt"><p>
An optional label for the transaction, limited to 500 characters.</p></dd><dt class="param">minConfs</dt><dd class="cmt"><p>
The minimum number of confirmations each one of your outputs used for
the transaction must satisfy.</p></dd><dt class="param">spendUnconfirmed</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Whether unconfirmed outputs should be used as inputs for the transaction.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendCoinsResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendCoinsResponseextendsGeneratedMessagewithUpdatable[lnrpc.SendCoinsResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SendCoinsResponse:SendCoinsResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendCoinsResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendCoinsResponse.html" title=""><span class="name">SendCoinsResponse</span></a><span class="params">(<span name="txid">txid: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendCoinsResponse.html" name="lnrpc.SendCoinsResponse" id="lnrpc.SendCoinsResponse" class="extype">SendCoinsResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">txid</dt><dd class="cmt"><p>
The transaction ID of the transaction</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendCustomMessageRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendCustomMessageRequestextendsGeneratedMessagewithUpdatable[lnrpc.SendCustomMessageRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendCustomMessageRequest:SendCustomMessageRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendCustomMessageRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendCustomMessageRequest.html" title=""><span class="name">SendCustomMessageRequest</span></a><span class="params">(<span name="peer">peer: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="type">type: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.SendCustomMessageRequest._typemapper_type.toCustom(0)</a></span></span></span>, <span name="data">data: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendCustomMessageRequest.html" name="lnrpc.SendCustomMessageRequest" id="lnrpc.SendCustomMessageRequest" class="extype">SendCustomMessageRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">peer</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
Peer to send the message to</p></dd><dt class="param">type</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
Message type. This value needs to be in the custom range (&gt;= 32768).
To send a type &lt; custom range, lnd needs to be compiled with the <code>dev</code>
build tag, and the message type to override should be specified in lnd's
experimental protocol configuration.</p></dd><dt class="param">data</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Raw message data.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendCustomMessageResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendCustomMessageResponseextendsGeneratedMessagewithUpdatable[lnrpc.SendCustomMessageResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SendCustomMessageResponse:SendCustomMessageResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendCustomMessageResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendCustomMessageResponse.html" title=""><span class="name">SendCustomMessageResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendCustomMessageResponse.html" name="lnrpc.SendCustomMessageResponse" id="lnrpc.SendCustomMessageResponse" class="extype">SendCustomMessageResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendManyRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendManyRequestextendsGeneratedMessagewithUpdatable[lnrpc.SendManyRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendManyRequest:SendManyRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendManyRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendManyRequest.html" title=""><span class="name">SendManyRequest</span></a><span class="params">(<span name="addrToAmount">addrToAmount: <a href="https://www.scala-lang.org/api/2.13.11/scala/collection/immutable/Map.html#scala.collection.immutable.Map" name="scala.collection.immutable.Map" id="scala.collection.immutable.Map" class="extype">Map</a>[<span name="scala.Predef.String" class="extype">String</span>, <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a>] = <span class="defval"><span class="name"><a href="../scala/index.html">_root_.scala.collection.immutable.Map.empty</a></span></span></span>, <span name="targetConf">targetConf: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="satPerVbyte">satPerVbyte: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The map from addresses to amounts</p></dd><dt class="param">targetConf</dt><dd class="cmt"><p>
The target number of blocks that this transaction should be confirmed
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
by.</p></dd><dt class="param">satPerVbyte</dt><dd class="cmt"><p>
A manual fee rate set in sat/vbyte that should be used when crafting the
transaction.</p></dd><dt class="param">satPerByte</dt><dd class="cmt"><p>
Deprecated, use sat_per_vbyte.
A manual fee rate set in sat/vbyte that should be used when crafting the
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
transaction.</p></dd><dt class="param">label</dt><dd class="cmt"><p>
An optional label for the transaction, limited to 500 characters.</p></dd><dt class="param">minConfs</dt><dd class="cmt"><p>
The minimum number of confirmations each one of your outputs used for
the transaction must satisfy.</p></dd><dt class="param">spendUnconfirmed</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Whether unconfirmed outputs should be used as inputs for the transaction.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendManyResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendManyResponseextendsGeneratedMessagewithUpdatable[lnrpc.SendManyResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SendManyResponse:SendManyResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendManyResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendManyResponse.html" title=""><span class="name">SendManyResponse</span></a><span class="params">(<span name="txid">txid: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendManyResponse.html" name="lnrpc.SendManyResponse" id="lnrpc.SendManyResponse" class="extype">SendManyResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">txid</dt><dd class="cmt"><p>
The id of the transaction</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendRequestextendsGeneratedMessagewithUpdatable[lnrpc.SendRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendRequest:SendRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendRequest.html" title=""><span class="name">SendRequest</span></a><span class="params">(<span name="dest">dest: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="destString">destString: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="amt">amt: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="amtMsat">amtMsat: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="paymentHash">paymentHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="paymentHashString">paymentHashString: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="paymentRequest">paymentRequest: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="finalCltvDelta">finalCltvDelta: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="feeLimit">feeLimit: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="FeeLimit.html" name="lnrpc.FeeLimit" id="lnrpc.FeeLimit" class="extype">FeeLimit</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="outgoingChanId">outgoingChanId: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.SendRequest._typemapper_outgoingChanId.toCustom(0L)</a></span></span></span>, <span name="lastHopPubkey">lastHopPubkey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="cltvLimit">cltvLimit: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span c
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
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
Deploy website Deploy website version based on 142612f0342f3bd1fc9021b72c384bae9b9475ba
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 (&lt;=1k sat) or 5% fees for larger amounts.</p></dd><dt class="param">outgoingChanId</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
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 &gt;= 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>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +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></li><li class="indented0 " name="lnrpc.SendResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendResponseextendsGeneratedMessagewithUpdatable[lnrpc.SendResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SendResponse:SendResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SendResponse.html" title=""><span class="name">SendResponse</span></a><span class="params">(<span name="paymentError">paymentError: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="paymentPreimage">paymentPreimage: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="paymentRoute">paymentRoute: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="Route.html" name="lnrpc.Route" id="lnrpc.Route" class="extype">Route</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="paymentHash">paymentHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SendResponse.html" name="lnrpc.SendResponse" id="lnrpc.SendResponse" class="extype">SendResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SendToRouteRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SendToRouteRequestextendsGeneratedMessagewithUpdatable[lnrpc.SendToRouteRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SendToRouteRequest:SendToRouteRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SendToRouteReq
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The payment hash to use for the HTLC. When using REST, this field must be
encoded as base64.</p></dd><dt class="param">paymentHashString</dt><dd class="cmt"><p>
An optional hex-encoded payment hash to be used for the HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.</p></dd><dt class="param">route</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
Route that should be used to attempt to complete the payment.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SetID" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SetIDextendsGeneratedMessagewithUpdatable[lnrpc.SetID]withProductwithSerializable" class="anchorToMember"></a><a id="SetID:SetID" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SetID.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SetID.html" title=""><span class="name">SetID</span></a><span class="params">(<span name="setId">setId: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SetID.html" name="lnrpc.SetID" id="lnrpc.SetID" class="extype">SetID</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SignMessageRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignMessageRequestextendsGeneratedMessagewithUpdatable[lnrpc.SignMessageRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SignMessageRequest:SignMessageRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SignMessageRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SignMessageRequest.html" title=""><span class="name">SignMessageRequest</span></a><span class="params">(<span name="msg">msg: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="singleHash">singleHash: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thes
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The message to be signed. When using REST, this field must be encoded as
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
base64.</p></dd><dt class="param">singleHash</dt><dd class="cmt"><p>
Instead of the default double-SHA256 hashing of the message before signing,
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
only use one round of hashing instead.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SignMessageResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignMessageResponseextendsGeneratedMessagewithUpdatable[lnrpc.SignMessageResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SignMessageResponse:SignMessageResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SignMessageResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SignMessageResponse.html" title=""><span class="name">SignMessageResponse</span></a><span class="params">(<span name="signature">signature: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SignMessageResponse.html" name="lnrpc.SignMessageResponse" id="lnrpc.SignMessageResponse" class="extype">SignMessageResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">signature</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 011fdc2cdb36aae5b370cfd2abdc08ca2ca00041
2022-01-21 00:10:54 +00:00
The signature for the given message</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.State" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="StateextendsAnyRef" class="anchorToMember"></a><a id="State:State" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/State.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="State.html" title="State service is a always running service that exposes the current state of the wallet and RPC server."><span class="name">State</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><p class="shortcomment cmt">State service is a always running service that exposes the current state of
the wallet and RPC server.</p><div class="fullcomment"><div class="comment cmt"><p>State service is a always running service that exposes the current state of
the wallet and RPC server.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.StateClient" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="StateClientextendsStatewithStateClientPowerApiwithAkkaGrpcClient" class="anchorToMember"></a><a id="StateClient:StateClient" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/StateClient.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="StateClient.html" title=""><span class="name">StateClient</span></a><span class="result"> extends <a href="State.html" name="lnrpc.State" id="lnrpc.State" class="extype">State</a> with <a href="StateClientPowerApi.html" name="lnrpc.StateClientPowerApi" id="lnrpc.StateClientPowerApi" class="extype">StateClientPowerApi</a> with <a href="https://doc.akka.io/api/akka-grpc/2.1.6/akka/grpc/akka/grpc/scaladsl/AkkaGrpcClient.html#akka.grpc.scaladsl.AkkaGrpcClient" name="akka.grpc.scaladsl.AkkaGrpcClient" id="akka.grpc.scaladsl.AkkaGrpcClient" class="extype">AkkaGrpcClient</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.StateClientPowerApi" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="StateClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="StateClientPowerApi:StateClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/StateClientPowerApi.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="StateClientPowerApi.html" title=""><span class="name">StateClientPowerApi</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.StopRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="StopRequestextendsGeneratedMessagewithUpdatable[lnrpc.StopRequest]withProductwithSerializable" class="anchorToMember"></a><a id="StopRequest:StopRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/StopRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="StopRequest.html" title=""><span class="name">StopRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="StopRequest.html" name="lnrpc.StopRequest" id="lnrpc.StopRequest" class="extype">StopRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The full URI (in the format /&lt;rpcpackage&gt;.&lt;ServiceName&gt;/MethodName, for
example /lnrpc.Lightning/GetInfo) of the streaming RPC method that was just
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
established.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SubscribeCustomMessagesRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SubscribeCustomMessagesRequestextendsGeneratedMessagewithUpdatable[lnrpc.SubscribeCustomMessagesRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SubscribeCustomMessagesRequest:SubscribeCustomMessagesRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SubscribeCustomMessagesRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SubscribeCustomMessagesRequest.html" title=""><span class="name">SubscribeCustomMessagesRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SubscribeCustomMessagesRequest.html" name="lnrpc.SubscribeCustomMessagesRequest" id="lnrpc.SubscribeCustomMessagesRequest" class="extype">SubscribeCustomMessagesRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.SubscribeStateRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SubscribeStateRequestextendsGeneratedMessagewithUpdatable[lnrpc.SubscribeStateRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SubscribeStateRequest:SubscribeStateRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/SubscribeStateRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SubscribeStateRequest.html" title=""><span class="name">SubscribeStateRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="S
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The unix timestamp in seconds when the error occurred.</p></dd><dt class="param">error</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The string representation of the error sent by our peer.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.Transaction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TransactionextendsGeneratedMessagewithUpdatable[lnrpc.Transaction]withProductwithSerializable" class="anchorToMember"></a><a id="Transaction:Transaction" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Transaction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Transaction.html" title=""><span class="name">Transaction</span></a><span class="params">(<span name="txHash">txHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="amount">amount: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="numConfirmations">numConfirmations: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="blockHash">blockHash: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="blockHeight">blockHeight: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="timeStamp">timeStamp: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="totalFees">totalFees: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="destAddresses">destAddresses: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<span name="scala.Predef.String" class="extype">String</span>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="outputDetails">outputDetails: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="OutputDetail.html" name="lnrpc.OutputDetail" id="lnrpc.OutputDetail" class="extype">OutputDetail</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="rawTxHex">rawTxHex: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="label">label: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="previousOutpoints">previousOutpoints: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="PreviousOutPoint.html" name="lnrpc.PreviousOutPoint" id="lnrpc.PreviousOutPoint" class="extype">PreviousOutPoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.Generate
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The transaction hash</p></dd><dt class="param">amount</dt><dd class="cmt"><p>
The transaction amount, denominated in satoshis</p></dd><dt class="param">numConfirmations</dt><dd class="cmt"><p>
The number of confirmations</p></dd><dt class="param">blockHash</dt><dd class="cmt"><p>
The hash of the block this transaction was included in</p></dd><dt class="param">blockHeight</dt><dd class="cmt"><p>
The height of the block this transaction was included in</p></dd><dt class="param">timeStamp</dt><dd class="cmt"><p>
Timestamp of this transaction</p></dd><dt class="param">totalFees</dt><dd class="cmt"><p>
Fees paid for this transaction</p></dd><dt class="param">destAddresses</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 42564bc810874b7f7d77478462b2cc509ba3f079
2022-06-28 15:54:09 +00:00
Addresses that received funds for this transaction. Deprecated as it is
now incorporated in the output_details field.</p></dd><dt class="param">outputDetails</dt><dd class="cmt"><p>
Outputs that received funds for this transaction</p></dd><dt class="param">rawTxHex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The raw transaction hex.</p></dd><dt class="param">label</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
A label that was optionally set on transaction broadcast.</p></dd><dt class="param">previousOutpoints</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
PreviousOutpoints/Inputs of this transaction.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.TransactionDetails" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TransactionDetailsextendsGeneratedMessagewithUpdatable[lnrpc.TransactionDetails]withProductwithSerializable" class="anchorToMember"></a><a id="TransactionDetails:TransactionDetails" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/TransactionDetails.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="TransactionDetails.html" title=""><span class="name">TransactionDetails</span></a><span class="params">(<span name="transactions">transactions: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="Transaction.html" name="lnrpc.Transaction" id="lnrpc.Transaction" class="extype">Transaction</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="TransactionDetails.html" name="lnrpc.TransactionDetails" id="lnrpc.TransactionDetails" class="extype">TransactionDetails</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">transactions</dt><dd class="cmt"><p>
The list of transactions relevant to the wallet.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.UnlockWalletRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UnlockWalletRequestextendsGeneratedMessagewithUpdatable[lnrpc.UnlockWalletRequest]withProductwithSerializable" class="anchorToMember"></a><a id="UnlockWalletRequest:UnlockWalletRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/UnlockWalletRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="UnlockWalletRequest.html" title=""><span class="name">UnlockWalletRequest</span></a><span class="params">(<span name="walletPassword">walletPassword: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="recoveryWindow">recoveryWindow: <a href="https://www.scala-lang.org/api/2.13.11/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="channelBackups">channelBackups: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="ChanBackupSnapshot.html" name="lnrpc.ChanBackupSnapshot" id="lnrpc.ChanBackupSnapshot" class="extype">ChanBackupSnapshot</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="statelessInit">statelessInit: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="UnlockWalletRequest.html" name="lnrpc.UnlockWalletRequest" id="lnrpc.UnlockWalletRequest" class="extype">UnlockWalletRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">walletPassword</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
wallet_password should be the current valid passphrase for the daemon. This
will be required to decrypt on-disk material that the daemon requires to
function properly. When using REST, this field must be encoded as base64.</p></dd><dt class="param">recoveryWindow</dt><dd class="cmt"><p>
recovery_window is an optional argument specifying the address lookahead
when restoring a wallet seed. The recovery window applies to each
individual branch of the BIP44 derivation paths. Supplying a recovery
window of zero indicates that no addresses should be recovered, such after
the first initialization of the wallet.</p></dd><dt class="param">channelBackups</dt><dd class="cmt"><p>
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels. This should be populated if the
user was unable to close out all channels and sweep funds before partial or
total data loss occurred. If specified, then after on-chain recovery of
funds, lnd begin to carry out the data loss recovery protocol in order to
recover the funds in each channel from a remote force closed transaction.</p></dd><dt class="param">statelessInit</dt><dd class="cmt"><p>
stateless_init is an optional argument instructing the daemon NOT to create
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
any *.macaroon files in its file system.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.UnlockWalletResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UnlockWalletResponseextendsGeneratedMessagewithUpdatable[lnrpc.UnlockWalletResponse]withProductwithSerializable" class="anchorToMember"></a><a id="UnlockWalletResponse:UnlockWalletResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/UnlockWalletResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="UnlockWalletResponse.html" title=""><span class="name">UnlockWalletResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="UnlockWalletResponse.html" name="lnrpc.UnlockWalletResponse" id="lnrpc.UnlockWalletResponse" class="extype">UnlockWalletResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.UpdateFailure" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="UpdateFailureextendsGeneratedEnum" class="anchorToMember"></a><a id="UpdateFailure:UpdateFailure" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/UpdateFailure.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="UpdateFailure.html" title=""><span class="name">UpdateFailure</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.Utxo" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UtxoextendsGeneratedMessagewithUpdatable[lnrpc.Utxo]withProductwithSerializable" class="anchorToMember"></a><a id="Utxo:Utxo" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Utxo.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Utxo.html" title=""><span class="name">Utxo</span></a><span class="params">(<span name="addressType">addressType: <a href="AddressType.html" name="lnrpc.AddressType" id="lnrpc.AddressType" class="extype">AddressType</a> = <span class="defval"><span class="name"><a href="">lnrpc.AddressType.WITNESS_PUBK
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The type of address</p></dd><dt class="param">address</dt><dd class="cmt"><p>
The address</p></dd><dt class="param">amountSat</dt><dd class="cmt"><p>
The value of the unspent coin in satoshis</p></dd><dt class="param">pkScript</dt><dd class="cmt"><p>
The pkscript in hex</p></dd><dt class="param">outpoint</dt><dd class="cmt"><p>
The outpoint in format txid:n</p></dd><dt class="param">confirmations</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The number of confirmations for the Utxo</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.VerifyChanBackupResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VerifyChanBackupResponseextendsGeneratedMessagewithUpdatable[lnrpc.VerifyChanBackupResponse]withProductwithSerializable" class="anchorToMember"></a><a id="VerifyChanBackupResponse:VerifyChanBackupResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/VerifyChanBackupResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="VerifyChanBackupResponse.html" title=""><span class="name">VerifyChanBackupResponse</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="VerifyChanBackupResponse.html" name="lnrpc.VerifyChanBackupResponse" id="lnrpc.VerifyChanBackupResponse" class="extype">VerifyChanBackupResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.VerifyMessageRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VerifyMessageRequestextendsGeneratedMessagewithUpdatable[lnrpc.VerifyMessageRequest]withProductwithSerializable" class="anchorToMember"></a><a id="VerifyMessageRequest:VerifyMessageRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/VerifyMessageRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="VerifyMessageRequest.html" title=""><span class="name">VerifyMessageRequest</span></a><span class="params">(<span name="msg">msg: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="signature">signature: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span cla
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The message over which the signature is to be verified. When using REST,
this field must be encoded as base64.</p></dd><dt class="param">signature</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The signature to be verified over the given message</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.VerifyMessageResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VerifyMessageResponseextendsGeneratedMessagewithUpdatable[lnrpc.VerifyMessageResponse]withProductwithSerializable" class="anchorToMember"></a><a id="VerifyMessageResponse:VerifyMessageResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/VerifyMessageResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="VerifyMessageResponse.html" title=""><span class="name">VerifyMessageResponse</span></a><span class="params">(<span name="valid">valid: <a href="https://www.scala-lang.org/api/2.13.11/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="pubkey">pubkey: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="VerifyMessageResponse.html" name="lnrpc.VerifyMessageResponse" id="lnrpc.VerifyMessageResponse" class="extype">VerifyMessageResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">valid</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Whether the signature was valid over the given message</p></dd><dt class="param">pubkey</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The pubkey recovered from the signature</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WalletAccountBalance" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WalletAccountBalanceextendsGeneratedMessagewithUpdatable[lnrpc.WalletAccountBalance]withProductwithSerializable" class="anchorToMember"></a><a id="WalletAccountBalance:WalletAccountBalance" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletAccountBalance.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="WalletAccountBalance.html" title=""><span class="name">WalletAccountBalance</span></a><span class="params">(<span name="confirmedBalance">confirmedBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unconfirmedBalance">unconfirmedBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="WalletAccountBalance.html" name="lnrpc.WalletAccountBalance" id="lnrpc.WalletAccountBalance" class="extype">WalletAccountBalance</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">confirmedBalance</dt><dd class="cmt"><p>
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
The confirmed balance of the account (with &gt;= 1 confirmations).</p></dd><dt class="param">unconfirmedBalance</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The unconfirmed balance of the account (with 0 confirmations).</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WalletBalanceRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WalletBalanceRequestextendsGeneratedMessagewithUpdatable[lnrpc.WalletBalanceRequest]withProductwithSerializable" class="anchorToMember"></a><a id="WalletBalanceRequest:WalletBalanceRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletBalanceRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="WalletBalanceRequest.html" title=""><span class="name">WalletBalanceRequest</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="WalletBalanceRequest.html" name="lnrpc.WalletBalanceRequest" id="lnrpc.WalletBalanceRequest" class="extype">WalletBalanceRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WalletBalanceResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WalletBalanceResponseextendsGeneratedMessagewithUpdatable[lnrpc.WalletBalanceResponse]withProductwithSerializable" class="anchorToMember"></a><a id="WalletBalanceResponse:WalletBalanceResponse" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletBalanceResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="WalletBalanceResponse.html" title=""><span class="name">WalletBalanceResponse</span></a><span class="params">(<span name="totalBalance">totalBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="confirmedBalance">confirmedBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="unconfirmedBalance">unconfirmedBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="lockedBalance">lockedBalance: <a href="https://www.scala-lang.org/api/2.13.11/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="reservedBalanceAnchorChan">reserv
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The balance of the wallet</p></dd><dt class="param">confirmedBalance</dt><dd class="cmt"><p>
The confirmed balance of a wallet(with &gt;= 1 confirmations)</p></dd><dt class="param">unconfirmedBalance</dt><dd class="cmt"><p>
Deploy website Deploy website version based on e9582d2145d013d5da4b3cd0869b795f37809265
2022-05-19 23:53:50 +00:00
The unconfirmed balance of a wallet(with 0 confirmations)</p></dd><dt class="param">lockedBalance</dt><dd class="cmt"><p>
The total amount of wallet UTXOs held in outputs that are locked for
Deploy website Deploy website version based on 2a30232181538e19fe10927b2345534617def9d4
2022-10-18 15:12:45 +00:00
other usage.</p></dd><dt class="param">reservedBalanceAnchorChan</dt><dd class="cmt"><p>
The amount of reserve required.</p></dd><dt class="param">accountBalance</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
A mapping of each wallet account's name to its balance.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WalletState" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="WalletStateextendsGeneratedEnum" class="anchorToMember"></a><a id="WalletState:WalletState" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletState.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="WalletState.html" title=""><span class="name">WalletState</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span></li><li class="indented0 " name="lnrpc.WalletUnlocker" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="WalletUnlockerextendsAnyRef" class="anchorToMember"></a><a id="WalletUnlocker:WalletUnlocker" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="WalletUnlocker.html" title="WalletUnlocker is a service that is used to set up a wallet password for lnd at first startup, and unlock a previously set up wallet."><span class="name">WalletUnlocker</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><p class="shortcomment cmt">WalletUnlocker is a service that is used to set up a wallet password for
Deploy website Deploy website version based on 011fdc2cdb36aae5b370cfd2abdc08ca2ca00041
2022-01-21 00:10:54 +00:00
lnd at first startup, and unlock a previously set up wallet.</p><div class="fullcomment"><div class="comment cmt"><p>WalletUnlocker is a service that is used to set up a wallet password for
lnd at first startup, and unlock a previously set up wallet.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WalletUnlockerClient" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="WalletUnlockerClientextendsWalletUnlockerwithWalletUnlockerClientPowerApiwithAkkaGrpcClient" class="anchorToMember"></a><a id="WalletUnlockerClient:WalletUnlockerClient" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlockerClient.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="WalletUnlockerClient.html" title=""><span class="name">WalletUnlockerClient</span></a><span class="result"> extends <a href="WalletUnlocker.html" name="lnrpc.WalletUnlocker" id="lnrpc.WalletUnlocker" class="extype">WalletUnlocker</a> with <a href="WalletUnlockerClientPowerApi.html" name="lnrpc.WalletUnlockerClientPowerApi" id="lnrpc.WalletUnlockerClientPowerApi" class="extype">WalletUnlockerClientPowerApi</a> with <a href="https://doc.akka.io/api/akka-grpc/2.1.6/akka/grpc/akka/grpc/scaladsl/AkkaGrpcClient.html#akka.grpc.scaladsl.AkkaGrpcClient" name="akka.grpc.scaladsl.AkkaGrpcClient" id="akka.grpc.scaladsl.AkkaGrpcClient" class="extype">AkkaGrpcClient</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WalletUnlockerClientPowerApi" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="WalletUnlockerClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="WalletUnlockerClientPowerApi:WalletUnlockerClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlockerClientPowerApi.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="WalletUnlockerClientPowerApi.html" title=""><span class="name">WalletUnlockerClientPowerApi</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WatchOnly" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WatchOnlyextendsGeneratedMessagewithUpdatable[lnrpc.WatchOnly]withProductwithSerializable" class="anchorToMember"></a><a id="WatchOnly:WatchOnly" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WatchOnly.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="WatchOnly.html" title=""><span class="name">WatchOnly</span></a><span class="params">(<span name="masterKeyBirthdayTimestamp">masterKeyBirthdayTimestamp: <a href="../org/bitcoins/core/number/UInt64.html" name="org.bitcoins.core.number.UInt64" id="org.bitcoins.core.number.UInt64" class="extype">UInt64</a> = <span class="defval"><span class="name"><a href="">lnrpc.WatchOnly._typemapper_masterKeyBirthdayTimestamp.toCustom(0L)</a></span></span></span>, <span name="masterKeyFingerprint">masterKeyFingerprint: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="accounts">accounts: <a href="../scala/index.
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
The unix timestamp in seconds of when the master key was created. lnd will
only start scanning for funds in blocks that are after the birthday which
can speed up the process significantly. If the birthday is not known, this
should be left at its default value of 0 in which case lnd will start
scanning from the first SegWit block (481824 on mainnet).</p></dd><dt class="param">masterKeyFingerprint</dt><dd class="cmt"><p>
The fingerprint of the root key (also known as the key with derivation path
m/) from which the account public keys were derived from. This may be
required by some hardware wallets for proper identification and signing. The
bytes must be in big-endian order.</p></dd><dt class="param">accounts</dt><dd class="cmt"><p>
The list of accounts to import. There _must_ be an account for all of lnd's
main key scopes: BIP49/BIP84 (m/49'/0'/0', m/84'/0'/0', note that the
coin type is always 0, even for testnet/regtest) and lnd's internal key
scope (m/1017'/&lt;coin_type&gt;'/&lt;account&gt;'), where account is the key family as
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
defined in <code>keychain/derivation.go</code> (currently indices 0 to 9).</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="lnrpc.WatchOnlyAccount" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WatchOnlyAccountextendsGeneratedMessagewithUpdatable[lnrpc.WatchOnlyAccount]withProductwithSerializable" class="anchorToMember"></a><a id="WatchOnlyAccount:WatchOnlyAccount" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WatchOnlyAccount.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="WatchOnlyAccount.html" title=""><span class="name">WatchOnlyAccount</span></a><span class="params">(<span name="purpose">purpose: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.WatchOnlyAccount._typemapper_purpose.toCustom(0)</a></span></span></span>, <span name="coinType">coinType: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.WatchOnlyAccount._typemapper_coinType.toCustom(0)</a></span></span></span>, <span name="account">account: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">lnrpc.WatchOnlyAccount._typemapper_account.toCustom(0)</a></span></span></span>, <span name="xpub">xpub: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">""</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="WatchOnlyAccount.html" name="lnrpc.WatchOnlyAccount" id="lnrpc.WatchOnlyAccount" class="extype">WatchOnlyAccount</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">purpose</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
Purpose is the first number in the derivation path, must be either 49, 84
or 1017.</p></dd><dt class="param">coinType</dt><dd class="cmt"><p>
Coin type is the second number in the derivation path, this is _always_ 0
for purposes 49 and 84. It only needs to be set to 1 for purpose 1017 on
testnet or regtest.</p></dd><dt class="param">account</dt><dd class="cmt"><p>
Account is the third number in the derivation path. For purposes 49 and 84
at least the default account (index 0) needs to be created but optional
additional accounts are allowed. For purpose 1017 there needs to be exactly
one account for each of the key families defined in <code>keychain/derivation.go</code>
(currently indices 0 to 9)</p></dd><dt class="param">xpub</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
The extended public key at depth 3 for the given account.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="lnrpc.AMP" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AMP" class="anchorToMember"></a><a id="AMP:AMP" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AMP$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AMP$.html" title=""><span class="name">AMP</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="AMP.html" name="lnrpc.AMP" id="lnrpc.AMP" class="extype">AMP</a>]</span></span></li><li class="indented0 " name="lnrpc.AMPInvoiceState" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AMPInvoiceState" class="anchorToMember"></a><a id="AMPInvoiceState:AMPInvoiceState" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AMPInvoiceState$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AMPInvoiceState$.html" title=""><span class="name">AMPInvoiceState</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="AMPInvoiceState.html" name="lnrpc.AMPInvoiceState" id="lnrpc.AMPInvoiceState" class="extype">AMPInvoiceState</a>]</span></span></li><li class="indented0 " name="lnrpc.AMPRecord" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AMPRecord" class="anchorToMember"></a><a id="AMPRecord:AMPRecord" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AMPRecord$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AMPRecord$.html" title=""><span class="name">AMPRecord</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="AMPRecord.html" name="lnrpc.AMPRecord" id="lnrpc.AMPRecord" class="extype">AMPRecord</a>]</span></span></li><li class="indented0 " name="lnrpc.AbandonChannelRequest" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AbandonChannelRequest" class="anchorToMember"></a><a id="AbandonChannelRequest:AbandonChannelRequest" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/AbandonChannelRequest$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="AbandonChannelRequest$.html" title=""><span class="name">AbandonChannelRequest</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="Aban
Reference in a new issue Copy permalink