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/Lightning.html

343 lines
190 KiB
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 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +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 " name="_root_.lnrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="lnrpc" class="anchorToMember"></a><a id="lnrpc:lnrpc" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">lnrpc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="current-entities indented1"><a href="AMP$.html" title="" class="object"></a> <a href="AMP.html" title="Details specific to AMP HTLCs." class="class"></a><a href="AMP.html" title="Details specific to AMP HTLCs.">AMP</a></li><li class="current-entities indented1"><a href="AMPInvoiceState$.html" title="" class="object"></a> <a href="AMPInvoiceState.html" title="" class="class"></a><a href="AMPInvoiceState.html" title="">AMPInvoiceState</a></li><li class="current-entities indented1"><a href="AMPRecord$.html" title="" class="object"></a> <a href="AMPRecord.html" title="" class="class"></a><a href="AMPRecord.html" title="">AMPRecord</a></li><li class="current-entities indented1"><a href="AbandonChannelRequest$.html" title="" class="object"></a> <a href="AbandonChannelRequest.html" title="" class="class"></a><a href="AbandonChannelRequest.html" title="">AbandonChannelRequest</a></li><li class="current-entities indented1"><a href="AbandonChannelResponse$.html" title="" class="object"></a> <a href="AbandonChannelResponse.html" title="" class="class"></a><a href="AbandonChannelResponse.html" title="">AbandonChannelResponse</a></li><li class="current-entities indented1"><a href="AddInvoiceResponse$.html" title="" class="object"></a> <a href="AddInvoiceResponse.html" title="" class="class"></a><a href="AddInvoiceResponse.html" title="">AddInvoiceResponse</a></li><li class="current-entities indented1"><a href="AddressType$.html" title="" class="object"></a> <a href="AddressType.html" title="AddressType has to be one of:" class="class"></a><a href="AddressType.html" title="AddressType has to be one of:">AddressType</a></li><li class="current-entities indented1"><a href="Amount$.html" title="" class="object"></a> <a href="Amount.html" title="" class="class"></a><a href="Amount.html" title="">Amount</a></li><li class="current-entities indented1"><a href="BakeMac
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div><div class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="LightningClient.html" name="lnrpc.LightningClient" id="lnrpc.LightningClient" class="extype">LightningClient</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="lnrpc.Lightning"><span>Lightning</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="lnrpc.Lightning#abandonChannel" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="abandonChannel(in:lnrpc.AbandonChannelRequest):scala.concurrent.Future[lnrpc.AbandonChannelResponse]" class="anchorToMember"></a><a id="abandonChannel(AbandonChannelRequest):Future[AbandonChannelResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#abandonChannel(in:lnrpc.AbandonChannelRequest):scala.concurrent.Future[lnrpc.AbandonChannelResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">abandonChannel</span><span class="params">(<span name="in">in: <a href="AbandonChannelRequest.html" name="lnrpc.AbandonChannelRequest" id="lnrpc.AbandonChannelRequest" class="extype">AbandonChannelRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="AbandonChannelResponse.html" name="lnrpc.AbandonChannelResponse" id="lnrpc.AbandonChannelResponse" class="extype">AbandonChannelResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>abandonchannel</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
AbandonChannel removes all channel state from the database except for a
close summary.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>abandonchannel</code>
AbandonChannel removes all channel state from the database except for a
close summary. This method can be used to get rid of permanently unusable
channels due to bugs fixed in newer versions of lnd. This method can also be
used to remove externally funded channels where the funding transaction was
never broadcast. Only available for non-externally funded channels in dev
build.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#addInvoice" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="addInvoice(in:lnrpc.Invoice):scala.concurrent.Future[lnrpc.AddInvoiceResponse]" class="anchorToMember"></a><a id="addInvoice(Invoice):Future[AddInvoiceResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#addInvoice(in:lnrpc.Invoice):scala.concurrent.Future[lnrpc.AddInvoiceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">addInvoice</span><span class="params">(<span name="in">in: <a href="Invoice.html" name="lnrpc.Invoice" id="lnrpc.Invoice" class="extype">Invoice</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="AddInvoiceResponse.html" name="lnrpc.AddInvoiceResponse" id="lnrpc.AddInvoiceResponse" class="extype">AddInvoiceResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>addinvoice</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
AddInvoice attempts to add a new invoice to the invoice database.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>addinvoice</code>
AddInvoice attempts to add a new invoice to the invoice database. Any
duplicated invoices are rejected, therefore all invoices *must* have a
unique payment preimage.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#bakeMacaroon" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="bakeMacaroon(in:lnrpc.BakeMacaroonRequest):scala.concurrent.Future[lnrpc.BakeMacaroonResponse]" class="anchorToMember"></a><a id="bakeMacaroon(BakeMacaroonRequest):Future[BakeMacaroonResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#bakeMacaroon(in:lnrpc.BakeMacaroonRequest):scala.concurrent.Future[lnrpc.BakeMacaroonResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">bakeMacaroon</span><span class="params">(<span name="in">in: <a href="BakeMacaroonRequest.html" name="lnrpc.BakeMacaroonRequest" id="lnrpc.BakeMacaroonRequest" class="extype">BakeMacaroonRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="BakeMacaroonResponse.html" name="lnrpc.BakeMacaroonResponse" id="lnrpc.BakeMacaroonResponse" class="extype">BakeMacaroonResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>bakemacaroon</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
BakeMacaroon allows the creation of a new macaroon with custom read and
write permissions.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>bakemacaroon</code>
BakeMacaroon allows the creation of a new macaroon with custom read and
write permissions. No first-party caveats are added since this can be done
offline.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#batchOpenChannel" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="batchOpenChannel(in:lnrpc.BatchOpenChannelRequest):scala.concurrent.Future[lnrpc.BatchOpenChannelResponse]" class="anchorToMember"></a><a id="batchOpenChannel(BatchOpenChannelRequest):Future[BatchOpenChannelResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#batchOpenChannel(in:lnrpc.BatchOpenChannelRequest):scala.concurrent.Future[lnrpc.BatchOpenChannelResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">batchOpenChannel</span><span class="params">(<span name="in">in: <a href="BatchOpenChannelRequest.html" name="lnrpc.BatchOpenChannelRequest" id="lnrpc.BatchOpenChannelRequest" class="extype">BatchOpenChannelRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="BatchOpenChannelResponse.html" name="lnrpc.BatchOpenChannelResponse" id="lnrpc.BatchOpenChannelResponse" class="extype">BatchOpenChannelResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>batchopenchannel</code>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
BatchOpenChannel attempts to open multiple single-funded channels in a
single transaction in an atomic way.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>batchopenchannel</code>
BatchOpenChannel attempts to open multiple single-funded channels in a
single transaction in an atomic way. This means either all channel open
requests succeed at once or all attempts are aborted if any of them fail.
This is the safer variant of using PSBTs to manually fund a batch of
channels through the OpenChannel RPC.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#channelAcceptor" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="channelAcceptor(in:akka.stream.scaladsl.Source[lnrpc.ChannelAcceptResponse,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.ChannelAcceptRequest,akka.NotUsed]" class="anchorToMember"></a><a id="channelAcceptor(Source[ChannelAcceptResponse,NotUsed]):Source[ChannelAcceptRequest,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#channelAcceptor(in:akka.stream.scaladsl.Source[lnrpc.ChannelAcceptResponse,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.ChannelAcceptRequest,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">channelAcceptor</span><span class="params">(<span name="in">in: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="ChannelAcceptResponse.html" name="lnrpc.ChannelAcceptResponse" id="lnrpc.ChannelAcceptResponse" class="extype">ChannelAcceptResponse</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="ChannelAcceptRequest.html" name="lnrpc.ChannelAcceptRequest" id="lnrpc.ChannelAcceptRequest" class="extype">ChannelAcceptRequest</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">ChannelAcceptor dispatches a bi-directional streaming RPC in which
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
OpenChannel requests are sent to the client and the client responds with
a boolean that tells LND whether or not to accept the channel.</p><div class="fullcomment"><div class="comment cmt"><p>ChannelAcceptor dispatches a bi-directional streaming RPC in which
OpenChannel requests are sent to the client and the client responds with
a boolean that tells LND whether or not to accept the channel. This allows
node operators to specify their own criteria for accepting inbound channels
through a single persistent connection.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#channelBalance" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="channelBalance(in:lnrpc.ChannelBalanceRequest):scala.concurrent.Future[lnrpc.ChannelBalanceResponse]" class="anchorToMember"></a><a id="channelBalance(ChannelBalanceRequest):Future[ChannelBalanceResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#channelBalance(in:lnrpc.ChannelBalanceRequest):scala.concurrent.Future[lnrpc.ChannelBalanceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">channelBalance</span><span class="params">(<span name="in">in: <a href="ChannelBalanceRequest.html" name="lnrpc.ChannelBalanceRequest" id="lnrpc.ChannelBalanceRequest" class="extype">ChannelBalanceRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChannelBalanceResponse.html" name="lnrpc.ChannelBalanceResponse" id="lnrpc.ChannelBalanceResponse" class="extype">ChannelBalanceResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>channelbalance</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ChannelBalance returns a report on the total funds across all open channels,
categorized in local/remote, pending local/remote and unsettled local/remote
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
balances.</p></li><li class="indented0 " name="lnrpc.Lightning#checkMacaroonPermissions" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="checkMacaroonPermissions(in:lnrpc.CheckMacPermRequest):scala.concurrent.Future[lnrpc.CheckMacPermResponse]" class="anchorToMember"></a><a id="checkMacaroonPermissions(CheckMacPermRequest):Future[CheckMacPermResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#checkMacaroonPermissions(in:lnrpc.CheckMacPermRequest):scala.concurrent.Future[lnrpc.CheckMacPermResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">checkMacaroonPermissions</span><span class="params">(<span name="in">in: <a href="CheckMacPermRequest.html" name="lnrpc.CheckMacPermRequest" id="lnrpc.CheckMacPermRequest" class="extype">CheckMacPermRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="CheckMacPermResponse.html" name="lnrpc.CheckMacPermResponse" id="lnrpc.CheckMacPermResponse" class="extype">CheckMacPermResponse</a>]</span></span><p class="shortcomment cmt">CheckMacaroonPermissions checks whether a request follows the constraints
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
imposed on the macaroon and that the macaroon is authorized to follow the
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
provided permissions.</p></li><li class="indented0 " name="lnrpc.Lightning#closeChannel" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="closeChannel(in:lnrpc.CloseChannelRequest):akka.stream.scaladsl.Source[lnrpc.CloseStatusUpdate,akka.NotUsed]" class="anchorToMember"></a><a id="closeChannel(CloseChannelRequest):Source[CloseStatusUpdate,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#closeChannel(in:lnrpc.CloseChannelRequest):akka.stream.scaladsl.Source[lnrpc.CloseStatusUpdate,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">closeChannel</span><span class="params">(<span name="in">in: <a href="CloseChannelRequest.html" name="lnrpc.CloseChannelRequest" id="lnrpc.CloseChannelRequest" class="extype">CloseChannelRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="CloseStatusUpdate.html" name="lnrpc.CloseStatusUpdate" id="lnrpc.CloseStatusUpdate" class="extype">CloseStatusUpdate</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">lncli: <code>closechannel</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
CloseChannel attempts to close an active channel identified by its channel
outpoint (ChannelPoint).</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>closechannel</code>
CloseChannel attempts to close an active channel identified by its channel
outpoint (ChannelPoint). The actions of this method can additionally be
augmented to attempt a force close after a timeout period in the case of an
inactive peer. If a non-force close (cooperative closure) is requested,
then the user can specify either a target number of blocks until the
closure transaction is confirmed, or a manual fee rate. If neither are
specified, then a default lax, block confirmation target is used.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#closedChannels" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="closedChannels(in:lnrpc.ClosedChannelsRequest):scala.concurrent.Future[lnrpc.ClosedChannelsResponse]" class="anchorToMember"></a><a id="closedChannels(ClosedChannelsRequest):Future[ClosedChannelsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#closedChannels(in:lnrpc.ClosedChannelsRequest):scala.concurrent.Future[lnrpc.ClosedChannelsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">closedChannels</span><span class="params">(<span name="in">in: <a href="ClosedChannelsRequest.html" name="lnrpc.ClosedChannelsRequest" id="lnrpc.ClosedChannelsRequest" class="extype">ClosedChannelsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ClosedChannelsResponse.html" name="lnrpc.ClosedChannelsResponse" id="lnrpc.ClosedChannelsResponse" class="extype">ClosedChannelsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>closedchannels</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ClosedChannels returns a description of all the closed channels that
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
this node was a participant in.</p></li><li class="indented0 " name="lnrpc.Lightning#connectPeer" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="connectPeer(in:lnrpc.ConnectPeerRequest):scala.concurrent.Future[lnrpc.ConnectPeerResponse]" class="anchorToMember"></a><a id="connectPeer(ConnectPeerRequest):Future[ConnectPeerResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#connectPeer(in:lnrpc.ConnectPeerRequest):scala.concurrent.Future[lnrpc.ConnectPeerResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">connectPeer</span><span class="params">(<span name="in">in: <a href="ConnectPeerRequest.html" name="lnrpc.ConnectPeerRequest" id="lnrpc.ConnectPeerRequest" class="extype">ConnectPeerRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ConnectPeerResponse.html" name="lnrpc.ConnectPeerResponse" id="lnrpc.ConnectPeerResponse" class="extype">ConnectPeerResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>connect</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ConnectPeer attempts to establish a connection to a remote peer.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>connect</code>
ConnectPeer attempts to establish a connection to a remote peer. This is at
the networking level, and is used for communication between nodes. This is
distinct from establishing a channel with a peer.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#debugLevel" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="debugLevel(in:lnrpc.DebugLevelRequest):scala.concurrent.Future[lnrpc.DebugLevelResponse]" class="anchorToMember"></a><a id="debugLevel(DebugLevelRequest):Future[DebugLevelResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#debugLevel(in:lnrpc.DebugLevelRequest):scala.concurrent.Future[lnrpc.DebugLevelResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">debugLevel</span><span class="params">(<span name="in">in: <a href="DebugLevelRequest.html" name="lnrpc.DebugLevelRequest" id="lnrpc.DebugLevelRequest" class="extype">DebugLevelRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="DebugLevelResponse.html" name="lnrpc.DebugLevelResponse" id="lnrpc.DebugLevelResponse" class="extype">DebugLevelResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>debuglevel</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
DebugLevel allows a caller to programmatically set the logging verbosity of
lnd.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>debuglevel</code>
DebugLevel allows a caller to programmatically set the logging verbosity of
lnd. The logging can be targeted according to a coarse daemon-wide logging
level, or in a granular fashion to specify the logging for a target
sub-system.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#decodePayReq" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="decodePayReq(in:lnrpc.PayReqString):scala.concurrent.Future[lnrpc.PayReq]" class="anchorToMember"></a><a id="decodePayReq(PayReqString):Future[PayReq]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#decodePayReq(in:lnrpc.PayReqString):scala.concurrent.Future[lnrpc.PayReq]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">decodePayReq</span><span class="params">(<span name="in">in: <a href="PayReqString.html" name="lnrpc.PayReqString" id="lnrpc.PayReqString" class="extype">PayReqString</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="PayReq.html" name="lnrpc.PayReq" id="lnrpc.PayReq" class="extype">PayReq</a>]</span></span><p class="shortcomment cmt">lncli: <code>decodepayreq</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
DecodePayReq takes an encoded payment request string and attempts to decode
it, returning a full description of the conditions encoded within the
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
payment request.</p></li><li class="indented0 " name="lnrpc.Lightning#deleteAllPayments" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="deleteAllPayments(in:lnrpc.DeleteAllPaymentsRequest):scala.concurrent.Future[lnrpc.DeleteAllPaymentsResponse]" class="anchorToMember"></a><a id="deleteAllPayments(DeleteAllPaymentsRequest):Future[DeleteAllPaymentsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#deleteAllPayments(in:lnrpc.DeleteAllPaymentsRequest):scala.concurrent.Future[lnrpc.DeleteAllPaymentsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">deleteAllPayments</span><span class="params">(<span name="in">in: <a href="DeleteAllPaymentsRequest.html" name="lnrpc.DeleteAllPaymentsRequest" id="lnrpc.DeleteAllPaymentsRequest" class="extype">DeleteAllPaymentsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="DeleteAllPaymentsResponse.html" name="lnrpc.DeleteAllPaymentsResponse" id="lnrpc.DeleteAllPaymentsResponse" class="extype">DeleteAllPaymentsResponse</a>]</span></span><p class="shortcomment cmt">DeleteAllPayments deletes all outgoing payments from DB.</p><div class="fullcomment"><div class="comment cmt"><p>DeleteAllPayments deletes all outgoing payments from DB. Note that it will
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
not attempt to delete In-Flight payments, since that would be unsafe.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#deleteMacaroonID" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="deleteMacaroonID(in:lnrpc.DeleteMacaroonIDRequest):scala.concurrent.Future[lnrpc.DeleteMacaroonIDResponse]" class="anchorToMember"></a><a id="deleteMacaroonID(DeleteMacaroonIDRequest):Future[DeleteMacaroonIDResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#deleteMacaroonID(in:lnrpc.DeleteMacaroonIDRequest):scala.concurrent.Future[lnrpc.DeleteMacaroonIDResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">deleteMacaroonID</span><span class="params">(<span name="in">in: <a href="DeleteMacaroonIDRequest.html" name="lnrpc.DeleteMacaroonIDRequest" id="lnrpc.DeleteMacaroonIDRequest" class="extype">DeleteMacaroonIDRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="DeleteMacaroonIDResponse.html" name="lnrpc.DeleteMacaroonIDResponse" id="lnrpc.DeleteMacaroonIDResponse" class="extype">DeleteMacaroonIDResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>deletemacaroonid</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
DeleteMacaroonID deletes the specified macaroon ID and invalidates all
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
macaroons derived from that ID.</p></li><li class="indented0 " name="lnrpc.Lightning#deletePayment" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="deletePayment(in:lnrpc.DeletePaymentRequest):scala.concurrent.Future[lnrpc.DeletePaymentResponse]" class="anchorToMember"></a><a id="deletePayment(DeletePaymentRequest):Future[DeletePaymentResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#deletePayment(in:lnrpc.DeletePaymentRequest):scala.concurrent.Future[lnrpc.DeletePaymentResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">deletePayment</span><span class="params">(<span name="in">in: <a href="DeletePaymentRequest.html" name="lnrpc.DeletePaymentRequest" id="lnrpc.DeletePaymentRequest" class="extype">DeletePaymentRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="DeletePaymentResponse.html" name="lnrpc.DeletePaymentResponse" id="lnrpc.DeletePaymentResponse" class="extype">DeletePaymentResponse</a>]</span></span><p class="shortcomment cmt">DeletePayment deletes an outgoing payment from DB.</p><div class="fullcomment"><div class="comment cmt"><p>DeletePayment deletes an outgoing payment from DB. Note that it will not
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
attempt to delete an In-Flight payment, since that would be unsafe.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#describeGraph" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="describeGraph(in:lnrpc.ChannelGraphRequest):scala.concurrent.Future[lnrpc.ChannelGraph]" class="anchorToMember"></a><a id="describeGraph(ChannelGraphRequest):Future[ChannelGraph]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#describeGraph(in:lnrpc.ChannelGraphRequest):scala.concurrent.Future[lnrpc.ChannelGraph]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">describeGraph</span><span class="params">(<span name="in">in: <a href="ChannelGraphRequest.html" name="lnrpc.ChannelGraphRequest" id="lnrpc.ChannelGraphRequest" class="extype">ChannelGraphRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChannelGraph.html" name="lnrpc.ChannelGraph" id="lnrpc.ChannelGraph" class="extype">ChannelGraph</a>]</span></span><p class="shortcomment cmt">lncli: <code>describegraph</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
DescribeGraph returns a description of the latest graph state from the
point of view of the node.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>describegraph</code>
DescribeGraph returns a description of the latest graph state from the
point of view of the node. The graph information is partitioned into two
components: all the nodes/vertexes, and all the edges that connect the
vertexes themselves. As this is a directed graph, the edges also contain
the node directional specific routing policy which includes: the time lock
delta, fee information, etc.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#disconnectPeer" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="disconnectPeer(in:lnrpc.DisconnectPeerRequest):scala.concurrent.Future[lnrpc.DisconnectPeerResponse]" class="anchorToMember"></a><a id="disconnectPeer(DisconnectPeerRequest):Future[DisconnectPeerResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#disconnectPeer(in:lnrpc.DisconnectPeerRequest):scala.concurrent.Future[lnrpc.DisconnectPeerResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">disconnectPeer</span><span class="params">(<span name="in">in: <a href="DisconnectPeerRequest.html" name="lnrpc.DisconnectPeerRequest" id="lnrpc.DisconnectPeerRequest" class="extype">DisconnectPeerRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="DisconnectPeerResponse.html" name="lnrpc.DisconnectPeerResponse" id="lnrpc.DisconnectPeerResponse" class="extype">DisconnectPeerResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>disconnect</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
DisconnectPeer attempts to disconnect one peer from another identified by a
given pubKey.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>disconnect</code>
DisconnectPeer attempts to disconnect one peer from another identified by a
given pubKey. In the case that we currently have a pending or active channel
with the target peer, then this action will be not be allowed.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#estimateFee" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="estimateFee(in:lnrpc.EstimateFeeRequest):scala.concurrent.Future[lnrpc.EstimateFeeResponse]" class="anchorToMember"></a><a id="estimateFee(EstimateFeeRequest):Future[EstimateFeeResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#estimateFee(in:lnrpc.EstimateFeeRequest):scala.concurrent.Future[lnrpc.EstimateFeeResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">estimateFee</span><span class="params">(<span name="in">in: <a href="EstimateFeeRequest.html" name="lnrpc.EstimateFeeRequest" id="lnrpc.EstimateFeeRequest" class="extype">EstimateFeeRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="EstimateFeeResponse.html" name="lnrpc.EstimateFeeResponse" id="lnrpc.EstimateFeeResponse" class="extype">EstimateFeeResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>estimatefee</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
EstimateFee asks the chain backend to estimate the fee rate and total fees
for a transaction that pays to multiple specified outputs.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>estimatefee</code>
EstimateFee asks the chain backend to estimate the fee rate and total fees
for a transaction that pays to multiple specified outputs.
When using REST, the <code>AddrToAmount</code> map type can be set by appending
<code>&amp;AddrToAmount[&lt;address&gt;]=&lt;amount_to_send&gt;</code> to the URL. Unfortunately this
map type doesn't appear in the REST API documentation because of a bug in
the grpc-gateway library.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#exportAllChannelBackups" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="exportAllChannelBackups(in:lnrpc.ChanBackupExportRequest):scala.concurrent.Future[lnrpc.ChanBackupSnapshot]" class="anchorToMember"></a><a id="exportAllChannelBackups(ChanBackupExportRequest):Future[ChanBackupSnapshot]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#exportAllChannelBackups(in:lnrpc.ChanBackupExportRequest):scala.concurrent.Future[lnrpc.ChanBackupSnapshot]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">exportAllChannelBackups</span><span class="params">(<span name="in">in: <a href="ChanBackupExportRequest.html" name="lnrpc.ChanBackupExportRequest" id="lnrpc.ChanBackupExportRequest" class="extype">ChanBackupExportRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChanBackupSnapshot.html" name="lnrpc.ChanBackupSnapshot" id="lnrpc.ChanBackupSnapshot" class="extype">ChanBackupSnapshot</a>]</span></span><p class="shortcomment cmt">ExportAllChannelBackups returns static channel backups for all existing
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
channels known to lnd.</p><div class="fullcomment"><div class="comment cmt"><p>ExportAllChannelBackups returns static channel backups for all existing
channels known to lnd. A set of regular singular static channel backups for
each channel are returned. Additionally, a multi-channel backup is returned
as well, which contains a single encrypted blob containing the backups of
each channel.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#exportChannelBackup" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="exportChannelBackup(in:lnrpc.ExportChannelBackupRequest):scala.concurrent.Future[lnrpc.ChannelBackup]" class="anchorToMember"></a><a id="exportChannelBackup(ExportChannelBackupRequest):Future[ChannelBackup]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#exportChannelBackup(in:lnrpc.ExportChannelBackupRequest):scala.concurrent.Future[lnrpc.ChannelBackup]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">exportChannelBackup</span><span class="params">(<span name="in">in: <a href="ExportChannelBackupRequest.html" name="lnrpc.ExportChannelBackupRequest" id="lnrpc.ExportChannelBackupRequest" class="extype">ExportChannelBackupRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChannelBackup.html" name="lnrpc.ChannelBackup" id="lnrpc.ChannelBackup" class="extype">ChannelBackup</a>]</span></span><p class="shortcomment cmt">lncli: <code>exportchanbackup</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ExportChannelBackup attempts to return an encrypted static channel backup
for the target channel identified by it channel point.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>exportchanbackup</code>
ExportChannelBackup attempts to return an encrypted static channel backup
for the target channel identified by it channel point. The backup is
encrypted with a key generated from the aezeed seed of the user. The
returned backup can either be restored using the RestoreChannelBackup
method once lnd is running, or via the InitWallet and UnlockWallet methods
from the WalletUnlocker service.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#feeReport" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="feeReport(in:lnrpc.FeeReportRequest):scala.concurrent.Future[lnrpc.FeeReportResponse]" class="anchorToMember"></a><a id="feeReport(FeeReportRequest):Future[FeeReportResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#feeReport(in:lnrpc.FeeReportRequest):scala.concurrent.Future[lnrpc.FeeReportResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">feeReport</span><span class="params">(<span name="in">in: <a href="FeeReportRequest.html" name="lnrpc.FeeReportRequest" id="lnrpc.FeeReportRequest" class="extype">FeeReportRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="FeeReportResponse.html" name="lnrpc.FeeReportResponse" id="lnrpc.FeeReportResponse" class="extype">FeeReportResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>feereport</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
FeeReport allows the caller to obtain a report detailing the current fee
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
schedule enforced by the node globally for each channel.</p></li><li class="indented0 " name="lnrpc.Lightning#forwardingHistory" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="forwardingHistory(in:lnrpc.ForwardingHistoryRequest):scala.concurrent.Future[lnrpc.ForwardingHistoryResponse]" class="anchorToMember"></a><a id="forwardingHistory(ForwardingHistoryRequest):Future[ForwardingHistoryResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#forwardingHistory(in:lnrpc.ForwardingHistoryRequest):scala.concurrent.Future[lnrpc.ForwardingHistoryResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">forwardingHistory</span><span class="params">(<span name="in">in: <a href="ForwardingHistoryRequest.html" name="lnrpc.ForwardingHistoryRequest" id="lnrpc.ForwardingHistoryRequest" class="extype">ForwardingHistoryRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ForwardingHistoryResponse.html" name="lnrpc.ForwardingHistoryResponse" id="lnrpc.ForwardingHistoryResponse" class="extype">ForwardingHistoryResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>fwdinghistory</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ForwardingHistory allows the caller to query the htlcswitch for a record of
all HTLCs forwarded within the target time range, and integer offset
Deploy website Deploy website version based on 35d2c6db4ef1752940d418e805a9572f33ea556e
2021-07-21 20:44:43 +00:00
within that time range, for a maximum number of events.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>fwdinghistory</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ForwardingHistory allows the caller to query the htlcswitch for a record of
all HTLCs forwarded within the target time range, and integer offset
Deploy website Deploy website version based on 35d2c6db4ef1752940d418e805a9572f33ea556e
2021-07-21 20:44:43 +00:00
within that time range, for a maximum number of events. If no maximum number
of events is specified, up to 100 events will be returned. If no time-range
is specified, then events will be returned in the order that they occured.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A list of forwarding events are returned. The size of each forwarding event
is 40 bytes, and the max message size able to be returned in gRPC is 4 MiB.
As a result each message can only contain 50k entries. Each response has
the index offset of the last entry. The index offset can be provided to the
request to allow the caller to skip a series of records.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#fundingStateStep" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="fundingStateStep(in:lnrpc.FundingTransitionMsg):scala.concurrent.Future[lnrpc.FundingStateStepResp]" class="anchorToMember"></a><a id="fundingStateStep(FundingTransitionMsg):Future[FundingStateStepResp]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#fundingStateStep(in:lnrpc.FundingTransitionMsg):scala.concurrent.Future[lnrpc.FundingStateStepResp]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">fundingStateStep</span><span class="params">(<span name="in">in: <a href="FundingTransitionMsg.html" name="lnrpc.FundingTransitionMsg" id="lnrpc.FundingTransitionMsg" class="extype">FundingTransitionMsg</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="FundingStateStepResp.html" name="lnrpc.FundingStateStepResp" id="lnrpc.FundingStateStepResp" class="extype">FundingStateStepResp</a>]</span></span><p class="shortcomment cmt">FundingStateStep is an advanced funding related call that allows the caller
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
to either execute some preparatory steps for a funding workflow, or
manually progress a funding workflow.</p><div class="fullcomment"><div class="comment cmt"><p>FundingStateStep is an advanced funding related call that allows the caller
to either execute some preparatory steps for a funding workflow, or
manually progress a funding workflow. The primary way a funding flow is
identified is via its pending channel ID. As an example, this method can be
used to specify that we're expecting a funding flow for a particular
pending channel ID, for which we need to use specific parameters.
Alternatively, this can be used to interactively drive PSBT signing for
funding for partially complete funding transactions.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#getChanInfo" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getChanInfo(in:lnrpc.ChanInfoRequest):scala.concurrent.Future[lnrpc.ChannelEdge]" class="anchorToMember"></a><a id="getChanInfo(ChanInfoRequest):Future[ChannelEdge]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getChanInfo(in:lnrpc.ChanInfoRequest):scala.concurrent.Future[lnrpc.ChannelEdge]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getChanInfo</span><span class="params">(<span name="in">in: <a href="ChanInfoRequest.html" name="lnrpc.ChanInfoRequest" id="lnrpc.ChanInfoRequest" class="extype">ChanInfoRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChannelEdge.html" name="lnrpc.ChannelEdge" id="lnrpc.ChannelEdge" class="extype">ChannelEdge</a>]</span></span><p class="shortcomment cmt">lncli: <code>getchaninfo</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetChanInfo returns the latest authenticated network announcement for the
given channel identified by its channel ID: an 8-byte integer which
uniquely identifies the location of transaction's funding output within the
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
blockchain.</p></li><li class="indented0 " name="lnrpc.Lightning#getInfo" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getInfo(in:lnrpc.GetInfoRequest):scala.concurrent.Future[lnrpc.GetInfoResponse]" class="anchorToMember"></a><a id="getInfo(GetInfoRequest):Future[GetInfoResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getInfo(in:lnrpc.GetInfoRequest):scala.concurrent.Future[lnrpc.GetInfoResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getInfo</span><span class="params">(<span name="in">in: <a href="GetInfoRequest.html" name="lnrpc.GetInfoRequest" id="lnrpc.GetInfoRequest" class="extype">GetInfoRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="GetInfoResponse.html" name="lnrpc.GetInfoResponse" id="lnrpc.GetInfoResponse" class="extype">GetInfoResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>getinfo</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetInfo returns general information concerning the lightning node including
it's identity pubkey, alias, the chains it is connected to, and information
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
concerning the number of open+pending channels.</p></li><li class="indented0 " name="lnrpc.Lightning#getNetworkInfo" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getNetworkInfo(in:lnrpc.NetworkInfoRequest):scala.concurrent.Future[lnrpc.NetworkInfo]" class="anchorToMember"></a><a id="getNetworkInfo(NetworkInfoRequest):Future[NetworkInfo]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getNetworkInfo(in:lnrpc.NetworkInfoRequest):scala.concurrent.Future[lnrpc.NetworkInfo]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getNetworkInfo</span><span class="params">(<span name="in">in: <a href="NetworkInfoRequest.html" name="lnrpc.NetworkInfoRequest" id="lnrpc.NetworkInfoRequest" class="extype">NetworkInfoRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="NetworkInfo.html" name="lnrpc.NetworkInfo" id="lnrpc.NetworkInfo" class="extype">NetworkInfo</a>]</span></span><p class="shortcomment cmt">lncli: <code>getnetworkinfo</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetNetworkInfo returns some basic stats about the known channel graph from
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
the point of view of the node.</p></li><li class="indented0 " name="lnrpc.Lightning#getNodeInfo" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getNodeInfo(in:lnrpc.NodeInfoRequest):scala.concurrent.Future[lnrpc.NodeInfo]" class="anchorToMember"></a><a id="getNodeInfo(NodeInfoRequest):Future[NodeInfo]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getNodeInfo(in:lnrpc.NodeInfoRequest):scala.concurrent.Future[lnrpc.NodeInfo]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getNodeInfo</span><span class="params">(<span name="in">in: <a href="NodeInfoRequest.html" name="lnrpc.NodeInfoRequest" id="lnrpc.NodeInfoRequest" class="extype">NodeInfoRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="NodeInfo.html" name="lnrpc.NodeInfo" id="lnrpc.NodeInfo" class="extype">NodeInfo</a>]</span></span><p class="shortcomment cmt">lncli: <code>getnodeinfo</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetNodeInfo returns the latest advertised, aggregated, and authenticated
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
channel information for the specified node identified by its public key.</p></li><li class="indented0 " name="lnrpc.Lightning#getNodeMetrics" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="getNodeMetrics(in:lnrpc.NodeMetricsRequest):scala.concurrent.Future[lnrpc.NodeMetricsResponse]" class="anchorToMember"></a><a id="getNodeMetrics(NodeMetricsRequest):Future[NodeMetricsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getNodeMetrics(in:lnrpc.NodeMetricsRequest):scala.concurrent.Future[lnrpc.NodeMetricsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getNodeMetrics</span><span class="params">(<span name="in">in: <a href="NodeMetricsRequest.html" name="lnrpc.NodeMetricsRequest" id="lnrpc.NodeMetricsRequest" class="extype">NodeMetricsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="NodeMetricsResponse.html" name="lnrpc.NodeMetricsResponse" id="lnrpc.NodeMetricsResponse" class="extype">NodeMetricsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>getnodemetrics</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetNodeMetrics returns node metrics calculated from the graph.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>getnodemetrics</code>
GetNodeMetrics returns node metrics calculated from the graph. Currently
the only supported metric is betweenness centrality of individual nodes.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#getRecoveryInfo" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getRecoveryInfo(in:lnrpc.GetRecoveryInfoRequest):scala.concurrent.Future[lnrpc.GetRecoveryInfoResponse]" class="anchorToMember"></a><a id="getRecoveryInfo(GetRecoveryInfoRequest):Future[GetRecoveryInfoResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getRecoveryInfo(in:lnrpc.GetRecoveryInfoRequest):scala.concurrent.Future[lnrpc.GetRecoveryInfoResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getRecoveryInfo</span><span class="params">(<span name="in">in: <a href="GetRecoveryInfoRequest.html" name="lnrpc.GetRecoveryInfoRequest" id="lnrpc.GetRecoveryInfoRequest" class="extype">GetRecoveryInfoRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="GetRecoveryInfoResponse.html" name="lnrpc.GetRecoveryInfoResponse" id="lnrpc.GetRecoveryInfoResponse" class="extype">GetRecoveryInfoResponse</a>]</span></span><p class="shortcomment cmt">* lncli: <code>getrecoveryinfo</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetRecoveryInfo returns information concerning the recovery mode including
whether it's in a recovery mode, whether the recovery is finished, and the
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
progress made so far.</p></li><li class="indented0 " name="lnrpc.Lightning#getTransactions" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="getTransactions(in:lnrpc.GetTransactionsRequest):scala.concurrent.Future[lnrpc.TransactionDetails]" class="anchorToMember"></a><a id="getTransactions(GetTransactionsRequest):Future[TransactionDetails]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#getTransactions(in:lnrpc.GetTransactionsRequest):scala.concurrent.Future[lnrpc.TransactionDetails]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getTransactions</span><span class="params">(<span name="in">in: <a href="GetTransactionsRequest.html" name="lnrpc.GetTransactionsRequest" id="lnrpc.GetTransactionsRequest" class="extype">GetTransactionsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="TransactionDetails.html" name="lnrpc.TransactionDetails" id="lnrpc.TransactionDetails" class="extype">TransactionDetails</a>]</span></span><p class="shortcomment cmt">lncli: <code>listchaintxns</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
GetTransactions returns a list describing all the known transactions
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
relevant to the wallet.</p></li><li class="indented0 " name="lnrpc.Lightning#listChannels" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="listChannels(in:lnrpc.ListChannelsRequest):scala.concurrent.Future[lnrpc.ListChannelsResponse]" class="anchorToMember"></a><a id="listChannels(ListChannelsRequest):Future[ListChannelsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listChannels(in:lnrpc.ListChannelsRequest):scala.concurrent.Future[lnrpc.ListChannelsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listChannels</span><span class="params">(<span name="in">in: <a href="ListChannelsRequest.html" name="lnrpc.ListChannelsRequest" id="lnrpc.ListChannelsRequest" class="extype">ListChannelsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListChannelsResponse.html" name="lnrpc.ListChannelsResponse" id="lnrpc.ListChannelsResponse" class="extype">ListChannelsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listchannels</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ListChannels returns a description of all the open channels that this node
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
is a participant in.</p></li><li class="indented0 " name="lnrpc.Lightning#listInvoices" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="listInvoices(in:lnrpc.ListInvoiceRequest):scala.concurrent.Future[lnrpc.ListInvoiceResponse]" class="anchorToMember"></a><a id="listInvoices(ListInvoiceRequest):Future[ListInvoiceResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listInvoices(in:lnrpc.ListInvoiceRequest):scala.concurrent.Future[lnrpc.ListInvoiceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listInvoices</span><span class="params">(<span name="in">in: <a href="ListInvoiceRequest.html" name="lnrpc.ListInvoiceRequest" id="lnrpc.ListInvoiceRequest" class="extype">ListInvoiceRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListInvoiceResponse.html" name="lnrpc.ListInvoiceResponse" id="lnrpc.ListInvoiceResponse" class="extype">ListInvoiceResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listinvoices</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ListInvoices returns a list of all the invoices currently stored within the
database.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>listinvoices</code>
ListInvoices returns a list of all the invoices currently stored within the
database. Any active debug invoices are ignored. It has full support for
paginated responses, allowing users to query for specific invoices through
their add_index. This can be done by using either the first_index_offset or
last_index_offset fields included in the response as the index_offset of the
next request. By default, the first 100 invoices created will be returned.
Backwards pagination is also supported through the Reversed flag.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#listMacaroonIDs" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="listMacaroonIDs(in:lnrpc.ListMacaroonIDsRequest):scala.concurrent.Future[lnrpc.ListMacaroonIDsResponse]" class="anchorToMember"></a><a id="listMacaroonIDs(ListMacaroonIDsRequest):Future[ListMacaroonIDsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listMacaroonIDs(in:lnrpc.ListMacaroonIDsRequest):scala.concurrent.Future[lnrpc.ListMacaroonIDsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listMacaroonIDs</span><span class="params">(<span name="in">in: <a href="ListMacaroonIDsRequest.html" name="lnrpc.ListMacaroonIDsRequest" id="lnrpc.ListMacaroonIDsRequest" class="extype">ListMacaroonIDsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListMacaroonIDsResponse.html" name="lnrpc.ListMacaroonIDsResponse" id="lnrpc.ListMacaroonIDsResponse" class="extype">ListMacaroonIDsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listmacaroonids</code>
ListMacaroonIDs returns all root key IDs that are in use.</p></li><li class="indented0 " name="lnrpc.Lightning#listPayments" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="listPayments(in:lnrpc.ListPaymentsRequest):scala.concurrent.Future[lnrpc.ListPaymentsResponse]" class="anchorToMember"></a><a id="listPayments(ListPaymentsRequest):Future[ListPaymentsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listPayments(in:lnrpc.ListPaymentsRequest):scala.concurrent.Future[lnrpc.ListPaymentsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listPayments</span><span class="params">(<span name="in">in: <a href="ListPaymentsRequest.html" name="lnrpc.ListPaymentsRequest" id="lnrpc.ListPaymentsRequest" class="extype">ListPaymentsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListPaymentsResponse.html" name="lnrpc.ListPaymentsResponse" id="lnrpc.ListPaymentsResponse" class="extype">ListPaymentsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listpayments</code>
ListPayments returns a list of all outgoing payments.</p></li><li class="indented0 " name="lnrpc.Lightning#listPeers" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="listPeers(in:lnrpc.ListPeersRequest):scala.concurrent.Future[lnrpc.ListPeersResponse]" class="anchorToMember"></a><a id="listPeers(ListPeersRequest):Future[ListPeersResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listPeers(in:lnrpc.ListPeersRequest):scala.concurrent.Future[lnrpc.ListPeersResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listPeers</span><span class="params">(<span name="in">in: <a href="ListPeersRequest.html" name="lnrpc.ListPeersRequest" id="lnrpc.ListPeersRequest" class="extype">ListPeersRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListPeersResponse.html" name="lnrpc.ListPeersResponse" id="lnrpc.ListPeersResponse" class="extype">ListPeersResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listpeers</code>
ListPeers returns a verbose listing of all currently active peers.</p></li><li class="indented0 " name="lnrpc.Lightning#listPermissions" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="listPermissions(in:lnrpc.ListPermissionsRequest):scala.concurrent.Future[lnrpc.ListPermissionsResponse]" class="anchorToMember"></a><a id="listPermissions(ListPermissionsRequest):Future[ListPermissionsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listPermissions(in:lnrpc.ListPermissionsRequest):scala.concurrent.Future[lnrpc.ListPermissionsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listPermissions</span><span class="params">(<span name="in">in: <a href="ListPermissionsRequest.html" name="lnrpc.ListPermissionsRequest" id="lnrpc.ListPermissionsRequest" class="extype">ListPermissionsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListPermissionsResponse.html" name="lnrpc.ListPermissionsResponse" id="lnrpc.ListPermissionsResponse" class="extype">ListPermissionsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listpermissions</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
ListPermissions lists all RPC method URIs and their required macaroon
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
permissions to access them.</p></li><li class="indented0 " name="lnrpc.Lightning#listUnspent" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="listUnspent(in:lnrpc.ListUnspentRequest):scala.concurrent.Future[lnrpc.ListUnspentResponse]" class="anchorToMember"></a><a id="listUnspent(ListUnspentRequest):Future[ListUnspentResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#listUnspent(in:lnrpc.ListUnspentRequest):scala.concurrent.Future[lnrpc.ListUnspentResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">listUnspent</span><span class="params">(<span name="in">in: <a href="ListUnspentRequest.html" name="lnrpc.ListUnspentRequest" id="lnrpc.ListUnspentRequest" class="extype">ListUnspentRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ListUnspentResponse.html" name="lnrpc.ListUnspentResponse" id="lnrpc.ListUnspentResponse" class="extype">ListUnspentResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>listunspent</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Deprecated, use walletrpc.ListUnspent instead.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>listunspent</code>
Deprecated, use walletrpc.ListUnspent instead.
ListUnspent returns a list of all utxos spendable by the wallet with a
number of confirmations between the specified minimum and maximum.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#lookupInvoice" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="lookupInvoice(in:lnrpc.PaymentHash):scala.concurrent.Future[lnrpc.Invoice]" class="anchorToMember"></a><a id="lookupInvoice(PaymentHash):Future[Invoice]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#lookupInvoice(in:lnrpc.PaymentHash):scala.concurrent.Future[lnrpc.Invoice]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">lookupInvoice</span><span class="params">(<span name="in">in: <a href="PaymentHash.html" name="lnrpc.PaymentHash" id="lnrpc.PaymentHash" class="extype">PaymentHash</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="Invoice.html" name="lnrpc.Invoice" id="lnrpc.Invoice" class="extype">Invoice</a>]</span></span><p class="shortcomment cmt">lncli: <code>lookupinvoice</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
LookupInvoice attempts to look up an invoice according to its payment hash.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>lookupinvoice</code>
LookupInvoice attempts to look up an invoice according to its payment hash.
The passed payment hash *must* be exactly 32 bytes, if not, an error is
returned.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#newAddress" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="newAddress(in:lnrpc.NewAddressRequest):scala.concurrent.Future[lnrpc.NewAddressResponse]" class="anchorToMember"></a><a id="newAddress(NewAddressRequest):Future[NewAddressResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#newAddress(in:lnrpc.NewAddressRequest):scala.concurrent.Future[lnrpc.NewAddressResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">newAddress</span><span class="params">(<span name="in">in: <a href="NewAddressRequest.html" name="lnrpc.NewAddressRequest" id="lnrpc.NewAddressRequest" class="extype">NewAddressRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="NewAddressResponse.html" name="lnrpc.NewAddressResponse" id="lnrpc.NewAddressResponse" class="extype">NewAddressResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>newaddress</code>
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
NewAddress creates a new address under control of the local wallet.</p></li><li class="indented0 " name="lnrpc.Lightning#openChannel" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="openChannel(in:lnrpc.OpenChannelRequest):akka.stream.scaladsl.Source[lnrpc.OpenStatusUpdate,akka.NotUsed]" class="anchorToMember"></a><a id="openChannel(OpenChannelRequest):Source[OpenStatusUpdate,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#openChannel(in:lnrpc.OpenChannelRequest):akka.stream.scaladsl.Source[lnrpc.OpenStatusUpdate,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">openChannel</span><span class="params">(<span name="in">in: <a href="OpenChannelRequest.html" name="lnrpc.OpenChannelRequest" id="lnrpc.OpenChannelRequest" class="extype">OpenChannelRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="OpenStatusUpdate.html" name="lnrpc.OpenStatusUpdate" id="lnrpc.OpenStatusUpdate" class="extype">OpenStatusUpdate</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">lncli: <code>openchannel</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
OpenChannel attempts to open a singly funded channel specified in the
request to a remote peer.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>openchannel</code>
OpenChannel attempts to open a singly funded channel specified in the
request to a remote peer. Users are able to specify a target number of
blocks that the funding transaction should be confirmed in, or a manual fee
rate to us for the funding transaction. If neither are specified, then a
lax block confirmation target is used. Each OpenStatusUpdate will return
the pending channel ID of the in-progress channel. Depending on the
arguments specified in the OpenChannelRequest, this pending channel ID can
then be used to manually progress the channel funding flow.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#openChannelSync" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="openChannelSync(in:lnrpc.OpenChannelRequest):scala.concurrent.Future[lnrpc.ChannelPoint]" class="anchorToMember"></a><a id="openChannelSync(OpenChannelRequest):Future[ChannelPoint]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#openChannelSync(in:lnrpc.OpenChannelRequest):scala.concurrent.Future[lnrpc.ChannelPoint]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">openChannelSync</span><span class="params">(<span name="in">in: <a href="OpenChannelRequest.html" name="lnrpc.OpenChannelRequest" id="lnrpc.OpenChannelRequest" class="extype">OpenChannelRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChannelPoint.html" name="lnrpc.ChannelPoint" id="lnrpc.ChannelPoint" class="extype">ChannelPoint</a>]</span></span><p class="shortcomment cmt">OpenChannelSync is a synchronous version of the OpenChannel RPC call.</p><div class="fullcomment"><div class="comment cmt"><p>OpenChannelSync is a synchronous version of the OpenChannel RPC call. This
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
call is meant to be consumed by clients to the REST proxy. As with all
other sync calls, all byte slices are intended to be populated as hex
encoded strings.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#pendingChannels" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="pendingChannels(in:lnrpc.PendingChannelsRequest):scala.concurrent.Future[lnrpc.PendingChannelsResponse]" class="anchorToMember"></a><a id="pendingChannels(PendingChannelsRequest):Future[PendingChannelsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#pendingChannels(in:lnrpc.PendingChannelsRequest):scala.concurrent.Future[lnrpc.PendingChannelsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">pendingChannels</span><span class="params">(<span name="in">in: <a href="PendingChannelsRequest.html" name="lnrpc.PendingChannelsRequest" id="lnrpc.PendingChannelsRequest" class="extype">PendingChannelsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="PendingChannelsResponse.html" name="lnrpc.PendingChannelsResponse" id="lnrpc.PendingChannelsResponse" class="extype">PendingChannelsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>pendingchannels</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
PendingChannels returns a list of all the channels that are currently
considered "pending".</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>pendingchannels</code>
PendingChannels returns a list of all the channels that are currently
considered "pending". A channel is pending if it has finished the funding
workflow and is waiting for confirmations for the funding txn, or is in the
process of closure, either initiated cooperatively or non-cooperatively.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#queryRoutes" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="queryRoutes(in:lnrpc.QueryRoutesRequest):scala.concurrent.Future[lnrpc.QueryRoutesResponse]" class="anchorToMember"></a><a id="queryRoutes(QueryRoutesRequest):Future[QueryRoutesResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#queryRoutes(in:lnrpc.QueryRoutesRequest):scala.concurrent.Future[lnrpc.QueryRoutesResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">queryRoutes</span><span class="params">(<span name="in">in: <a href="QueryRoutesRequest.html" name="lnrpc.QueryRoutesRequest" id="lnrpc.QueryRoutesRequest" class="extype">QueryRoutesRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="QueryRoutesResponse.html" name="lnrpc.QueryRoutesResponse" id="lnrpc.QueryRoutesResponse" class="extype">QueryRoutesResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>queryroutes</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
QueryRoutes attempts to query the daemon's Channel Router for a possible
route to a target destination capable of carrying a specific amount of
satoshis.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>queryroutes</code>
QueryRoutes attempts to query the daemon's Channel Router for a possible
route to a target destination capable of carrying a specific amount of
satoshis. The returned route contains the full details required to craft and
send an HTLC, also including the necessary information that should be
present within the Sphinx packet encapsulated within the HTLC.
When using REST, the <code>dest_custom_records</code> map type can be set by appending
<code>&amp;dest_custom_records[&lt;record_number&gt;]=&lt;record_data_base64_url_encoded&gt;</code>
to the URL. Unfortunately this map type doesn't appear in the REST API
documentation because of a bug in the grpc-gateway library.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#registerRPCMiddleware" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="registerRPCMiddleware(in:akka.stream.scaladsl.Source[lnrpc.RPCMiddlewareResponse,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.RPCMiddlewareRequest,akka.NotUsed]" class="anchorToMember"></a><a id="registerRPCMiddleware(Source[RPCMiddlewareResponse,NotUsed]):Source[RPCMiddlewareRequest,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#registerRPCMiddleware(in:akka.stream.scaladsl.Source[lnrpc.RPCMiddlewareResponse,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.RPCMiddlewareRequest,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">registerRPCMiddleware</span><span class="params">(<span name="in">in: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="RPCMiddlewareResponse.html" name="lnrpc.RPCMiddlewareResponse" id="lnrpc.RPCMiddlewareResponse" class="extype">RPCMiddlewareResponse</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="RPCMiddlewareRequest.html" name="lnrpc.RPCMiddlewareRequest" id="lnrpc.RPCMiddlewareRequest" class="extype">RPCMiddlewareRequest</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">RegisterRPCMiddleware adds a new gRPC middleware to the interceptor chain.</p><div class="fullcomment"><div class="comment cmt"><p>RegisterRPCMiddleware adds a new gRPC middleware to the interceptor chain. A
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
gRPC middleware is software component external to lnd that aims to add
additional business logic to lnd by observing/intercepting/validating
incoming gRPC client requests and (if needed) replacing/overwriting outgoing
messages before they're sent to the client. When registering the middleware
must identify itself and indicate what custom macaroon caveats it wants to
be responsible for. Only requests that contain a macaroon with that specific
custom caveat are then sent to the middleware for inspection. The other
option is to register for the read-only mode in which all requests/responses
are forwarded for interception to the middleware but the middleware is not
allowed to modify any responses. As a security measure, _no_ middleware can
modify responses for requests made with _unencumbered_ macaroons!
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#restoreChannelBackups" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="restoreChannelBackups(in:lnrpc.RestoreChanBackupRequest):scala.concurrent.Future[lnrpc.RestoreBackupResponse]" class="anchorToMember"></a><a id="restoreChannelBackups(RestoreChanBackupRequest):Future[RestoreBackupResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#restoreChannelBackups(in:lnrpc.RestoreChanBackupRequest):scala.concurrent.Future[lnrpc.RestoreBackupResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">restoreChannelBackups</span><span class="params">(<span name="in">in: <a href="RestoreChanBackupRequest.html" name="lnrpc.RestoreChanBackupRequest" id="lnrpc.RestoreChanBackupRequest" class="extype">RestoreChanBackupRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="RestoreBackupResponse.html" name="lnrpc.RestoreBackupResponse" id="lnrpc.RestoreBackupResponse" class="extype">RestoreBackupResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>restorechanbackup</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
RestoreChannelBackups accepts a set of singular channel backups, or a
single encrypted multi-chan backup and attempts to recover any funds
remaining within the channel.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>restorechanbackup</code>
RestoreChannelBackups accepts a set of singular channel backups, or a
single encrypted multi-chan backup and attempts to recover any funds
remaining within the channel. If we are able to unpack the backup, then the
new channel will be shown under listchannels, as well as pending channels.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#sendCoins" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendCoins(in:lnrpc.SendCoinsRequest):scala.concurrent.Future[lnrpc.SendCoinsResponse]" class="anchorToMember"></a><a id="sendCoins(SendCoinsRequest):Future[SendCoinsResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendCoins(in:lnrpc.SendCoinsRequest):scala.concurrent.Future[lnrpc.SendCoinsResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendCoins</span><span class="params">(<span name="in">in: <a href="SendCoinsRequest.html" name="lnrpc.SendCoinsRequest" id="lnrpc.SendCoinsRequest" class="extype">SendCoinsRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendCoinsResponse.html" name="lnrpc.SendCoinsResponse" id="lnrpc.SendCoinsResponse" class="extype">SendCoinsResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>sendcoins</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
SendCoins executes a request to send coins to a particular address.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>sendcoins</code>
SendCoins executes a request to send coins to a particular address. Unlike
SendMany, this RPC call only allows creating a single output at a time. If
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
neither target_conf, or sat_per_vbyte are set, then the internal wallet will
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
consult its fee model to determine a fee for the default confirmation
target.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#sendCustomMessage" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="sendCustomMessage(in:lnrpc.SendCustomMessageRequest):scala.concurrent.Future[lnrpc.SendCustomMessageResponse]" class="anchorToMember"></a><a id="sendCustomMessage(SendCustomMessageRequest):Future[SendCustomMessageResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendCustomMessage(in:lnrpc.SendCustomMessageRequest):scala.concurrent.Future[lnrpc.SendCustomMessageResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendCustomMessage</span><span class="params">(<span name="in">in: <a href="SendCustomMessageRequest.html" name="lnrpc.SendCustomMessageRequest" id="lnrpc.SendCustomMessageRequest" class="extype">SendCustomMessageRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendCustomMessageResponse.html" name="lnrpc.SendCustomMessageResponse" id="lnrpc.SendCustomMessageResponse" class="extype">SendCustomMessageResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>sendcustom</code>
SendCustomMessage sends a custom peer message.</p></li><li class="indented0 " name="lnrpc.Lightning#sendMany" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendMany(in:lnrpc.SendManyRequest):scala.concurrent.Future[lnrpc.SendManyResponse]" class="anchorToMember"></a><a id="sendMany(SendManyRequest):Future[SendManyResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendMany(in:lnrpc.SendManyRequest):scala.concurrent.Future[lnrpc.SendManyResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendMany</span><span class="params">(<span name="in">in: <a href="SendManyRequest.html" name="lnrpc.SendManyRequest" id="lnrpc.SendManyRequest" class="extype">SendManyRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendManyResponse.html" name="lnrpc.SendManyResponse" id="lnrpc.SendManyResponse" class="extype">SendManyResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>sendmany</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
SendMany handles a request for a transaction that creates multiple specified
outputs in parallel.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>sendmany</code>
SendMany handles a request for a transaction that creates multiple specified
Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
outputs in parallel. If neither target_conf, or sat_per_vbyte are set, then
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
the internal wallet will consult its fee model to determine a fee for the
default confirmation target.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#sendPayment" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendPayment(in:akka.stream.scaladsl.Source[lnrpc.SendRequest,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.SendResponse,akka.NotUsed]" class="anchorToMember"></a><a id="sendPayment(Source[SendRequest,NotUsed]):Source[SendResponse,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendPayment(in:akka.stream.scaladsl.Source[lnrpc.SendRequest,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.SendResponse,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendPayment</span><span class="params">(<span name="in">in: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="SendRequest.html" name="lnrpc.SendRequest" id="lnrpc.SendRequest" class="extype">SendRequest</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="SendResponse.html" name="lnrpc.SendResponse" id="lnrpc.SendResponse" class="extype">SendResponse</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">lncli: <code>sendpayment</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Deprecated, use routerrpc.SendPaymentV2.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>sendpayment</code>
Deprecated, use routerrpc.SendPaymentV2. SendPayment dispatches a
bi-directional streaming RPC for sending payments through the Lightning
Network. A single RPC invocation creates a persistent bi-directional
stream allowing clients to rapidly send payments through the Lightning
Network with a single persistent connection.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#sendPaymentSync" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendPaymentSync(in:lnrpc.SendRequest):scala.concurrent.Future[lnrpc.SendResponse]" class="anchorToMember"></a><a id="sendPaymentSync(SendRequest):Future[SendResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendPaymentSync(in:lnrpc.SendRequest):scala.concurrent.Future[lnrpc.SendResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendPaymentSync</span><span class="params">(<span name="in">in: <a href="SendRequest.html" name="lnrpc.SendRequest" id="lnrpc.SendRequest" class="extype">SendRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendResponse.html" name="lnrpc.SendResponse" id="lnrpc.SendResponse" class="extype">SendResponse</a>]</span></span><p class="shortcomment cmt">SendPaymentSync is the synchronous non-streaming version of SendPayment.</p><div class="fullcomment"><div class="comment cmt"><p>SendPaymentSync is the synchronous non-streaming version of SendPayment.
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
This RPC is intended to be consumed by clients of the REST proxy.
Additionally, this RPC expects the destination's public key and the payment
hash (if any) to be encoded as hex strings.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#sendToRoute" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendToRoute(in:akka.stream.scaladsl.Source[lnrpc.SendToRouteRequest,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.SendResponse,akka.NotUsed]" class="anchorToMember"></a><a id="sendToRoute(Source[SendToRouteRequest,NotUsed]):Source[SendResponse,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendToRoute(in:akka.stream.scaladsl.Source[lnrpc.SendToRouteRequest,akka.NotUsed]):akka.stream.scaladsl.Source[lnrpc.SendResponse,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendToRoute</span><span class="params">(<span name="in">in: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="SendToRouteRequest.html" name="lnrpc.SendToRouteRequest" id="lnrpc.SendToRouteRequest" class="extype">SendToRouteRequest</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="SendResponse.html" name="lnrpc.SendResponse" id="lnrpc.SendResponse" class="extype">SendResponse</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">lncli: <code>sendtoroute</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
Deprecated, use routerrpc.SendToRouteV2.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>sendtoroute</code>
Deprecated, use routerrpc.SendToRouteV2. SendToRoute is a bi-directional
streaming RPC for sending payment through the Lightning Network. This
method differs from SendPayment in that it allows users to specify a full
route manually. This can be used for things like rebalancing, and atomic
swaps.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#sendToRouteSync" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="sendToRouteSync(in:lnrpc.SendToRouteRequest):scala.concurrent.Future[lnrpc.SendResponse]" class="anchorToMember"></a><a id="sendToRouteSync(SendToRouteRequest):Future[SendResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#sendToRouteSync(in:lnrpc.SendToRouteRequest):scala.concurrent.Future[lnrpc.SendResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">sendToRouteSync</span><span class="params">(<span name="in">in: <a href="SendToRouteRequest.html" name="lnrpc.SendToRouteRequest" id="lnrpc.SendToRouteRequest" class="extype">SendToRouteRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SendResponse.html" name="lnrpc.SendResponse" id="lnrpc.SendResponse" class="extype">SendResponse</a>]</span></span><p class="shortcomment cmt">SendToRouteSync is a synchronous version of SendToRoute.</p><div class="fullcomment"><div class="comment cmt"><p>SendToRouteSync is a synchronous version of SendToRoute. It Will block
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
until the payment either fails or succeeds.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#signMessage" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="signMessage(in:lnrpc.SignMessageRequest):scala.concurrent.Future[lnrpc.SignMessageResponse]" class="anchorToMember"></a><a id="signMessage(SignMessageRequest):Future[SignMessageResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#signMessage(in:lnrpc.SignMessageRequest):scala.concurrent.Future[lnrpc.SignMessageResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">signMessage</span><span class="params">(<span name="in">in: <a href="SignMessageRequest.html" name="lnrpc.SignMessageRequest" id="lnrpc.SignMessageRequest" class="extype">SignMessageRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="SignMessageResponse.html" name="lnrpc.SignMessageResponse" id="lnrpc.SignMessageResponse" class="extype">SignMessageResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>signmessage</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
SignMessage signs a message with this node's private key.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>signmessage</code>
SignMessage signs a message with this node's private key. The returned
signature string is <code>zbase32</code> encoded and pubkey recoverable, meaning that
only the message digest and signature are needed for verification.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#stopDaemon" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="stopDaemon(in:lnrpc.StopRequest):scala.concurrent.Future[lnrpc.StopResponse]" class="anchorToMember"></a><a id="stopDaemon(StopRequest):Future[StopResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#stopDaemon(in:lnrpc.StopRequest):scala.concurrent.Future[lnrpc.StopResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">stopDaemon</span><span class="params">(<span name="in">in: <a href="StopRequest.html" name="lnrpc.StopRequest" id="lnrpc.StopRequest" class="extype">StopRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="StopResponse.html" name="lnrpc.StopResponse" id="lnrpc.StopResponse" class="extype">StopResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>stop</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
StopDaemon will send a shutdown request to the interrupt handler, triggering
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
a graceful shutdown of the daemon.</p></li><li class="indented0 " name="lnrpc.Lightning#subscribeChannelBackups" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="subscribeChannelBackups(in:lnrpc.ChannelBackupSubscription):akka.stream.scaladsl.Source[lnrpc.ChanBackupSnapshot,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeChannelBackups(ChannelBackupSubscription):Source[ChanBackupSnapshot,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribeChannelBackups(in:lnrpc.ChannelBackupSubscription):akka.stream.scaladsl.Source[lnrpc.ChanBackupSnapshot,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeChannelBackups</span><span class="params">(<span name="in">in: <a href="ChannelBackupSubscription.html" name="lnrpc.ChannelBackupSubscription" id="lnrpc.ChannelBackupSubscription" class="extype">ChannelBackupSubscription</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="ChanBackupSnapshot.html" name="lnrpc.ChanBackupSnapshot" id="lnrpc.ChanBackupSnapshot" class="extype">ChanBackupSnapshot</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribeChannelBackups allows a client to sub-subscribe to the most up to
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
date information concerning the state of all channel backups.</p><div class="fullcomment"><div class="comment cmt"><p>SubscribeChannelBackups allows a client to sub-subscribe to the most up to
date information concerning the state of all channel backups. Each time a
new channel is added, we return the new set of channels, along with a
multi-chan backup containing the backup info for all channels. Each time a
channel is closed, we send a new update, which contains new new chan back
ups, but the updated set of encrypted multi-chan backups with the closed
channel(s) removed.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#subscribeChannelEvents" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="subscribeChannelEvents(in:lnrpc.ChannelEventSubscription):akka.stream.scaladsl.Source[lnrpc.ChannelEventUpdate,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeChannelEvents(ChannelEventSubscription):Source[ChannelEventUpdate,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribeChannelEvents(in:lnrpc.ChannelEventSubscription):akka.stream.scaladsl.Source[lnrpc.ChannelEventUpdate,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeChannelEvents</span><span class="params">(<span name="in">in: <a href="ChannelEventSubscription.html" name="lnrpc.ChannelEventSubscription" id="lnrpc.ChannelEventSubscription" class="extype">ChannelEventSubscription</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="ChannelEventUpdate.html" name="lnrpc.ChannelEventUpdate" id="lnrpc.ChannelEventUpdate" class="extype">ChannelEventUpdate</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribeChannelEvents creates a uni-directional stream from the server to
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
the client in which any updates relevant to the state of the channels are
sent over.</p><div class="fullcomment"><div class="comment cmt"><p>SubscribeChannelEvents creates a uni-directional stream from the server to
the client in which any updates relevant to the state of the channels are
sent over. Events include new active channels, inactive channels, and closed
channels.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#subscribeChannelGraph" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="subscribeChannelGraph(in:lnrpc.GraphTopologySubscription):akka.stream.scaladsl.Source[lnrpc.GraphTopologyUpdate,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeChannelGraph(GraphTopologySubscription):Source[GraphTopologyUpdate,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribeChannelGraph(in:lnrpc.GraphTopologySubscription):akka.stream.scaladsl.Source[lnrpc.GraphTopologyUpdate,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeChannelGraph</span><span class="params">(<span name="in">in: <a href="GraphTopologySubscription.html" name="lnrpc.GraphTopologySubscription" id="lnrpc.GraphTopologySubscription" class="extype">GraphTopologySubscription</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="GraphTopologyUpdate.html" name="lnrpc.GraphTopologyUpdate" id="lnrpc.GraphTopologyUpdate" class="extype">GraphTopologyUpdate</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribeChannelGraph launches a streaming RPC that allows the caller to
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
receive notifications upon any changes to the channel graph topology from
the point of view of the responding node.</p><div class="fullcomment"><div class="comment cmt"><p>SubscribeChannelGraph launches a streaming RPC that allows the caller to
receive notifications upon any changes to the channel graph topology from
the point of view of the responding node. Events notified include: new
nodes coming online, nodes updating their authenticated attributes, new
channels being advertised, updates in the routing policy for a directional
channel edge, and when channels are closed on-chain.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#subscribeCustomMessages" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="subscribeCustomMessages(in:lnrpc.SubscribeCustomMessagesRequest):akka.stream.scaladsl.Source[lnrpc.CustomMessage,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeCustomMessages(SubscribeCustomMessagesRequest):Source[CustomMessage,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribeCustomMessages(in:lnrpc.SubscribeCustomMessagesRequest):akka.stream.scaladsl.Source[lnrpc.CustomMessage,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeCustomMessages</span><span class="params">(<span name="in">in: <a href="SubscribeCustomMessagesRequest.html" name="lnrpc.SubscribeCustomMessagesRequest" id="lnrpc.SubscribeCustomMessagesRequest" class="extype">SubscribeCustomMessagesRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="CustomMessage.html" name="lnrpc.CustomMessage" id="lnrpc.CustomMessage" class="extype">CustomMessage</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">lncli: <code>subscribecustom</code>
Deploy website Deploy website version based on ea6ac56fd55bb945c97e7566cc0f813d3b137b7c
2021-11-19 13:25:19 +00:00
SubscribeCustomMessages subscribes to a stream of incoming custom peer
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
messages.</p></li><li class="indented0 " name="lnrpc.Lightning#subscribeInvoices" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="subscribeInvoices(in:lnrpc.InvoiceSubscription):akka.stream.scaladsl.Source[lnrpc.Invoice,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeInvoices(InvoiceSubscription):Source[Invoice,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribeInvoices(in:lnrpc.InvoiceSubscription):akka.stream.scaladsl.Source[lnrpc.Invoice,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeInvoices</span><span class="params">(<span name="in">in: <a href="InvoiceSubscription.html" name="lnrpc.InvoiceSubscription" id="lnrpc.InvoiceSubscription" class="extype">InvoiceSubscription</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="Invoice.html" name="lnrpc.Invoice" id="lnrpc.Invoice" class="extype">Invoice</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribeInvoices returns a uni-directional stream (server -&gt; client) for
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
notifying the client of newly added/settled invoices.</p><div class="fullcomment"><div class="comment cmt"><p>SubscribeInvoices returns a uni-directional stream (server -&gt; client) for
notifying the client of newly added/settled invoices. The caller can
optionally specify the add_index and/or the settle_index. If the add_index
is specified, then we'll first start by sending add invoice events for all
invoices with an add_index greater than the specified value. If the
settle_index is specified, the next, we'll send out all settle events for
invoices with a settle_index greater than the specified value. One or both
of these fields can be set. If no fields are set, then we'll only send out
the latest add/settle events.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#subscribePeerEvents" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="subscribePeerEvents(in:lnrpc.PeerEventSubscription):akka.stream.scaladsl.Source[lnrpc.PeerEvent,akka.NotUsed]" class="anchorToMember"></a><a id="subscribePeerEvents(PeerEventSubscription):Source[PeerEvent,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribePeerEvents(in:lnrpc.PeerEventSubscription):akka.stream.scaladsl.Source[lnrpc.PeerEvent,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribePeerEvents</span><span class="params">(<span name="in">in: <a href="PeerEventSubscription.html" name="lnrpc.PeerEventSubscription" id="lnrpc.PeerEventSubscription" class="extype">PeerEventSubscription</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="PeerEvent.html" name="lnrpc.PeerEvent" id="lnrpc.PeerEvent" class="extype">PeerEvent</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribePeerEvents creates a uni-directional stream from the server to
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
the client in which any events relevant to the state of peers are sent
over.</p><div class="fullcomment"><div class="comment cmt"><p>SubscribePeerEvents creates a uni-directional stream from the server to
the client in which any events relevant to the state of peers are sent
over. Events include peers going online and offline.
Deploy website Deploy website version based on 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#subscribeTransactions" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="subscribeTransactions(in:lnrpc.GetTransactionsRequest):akka.stream.scaladsl.Source[lnrpc.Transaction,akka.NotUsed]" class="anchorToMember"></a><a id="subscribeTransactions(GetTransactionsRequest):Source[Transaction,NotUsed]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#subscribeTransactions(in:lnrpc.GetTransactionsRequest):akka.stream.scaladsl.Source[lnrpc.Transaction,akka.NotUsed]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">subscribeTransactions</span><span class="params">(<span name="in">in: <a href="GetTransactionsRequest.html" name="lnrpc.GetTransactionsRequest" id="lnrpc.GetTransactionsRequest" class="extype">GetTransactionsRequest</a></span>)</span><span class="result">: <a href="https://doc.akka.io/api/akka/2.6.20/akka/stream/scaladsl/Source.html#akka.stream.scaladsl.Source" name="akka.stream.scaladsl.Source" id="akka.stream.scaladsl.Source" class="extype">Source</a>[<a href="Transaction.html" name="lnrpc.Transaction" id="lnrpc.Transaction" class="extype">Transaction</a>, <a href="https://doc.akka.io/api/akka/2.6.20/akka/NotUsed.html#akka.NotUsed" name="akka.NotUsed" id="akka.NotUsed" class="extype">NotUsed</a>]</span></span><p class="shortcomment cmt">SubscribeTransactions creates a uni-directional stream from the server to
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
the client in which any newly discovered transactions relevant to the
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
wallet are sent over.</p></li><li class="indented0 " name="lnrpc.Lightning#updateChannelPolicy" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="updateChannelPolicy(in:lnrpc.PolicyUpdateRequest):scala.concurrent.Future[lnrpc.PolicyUpdateResponse]" class="anchorToMember"></a><a id="updateChannelPolicy(PolicyUpdateRequest):Future[PolicyUpdateResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#updateChannelPolicy(in:lnrpc.PolicyUpdateRequest):scala.concurrent.Future[lnrpc.PolicyUpdateResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">updateChannelPolicy</span><span class="params">(<span name="in">in: <a href="PolicyUpdateRequest.html" name="lnrpc.PolicyUpdateRequest" id="lnrpc.PolicyUpdateRequest" class="extype">PolicyUpdateRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="PolicyUpdateResponse.html" name="lnrpc.PolicyUpdateResponse" id="lnrpc.PolicyUpdateResponse" class="extype">PolicyUpdateResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>updatechanpolicy</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
UpdateChannelPolicy allows the caller to update the fee schedule and
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
channel policies for all channels globally, or a particular channel.</p></li><li class="indented0 " name="lnrpc.Lightning#verifyChanBackup" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="verifyChanBackup(in:lnrpc.ChanBackupSnapshot):scala.concurrent.Future[lnrpc.VerifyChanBackupResponse]" class="anchorToMember"></a><a id="verifyChanBackup(ChanBackupSnapshot):Future[VerifyChanBackupResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#verifyChanBackup(in:lnrpc.ChanBackupSnapshot):scala.concurrent.Future[lnrpc.VerifyChanBackupResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">verifyChanBackup</span><span class="params">(<span name="in">in: <a href="ChanBackupSnapshot.html" name="lnrpc.ChanBackupSnapshot" id="lnrpc.ChanBackupSnapshot" class="extype">ChanBackupSnapshot</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="VerifyChanBackupResponse.html" name="lnrpc.VerifyChanBackupResponse" id="lnrpc.VerifyChanBackupResponse" class="extype">VerifyChanBackupResponse</a>]</span></span><p class="shortcomment cmt">VerifyChanBackup allows a caller to verify the integrity of a channel backup
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
snapshot.</p><div class="fullcomment"><div class="comment cmt"><p>VerifyChanBackup allows a caller to verify the integrity of a channel backup
snapshot. This method will accept either a packed Single or a packed Multi.
Specifying both will result in an error.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#verifyMessage" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="verifyMessage(in:lnrpc.VerifyMessageRequest):scala.concurrent.Future[lnrpc.VerifyMessageResponse]" class="anchorToMember"></a><a id="verifyMessage(VerifyMessageRequest):Future[VerifyMessageResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#verifyMessage(in:lnrpc.VerifyMessageRequest):scala.concurrent.Future[lnrpc.VerifyMessageResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">verifyMessage</span><span class="params">(<span name="in">in: <a href="VerifyMessageRequest.html" name="lnrpc.VerifyMessageRequest" id="lnrpc.VerifyMessageRequest" class="extype">VerifyMessageRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="VerifyMessageResponse.html" name="lnrpc.VerifyMessageResponse" id="lnrpc.VerifyMessageResponse" class="extype">VerifyMessageResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>verifymessage</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
VerifyMessage verifies a signature over a msg.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>verifymessage</code>
VerifyMessage verifies a signature over a msg. The signature must be
zbase32 encoded and signed by an active node in the resident node's
channel database. In addition to returning the validity of the signature,
VerifyMessage also returns the recovered pubkey from the signature.
Deploy website Deploy website version based on 44a66e72e56c52a91a8f7b2478b117d291440263
2022-01-13 16:45:55 +00:00
</p></div></div></li><li class="indented0 " name="lnrpc.Lightning#walletBalance" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="walletBalance(in:lnrpc.WalletBalanceRequest):scala.concurrent.Future[lnrpc.WalletBalanceResponse]" class="anchorToMember"></a><a id="walletBalance(WalletBalanceRequest):Future[WalletBalanceResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#walletBalance(in:lnrpc.WalletBalanceRequest):scala.concurrent.Future[lnrpc.WalletBalanceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">walletBalance</span><span class="params">(<span name="in">in: <a href="WalletBalanceRequest.html" name="lnrpc.WalletBalanceRequest" id="lnrpc.WalletBalanceRequest" class="extype">WalletBalanceRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="WalletBalanceResponse.html" name="lnrpc.WalletBalanceResponse" id="lnrpc.WalletBalanceResponse" class="extype">WalletBalanceResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>walletbalance</code>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
WalletBalance returns total unspent outputs(confirmed and unconfirmed), all
confirmed unspent outputs and all unconfirmed unspent outputs under control
Deploy website Deploy website version based on 69cade4737748727f36731fe2b203c025330423e
2022-02-22 01:16:40 +00:00
of the wallet.</p></li></ol></div><div class="values members"><h3>Concrete Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Lightning.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span clas
Reference in a new issue Copy permalink