Files
api/docs/examples/rx/01_simple_connect/index.html
T
2019-01-29 16:15:42 +00:00

2258 lines
66 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Simple connect · Polkadot API Book</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../../../gitbook/style.css">
<link rel="stylesheet" href="../../../gitbook/gitbook-plugin-insert-logo-link/plugin.css">
<link rel="stylesheet" href="../../../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="../../../gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
<link rel="stylesheet" href="../../../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../../../gitbook/gitbook-plugin-fontsettings/website.css">
<link rel="stylesheet" href="../../../styles/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../../../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../../../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../02_listen_to_blocks/" />
<link rel="prev" href="../" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Packages</li>
<li class="chapter " data-level="1.1" data-path="../../../">
<a href="../../../">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="../../../api/">
<a href="../../../api/">
api
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="../../../api/classes/_promise_index_.apipromise.html">
<a href="../../../api/classes/_promise_index_.apipromise.html">
ApiPromise
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="../../../api/classes/_rx_index_.apirx.html">
<a href="../../../api/classes/_rx_index_.apirx.html">
ApiRx
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="../../../rpc-provider/">
<a href="../../../rpc-provider/">
rpc-provider
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../../../rpc-provider/classes/_http_index_.httpprovider.html">
<a href="../../../rpc-provider/classes/_http_index_.httpprovider.html">
HttpProvider
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="../../../rpc-provider/classes/_ws_index_.wsprovider.html">
<a href="../../../rpc-provider/classes/_ws_index_.wsprovider.html">
WsProvider
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../../types/">
<a href="../../../types/">
types (codec implementation)
</a>
</li>
<li class="header">Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../../METHODS_RPC.html">
<a href="../../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../../METHODS_STORAGE.html">
<a href="../../../METHODS_STORAGE.html">
Chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../../METHODS_EXTRINSICS.html">
<a href="../../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="chapter " data-level="2.4" data-path="../../../METHODS_EVENTS.html">
<a href="../../../METHODS_EVENTS.html">
Events (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="3.1" data-path="../../promise/">
<a href="../../promise/">
ApiPromise
</a>
<ul class="articles">
<li class="chapter " data-level="3.1.1" data-path="../../promise/01_simple_connect/">
<a href="../../promise/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.1.2" data-path="../../promise/02_listen_to_blocks/">
<a href="../../promise/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.1.3" data-path="../../promise/03_listen_to_balance_change/">
<a href="../../promise/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.1.4" data-path="../../promise/04_unsubscribe/">
<a href="../../promise/04_unsubscribe/">
Unsubscribe from listening
</a>
</li>
<li class="chapter " data-level="3.1.5" data-path="../../promise/05_read_storage/">
<a href="../../promise/05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.1.6" data-path="../../promise/06_make_transfer/">
<a href="../../promise/06_make_transfer/">
Make a transfer
</a>
</li>
<li class="chapter " data-level="3.1.7" data-path="../../promise/08_system_events/">
<a href="../../promise/08_system_events/">
Display system events
</a>
</li>
<li class="chapter " data-level="3.1.8" data-path="../../promise/09_transfer_events/">
<a href="../../promise/09_transfer_events/">
Transaction with events
</a>
</li>
<li class="chapter " data-level="3.1.9" data-path="../../promise/10_upgrade_chain/">
<a href="../../promise/10_upgrade_chain/">
Upgrade via sudo
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="3.2" data-path="../">
<a href="../">
ApiRx
</a>
<ul class="articles">
<li class="chapter active" data-level="3.2.1" data-path="./">
<a href="./">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.2.2" data-path="../02_listen_to_blocks/">
<a href="../02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.2.3" data-path="../03_listen_to_balance_change/">
<a href="../03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.2.4" data-path="../04_unsubscribe/">
<a href="../04_unsubscribe/">
Unsubscribe from listening
</a>
</li>
<li class="chapter " data-level="3.2.5" data-path="../05_read_storage/">
<a href="../05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.2.6" data-path="../06_make_transfer/">
<a href="../06_make_transfer/">
Make a transfer
</a>
</li>
<li class="chapter " data-level="3.2.7" data-path="../08_system_events/">
<a href="../08_system_events/">
Display system events
</a>
</li>
<li class="chapter " data-level="3.2.8" data-path="../09_transfer_events/">
<a href="../09_transfer_events/">
Transaction with events
</a>
</li>
<li class="chapter " data-level="3.2.9" data-path="../10_upgrade_chain/">
<a href="../10_upgrade_chain/">
Upgrade via sudo
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li class="chapter " data-level="4.1" data-path="../../../types/classes/_accountid_.accountid.html">
<a href="../../../types/classes/_accountid_.accountid.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.2" data-path="../../../types/classes/_accountindex_.accountindex.html">
<a href="../../../types/classes/_accountindex_.accountindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.3" data-path="../../../types/classes/_address_.address.html">
<a href="../../../types/classes/_address_.address.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.4" data-path="../../../types/classes/_authorityid_.authorityid.html">
<a href="../../../types/classes/_authorityid_.authorityid.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.5" data-path="../../../types/classes/_balance_.balance.html">
<a href="../../../types/classes/_balance_.balance.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.6" data-path="../../../types/classes/_bft_.bftauthoritysignature.html">
<a href="../../../types/classes/_bft_.bftauthoritysignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.7" data-path="../../../types/classes/_bft_.bfthashsignature.html">
<a href="../../../types/classes/_bft_.bfthashsignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.8" data-path="../../../types/classes/_block_.block.html">
<a href="../../../types/classes/_block_.block.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.9" data-path="../../../types/classes/_blocknumber_.blocknumber.html">
<a href="../../../types/classes/_blocknumber_.blocknumber.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.10" data-path="../../../types/classes/_bool_.bool.html">
<a href="../../../types/classes/_bool_.bool.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.11" data-path="../../../types/classes/_bytes_.bytes.html">
<a href="../../../types/classes/_bytes_.bytes.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.12" data-path="../../../types/classes/_chainproperties_.chainproperties.html">
<a href="../../../types/classes/_chainproperties_.chainproperties.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.13" data-path="../../../types/classes/_codec_base_.base.html">
<a href="../../../types/classes/_codec_base_.base.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.14" data-path="../../../types/classes/_codec_compact_.compact.html">
<a href="../../../types/classes/_codec_compact_.compact.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.15" data-path="../../../types/classes/_codec_enum_.enum.html">
<a href="../../../types/classes/_codec_enum_.enum.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.16" data-path="../../../types/classes/_codec_enumtype_.enumtype.html">
<a href="../../../types/classes/_codec_enumtype_.enumtype.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.17" data-path="../../../types/classes/_codec_option_.option.html">
<a href="../../../types/classes/_codec_option_.option.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.18" data-path="../../../types/classes/_codec_set_.set.html">
<a href="../../../types/classes/_codec_set_.set.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.19" data-path="../../../types/classes/_codec_struct_.struct.html">
<a href="../../../types/classes/_codec_struct_.struct.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.20" data-path="../../../types/classes/_codec_tuple_.tuple.html">
<a href="../../../types/classes/_codec_tuple_.tuple.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.21" data-path="../../../types/classes/_codec_typeregistry_.typeregistry.html">
<a href="../../../types/classes/_codec_typeregistry_.typeregistry.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.22" data-path="../../../types/classes/_codec_u8a_.u8a.html">
<a href="../../../types/classes/_codec_u8a_.u8a.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.23" data-path="../../../types/classes/_codec_u8afixed_.u8afixed.html">
<a href="../../../types/classes/_codec_u8afixed_.u8afixed.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.24" data-path="../../../types/classes/_codec_uint_.uint.html">
<a href="../../../types/classes/_codec_uint_.uint.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.25" data-path="../../../types/classes/_codec_vector_.vector.html">
<a href="../../../types/classes/_codec_vector_.vector.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.26" data-path="../../../types/classes/_data_.data.html">
<a href="../../../types/classes/_data_.data.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.27" data-path="../../../types/classes/_digest_.authoritieschange.html">
<a href="../../../types/classes/_digest_.authoritieschange.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.28" data-path="../../../types/classes/_digest_.changestrieroot.html">
<a href="../../../types/classes/_digest_.changestrieroot.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.29" data-path="../../../types/classes/_digest_.digest.html">
<a href="../../../types/classes/_digest_.digest.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.30" data-path="../../../types/classes/_digest_.digestitem.html">
<a href="../../../types/classes/_digest_.digestitem.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.31" data-path="../../../types/classes/_digest_.other.html">
<a href="../../../types/classes/_digest_.other.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.32" data-path="../../../types/classes/_digest_.seal.html">
<a href="../../../types/classes/_digest_.seal.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.33" data-path="../../../types/classes/_event_.event.html">
<a href="../../../types/classes/_event_.event.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.34" data-path="../../../types/classes/_event_.eventdata.html">
<a href="../../../types/classes/_event_.eventdata.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.35" data-path="../../../types/classes/_event_.eventindex.html">
<a href="../../../types/classes/_event_.eventindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.36" data-path="../../../types/classes/_eventrecord_.applyextrinsic.html">
<a href="../../../types/classes/_eventrecord_.applyextrinsic.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.37" data-path="../../../types/classes/_eventrecord_.eventrecord.html">
<a href="../../../types/classes/_eventrecord_.eventrecord.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.38" data-path="../../../types/classes/_eventrecord_.finalization.html">
<a href="../../../types/classes/_eventrecord_.finalization.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.39" data-path="../../../types/classes/_eventrecord_.phase.html">
<a href="../../../types/classes/_eventrecord_.phase.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.40" data-path="../../../types/classes/_extrinsic_.extrinsic.html">
<a href="../../../types/classes/_extrinsic_.extrinsic.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.41" data-path="../../../types/classes/_extrinsicera_.extrinsicera.html">
<a href="../../../types/classes/_extrinsicera_.extrinsicera.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.42" data-path="../../../types/classes/_extrinsics_.extrinsics.html">
<a href="../../../types/classes/_extrinsics_.extrinsics.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.43" data-path="../../../types/classes/_extrinsicsignature_.extrinsicsignature.html">
<a href="../../../types/classes/_extrinsicsignature_.extrinsicsignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.44" data-path="../../../types/classes/_extrinsicstatus_.broadcast.html">
<a href="../../../types/classes/_extrinsicstatus_.broadcast.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.45" data-path="../../../types/classes/_extrinsicstatus_.dropped.html">
<a href="../../../types/classes/_extrinsicstatus_.dropped.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.46" data-path="../../../types/classes/_extrinsicstatus_.extrinsicstatus.html">
<a href="../../../types/classes/_extrinsicstatus_.extrinsicstatus.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.47" data-path="../../../types/classes/_extrinsicstatus_.finalised.html">
<a href="../../../types/classes/_extrinsicstatus_.finalised.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.48" data-path="../../../types/classes/_extrinsicstatus_.usurped.html">
<a href="../../../types/classes/_extrinsicstatus_.usurped.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.49" data-path="../../../types/classes/_gas_.gas.html">
<a href="../../../types/classes/_gas_.gas.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.50" data-path="../../../types/classes/_h256_.h256.html">
<a href="../../../types/classes/_h256_.h256.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.51" data-path="../../../types/classes/_h512_.h512.html">
<a href="../../../types/classes/_h512_.h512.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.52" data-path="../../../types/classes/_hash_.hash.html">
<a href="../../../types/classes/_hash_.hash.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.53" data-path="../../../types/classes/_header_.header.html">
<a href="../../../types/classes/_header_.header.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.54" data-path="../../../types/classes/_justification_.justification.html">
<a href="../../../types/classes/_justification_.justification.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.55" data-path="../../../types/classes/_justification_.rhdjustification.html">
<a href="../../../types/classes/_justification_.rhdjustification.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.56" data-path="../../../types/classes/_keyvalue_.keyvalue.html">
<a href="../../../types/classes/_keyvalue_.keyvalue.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.57" data-path="../../../types/classes/_keyvalue_.keyvalueoption.html">
<a href="../../../types/classes/_keyvalue_.keyvalueoption.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.58" data-path="../../../types/classes/_metadata_.callmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.59" data-path="../../../types/classes/_metadata_.eventmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.60" data-path="../../../types/classes/_metadata_.functionargumentmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.61" data-path="../../../types/classes/_metadata_.functionmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.62" data-path="../../../types/classes/_metadata_.modulemetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.63" data-path="../../../types/classes/_metadata_.outerdispatchcall.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.64" data-path="../../../types/classes/_metadata_.outerdispatchmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.65" data-path="../../../types/classes/_metadata_.outereventmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.66" data-path="../../../types/classes/_metadata_.outereventmetadataevent.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.67" data-path="../../../types/classes/_metadata_.runtimemetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.68" data-path="../../../types/classes/_metadata_.runtimemodulemetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.69" data-path="../../../types/classes/_metadata_.storagefunctionmetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.70" data-path="../../../types/classes/_metadata_.storagefunctionmodifier.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.71" data-path="../../../types/classes/_metadata_.storagefunctiontype.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.72" data-path="../../../types/classes/_metadata_.storagefunctiontype_map.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.73" data-path="../../../types/classes/_metadata_.storagemetadata.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.74" data-path="../../../types/classes/_method_.method.html">
<a href="../../../types/classes/_method_.method.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.75" data-path="../../../types/classes/_method_.methodindex.html">
<a href="../../../types/classes/_method_.methodindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.76" data-path="../../../types/classes/_misbehaviorreport_.bftatreport.html">
<a href="../../../types/classes/_misbehaviorreport_.bftatreport.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.77" data-path="../../../types/classes/_misbehaviorreport_.bftdoublecommit.html">
<a href="../../../types/classes/_misbehaviorreport_.bftdoublecommit.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.78" data-path="../../../types/classes/_misbehaviorreport_.bftdoubleprepare.html">
<a href="../../../types/classes/_misbehaviorreport_.bftdoubleprepare.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.79" data-path="../../../types/classes/_misbehaviorreport_.bftdoublepropose.html">
<a href="../../../types/classes/_misbehaviorreport_.bftdoublepropose.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.80" data-path="../../../types/classes/_misbehaviorreport_.bftproposeoutofturn.html">
<a href="../../../types/classes/_misbehaviorreport_.bftproposeoutofturn.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.81" data-path="../../../types/classes/_misbehaviorreport_.misbehaviorkind.html">
<a href="../../../types/classes/_misbehaviorreport_.misbehaviorkind.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.82" data-path="../../../types/classes/_misbehaviorreport_.misbehaviorreport.html">
<a href="../../../types/classes/_misbehaviorreport_.misbehaviorreport.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.83" data-path="../../../types/classes/_moment_.moment.html">
<a href="../../../types/classes/_moment_.moment.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.84" data-path="../../../types/classes/_newaccountoutcome_.newaccountoutcome.html">
<a href="../../../types/classes/_newaccountoutcome_.newaccountoutcome.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.85" data-path="../../../types/classes/_nonce_.nonce.html">
<a href="../../../types/classes/_nonce_.nonce.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.86" data-path="../../../types/classes/_null_.null.html">
<a href="../../../types/classes/_null_.null.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.87" data-path="../../../types/classes/_origin_.origin.html">
<a href="../../../types/classes/_origin_.origin.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.88" data-path="../../../types/classes/_parachainid_.parachainid.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="4.89" data-path="../../../types/classes/_pendingextrinsics_.pendingextrinsics.html">
<a href="../../../types/classes/_pendingextrinsics_.pendingextrinsics.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.90" data-path="../../../types/classes/_perbill_.perbill.html">
<a href="../../../types/classes/_perbill_.perbill.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.91" data-path="../../../types/classes/_permill_.permill.html">
<a href="../../../types/classes/_permill_.permill.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.92" data-path="../../../types/classes/_propindex_.propindex.html">
<a href="../../../types/classes/_propindex_.propindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.93" data-path="../../../types/classes/_proposal_.proposal.html">
<a href="../../../types/classes/_proposal_.proposal.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.94" data-path="../../../types/classes/_proposalindex_.proposalindex.html">
<a href="../../../types/classes/_proposalindex_.proposalindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.95" data-path="../../../types/classes/_referendumindex_.referendumindex.html">
<a href="../../../types/classes/_referendumindex_.referendumindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.96" data-path="../../../types/classes/_runtimeversion_.apiid.html">
<a href="../../../types/classes/_runtimeversion_.apiid.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.97" data-path="../../../types/classes/_runtimeversion_.runtimeversion.html">
<a href="../../../types/classes/_runtimeversion_.runtimeversion.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.98" data-path="../../../types/classes/_runtimeversion_.runtimeversionapi.html">
<a href="../../../types/classes/_runtimeversion_.runtimeversionapi.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.99" data-path="../../../types/classes/_sessionkey_.sessionkey.html">
<a href="../../../types/classes/_sessionkey_.sessionkey.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.100" data-path="../../../types/classes/_signature_.signature.html">
<a href="../../../types/classes/_signature_.signature.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.101" data-path="../../../types/classes/_signaturepayload_.signaturepayload.html">
<a href="../../../types/classes/_signaturepayload_.signaturepayload.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.102" data-path="../../../types/classes/_signedblock_.signedblock.html">
<a href="../../../types/classes/_signedblock_.signedblock.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.103" data-path="../../../types/classes/_storagechangeset_.storagechangeset.html">
<a href="../../../types/classes/_storagechangeset_.storagechangeset.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.104" data-path="../../../types/classes/_storagedata_.storagedata.html">
<a href="../../../types/classes/_storagedata_.storagedata.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.105" data-path="../../../types/classes/_storagekey_.storagekey.html">
<a href="../../../types/classes/_storagekey_.storagekey.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.106" data-path="../../../types/classes/_storedpendingchange_.nextauthority.html">
<a href="../../../types/classes/_storedpendingchange_.nextauthority.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.107" data-path="../../../types/classes/_storedpendingchange_.storedpendingchange.html">
<a href="../../../types/classes/_storedpendingchange_.storedpendingchange.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.108" data-path="../../../types/classes/_text_.text.html">
<a href="../../../types/classes/_text_.text.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.109" data-path="../../../types/classes/_type_.type.html">
<a href="../../../types/classes/_type_.type.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.110" data-path="../../../types/classes/_u128_.u128.html">
<a href="../../../types/classes/_u128_.u128.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.111" data-path="../../../types/classes/_u16_.u16.html">
<a href="../../../types/classes/_u16_.u16.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.112" data-path="../../../types/classes/_u256_.u256.html">
<a href="../../../types/classes/_u256_.u256.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.113" data-path="../../../types/classes/_u32_.u32.html">
<a href="../../../types/classes/_u32_.u32.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.114" data-path="../../../types/classes/_u64_.u64.html">
<a href="../../../types/classes/_u64_.u64.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.115" data-path="../../../types/classes/_u8_.u8.html">
<a href="../../../types/classes/_u8_.u8.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.116" data-path="../../../types/classes/_validatorprefs_.validatorprefs.html">
<a href="../../../types/classes/_validatorprefs_.validatorprefs.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.117" data-path="../../../types/classes/_voteindex_.voteindex.html">
<a href="../../../types/classes/_voteindex_.voteindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.118" data-path="../../../types/classes/_votethreshold_.votethreshold.html">
<a href="../../../types/classes/_votethreshold_.votethreshold.html">
hidden
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="../../.." >Simple connect</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="simple-connect">Simple Connect</h1>
<p>The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiRx.</p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-comment">//&#xA0;Required&#xA0;imports</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">zip</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">require</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;rxjs&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">ApiRx</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">require</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;@polkadot/api&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-punctuation">{</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">require</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;@polkadot/rpc-provider&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-keyword">function</span>&#xA0;<span class="sunlight-named-ident">main</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;Initialise&#xA0;the&#xA0;provider&#xA0;to&#xA0;connect&#xA0;to&#xA0;the&#xA0;local&#xA0;node</span>
&#xA0;&#xA0;<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;ws://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;Create&#xA0;the&#xA0;API&#xA0;and&#xA0;wait&#xA0;until&#xA0;ready</span>
&#xA0;&#xA0;<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-ident">await</span>&#xA0;<span class="sunlight-ident">ApiRx</span><span class="sunlight-operator">.</span><span class="sunlight-ident">create</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">toPromise</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;We&apos;re&#xA0;using&#xA0;RxJs&#xA0;&apos;zip()&apos;&#xA0;combination&#xA0;operator&#xA0;to&#xA0;get&#xA0;the&#xA0;emitted&#xA0;values</span>
&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;of&#xA0;multiple&#xA0;observables&#xA0;as&#xA0;an&#xA0;array</span>
&#xA0;&#xA0;<span class="sunlight-ident">zip</span><span class="sunlight-punctuation">(</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">rpc</span><span class="sunlight-operator">.</span><span class="sunlight-ident">system</span><span class="sunlight-operator">.</span><span class="sunlight-ident">chain</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">,</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">rpc</span><span class="sunlight-operator">.</span><span class="sunlight-ident">system</span><span class="sunlight-operator">.</span><span class="sunlight-ident">name</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">,</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">api</span><span class="sunlight-operator">.</span><span class="sunlight-ident">rpc</span><span class="sunlight-operator">.</span><span class="sunlight-ident">system</span><span class="sunlight-operator">.</span><span class="sunlight-ident">version</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">)</span>
&#xA0;&#xA0;<span class="sunlight-comment">//&#xA0;Then&#xA0;we&#xA0;subscribe&#xA0;to&#xA0;the&#xA0;result</span>
&#xA0;&#xA0;<span class="sunlight-operator">.</span><span class="sunlight-ident">subscribe</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">[</span><span class="sunlight-ident">chain</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">nodeName</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">nodeVersion</span><span class="sunlight-punctuation">]</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">`</span><span class="sunlight-ident">You</span>&#xA0;<span class="sunlight-ident">are</span>&#xA0;<span class="sunlight-ident">connected</span>&#xA0;<span class="sunlight-ident">to</span>&#xA0;<span class="sunlight-ident">chain</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">chain</span><span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">using</span>&#xA0;<span class="sunlight-ident">$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">nodeName</span><span class="sunlight-punctuation">}</span>&#xA0;<span class="sunlight-ident">v$</span><span class="sunlight-punctuation">{</span><span class="sunlight-ident">nodeVersion</span><span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">`</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
&#xA0;&#xA0;<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-punctuation">}</span>
<span class="sunlight-ident">main</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-keyword">catch</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">error</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-keyword">finally</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-ident">process</span><span class="sunlight-operator">.</span><span class="sunlight-ident">exit</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="../" class="navigation navigation-prev " aria-label="Previous page: ApiRx">
<i class="fa fa-angle-left"></i>
</a>
<a href="../02_listen_to_blocks/" class="navigation navigation-next " aria-label="Next page: Listen to blocks">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Simple connect","level":"3.2.1","depth":2,"next":{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},"previous":{"title":"ApiRx","level":"3.2","depth":1,"path":"examples/rx/README.md","ref":"examples/rx/README.md","articles":[{"title":"Simple connect","level":"3.2.1","depth":2,"path":"examples/rx/01_simple_connect/README.md","ref":"examples/rx/01_simple_connect/README.md","articles":[]},{"title":"Listen to blocks","level":"3.2.2","depth":2,"path":"examples/rx/02_listen_to_blocks/README.md","ref":"examples/rx/02_listen_to_blocks/README.md","articles":[]},{"title":"Listen to balance change","level":"3.2.3","depth":2,"path":"examples/rx/03_listen_to_balance_change/README.md","ref":"examples/rx/03_listen_to_balance_change/README.md","articles":[]},{"title":"Unsubscribe from listening","level":"3.2.4","depth":2,"path":"examples/rx/04_unsubscribe/README.md","ref":"examples/rx/04_unsubscribe/README.md","articles":[]},{"title":"Read chain state","level":"3.2.5","depth":2,"path":"examples/rx/05_read_storage/README.md","ref":"examples/rx/05_read_storage/README.md","articles":[]},{"title":"Make a transfer","level":"3.2.6","depth":2,"path":"examples/rx/06_make_transfer/README.md","ref":"examples/rx/06_make_transfer/README.md","articles":[]},{"title":"Display system events","level":"3.2.7","depth":2,"path":"examples/rx/08_system_events/README.md","ref":"examples/rx/08_system_events/README.md","articles":[]},{"title":"Transaction with events","level":"3.2.8","depth":2,"path":"examples/rx/09_transfer_events/README.md","ref":"examples/rx/09_transfer_events/README.md","articles":[]},{"title":"Upgrade via sudo","level":"3.2.9","depth":2,"path":"examples/rx/10_upgrade_chain/README.md","ref":"examples/rx/10_upgrade_chain/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"examples/rx/01_simple_connect/README.md","mtime":"2019-01-29T16:10:41.325Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-29T16:14:59.334Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
<script src="../../../gitbook/gitbook.js"></script>
<script src="../../../gitbook/theme.js"></script>
<script src="../../../gitbook/gitbook-plugin-insert-logo-link/plugin.js"></script>
<script src="../../../gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="../../../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../../../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../../../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../../../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../../../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../../../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
<script src="../../../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>