kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-06-15 02:29:39 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
replace-core-endpoint
stacks.js/docs/modules/bns.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

791 lines
52 KiB
HTML
Vendored
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>bns | 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="bns.html">bns</a>
</li>
</ul>
<h1>Module bns</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="#stacksbns" id="stacksbns" style="color: inherit; text-decoration: none;">
<h1><code>@stacks/bns</code></h1>
</a>
<p>A package for interacting with the <a href="https://explorer.stacks.co/txid/SP000000000000000000002Q6VF78.bns?chain=mainnet">BNS contract</a>
on the Stacks blockchain.</p>
<a href="#what-is-bns" id="what-is-bns" style="color: inherit; text-decoration: none;">
<h2>What is BNS?</h2>
</a>
<p>The <a href="https://docs.blockstack.org/build-apps/references/bns">Blockchain Naming System</a>
(BNS) is a network system that binds Stacks usernames to off-chain
state without relying on any central points of control.</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">save</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">bns</span>
</code></pre>
<a href="#example-usage" id="example-usage" style="color: inherit; text-decoration: none;">
<h2>Example Usage</h2>
</a>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">canRegisterName</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@stacks/bns&#039;</span><span style="color: #000000">;</span>
<span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">StacksTestnet</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@stacks/network&#039;</span><span style="color: #000000">;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">network</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">StacksMainnet</span><span style="color: #000000">();</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">fullyQualifiedName</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;name.id&#039;</span><span style="color: #000000">;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">result</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">canRegisterName</span><span style="color: #000000">({ </span><span style="color: #001080">fullyQualifiedName</span><span style="color: #000000">, </span><span style="color: #001080">network</span><span style="color: #000000"> });</span>
</code></pre>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">buildRegisterNameTX</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@stacks/bns&#039;</span><span style="color: #000000">;</span>
<span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">StacksTestnet</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@stacks/network&#039;</span><span style="color: #000000">;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">network</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">StacksMainnet</span><span style="color: #000000">();</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">name</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;name.id&#039;</span><span style="color: #000000">;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">salt</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;example-salt&#039;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">zonefile</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;example-zonefile&#039;</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">publicKey</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;SPF0324DSC4K505TP6A8C7GAK4R95E38TGNZP7RE&#039;</span>
<span style="color: #008000">// construct an unsigned bns register-name transaction</span>
<span style="color: #008000">// note: builder functions build transactions with AnchorMode set to Any</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">unsignedTX</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">buildRegisterNameTX</span><span style="color: #000000">({ </span><span style="color: #001080">name</span><span style="color: #000000">, </span><span style="color: #001080">salt</span><span style="color: #000000">, </span><span style="color: #001080">zonefile</span><span style="color: #000000">, </span><span style="color: #001080">publicKey</span><span style="color: #000000">, </span><span style="color: #001080">network</span><span style="color: #000000"> });</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/bns.bnscontractaddress.html" class="tsd-kind-icon">Bns<wbr>Contract<wbr>Address</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/bns.bnscontractcalloptions.html" class="tsd-kind-icon">Bns<wbr>Contract<wbr>Call<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.bnsreadonlyoptions.html" class="tsd-kind-icon">Bns<wbr>Read<wbr>Only<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.canregisternameoptions.html" class="tsd-kind-icon">Can<wbr>Register<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.getnamepriceoptions.html" class="tsd-kind-icon">Get<wbr>Name<wbr>Price<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.getnamespacepriceoptions.html" class="tsd-kind-icon">Get<wbr>Namespace<wbr>Price<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.importnameoptions.html" class="tsd-kind-icon">Import<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.preordernameoptions.html" class="tsd-kind-icon">Preorder<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.preordernamespaceoptions.html" class="tsd-kind-icon">Preorder<wbr>Namespace<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.pricefunction.html" class="tsd-kind-icon">Price<wbr>Function</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.readynamespaceoptions.html" class="tsd-kind-icon">Ready<wbr>Namespace<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.registernameoptions.html" class="tsd-kind-icon">Register<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.renewnameoptions.html" class="tsd-kind-icon">Renew<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.revealnamespaceoptions.html" class="tsd-kind-icon">Reveal<wbr>Namespace<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.revokenameoptions.html" class="tsd-kind-icon">Revoke<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.transfernameoptions.html" class="tsd-kind-icon">Transfer<wbr>Name<wbr>Options</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/bns.updatenameoptions.html" class="tsd-kind-icon">Update<wbr>Name<wbr>Options</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="bns.html#bns_contract_name" class="tsd-kind-icon">BNS_<wbr>CONTRACT_<wbr>NAME</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"><a href="bns.html#buildimportnametx" class="tsd-kind-icon">build<wbr>Import<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildpreordernametx" class="tsd-kind-icon">build<wbr>Preorder<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildpreordernamespacetx" class="tsd-kind-icon">build<wbr>Preorder<wbr>Namespace<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildreadynamespacetx" class="tsd-kind-icon">build<wbr>Ready<wbr>Namespace<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildregisternametx" class="tsd-kind-icon">build<wbr>Register<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildrenewnametx" class="tsd-kind-icon">build<wbr>Renew<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildrevealnamespacetx" class="tsd-kind-icon">build<wbr>Reveal<wbr>Namespace<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildrevokenametx" class="tsd-kind-icon">build<wbr>Revoke<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildtransfernametx" class="tsd-kind-icon">build<wbr>Transfer<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#buildupdatenametx" class="tsd-kind-icon">build<wbr>Update<wbr>Name<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#canregistername" class="tsd-kind-icon">can<wbr>Register<wbr>Name</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#getnameprice" class="tsd-kind-icon">get<wbr>Name<wbr>Price</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="bns.html#getnamespaceprice" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price</a></li>
</ul>
</section>
</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="bns_contract_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> BNS_<wbr>CONTRACT_<wbr>NAME</h3>
<div class="tsd-signature tsd-kind-icon">BNS_<wbr>CONTRACT_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;bns&quot;</span><span class="tsd-signature-symbol"> = &#x27;bns&#x27;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/bns/src/index.ts#L31">packages/bns/src/index.ts:31</a></li>
</ul>
</aside>
</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">
<a name="buildimportnametx" class="tsd-anchor"></a>
<h3>build<wbr>Import<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Import<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.importnameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ImportNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L413">packages/bns/src/index.ts:413</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a namespace name import transaction.
An optional step in namespace registration.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.importnameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ImportNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildpreordernametx" class="tsd-anchor"></a>
<h3>build<wbr>Preorder<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Preorder<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.preordernameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PreorderNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L506">packages/bns/src/index.ts:506</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a name preorder transaction.
First step in registering a name. This transaction does not reveal the name that is
about to be registered. And it sets the amount of STX to be burned for the registration.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.preordernameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PreorderNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildpreordernamespacetx" class="tsd-anchor"></a>
<h3>build<wbr>Preorder<wbr>Namespace<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Preorder<wbr>Namespace<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.preordernamespaceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PreorderNamespaceOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L290">packages/bns/src/index.ts:290</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a namespace preorder transaction.
First step in registering a namespace. This transaction does not reveal the namespace that is
about to be registered. And it sets the amount of STX to be burned for the registration.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.preordernamespaceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">PreorderNamespaceOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildreadynamespacetx" class="tsd-anchor"></a>
<h3>build<wbr>Ready<wbr>Namespace<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Ready<wbr>Namespace<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.readynamespaceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadyNamespaceOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L462">packages/bns/src/index.ts:462</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a ready namespace transaction.
Final step in namespace registration. This completes the namespace registration and
makes the namespace available for name registrations.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.readynamespaceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadyNamespaceOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildregisternametx" class="tsd-anchor"></a>
<h3>build<wbr>Register<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Register<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.registernameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisterNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L557">packages/bns/src/index.ts:557</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a name registration transaction.
Second and final step in registering a name.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.registernameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RegisterNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildrenewnametx" class="tsd-anchor"></a>
<h3>build<wbr>Renew<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Renew<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.renewnameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RenewNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L768">packages/bns/src/index.ts:768</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a name renew transaction.
This renews a name registration.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.renewnameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RenewNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildrevealnamespacetx" class="tsd-anchor"></a>
<h3>build<wbr>Reveal<wbr>Namespace<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Reveal<wbr>Namespace<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.revealnamespaceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RevealNamespaceOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L340">packages/bns/src/index.ts:340</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a namespace reveal transaction.
Second step in registering a namespace.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.revealnamespaceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RevealNamespaceOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildrevokenametx" class="tsd-anchor"></a>
<h3>build<wbr>Revoke<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Revoke<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.revokenameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RevokeNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L719">packages/bns/src/index.ts:719</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a name revoke transaction.
This revokes a name registration.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.revokenameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RevokeNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildtransfernametx" class="tsd-anchor"></a>
<h3>build<wbr>Transfer<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Transfer<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.transfernameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TransferNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L666">packages/bns/src/index.ts:666</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a name transfer transaction.
This changes the owner of the registered name.</p>
</div>
<p>Since the underlying NFT will be transferred,
you will be required to add a post-condition to this
transaction before broadcasting it.</p>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.transfernameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TransferNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="buildupdatenametx" class="tsd-anchor"></a>
<h3>build<wbr>Update<wbr>Name<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Update<wbr>Name<wbr>Tx<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.updatenameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateNameOptions</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">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L612">packages/bns/src/index.ts:612</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a name update transaction.
This changes the zonefile for the registered name.</p>
</div>
<p>Resolves to the generated StacksTransaction</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.updatenameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/transactions.stackstransaction.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTransaction</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="canregistername" class="tsd-anchor"></a>
<h3>can<wbr>Register<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">can<wbr>Register<wbr>Name<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.canregisternameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CanRegisterNameOptions</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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L127">packages/bns/src/index.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if name can be registered</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.canregisternameoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CanRegisterNameOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to true if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="getnameprice" class="tsd-anchor"></a>
<h3>get<wbr>Name<wbr>Price</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Price<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.getnamepriceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetNamePriceOptions</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">&lt;</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L227">packages/bns/src/index.ts:227</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get price of name registration in microstacks</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.getnamepriceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetNamePriceOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a BN object number of microstacks if the operation succeeds</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="getnamespaceprice" class="tsd-anchor"></a>
<h3>get<wbr>Namespace<wbr>Price</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<wbr>Price<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/bns.getnamespacepriceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetNamespacePriceOptions</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">&lt;</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">&gt;</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/bns/src/index.ts#L176">packages/bns/src/index.ts:176</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get price of namespace registration in microstacks</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <a href="../interfaces/bns.getnamespacepriceoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">GetNamespacePriceOptions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>that resolves to a BN object number of microstacks if the operation succeeds</p>
</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="current 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=" 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>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="bns.html" class="tsd-kind-icon">bns</a>
<ul>
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/bns.bnscontractaddress.html" class="tsd-kind-icon">Bns<wbr>Contract<wbr>Address</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.bnscontractcalloptions.html" class="tsd-kind-icon">Bns<wbr>Contract<wbr>Call<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.bnsreadonlyoptions.html" class="tsd-kind-icon">Bns<wbr>Read<wbr>Only<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.canregisternameoptions.html" class="tsd-kind-icon">Can<wbr>Register<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.getnamepriceoptions.html" class="tsd-kind-icon">Get<wbr>Name<wbr>Price<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.getnamespacepriceoptions.html" class="tsd-kind-icon">Get<wbr>Namespace<wbr>Price<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.importnameoptions.html" class="tsd-kind-icon">Import<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.preordernameoptions.html" class="tsd-kind-icon">Preorder<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.preordernamespaceoptions.html" class="tsd-kind-icon">Preorder<wbr>Namespace<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.pricefunction.html" class="tsd-kind-icon">Price<wbr>Function</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.readynamespaceoptions.html" class="tsd-kind-icon">Ready<wbr>Namespace<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.registernameoptions.html" class="tsd-kind-icon">Register<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.renewnameoptions.html" class="tsd-kind-icon">Renew<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.revealnamespaceoptions.html" class="tsd-kind-icon">Reveal<wbr>Namespace<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.revokenameoptions.html" class="tsd-kind-icon">Revoke<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.transfernameoptions.html" class="tsd-kind-icon">Transfer<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/bns.updatenameoptions.html" class="tsd-kind-icon">Update<wbr>Name<wbr>Options</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="bns.html#bns_contract_name" class="tsd-kind-icon">BNS_<wbr>CONTRACT_<wbr>NAME</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildimportnametx" class="tsd-kind-icon">build<wbr>Import<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildpreordernametx" class="tsd-kind-icon">build<wbr>Preorder<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildpreordernamespacetx" class="tsd-kind-icon">build<wbr>Preorder<wbr>Namespace<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildreadynamespacetx" class="tsd-kind-icon">build<wbr>Ready<wbr>Namespace<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildregisternametx" class="tsd-kind-icon">build<wbr>Register<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildrenewnametx" class="tsd-kind-icon">build<wbr>Renew<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildrevealnamespacetx" class="tsd-kind-icon">build<wbr>Reveal<wbr>Namespace<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildrevokenametx" class="tsd-kind-icon">build<wbr>Revoke<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildtransfernametx" class="tsd-kind-icon">build<wbr>Transfer<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#buildupdatenametx" class="tsd-kind-icon">build<wbr>Update<wbr>Name<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#canregistername" class="tsd-kind-icon">can<wbr>Register<wbr>Name</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#getnameprice" class="tsd-kind-icon">get<wbr>Name<wbr>Price</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="bns.html#getnamespaceprice" class="tsd-kind-icon">get<wbr>Namespace<wbr>Price</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<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>
<li class=" tsd-kind-module">
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<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>
Reference in New Issue View Git Blame Copy Permalink