UNPKG

ontology-ts-sdk

Version:

Comprehensive TypeScript library for the Ontology blockchain.

652 lines 41.8 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>&quot;network/websocket/websocketBuilder&quot; | 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="_network_websocket_websocketbuilder_.html">&quot;network/websocket/websocketBuilder&quot;</a> </li> </ul> <h1>External module &quot;network/websocket/websocketBuilder&quot;</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 tsd-is-external"> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getallowance" class="tsd-kind-icon">get<wbr>Allowance</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getbalance" class="tsd-kind-icon">get<wbr>Balance</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getblock" class="tsd-kind-icon">get<wbr>Block</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getblockheight" class="tsd-kind-icon">get<wbr>Block<wbr>Height</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getblockheightbytxhash" class="tsd-kind-icon">get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getblockjson" class="tsd-kind-icon">get<wbr>Block<wbr>Json</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getcontract" class="tsd-kind-icon">get<wbr>Contract</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getcontractjson" class="tsd-kind-icon">get<wbr>Contract<wbr>Json</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getgenerateblocktime" class="tsd-kind-icon">get<wbr>Generate<wbr>Block<wbr>Time</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getmerkleproof" class="tsd-kind-icon">get<wbr>Merkle<wbr>Proof</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getnodecount" class="tsd-kind-icon">get<wbr>Node<wbr>Count</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getrawtransaction" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getrawtransactionjson" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>Json</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getsmartcodeevent" class="tsd-kind-icon">get<wbr>Smart<wbr>Code<wbr>Event</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#sendheartbeat" class="tsd-kind-icon">send<wbr>Heart<wbr>Beat</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#sendrawtransaction" class="tsd-kind-icon">send<wbr>Raw<wbr>Transaction</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-external"><a href="_network_websocket_websocketbuilder_.html#sendsubscribe" class="tsd-kind-icon">send<wbr>Subscribe</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="getallowance" class="tsd-anchor"></a> <h3>get<wbr>Allowance</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a>, to<span class="tsd-signature-symbol">: </span><a href="../classes/_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">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/websocket/websocketBuilder.ts#L219">network/websocket/websocketBuilder.ts:219</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>asset: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>from: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> </li> <li> <h5>to: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="getbalance" class="tsd-anchor"></a> <h3>get<wbr>Balance</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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="../classes/_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">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/websocket/websocketBuilder.ts#L144">network/websocket/websocketBuilder.ts:144</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>address: <a href="../classes/_crypto_address_.address.html" class="tsd-signature-type">Address</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="getblock" class="tsd-anchor"></a> <h3>get<wbr>Block</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L106">network/websocket/websocketBuilder.ts:106</a></li> </ul> </aside> <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> </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 tsd-is-external"> <a name="getblockheight" class="tsd-anchor"></a> <h3>get<wbr>Block<wbr>Height</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L98">network/websocket/websocketBuilder.ts:98</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="getblockheightbytxhash" class="tsd-anchor"></a> <h3>get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L191">network/websocket/websocketBuilder.ts:191</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hash: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="getblockjson" class="tsd-anchor"></a> <h3>get<wbr>Block<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L126">network/websocket/websocketBuilder.ts:126</a></li> </ul> </aside> <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> </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 tsd-is-external"> <a name="getcontract" class="tsd-anchor"></a> <h3>get<wbr>Contract</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Contract<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">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/websocket/websocketBuilder.ts#L153">network/websocket/websocketBuilder.ts:153</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hash: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="getcontractjson" class="tsd-anchor"></a> <h3>get<wbr>Contract<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Contract<wbr>Json<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">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/websocket/websocketBuilder.ts#L163">network/websocket/websocketBuilder.ts:163</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hash: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="getgenerateblocktime" class="tsd-anchor"></a> <h3>get<wbr>Generate<wbr>Block<wbr>Time</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L82">network/websocket/websocketBuilder.ts:82</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="getmerkleproof" class="tsd-anchor"></a> <h3>get<wbr>Merkle<wbr>Proof</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L210">network/websocket/websocketBuilder.ts:210</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hash: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="getnodecount" class="tsd-anchor"></a> <h3>get<wbr>Node<wbr>Count</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L90">network/websocket/websocketBuilder.ts:90</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="getrawtransaction" class="tsd-anchor"></a> <h3>get<wbr>Raw<wbr>Transaction</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L62">network/websocket/websocketBuilder.ts:62</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>txHash: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="getrawtransactionjson" class="tsd-anchor"></a> <h3>get<wbr>Raw<wbr>Transaction<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L72">network/websocket/websocketBuilder.ts:72</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>txHash: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="getsmartcodeevent" class="tsd-anchor"></a> <h3>get<wbr>Smart<wbr>Code<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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">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/websocket/websocketBuilder.ts#L173">network/websocket/websocketBuilder.ts:173</a></li> </ul> </aside> <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> </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 tsd-is-external"> <a name="getstorage" class="tsd-anchor"></a> <h3>get<wbr>Storage</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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">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/websocket/websocketBuilder.ts#L200">network/websocket/websocketBuilder.ts:200</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>codeHash: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>key: <span class="tsd-signature-type">string</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-function tsd-parent-kind-external-module tsd-is-external"> <a name="sendheartbeat" class="tsd-anchor"></a> <h3>send<wbr>Heart<wbr>Beat</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <li class="tsd-signature tsd-kind-icon">send<wbr>Heart<wbr>Beat<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/websocket/websocketBuilder.ts#L25">network/websocket/websocketBuilder.ts:25</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a name="sendrawtransaction" class="tsd-anchor"></a> <h3>send<wbr>Raw<wbr>Transaction</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <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><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/websocket/websocketBuilder.ts#L50">network/websocket/websocketBuilder.ts:50</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>hexData: <span class="tsd-signature-type">string</span></h5> </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> </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 tsd-is-external"> <a name="sendsubscribe" class="tsd-anchor"></a> <h3>send<wbr>Subscribe</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <li class="tsd-signature tsd-kind-icon">send<wbr>Subscribe<span class="tsd-signature-symbol">(</span>subscribeEvent<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, subscribeJsonBlock<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, subscribeRawBlock<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, subscribeBlockTxHashes<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/network/websocket/websocketBuilder.ts#L33">network/websocket/websocketBuilder.ts:33</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> subscribeEvent: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> subscribeJsonBlock: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> subscribeRawBlock: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> subscribeBlockTxHashes: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html">"network/websocket/websocket<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 tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getallowance" class="tsd-kind-icon">get<wbr>Allowance</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getbalance" class="tsd-kind-icon">get<wbr>Balance</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getblock" class="tsd-kind-icon">get<wbr>Block</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getblockheight" class="tsd-kind-icon">get<wbr>Block<wbr>Height</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getblockheightbytxhash" class="tsd-kind-icon">get<wbr>Block<wbr>Height<wbr>ByTx<wbr>Hash</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getblockjson" class="tsd-kind-icon">get<wbr>Block<wbr>Json</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getcontract" class="tsd-kind-icon">get<wbr>Contract</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getcontractjson" class="tsd-kind-icon">get<wbr>Contract<wbr>Json</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getgenerateblocktime" class="tsd-kind-icon">get<wbr>Generate<wbr>Block<wbr>Time</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getmerkleproof" class="tsd-kind-icon">get<wbr>Merkle<wbr>Proof</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getnodecount" class="tsd-kind-icon">get<wbr>Node<wbr>Count</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getrawtransaction" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getrawtransactionjson" class="tsd-kind-icon">get<wbr>Raw<wbr>Transaction<wbr>Json</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getsmartcodeevent" class="tsd-kind-icon">get<wbr>Smart<wbr>Code<wbr>Event</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#getstorage" class="tsd-kind-icon">get<wbr>Storage</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#sendheartbeat" class="tsd-kind-icon">send<wbr>Heart<wbr>Beat</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#sendrawtransaction" class="tsd-kind-icon">send<wbr>Raw<wbr>Transaction</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external"> <a href="_network_websocket_websocketbuilder_.html#sendsubscribe" class="tsd-kind-icon">send<wbr>Subscribe</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 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="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <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>