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/signrpc/index.html

61 lines
79 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 */
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +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_.signrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="signrpc" class="anchorToMember"></a><a id="signrpc:signrpc" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/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">signrpc</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="DefaultSignerClient$.html" title="" class="object"></a> <a href="DefaultSignerClient.html" title="" class="class"></a><a href="DefaultSignerClient.html" title="">DefaultSignerClient</a></li><li class="current-entities indented1"><a href="InputScript$.html" title="" class="object"></a> <a href="InputScript.html" title="" class="class"></a><a href="InputScript.html" title="">InputScript</a></li><li class="current-entities indented1"><a href="InputScriptResp$.html" title="" class="object"></a> <a href="InputScriptResp.html" title="" class="class"></a><a href="InputScriptResp.html" title="">InputScriptResp</a></li><li class="current-entities indented1"><a href="KeyDescriptor$.html" title="" class="object"></a> <a href="KeyDescriptor.html" title="" class="class"></a><a href="KeyDescriptor.html" title="">KeyDescriptor</a></li><li class="current-entities indented1"><a href="KeyLocator$.html" title="" class="object"></a> <a href="KeyLocator.html" title="" class="class"></a><a href="KeyLocator.html" title="">KeyLocator</a></li><li class="current-entities indented1"><a href="SharedKeyRequest$.html" title="" class="object"></a> <a href="SharedKeyRequest.html" title="" class="class"></a><a href="SharedKeyRequest.html" title="">SharedKeyRequest</a></li><li class="current-entities indented1"><a href="SharedKeyResponse$.html" title="" class="object"></a> <a href="SharedKeyResponse.html" title="" class="class"></a><a href="SharedKeyResponse.html" title="">SharedKeyResponse</a></li><li class="current-entities indented1"><a href="SignDescriptor$.html" title="" class="object"></a> <a href="SignDescriptor.html" title="" class="class"></a><a href="SignDescriptor.html" title="">SignDescriptor</a></li><li class="current-entities indented1"><a href="SignMessageReq$.html" title="" class="object"></a> <a href="SignMessageReq.html" title="" class="cla
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The serializes witness stack for the specified input.</p></dd><dt class="param">sigScript</dt><dd class="cmt"><p>
The optional sig script for the specified witness that will only be set if
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
the input specified is a nested p2sh witness program.</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="signrpc.InputScriptResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InputScriptRespextendsGeneratedMessagewithUpdatable[signrpc.InputScriptResp]withProductwithSerializable" class="anchorToMember"></a><a id="InputScriptResp:InputScriptResp" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/InputScriptResp.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="InputScriptResp.html" title=""><span class="name">InputScriptResp</span></a><span class="params">(<span name="inputScripts">inputScripts: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="InputScript.html" name="signrpc.InputScript" id="signrpc.InputScript" class="extype">InputScript</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="InputScriptResp.html" name="signrpc.InputScriptResp" id="signrpc.InputScriptResp" class="extype">InputScriptResp</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">inputScripts</dt><dd class="cmt"><p>
The set of fully valid input scripts requested.</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="signrpc.KeyDescriptor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="KeyDescriptorextendsGeneratedMessagewithUpdatable[signrpc.KeyDescriptor]withProductwithSerializable" class="anchorToMember"></a><a id="KeyDescriptor:KeyDescriptor" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/KeyDescriptor.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="KeyDescriptor.html" title=""><span class="name">KeyDescriptor</span></a><span class="params">(<span name="rawKeyBytes">rawKeyBytes: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="keyLoc">keyLoc: <a href="https://www.scala-lang.org/api/2.13.6/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyLocator.html" name="signrpc.KeyLocator" id="signrpc.KeyLocator" class="extype">KeyLocator</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="KeyDescriptor.html" name="signrpc.KeyDescriptor" id="signrpc.KeyDescriptor" class="extype">KeyDescriptor</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">rawKeyBytes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The raw bytes of the key being identified. Either this or the KeyLocator
must be specified.</p></dd><dt class="param">keyLoc</dt><dd class="cmt"><p>
The key locator that identifies which key to use for signing. Either this
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
or the raw bytes of the target key must be specified.</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="signrpc.KeyLocator" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="KeyLocatorextendsGeneratedMessagewithUpdatable[signrpc.KeyLocator]withProductwithSerializable" class="anchorToMember"></a><a id="KeyLocator:KeyLocator" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/KeyLocator.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="KeyLocator.html" title=""><span class="name">KeyLocator</span></a><span class="params">(<span name="keyFamily">keyFamily: <a href="https://www.scala-lang.org/api/2.13.6/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="keyIndex">keyIndex: <a href="https://www.scala-lang.org/api/2.13.6/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="KeyLocator.html" name="signrpc.KeyLocator" id="signrpc.KeyLocator" class="extype">KeyLocator</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">keyFamily</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The family of key being identified.</p></dd><dt class="param">keyIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
The precise index of the key being identified.</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="signrpc.SharedKeyRequest" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SharedKeyRequestextendsGeneratedMessagewithUpdatable[signrpc.SharedKeyRequest]withProductwithSerializable" class="anchorToMember"></a><a id="SharedKeyRequest:SharedKeyRequest" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SharedKeyRequest.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="SharedKeyRequest.html" title=""><span class="name">SharedKeyRequest</span></a><span class="params">(<span name="ephemeralPubkey">ephemeralPubkey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="keyLoc">keyLoc: <a href="https://www.scala-lang.org/api/2.13.6/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyLocator.html" name="signrpc.KeyLocator" id="signrpc.KeyLocator" class="extype">KeyLocator</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="keyDesc">keyDesc: <a href="https://www.scala-lang.org/api/2.13.6/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyDescriptor.html" name="signrpc.KeyDescriptor" id="signrpc.KeyDescriptor" class="extype">KeyDescriptor</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SharedKeyRequest.html" name="signrpc.SharedKeyRequest" id="signrpc.SharedKeyRequest" class="extype">SharedKeyRequest</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">ephemeralPubkey</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The ephemeral public key to use for the DH key derivation.</p></dd><dt class="param">keyLoc</dt><dd class="cmt"><p>
Deprecated. The optional key locator of the local key that should be used.
If this parameter is not set then the node's identity private key will be
used.</p></dd><dt class="param">keyDesc</dt><dd class="cmt"><p>
A key descriptor describes the key used for performing ECDH. Either a key
locator or a raw public key is expected, if neither is supplied, defaults to
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
the node's identity private key.</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="signrpc.SharedKeyResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SharedKeyResponseextendsGeneratedMessagewithUpdatable[signrpc.SharedKeyResponse]withProductwithSerializable" class="anchorToMember"></a><a id="SharedKeyResponse:SharedKeyResponse" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SharedKeyResponse.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="SharedKeyResponse.html" title=""><span class="name">SharedKeyResponse</span></a><span class="params">(<span name="sharedKey">sharedKey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SharedKeyResponse.html" name="signrpc.SharedKeyResponse" id="signrpc.SharedKeyResponse" class="extype">SharedKeyResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">sharedKey</dt><dd class="cmt"><p>
The shared public key, hashed with sha256.</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="signrpc.SignDescriptor" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignDescriptorextendsGeneratedMessagewithUpdatable[signrpc.SignDescriptor]withProductwithSerializable" class="anchorToMember"></a><a id="SignDescriptor:SignDescriptor" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignDescriptor.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="SignDescriptor.html" title=""><span class="name">SignDescriptor</span></a><span class="params">(<span name="keyDesc">keyDesc: <a href="https://www.scala-lang.org/api/2.13.6/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyDescriptor.html" name="signrpc.KeyDescriptor" id="signrpc.KeyDescriptor" class="extype">KeyDescriptor</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="singleTweak">singleTweak: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="doubleTweak">doubleTweak: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="witnessScript">witnessScript: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="output">output: <a href="https://www.scala-lang.org/api/2.13.6/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="TxOut.html" name="signrpc.TxOut" id="signrpc.TxOut" class="extype">TxOut</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="sighash">sighash: <a href="https://www.scala-lang.org/api/2.13.6/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="inputIndex">inputIndex: <a href="https://www.scala-lang.org/api/2.13.6/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a> = <span class="symbol">0</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Up
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A descriptor that precisely describes *which* key to use for signing. This
may provide the raw public key directly, or require the Signer to re-derive
the key according to the populated derivation path.
Note that if the key descriptor was obtained through walletrpc.DeriveKey,
then the key locator MUST always be provided, since the derived keys are not
persisted unlike with DeriveNextKey.</p></dd><dt class="param">singleTweak</dt><dd class="cmt"><p>
A scalar value that will be added to the private key corresponding to the
above public key to obtain the private key to be used to sign this input.
This value is typically derived via the following computation:
derivedKey = privkey + sha256(perCommitmentPoint || pubKey) mod N</p></dd><dt class="param">doubleTweak</dt><dd class="cmt"><p>
A private key that will be used in combination with its corresponding
private key to derive the private key that is to be used to sign the target
input. Within the Lightning protocol, this value is typically the
commitment secret from a previously revoked commitment transaction. This
value is in combination with two hash values, and the original private key
to derive the private key to be used when signing.
k = (privKey*sha256(pubKey || tweakPub) +
tweakPriv*sha256(tweakPub || pubKey)) mod N</p></dd><dt class="param">witnessScript</dt><dd class="cmt"><p>
The full script required to properly redeem the output. This field will
only be populated if a p2wsh or a p2sh output is being signed.</p></dd><dt class="param">output</dt><dd class="cmt"><p>
A description of the output being spent. The value and script MUST be
provided.</p></dd><dt class="param">sighash</dt><dd class="cmt"><p>
The target sighash type that should be used when generating the final
sighash, and signature.</p></dd><dt class="param">inputIndex</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
The target input within the transaction that should be signed.</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="signrpc.SignMessageReq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignMessageReqextendsGeneratedMessagewithUpdatable[signrpc.SignMessageReq]withProductwithSerializable" class="anchorToMember"></a><a id="SignMessageReq:SignMessageReq" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignMessageReq.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="SignMessageReq.html" title=""><span class="name">SignMessageReq</span></a><span class="params">(<span name="msg">msg: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="keyLoc">keyLoc: <a href="https://www.scala-lang.org/api/2.13.6/scala/Option.html#scala.Option" name="scala.Option" id="scala.Option" class="extype">Option</a>[<a href="KeyLocator.html" name="signrpc.KeyLocator" id="signrpc.KeyLocator" class="extype">KeyLocator</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.None</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SignMessageReq.html" name="signrpc.SignMessageReq" id="signrpc.SignMessageReq" class="extype">SignMessageReq</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">msg</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The message to be signed.</p></dd><dt class="param">keyLoc</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
The key locator that identifies which key to use for signing.</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="signrpc.SignMessageResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignMessageRespextendsGeneratedMessagewithUpdatable[signrpc.SignMessageResp]withProductwithSerializable" class="anchorToMember"></a><a id="SignMessageResp:SignMessageResp" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignMessageResp.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="SignMessageResp.html" title=""><span class="name">SignMessageResp</span></a><span class="params">(<span name="signature">signature: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SignMessageResp.html" name="signrpc.SignMessageResp" id="signrpc.SignMessageResp" class="extype">SignMessageResp</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">signature</dt><dd class="cmt"><p>
The signature for the given message in the fixed-size LN wire format.</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="signrpc.SignReq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignReqextendsGeneratedMessagewithUpdatable[signrpc.SignReq]withProductwithSerializable" class="anchorToMember"></a><a id="SignReq:SignReq" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignReq.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="SignReq.html" title=""><span class="name">SignReq</span></a><span class="params">(<span name="rawTxBytes">rawTxBytes: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="signDescs">signDescs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="SignDescriptor.html" name="signrpc.SignDescriptor" id="signrpc.SignDescriptor" class="extype">SignDescriptor</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SignReq.html" name="signrpc.SignReq" id="signrpc.SignReq" class="extype">SignReq</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">rawTxBytes</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The raw bytes of the transaction to be signed.</p></dd><dt class="param">signDescs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
A set of sign descriptors, for each input to be signed.</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="signrpc.SignResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SignRespextendsGeneratedMessagewithUpdatable[signrpc.SignResp]withProductwithSerializable" class="anchorToMember"></a><a id="SignResp:SignResp" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignResp.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="SignResp.html" title=""><span class="name">SignResp</span></a><span class="params">(<span name="rawSigs">rawSigs: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="SignResp.html" name="signrpc.SignResp" id="signrpc.SignResp" class="extype">SignResp</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">rawSigs</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
A set of signatures realized in a fixed 64-byte format ordered in ascending
input order.</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="signrpc.Signer" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SignerextendsAnyRef" class="anchorToMember"></a><a id="Signer:Signer" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/Signer.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="Signer.html" title="Signer is a service that gives access to the signing functionality of the daemon's wallet."><span class="name">Signer</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">Signer is a service that gives access to the signing functionality of the
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
daemon's wallet.</p></li><li class="indented0 " name="signrpc.SignerClient" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SignerClientextendsSignerwithSignerClientPowerApiwithAkkaGrpcClient" class="anchorToMember"></a><a id="SignerClient:SignerClient" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignerClient.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="SignerClient.html" title=""><span class="name">SignerClient</span></a><span class="result"> extends <a href="Signer.html" name="signrpc.Signer" id="signrpc.Signer" class="extype">Signer</a> with <a href="SignerClientPowerApi.html" name="signrpc.SignerClientPowerApi" id="signrpc.SignerClientPowerApi" class="extype">SignerClientPowerApi</a> with <a href="https://doc.akka.io/api/akka-grpc/2.0.0/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></li><li class="indented0 " name="signrpc.SignerClientPowerApi" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="SignerClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="SignerClientPowerApi:SignerClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/SignerClientPowerApi.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="SignerClientPowerApi.html" title=""><span class="name">SignerClientPowerApi</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></li><li class="indented0 " name="signrpc.TxOut" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="TxOutextendsGeneratedMessagewithUpdatable[signrpc.TxOut]withProductwithSerializable" class="anchorToMember"></a><a id="TxOut:TxOut" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/TxOut.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="TxOut.html" title=""><span class="name">TxOut</span></a><span class="params">(<span name="value">value: <a href="https://www.scala-lang.org/api/2.13.6/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a> = <span class="symbol">0L</span></span>, <span name="pkScript">pkScript: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="TxOut.html" name="signrpc.TxOut" id="signrpc.TxOut" class="exty
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The value of the output being spent.</p></dd><dt class="param">pkScript</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
The script of the output being spent.</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="signrpc.VerifyMessageReq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VerifyMessageReqextendsGeneratedMessagewithUpdatable[signrpc.VerifyMessageReq]withProductwithSerializable" class="anchorToMember"></a><a id="VerifyMessageReq:VerifyMessageReq" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/VerifyMessageReq.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="VerifyMessageReq.html" title=""><span class="name">VerifyMessageReq</span></a><span class="params">(<span name="msg">msg: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="signature">signature: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="pubkey">pubkey: <a href="https://javadoc.io/page/com.google.protobuf/protobuf-java/3.15.8/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="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="VerifyMessageReq.html" name="signrpc.VerifyMessageReq" id="signrpc.VerifyMessageReq" class="extype">VerifyMessageReq</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">msg</dt><dd class="cmt"><p>
Deploy website Deploy website version based on a2911f31edf44a7b90995fbc7d6d0074b3f0cde2
2021-05-01 18:33:34 +00:00
The message over which the signature is to be verified.</p></dd><dt class="param">signature</dt><dd class="cmt"><p>
The fixed-size LN wire encoded signature to be verified over the given
message.</p></dd><dt class="param">pubkey</dt><dd class="cmt"><p>
Deploy website Deploy website version based on 0f9024b7ae7d8a66cc390be9141957c492bb908d
2021-06-08 16:14:27 +00:00
The public key the signature has to be valid for.</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="signrpc.VerifyMessageResp" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="VerifyMessageRespextendsGeneratedMessagewithUpdatable[signrpc.VerifyMessageResp]withProductwithSerializable" class="anchorToMember"></a><a id="VerifyMessageResp:VerifyMessageResp" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/VerifyMessageResp.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="VerifyMessageResp.html" title=""><span class="name">VerifyMessageResp</span></a><span class="params">(<span name="valid">valid: <a href="https://www.scala-lang.org/api/2.13.6/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a> = <span class="symbol">false</span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/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.3/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.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="VerifyMessageResp.html" name="signrpc.VerifyMessageResp" id="signrpc.VerifyMessageResp" class="extype">VerifyMessageResp</a>] with <a href="https://www.scala-lang.org/api/2.13.6/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">valid</dt><dd class="cmt"><p>
Whether the signature was valid over the given message.</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="signrpc.DefaultSignerClient" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="DefaultSignerClient" class="anchorToMember"></a><a id="DefaultSignerClient:DefaultSignerClient" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/DefaultSignerClient$.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="DefaultSignerClient$.html" title=""><span class="name">DefaultSignerClient</span></a></span></li><li class="indented0 " name="signrpc.InputScript" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InputScript" class="anchorToMember"></a><a id="InputScript:InputScript" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/InputScript$.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="InputScript$.html" title=""><span class="name">InputScript</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="InputScript.html" name="signrpc.InputScript" id="signrpc.InputScript" class="extype">InputScript</a>] with <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></span></span></li><li class="indented0 " name="signrpc.InputScriptResp" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="InputScriptResp" class="anchorToMember"></a><a id="InputScriptResp:InputScriptResp" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/InputScriptResp$.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="InputScriptResp$.html" title=""><span class="name">InputScriptResp</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="InputScriptResp.html" name="signrpc.InputScriptResp" id="signrpc.InputScriptResp" class="extype">InputScriptResp</a>] with <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></span></span></li><li class="indented0 " name="signrpc.KeyDescriptor" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="KeyDescriptor" class="anchorToMember"></a><a id="KeyDescriptor:KeyDescriptor" class="anchorToMember"></a> <span class="permalink"><a href="../signrpc/KeyDescriptor$.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="KeyDescriptor$.html" title=""><span class="name">KeyDescriptor</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompa
Reference in a new issue Copy permalink