UNPKG

ontology-ts-sdk

Version:

Comprehensive TypeScript library for the Ontology blockchain.

847 lines (846 loc) 55.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>RestClient | 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="../modules/_network_rest_restclient_.html">&quot;network/rest/restClient&quot;</a> </li> <li> <a href="_network_rest_restclient_.restclient.html">RestClient</a> </li> </ul> <h1>Class RestClient</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>Wrapper class for restful api.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">RestClient</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="_network_rest_restclient_.restclient.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="_network_rest_restclient_.restclient.html#action" class="tsd-kind-icon">action</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#url" class="tsd-kind-icon">url</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.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="_network_rest_restclient_.restclient.html#concatparams" class="tsd-kind-icon">concat<wbr>Params</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getallowance" class="tsd-kind-icon">get<wbr>Allowance</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getbalance" class="tsd-kind-icon">get<wbr>Balance</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getblock" class="tsd-kind-icon">get<wbr>Block</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getblockheight" class="tsd-kind-icon">get<wbr>Block<wbr>Height</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getblockheightbytxhash" class="tsd-kind-icon">get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getblockjson" class="tsd-kind-icon">get<wbr>Block<wbr>Json</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getcontract" class="tsd-kind-icon">get<wbr>Contract</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getcontractjson" class="tsd-kind-icon">get<wbr>Contract<wbr>Json</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getgenerateblocktime" class="tsd-kind-icon">get<wbr>Generate<wbr>Block<wbr>Time</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getmerkleproof" class="tsd-kind-icon">get<wbr>Merkle<wbr>Proof</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getnodecount" class="tsd-kind-icon">get<wbr>Node<wbr>Count</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getrawtransaction" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getrawtransactionjson" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>Json</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getsmartcodeevent" class="tsd-kind-icon">get<wbr>Smart<wbr>Code<wbr>Event</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#geturl" class="tsd-kind-icon">get<wbr>Url</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_network_rest_restclient_.restclient.html#sendrawtransaction" class="tsd-kind-icon">send<wbr>Raw<wbr>Transaction</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>Rest<wbr>Client<span class="tsd-signature-symbol">(</span>url<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><a href="_network_rest_restclient_.restclient.html" class="tsd-signature-type">RestClient</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/network/rest/restClient.ts#L42">network/rest/restClient.ts:42</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> url: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_network_rest_restclient_.restclient.html" class="tsd-signature-type">RestClient</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="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"> =&nbsp;&quot;sendrawtransaction&quot;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/network/rest/restClient.ts#L42">network/rest/restClient.ts:42</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Action name of the request</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="url" class="tsd-anchor"></a> <h3>url</h3> <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/network/rest/restClient.ts#L32">network/rest/restClient.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Url of the blockchain node</p> </div> </div> </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> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;v1.0.0&quot;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/MickWang/ontology-ts-sdk/blob/f203ee8/src/network/rest/restClient.ts#L37">network/rest/restClient.ts:37</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Version of restful api</p> </div> </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="concatparams" class="tsd-anchor"></a> <h3>concat<wbr>Params</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">concat<wbr>Params<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L55">network/rest/restClient.ts:55</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Concat params as the query part</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>params: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5> <div class="tsd-comment tsd-typography"> </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-method tsd-parent-kind-class"> <a name="getallowance" class="tsd-anchor"></a> <h3>get<wbr>Allowance</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Allowance<span class="tsd-signature-symbol">(</span>asset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, from<span class="tsd-signature-symbol">: </span><a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a>, to<span class="tsd-signature-symbol">: </span><a href="_crypto_address_.address.html" class="tsd-signature-type">Address</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L326">network/rest/restClient.ts:326</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get allowance by address</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>asset: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Asset type. Only ONT or ONG.</p> </div> </li> <li> <h5>from: <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>Address of allowance sender.</p> </div> </li> <li> <h5>to: <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>Address of allowance receiver.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getbalance" class="tsd-anchor"></a> <h3>get<wbr>Balance</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Balance<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><a href="_crypto_address_.address.html" class="tsd-signature-type">Address</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L296">network/rest/restClient.ts:296</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get balance of some address The result contains balance of ONT and ONG</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>address: <a href="_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> <div class="tsd-comment tsd-typography"> <p>Address</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getblock" class="tsd-anchor"></a> <h3>get<wbr>Block</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Block<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L187">network/rest/restClient.ts:187</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get block by block&#39;s height or hash</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Block height or block hash</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getblockheight" class="tsd-anchor"></a> <h3>get<wbr>Block<wbr>Height</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>Height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L176">network/rest/restClient.ts:176</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the current height of the blockchain.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getblockheightbytxhash" class="tsd-anchor"></a> <h3>get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash<span class="tsd-signature-symbol">(</span>hash<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L257">network/rest/restClient.ts:257</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the block height by reversed transaction hash.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Reversed transaction hash.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getblockjson" class="tsd-anchor"></a> <h3>get<wbr>Block<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Block<wbr>Json<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L307">network/rest/restClient.ts:307</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get block info by block&#39;s height or hash.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Block&#39;s height or hash</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcontract" class="tsd-anchor"></a> <h3>get<wbr>Contract</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Contract<span class="tsd-signature-symbol">(</span>codeHash<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L208">network/rest/restClient.ts:208</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get contract info by code hash.The result is hex encoded string.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>codeHash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Code hash of contract.The value is reversed contract address.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcontractjson" class="tsd-anchor"></a> <h3>get<wbr>Contract<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Json<span class="tsd-signature-symbol">(</span>codeHash<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L225">network/rest/restClient.ts:225</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get contract info by code hash. The result is json.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>codeHash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Code hash of contract.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getgenerateblocktime" class="tsd-anchor"></a> <h3>get<wbr>Generate<wbr>Block<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Generate<wbr>Block<wbr>Time<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L156">network/rest/restClient.ts:156</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the generation time for each block. If the blockchain node runs in vbft, the result is null.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getmerkleproof" class="tsd-anchor"></a> <h3>get<wbr>Merkle<wbr>Proof</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Merkle<wbr>Proof<span class="tsd-signature-symbol">(</span>hash<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L280">network/rest/restClient.ts:280</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the merkle proof by transaction hash</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Reversed transaction hash</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getnodecount" class="tsd-anchor"></a> <h3>get<wbr>Node<wbr>Count</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Node<wbr>Count<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L166">network/rest/restClient.ts:166</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the nodes count of the blockchain.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getrawtransaction" class="tsd-anchor"></a> <h3>get<wbr>Raw<wbr>Transaction</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Transaction<span class="tsd-signature-symbol">(</span>txHash<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L126">network/rest/restClient.ts:126</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get raw transaction by transaction hash. The result is hex encoded transaction.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code class="lang-typescript"><span class="hljs-keyword">import</span> { utils, Transaction } <span class="hljs-keyword">from</span> <span class="hljs-string">'ontology-ts-sdk'</span>; <span class="hljs-keyword">const</span> txHash = tx.getHash(); <span class="hljs-comment">// tx is an instance of Transaction</span> restClient.getRawTransaction(utils.reverseHex(txHash)).then(<span class="hljs-function"><span class="hljs-params">res</span> =&gt;</span> { <span class="hljs-keyword">const</span> tx = Transaction.deserialize(res.Result) }) <span class="hljs-string">`</span> </code></pre> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>txHash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Transactin hash.Always use the reversed value of transaction hash to query.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getrawtransactionjson" class="tsd-anchor"></a> <h3>get<wbr>Raw<wbr>Transaction<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>Json<span class="tsd-signature-symbol">(</span>txHash<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L142">network/rest/restClient.ts:142</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get transaction by transaction hash. The result is transaction in json.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>txHash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Reversed transaction hash</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getsmartcodeevent" class="tsd-anchor"></a> <h3>get<wbr>Smart<wbr>Code<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Smart<wbr>Code<wbr>Event<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">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L241">network/rest/restClient.ts:241</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get smart contract event by Block height or reversed transaction hash. If the parameter is block height, the result includes all the transaction event of that block; If the parameter is transaction hash, the result is the event of that transaction.</p> </div> </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">number</span></h5> <div class="tsd-comment tsd-typography"> <p>Block height or reversed transaction hash</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getstorage" class="tsd-anchor"></a> <h3>get<wbr>Storage</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Storage<span class="tsd-signature-symbol">(</span>codeHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L269">network/rest/restClient.ts:269</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the stored value in smart contract by the code hash and key.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>codeHash: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Code hash of the smart contract</p> </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Key of the stored value</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="geturl" class="tsd-anchor"></a> <h3>get<wbr>Url</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Url<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/MickWang/ontology-ts-sdk/blob/f203ee8/src/network/rest/restClient.ts#L75">network/rest/restClient.ts:75</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the current blockchain node url</p> </div> </div> <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="sendrawtransaction" class="tsd-anchor"></a> <h3>send<wbr>Raw<wbr>Transaction</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">send<wbr>Raw<wbr>Transaction<span class="tsd-signature-symbol">(</span>hexData<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>, userId<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/network/rest/restClient.ts#L85">network/rest/restClient.ts:85</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>To send raw transaction to blockchian</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hexData: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Hex encoded data</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"> =&nbsp;false</span></h5> <div class="tsd-comment tsd-typography"> <p>Decides if it is a pre-execute transaction</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> userId: <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>User&#39;s id</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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> <li class="current tsd-kind-external-module"> <a href="../modules/_network_rest_restclient_.html">"network/rest/rest<wbr>Client"</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="_network_rest_restclient_.restclient.html" class="tsd-kind-icon">Rest<wbr>Client</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#action" class="tsd-kind-icon">action</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#url" class="tsd-kind-icon">url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#version" class="tsd-kind-icon">version</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#concatparams" class="tsd-kind-icon">concat<wbr>Params</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getallowance" class="tsd-kind-icon">get<wbr>Allowance</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getbalance" class="tsd-kind-icon">get<wbr>Balance</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getblock" class="tsd-kind-icon">get<wbr>Block</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getblockheight" class="tsd-kind-icon">get<wbr>Block<wbr>Height</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getblockheightbytxhash" class="tsd-kind-icon">get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getblockjson" class="tsd-kind-icon">get<wbr>Block<wbr>Json</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getcontract" class="tsd-kind-icon">get<wbr>Contract</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getcontractjson" class="tsd-kind-icon">get<wbr>Contract<wbr>Json</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getgenerateblocktime" class="tsd-kind-icon">get<wbr>Generate<wbr>Block<wbr>Time</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getmerkleproof" class="tsd-kind-icon">get<wbr>Merkle<wbr>Proof</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getnodecount" class="tsd-kind-icon">get<wbr>Node<wbr>Count</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_network_rest_restclient_.restclient.html#getrawtransaction" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction</a> </li> <li class=" tsd-kind-method tsd-parent-kind