mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-01-12 22:43:34 +08:00
506 lines
34 KiB
HTML
506 lines
34 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>FeesApi | @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.feesapi.html">FeesApi</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class FeesApi</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>
|
|
<a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">FeesApi</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/generated.feesapiinterface.html" class="tsd-signature-type" data-tsd-kind="Interface">FeesApiInterface</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 tsd-is-inherited">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="generated.feesapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="generated.feesapi.html#configuration" class="tsd-kind-icon">configuration</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-class"><a href="generated.feesapi.html#fetchfeerate" class="tsd-kind-icon">fetch<wbr>Fee<wbr>Rate</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.feesapi.html#fetchfeerateraw" class="tsd-kind-icon">fetch<wbr>Fee<wbr>Rate<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.feesapi.html#getfeetransfer" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.feesapi.html#getfeetransferraw" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="generated.feesapi.html#request" class="tsd-kind-icon">request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.feesapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.feesapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.feesapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Fees<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.feesapi.html" class="tsd-signature-type" data-tsd-kind="Class">FeesApi</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L25">src/generated/runtime.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>configuration: <a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol"> = ...</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="generated.feesapi.html" class="tsd-signature-type" data-tsd-kind="Class">FeesApi</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a name="configuration" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
|
|
<div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="generated_runtime.configuration.html" class="tsd-signature-type" data-tsd-kind="Class">Configuration</a><span class="tsd-signature-symbol"> = ...</span></div>
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#configuration">configuration</a></p>
|
|
</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-class">
|
|
<a name="fetchfeerate" class="tsd-anchor"></a>
|
|
<h3>fetch<wbr>Fee<wbr>Rate</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Fee<wbr>Rate<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.fetchfeeraterequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchFeeRateRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated.feerate.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRate</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/generated.feesapiinterface.html">FeesApiInterface</a>.<a href="../interfaces/generated.feesapiinterface.html#fetchfeerate">fetchFeeRate</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/FeesApi.ts#L105">src/generated/apis/FeesApi.ts:105</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves estimated fee rate.
|
|
fetch fee rate</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.fetchfeeraterequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchFeeRateRequest</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated.feerate.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRate</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="fetchfeerateraw" class="tsd-anchor"></a>
|
|
<h3>fetch<wbr>Fee<wbr>Rate<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">fetch<wbr>Fee<wbr>Rate<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.fetchfeeraterequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchFeeRateRequest</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated.feerate.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRate</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/generated.feesapiinterface.html">FeesApiInterface</a>.<a href="../interfaces/generated.feesapiinterface.html#fetchfeerateraw">fetchFeeRateRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/FeesApi.ts#L79">src/generated/apis/FeesApi.ts:79</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves estimated fee rate.
|
|
fetch fee rate</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.fetchfeeraterequest.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchFeeRateRequest</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated.feerate.html" class="tsd-signature-type" data-tsd-kind="Interface">FeeRate</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getfeetransfer" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Fee<wbr>Transfer</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>Transfer<span class="tsd-signature-symbol">(</span>initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/generated.feesapiinterface.html">FeesApiInterface</a>.<a href="../interfaces/generated.feesapiinterface.html#getfeetransfer">getFeeTransfer</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/FeesApi.ts#L133">src/generated/apis/FeesApi.ts:133</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
|
|
Get estimated fee</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getfeetransferraw" class="tsd-anchor"></a>
|
|
<h3>get<wbr>Fee<wbr>Transfer<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Fee<wbr>Transfer<wbr>Raw<span class="tsd-signature-symbol">(</span>initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of <a href="../interfaces/generated.feesapiinterface.html">FeesApiInterface</a>.<a href="../interfaces/generated.feesapiinterface.html#getfeetransferraw">getFeeTransferRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/FeesApi.ts#L114">src/generated/apis/FeesApi.ts:114</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer
|
|
Get estimated fee</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/generated_runtime.apiresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ApiResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a name="request" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> request</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<li class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a>, initOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#request">request</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L47">src/generated/runtime.ts:47</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>context: <a href="../interfaces/generated_runtime.requestopts.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOpts</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> initOverrides: <span class="tsd-signature-type">RequestInit</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a name="withmiddleware" class="tsd-anchor"></a>
|
|
<h3>with<wbr>Middleware</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Middleware<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>middlewares<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#withmiddleware">withMiddleware</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L31">src/generated/runtime.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>middlewares: <a href="../interfaces/generated_runtime.middleware.html" class="tsd-signature-type" data-tsd-kind="Interface">Middleware</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a name="withpostmiddleware" class="tsd-anchor"></a>
|
|
<h3>with<wbr>Post<wbr>Middleware</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Post<wbr>Middleware<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>postMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-signature-type" data-tsd-kind="Interface">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#withpostmiddleware">withPostMiddleware</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L42">src/generated/runtime.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>postMiddlewares: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.responsecontext.html" class="tsd-signature-type" data-tsd-kind="Interface">ResponseContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a name="withpremiddleware" class="tsd-anchor"></a>
|
|
<h3>with<wbr>Pre<wbr>Middleware</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Pre<wbr>Middleware<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>preMiddlewares<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchParams</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="generated_runtime.baseapi.html">BaseAPI</a>.<a href="generated_runtime.baseapi.html#withpremiddleware">withPreMiddleware</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/runtime.ts#L37">src/generated/runtime.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
<ul class="tsd-type-parameters">
|
|
<li>
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="generated_runtime.baseapi.html" class="tsd-signature-type" data-tsd-kind="Class">BaseAPI</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>preMiddlewares: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_runtime.requestcontext.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/generated_runtime.fetchparams.html" class="tsd-signature-type" data-tsd-kind="Interface">FetchParams</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</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="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-class tsd-parent-kind-module">
|
|
<a href="generated.feesapi.html" class="tsd-kind-icon">Fees<wbr>Api</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="generated.feesapi.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="generated.feesapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.feesapi.html#fetchfeerate" class="tsd-kind-icon">fetch<wbr>Fee<wbr>Rate</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.feesapi.html#fetchfeerateraw" class="tsd-kind-icon">fetch<wbr>Fee<wbr>Rate<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.feesapi.html#getfeetransfer" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.feesapi.html#getfeetransferraw" class="tsd-kind-icon">get<wbr>Fee<wbr>Transfer<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="generated.feesapi.html#request" class="tsd-kind-icon">request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a href="generated.feesapi.html#withmiddleware" class="tsd-kind-icon">with<wbr>Middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a href="generated.feesapi.html#withpostmiddleware" class="tsd-kind-icon">with<wbr>Post<wbr>Middleware</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a href="generated.feesapi.html#withpremiddleware" class="tsd-kind-icon">with<wbr>Pre<wbr>Middleware</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-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>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</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> |