mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-05-30 01:12:32 +08:00
343 lines
15 KiB
HTML
343 lines
15 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>BurnchainReward | @stacks/blockchain-api-client</title>
|
|
<meta name="description" content="Documentation for @stacks/blockchain-api-client">
|
|
<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/blockchain-api-client</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/blockchain-api-client</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/generated.html">generated</a>
|
|
</li>
|
|
<li>
|
|
<a href="generated.burnchainreward.html">BurnchainReward</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface BurnchainReward</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">
|
|
<div class="lead">
|
|
<p>Reward payment made on the burnchain</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>export</dt>
|
|
<dd></dd>
|
|
<dt>interface</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">BurnchainReward</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#burn_amount" class="tsd-kind-icon">burn_<wbr>amount</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#burn_block_hash" class="tsd-kind-icon">burn_<wbr>block_<wbr>hash</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#burn_block_height" class="tsd-kind-icon">burn_<wbr>block_<wbr>height</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#canonical" class="tsd-kind-icon">canonical</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#reward_amount" class="tsd-kind-icon">reward_<wbr>amount</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#reward_index" class="tsd-kind-icon">reward_<wbr>index</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.burnchainreward.html#reward_recipient" class="tsd-kind-icon">reward_<wbr>recipient</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="burn_amount" class="tsd-anchor"></a>
|
|
<h3>burn_<wbr>amount</h3>
|
|
<div class="tsd-signature tsd-kind-icon">burn_<wbr>amount<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-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L45">src/generated/models/BurnchainReward.ts:45</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The total amount of burnchain tokens burned for this burnchain block, in the smallest unit (e.g. satoshis for Bitcoin)</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="burn_block_hash" class="tsd-anchor"></a>
|
|
<h3>burn_<wbr>block_<wbr>hash</h3>
|
|
<div class="tsd-signature tsd-kind-icon">burn_<wbr>block_<wbr>hash<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-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L33">src/generated/models/BurnchainReward.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The hash representing the burnchain block</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="burn_block_height" class="tsd-anchor"></a>
|
|
<h3>burn_<wbr>block_<wbr>height</h3>
|
|
<div class="tsd-signature tsd-kind-icon">burn_<wbr>block_<wbr>height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L39">src/generated/models/BurnchainReward.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Height of the burnchain block</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="canonical" class="tsd-anchor"></a>
|
|
<h3>canonical</h3>
|
|
<div class="tsd-signature tsd-kind-icon">canonical<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L27">src/generated/models/BurnchainReward.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Set to <code>true</code> if block corresponds to the canonical burchchain tip</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="reward_amount" class="tsd-anchor"></a>
|
|
<h3>reward_<wbr>amount</h3>
|
|
<div class="tsd-signature tsd-kind-icon">reward_<wbr>amount<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-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L57">src/generated/models/BurnchainReward.ts:57</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The amount of burnchain tokens rewarded to the recipient, in the smallest unit (e.g. satoshis for Bitcoin)</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="reward_index" class="tsd-anchor"></a>
|
|
<h3>reward_<wbr>index</h3>
|
|
<div class="tsd-signature tsd-kind-icon">reward_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L63">src/generated/models/BurnchainReward.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The index position of the reward entry, useful for ordering when there's more than one recipient per burnchain block</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="reward_recipient" class="tsd-anchor"></a>
|
|
<h3>reward_<wbr>recipient</h3>
|
|
<div class="tsd-signature tsd-kind-icon">reward_<wbr>recipient<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-blockchain-api/blob/7dcb019/client/src/generated/models/BurnchainReward.ts#L51">src/generated/models/BurnchainReward.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The recipient address that received the burnchain rewards, in the format native to the burnchain (e.g. B58 encoded for Bitcoin)</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>BurnchainReward</p>
|
|
</dd>
|
|
</dl>
|
|
</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="current tsd-kind-module">
|
|
<a href="../modules/generated.html">generated</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/generated_runtime.html">generated/runtime</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/socket_io.html">socket-<wbr>io</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/ws.html">ws</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="generated.burnchainreward.html" class="tsd-kind-icon">Burnchain<wbr>Reward</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#burn_amount" class="tsd-kind-icon">burn_<wbr>amount</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#burn_block_hash" class="tsd-kind-icon">burn_<wbr>block_<wbr>hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#burn_block_height" class="tsd-kind-icon">burn_<wbr>block_<wbr>height</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#canonical" class="tsd-kind-icon">canonical</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#reward_amount" class="tsd-kind-icon">reward_<wbr>amount</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#reward_index" class="tsd-kind-icon">reward_<wbr>index</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.burnchainreward.html#reward_recipient" class="tsd-kind-icon">reward_<wbr>recipient</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</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-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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> |