bitcoin-s/api/lnrpc/WalletUnlocker.html

30 lines
85 KiB
HTML
Raw Normal View History

<!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_.lnrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="lnrpc" class="anchorToMember"></a><a id="lnrpc:lnrpc" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/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">lnrpc</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="AMP$.html" title="" class="object"></a> <a href="AMP.html" title="Details specific to AMP HTLCs." class="class"></a><a href="AMP.html" title="Details specific to AMP HTLCs.">AMP</a></li><li class="current-entities indented1"><a href="AMPInvoiceState$.html" title="" class="object"></a> <a href="AMPInvoiceState.html" title="" class="class"></a><a href="AMPInvoiceState.html" title="">AMPInvoiceState</a></li><li class="current-entities indented1"><a href="AMPRecord$.html" title="" class="object"></a> <a href="AMPRecord.html" title="" class="class"></a><a href="AMPRecord.html" title="">AMPRecord</a></li><li class="current-entities indented1"><a href="AbandonChannelRequest$.html" title="" class="object"></a> <a href="AbandonChannelRequest.html" title="" class="class"></a><a href="AbandonChannelRequest.html" title="">AbandonChannelRequest</a></li><li class="current-entities indented1"><a href="AbandonChannelResponse$.html" title="" class="object"></a> <a href="AbandonChannelResponse.html" title="" class="class"></a><a href="AbandonChannelResponse.html" title="">AbandonChannelResponse</a></li><li class="current-entities indented1"><a href="AddInvoiceResponse$.html" title="" class="object"></a> <a href="AddInvoiceResponse.html" title="" class="class"></a><a href="AddInvoiceResponse.html" title="">AddInvoiceResponse</a></li><li class="current-entities indented1"><a href="AddressType$.html" title="" class="object"></a> <a href="AddressType.html" title="AddressType has to be one of:" class="class"></a><a href="AddressType.html" title="AddressType has to be one of:">AddressType</a></li><li class="current-entities indented1"><a href="AliasMap$.html" title="" class="object"></a> <a href="AliasMap.html" title="" class="class"></a><a href="AliasMap.html" title="">AliasMap</a></li><li class="current-entities indented1"><a href=
lnd at first startup, and unlock a previously set up wallet.
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><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.12/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></div></div></div><div class="toggleContainer"><div class="toggle block"><span>Known Subclasses</span><div class="subClasses hiddenContent"><a href="WalletUnlockerClient.html" name="lnrpc.WalletUnlockerClient" id="lnrpc.WalletUnlockerClient" class="extype">WalletUnlockerClient</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="lnrpc.WalletUnlocker"><span>WalletUnlocker</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 class="values members"><h3>Abstract Value Members</h3><ol><li class="indented0 " name="lnrpc.WalletUnlocker#changePassword" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="changePassword(in:lnrpc.ChangePasswordRequest):scala.concurrent.Future[lnrpc.ChangePasswordResponse]" class="anchorToMember"></a><a id="changePassword(ChangePasswordRequest):Future[ChangePasswordResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html#changePassword(in:lnrpc.ChangePasswordRequest):scala.concurrent.Future[lnrpc.ChangePasswordResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">changePassword</span><span class="params">(<span name="in">in: <a href="ChangePasswordRequest.html" name="lnrpc.ChangePasswordRequest" id="lnrpc.ChangePasswordRequest" class="extype">ChangePasswordRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="ChangePasswordResponse.html" name="lnrpc.ChangePasswordResponse" id="lnrpc.ChangePasswordResponse" class="extype">ChangePasswordResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>changepassword</code>
ChangePassword changes the password of the encrypted wallet.</p><div class="fullcomment"><div class="comment cmt"><p>lncli: <code>changepassword</code>
ChangePassword changes the password of the encrypted wallet. This will
automatically unlock the wallet database if successful.
</p></div></div></li><li class="indented0 " name="lnrpc.WalletUnlocker#genSeed" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="genSeed(in:lnrpc.GenSeedRequest):scala.concurrent.Future[lnrpc.GenSeedResponse]" class="anchorToMember"></a><a id="genSeed(GenSeedRequest):Future[GenSeedResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html#genSeed(in:lnrpc.GenSeedRequest):scala.concurrent.Future[lnrpc.GenSeedResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">genSeed</span><span class="params">(<span name="in">in: <a href="GenSeedRequest.html" name="lnrpc.GenSeedRequest" id="lnrpc.GenSeedRequest" class="extype">GenSeedRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="GenSeedResponse.html" name="lnrpc.GenSeedResponse" id="lnrpc.GenSeedResponse" class="extype">GenSeedResponse</a>]</span></span><p class="shortcomment cmt">GenSeed is the first method that should be used to instantiate a new lnd
instance.</p><div class="fullcomment"><div class="comment cmt"><p>GenSeed is the first method that should be used to instantiate a new lnd
instance. This method allows a caller to generate a new aezeed cipher seed
given an optional passphrase. If provided, the passphrase will be necessary
to decrypt the cipherseed to expose the internal wallet seed.
Once the cipherseed is obtained and verified by the user, the InitWallet
method should be used to commit the newly generated seed, and create the
wallet.
</p></div></div></li><li class="indented0 " name="lnrpc.WalletUnlocker#initWallet" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="initWallet(in:lnrpc.InitWalletRequest):scala.concurrent.Future[lnrpc.InitWalletResponse]" class="anchorToMember"></a><a id="initWallet(InitWalletRequest):Future[InitWalletResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html#initWallet(in:lnrpc.InitWalletRequest):scala.concurrent.Future[lnrpc.InitWalletResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">initWallet</span><span class="params">(<span name="in">in: <a href="InitWalletRequest.html" name="lnrpc.InitWalletRequest" id="lnrpc.InitWalletRequest" class="extype">InitWalletRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="InitWalletResponse.html" name="lnrpc.InitWalletResponse" id="lnrpc.InitWalletResponse" class="extype">InitWalletResponse</a>]</span></span><p class="shortcomment cmt">InitWallet is used when lnd is starting up for the first time to fully
initialize the daemon and its internal wallet.</p><div class="fullcomment"><div class="comment cmt"><p>InitWallet is used when lnd is starting up for the first time to fully
initialize the daemon and its internal wallet. At the very least a wallet
password must be provided. This will be used to encrypt sensitive material
on disk.
In the case of a recovery scenario, the user can also specify their aezeed
mnemonic and passphrase. If set, then the daemon will use this prior state
to initialize its internal wallet.
Alternatively, this can be used along with the GenSeed RPC to obtain a
seed, then present it to the user. Once it has been verified by the user,
the seed can be fed into this RPC in order to commit the new wallet.
</p></div></div></li><li class="indented0 " name="lnrpc.WalletUnlocker#unlockWallet" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="unlockWallet(in:lnrpc.UnlockWalletRequest):scala.concurrent.Future[lnrpc.UnlockWalletResponse]" class="anchorToMember"></a><a id="unlockWallet(UnlockWalletRequest):Future[UnlockWalletResponse]" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html#unlockWallet(in:lnrpc.UnlockWalletRequest):scala.concurrent.Future[lnrpc.UnlockWalletResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">unlockWallet</span><span class="params">(<span name="in">in: <a href="UnlockWalletRequest.html" name="lnrpc.UnlockWalletRequest" id="lnrpc.UnlockWalletRequest" class="extype">UnlockWalletRequest</a></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.12/scala/concurrent/Future.html#scala.concurrent.Future" name="scala.concurrent.Future" id="scala.concurrent.Future" class="extype">Future</a>[<a href="UnlockWalletResponse.html" name="lnrpc.UnlockWalletResponse" id="lnrpc.UnlockWalletResponse" class="extype">UnlockWalletResponse</a>]</span></span><p class="shortcomment cmt">lncli: <code>unlock</code>
UnlockWallet is used at startup of lnd to provide a password to unlock
the wallet database.</p></li></ol></div><div class="values members"><h3>Concrete 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="../lnrpc/WalletUnlocker.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.12/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.12/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="../lnrpc/WalletUnlocker.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.12/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="../lnrpc/WalletUnlocker.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.12/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.12/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object" class="anchorToMember"></a><a id="clone():AnyRef" class="anchorToMember"></a> <span class="permalink"><a href="../lnrpc/WalletUnlocker.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class