kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-01-12 22:52:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
f572477ca0e5bc5e862c8a4e2fcc276655ee55a3
stacks.js/docs/interfaces/keychain.constructoroptions.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

372 lines
19 KiB
HTML
Vendored
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ConstructorOptions | 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="../modules/keychain.html">keychain</a>
</li>
<li>
<a href="keychain.constructoroptions.html">ConstructorOptions</a>
</li>
</ul>
<h1>Interface ConstructorOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ConstructorOptions</span>
</li>
</ul>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#bitcoinpublickeychain" class="tsd-kind-icon">bitcoin<wbr>Public<wbr>Keychain</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#chain" class="tsd-kind-icon">chain</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#configprivatekey" class="tsd-kind-icon">config<wbr>Private<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#encryptedbackupphrase" class="tsd-kind-icon">encrypted<wbr>Backup<wbr>Phrase</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#firstbitcoinaddress" class="tsd-kind-icon">first<wbr>Bitcoin<wbr>Address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#identities" class="tsd-kind-icon">identities</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#identityaddresses" class="tsd-kind-icon">identity<wbr>Addresses</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#identitykeypairs" class="tsd-kind-icon">identity<wbr>Keypairs</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#identitypublickeychain" class="tsd-kind-icon">identity<wbr>Public<wbr>Keychain</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#stacksprivatekey" class="tsd-kind-icon">stacks<wbr>Private<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="keychain.constructoroptions.html#walletconfig" class="tsd-kind-icon">wallet<wbr>Config</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="bitcoinpublickeychain" class="tsd-anchor"></a>
<h3>bitcoin<wbr>Public<wbr>Keychain</h3>
<div class="tsd-signature tsd-kind-icon">bitcoin<wbr>Public<wbr>Keychain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L54">packages/keychain/src/wallet/index.ts:54</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="chain" class="tsd-anchor"></a>
<h3>chain</h3>
<div class="tsd-signature tsd-kind-icon">chain<span class="tsd-signature-symbol">:</span> <a href="../enums/transactions.chainid.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChainID</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L52">packages/keychain/src/wallet/index.ts:52</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="configprivatekey" class="tsd-anchor"></a>
<h3>config<wbr>Private<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">config<wbr>Private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L60">packages/keychain/src/wallet/index.ts:60</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="encryptedbackupphrase" class="tsd-anchor"></a>
<h3>encrypted<wbr>Backup<wbr>Phrase</h3>
<div class="tsd-signature tsd-kind-icon">encrypted<wbr>Backup<wbr>Phrase<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L58">packages/keychain/src/wallet/index.ts:58</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="firstbitcoinaddress" class="tsd-anchor"></a>
<h3>first<wbr>Bitcoin<wbr>Address</h3>
<div class="tsd-signature tsd-kind-icon">first<wbr>Bitcoin<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L55">packages/keychain/src/wallet/index.ts:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="identities" class="tsd-anchor"></a>
<h3>identities</h3>
<div class="tsd-signature tsd-kind-icon">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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L59">packages/keychain/src/wallet/index.ts:59</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="identityaddresses" class="tsd-anchor"></a>
<h3>identity<wbr>Addresses</h3>
<div class="tsd-signature tsd-kind-icon">identity<wbr>Addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/wallet/index.ts#L57">packages/keychain/src/wallet/index.ts:57</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="identitykeypairs" class="tsd-anchor"></a>
<h3>identity<wbr>Keypairs</h3>
<div class="tsd-signature tsd-kind-icon">identity<wbr>Keypairs<span class="tsd-signature-symbol">:</span> <a href="keychain.identitykeypair.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityKeyPair</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/wallet/index.ts#L56">packages/keychain/src/wallet/index.ts:56</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="identitypublickeychain" class="tsd-anchor"></a>
<h3>identity<wbr>Public<wbr>Keychain</h3>
<div class="tsd-signature tsd-kind-icon">identity<wbr>Public<wbr>Keychain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L53">packages/keychain/src/wallet/index.ts:53</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="stacksprivatekey" class="tsd-anchor"></a>
<h3>stacks<wbr>Private<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">stacks<wbr>Private<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L61">packages/keychain/src/wallet/index.ts:61</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="walletconfig" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> wallet<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">wallet<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="keychain.walletconfig.html" class="tsd-signature-type" data-tsd-kind="Interface">WalletConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/keychain/src/wallet/index.ts#L62">packages/keychain/src/wallet/index.ts:62</a></li>
</ul>
</aside>
</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="../modules/auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html">encryption</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/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="../modules/auth.html" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html" class="tsd-kind-icon">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html" class="tsd-kind-icon">encryption</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="keychain.constructoroptions.html" class="tsd-kind-icon">Constructor<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#bitcoinpublickeychain" class="tsd-kind-icon">bitcoin<wbr>Public<wbr>Keychain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#chain" class="tsd-kind-icon">chain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#configprivatekey" class="tsd-kind-icon">config<wbr>Private<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#encryptedbackupphrase" class="tsd-kind-icon">encrypted<wbr>Backup<wbr>Phrase</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#firstbitcoinaddress" class="tsd-kind-icon">first<wbr>Bitcoin<wbr>Address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#identities" class="tsd-kind-icon">identities</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#identityaddresses" class="tsd-kind-icon">identity<wbr>Addresses</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#identitykeypairs" class="tsd-kind-icon">identity<wbr>Keypairs</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#identitypublickeychain" class="tsd-kind-icon">identity<wbr>Public<wbr>Keychain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#stacksprivatekey" class="tsd-kind-icon">stacks<wbr>Private<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="keychain.constructoroptions.html#walletconfig" class="tsd-kind-icon">wallet<wbr>Config</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html" class="tsd-kind-icon">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html" class="tsd-kind-icon">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/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>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
Reference in New Issue View Git Blame Copy Permalink