mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-01-12 22:43:34 +08:00
655 lines
31 KiB
HTML
655 lines
31 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>RosettaOptions | @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.rosettaoptions.html">RosettaOptions</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface RosettaOptions</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The options that will be sent directly to /construction/metadata by the caller.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>export</dt>
|
|
<dd></dd>
|
|
<dt>interface</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">RosettaOptions</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#amount" class="tsd-kind-icon">amount</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#burn_block_height" class="tsd-kind-icon">burn_<wbr>block_<wbr>height</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#contract_address" class="tsd-kind-icon">contract_<wbr>address</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#contract_name" class="tsd-kind-icon">contract_<wbr>name</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#decimals" class="tsd-kind-icon">decimals</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#delegate_to" class="tsd-kind-icon">delegate_<wbr>to</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#fee" class="tsd-kind-icon">fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#gas_limit" class="tsd-kind-icon">gas_<wbr>limit</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#gas_price" class="tsd-kind-icon">gas_<wbr>price</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#max_fee" class="tsd-kind-icon">max_<wbr>fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#memo" class="tsd-kind-icon">memo</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#number_of_cycles" class="tsd-kind-icon">number_<wbr>of_<wbr>cycles</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#pox_addr" class="tsd-kind-icon">pox_<wbr>addr</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#sender_address" class="tsd-kind-icon">sender_<wbr>address</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#size" class="tsd-kind-icon">size</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#status" class="tsd-kind-icon">status</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#suggested_fee_multiplier" class="tsd-kind-icon">suggested_<wbr>fee_<wbr>multiplier</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#symbol" class="tsd-kind-icon">symbol</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#token_transfer_recipient_address" class="tsd-kind-icon">token_<wbr>transfer_<wbr>recipient_<wbr>address</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaoptions.html#type" class="tsd-kind-icon">type</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="amount" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> amount</h3>
|
|
<div class="tsd-signature tsd-kind-icon">amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L51">src/generated/models/RosettaOptions.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Amount to be transfered.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="burn_block_height" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> burn_<wbr>block_<wbr>height</h3>
|
|
<div class="tsd-signature tsd-kind-icon">burn_<wbr>block_<wbr>height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L129">src/generated/models/RosettaOptions.ts:129</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Set the burnchain (BTC) block for stacking lock to start.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="contract_address" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> contract_<wbr>address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">contract_<wbr>address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L117">src/generated/models/RosettaOptions.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Address of the contract to call.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="contract_name" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> contract_<wbr>name</h3>
|
|
<div class="tsd-signature tsd-kind-icon">contract_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L123">src/generated/models/RosettaOptions.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Name of the contract to call.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="decimals" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> decimals</h3>
|
|
<div class="tsd-signature tsd-kind-icon">decimals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L63">src/generated/models/RosettaOptions.ts:63</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Number of decimal places</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="delegate_to" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> delegate_<wbr>to</h3>
|
|
<div class="tsd-signature tsd-kind-icon">delegate_<wbr>to<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L135">src/generated/models/RosettaOptions.ts:135</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Delegator address for when calling <code>delegate-stacking</code>.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="fee" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> fee</h3>
|
|
<div class="tsd-signature tsd-kind-icon">fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L93">src/generated/models/RosettaOptions.ts:93</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fee for this transaction</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="gas_limit" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> gas_<wbr>limit</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gas_<wbr>limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L69">src/generated/models/RosettaOptions.ts:69</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Maximum price a user is willing to pay.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="gas_price" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> gas_<wbr>price</h3>
|
|
<div class="tsd-signature tsd-kind-icon">gas_<wbr>price<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L75">src/generated/models/RosettaOptions.ts:75</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Cost necessary to perform a transaction on the network</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="max_fee" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max_<wbr>fee</h3>
|
|
<div class="tsd-signature tsd-kind-icon">max_<wbr>fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L87">src/generated/models/RosettaOptions.ts:87</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Maximum fee user is willing to pay</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="memo" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> memo</h3>
|
|
<div class="tsd-signature tsd-kind-icon">memo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L105">src/generated/models/RosettaOptions.ts:105</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>STX token transfer memo.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="number_of_cycles" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> number_<wbr>of_<wbr>cycles</h3>
|
|
<div class="tsd-signature tsd-kind-icon">number_<wbr>of_<wbr>cycles<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L111">src/generated/models/RosettaOptions.ts:111</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Number of cycles when stacking.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="pox_addr" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> pox_<wbr>addr</h3>
|
|
<div class="tsd-signature tsd-kind-icon">pox_<wbr>addr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L141">src/generated/models/RosettaOptions.ts:141</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The reward address for stacking transaction. It should be a valid Bitcoin address</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="sender_address" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> sender_<wbr>address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">sender_<wbr>address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L27">src/generated/models/RosettaOptions.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>sender's address</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="size" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> size</h3>
|
|
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L99">src/generated/models/RosettaOptions.ts:99</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Transaction approximative size (used to calculate total fee).</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="status" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
|
|
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L39">src/generated/models/RosettaOptions.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>This value indicates the state of the operations</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="suggested_fee_multiplier" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> suggested_<wbr>fee_<wbr>multiplier</h3>
|
|
<div class="tsd-signature tsd-kind-icon">suggested_<wbr>fee_<wbr>multiplier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L81">src/generated/models/RosettaOptions.ts:81</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p> A suggested fee multiplier to indicate that the suggested fee should be scaled. This may be used to set higher fees for urgent transactions or to pay lower fees when there is less urgency.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="symbol" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> symbol</h3>
|
|
<div class="tsd-signature tsd-kind-icon">symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L57">src/generated/models/RosettaOptions.ts:57</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Currency symbol e.g STX</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="token_transfer_recipient_address" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> token_<wbr>transfer_<wbr>recipient_<wbr>address</h3>
|
|
<div class="tsd-signature tsd-kind-icon">token_<wbr>transfer_<wbr>recipient_<wbr>address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L45">src/generated/models/RosettaOptions.ts:45</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Recipient's address</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="type" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/hirosystems/stacks-blockchain-api/blob/887b7d61/client/src/generated/models/RosettaOptions.ts#L33">src/generated/models/RosettaOptions.ts:33</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Type of operation e.g transfer</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>memberof</dt>
|
|
<dd><p>RosettaOptions</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/generated.html">generated</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/generated_runtime.html">generated/runtime</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/socket_io.html">socket-<wbr>io</a>
|
|
</li>
|
|
<li class=" tsd-kind-module">
|
|
<a href="../modules/ws.html">ws</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="generated.rosettaoptions.html" class="tsd-kind-icon">Rosetta<wbr>Options</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#amount" class="tsd-kind-icon">amount</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#burn_block_height" class="tsd-kind-icon">burn_<wbr>block_<wbr>height</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#contract_address" class="tsd-kind-icon">contract_<wbr>address</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#contract_name" class="tsd-kind-icon">contract_<wbr>name</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#decimals" class="tsd-kind-icon">decimals</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#delegate_to" class="tsd-kind-icon">delegate_<wbr>to</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#fee" class="tsd-kind-icon">fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#gas_limit" class="tsd-kind-icon">gas_<wbr>limit</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#gas_price" class="tsd-kind-icon">gas_<wbr>price</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#max_fee" class="tsd-kind-icon">max_<wbr>fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#memo" class="tsd-kind-icon">memo</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#number_of_cycles" class="tsd-kind-icon">number_<wbr>of_<wbr>cycles</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#pox_addr" class="tsd-kind-icon">pox_<wbr>addr</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#sender_address" class="tsd-kind-icon">sender_<wbr>address</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#size" class="tsd-kind-icon">size</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#status" class="tsd-kind-icon">status</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#suggested_fee_multiplier" class="tsd-kind-icon">suggested_<wbr>fee_<wbr>multiplier</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#symbol" class="tsd-kind-icon">symbol</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#token_transfer_recipient_address" class="tsd-kind-icon">token_<wbr>transfer_<wbr>recipient_<wbr>address</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="generated.rosettaoptions.html#type" class="tsd-kind-icon">type</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |