@ellcrys/spell

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TxBalanceBuilder | Spell Documentation</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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.js" 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">Spell Documentation</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> <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="../modules/transactionbuilder.html">TransactionBuilder</a> </li> <li> <a href="transactionbuilder.txbalancebuilder.html">TxBalanceBuilder</a> </li> </ul> <h1>Class TxBalanceBuilder</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>TxBalanceBuilder provides the ability to build and execute a balance transaction</p> </div> <dl class="tsd-comment-tags"> <dt>class</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="txutility.txutility-1.html" class="tsd-signature-type">TxUtility</a> <ul class="tsd-hierarchy"> <li> <span class="target">TxBalanceBuilder</span> </li> </ul> </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="transactionbuilder.txbalancebuilder.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="transactionbuilder.txbalancebuilder.html#client" class="tsd-kind-icon">client</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="transactionbuilder.txbalancebuilder.html#data" class="tsd-kind-icon">data</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="transactionbuilder.txbalancebuilder.html#fee" class="tsd-kind-icon">fee</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="transactionbuilder.txbalancebuilder.html#finalize" class="tsd-kind-icon">finalize</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#from" class="tsd-kind-icon">from</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transactionbuilder.txbalancebuilder.html#getbytesnohashandsig" class="tsd-kind-icon">get<wbr>Bytes<wbr>NoHash<wbr>And<wbr>Sig</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transactionbuilder.txbalancebuilder.html#hash" class="tsd-kind-icon">hash</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#nonce" class="tsd-kind-icon">nonce</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#packed" class="tsd-kind-icon">packed</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#payload" class="tsd-kind-icon">payload</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#reset" class="tsd-kind-icon">reset</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#send" class="tsd-kind-icon">send</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="transactionbuilder.txbalancebuilder.html#sign" class="tsd-kind-icon">sign</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#to" class="tsd-kind-icon">to</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="transactionbuilder.txbalancebuilder.html#value" class="tsd-kind-icon">value</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>TxBalance<wbr>Builder<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">?: </span><a href="../modules/rpcclient.html" class="tsd-signature-type">RPCClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L56">builders/transaction_builder.ts:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates an instance of TxBalanceBuilder.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> client: <a href="../modules/rpcclient.html" class="tsd-signature-type">RPCClient</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="client" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3> <div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="rpcclient.rpcclient-1.html" class="tsd-signature-type">RPCClient</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L56">builders/transaction_builder.ts:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The RPC client</p> </div> <dl class="tsd-comment-tags"> <dt>type</dt> <dd><p>{RPCClient}</p> </dd> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="data" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> data</h3> <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Transaction</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L47">builders/transaction_builder.ts:47</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The transaction data</p> </div> <dl class="tsd-comment-tags"> <dt>type</dt> <dd><p>{Transaction}</p> </dd> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> </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="fee" class="tsd-anchor"></a> <h3>fee</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">fee<span class="tsd-signature-symbol">(</span>fee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L141">builders/transaction_builder.ts:141</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the fee to be paid for this transaction</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fee: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Decimal</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="finalize" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> finalize</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">finalize<span class="tsd-signature-symbol">(</span>sk<span class="tsd-signature-symbol">?: </span><a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</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">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L233">builders/transaction_builder.ts:233</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Performs final operations such computing and setting the transaction hash and signature as well as setting the sender public key and time.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> sk: <a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5> <div class="tsd-comment tsd-typography"> <p>The sender's private key</p> </div> </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">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns the transaction hash</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="from" class="tsd-anchor"></a> <h3>from</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="key.address.html" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L79">builders/transaction_builder.ts:79</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the sender address</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="key.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>The address</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="getbytesnohashandsig" class="tsd-anchor"></a> <h3>get<wbr>Bytes<wbr>NoHash<wbr>And<wbr>Sig</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">get<wbr>Bytes<wbr>NoHash<wbr>And<wbr>Sig<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</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"> <p>Inherited from <a href="txutility.txutility-1.html">TxUtility</a>.<a href="txutility.txutility-1.html#getbytesnohashandsig">getBytesNoHashAndSig</a></p> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/tx_util.ts#L27">builders/tx_util.ts:27</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the byte equivalent of a given transaction but does not include the transaction <code>hash</code> and <code>sig</code> fields</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxUtility</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>tx: <span class="tsd-signature-type">Transaction</span></h5> <div class="tsd-comment tsd-typography"> <p>The transaction</p> </div> </li> </ul> <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 tsd-is-inherited"> <a name="hash" class="tsd-anchor"></a> <h3>hash</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span>, prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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"> <p>Inherited from <a href="txutility.txutility-1.html">TxUtility</a>.<a href="txutility.txutility-1.html#hash">hash</a></p> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/tx_util.ts#L52">builders/tx_util.ts:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Compute and return the hash of a transaction</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxUtility</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>tx: <span class="tsd-signature-type">Transaction</span></h5> <div class="tsd-comment tsd-typography"> <p>The transaction</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> prefix: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "0x"</span></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="nonce" class="tsd-anchor"></a> <h3>nonce</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">nonce<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L111">builders/transaction_builder.ts:111</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The next nonce of the sending account</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>num: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="packed" class="tsd-anchor"></a> <h3>packed</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">packed<span class="tsd-signature-symbol">(</span>sk<span class="tsd-signature-symbol">: </span><a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</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">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L216">builders/transaction_builder.ts:216</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns a base58 serialized version of the transaction.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sk: <a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5> <div class="tsd-comment tsd-typography"> <p>The sender's private key</p> </div> </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">string</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="payload" class="tsd-anchor"></a> <h3>payload</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">(</span>sk<span class="tsd-signature-symbol">?: </span><a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</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">Transaction</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L167">builders/transaction_builder.ts:167</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the transaction data without sending it to the network. It will finalize the transaction if the sender's private key is provided.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> sk: <a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></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">Transaction</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="reset" class="tsd-anchor"></a> <h3>reset</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</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/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L155">builders/transaction_builder.ts:155</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Reset the transaction builder</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <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="send" class="tsd-anchor"></a> <h3>send</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>sk<span class="tsd-signature-symbol">: </span><a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</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">TxResult</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L188">builders/transaction_builder.ts:188</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Send the transaction to the network</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sk: <a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5> <div class="tsd-comment tsd-typography"> <p>The sender's private key</p> </div> </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">TxResult</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="sign" class="tsd-anchor"></a> <h3>sign</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span>, sk<span class="tsd-signature-symbol">: </span><a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a>, prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</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"> <p>Inherited from <a href="txutility.txutility-1.html">TxUtility</a>.<a href="txutility.txutility-1.html#sign">sign</a></p> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/tx_util.ts#L69">builders/tx_util.ts:69</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sign and return a signature of the transaction.</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxUtility</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>tx: <span class="tsd-signature-type">Transaction</span></h5> <div class="tsd-comment tsd-typography"> <p>The transaction</p> </div> </li> <li> <h5>sk: <a href="key.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5> <div class="tsd-comment tsd-typography"> <p>The private key to use for signing</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> prefix: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "0x"</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> <p>An hex string</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="to" class="tsd-anchor"></a> <h3>to</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="key.address.html" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L95">builders/transaction_builder.ts:95</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the recipient address</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>address: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="key.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>The address</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="value" class="tsd-anchor"></a> <h3>value</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Decimal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/ellcrys/spell.js/blob/cda6112/src/lib/builders/transaction_builder.ts#L124">builders/transaction_builder.ts:124</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the amount to send from the sender to the recipient</p> </div> <dl class="tsd-comment-tags"> <dt>memberof</dt> <dd><p>TxBalanceBuilder</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Decimal</span></h5> <div class="tsd-comment tsd-typography"> <p>The amount to send</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="transactionbuilder.txbalancebuilder.html" class="tsd-signature-type">TxBalanceBuilder</a></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> <li class=" tsd-kind-external-module"> <a href="../modules/auth.html">Auth</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/ell.html">Ell</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/errors.html">Errors</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/index.html">Index</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/key.html">Key</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/logger.html">Logger</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/miner.html">Miner</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/namespace.html">Namespace</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/net.html">Net</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/node.html">Node</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/pool.html">Pool</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/rpc.html">RPC</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/rpcclient.html">RPCClient</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/spell.html">Spell</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/state.html">State</a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/transactionbuilder.html">Transaction<wbr>Builder</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/txutility.html">Tx<wbr>Utility</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-external-module"> <a href="transactionbuilder.txbalancebuilder.html" class="tsd-kind-icon">Tx<wbr>Balance<wbr>Builder</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="transactionbuilder.txbalancebuilder.html#client" class="tsd-kind-icon">client</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="transactionbuilder.txbalancebuilder.html#data" class="tsd-kind-icon">data</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#fee" class="tsd-kind-icon">fee</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="transactionbuilder.txbalancebuilder.html#finalize" class="tsd-kind-icon">finalize</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#from" class="tsd-kind-icon">from</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="transactionbuilder.txbalancebuilder.html#getbytesnohashandsig" class="tsd-kind-icon">get<wbr>Bytes<wbr>NoHash<wbr>And<wbr>Sig</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="transactionbuilder.txbalancebuilder.html#hash" class="tsd-kind-icon">hash</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#nonce" class="tsd-kind-icon">nonce</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#packed" class="tsd-kind-icon">packed</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#payload" class="tsd-kind-icon">payload</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#reset" class="tsd-kind-icon">reset</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#send" class="tsd-kind-icon">send</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="transactionbuilder.txbalancebuilder.html#sign" class="tsd-kind-icon">sign</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#to" class="tsd-kind-icon">to</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="transactionbuilder.txbalancebuilder.html#value" class="tsd-kind-icon">value</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="transactionbuilder.txbuilder.html" class="tsd-kind-icon">Tx<wbr>Builder</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/transactionbuilder.html#numdecimals" class="tsd-kind-icon">Num<wbr>Decimals</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module"> <a href="../modules/transactionbuilder.html#txpayloadversion" class="tsd-kind-icon">Tx<wbr>Payload<wbr>Version</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"> <a href="../modules/transactionbuilder.html#b58" class="tsd-kind-icon">b58</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><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> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <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> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</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-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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>