ontology-ts-sdk
Version:
Comprehensive TypeScript library for the Ontology blockchain.
846 lines • 53 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"transaction/transactionBuilder" | ontology-ts-sdk</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">ontology-ts-sdk</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="_transaction_transactionbuilder_.html">"transaction/transactionBuilder"</a>
</li>
</ul>
<h1>External module "transaction/transactionBuilder"</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<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>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#addsign" class="tsd-kind-icon">add<wbr>Sign</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#buildrestfulparam" class="tsd-kind-icon">build<wbr>Restful<wbr>Param</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#buildrpcparam" class="tsd-kind-icon">build<wbr>Rpc<wbr>Param</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#buildtxparam" class="tsd-kind-icon">build<wbr>TxParam</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#makedeploycodetransaction" class="tsd-kind-icon">make<wbr>Deploy<wbr>Code<wbr>Transaction</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#makeinvoketransaction" class="tsd-kind-icon">make<wbr>Invoke<wbr>Transaction</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#makenativecontracttx" class="tsd-kind-icon">make<wbr>Native<wbr>Contract<wbr>Tx</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#sendrawtxrestfulurl" class="tsd-kind-icon">send<wbr>Raw<wbr>TxRestful<wbr>Url</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#signtransaction" class="tsd-kind-icon">sign<wbr>Transaction</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#signtransactionasync" class="tsd-kind-icon">sign<wbr>Transaction<wbr>Async</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#signtx" class="tsd-kind-icon">sign<wbr>Tx</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_transaction_transactionbuilder_.html#default_params" class="tsd-kind-icon">Default_<wbr>params</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="addsign" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> add<wbr>Sign</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">add<wbr>Sign<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a>, privateKey<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, schema<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</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/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L90">transaction/transactionBuilder.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signs the transaction object.</p>
</div>
<p>If there is already a signature, the new one will be added to the end.
If the signature schema is not provided, default schema for Private key type is used.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transaction to sign</p>
</div>
</div>
</li>
<li>
<h5>privateKey: <a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Private key to sign with</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> schema: <a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signature Schema to use</p>
</div>
</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-function tsd-parent-kind-external-module">
<a name="buildrestfulparam" class="tsd-anchor"></a>
<h3>build<wbr>Restful<wbr>Param</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Restful<wbr>Param<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L310">transaction/transactionBuilder.ts:310</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd><p>Creates params from transaction to send with restful</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<p>Transaction</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>Action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>Version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="buildrpcparam" class="tsd-anchor"></a>
<h3>build<wbr>Rpc<wbr>Param</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>Rpc<wbr>Param<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a>, method<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><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">object</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L294">transaction/transactionBuilder.ts:294</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd><p>Creates params from transaction to send with rpc</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<p>Transaction</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> method: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Method name</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>jsonrpc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="buildtxparam" class="tsd-anchor"></a>
<h3>build<wbr>TxParam</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">build<wbr>TxParam<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a>, isPreExec<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L281">transaction/transactionBuilder.ts:281</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd><p>Creates params from transaction to send with websocket</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<p>Transactio to send</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> isPreExec: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>Decides if it is pre-execute transaction</p>
</div>
</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-function tsd-parent-kind-external-module">
<a name="makedeploycodetransaction" class="tsd-anchor"></a>
<h3>make<wbr>Deploy<wbr>Code<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">make<wbr>Deploy<wbr>Code<wbr>Transaction<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, codeVersion<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, email<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, desp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, needStorage<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, gasPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">?: </span><a href="../enums/_smartcontract_abi_parameter_.parametertype.html#address" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L232">transaction/transactionBuilder.ts:232</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates transaction to deploy smart contract</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>code: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Avm code of contract to deploy</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<p>Name of contract</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> codeVersion: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "1.0"</span></h5>
<div class="tsd-comment tsd-typography">
<p>version of contract</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> author: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<p>Author of contract</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> email: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<p>Email of author</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> desp: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
<div class="tsd-comment tsd-typography">
<p>Description of contract</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> needStorage: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
<div class="tsd-comment tsd-typography">
<p>Decides if the contract needs storage</p>
</div>
</li>
<li>
<h5>gasPrice: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Gas price</p>
</div>
</li>
<li>
<h5>gasLimit: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Gas limit</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> payer: <a href="../enums/_smartcontract_abi_parameter_.parametertype.html#address" class="tsd-signature-type">Address</a></h5>
<div class="tsd-comment tsd-typography">
<p>Address to pay for gas</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="makeinvoketransaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> make<wbr>Invoke<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">make<wbr>Invoke<wbr>Transaction<span class="tsd-signature-symbol">(</span>funcName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="../classes/_smartcontract_abi_parameter_.parameter.html" class="tsd-signature-type">Parameter</a><span class="tsd-signature-symbol">[]</span>, contractAddr<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, gasPrice<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">?: </span><a href="../enums/_smartcontract_abi_parameter_.parametertype.html#address" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L187">transaction/transactionBuilder.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates transaction to inovke smart contract</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>funcName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Function name of smart contract</p>
</div>
</div>
</li>
<li>
<h5>params: <a href="../classes/_smartcontract_abi_parameter_.parameter.html" class="tsd-signature-type">Parameter</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of Parameters</p>
</div>
</div>
</li>
<li>
<h5>contractAddr: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Address of contract</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gasPrice: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gas price</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gasLimit: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gas limit</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> payer: <a href="../enums/_smartcontract_abi_parameter_.parametertype.html#address" class="tsd-signature-type">Address</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Address to pay for gas</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="makenativecontracttx" class="tsd-anchor"></a>
<h3>make<wbr>Native<wbr>Contract<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">make<wbr>Native<wbr>Contract<wbr>Tx<span class="tsd-signature-symbol">(</span>funcName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contractAddr<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, gasPrice<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, gasLimit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, payer<span class="tsd-signature-symbol">?: </span><a href="../enums/_smartcontract_abi_parameter_.parametertype.html#address" class="tsd-signature-type">Address</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L146">transaction/transactionBuilder.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates transaction to invoke native contract</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>funcName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Function name of contract to call</p>
</div>
</li>
<li>
<h5>params: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Parameters serialized in hex string</p>
</div>
</li>
<li>
<h5>contractAddr: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5>
<div class="tsd-comment tsd-typography">
<p>Adderss of contract</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gasPrice: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Gas price</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> gasLimit: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Gas limit</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> payer: <a href="../enums/_smartcontract_abi_parameter_.parametertype.html#address" class="tsd-signature-type">Address</a></h5>
<div class="tsd-comment tsd-typography">
<p>Address to pay for transaction gas</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="sendrawtxrestfulurl" class="tsd-anchor"></a>
<h3>send<wbr>Raw<wbr>TxRestful<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">send<wbr>Raw<wbr>TxRestful<wbr>Url<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, preExec<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L324">transaction/transactionBuilder.ts:324</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>deprecated</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Url of blochchain node</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> preExec: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<p>Decides if is a pre-execute request</p>
</div>
</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-function tsd-parent-kind-external-module">
<a name="signtransaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> sign<wbr>Transaction</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">sign<wbr>Transaction<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a>, privateKey<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, schema<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</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/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L54">transaction/transactionBuilder.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signs the transaction object.</p>
</div>
<p>If there is already a signature, the new one will replace existing.
If the signature schema is not provided, default schema for Private key type is used.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transaction to sign</p>
</div>
</div>
</li>
<li>
<h5>privateKey: <a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Private key to sign with</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> schema: <a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signature Schema to use</p>
</div>
</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-function tsd-parent-kind-external-module">
<a name="signtransactionasync" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> sign<wbr>Transaction<wbr>Async</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">sign<wbr>Transaction<wbr>Async<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a>, privateKey<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, schema<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L72">transaction/transactionBuilder.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signs the transaction object asynchroniously.</p>
</div>
<p>If there is already a signature, the new one will replace existing.
If the signature schema is not provided, default schema for Private key type is used.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transaction to sign</p>
</div>
</div>
</li>
<li>
<h5>privateKey: <a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Private key to sign with</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> schema: <a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signature Schema to use</p>
</div>
</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">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
<a name="signtx" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> sign<wbr>Tx</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
<li class="tsd-signature tsd-kind-icon">sign<wbr>Tx<span class="tsd-signature-symbol">(</span>tx<span class="tsd-signature-symbol">: </span><a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a>, M<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, pubKeys<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_publickey_.publickey.html" class="tsd-signature-type">PublicKey</a><span class="tsd-signature-symbol">[]</span>, privateKey<span class="tsd-signature-symbol">: </span><a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a>, scheme<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</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/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L109">transaction/transactionBuilder.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signs the transaction with multiple signatures with multi-sign keys.</p>
</div>
<p>If there is already a signature, the new ones will be added to the end.
If the signature schema is not provided, default schema for Private key type is used.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tx: <a href="../classes/_transaction_transaction_.transaction.html" class="tsd-signature-type">Transaction</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Transaction to sign</p>
</div>
</div>
</li>
<li>
<h5>M: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>m of the (m ,n) multi sign address threshold</p>
</div>
</div>
</li>
<li>
<h5>pubKeys: <a href="../classes/_crypto_publickey_.publickey.html" class="tsd-signature-type">PublicKey</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of Public keys of (m,n) multi sign address, the number is n</p>
</div>
</div>
</li>
<li>
<h5>privateKey: <a href="../classes/_crypto_privatekey_.privatekey.html" class="tsd-signature-type">PrivateKey</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Private key to sign the tx.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scheme: <a href="../classes/_crypto_signaturescheme_.signaturescheme.html" class="tsd-signature-type">SignatureScheme</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Signature scheme to use</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module">
<a name="default_params" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Default_<wbr>params</h3>
<div class="tsd-signature tsd-kind-icon">Default_<wbr>params<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/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L37">transaction/transactionBuilder.ts:37</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="default_params.action" class="tsd-anchor"></a>
<h3>Action</h3>
<div class="tsd-signature tsd-kind-icon">Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "sendrawtransaction"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L38">transaction/transactionBuilder.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="default_params.op" class="tsd-anchor"></a>
<h3>Op</h3>
<div class="tsd-signature tsd-kind-icon">Op<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "test"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L41">transaction/transactionBuilder.ts:41</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="default_params.type" class="tsd-anchor"></a>
<h3>Type</h3>
<div class="tsd-signature tsd-kind-icon">Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L40">transaction/transactionBuilder.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="default_params.version" class="tsd-anchor"></a>
<h3>Version</h3>
<div class="tsd-signature tsd-kind-icon">Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "1.0.0"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/transaction/transactionBuilder.ts#L39">transaction/transactionBuilder.ts:39</a></li>
</ul>
</aside>
</section>
</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="current tsd-kind-external-module">
<a href="_transaction_transactionbuilder_.html">"transaction/transaction<wbr>Builder"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#addsign" class="tsd-kind-icon">add<wbr>Sign</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#buildrestfulparam" class="tsd-kind-icon">build<wbr>Restful<wbr>Param</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#buildrpcparam" class="tsd-kind-icon">build<wbr>Rpc<wbr>Param</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#buildtxparam" class="tsd-kind-icon">build<wbr>TxParam</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#makedeploycodetransaction" class="tsd-kind-icon">make<wbr>Deploy<wbr>Code<wbr>Transaction</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#makeinvoketransaction" class="tsd-kind-icon">make<wbr>Invoke<wbr>Transaction</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#makenativecontracttx" class="tsd-kind-icon">make<wbr>Native<wbr>Contract<wbr>Tx</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#sendrawtxrestfulurl" class="tsd-kind-icon">send<wbr>Raw<wbr>TxRestful<wbr>Url</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#signtransaction" class="tsd-kind-icon">sign<wbr>Transaction</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#signtransactionasync" class="tsd-kind-icon">sign<wbr>Transaction<wbr>Async</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#signtx" class="tsd-kind-icon">sign<wbr>Tx</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-external-module">
<a href="_transaction_transactionbuilder_.html#default_params" class="tsd-kind-icon">Default_<wbr>params</a>
</li>
</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-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