mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 22:52:34 +08:00
1286 lines
90 KiB
HTML
Vendored
1286 lines
90 KiB
HTML
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>keychain | Stacks.js 1.4.1 Library Reference</title>
|
|
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">Stacks.js 1.4.1 Library Reference</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">Stacks.js 1.4.1 Library Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="keychain.html">keychain</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module keychain</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<a href="#stackskeychain" id="stackskeychain" style="color: inherit; text-decoration: none;">
|
|
<h1>@stacks/keychain</h1>
|
|
</a>
|
|
<p>Create and manage keys/wallets for the Stacks blockchain.</p>
|
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
<h2>Installation</h2>
|
|
</a>
|
|
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">keychain</span>
|
|
</code></pre>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Enumerations</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/keychain.identitynamevalidityerror.html" class="tsd-kind-icon">Identity<wbr>Name<wbr>Validity<wbr>Error</a></li>
|
|
<li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/keychain.subdomains.html" class="tsd-kind-icon">Subdomains</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/keychain.identity.html" class="tsd-kind-icon">Identity</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/keychain.wallet.html" class="tsd-kind-icon">Wallet</a></li>
|
|
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/keychain.walletsigner.html" class="tsd-kind-icon">Wallet<wbr>Signer</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Interfaces</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/keychain.configapp.html" class="tsd-kind-icon">Config<wbr>App</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/keychain.constructoroptions.html" class="tsd-kind-icon">Constructor<wbr>Options</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/keychain.identitykeypair.html" class="tsd-kind-icon">Identity<wbr>Key<wbr>Pair</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/keychain.profile.html" class="tsd-kind-icon">Profile</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/keychain.profileimage.html" class="tsd-kind-icon">Profile<wbr>Image</a></li>
|
|
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/keychain.walletconfig.html" class="tsd-kind-icon">Wallet<wbr>Config</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Type aliases</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="keychain.html#allowedkeyentropybits" class="tsd-kind-icon">Allowed<wbr>Key<wbr>Entropy<wbr>Bits</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-module"><a href="keychain.html#default" class="tsd-kind-icon">default</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Variables</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="keychain.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="keychain.html#derivationpaths" class="tsd-kind-icon">derivation<wbr>Paths</a></li>
|
|
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="keychain.html#registrars" class="tsd-kind-icon">registrars</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="keychain.html#assertistruthy" class="tsd-kind-icon">assert<wbr>IsTruthy</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#decrypt" class="tsd-kind-icon">decrypt</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#deriveidentitykeypair" class="tsd-kind-icon">derive<wbr>Identity<wbr>Key<wbr>Pair</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#deriverootkeychainfrommnemonic" class="tsd-kind-icon">derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#derivestxaddresschain" class="tsd-kind-icon">derive<wbr>Stx<wbr>Address<wbr>Chain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#encrypt" class="tsd-kind-icon">encrypt</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#encryptmnemonicformatted" class="tsd-kind-icon">encrypt<wbr>Mnemonic<wbr>Formatted</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#fetchprofile" class="tsd-kind-icon">fetch<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#generateencryptedmnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#generatemnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Root<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getaddress" class="tsd-kind-icon">get<wbr>Address</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getbitcoinaddressnode" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Address<wbr>Node</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getbitcoinprivatekeychain" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Private<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getblockchainidentities" class="tsd-kind-icon">get<wbr>Blockchain<wbr>Identities</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getderivationpath" class="tsd-kind-icon">get<wbr>Derivation<wbr>Path</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getidentityowneraddressnode" class="tsd-kind-icon">get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getidentityprivatekeychain" class="tsd-kind-icon">get<wbr>Identity<wbr>Private<wbr>Keychain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#getprofileurlfromzonefile" class="tsd-kind-icon">get<wbr>ProfileURLFrom<wbr>Zone<wbr>File</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#makeidentity" class="tsd-kind-icon">make<wbr>Identity</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#recursiverestoreidentities" class="tsd-kind-icon">recursive<wbr>Restore<wbr>Identities</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#registersubdomain" class="tsd-kind-icon">register<wbr>Subdomain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#signanduploadprofile" class="tsd-kind-icon">sign<wbr>And<wbr>Upload<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#signprofileforupload" class="tsd-kind-icon">sign<wbr>Profile<wbr>For<wbr>Upload</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#uploadprofile" class="tsd-kind-icon">upload<wbr>Profile</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#validatesubdomain" class="tsd-kind-icon">validate<wbr>Subdomain</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#validatesubdomainavailability" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Availability</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-module"><a href="keychain.html#validatesubdomainformat" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Format</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Type aliases</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a name="allowedkeyentropybits" class="tsd-anchor"></a>
|
|
<h3>Allowed<wbr>Key<wbr>Entropy<wbr>Bits</h3>
|
|
<div class="tsd-signature tsd-kind-icon">Allowed<wbr>Key<wbr>Entropy<wbr>Bits<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">128</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">256</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/mnemonic/index.ts#L8">packages/keychain/src/mnemonic/index.ts:8</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-module">
|
|
<a name="default" class="tsd-anchor"></a>
|
|
<h3>default</h3>
|
|
<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>Wallet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/keychain.wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>Wallet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><a href="../classes/keychain.wallet.html" class="tsd-signature-type" data-tsd-kind="Class">Wallet</a></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Variables</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="default_profile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PROFILE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PROFILE<span class="tsd-signature-symbol">:</span> <a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L35">packages/keychain/src/profiles.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="derivationpaths" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> derivation<wbr>Paths</h3>
|
|
<div class="tsd-signature tsd-kind-icon">derivation<wbr>Paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>2147483648<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/address-derivation/index.ts#L7">packages/keychain/src/address-derivation/index.ts:7</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>2147483648<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
|
<a name="registrars" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> registrars</h3>
|
|
<div class="tsd-signature tsd-kind-icon">registrars<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>id.blockstack<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>registerUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>test-personal.id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>registerUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L47">packages/keychain/src/profiles.ts:47</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-type-declaration">
|
|
<h4>Type declaration</h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>id.blockstack<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>registerUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>api<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>register<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>test-<wbr>personal.id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>registerUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>api<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>register<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a name="assertistruthy" class="tsd-anchor"></a>
|
|
<h3>assert<wbr>IsTruthy</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
|
<li class="tsd-signature tsd-kind-icon">assert<wbr>IsTruthy<T><span class="tsd-signature-symbol">(</span>val<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">asserts </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L150">packages/keychain/src/utils/index.ts:150</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T</h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>val: <span class="tsd-signature-type">any</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">asserts </span><span class="tsd-signature-type">val</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">NonNullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="decrypt" class="tsd-anchor"></a>
|
|
<h3>decrypt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">decrypt<span class="tsd-signature-symbol">(</span>dataBuffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/encryption/decrypt.ts#L13">packages/keychain/src/encryption/decrypt.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Decrypt an encrypted mnemonic phrase with a password.
|
|
Legacy triplesec encrypted payloads are also supported.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>dataBuffer: <span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Password for data</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>the raw mnemonic phrase</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="deriveidentitykeypair" class="tsd-anchor"></a>
|
|
<h3>derive<wbr>Identity<wbr>Key<wbr>Pair</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">derive<wbr>Identity<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>identityOwnerAddressNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdentityAddressOwnerNode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L78">packages/keychain/src/utils/index.ts:78</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>identityOwnerAddressNode: <span class="tsd-signature-type">IdentityAddressOwnerNode</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="deriverootkeychainfrommnemonic" class="tsd-anchor"></a>
|
|
<h3>derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic<span class="tsd-signature-symbol">(</span>plaintextMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/mnemonic/index.ts#L35">packages/keychain/src/mnemonic/index.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>plaintextMnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="derivestxaddresschain" class="tsd-anchor"></a>
|
|
<h3>derive<wbr>Stx<wbr>Address<wbr>Chain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">derive<wbr>Stx<wbr>Address<wbr>Chain<span class="tsd-signature-symbol">(</span>chain<span class="tsd-signature-symbol">: </span><a href="../enums/transactions.chainid.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChainID</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>childKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">; </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/address-derivation/index.ts#L16">packages/keychain/src/address-derivation/index.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>chain: <a href="../enums/transactions.chainid.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChainID</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>childKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">; </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>childKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">; </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>childKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">; </span>privateKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>child<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>private<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="encrypt" class="tsd-anchor"></a>
|
|
<h3>encrypt</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">(</span>phrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/encryption/encrypt.ts#L9">packages/keychain/src/encryption/encrypt.ts:9</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Encrypt a raw mnemonic phrase to be password protected</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>phrase: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Raw mnemonic phrase</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Password to encrypt mnemonic with</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>The encrypted phrase</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="encryptmnemonicformatted" class="tsd-anchor"></a>
|
|
<h3>encrypt<wbr>Mnemonic<wbr>Formatted</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>Mnemonic<wbr>Formatted<span class="tsd-signature-symbol">(</span>plaintextMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>encryptedMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>encryptedMnemonicHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/mnemonic/index.ts#L41">packages/keychain/src/mnemonic/index.ts:41</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>plaintextMnemonic: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>encryptedMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>encryptedMnemonicHex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="fetchprofile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> fetch<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Profile<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L177">packages/keychain/src/profiles.ts:177</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5>gaia<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="generateencryptedmnemonicrootkeychain" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, entropy<span class="tsd-signature-symbol">: </span><a href="keychain.html#allowedkeyentropybits" class="tsd-signature-type" data-tsd-kind="Type alias">AllowedKeyEntropyBits</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>encryptedMnemonicPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/mnemonic/index.ts#L20">packages/keychain/src/mnemonic/index.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>password: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>entropy: <a href="keychain.html#allowedkeyentropybits" class="tsd-signature-type" data-tsd-kind="Type alias">AllowedKeyEntropyBits</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>encryptedMnemonicPhrase<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="generatemnemonicrootkeychain" class="tsd-anchor"></a>
|
|
<h3>generate<wbr>Mnemonic<wbr>Root<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Mnemonic<wbr>Root<wbr>Keychain<span class="tsd-signature-symbol">(</span>entropy<span class="tsd-signature-symbol">: </span><a href="keychain.html#allowedkeyentropybits" class="tsd-signature-type" data-tsd-kind="Type alias">AllowedKeyEntropyBits</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>plaintextMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/mnemonic/index.ts#L10">packages/keychain/src/mnemonic/index.ts:10</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>entropy: <a href="keychain.html#allowedkeyentropybits" class="tsd-signature-type" data-tsd-kind="Type alias">AllowedKeyEntropyBits</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>plaintextMnemonic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getaddress" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Address</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Address<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L65">packages/keychain/src/utils/index.ts:65</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getbitcoinaddressnode" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Bitcoin<wbr>Address<wbr>Node</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Bitcoin<wbr>Address<wbr>Node<span class="tsd-signature-symbol">(</span>bitcoinKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, addressIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, chainType<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L30">packages/keychain/src/utils/index.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bitcoinKeychain: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>addressIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>chainType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BIP32Interface</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getbitcoinprivatekeychain" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Bitcoin<wbr>Private<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Bitcoin<wbr>Private<wbr>Keychain<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L19">packages/keychain/src/utils/index.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BIP32Interface</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getblockchainidentities" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Blockchain<wbr>Identities</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Blockchain<wbr>Identities<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, identitiesToGenerate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>bitcoinPublicKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>firstBitcoinAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identities<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityAddresses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityKeypairs<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityPublicKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L97">packages/keychain/src/utils/index.ts:97</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>identitiesToGenerate: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>bitcoinPublicKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>firstBitcoinAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identities<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityAddresses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityKeypairs<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>identityPublicKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getderivationpath" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Derivation<wbr>Path</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Derivation<wbr>Path<span class="tsd-signature-symbol">(</span>chain<span class="tsd-signature-symbol">: </span><a href="../enums/transactions.chainid.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChainID</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/address-derivation/index.ts#L12">packages/keychain/src/address-derivation/index.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>chain: <a href="../enums/transactions.chainid.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChainID</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getidentityowneraddressnode" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node<span class="tsd-signature-symbol">(</span>identityPrivateKeychain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, identityIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L48">packages/keychain/src/utils/index.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>identityPrivateKeychain: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>identityIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">default</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getidentityprivatekeychain" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Identity<wbr>Private<wbr>Keychain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Identity<wbr>Private<wbr>Keychain<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L12">packages/keychain/src/utils/index.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BIP32Interface</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="getprofileurlfromzonefile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>ProfileURLFrom<wbr>Zone<wbr>File</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>ProfileURLFrom<wbr>Zone<wbr>File<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L250">packages/keychain/src/utils/index.ts:250</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="makeidentity" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Identity</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Identity<span class="tsd-signature-symbol">(</span>rootNode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BIP32Interface</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L135">packages/keychain/src/utils/index.ts:135</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rootNode: <span class="tsd-signature-type">BIP32Interface</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>index: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="recursiverestoreidentities" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> recursive<wbr>Restore<wbr>Identities</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">recursive<wbr>Restore<wbr>Identities<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RecursiveMakeIdentitiesOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L204">packages/keychain/src/utils/index.ts:204</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Restore identities by recursively making a new identity, and checking if it has a username.</p>
|
|
</div>
|
|
<p>As soon as a username is not found for an identity, the recursion stops.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-type">RecursiveMakeIdentitiesOptions</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="registersubdomain" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> register<wbr>Subdomain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Subdomain<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegisterParams</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L140">packages/keychain/src/profiles.ts:140</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Register a subdomain for a given identity</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-type">RegisterParams</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="signanduploadprofile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> sign<wbr>And<wbr>Upload<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>And<wbr>Upload<wbr>Profile<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>gaiaHubConfig<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</a><span class="tsd-signature-symbol">; </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">; </span>profile<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L162">packages/keychain/src/profiles.ts:162</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>gaiaHubConfig<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</a><span class="tsd-signature-symbol">; </span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a><span class="tsd-signature-symbol">; </span>profile<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter">
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gaia<wbr>Hub<wbr>Config<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>gaia<wbr>Hub<wbr>Url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a></h5>
|
|
</li>
|
|
<li class="tsd-parameter">
|
|
<h5>profile<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a></h5>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="signprofileforupload" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>Profile<wbr>For<wbr>Upload</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>Profile<wbr>For<wbr>Upload<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a>, keypair<span class="tsd-signature-symbol">: </span><a href="../interfaces/keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L58">packages/keychain/src/profiles.ts:58</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>profile: <a href="../interfaces/keychain.profile.html" class="tsd-signature-type" data-tsd-kind="Interface">Profile</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>keypair: <a href="../interfaces/keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="uploadprofile" class="tsd-anchor"></a>
|
|
<h3>upload<wbr>Profile</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">upload<wbr>Profile<span class="tsd-signature-symbol">(</span>gaiaHubUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, identity<span class="tsd-signature-symbol">: </span><a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a>, signedProfileTokenData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gaiaHubConfig<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/profiles.ts#L68">packages/keychain/src/profiles.ts:68</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>gaiaHubUrl: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>identity: <a href="../classes/keychain.identity.html" class="tsd-signature-type" data-tsd-kind="Class">Identity</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>signedProfileTokenData: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gaiaHubConfig: <a href="../interfaces/storage.gaiahubconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">GaiaHubConfig</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="validatesubdomain" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Subdomain</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Subdomain<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subdomain<span class="tsd-signature-symbol">?: </span><a href="../enums/keychain.subdomains.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Subdomains</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/keychain.identitynamevalidityerror.html" class="tsd-signature-type" data-tsd-kind="Enumeration">IdentityNameValidityError</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L224">packages/keychain/src/utils/index.ts:224</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Validate the format and availability of a subdomain. Will return an error of enum
|
|
IdentityNameValidityError if an error is present. If no errors are found, will return null.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the subdomain to be registered</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>subdomain: <a href="../enums/keychain.subdomains.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Subdomains</a><span class="tsd-signature-symbol"> = ...</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a valid Subdomains enum</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/keychain.identitynamevalidityerror.html" class="tsd-signature-type" data-tsd-kind="Enumeration">IdentityNameValidityError</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="validatesubdomainavailability" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Subdomain<wbr>Availability</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Subdomain<wbr>Availability<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, subdomain<span class="tsd-signature-symbol">?: </span><a href="../enums/keychain.subdomains.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Subdomains</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L183">packages/keychain/src/utils/index.ts:183</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>subdomain: <a href="../enums/keychain.subdomains.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Subdomains</a><span class="tsd-signature-symbol"> = ...</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
|
<a name="validatesubdomainformat" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> validate<wbr>Subdomain<wbr>Format</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
|
<li class="tsd-signature tsd-kind-icon">validate<wbr>Subdomain<wbr>Format<span class="tsd-signature-symbol">(</span>identityName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/keychain.identitynamevalidityerror.html" class="tsd-signature-type" data-tsd-kind="Enumeration">IdentityNameValidityError</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/utils/index.ts#L165">packages/keychain/src/utils/index.ts:165</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>identityName: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/keychain.identitynamevalidityerror.html" class="tsd-signature-type" data-tsd-kind="Enumeration">IdentityNameValidityError</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html">encryption</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="keychain.html">keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html">transactions</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html" class="tsd-kind-icon">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html" class="tsd-kind-icon">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html" class="tsd-kind-icon">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html" class="tsd-kind-icon">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html" class="tsd-kind-icon">encryption</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-module">
|
|
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
|
|
<ul>
|
|
<li class=" tsd-kind-enum tsd-parent-kind-module">
|
|
<a href="../enums/keychain.identitynamevalidityerror.html" class="tsd-kind-icon">Identity<wbr>Name<wbr>Validity<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum tsd-parent-kind-module">
|
|
<a href="../enums/keychain.subdomains.html" class="tsd-kind-icon">Subdomains</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/keychain.identity.html" class="tsd-kind-icon">Identity</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/keychain.wallet.html" class="tsd-kind-icon">Wallet</a>
|
|
</li>
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/keychain.walletsigner.html" class="tsd-kind-icon">Wallet<wbr>Signer</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/keychain.configapp.html" class="tsd-kind-icon">Config<wbr>App</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/keychain.constructoroptions.html" class="tsd-kind-icon">Constructor<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/keychain.identitykeypair.html" class="tsd-kind-icon">Identity<wbr>Key<wbr>Pair</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/keychain.profile.html" class="tsd-kind-icon">Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/keychain.profileimage.html" class="tsd-kind-icon">Profile<wbr>Image</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/keychain.walletconfig.html" class="tsd-kind-icon">Wallet<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
|
<a href="keychain.html#allowedkeyentropybits" class="tsd-kind-icon">Allowed<wbr>Key<wbr>Entropy<wbr>Bits</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-module">
|
|
<a href="keychain.html#default" class="tsd-kind-icon">default</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="keychain.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="keychain.html#derivationpaths" class="tsd-kind-icon">derivation<wbr>Paths</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
|
<a href="keychain.html#registrars" class="tsd-kind-icon">registrars</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
|
<a href="keychain.html#assertistruthy" class="tsd-kind-icon">assert<wbr>IsTruthy</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#decrypt" class="tsd-kind-icon">decrypt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#deriveidentitykeypair" class="tsd-kind-icon">derive<wbr>Identity<wbr>Key<wbr>Pair</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#deriverootkeychainfrommnemonic" class="tsd-kind-icon">derive<wbr>Root<wbr>Keychain<wbr>From<wbr>Mnemonic</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#derivestxaddresschain" class="tsd-kind-icon">derive<wbr>Stx<wbr>Address<wbr>Chain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#encrypt" class="tsd-kind-icon">encrypt</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#encryptmnemonicformatted" class="tsd-kind-icon">encrypt<wbr>Mnemonic<wbr>Formatted</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#fetchprofile" class="tsd-kind-icon">fetch<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#generateencryptedmnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Encrypted<wbr>Mnemonic<wbr>Root<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#generatemnemonicrootkeychain" class="tsd-kind-icon">generate<wbr>Mnemonic<wbr>Root<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getaddress" class="tsd-kind-icon">get<wbr>Address</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getbitcoinaddressnode" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Address<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getbitcoinprivatekeychain" class="tsd-kind-icon">get<wbr>Bitcoin<wbr>Private<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getblockchainidentities" class="tsd-kind-icon">get<wbr>Blockchain<wbr>Identities</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getderivationpath" class="tsd-kind-icon">get<wbr>Derivation<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getidentityowneraddressnode" class="tsd-kind-icon">get<wbr>Identity<wbr>Owner<wbr>Address<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getidentityprivatekeychain" class="tsd-kind-icon">get<wbr>Identity<wbr>Private<wbr>Keychain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#getprofileurlfromzonefile" class="tsd-kind-icon">get<wbr>ProfileURLFrom<wbr>Zone<wbr>File</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#makeidentity" class="tsd-kind-icon">make<wbr>Identity</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#recursiverestoreidentities" class="tsd-kind-icon">recursive<wbr>Restore<wbr>Identities</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#registersubdomain" class="tsd-kind-icon">register<wbr>Subdomain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#signanduploadprofile" class="tsd-kind-icon">sign<wbr>And<wbr>Upload<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#signprofileforupload" class="tsd-kind-icon">sign<wbr>Profile<wbr>For<wbr>Upload</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#uploadprofile" class="tsd-kind-icon">upload<wbr>Profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#validatesubdomain" class="tsd-kind-icon">validate<wbr>Subdomain</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#validatesubdomainavailability" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Availability</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-module">
|
|
<a href="keychain.html#validatesubdomainformat" class="tsd-kind-icon">validate<wbr>Subdomain<wbr>Format</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="network.html" class="tsd-kind-icon">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html" class="tsd-kind-icon">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html" class="tsd-kind-icon">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html" class="tsd-kind-icon">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html" class="tsd-kind-icon">transactions</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |