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/chainrpc/SpendRequest.html

29 lines
59 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +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 dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +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_.chainrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="chainrpc" class="anchorToMember"></a><a id="chainrpc:chainrpc" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/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">chainrpc</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="BlockEpoch$.html" title="" class="object"></a> <a href="BlockEpoch.html" title="" class="class"></a><a href="BlockEpoch.html" title="">BlockEpoch</a></li><li class="current-entities indented1"><a href="ChainNotifier$.html" title="" class="object"></a> <a href="ChainNotifier.html" title="ChainNotifier is a service that can be used to get information about the chain backend by registering notifiers for chain events." class="trait"></a><a href="ChainNotifier.html" title="ChainNotifier is a service that can be used to get information about the chain backend by registering notifiers for chain events.">ChainNotifier</a></li><li class="current-entities indented1"><a href="ChainNotifierClient$.html" title="" class="object"></a> <a href="ChainNotifierClient.html" title="" class="trait"></a><a href="ChainNotifierClient.html" title="">ChainNotifierClient</a></li><li class="current-entities indented1"><span class="separator"></span> <a href="ChainNotifierClientPowerApi.html" title="" class="trait"></a><a href="ChainNotifierClientPowerApi.html" title="">ChainNotifierClientPowerApi</a></li><li class="current-entities indented1"><span class="separator"></span> <a href="ChainNotifierHandler$.html" title="" class="object"></a><a href="ChainNotifierHandler$.html" title="">ChainNotifierHandler</a></li><li class="current-entities indented1"><span class="separator"></span> <a href="ChainnotifierProto$.html" title="" class="object"></a><a href="ChainnotifierProto$.html" title="">ChainnotifierProto</a></li><li class="current-entities indented1"><a href="ConfDetails$.html" title="" class="object"></a> <a href="ConfDetails.html" title="" class="class"></a><a href="ConfDetails.html" title="">ConfDetails</a></li><li class="current-entities indented1"><a href="ConfEvent$.html" title="" class="object"></a> <a href="ConfE
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The outpoint for which we should request a spend notification for. If set to
a zero outpoint, then the spend notification will be requested for the
script instead. A zero or nil outpoint is not supported for Taproot spends
because the output script cannot reliably be computed from the witness alone
and the spent output script is not always available in the rescan context.
So an outpoint must _always_ be specified when registering a spend
notification for a Taproot output.</p></dd><dt class="param">script</dt><dd class="cmt"><p>
The output script for the outpoint above. This will be used by light clients
to match block filters. If the outpoint is set to a zero outpoint, then a
spend notification will be requested for this script instead.</p></dd><dt class="param">heightHint</dt><dd class="cmt"><p>
The earliest height in the chain for which the outpoint/output script could
have been spent. This should in most cases be set to the broadcast height of
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
the outpoint/output script.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="" name="chainrpc.SpendRequest" id="chainrpc.SpendRequest" class="extype">SpendRequest</a>], <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <a href="https://www.scala-lang.org/api/2.13.10/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.10/scala/Equals.html#scala.Equals" name="scala.Equals" id="scala.Equals" class="extype">Equals</a>, <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.10/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="chainrpc.SpendRequest"><span>SpendRequest</span></li><li class="in" name="scalapb.lenses.Updatable"><span>Updatable</span></li><li class="in" name="scalapb.GeneratedMessage"><span>GeneratedMessage</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="chainrpc.SpendRequest#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(outpoint:Option[chainrpc.Outpoint],script:com.google.protobuf.ByteString,heightHint:org.bitcoins.core.number.UInt32,unknownFields:scalapb.UnknownFieldSet):chainrpc.SpendRequest" class="anchorToMember"></a><a id="&lt;init&gt;:SpendRequest" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/SpendRequest.html#&lt;init&gt;(outpoint:Option[chainrpc.Outpoint],script:com.google.protobuf.ByteString,heightHint:org.bitcoins.core.number.UInt32,unknownFields:scalapb.UnknownFieldSet):chainrpc.SpendRequest" 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">SpendRequest</span><span class="params">(<span name=
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The outpoint for which we should request a spend notification for. If set to
a zero outpoint, then the spend notification will be requested for the
script instead. A zero or nil outpoint is not supported for Taproot spends
because the output script cannot reliably be computed from the witness alone
and the spent output script is not always available in the rescan context.
So an outpoint must _always_ be specified when registering a spend
notification for a Taproot output.</p></dd><dt class="param">script</dt><dd class="cmt"><p>
The output script for the outpoint above. This will be used by light clients
to match block filters. If the outpoint is set to a zero outpoint, then a
spend notification will be requested for this script instead.</p></dd><dt class="param">heightHint</dt><dd class="cmt"><p>
The earliest height in the chain for which the outpoint/output script could
have been spent. This should in most cases be set to the broadcast height of
Deploy website Deploy website version based on dbd54ca55f9cf28ebd4388a30da85f2a1ff48605
2022-11-16 18:32:38 +00:00
the outpoint/output script.</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="../chainrpc/SpendRequest.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.10/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.10/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="../chainrpc/SpendRequest.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.10/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="../chainrpc/SpendRequest.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.10/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.10/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="../chainrpc/SpendRequest.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="chainrpc.SpendRequest#clearOutpoint" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="clearOutpoint:chainrpc.SpendRequest" class="anchorToMember"></a><a id="clearOutpoint:SpendRequest" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/SpendRequest.html#clearOutpoint:chainrpc.SpendRequest" title="Permalink"><i class="material-icons"
Reference in a new issue Copy permalink