kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-01-12 22:43:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
stacks-blockchain-api/client/interfaces/generated.microblock.html

511 lines
22 KiB
HTML
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>Microblock | @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.microblock.html">Microblock</a>
</li>
</ul>
<h1>Interface Microblock</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>A microblock</p>
</div>
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>interface</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Microblock</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.microblock.html#block_hash" class="tsd-kind-icon">block_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#block_height" class="tsd-kind-icon">block_<wbr>height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#canonical" class="tsd-kind-icon">canonical</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#microblock_canonical" class="tsd-kind-icon">microblock_<wbr>canonical</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#microblock_hash" class="tsd-kind-icon">microblock_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#microblock_parent_hash" class="tsd-kind-icon">microblock_<wbr>parent_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#microblock_sequence" class="tsd-kind-icon">microblock_<wbr>sequence</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#parent_block_hash" class="tsd-kind-icon">parent_<wbr>block_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#parent_block_height" class="tsd-kind-icon">parent_<wbr>block_<wbr>height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#parent_burn_block_hash" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>hash</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#parent_burn_block_height" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>height</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#parent_burn_block_time" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>time</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#parent_burn_block_time_iso" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>time_<wbr>iso</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.microblock.html#txs" class="tsd-kind-icon">txs</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="block_hash" class="tsd-anchor"></a>
<h3>block_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">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 src/generated/models/Microblock.ts:99</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The hash of the anchor block that confirmed this microblock. This wil be empty for unanchored microblocks</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="block_height" class="tsd-anchor"></a>
<h3>block_<wbr>height</h3>
<div class="tsd-signature tsd-kind-icon">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 src/generated/models/Microblock.ts:57</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The anchor block height that confirmed this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</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 src/generated/models/Microblock.ts:27</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to <code>true</code> if the microblock corresponds to the canonical chain tip.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="microblock_canonical" class="tsd-anchor"></a>
<h3>microblock_<wbr>canonical</h3>
<div class="tsd-signature tsd-kind-icon">microblock_<wbr>canonical<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to <code>true</code> if the microblock was not orphaned in a following anchor block. Defaults to <code>true</code> if the following anchor block has not yet been created.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="microblock_hash" class="tsd-anchor"></a>
<h3>microblock_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">microblock_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:39</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The SHA512/256 hash of this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="microblock_parent_hash" class="tsd-anchor"></a>
<h3>microblock_<wbr>parent_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">microblock_<wbr>parent_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:51</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The SHA512/256 hash of the previous signed microblock in this stream.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="microblock_sequence" class="tsd-anchor"></a>
<h3>microblock_<wbr>sequence</h3>
<div class="tsd-signature tsd-kind-icon">microblock_<wbr>sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:45</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A hint to describe how to order a set of microblocks. Starts at 0.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_block_hash" class="tsd-anchor"></a>
<h3>parent_<wbr>block_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">parent_<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 src/generated/models/Microblock.ts:69</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The hash of the anchor block that preceded this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_block_height" class="tsd-anchor"></a>
<h3>parent_<wbr>block_<wbr>height</h3>
<div class="tsd-signature tsd-kind-icon">parent_<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 src/generated/models/Microblock.ts:63</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The height of the anchor block that preceded this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_burn_block_hash" class="tsd-anchor"></a>
<h3>parent_<wbr>burn_<wbr>block_<wbr>hash</h3>
<div class="tsd-signature tsd-kind-icon">parent_<wbr>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 src/generated/models/Microblock.ts:75</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The hash of the Bitcoin block that preceded this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_burn_block_height" class="tsd-anchor"></a>
<h3>parent_<wbr>burn_<wbr>block_<wbr>height</h3>
<div class="tsd-signature tsd-kind-icon">parent_<wbr>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 src/generated/models/Microblock.ts:93</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The height of the Bitcoin block that preceded this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_burn_block_time" class="tsd-anchor"></a>
<h3>parent_<wbr>burn_<wbr>block_<wbr>time</h3>
<div class="tsd-signature tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:81</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The block timestamp of the Bitcoin block that preceded this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="parent_burn_block_time_iso" class="tsd-anchor"></a>
<h3>parent_<wbr>burn_<wbr>block_<wbr>time_<wbr>iso</h3>
<div class="tsd-signature tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>time_<wbr>iso<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:87</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) formatted block time of the bitcoin block that preceded this microblock.</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="txs" class="tsd-anchor"></a>
<h3>txs</h3>
<div class="tsd-signature tsd-kind-icon">txs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in src/generated/models/Microblock.ts:105</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>List of transactions included in the microblock</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>Microblock</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.microblock.html" class="tsd-kind-icon">Microblock</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#block_hash" class="tsd-kind-icon">block_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#block_height" class="tsd-kind-icon">block_<wbr>height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#canonical" class="tsd-kind-icon">canonical</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#microblock_canonical" class="tsd-kind-icon">microblock_<wbr>canonical</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#microblock_hash" class="tsd-kind-icon">microblock_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#microblock_parent_hash" class="tsd-kind-icon">microblock_<wbr>parent_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#microblock_sequence" class="tsd-kind-icon">microblock_<wbr>sequence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#parent_block_hash" class="tsd-kind-icon">parent_<wbr>block_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#parent_block_height" class="tsd-kind-icon">parent_<wbr>block_<wbr>height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#parent_burn_block_hash" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>hash</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#parent_burn_block_height" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#parent_burn_block_time" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#parent_burn_block_time_iso" class="tsd-kind-icon">parent_<wbr>burn_<wbr>block_<wbr>time_<wbr>iso</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.microblock.html#txs" class="tsd-kind-icon">txs</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>
Reference in New Issue View Git Blame Copy Permalink