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

125 lines
164 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 */
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="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="BakeMacaroonRequest$.html" title="" class="object"></a> <a href="BakeMacaroonRequest.html" title="" class="class"></a><a href="BakeMacaroonRequest.html" title="">BakeMacaroonRequest</a></li><li class="current-entities indented1"><a href="BakeMacaroonResponse$.html" title="" class="object"></a> <a href="BakeMacaroonResponse.html" title="" class="class"></a><a href="BakeMacaroonResponse.html" title="">BakeMacaroonResponse</a>
Whether this channel is active or not</p></dd><dt class="param">remotePubkey</dt><dd class="cmt"><p>
The identity pubkey of the remote node</p></dd><dt class="param">channelPoint</dt><dd class="cmt"><p>
The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.</p></dd><dt class="param">chanId</dt><dd class="cmt"><p>
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
output index for the channel.</p></dd><dt class="param">capacity</dt><dd class="cmt"><p>
The total amount of funds held in this channel</p></dd><dt class="param">localBalance</dt><dd class="cmt"><p>
This node's current balance in this channel</p></dd><dt class="param">remoteBalance</dt><dd class="cmt"><p>
The counterparty's current balance in this channel</p></dd><dt class="param">commitFee</dt><dd class="cmt"><p>
The amount calculated to be paid in fees for the current set of commitment
transactions. The fee amount is persisted with the channel in order to
allow the fee amount to be removed and recalculated with each channel state
update, including updates that happen after a system restart.</p></dd><dt class="param">commitWeight</dt><dd class="cmt"><p>
The weight of the commitment transaction</p></dd><dt class="param">feePerKw</dt><dd class="cmt"><p>
The required number of satoshis per kilo-weight that the requester will pay
at all times, for both the funding transaction and commitment transaction.
This value can later be updated once the channel is open.</p></dd><dt class="param">unsettledBalance</dt><dd class="cmt"><p>
The unsettled balance in this channel</p></dd><dt class="param">totalSatoshisSent</dt><dd class="cmt"><p>
The total number of satoshis we've sent within this channel.</p></dd><dt class="param">totalSatoshisReceived</dt><dd class="cmt"><p>
The total number of satoshis we've received within this channel.</p></dd><dt class="param">numUpdates</dt><dd class="cmt"><p>
The total number of updates conducted within this channel.</p></dd><dt class="param">pendingHtlcs</dt><dd class="cmt"><p>
The list of active, uncleared HTLCs currently pending within the channel.</p></dd><dt class="param">csvDelay</dt><dd class="cmt"><p>
Deprecated. The CSV delay expressed in relative blocks. If the channel is
force closed, we will need to wait for this many blocks before we can regain
our funds.</p></dd><dt class="param">private</dt><dd class="cmt"><p>
Whether this channel is advertised to the network or not.</p></dd><dt class="param">initiator</dt><dd class="cmt"><p>
True if we were the ones that created the channel.</p></dd><dt class="param">chanStatusFlags</dt><dd class="cmt"><p>
A set of flags showing the current state of the channel.</p></dd><dt class="param">localChanReserveSat</dt><dd class="cmt"><p>
Deprecated. The minimum satoshis this node is required to reserve in its
balance.</p></dd><dt class="param">remoteChanReserveSat</dt><dd class="cmt"><p>
Deprecated. The minimum satoshis the other node is required to reserve in
its balance.</p></dd><dt class="param">staticRemoteKey</dt><dd class="cmt"><p>
Deprecated. Use commitment_type.</p></dd><dt class="param">commitmentType</dt><dd class="cmt"><p>
The commitment type used by this channel.</p></dd><dt class="param">lifetime</dt><dd class="cmt"><p>
The number of seconds that the channel has been monitored by the channel
scoring system. Scores are currently not persisted, so this value may be
less than the lifetime of the channel [EXPERIMENTAL].</p></dd><dt class="param">uptime</dt><dd class="cmt"><p>
The number of seconds that the remote peer has been observed as being online
by the channel scoring system over the lifetime of the channel
[EXPERIMENTAL].</p></dd><dt class="param">closeAddress</dt><dd class="cmt"><p>
Close address is the address that we will enforce payout to on cooperative
close if the channel was opened utilizing option upfront shutdown. This
value can be set on channel open by setting close_address in an open channel
request. If this value is not set, you can still choose a payout address by
cooperatively closing with the delivery_address field set.</p></dd><dt class="param">pushAmountSat</dt><dd class="cmt"><p>
The amount that the initiator of the channel optionally pushed to the remote
party on channel open. This amount will be zero if the channel initiator did
not push any funds to the remote peer. If the initiator field is true, we
pushed this amount to our peer, if it is false, the remote peer pushed this
amount to us.</p></dd><dt class="param">thawHeight</dt><dd class="cmt"><p>
This uint32 indicates if this channel is to be considered 'frozen'. A
frozen channel doest not allow a cooperative channel close by the
initiator. The thaw_height is the height that this restriction stops
applying to the channel. This field is optional, not setting it or using a
value of zero will mean the channel has no additional restrictions. The
height can be interpreted in two ways: as a relative height if the value is
less than 500,000, or as an absolute height otherwise.</p></dd><dt class="param">localConstraints</dt><dd class="cmt"><p>
List constraints for the local node.</p></dd><dt class="param">remoteConstraints</dt><dd class="cmt"><p>
List constraints for the remote node.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="https://www.scala-lang.org/api/2.13.5/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a>, <a href="https://www.scala-lang.org/api/2.13.5/scala/Equals.html#scala.Equals" name="scala.Equals" id="scala.Equals" class="extype">Equals</a>, <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.10.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="" name="lnrpc.Channel" id="lnrpc.Channel" class="extype">Channel</a>], <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.10.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.5/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="lnrpc.Channel"><span>Channel</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="scalapb.lenses.Updatable"><span>Updatable</span></li><li class="in" name="scalapb.GeneratedMessage"><span>GeneratedMessage</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="lnrpc.Channel#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(active:Boolean,remotePubkey:String,channelPoint:String,chanId:Long,capacity:Long,localBalance:Long,remoteBalance:Long,commitFee:Long,commitWeight:Long,feePerKw:Long,unsettledBalance:Long,totalSatoshisSent:Long,totalSatoshisReceived:Long,numUpdates:Long,pendingHtlcs:Seq[lnrpc.HTLC],csvDelay:Int,private:Boolean,initiator:Boolean,chanStatusFlags:String,localChanReserveSat:Long,remoteChanReserveSat:Long,staticRemoteKey:Boolean,commitmentType:lnrpc.CommitmentType,lifetime:Long,uptime:Long,closeAddress:String,pushAmountSat:Long,thawHeight:Int,localConstraints:Option[lnrpc.ChannelConstraints],remoteConstraints:Option[lnrpc.ChannelConstraints],unknownFields:scalapb.UnknownFieldSet):lnrpc.Channel" class="anchorToMember"></a><a id="&lt;init&gt;:Channel" class="anchorToMember"></a> <span class="permalink">
Whether this channel is active or not</p></dd><dt class="param">remotePubkey</dt><dd class="cmt"><p>
The identity pubkey of the remote node</p></dd><dt class="param">channelPoint</dt><dd class="cmt"><p>
The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.</p></dd><dt class="param">chanId</dt><dd class="cmt"><p>
The unique channel ID for the channel. The first 3 bytes are the block
height, the next 3 the index within the block, and the last 2 bytes are the
output index for the channel.</p></dd><dt class="param">capacity</dt><dd class="cmt"><p>
The total amount of funds held in this channel</p></dd><dt class="param">localBalance</dt><dd class="cmt"><p>
This node's current balance in this channel</p></dd><dt class="param">remoteBalance</dt><dd class="cmt"><p>
The counterparty's current balance in this channel</p></dd><dt class="param">commitFee</dt><dd class="cmt"><p>
The amount calculated to be paid in fees for the current set of commitment
transactions. The fee amount is persisted with the channel in order to
allow the fee amount to be removed and recalculated with each channel state
update, including updates that happen after a system restart.</p></dd><dt class="param">commitWeight</dt><dd class="cmt"><p>
The weight of the commitment transaction</p></dd><dt class="param">feePerKw</dt><dd class="cmt"><p>
The required number of satoshis per kilo-weight that the requester will pay
at all times, for both the funding transaction and commitment transaction.
This value can later be updated once the channel is open.</p></dd><dt class="param">unsettledBalance</dt><dd class="cmt"><p>
The unsettled balance in this channel</p></dd><dt class="param">totalSatoshisSent</dt><dd class="cmt"><p>
The total number of satoshis we've sent within this channel.</p></dd><dt class="param">totalSatoshisReceived</dt><dd class="cmt"><p>
The total number of satoshis we've received within this channel.</p></dd><dt class="param">numUpdates</dt><dd class="cmt"><p>
The total number of updates conducted within this channel.</p></dd><dt class="param">pendingHtlcs</dt><dd class="cmt"><p>
The list of active, uncleared HTLCs currently pending within the channel.</p></dd><dt class="param">csvDelay</dt><dd class="cmt"><p>
Deprecated. The CSV delay expressed in relative blocks. If the channel is
force closed, we will need to wait for this many blocks before we can regain
our funds.</p></dd><dt class="param">private</dt><dd class="cmt"><p>
Whether this channel is advertised to the network or not.</p></dd><dt class="param">initiator</dt><dd class="cmt"><p>
True if we were the ones that created the channel.</p></dd><dt class="param">chanStatusFlags</dt><dd class="cmt"><p>
A set of flags showing the current state of the channel.</p></dd><dt class="param">localChanReserveSat</dt><dd class="cmt"><p>
Deprecated. The minimum satoshis this node is required to reserve in its
balance.</p></dd><dt class="param">remoteChanReserveSat</dt><dd class="cmt"><p>
Deprecated. The minimum satoshis the other node is required to reserve in
its balance.</p></dd><dt class="param">staticRemoteKey</dt><dd class="cmt"><p>
Deprecated. Use commitment_type.</p></dd><dt class="param">commitmentType</dt><dd class="cmt"><p>
The commitment type used by this channel.</p></dd><dt class="param">lifetime</dt><dd class="cmt"><p>
The number of seconds that the channel has been monitored by the channel
scoring system. Scores are currently not persisted, so this value may be
less than the lifetime of the channel [EXPERIMENTAL].</p></dd><dt class="param">uptime</dt><dd class="cmt"><p>
The number of seconds that the remote peer has been observed as being online
by the channel scoring system over the lifetime of the channel
[EXPERIMENTAL].</p></dd><dt class="param">closeAddress</dt><dd class="cmt"><p>
Close address is the address that we will enforce payout to on cooperative
close if the channel was opened utilizing option upfront shutdown. This
value can be set on channel open by setting close_address in an open channel
request. If this value is not set, you can still choose a payout address by
cooperatively closing with the delivery_address field set.</p></dd><dt class="param">pushAmountSat</dt><dd class="cmt"><p>
The amount that the initiator of the channel optionally pushed to the remote
party on channel open. This amount will be zero if the channel initiator did
not push any funds to the remote peer. If the initiator field is true, we
pushed this amount to our peer, if it is false, the remote peer pushed this
amount to us.</p></dd><dt class="param">thawHeight</dt><dd class="cmt"><p>
This uint32 indicates if this channel is to be considered 'frozen'. A
frozen channel doest not allow a cooperative channel close by the
initiator. The thaw_height is the height that this restriction stops
applying to the channel. This field is optional, not setting it or using a
value of zero will mean the channel has no additional restrictions. The
height can be interpreted in two ways: as a relative height if the value is
less than 500,000, or as an absolute height otherwise.</p></dd><dt class="param">localConstraints</dt><dd class="cmt"><p>
List constraints for the local node.</p></dd><dt class="param">remoteConstraints</dt><dd class="cmt"><p>
List constraints for the remote node.</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Channel.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.5/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.5/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/Channel.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.5/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/Channel.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.5/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.5/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="lnrpc.Channel#active" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="active:Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Channel.html#active:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">active</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.5/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span></li><li class="indented0 " name="lnrpc.Channel#addAllPendingHtlcs" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="addAllPendingHtlcs(__vs:Iterable[lnrpc.HTLC]):lnrpc.Channel" class="anchorToMember"></a><a id="addAllPendingHtlcs(Iterable[HTLC]):Channel" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/Channel.html#addAllPendingHtlcs(__vs:Iterable[lnrpc.HTLC]):lnrpc.Channel" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></s
Reference in a new issue Copy permalink