var toRoot = '../';</script></head><body><divid="search"><spanid="doc-title"><spanid="doc-version"></span></span><spanclass="close-results"><spanclass="left"><</span> Back</span><divid="textfilter"><spanclass="input"><inputautocapitalize="none"placeholder="Search"id="index-input"type="text"accesskey="/"/><iclass="clear material-icons"></i><iid="search-icon"class="material-icons"></i></span></div></div><divid="search-results"><divid="search-progress"><divid="progress-fill"></div></div><divid="results-content"><divid="entity-results"></div><divid="member-results"></div></div></div><divid="content-scroll-container"style="-webkit-overflow-scrolling: touch;"><divid="content-container"style="-webkit-overflow-scrolling: touch;"><divid="subpackage-spacer"><divid="packages"><h1>Packages</h1><ul><liclass="indented0 "name="_root_.root"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="_root_"class="anchorToMember"></a><aid="root:_root_"class="anchorToMember"></a><spanclass="permalink"><ahref="../index.html"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">package</span></span><spanclass="symbol"><ahref="../index.html"title=""><spanclass="name">root</span></a></span><divclass="fullcomment"><dlclass="attributes block"><dt>Definition Classes</dt><dd><ahref="../index.html"name="_root_"id="_root_"class="extype">root</a></dd></dl></div></li><liclass="indented1 "name="_root_.chainrpc"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="chainrpc"class="anchorToMember"></a><aid="chainrpc:chainrpc"class="anchorToMember"></a><spanclass="permalink"><ahref="../chainrpc/index.html"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">package</span></span><spanclass="symbol"><ahref="index.html"title=""><spanclass="name">chainrpc</span></a></span><divclass="fullcomment"><dlclass="attributes block"><dt>Definition Classes</dt><dd><ahref="../index.html"name="_root_"id="_root_"class="extype">root</a></dd></dl></div></li><liclass="current-entities indented1"><ahref="BlockEpoch$.html"title=""class="object"></a><ahref="BlockEpoch.html"title=""class="class"></a><ahref="BlockEpoch.html"title="">BlockEpoch</a></li><liclass="current-entities indented1"><ahref="ChainNotifier$.html"title=""class="object"></a><ahref="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><ahref="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><liclass="current-entities indented1"><ahref="ChainNotifierClient$.html"title=""class="object"></a><ahref=""title=""class="trait"></a><ahref=""title="">ChainNotifierClient</a></li><liclass="current-entities indented1"><spanclass="separator"></span><ahref="ChainNotifierClientPowerApi.html"title=""class="trait"></a><ahref="ChainNotifierClientPowerApi.html"title="">ChainNotifierClientPowerApi</a></li><liclass="current-entities indented1"><spanclass="separator"></span><ahref="ChainNotifierHandler$.html"title=""class="object"></a><ahref="ChainNotifierHandler$.html"title="">ChainNotifierHandler</a></li><liclass="current-entities indented1"><spanclass="separator"></span><ahref="ChainnotifierProto$.html"title=""class="object"></a><ahref="ChainnotifierProto$.html"title="">ChainnotifierProto</a></li><liclass="current-entities indented1"><ahref="ConfDetails$.html"title=""class="object"></a><ahref="ConfDetails.html"title=""class="class"></a><ahref="ConfDetails.html"title="">ConfDetails</a></li><liclass="current-entities indented1"><ahref="ConfEvent$.html"title=""class="object"></a><ahref="ConfEvent.html"title=""class="class"></a><ahref="C
registers an intent for a client to be notified of blocks in the chain.</p><divclass="fullcomment"><divclass="comment cmt"><p>RegisterBlockEpochNtfn is a synchronous response-streaming RPC that
registers an intent for a client to be notified of blocks in the chain. The
stream will return a hash and height tuple of a block for each new/stale
block in the chain. It is the client's responsibility to determine whether
the tuple returned is for a new or stale block in the chain.
A client can also request a historical backlog of blocks from a particular
point. This allows clients to be idempotent by ensuring that they do not
missing processing a single block within the chain.
</p></div><dlclass="attributes block"><dt>Definition Classes</dt><dd><ahref="ChainNotifier.html"name="chainrpc.ChainNotifier"id="chainrpc.ChainNotifier"class="extype">ChainNotifier</a></dd></dl></div></li><liclass="indented0 "name="chainrpc.ChainNotifier#registerConfirmationsNtfn"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="registerConfirmationsNtfn(in:chainrpc.ConfRequest):org.apache.pekko.stream.scaladsl.Source[chainrpc.ConfEvent,org.apache.pekko.NotUsed]"class="anchorToMember"></a><aid="registerConfirmationsNtfn(ConfRequest):Source[ConfEvent,NotUsed]"class="anchorToMember"></a><spanclass="permalink"><ahref="../chainrpc/ChainNotifierClient.html#registerConfirmationsNtfn(in:chainrpc.ConfRequest):org.apache.pekko.stream.scaladsl.Source[chainrpc.ConfEvent,org.apache.pekko.NotUsed]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">registerConfirmationsNtfn</span><spanclass="params">(<spanname="in">in: <ahref="ConfRequest.html"name="chainrpc.ConfRequest"id="chainrpc.ConfRequest"class="extype">ConfRequest</a></span>)</span><spanclass="result">: <ahref="https://pekko.apache.org/api/pekko/1.0.2/org/apache/pekko/stream/scaladsl/Source.html#org.apache.pekko.stream.scaladsl.Source"name="org.apache.pekko.stream.scaladsl.Source"id="org.apache.pekko.stream.scaladsl.Source"class="extype">Source</a>[<ahref="ConfEvent.html"name="chainrpc.ConfEvent"id="chainrpc.ConfEvent"class="extype">ConfEvent</a>, <ahref="https://pekko.apache.org/api/pekko/1.0.2/org/apache/pekko/NotUsed.html#org.apache.pekko.NotUsed"name="org.apache.pekko.NotUsed"id="org.apache.pekko.NotUsed"class="extype">NotUsed</a>]</span></span><pclass="shortcomment cmt">RegisterConfirmationsNtfn is a synchronous response-streaming RPC that
registers an intent for a client to be notified once a confirmation request
has reached its required number of confirmations on-chain.</p><divclass="fullcomment"><divclass="comment cmt"><p>RegisterConfirmationsNtfn is a synchronous response-streaming RPC that
registers an intent for a client to be notified once a confirmation request
has reached its required number of confirmations on-chain.
A confirmation request must have a valid output script. It is also possible
to give a transaction ID. If the transaction ID is not set, a notification
is sent once the output script confirms. If the transaction ID is also set,
a notification is sent once the output script confirms in the given
</p></div><dlclass="attributes block"><dt>Definition Classes</dt><dd><ahref="ChainNotifier.html"name="chainrpc.ChainNotifier"id="chainrpc.ChainNotifier"class="extype">ChainNotifier</a></dd></dl></div></li><liclass="indented0 "name="chainrpc.ChainNotifier#registerSpendNtfn"group="Ungrouped"fullComment="yes"data-isabs="true"visbl="pub"><aid="registerSpendNtfn(in:chainrpc.SpendRequest):org.apache.pekko.stream.scaladsl.Source[chainrpc.SpendEvent,org.apache.pekko.NotUsed]"class="anchorToMember"></a><aid="registerSpendNtfn(SpendRequest):Source[SpendEvent,NotUsed]"class="anchorToMember"></a><spanclass="permalink"><ahref="../chainrpc/ChainNotifierClient.html#registerSpendNtfn(in:chainrpc.SpendRequest):org.apache.pekko.stream.scaladsl.Source[chainrpc.SpendEvent,org.apache.pekko.NotUsed]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier">abstract </span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">registerSpendNtfn</span><spanclass="params">(<spanname="in">in: <ahref="SpendRequest.html"name="chainrpc.SpendRequest"id="chainrpc.SpendRequest"class="extype">SpendRequest</a></span>)</span><spanclass="result">: <ahref="https://pekko.apache.org/api/pekko/1.0.2/org/apache/pekko/stream/scaladsl/Source.html#org.apache.pekko.stream.scaladsl.Source"name="org.apache.pekko.stream.scaladsl.Source"id="org.apache.pekko.stream.scaladsl.Source"class="extype">Source</a>[<ahref="SpendEvent.html"name="chainrpc.SpendEvent"id="chainrpc.SpendEvent"class="extype">SpendEvent</a>, <ahref="https://pekko.apache.org/api/pekko/1.0.2/org/apache/pekko/NotUsed.html#org.apache.pekko.NotUsed"name="org.apache.pekko.NotUsed"id="org.apache.pekko.NotUsed"class="extype">NotUsed</a>]</span></span><pclass="shortcomment cmt">RegisterSpendNtfn is a synchronous response-streaming RPC that registers an
intent for a client to be notification once a spend request has been spent
by a transaction that has confirmed on-chain.</p><divclass="fullcomment"><divclass="comment cmt"><p>RegisterSpendNtfn is a synchronous response-streaming RPC that registers an
intent for a client to be notification once a spend request has been spent
by a transaction that has confirmed on-chain.
A client can specify whether the spend request should be for a particular
outpoint or for an output script by specifying a zero outpoint.
</p></div><dlclass="attributes block"><dt>Definition Classes</dt><dd><ahref="ChainNotifierClientPowerApi.html"name="chainrpc.ChainNotifierClientPowerApi"id="chainrpc.ChainNotifierClientPowerApi"class="extype">ChainNotifierClientPowerApi</a></dd></dl></div></li><liclass="indented0 "name="chainrpc.ChainNotifierClientPowerApi#registerConfirmationsNtfn"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="registerConfirmationsNtfn():org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder[chainrpc.ConfRequest,chainrpc.ConfEvent]"class="anchorToMember"></a><aid="registerConfirmationsNtfn():StreamResponseRequestBuilder[ConfRequest,ConfEvent]"class="anchorToMember"></a><spanclass="permalink"><ahref="../chainrpc/ChainNotifierClient.html#registerConfirmationsNtfn():org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder[chainrpc.ConfRequest,chainrpc.ConfEvent]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">registerConfirmationsNtfn</span><spanclass="params">()</span><spanclass="result">: <ahref="https://pekko.apache.org/api/pekko-grpc/1.0.2/org/apache/pekko/grpc/org/apache/pekko/grpc/scaladsl/StreamResponseRequestBuilder.html#org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder"name="org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder"id="org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder"class="extype">StreamResponseRequestBuilder</a>[<ahref="ConfRequest.html"name="chainrpc.ConfRequest"id="chainrpc.ConfRequest"class="extype">ConfRequest</a>, <ahref="ConfEvent.html"name="chainrpc.ConfEvent"id="chainrpc.ConfEvent"class="extype">ConfEvent</a>]</span></span><pclass="shortcomment cmt">Lower level "lifted" version of the method, giving access to request metadata etc.</p><divclass="fullcomment"><divclass="comment cmt"><p>Lower level "lifted" version of the method, giving access to request metadata etc.
</p></div><dlclass="attributes block"><dt>Definition Classes</dt><dd><ahref="ChainNotifierClientPowerApi.html"name="chainrpc.ChainNotifierClientPowerApi"id="chainrpc.ChainNotifierClientPowerApi"class="extype">ChainNotifierClientPowerApi</a></dd></dl></div></li><liclass="indented0 "name="chainrpc.ChainNotifierClientPowerApi#registerSpendNtfn"group="Ungrouped"fullComment="yes"data-isabs="false"visbl="pub"><aid="registerSpendNtfn():org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder[chainrpc.SpendRequest,chainrpc.SpendEvent]"class="anchorToMember"></a><aid="registerSpendNtfn():StreamResponseRequestBuilder[SpendRequest,SpendEvent]"class="anchorToMember"></a><spanclass="permalink"><ahref="../chainrpc/ChainNotifierClient.html#registerSpendNtfn():org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder[chainrpc.SpendRequest,chainrpc.SpendEvent]"title="Permalink"><iclass="material-icons"></i></a></span><spanclass="modifier_kind"><spanclass="modifier"></span><spanclass="kind">def</span></span><spanclass="symbol"><spanclass="name">registerSpendNtfn</span><spanclass="params">()</span><spanclass="result">: <ahref="https://pekko.apache.org/api/pekko-grpc/1.0.2/org/apache/pekko/grpc/org/apache/pekko/grpc/scaladsl/StreamResponseRequestBuilder.html#org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder"name="org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder"id="org.apache.pekko.grpc.scaladsl.StreamResponseRequestBuilder"class="extype">StreamResponseRequestBuilder</a>[<ahref="SpendRequest.html"name="chainrpc.SpendRequest"id="chainrpc.SpendRequest"class="extype">SpendRequest</a>, <ahref="SpendEvent.html"name="chainrpc.SpendEvent"id="chainrpc.SpendEvent"class="extype">SpendEvent</a>]</span></span><pclass="shortcomment cmt">Lower level "lifted" version of the method, giving access to request metadata etc.</p><divclass="fullcomment"><divclass="comment cmt"><p>Lower level "lifted" version of the method, giving access to request metadata etc.
