mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-03-19 21:45:36 +01:00
Code Issues Projects Releases Packages Wiki Activity
bitcoin-s/api/walletrpc/Account.html

51 lines
74 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on fafc564da81cf3fcdc739299a215f0a139dbcb7c
2021-06-21 21:43:03 +00:00
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../lib/jquery.min.js"></script><script type="text/javascript" src="../lib/index.js"></script><script type="text/javascript" src="../index.js"></script><script type="text/javascript" src="../lib/scheduler.js"></script><script type="text/javascript" src="../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.walletrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="walletrpc" class="anchorToMember"></a><a id="walletrpc:walletrpc" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/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">walletrpc</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="current-entities indented1"><a href="Account$.html" title="" class="object"></a> <a href="" title="" class="class"></a><a href="" title="">Account</a></li><li class="current-entities indented1"><a href="AddrRequest$.html" title="" class="object"></a> <a href="AddrRequest.html" title="" class="class"></a><a href="AddrRequest.html" title="">AddrRequest</a></li><li class="current-entities indented1"><a href="AddrResponse$.html" title="" class="object"></a> <a href="AddrResponse.html" title="" class="class"></a><a href="AddrResponse.html" title="">AddrResponse</a></li><li class="current-entities indented1"><a href="AddressType$.html" title="" class="object"></a> <a href="AddressType.html" title="" class="class"></a><a href="AddressType.html" title="">AddressType</a></li><li class="current-entities indented1"><a href="BumpFeeRequest$.html" title="" class="object"></a> <a href="BumpFeeRequest.html" title="" class="class"></a><a href="BumpFeeRequest.html" title="">BumpFeeRequest</a></li><li class="current-entities indented1"><a href="BumpFeeResponse$.html" title="" class="object"></a> <a href="BumpFeeResponse.html" title="" class="class"></a><a href="BumpFeeResponse.html" title="">BumpFeeResponse</a></li><li class="current-entities indented1"><a href="DefaultWalletKitClient$.html" title="" class="object"></a> <a href="DefaultWalletKitClient.html" title="" class="class"></a><a href="DefaultWalletKitClient.html" title="">DefaultWalletKitClient</a></li><li class="current-entities indented1"><a href="EstimateFeeRequest$.html" title="" class="object"></a> <a href="EstimateFeeRequest.html" title="" class="class"></a><a href="EstimateFeeRequest.html" title="">EstimateFeeRequest</a></li><li class="current-entities indented1"><a href="EstimateFeeResponse$.html" title="" class="object"></a> <a href="EstimateFeeResponse.html" title="" class
The name used to identify the account.</p></dd><dt class="param">addressType</dt><dd class="cmt"><p>
The type of addresses the account supports.
AddressType | External Branch | Internal Branch
---------------------------------------------------------------------
WITNESS_PUBKEY_HASH | P2WPKH | P2WPKH
NESTED_WITNESS_PUBKEY_HASH | NP2WPKH | NP2WPKH
HYBRID_NESTED_WITNESS_PUBKEY_HASH | NP2WPKH | P2WPKH</p></dd><dt class="param">extendedPublicKey</dt><dd class="cmt"><p>
The public key backing the account that all keys are derived from
represented as an extended key. This will always be empty for the default
imported account in which single public keys are imported into.</p></dd><dt class="param">masterKeyFingerprint</dt><dd class="cmt"><p>
The fingerprint of the root key from which the account public key was
derived from. This will always be zero for the default imported account in
which single public keys are imported into. The bytes are in big-endian
order.</p></dd><dt class="param">derivationPath</dt><dd class="cmt"><p>
The derivation path corresponding to the account public key. This will
always be empty for the default imported account in which single public keys
are imported into.</p></dd><dt class="param">externalKeyCount</dt><dd class="cmt"><p>
The number of keys derived from the external branch of the account public
key. This will always be zero for the default imported account in which
single public keys are imported into.</p></dd><dt class="param">internalKeyCount</dt><dd class="cmt"><p>
The number of keys derived from the internal branch of the account public
key. This will always be zero for the default imported account in which
single public keys are imported into.</p></dd><dt class="param">watchOnly</dt><dd class="cmt"><p>
Whether the wallet stores private keys for the account.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="" name="walletrpc.Account" id="walletrpc.Account" class="extype">Account</a>], <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>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a>, <a href="https://www.scala-lang.org/api/2.13.6/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a>, <a href="https://www.scala-lang.org/api/2.13.6/scala/Equals.html#scala.Equals" name="scala.Equals" id="scala.Equals" class="extype">Equals</a>, <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <a href="https://www.scala-lang.org/api/2.13.6/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="walletrpc.Account"><span>Account</span></li><li class="in" name="scalapb.lenses.Updatable"><span>Updatable</span></li><li class="in" name="scalapb.GeneratedMessage"><span>GeneratedMessage</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="scala.Product"><span>Product</span></li><li class="in" name="scala.Equals"><span>Equals</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="walletrpc.Account#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(name:String,addressType:walletrpc.AddressType,extendedPublicKey:String,masterKeyFingerprint:com.google.protobuf.ByteString,derivationPath:String,externalKeyCount:Int,internalKeyCount:Int,watchOnly:Boolean,unknownFields:scalapb.UnknownFieldSet):walletrpc.Account" class="anchorToMember"></a><a id="&lt;init&gt;:Account" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/Account.html#&lt;init&gt;(name:String,addressType:walletrpc.AddressType,extendedPublicKey:String,masterKeyFingerprint:com.google.protobuf.ByteString,derivationPath:String,externalKeyCount:Int,internalKeyCount:Int,watchOnly:Boolean,unknownFields:scalapb.UnknownFieldSet):walletrpc.Account" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><
The name used to identify the account.</p></dd><dt class="param">addressType</dt><dd class="cmt"><p>
The type of addresses the account supports.
AddressType | External Branch | Internal Branch
---------------------------------------------------------------------
WITNESS_PUBKEY_HASH | P2WPKH | P2WPKH
NESTED_WITNESS_PUBKEY_HASH | NP2WPKH | NP2WPKH
HYBRID_NESTED_WITNESS_PUBKEY_HASH | NP2WPKH | P2WPKH</p></dd><dt class="param">extendedPublicKey</dt><dd class="cmt"><p>
The public key backing the account that all keys are derived from
represented as an extended key. This will always be empty for the default
imported account in which single public keys are imported into.</p></dd><dt class="param">masterKeyFingerprint</dt><dd class="cmt"><p>
The fingerprint of the root key from which the account public key was
derived from. This will always be zero for the default imported account in
which single public keys are imported into. The bytes are in big-endian
order.</p></dd><dt class="param">derivationPath</dt><dd class="cmt"><p>
The derivation path corresponding to the account public key. This will
always be empty for the default imported account in which single public keys
are imported into.</p></dd><dt class="param">externalKeyCount</dt><dd class="cmt"><p>
The number of keys derived from the external branch of the account public
key. This will always be zero for the default imported account in which
single public keys are imported into.</p></dd><dt class="param">internalKeyCount</dt><dd class="cmt"><p>
The number of keys derived from the internal branch of the account public
key. This will always be zero for the default imported account in which
single public keys are imported into.</p></dd><dt class="param">watchOnly</dt><dd class="cmt"><p>
Whether the wallet stores private keys for the account.</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/Account.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.6/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.6/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/Account.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.6/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean" class="anchorToMember"></a><a id="==(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/Account.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <a href="https://www.scala-lang.org/api/2.13.6/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.6/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="walletrpc.Account#addressType" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="addressType:walletrpc.AddressType" class="anchorToMember"></a><a id="addressType:AddressType" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/Account.html#addressType:walletrpc.AddressType" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">addressType</span><span class="result">: <a href="AddressType.html" name="walletrpc.AddressType" id="walletrpc.AddressType" class="extype">AddressType</a></span></span></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0" class="anchorToMember"></a> <span class="permalink"><a href="../walletrpc/Account.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <spa
Reference in a new issue Copy permalink