1 line
82 KiB
JavaScript
1 line
82 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[47],{497:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-api-rx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-api-rx","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/api/rx")]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview","aria-hidden":"true"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": ApiRx")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static "),a("code",[t._v(".create(...)")]),t._v(". In the same fashion and subscription-based methods return long-running Observables that update with the latest values.")]),t._v(" "),a("p",[t._v("The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding "),a("code",[t._v(".subscribe")]),t._v(" and "),a("code",[t._v(".pipe")]),t._v(" on Observables will unlock full-scale use thereof.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("see")])]),t._v(": "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Making rpc calls -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" ApiRx "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via Promise & static create")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// make a call to retrieve the current network head")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br")])]),a("p",[t._v("Subscribing to chain state -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" combineLatest "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" pairwise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" WsProvider "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise a provider with a specific endpoint")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'wss://example.com:9944'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via isReady & new with specific provider")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ApiRx")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("combineLatest")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blockPeriod")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pairwise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" elapsed "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`timestamp ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" \\nelapsed ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("elapsed"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" \\n(")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("s target)`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br")])]),a("p",[t._v("Submitting a transaction -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" first"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" ApiRx "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" testingPairs "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring/testingPairs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("testingPairs")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get api via Promise")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve nonce for the account")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("first")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pipe nonce into transfer")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("nonce"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create transfer")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("bob"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("12345")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// sign the transcation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("sign")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" nonce "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// send the transaction")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("send")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to overall result")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Completed at block hash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br"),a("span",{staticClass:"line-number"},[t._v("23")]),a("br"),a("span",{staticClass:"line-number"},[t._v("24")]),a("br"),a("span",{staticClass:"line-number"},[t._v("25")]),a("br"),a("span",{staticClass:"line-number"},[t._v("26")]),a("br"),a("span",{staticClass:"line-number"},[t._v("27")]),a("br"),a("span",{staticClass:"line-number"},[t._v("28")]),a("br"),a("span",{staticClass:"line-number"},[t._v("29")]),a("br"),a("span",{staticClass:"line-number"},[t._v("30")]),a("br"),a("span",{staticClass:"line-number"},[t._v("31")]),a("br"),a("span",{staticClass:"line-number"},[t._v("32")]),a("br")])]),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("strong",[t._v("↳ ApiRx")])]),t._v(" "),a("h1",{attrs:{id:"implements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1)]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new ApiRx")]),t._v("(provider?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v("): "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("p",[a("em",[t._v("Overrides "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Create an instance of the ApiRx class")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" provider")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"accessors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),a("p",[a("a",{attrs:{id:"derive"}})]),t._v(" "),a("h2",{attrs:{id:"derive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),a("p",[a("strong",[t._v("get derive")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#derive"}},[t._v("derive")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'best number'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"genesishash"}})]),t._v(" "),a("h2",{attrs:{id:"genesishash"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),a("p",[a("strong",[t._v("get genesisHash")]),t._v("(): "),a("code",[t._v("Hash")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#genesishash"}},[t._v("genesisHash")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Hash")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),a("h2",{attrs:{id:"hassubscriptions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),a("p",[a("strong",[t._v("get hasSubscriptions")]),t._v("(): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#hassubscriptions"}},[t._v("hasSubscriptions")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"isconnected"}})]),t._v(" "),a("h2",{attrs:{id:"isconnected"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isconnected","aria-hidden":"true"}},[t._v("#")]),t._v(" isConnected")]),t._v(" "),a("p",[a("strong",[t._v("get isConnected")]),t._v("(): "),a("code",[t._v("Observable")]),t._v("<"),a("code",[t._v("boolean")]),t._v(">")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L181",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:181"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Observable")]),t._v("<"),a("code",[t._v("boolean")]),t._v(">")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"isready"}})]),t._v(" "),a("h2",{attrs:{id:"isready"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isready","aria-hidden":"true"}},[t._v("#")]),t._v(" isReady")]),t._v(" "),a("p",[a("strong",[t._v("get isReady")]),t._v("(): "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L188",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:188"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Observable that returns the first time we are connected and loaded")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),a("h2",{attrs:{id:"libraryinfo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),a("p",[a("strong",[t._v("get libraryInfo")]),t._v("(): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#libraryinfo"}},[t._v("libraryInfo")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"query"}})]),t._v(" "),a("h2",{attrs:{id:"query"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),a("p",[a("strong",[t._v("get query")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#query"}},[t._v("query")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[t._v("All calls inside the namespace, is denoted by "),a("code",[t._v("section")]),t._v("."),a("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),a("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),a("code",[t._v("api.query.system.accountNonce(<accountId>)")]),t._v(" (retrieving the associated nonce for an account), takes the "),a("code",[t._v("AccountId")]),t._v(" as a parameter.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new balance'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpc"}})]),t._v(" "),a("h2",{attrs:{id:"rpc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),a("p",[a("strong",[t._v("get rpc")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#rpc"}},[t._v("rpc")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),a("code",[t._v("api.query")]),t._v(" and "),a("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),a("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new header'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),a("h2",{attrs:{id:"runtimemetadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeMetadata")]),t._v("(): "),a("code",[t._v("Metadata")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimemetadata"}},[t._v("runtimeMetadata")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Metadata")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),a("h2",{attrs:{id:"runtimeversion"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeVersion")]),t._v("(): "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimeversion"}},[t._v("runtimeVersion")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tx"}})]),t._v(" "),a("h2",{attrs:{id:"tx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),a("p",[a("strong",[t._v("get tx")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#tx"}},[t._v("tx")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'tx status'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"type"}})]),t._v(" "),a("h2",{attrs:{id:"type"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),a("p",[a("strong",[t._v("get type")]),t._v("(): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#type"}},[t._v("type")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"clone"}})]),t._v(" "),a("h2",{attrs:{id:"clone"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[t._v("#")]),t._v(" clone")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("clone")]),t._v("(): "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L195",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:195"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a clone of this ApiRx instance (new underlying provider connection)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"disconnect"}})]),t._v(" "),a("h2",{attrs:{id:"disconnect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("disconnect")]),t._v("(): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"on"}})]),t._v(" "),a("h2",{attrs:{id:"on"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("on")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#on"}},[t._v("on")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"once"}})]),t._v(" "),a("h2",{attrs:{id:"once"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("once")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#once"}},[t._v("once")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"registertypes"}})]),t._v(" "),a("h2",{attrs:{id:"registertypes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("registerTypes")]),t._v("(types?: "),a("em",[a("code",[t._v("RegistryTypes")])]),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" types")]),t._v(" "),a("td",[a("code",[t._v("RegistryTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"setsigner"}})]),t._v(" "),a("h2",{attrs:{id:"setsigner"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("setSigner")]),t._v("(signer: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("signer")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"create"}})]),t._v(" "),a("h2",{attrs:{id:"static-create"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-create","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("<Static>")]),t._v(" create")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("create")]),t._v("(options?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v("): "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/73a5ea1/packages/api/src/rx/Api.ts#L139",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:139"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nApi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(" "),a("td",[t._v("options that is passed to the class contructor. Can be either "),a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" or [[WsProvider]]")],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); |