mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 22:52:34 +08:00
690 lines
38 KiB
HTML
Vendored
690 lines
38 KiB
HTML
Vendored
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>StacksTransaction | Stacks.js 1.0.0 Library Reference</title>
|
|
<meta name="description" content="Documentation for Stacks.js 1.0.0 Library Reference">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<link rel="stylesheet" href="../assets/css/custom-style.css">
|
|
<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.js 1.0.0 Library Reference</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-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="stackstransaction.html">StacksTransaction</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class StacksTransaction</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>
|
|
<span class="target">StacksTransaction</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>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="stackstransaction.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#anchormode" class="tsd-kind-icon">anchor<wbr>Mode</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#auth" class="tsd-kind-icon">auth</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#chainid" class="tsd-kind-icon">chain<wbr>Id</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#payload" class="tsd-kind-icon">payload</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#postconditionmode" class="tsd-kind-icon">post<wbr>Condition<wbr>Mode</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#postconditions" class="tsd-kind-icon">post<wbr>Conditions</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stackstransaction.html#version" class="tsd-kind-icon">version</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#appendpubkey" class="tsd-kind-icon">append<wbr>Pubkey</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#createtxwithsignature" class="tsd-kind-icon">create<wbr>TxWith<wbr>Signature</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#serialize" class="tsd-kind-icon">serialize</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#setfee" class="tsd-kind-icon">set<wbr>Fee</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#setnonce" class="tsd-kind-icon">set<wbr>Nonce</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#setsponsor" class="tsd-kind-icon">set<wbr>Sponsor</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#setsponsornonce" class="tsd-kind-icon">set<wbr>Sponsor<wbr>Nonce</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#signandappend" class="tsd-kind-icon">sign<wbr>And<wbr>Append</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#signbegin" class="tsd-kind-icon">sign<wbr>Begin</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#signnextorigin" class="tsd-kind-icon">sign<wbr>Next<wbr>Origin</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#signnextsponsor" class="tsd-kind-icon">sign<wbr>Next<wbr>Sponsor</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#txid" class="tsd-kind-icon">txid</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#verifybegin" class="tsd-kind-icon">verify<wbr>Begin</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stackstransaction.html#verifyorigin" class="tsd-kind-icon">verify<wbr>Origin</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Stacks<wbr>Transaction<span class="tsd-signature-symbol">(</span>version<span class="tsd-signature-symbol">: </span><a href="../enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a>, auth<span class="tsd-signature-symbol">: </span><a href="authorization.html" class="tsd-signature-type">Authorization</a>, payload<span class="tsd-signature-symbol">: </span><a href="../enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a>, postConditions<span class="tsd-signature-symbol">?: </span><a href="../enums/stacksmessagetype.html#lengthprefixedlist" class="tsd-signature-type">LengthPrefixedList</a>, postConditionMode<span class="tsd-signature-symbol">?: </span><a href="../enums/postconditionmode.html" class="tsd-signature-type">PostConditionMode</a>, anchorMode<span class="tsd-signature-symbol">?: </span><a href="../enums/anchormode.html" class="tsd-signature-type">AnchorMode</a>, chainId<span class="tsd-signature-symbol">?: </span><a href="../enums/chainid.html" class="tsd-signature-type">ChainID</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L42">packages/transactions/src/transaction.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>version: <a href="../enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>auth: <a href="authorization.html" class="tsd-signature-type">Authorization</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>payload: <a href="../enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> postConditions: <a href="../enums/stacksmessagetype.html#lengthprefixedlist" class="tsd-signature-type">LengthPrefixedList</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> postConditionMode: <a href="../enums/postconditionmode.html" class="tsd-signature-type">PostConditionMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> anchorMode: <a href="../enums/anchormode.html" class="tsd-signature-type">AnchorMode</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> chainId: <a href="../enums/chainid.html" class="tsd-signature-type">ChainID</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h4>
|
|
</li>
|
|
</ul>
|
|
</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-class">
|
|
<a name="anchormode" class="tsd-anchor"></a>
|
|
<h3>anchor<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">anchor<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/anchormode.html" class="tsd-signature-type">AnchorMode</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L39">packages/transactions/src/transaction.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="auth" class="tsd-anchor"></a>
|
|
<h3>auth</h3>
|
|
<div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <a href="authorization.html" class="tsd-signature-type">Authorization</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L38">packages/transactions/src/transaction.ts:38</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="chainid" class="tsd-anchor"></a>
|
|
<h3>chain<wbr>Id</h3>
|
|
<div class="tsd-signature tsd-kind-icon">chain<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="../enums/chainid.html" class="tsd-signature-type">ChainID</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L37">packages/transactions/src/transaction.ts:37</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="payload" class="tsd-anchor"></a>
|
|
<h3>payload</h3>
|
|
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <a href="../enums/stacksmessagetype.html#payload" class="tsd-signature-type">Payload</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L40">packages/transactions/src/transaction.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="postconditionmode" class="tsd-anchor"></a>
|
|
<h3>post<wbr>Condition<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">post<wbr>Condition<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/postconditionmode.html" class="tsd-signature-type">PostConditionMode</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L41">packages/transactions/src/transaction.ts:41</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="postconditions" class="tsd-anchor"></a>
|
|
<h3>post<wbr>Conditions</h3>
|
|
<div class="tsd-signature tsd-kind-icon">post<wbr>Conditions<span class="tsd-signature-symbol">:</span> <a href="../interfaces/lengthprefixedlist.html" class="tsd-signature-type">LengthPrefixedList</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L42">packages/transactions/src/transaction.ts:42</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="version" class="tsd-anchor"></a>
|
|
<h3>version</h3>
|
|
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <a href="../enums/transactionversion.html" class="tsd-signature-type">TransactionVersion</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L36">packages/transactions/src/transaction.ts:36</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="appendpubkey" class="tsd-anchor"></a>
|
|
<h3>append<wbr>Pubkey</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">append<wbr>Pubkey<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><a href="../interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L132">packages/transactions/src/transaction.ts:132</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>publicKey: <a href="../interfaces/stackspublickey.html" class="tsd-signature-type">StacksPublicKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="createtxwithsignature" class="tsd-anchor"></a>
|
|
<h3>create<wbr>TxWith<wbr>Signature</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>TxWith<wbr>Signature<span class="tsd-signature-symbol">(</span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L91">packages/transactions/src/transaction.ts:91</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>signature: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="stackstransaction.html" class="tsd-signature-type">StacksTransaction</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="serialize" class="tsd-anchor"></a>
|
|
<h3>serialize</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">serialize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L203">packages/transactions/src/transaction.ts:203</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="setfee" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Fee</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Fee<span class="tsd-signature-symbol">(</span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L181">packages/transactions/src/transaction.ts:181</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Set the total fee to be paid for this transaction</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>amount: <span class="tsd-signature-type">BigNum</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="setnonce" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Nonce</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Nonce<span class="tsd-signature-symbol">(</span>nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L190">packages/transactions/src/transaction.ts:190</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Set the transaction nonce</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the nonce value</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="setsponsor" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Sponsor</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Sponsor<span class="tsd-signature-symbol">(</span>sponsorSpendingCondition<span class="tsd-signature-symbol">: </span><a href="../globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L168">packages/transactions/src/transaction.ts:168</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sponsorSpendingCondition: <a href="../globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="setsponsornonce" class="tsd-anchor"></a>
|
|
<h3>set<wbr>Sponsor<wbr>Nonce</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Sponsor<wbr>Nonce<span class="tsd-signature-symbol">(</span>nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigNum</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L199">packages/transactions/src/transaction.ts:199</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Set the transaction sponsor nonce</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>nonce: <span class="tsd-signature-type">BigNum</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the sponsor nonce value</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="signandappend" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>And<wbr>Append</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>And<wbr>Append<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><a href="../globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a>, curSigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, authType<span class="tsd-signature-symbol">: </span><a href="../enums/authtype.html" class="tsd-signature-type">AuthType</a>, privateKey<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L141">packages/transactions/src/transaction.ts:141</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>condition: <a href="../globals.html#spendingcondition" class="tsd-signature-type">SpendingCondition</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>curSigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>authType: <a href="../enums/authtype.html" class="tsd-signature-type">AuthType</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <a href="../interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="signbegin" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>Begin</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>Begin<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L79">packages/transactions/src/transaction.ts:79</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="signnextorigin" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>Next<wbr>Origin</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>Next<wbr>Origin<span class="tsd-signature-symbol">(</span>sigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L107">packages/transactions/src/transaction.ts:107</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <a href="../interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="signnextsponsor" class="tsd-anchor"></a>
|
|
<h3>sign<wbr>Next<wbr>Sponsor</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">sign<wbr>Next<wbr>Sponsor<span class="tsd-signature-symbol">(</span>sigHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, privateKey<span class="tsd-signature-symbol">: </span><a href="../interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L117">packages/transactions/src/transaction.ts:117</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sigHash: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>privateKey: <a href="../interfaces/stacksprivatekey.html" class="tsd-signature-type">StacksPrivateKey</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="txid" class="tsd-anchor"></a>
|
|
<h3>txid</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">txid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L163">packages/transactions/src/transaction.ts:163</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="verifybegin" class="tsd-anchor"></a>
|
|
<h3>verify<wbr>Begin</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">verify<wbr>Begin<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L85">packages/transactions/src/transaction.ts:85</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="verifyorigin" class="tsd-anchor"></a>
|
|
<h3>verify<wbr>Origin</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">verify<wbr>Origin<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/transaction.ts#L103">packages/transactions/src/transaction.ts:103</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="globals ">
|
|
<a href="../globals.html"><em>Globals</em></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">
|
|
<a href="stackstransaction.html" class="tsd-kind-icon">Stacks<wbr>Transaction</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#anchormode" class="tsd-kind-icon">anchor<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#auth" class="tsd-kind-icon">auth</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#chainid" class="tsd-kind-icon">chain<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#payload" class="tsd-kind-icon">payload</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#postconditionmode" class="tsd-kind-icon">post<wbr>Condition<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#postconditions" class="tsd-kind-icon">post<wbr>Conditions</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#version" class="tsd-kind-icon">version</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#appendpubkey" class="tsd-kind-icon">append<wbr>Pubkey</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#createtxwithsignature" class="tsd-kind-icon">create<wbr>TxWith<wbr>Signature</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#serialize" class="tsd-kind-icon">serialize</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#setfee" class="tsd-kind-icon">set<wbr>Fee</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#setnonce" class="tsd-kind-icon">set<wbr>Nonce</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#setsponsor" class="tsd-kind-icon">set<wbr>Sponsor</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#setsponsornonce" class="tsd-kind-icon">set<wbr>Sponsor<wbr>Nonce</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#signandappend" class="tsd-kind-icon">sign<wbr>And<wbr>Append</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#signbegin" class="tsd-kind-icon">sign<wbr>Begin</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#signnextorigin" class="tsd-kind-icon">sign<wbr>Next<wbr>Origin</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#signnextsponsor" class="tsd-kind-icon">sign<wbr>Next<wbr>Sponsor</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#txid" class="tsd-kind-icon">txid</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#verifybegin" class="tsd-kind-icon">verify<wbr>Begin</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="stackstransaction.html#verifyorigin" class="tsd-kind-icon">verify<wbr>Origin</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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> |