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/network.stacksnetwork.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

742 lines
41 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>StacksNetwork | 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/network.html">network</a>
</li>
<li>
<a href="network.stacksnetwork.html">StacksNetwork</a>
</li>
</ul>
<h1>Interface StacksNetwork</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">StacksNetwork</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/network.stacksmainnet.html" class="tsd-signature-type" data-tsd-kind="Class">StacksMainnet</a></li>
<li><a href="../classes/network.stacksmocknet.html" class="tsd-signature-type" data-tsd-kind="Class">StacksMocknet</a></li>
<li><a href="../classes/network.stacksregtest.html" class="tsd-signature-type" data-tsd-kind="Class">StacksRegtest</a></li>
<li><a href="../classes/network.stackstestnet.html" class="tsd-signature-type" data-tsd-kind="Class">StacksTestnet</a></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="network.stacksnetwork.html#accountendpoint" class="tsd-kind-icon">account<wbr>Endpoint</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#bnslookupurl" class="tsd-kind-icon">bns<wbr>Lookup<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#broadcastendpoint" class="tsd-kind-icon">broadcast<wbr>Endpoint</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#chainid" class="tsd-kind-icon">chain<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#contractabiendpoint" class="tsd-kind-icon">contract<wbr>Abi<wbr>Endpoint</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#coreapiurl" class="tsd-kind-icon">core<wbr>Api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getabiapiurl" class="tsd-kind-icon">get<wbr>Abi<wbr>Api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getaccountapiurl" class="tsd-kind-icon">get<wbr>Account<wbr>Api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getblocktimeinfourl" class="tsd-kind-icon">get<wbr>Block<wbr>Time<wbr>Info<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getbroadcastapiurl" class="tsd-kind-icon">get<wbr>Broadcast<wbr>Api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getinfourl" class="tsd-kind-icon">get<wbr>Info<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getnameinfo" class="tsd-kind-icon">get<wbr>Name<wbr>Info</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getpoxinfourl" class="tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getreadonlyfunctioncallapiurl" class="tsd-kind-icon">get<wbr>Read<wbr>Only<wbr>Function<wbr>Call<wbr>Api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#getstackerinfourl" class="tsd-kind-icon">get<wbr>Stacker<wbr>Info<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#gettransferfeeestimateapiurl" class="tsd-kind-icon">get<wbr>Transfer<wbr>Fee<wbr>Estimate<wbr>Api<wbr>Url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#readonlyfunctioncallendpoint" class="tsd-kind-icon">read<wbr>Only<wbr>Function<wbr>Call<wbr>Endpoint</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#transferfeeestimateendpoint" class="tsd-kind-icon">transfer<wbr>Fee<wbr>Estimate<wbr>Endpoint</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="network.stacksnetwork.html#version" class="tsd-kind-icon">version</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="network.stacksnetwork.html#ismainnet" class="tsd-kind-icon">is<wbr>Mainnet</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="accountendpoint" class="tsd-anchor"></a>
<h3>account<wbr>Endpoint</h3>
<div class="tsd-signature tsd-kind-icon">account<wbr>Endpoint<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/network/src/index.ts#L10">packages/network/src/index.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="bnslookupurl" class="tsd-anchor"></a>
<h3>bns<wbr>Lookup<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">bns<wbr>Lookup<wbr>Url<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/network/src/index.ts#L7">packages/network/src/index.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="broadcastendpoint" class="tsd-anchor"></a>
<h3>broadcast<wbr>Endpoint</h3>
<div class="tsd-signature tsd-kind-icon">broadcast<wbr>Endpoint<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/network/src/index.ts#L8">packages/network/src/index.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="chainid" class="tsd-anchor"></a>
<h3>chain<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">chain<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="../enums/common.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/network/src/index.ts#L5">packages/network/src/index.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="contractabiendpoint" class="tsd-anchor"></a>
<h3>contract<wbr>Abi<wbr>Endpoint</h3>
<div class="tsd-signature tsd-kind-icon">contract<wbr>Abi<wbr>Endpoint<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/network/src/index.ts#L11">packages/network/src/index.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="coreapiurl" class="tsd-anchor"></a>
<h3>core<wbr>Api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">core<wbr>Api<wbr>Url<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/network/src/index.ts#L6">packages/network/src/index.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getabiapiurl" class="tsd-anchor"></a>
<h3>get<wbr>Abi<wbr>Api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Abi<wbr>Api<wbr>Url<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>, contract<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L17">packages/network/src/index.ts:17</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contract<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>contract: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getaccountapiurl" class="tsd-anchor"></a>
<h3>get<wbr>Account<wbr>Api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Account<wbr>Api<wbr>Url<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><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L16">packages/network/src/index.ts:16</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>address: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getblocktimeinfourl" class="tsd-anchor"></a>
<h3>get<wbr>Block<wbr>Time<wbr>Info<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>Time<wbr>Info<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L24">packages/network/src/index.ts:24</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getbroadcastapiurl" class="tsd-anchor"></a>
<h3>get<wbr>Broadcast<wbr>Api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Broadcast<wbr>Api<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L14">packages/network/src/index.ts:14</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getinfourl" class="tsd-anchor"></a>
<h3>get<wbr>Info<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Info<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L23">packages/network/src/index.ts:23</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getnameinfo" class="tsd-anchor"></a>
<h3>get<wbr>Name<wbr>Info</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Name<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>fullyQualifiedName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/network/src/index.ts#L36">packages/network/src/index.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get WHOIS-like information for a name, including the address that owns it,
the block at which it expires, and the zone file anchored to it (if available).</p>
</div>
<p>This is intended for use in third-party wallets or in DApps that register names.</p>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>the name to query. Can be on-chain of off-chain.</p>
</dd>
<dt>returns</dt>
<dd><p>a promise that resolves to the WHOIS-like information</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>fullyQualifiedName<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">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fullyQualifiedName: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getpoxinfourl" class="tsd-anchor"></a>
<h3>get<wbr>Pox<wbr>Info<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L25">packages/network/src/index.ts:25</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getreadonlyfunctioncallapiurl" class="tsd-anchor"></a>
<h3>get<wbr>Read<wbr>Only<wbr>Function<wbr>Call<wbr>Api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Read<wbr>Only<wbr>Function<wbr>Call<wbr>Api<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>contractAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, functionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L18">packages/network/src/index.ts:18</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>contractAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, functionName<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contractAddress: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>functionName: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getstackerinfourl" class="tsd-anchor"></a>
<h3>get<wbr>Stacker<wbr>Info<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Stacker<wbr>Info<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>contractAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L26">packages/network/src/index.ts:26</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>contractAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractName<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>contractAddress: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>contractName: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="gettransferfeeestimateapiurl" class="tsd-anchor"></a>
<h3>get<wbr>Transfer<wbr>Fee<wbr>Estimate<wbr>Api<wbr>Url</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Transfer<wbr>Fee<wbr>Estimate<wbr>Api<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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/network/src/index.ts#L15">packages/network/src/index.ts:15</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</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">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="readonlyfunctioncallendpoint" class="tsd-anchor"></a>
<h3>read<wbr>Only<wbr>Function<wbr>Call<wbr>Endpoint</h3>
<div class="tsd-signature tsd-kind-icon">read<wbr>Only<wbr>Function<wbr>Call<wbr>Endpoint<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/network/src/index.ts#L12">packages/network/src/index.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="transferfeeestimateendpoint" class="tsd-anchor"></a>
<h3>transfer<wbr>Fee<wbr>Estimate<wbr>Endpoint</h3>
<div class="tsd-signature tsd-kind-icon">transfer<wbr>Fee<wbr>Estimate<wbr>Endpoint<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/network/src/index.ts#L9">packages/network/src/index.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="version" class="tsd-anchor"></a>
<h3>version</h3>
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <a href="../enums/common.transactionversion.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TransactionVersion</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/network/src/index.ts#L4">packages/network/src/index.ts:4</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="ismainnet" class="tsd-anchor"></a>
<h3>is<wbr>Mainnet</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">is<wbr>Mainnet<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/network/src/index.ts#L13">packages/network/src/index.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></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="../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=" tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class="current 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>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
<ul>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/network.stacksmainnet.html" class="tsd-kind-icon">Stacks<wbr>Mainnet</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/network.stacksmocknet.html" class="tsd-kind-icon">Stacks<wbr>Mocknet</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/network.stacksregtest.html" class="tsd-kind-icon">Stacks<wbr>Regtest</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/network.stackstestnet.html" class="tsd-kind-icon">Stacks<wbr>Testnet</a>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="network.stacksnetwork.html" class="tsd-kind-icon">Stacks<wbr>Network</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#accountendpoint" class="tsd-kind-icon">account<wbr>Endpoint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#bnslookupurl" class="tsd-kind-icon">bns<wbr>Lookup<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#broadcastendpoint" class="tsd-kind-icon">broadcast<wbr>Endpoint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#chainid" class="tsd-kind-icon">chain<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#contractabiendpoint" class="tsd-kind-icon">contract<wbr>Abi<wbr>Endpoint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#coreapiurl" class="tsd-kind-icon">core<wbr>Api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getabiapiurl" class="tsd-kind-icon">get<wbr>Abi<wbr>Api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getaccountapiurl" class="tsd-kind-icon">get<wbr>Account<wbr>Api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getblocktimeinfourl" class="tsd-kind-icon">get<wbr>Block<wbr>Time<wbr>Info<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getbroadcastapiurl" class="tsd-kind-icon">get<wbr>Broadcast<wbr>Api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getinfourl" class="tsd-kind-icon">get<wbr>Info<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getnameinfo" class="tsd-kind-icon">get<wbr>Name<wbr>Info</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getpoxinfourl" class="tsd-kind-icon">get<wbr>Pox<wbr>Info<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getreadonlyfunctioncallapiurl" class="tsd-kind-icon">get<wbr>Read<wbr>Only<wbr>Function<wbr>Call<wbr>Api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#getstackerinfourl" class="tsd-kind-icon">get<wbr>Stacker<wbr>Info<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#gettransferfeeestimateapiurl" class="tsd-kind-icon">get<wbr>Transfer<wbr>Fee<wbr>Estimate<wbr>Api<wbr>Url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#readonlyfunctioncallendpoint" class="tsd-kind-icon">read<wbr>Only<wbr>Function<wbr>Call<wbr>Endpoint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#transferfeeestimateendpoint" class="tsd-kind-icon">transfer<wbr>Fee<wbr>Estimate<wbr>Endpoint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#version" class="tsd-kind-icon">version</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="network.stacksnetwork.html#ismainnet" class="tsd-kind-icon">is<wbr>Mainnet</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<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>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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