kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-05-10 13:51:42 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
0880faf7e6316250ee7897e9d3a696c2ef226c19
stacks-blockchain-api/client/interfaces/generated.rosettaconstructionpreprocessrequest.html

283 lines
13 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RosettaConstructionPreprocessRequest | @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.rosettaconstructionpreprocessrequest.html">RosettaConstructionPreprocessRequest</a>
</li>
</ul>
<h1>Interface RosettaConstructionPreprocessRequest</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>ConstructionPreprocessRequest is passed to the /construction/preprocess endpoint so that a Rosetta implementation can determine which metadata it needs to request for construction</p>
</div>
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>interface</dt>
<dd><p>RosettaConstructionPreprocessRequest</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">RosettaConstructionPreprocessRequest</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.rosettaconstructionpreprocessrequest.html#max_fee" class="tsd-kind-icon">max_<wbr>fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaconstructionpreprocessrequest.html#metadata" class="tsd-kind-icon">metadata</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaconstructionpreprocessrequest.html#network_identifier" class="tsd-kind-icon">network_<wbr>identifier</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaconstructionpreprocessrequest.html#operations" class="tsd-kind-icon">operations</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="generated.rosettaconstructionpreprocessrequest.html#suggested_fee_multiplier" class="tsd-kind-icon">suggested_<wbr>fee_<wbr>multiplier</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="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> <a href="generated.rosettamaxfeeamount.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaMaxFeeAmount</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/RosettaConstructionPreprocessRequest.ts#L60">src/generated/models/RosettaConstructionPreprocessRequest.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>RosettaConstructionPreprocessRequest</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="metadata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/RosettaConstructionPreprocessRequest.ts#L54">src/generated/models/RosettaConstructionPreprocessRequest.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>RosettaConstructionPreprocessRequest</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="network_identifier" class="tsd-anchor"></a>
<h3>network_<wbr>identifier</h3>
<div class="tsd-signature tsd-kind-icon">network_<wbr>identifier<span class="tsd-signature-symbol">:</span> <a href="generated.networkidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">NetworkIdentifier</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/RosettaConstructionPreprocessRequest.ts#L42">src/generated/models/RosettaConstructionPreprocessRequest.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>RosettaConstructionPreprocessRequest</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="operations" class="tsd-anchor"></a>
<h3>operations</h3>
<div class="tsd-signature tsd-kind-icon">operations<span class="tsd-signature-symbol">:</span> <a href="generated.rosettaoperation.html" class="tsd-signature-type" data-tsd-kind="Interface">RosettaOperation</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/RosettaConstructionPreprocessRequest.ts#L48">src/generated/models/RosettaConstructionPreprocessRequest.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>RosettaConstructionPreprocessRequest</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/blockstack/stacks-blockchain-api/blob/7dcb019/client/src/generated/models/RosettaConstructionPreprocessRequest.ts#L66">src/generated/models/RosettaConstructionPreprocessRequest.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p> The caller can also provide 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. It is assumed that providing a very low multiplier (like 0.0001) will never lead to a transaction being created with a fee less than the minimum network fee (if applicable). In the case that the caller provides both a max fee and a suggested fee multiplier, the max fee will set an upper bound on the suggested fee (regardless of the multiplier provided).</p>
</div>
<dl class="tsd-comment-tags">
<dt>memberof</dt>
<dd><p>RosettaConstructionPreprocessRequest</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.rosettaconstructionpreprocessrequest.html" class="tsd-kind-icon">Rosetta<wbr>Construction<wbr>Preprocess<wbr>Request</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.rosettaconstructionpreprocessrequest.html#max_fee" class="tsd-kind-icon">max_<wbr>fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.rosettaconstructionpreprocessrequest.html#metadata" class="tsd-kind-icon">metadata</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.rosettaconstructionpreprocessrequest.html#network_identifier" class="tsd-kind-icon">network_<wbr>identifier</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.rosettaconstructionpreprocessrequest.html#operations" class="tsd-kind-icon">operations</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="generated.rosettaconstructionpreprocessrequest.html#suggested_fee_multiplier" class="tsd-kind-icon">suggested_<wbr>fee_<wbr>multiplier</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink