mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-01-12 22:43:34 +08:00
1542 lines
130 KiB
HTML
1542 lines
130 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>RosettaApi | @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.rosettaapi.html">RosettaApi</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class RosettaApi</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">RosettaApi</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/generated.rosettaapiinterface.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaApiInterface</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.rosettaapi.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.rosettaapi.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 tsd-is-inherited tsd-is-protected"><a href="generated.rosettaapi.html#request" class="tsd-kind-icon">request</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaaccountbalance" class="tsd-kind-icon">rosetta<wbr>Account<wbr>Balance</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaaccountbalanceraw" class="tsd-kind-icon">rosetta<wbr>Account<wbr>Balance<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettablock" class="tsd-kind-icon">rosetta<wbr>Block</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettablockraw" class="tsd-kind-icon">rosetta<wbr>Block<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettablocktransaction" class="tsd-kind-icon">rosetta<wbr>Block<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettablocktransactionraw" class="tsd-kind-icon">rosetta<wbr>Block<wbr>Transaction<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructioncombine" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Combine</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructioncombineraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Combine<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionderive" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Derive</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionderiveraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Derive<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionhash" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Hash</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionhashraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Hash<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionmetadata" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Metadata</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionmetadataraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Metadata<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionparse" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Parse</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionparseraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Parse<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionpayloads" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Payloads</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionpayloadsraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Payloads<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionpreprocess" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Preprocess</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionpreprocessraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Preprocess<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionsubmit" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Submit</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettaconstructionsubmitraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Submit<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettamempool" class="tsd-kind-icon">rosetta<wbr>Mempool</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettamempoolraw" class="tsd-kind-icon">rosetta<wbr>Mempool<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettamempooltransaction" class="tsd-kind-icon">rosetta<wbr>Mempool<wbr>Transaction</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettamempooltransactionraw" class="tsd-kind-icon">rosetta<wbr>Mempool<wbr>Transaction<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettanetworklist" class="tsd-kind-icon">rosetta<wbr>Network<wbr>List</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettanetworklistraw" class="tsd-kind-icon">rosetta<wbr>Network<wbr>List<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettanetworkoptions" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Options</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettanetworkoptionsraw" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Options<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettanetworkstatus" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Status</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.rosettaapi.html#rosettanetworkstatusraw" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Status<wbr>Raw</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="generated.rosettaapi.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.rosettaapi.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.rosettaapi.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>Rosetta<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.rosettaapi.html" class="tsd-signature-type" data-tsd-kind="Class">RosettaApi</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.rosettaapi.html" class="tsd-signature-type" data-tsd-kind="Class">RosettaApi</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 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">
|
|
<a name="rosettaaccountbalance" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Account<wbr>Balance</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Account<wbr>Balance<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaaccountbalanceoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceOperationRequest</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.rosettaaccountbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaaccountbalance">rosettaAccountBalance</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L472">src/generated/apis/RosettaApi.ts:472</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint. If the block_identifier is populated, a historical balance query should be performed.
|
|
Get an Account Balance</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaaccountbalanceoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceOperationRequest</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.rosettaaccountbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceResponse</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="rosettaaccountbalanceraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Account<wbr>Balance<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Account<wbr>Balance<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaaccountbalanceoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceOperationRequest</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.rosettaaccountbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaaccountbalanceraw">rosettaAccountBalanceRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L446">src/generated/apis/RosettaApi.ts:446</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint. If the block_identifier is populated, a historical balance query should be performed.
|
|
Get an Account Balance</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaaccountbalanceoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceOperationRequest</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.rosettaaccountbalanceresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaAccountBalanceResponse</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="rosettablock" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Block</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Block<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettablockoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockOperationRequest</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.rosettablockresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettablock">rosettaBlock</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L507">src/generated/apis/RosettaApi.ts:507</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the Block information for a given block identifier including a list of all transactions in the block.
|
|
Get a Block</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettablockoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockOperationRequest</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.rosettablockresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockResponse</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="rosettablockraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Block<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Block<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettablockoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockOperationRequest</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.rosettablockresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettablockraw">rosettaBlockRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L481">src/generated/apis/RosettaApi.ts:481</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the Block information for a given block identifier including a list of all transactions in the block.
|
|
Get a Block</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettablockoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockOperationRequest</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.rosettablockresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockResponse</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="rosettablocktransaction" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Block<wbr>Transaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Block<wbr>Transaction<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettablocktransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionOperationRequest</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.rosettablocktransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettablocktransaction">rosettaBlockTransaction</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L542">src/generated/apis/RosettaApi.ts:542</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a Transaction included in a block that is not returned in a BlockResponse.
|
|
Get a Block Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettablocktransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionOperationRequest</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.rosettablocktransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionResponse</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="rosettablocktransactionraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Block<wbr>Transaction<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Block<wbr>Transaction<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettablocktransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionOperationRequest</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.rosettablocktransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettablocktransactionraw">rosettaBlockTransactionRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L516">src/generated/apis/RosettaApi.ts:516</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a Transaction included in a block that is not returned in a BlockResponse.
|
|
Get a Block Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettablocktransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionOperationRequest</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.rosettablocktransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaBlockTransactionResponse</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="rosettaconstructioncombine" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Combine</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Combine<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructioncombineoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineOperationRequest</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.rosettaconstructioncombineresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructioncombine">rosettaConstructionCombine</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L577">src/generated/apis/RosettaApi.ts:577</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Take unsigned transaction and signature, combine both and return signed transaction
|
|
Create Network Transaction from Signatures</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructioncombineoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineOperationRequest</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.rosettaconstructioncombineresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineResponse</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="rosettaconstructioncombineraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Combine<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Combine<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructioncombineoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineOperationRequest</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.rosettaconstructioncombineresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructioncombineraw">rosettaConstructionCombineRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L551">src/generated/apis/RosettaApi.ts:551</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Take unsigned transaction and signature, combine both and return signed transaction
|
|
Create Network Transaction from Signatures</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructioncombineoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineOperationRequest</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.rosettaconstructioncombineresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionCombineResponse</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="rosettaconstructionderive" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Derive</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Derive<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionderiveoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveOperationRequest</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.rosettaconstructionderiveresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionderive">rosettaConstructionDerive</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L612">src/generated/apis/RosettaApi.ts:612</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the Account Identifier information based on a Public Key for a given network
|
|
Derive an AccountIdentifier from a PublicKey</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionderiveoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveOperationRequest</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.rosettaconstructionderiveresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveResponse</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="rosettaconstructionderiveraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Derive<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Derive<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionderiveoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveOperationRequest</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.rosettaconstructionderiveresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionderiveraw">rosettaConstructionDeriveRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L586">src/generated/apis/RosettaApi.ts:586</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the Account Identifier information based on a Public Key for a given network
|
|
Derive an AccountIdentifier from a PublicKey</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionderiveoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveOperationRequest</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.rosettaconstructionderiveresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionDeriveResponse</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="rosettaconstructionhash" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Hash</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Hash<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionhashoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashOperationRequest</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.rosettaconstructionhashresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionhash">rosettaConstructionHash</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L647">src/generated/apis/RosettaApi.ts:647</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the network-specific transaction hash for a signed transaction.
|
|
Get the Hash of a Signed Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionhashoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashOperationRequest</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.rosettaconstructionhashresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashResponse</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="rosettaconstructionhashraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Hash<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Hash<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionhashoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashOperationRequest</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.rosettaconstructionhashresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionhashraw">rosettaConstructionHashRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L621">src/generated/apis/RosettaApi.ts:621</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the network-specific transaction hash for a signed transaction.
|
|
Get the Hash of a Signed Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionhashoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashOperationRequest</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.rosettaconstructionhashresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionHashResponse</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="rosettaconstructionmetadata" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Metadata</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Metadata<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionmetadataoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataOperationRequest</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.rosettaconstructionmetadataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionmetadata">rosettaConstructionMetadata</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L682">src/generated/apis/RosettaApi.ts:682</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>To Do
|
|
Get Metadata for Transaction Construction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionmetadataoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataOperationRequest</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.rosettaconstructionmetadataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataResponse</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="rosettaconstructionmetadataraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Metadata<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Metadata<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionmetadataoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataOperationRequest</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.rosettaconstructionmetadataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionmetadataraw">rosettaConstructionMetadataRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L656">src/generated/apis/RosettaApi.ts:656</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>To Do
|
|
Get Metadata for Transaction Construction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionmetadataoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataOperationRequest</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.rosettaconstructionmetadataresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionMetadataResponse</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="rosettaconstructionparse" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Parse</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Parse<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionparseoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseOperationRequest</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.rosettaconstructionparseresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionparse">rosettaConstructionParse</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L717">src/generated/apis/RosettaApi.ts:717</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>TODO
|
|
Parse a Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionparseoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseOperationRequest</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.rosettaconstructionparseresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseResponse</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="rosettaconstructionparseraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Parse<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Parse<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionparseoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseOperationRequest</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.rosettaconstructionparseresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionparseraw">rosettaConstructionParseRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L691">src/generated/apis/RosettaApi.ts:691</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>TODO
|
|
Parse a Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionparseoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseOperationRequest</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.rosettaconstructionparseresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionParseResponse</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="rosettaconstructionpayloads" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Payloads</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Payloads<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionpayloadsoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadsOperationRequest</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.rosettaconstructionpayloadresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionpayloads">rosettaConstructionPayloads</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L752">src/generated/apis/RosettaApi.ts:752</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generate and unsigned transaction from operations and metadata
|
|
Generate an Unsigned Transaction and Signing Payloads</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionpayloadsoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadsOperationRequest</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.rosettaconstructionpayloadresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadResponse</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="rosettaconstructionpayloadsraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Payloads<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Payloads<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionpayloadsoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadsOperationRequest</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.rosettaconstructionpayloadresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionpayloadsraw">rosettaConstructionPayloadsRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L726">src/generated/apis/RosettaApi.ts:726</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generate and unsigned transaction from operations and metadata
|
|
Generate an Unsigned Transaction and Signing Payloads</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionpayloadsoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadsOperationRequest</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.rosettaconstructionpayloadresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPayloadResponse</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="rosettaconstructionpreprocess" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Preprocess</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Preprocess<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionpreprocessoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessOperationRequest</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.rosettaconstructionpreprocessresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionpreprocess">rosettaConstructionPreprocess</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L787">src/generated/apis/RosettaApi.ts:787</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>TODO
|
|
Create a Request to Fetch Metadata</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionpreprocessoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessOperationRequest</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.rosettaconstructionpreprocessresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessResponse</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="rosettaconstructionpreprocessraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Preprocess<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Preprocess<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionpreprocessoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessOperationRequest</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.rosettaconstructionpreprocessresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionpreprocessraw">rosettaConstructionPreprocessRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L761">src/generated/apis/RosettaApi.ts:761</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>TODO
|
|
Create a Request to Fetch Metadata</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionpreprocessoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessOperationRequest</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.rosettaconstructionpreprocessresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionPreprocessResponse</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="rosettaconstructionsubmit" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Submit</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Submit<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionsubmitoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitOperationRequest</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.rosettaconstructionsubmitresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionsubmit">rosettaConstructionSubmit</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L822">src/generated/apis/RosettaApi.ts:822</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Submit a pre-signed transaction to the node.
|
|
Submit a Signed Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionsubmitoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitOperationRequest</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.rosettaconstructionsubmitresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitResponse</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="rosettaconstructionsubmitraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Construction<wbr>Submit<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Construction<wbr>Submit<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettaconstructionsubmitoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitOperationRequest</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.rosettaconstructionsubmitresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettaconstructionsubmitraw">rosettaConstructionSubmitRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L796">src/generated/apis/RosettaApi.ts:796</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Submit a pre-signed transaction to the node.
|
|
Submit a Signed Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettaconstructionsubmitoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitOperationRequest</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.rosettaconstructionsubmitresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaConstructionSubmitResponse</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="rosettamempool" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Mempool</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Mempool<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettamempooloperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolOperationRequest</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.rosettamempoolresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettamempool">rosettaMempool</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L857">src/generated/apis/RosettaApi.ts:857</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of transcations currently in the mempool for a given network.
|
|
Get All Mempool Transactions</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettamempooloperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolOperationRequest</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.rosettamempoolresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolResponse</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="rosettamempoolraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Mempool<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Mempool<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettamempooloperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolOperationRequest</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.rosettamempoolresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettamempoolraw">rosettaMempoolRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L831">src/generated/apis/RosettaApi.ts:831</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of transcations currently in the mempool for a given network.
|
|
Get All Mempool Transactions</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettamempooloperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolOperationRequest</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.rosettamempoolresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolResponse</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="rosettamempooltransaction" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Mempool<wbr>Transaction</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Mempool<wbr>Transaction<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettamempooltransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionOperationRequest</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.rosettamempooltransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettamempooltransaction">rosettaMempoolTransaction</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L892">src/generated/apis/RosettaApi.ts:892</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves transaction details from the mempool for a given transaction id from a given network.
|
|
Get a Mempool Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettamempooltransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionOperationRequest</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.rosettamempooltransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionResponse</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="rosettamempooltransactionraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Mempool<wbr>Transaction<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Mempool<wbr>Transaction<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettamempooltransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionOperationRequest</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.rosettamempooltransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettamempooltransactionraw">rosettaMempoolTransactionRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L866">src/generated/apis/RosettaApi.ts:866</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves transaction details from the mempool for a given transaction id from a given network.
|
|
Get a Mempool Transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettamempooltransactionoperationrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionOperationRequest</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.rosettamempooltransactionresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMempoolTransactionResponse</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="rosettanetworklist" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Network<wbr>List</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Network<wbr>List<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.rosettanetworklistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkListResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettanetworklist">rosettaNetworkList</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L920">src/generated/apis/RosettaApi.ts:920</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
|
|
Get List of Available Networks</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.rosettanetworklistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkListResponse</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="rosettanetworklistraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Network<wbr>List<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Network<wbr>List<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><a href="../interfaces/generated.rosettanetworklistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkListResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettanetworklistraw">rosettaNetworkListRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L901">src/generated/apis/RosettaApi.ts:901</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
|
|
Get List of Available Networks</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><a href="../interfaces/generated.rosettanetworklistresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkListResponse</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="rosettanetworkoptions" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Network<wbr>Options</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Network<wbr>Options<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettanetworkoptionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsRequest</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.rosettanetworkoptionsresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettanetworkoptions">rosettaNetworkOptions</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L955">src/generated/apis/RosettaApi.ts:955</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.
|
|
Get Network Options</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettanetworkoptionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsRequest</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.rosettanetworkoptionsresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsResponse</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="rosettanetworkoptionsraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Network<wbr>Options<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Network<wbr>Options<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettanetworkoptionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsRequest</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.rosettanetworkoptionsresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsResponse</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettanetworkoptionsraw">rosettaNetworkOptionsRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L929">src/generated/apis/RosettaApi.ts:929</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.
|
|
Get Network Options</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettanetworkoptionsrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsRequest</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.rosettanetworkoptionsresponse.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkOptionsResponse</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="rosettanetworkstatus" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Network<wbr>Status</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Network<wbr>Status<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettanetworkstatusrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkStatusRequest</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-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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettanetworkstatus">rosettaNetworkStatus</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L990">src/generated/apis/RosettaApi.ts:990</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here.
|
|
Get Network Status</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettanetworkstatusrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkStatusRequest</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-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="rosettanetworkstatusraw" class="tsd-anchor"></a>
|
|
<h3>rosetta<wbr>Network<wbr>Status<wbr>Raw</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">rosetta<wbr>Network<wbr>Status<wbr>Raw<span class="tsd-signature-symbol">(</span>requestParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated.rosettanetworkstatusrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkStatusRequest</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><span class="tsd-signature-symbol">{}</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.rosettaapiinterface.html">RosettaApiInterface</a>.<a href="../interfaces/generated.rosettaapiinterface.html#rosettanetworkstatusraw">rosettaNetworkStatusRaw</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/apis/RosettaApi.ts#L964">src/generated/apis/RosettaApi.ts:964</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here.
|
|
Get Network Status</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>requestParameters: <a href="../interfaces/generated.rosettanetworkstatusrequest.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaNetworkStatusRequest</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><span class="tsd-signature-symbol">{}</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-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.rosettaapi.html" class="tsd-kind-icon">Rosetta<wbr>Api</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="generated.rosettaapi.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.rosettaapi.html#configuration" class="tsd-kind-icon">configuration</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
|
<a href="generated.rosettaapi.html#request" class="tsd-kind-icon">request</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaaccountbalance" class="tsd-kind-icon">rosetta<wbr>Account<wbr>Balance</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaaccountbalanceraw" class="tsd-kind-icon">rosetta<wbr>Account<wbr>Balance<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettablock" class="tsd-kind-icon">rosetta<wbr>Block</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettablockraw" class="tsd-kind-icon">rosetta<wbr>Block<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettablocktransaction" class="tsd-kind-icon">rosetta<wbr>Block<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettablocktransactionraw" class="tsd-kind-icon">rosetta<wbr>Block<wbr>Transaction<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructioncombine" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Combine</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructioncombineraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Combine<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionderive" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Derive</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionderiveraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Derive<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionhash" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Hash</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionhashraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Hash<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionmetadata" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Metadata</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionmetadataraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Metadata<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionparse" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Parse</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionparseraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Parse<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionpayloads" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Payloads</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionpayloadsraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Payloads<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionpreprocess" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Preprocess</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionpreprocessraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Preprocess<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionsubmit" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Submit</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettaconstructionsubmitraw" class="tsd-kind-icon">rosetta<wbr>Construction<wbr>Submit<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettamempool" class="tsd-kind-icon">rosetta<wbr>Mempool</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettamempoolraw" class="tsd-kind-icon">rosetta<wbr>Mempool<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettamempooltransaction" class="tsd-kind-icon">rosetta<wbr>Mempool<wbr>Transaction</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettamempooltransactionraw" class="tsd-kind-icon">rosetta<wbr>Mempool<wbr>Transaction<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettanetworklist" class="tsd-kind-icon">rosetta<wbr>Network<wbr>List</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettanetworklistraw" class="tsd-kind-icon">rosetta<wbr>Network<wbr>List<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettanetworkoptions" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Options</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettanetworkoptionsraw" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Options<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettanetworkstatus" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Status</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="generated.rosettaapi.html#rosettanetworkstatusraw" class="tsd-kind-icon">rosetta<wbr>Network<wbr>Status<wbr>Raw</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
|
|
<a href="generated.rosettaapi.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.rosettaapi.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.rosettaapi.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> |