mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-06-11 08:49:21 +08:00
288 lines
18 KiB
HTML
Vendored
288 lines
18 KiB
HTML
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>network | 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="network.html">network</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Module network</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="#stacksnetwork" id="stacksnetwork" style="color: inherit; text-decoration: none;">
|
|
<h1>@stacks/network</h1>
|
|
</a>
|
|
<p>Network and API library for working with Stacks blockchain nodes.</p>
|
|
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
|
|
<h2>Installation</h2>
|
|
</a>
|
|
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">install</span><span style="color: #000000"> @</span><span style="color: #001080">stacks</span><span style="color: #000000">/</span><span style="color: #001080">network</span>
|
|
</code></pre>
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
<h2>Usage</h2>
|
|
</a>
|
|
<p>Creating a Stacks mainnet, testnet, regtest or mocknet network</p>
|
|
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">StacksMainnet</span><span style="color: #000000">, </span><span style="color: #001080">StacksTestnet</span><span style="color: #000000">, </span><span style="color: #001080">StacksMocknet</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@stacks/network'</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">testnet</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">StacksTestnet</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">regtest</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">StacksRegtest</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">mocknet</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">StacksMocknet</span><span style="color: #000000">();</span>
|
|
</code></pre>
|
|
<p>Setting a custom node URL</p>
|
|
<pre><code class="language-typescript"><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #001080">coreApiUrl</span><span style="color: #000000"> = </span><span style="color: #A31515">'https://www.mystacksnode.com/'</span><span style="color: #000000">;</span>
|
|
</code></pre>
|
|
<p>Check if network is mainnet</p>
|
|
<pre><code class="language-typescript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">isMainnet</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">isMainnet</span><span style="color: #000000">();</span>
|
|
</code></pre>
|
|
<p>Example usage in transaction builder</p>
|
|
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">makeSTXTokenTransfer</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@stacks/transactions'</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">txOptions</span><span style="color: #000000"> = {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">network</span><span style="color: #000000">,</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">recipient:</span><span style="color: #000000"> </span><span style="color: #A31515">'SP2BS6HD7TN34V8Z5BNF8Q2AW3K8K2DPV4264CF26'</span><span style="color: #000000">,</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">amount:</span><span style="color: #000000"> </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">BigNum</span><span style="color: #000000">(</span><span style="color: #098658">12345</span><span style="color: #000000">),</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">senderKey:</span><span style="color: #000000"> </span><span style="color: #A31515">'b244296d5907de9864c0b0d51f98a13c52890be0404e83f273144cd5b9960eed01'</span><span style="color: #000000">,</span>
|
|
<span style="color: #000000">};</span>
|
|
|
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">transaction</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">makeSTXTokenTransfer</span><span style="color: #000000">(</span><span style="color: #001080">txOptions</span><span style="color: #000000">);</span>
|
|
</code></pre>
|
|
<p>Get various API URLs</p>
|
|
<pre><code class="language-typescript"><span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">txBroadcastUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getBroadcastApiUrl</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">feeEstimateUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getTransferFeeEstimateApiUrl</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">address</span><span style="color: #000000"> = </span><span style="color: #A31515">'SP2BS6HD7TN34V8Z5BNF8Q2AW3K8K2DPV4264CF26'</span><span style="color: #000000">;</span>
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">accountInfoUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getAccountApiUrl</span><span style="color: #000000">(</span><span style="color: #001080">address</span><span style="color: #000000">);</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">contractName</span><span style="color: #000000"> = </span><span style="color: #A31515">'hello_world'</span><span style="color: #000000">;</span>
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">abiUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getAbiApiUrl</span><span style="color: #000000">(</span><span style="color: #001080">address</span><span style="color: #000000">, </span><span style="color: #001080">contractName</span><span style="color: #000000">);</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">functionName</span><span style="color: #000000"> = </span><span style="color: #A31515">'hello'</span><span style="color: #000000">;</span>
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">readOnlyFunctionCallUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getReadOnlyFunctionCallApiUrl</span><span style="color: #000000">(</span><span style="color: #001080">address</span><span style="color: #000000">, </span><span style="color: #001080">contractName</span><span style="color: #000000">, </span><span style="color: #001080">functionName</span><span style="color: #000000">);</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">nodeInfoUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getInfoUrl</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">blockTimeUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getBlockTimeInfoUrl</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">poxInfoUrl</span><span style="color: #000000"> = </span><span style="color: #001080">network</span><span style="color: #000000">.</span><span style="color: #795E26">getPoxInfoUrl</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>Classes</h3>
|
|
<ul class="tsd-index-list">
|
|
<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>
|
|
</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/network.stacksnetwork.html" class="tsd-kind-icon">Stacks<wbr>Network</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html">keychain</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="network.html">network</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="profile.html">profile</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="stacking.html">stacking</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="storage.html">storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="transactions.html">transactions</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-module">
|
|
<a href="auth.html" class="tsd-kind-icon">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="bns.html" class="tsd-kind-icon">bns</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="cli.html" class="tsd-kind-icon">cli</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="common.html" class="tsd-kind-icon">common</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="encryption.html" class="tsd-kind-icon">encryption</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="keychain.html" class="tsd-kind-icon">keychain</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-module">
|
|
<a href="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=" tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="../interfaces/network.stacksnetwork.html" class="tsd-kind-icon">Stacks<wbr>Network</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
<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> |