kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-05-27 22:14:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ hirosystems/stacks-blockchain-api@f29919b5fb 🚀

Browse Source
This commit is contained in:
zone117x
2021-12-15 16:34:21 +00:00
parent 0b544ebe5e
commit 201c82f2bd
225 changed files with 6313 additions and 3170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
client/interfaces/generated.blocksapiinterface.html
View File

@@ -130,13 +130,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L68">src/generated/apis/BlocksApi.ts:68</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L68">src/generated/apis/BlocksApi.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by burnchain block hash
Get block</p>
<p>Retrieves block details of a specific block for a given burnchain block hash
Get block by burnchain block hash</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -162,16 +162,16 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L62">src/generated/apis/BlocksApi.ts:62</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L62">src/generated/apis/BlocksApi.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by burnchain block hash</p>
<p>Retrieves block details of a specific block for a given burnchain block hash</p>
</div>
<dl class="tsd-comment-tags">
<dt>summary</dt>
<dd><p>Get block</p>
<dd><p>Get block by burnchain block hash</p>
</dd>
<dt>throws</dt>
<dd><p>{RequiredError}</p>
@@ -204,13 +204,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L84">src/generated/apis/BlocksApi.ts:84</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L84">src/generated/apis/BlocksApi.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by burn chain height
Get block</p>
<p>Retrieves block details of a specific block for a given burn chain height
Get block by burnchain height</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -236,16 +236,16 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L78">src/generated/apis/BlocksApi.ts:78</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L78">src/generated/apis/BlocksApi.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by burn chain height</p>
<p>Retrieves block details of a specific block for a given burn chain height</p>
</div>
<dl class="tsd-comment-tags">
<dt>summary</dt>
<dd><p>Get block</p>
<dd><p>Get block by burnchain height</p>
</dd>
<dt>throws</dt>
<dd><p>{RequiredError}</p>
@@ -278,13 +278,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L100">src/generated/apis/BlocksApi.ts:100</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L100">src/generated/apis/BlocksApi.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by hash
Get block</p>
<p>Retrieves block details of a specific block for a given chain height
Get block by hash</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -310,16 +310,16 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L94">src/generated/apis/BlocksApi.ts:94</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L94">src/generated/apis/BlocksApi.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by hash</p>
<p>Retrieves block details of a specific block for a given chain height</p>
</div>
<dl class="tsd-comment-tags">
<dt>summary</dt>
<dd><p>Get block</p>
<dd><p>Get block by hash</p>
</dd>
<dt>throws</dt>
<dd><p>{RequiredError}</p>
@@ -352,13 +352,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L116">src/generated/apis/BlocksApi.ts:116</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L116">src/generated/apis/BlocksApi.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by height
Get block</p>
<p>Retrieves block details of a specific block at a given block height
Get block by height</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -384,16 +384,16 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L110">src/generated/apis/BlocksApi.ts:110</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L110">src/generated/apis/BlocksApi.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a specific block by height</p>
<p>Retrieves block details of a specific block at a given block height</p>
</div>
<dl class="tsd-comment-tags">
<dt>summary</dt>
<dd><p>Get block</p>
<dd><p>Get block by height</p>
</dd>
<dt>throws</dt>
<dd><p>{RequiredError}</p>
@@ -426,12 +426,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L133">src/generated/apis/BlocksApi.ts:133</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L133">src/generated/apis/BlocksApi.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get all recently mined blocks
<p>Retrieves a list of recently mined blocks
Get recent blocks</p>
</div>
</div>
@@ -458,12 +458,12 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/04f3c68a/client/src/generated/apis/BlocksApi.ts#L127">src/generated/apis/BlocksApi.ts:127</a></li>
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/f29919b5/client/src/generated/apis/BlocksApi.ts#L127">src/generated/apis/BlocksApi.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get all recently mined blocks</p>
<p>Retrieves a list of recently mined blocks</p>
</div>
<dl class="tsd-comment-tags">
<dt>summary</dt>