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

25 lines
96 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>
A unique identifier of 32 random bytes that will be used as the pending
channel ID to identify the PSBT state machine when interacting with it and
on the wire protocol to initiate the funding request.</p></dd><dt class="param">basePsbt</dt><dd class="cmt"><p>
An optional base PSBT the new channel output will be added to. If this is
non-empty, it must be a binary serialized PSBT.</p></dd><dt class="param">noPublish</dt><dd class="cmt"><p>
If a channel should be part of a batch (multiple channel openings in one
transaction), it can be dangerous if the whole batch transaction is
published too early before all channel opening negotiations are completed.
This flag prevents this particular channel from broadcasting the transaction
after the negotiation with the remote peer. In a batch of channel openings
this flag should be set to true for every channel but the very last.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl><div 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.PsbtShim" id="lnrpc.PsbtShim" class="extype">PsbtShim</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.PsbtShim"><span>PsbtShim</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.PsbtShim#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(pendingChanId:com.google.protobuf.ByteString,basePsbt:com.google.protobuf.ByteString,noPublish:Boolean,unknownFields:scalapb.UnknownFieldSet):lnrpc.PsbtShim" class="anchorToMember"></a><a id="&lt;init&gt;:PsbtShim" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PsbtShim.html#&lt;init&gt;(pendingChanId:com.google.protobuf.ByteString,basePsbt:com.google.protobuf.ByteString,noPublish:Boolean,unknownFields:scalapb.UnknownFieldSet):lnrpc.PsbtShim" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">PsbtShim</span><span class="params">(<span name="pendingChanId">pendingChanId: <a href="https://javad
A unique identifier of 32 random bytes that will be used as the pending
channel ID to identify the PSBT state machine when interacting with it and
on the wire protocol to initiate the funding request.</p></dd><dt class="param">basePsbt</dt><dd class="cmt"><p>
An optional base PSBT the new channel output will be added to. If this is
non-empty, it must be a binary serialized PSBT.</p></dd><dt class="param">noPublish</dt><dd class="cmt"><p>
If a channel should be part of a batch (multiple channel openings in one
transaction), it can be dangerous if the whole batch transaction is
published too early before all channel opening negotiations are completed.
This flag prevents this particular channel from broadcasting the transaction
after the negotiation with the remote peer. In a batch of channel openings
this flag should be set to true for every channel but the very last.</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/PsbtShim.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/PsbtShim.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/PsbtShim.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="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/PsbtShim.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="lnrpc.PsbtShim#basePsbt" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="basePsbt:com.google.protobuf.ByteString" class="anchorToMember"></a><a id="basePsbt:ByteString" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/PsbtShim.html#basePsbt:com.google.protobuf.ByteString" title="Permalink"><i class="material-icons"></i></
Reference in a new issue Copy permalink