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

50 lines
55 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 ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
var toRoot = '../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 current" name="_root_.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"><span class="name">chainrpc</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="current-entities indented1"><a href="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="ConfEvent.html" title="" class="
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The hash of the block.</p></dd><dt class="param">height</dt><dd class="cmt"><p>
The height of the block.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ChainNotifier" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ChainNotifierextendsAnyRef" class="anchorToMember"></a><a id="ChainNotifier:ChainNotifier" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ChainNotifier.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="ChainNotifier.html" title="ChainNotifier is a service that can be used to get information about the chain backend by registering notifiers for chain events."><span class="name">ChainNotifier</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><p class="shortcomment cmt">ChainNotifier is a service that can be used to get information about the
chain backend by registering notifiers for chain events.</p><div class="fullcomment"><div class="comment cmt"><p>ChainNotifier is a service that can be used to get information about the
chain backend by registering notifiers for chain events.
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ChainNotifierClient" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ChainNotifierClientextendsChainNotifierwithChainNotifierClientPowerApiwithAkkaGrpcClient" class="anchorToMember"></a><a id="ChainNotifierClient:ChainNotifierClient" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ChainNotifierClient.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="ChainNotifierClient.html" title=""><span class="name">ChainNotifierClient</span></a><span class="result"> extends <a href="ChainNotifier.html" name="chainrpc.ChainNotifier" id="chainrpc.ChainNotifier" class="extype">ChainNotifier</a> with <a href="ChainNotifierClientPowerApi.html" name="chainrpc.ChainNotifierClientPowerApi" id="chainrpc.ChainNotifierClientPowerApi" class="extype">ChainNotifierClientPowerApi</a> with <a href="https://doc.akka.io/api/akka-grpc/2.1.6/akka/grpc/akka/grpc/scaladsl/AkkaGrpcClient.html#akka.grpc.scaladsl.AkkaGrpcClient" name="akka.grpc.scaladsl.AkkaGrpcClient" id="akka.grpc.scaladsl.AkkaGrpcClient" class="extype">AkkaGrpcClient</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ChainNotifierClientPowerApi" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="ChainNotifierClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="ChainNotifierClientPowerApi:ChainNotifierClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ChainNotifierClientPowerApi.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="ChainNotifierClientPowerApi.html" title=""><span class="name">ChainNotifierClientPowerApi</span></a><span class="result"> extends <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ConfDetails" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ConfDetailsextendsGeneratedMessagewithUpdatable[chainrpc.ConfDetails]withProductwithSerializable" class="anchorToMember"></a><a id="ConfDetails:ConfDetails" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ConfDetails.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ConfDetails.html" title=""><span class="name">ConfDetails</span></a><span class="params">(<span name="rawTx">rawTx: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="blockHash">blockHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span na
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The raw bytes of the confirmed transaction.</p></dd><dt class="param">blockHash</dt><dd class="cmt"><p>
The hash of the block in which the confirmed transaction was included in.</p></dd><dt class="param">blockHeight</dt><dd class="cmt"><p>
The height of the block in which the confirmed transaction was included
in.</p></dd><dt class="param">txIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
The index of the confirmed transaction within the block.</p></dd><dt class="param">rawBlock</dt><dd class="cmt"><p>
The raw bytes of the block that mined the transaction. Only included if
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
include_block was set in the request.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ConfEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ConfEventextendsGeneratedMessagewithUpdatable[chainrpc.ConfEvent]withProductwithSerializable" class="anchorToMember"></a><a id="ConfEvent:ConfEvent" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ConfEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ConfEvent.html" title=""><span class="name">ConfEvent</span></a><span class="params">(<span name="event">event: <a href="ConfEvent$$Event.html" name="chainrpc.ConfEvent.Event" id="chainrpc.ConfEvent.Event" class="extype">Event</a> = <span class="symbol"><span class="name"><a href="">chainrpc.ConfEvent.Event.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="ConfEvent.html" name="chainrpc.ConfEvent" id="chainrpc.ConfEvent" class="extype">ConfEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ConfRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ConfRequestextendsGeneratedMessagewithUpdatable[chainrpc.ConfRequest]withProductwithSerializable" class="anchorToMember"></a><a id="ConfRequest:ConfRequest" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ConfRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="ConfRequest.html" title=""><span class="name">ConfRequest</span></a><span class="params">(<span name="txid">txid: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="script">script: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="numConfs">numConfs: <a href="../org/bitcoins/core/
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The transaction hash for which we should request a confirmation notification
for. If set to a hash of all zeros, then the confirmation notification will
be requested for the script instead.</p></dd><dt class="param">script</dt><dd class="cmt"><p>
An output script within a transaction with the hash above which will be used
by light clients to match block filters. If the transaction hash is set to a
hash of all zeros, then a confirmation notification will be requested for
this script instead.</p></dd><dt class="param">numConfs</dt><dd class="cmt"><p>
The number of desired confirmations the transaction/output script should
reach before dispatching a confirmation notification.</p></dd><dt class="param">heightHint</dt><dd class="cmt"><p>
The earliest height in the chain for which the transaction/output script
could have been included in a block. This should in most cases be set to the
Deploy website Deploy website version based on 08757d536f98dc1fadf6c77458a16c7c021160cd
2023-03-30 20:10:21 +00:00
broadcast height of the transaction/output script.</p></dd><dt class="param">includeBlock</dt><dd class="cmt"><p>
If true, then the block that mines the specified txid/script will be
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
included in eventual the notification event.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.Outpoint" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="OutpointextendsGeneratedMessagewithUpdatable[chainrpc.Outpoint]withProductwithSerializable" class="anchorToMember"></a><a id="Outpoint:Outpoint" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/Outpoint.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Outpoint.html" title=""><span class="name">Outpoint</span></a><span class="params">(<span name="hash">hash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="index">index: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">chainrpc.Outpoint._typemapper_index.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="Outpoint.html" name="chainrpc.Outpoint" id="chainrpc.Outpoint" class="extype">Outpoint</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">hash</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The hash of the transaction.</p></dd><dt class="param">index</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The index of the output within the transaction.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.Reorg" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ReorgextendsGeneratedMessagewithUpdatable[chainrpc.Reorg]withProductwithSerializable" class="anchorToMember"></a><a id="Reorg:Reorg" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/Reorg.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="Reorg.html" title="TODO(wilmer): need to know how the client will use this first."><span class="name">Reorg</span></a><span class="params">(<span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="Reorg.html" name="chainrpc.Reorg" id="chainrpc.Reorg" class="extype">Reorg</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt">TODO(wilmer): need to know how the client will use this first.</p><div class="fullcomment"><div class="comment cmt"><p>TODO(wilmer): need to know how the client will use this first.
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.SpendDetails" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SpendDetailsextendsGeneratedMessagewithUpdatable[chainrpc.SpendDetails]withProductwithSerializable" class="anchorToMember"></a><a id="SpendDetails:SpendDetails" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/SpendDetails.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SpendDetails.html" title=""><span class="name">SpendDetails</span></a><span class="params">(<span name="spendingOutpoint">spendingOutpoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="Outpoint.html" name="chainrpc.Outpoint" id="chainrpc.Outpoint" class="extype">Outpoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="rawSpendingTx">rawSpendingTx: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="spendingTxHash">spendingTxHash: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="spendingInputIndex">spendingInputIndex: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">chainrpc.SpendDetails._typemapper_spendingInputIndex.toCustom(0)</a></span></span></span>, <span name="spendingHeight">spendingHeight: <a href="../org/bitcoins/core/number/UInt32.html" name="org.bitcoins.core.number.UInt32" id="org.bitcoins.core.number.UInt32" class="extype">UInt32</a> = <span class="defval"><span class="name"><a href="">chainrpc.SpendDetails._typemapper_spendingHeight.toCustom(0)</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SpendDetails.html" name="chainrpc.SpendDetails" id="chainrpc.SpendDetails" class="extype">SpendDetails</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><p class="shortcomment cmt"></p>
Deploy website Deploy website version based on ef3bfed1dc061c51676c4ea03550beb790e571a5
2022-08-09 12:08:55 +00:00
The outpoint was that spent.</p></dd><dt class="param">rawSpendingTx</dt><dd class="cmt"><p>
The raw bytes of the spending transaction.</p></dd><dt class="param">spendingTxHash</dt><dd class="cmt"><p>
The hash of the spending transaction.</p></dd><dt class="param">spendingInputIndex</dt><dd class="cmt"><p>
The input of the spending transaction that fulfilled the spend request.</p></dd><dt class="param">spendingHeight</dt><dd class="cmt"><p>
Deploy website Deploy website version based on ebe98959ed68472208a6bf13485501ce48b7b4bd
2023-06-08 16:02:22 +00:00
The height at which the spending transaction was included in a block.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.SpendEvent" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SpendEventextendsGeneratedMessagewithUpdatable[chainrpc.SpendEvent]withProductwithSerializable" class="anchorToMember"></a><a id="SpendEvent:SpendEvent" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/SpendEvent.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SpendEvent.html" title=""><span class="name">SpendEvent</span></a><span class="params">(<span name="event">event: <a href="SpendEvent$$Event.html" name="chainrpc.SpendEvent.Event" id="chainrpc.SpendEvent.Event" class="extype">Event</a> = <span class="symbol"><span class="name"><a href="">chainrpc.SpendEvent.Event.Empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SpendEvent.html" name="chainrpc.SpendEvent" id="chainrpc.SpendEvent" class="extype">SpendEvent</a>] with <a href="https://www.scala-lang.org/api/2.13.11/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.SpendRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SpendRequestextendsGeneratedMessagewithUpdatable[chainrpc.SpendRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SpendRequest:SpendRequest" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/SpendRequest.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="SpendRequest.html" title=""><span class="name">SpendRequest</span></a><span class="params">(<span name="outpoint">outpoint: <a href="https://www.scala-lang.org/api/2.13.11/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="Outpoint.html" name="chainrpc.Outpoint" id="chainrpc.Outpoint" class="extype">Outpoint</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="script">script: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.21.1/com/google/protobuf/ByteString.html#com.google.protobuf.ByteString" name="com.google.protobuf.ByteString" id="com.google.protobuf.ByteString" class="extype">ByteString</a> = <span class="defval"><span class="name"><a href="../com/index.html">_root_.com.google.protobuf.ByteString.EMPTY</a></span></span></span>, <span name="heightHint
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 26595ab3acb177d2c40470d01144d283a0598ca7
2022-09-08 00:31:00 +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></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="chainrpc.BlockEpoch" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="BlockEpoch" class="anchorToMember"></a><a id="BlockEpoch:BlockEpoch" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/BlockEpoch$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="BlockEpoch$.html" title=""><span class="name">BlockEpoch</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="BlockEpoch.html" name="chainrpc.BlockEpoch" id="chainrpc.BlockEpoch" class="extype">BlockEpoch</a>]</span></span></li><li class="indented0 " name="chainrpc.ChainNotifier" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChainNotifier" class="anchorToMember"></a><a id="ChainNotifier:ChainNotifier" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ChainNotifier$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="ChainNotifier$.html" title=""><span class="name">ChainNotifier</span></a><span class="result"> extends <a href="https://doc.akka.io/api/akka-grpc/2.1.6/akka/grpc/akka/grpc/ServiceDescription.html#akka.grpc.ServiceDescription" name="akka.grpc.ServiceDescription" id="akka.grpc.ServiceDescription" class="extype">ServiceDescription</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ChainNotifierClient" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChainNotifierClient" class="anchorToMember"></a><a id="ChainNotifierClient:ChainNotifierClient" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ChainNotifierClient$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="ChainNotifierClient$.html" title=""><span class="name">ChainNotifierClient</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ChainNotifierHandler" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ChainNotifierHandler" class="anchorToMember"></a><a id="ChainNotifierHandler:ChainNotifierHandler" class="anchorToMember"></a> <span class="permalink"><a href="../chainrpc/ChainNotifierHandler$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="ChainNotifierHandler$.html" title=""><span class="name">ChainNotifierHandler</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@ApiMayChange</span><span class="args">()</span> <span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="chainrpc.ChainnotifierProto" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="ChainnotifierProto" class="anchorToMember"></a><a id="ChainnotifierProto:Ch
Reference in a new issue Copy permalink