526 lines
15 KiB
HTML
526 lines
15 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Introduction · 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="api/" />
|
|
|
|
|
|
|
|
</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 active" 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="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="examples/promise/">
|
|
|
|
<a href="examples/promise/">
|
|
|
|
|
|
ApiPromise
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="3.1.1" data-path="examples/promise/01_simple_connect/">
|
|
|
|
<a href="examples/promise/01_simple_connect/">
|
|
|
|
|
|
Simple connect
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.1.2" data-path="examples/promise/02_listen_to_blocks/">
|
|
|
|
<a href="examples/promise/02_listen_to_blocks/">
|
|
|
|
|
|
Listen to blocks
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.1.3" data-path="examples/promise/03_listen_to_balance_change/">
|
|
|
|
<a href="examples/promise/03_listen_to_balance_change/">
|
|
|
|
|
|
Listen to balance change
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.1.4" data-path="examples/promise/05_read_storage/">
|
|
|
|
<a href="examples/promise/05_read_storage/">
|
|
|
|
|
|
Read chain state
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.1.5" data-path="examples/promise/07_transfer_dots/">
|
|
|
|
<a href="examples/promise/07_transfer_dots/">
|
|
|
|
|
|
Make a transfer
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</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="." >Introduction</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="polkadot-javascript-api">Polkadot Javascript API</h1>
|
|
<p>You can query a node and interact with the Polkadot network using Javascript. This guide describes the Polkadot Javascript API.</p>
|
|
<h2 id="packages">Packages</h2>
|
|
<ul>
|
|
<li><a href="api/">api</a><ul>
|
|
<li><a href="api/classes/_promise_index_.apipromise.html">ApiPromise</a></li>
|
|
<li><a href="api/classes/_rx_index_.apirx.html">ApiRx</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="rpc-provider/">rpc-provider</a><ul>
|
|
<li><a href="rpc-provider/classes/_http_index_.httpprovider.html">HttpProvider</a></li>
|
|
<li><a href="rpc-provider/classes/_ws_index_.wsprovider.html">WsProvider</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2 id="interfaces">Interfaces</h2>
|
|
<ul>
|
|
<li><a href="METHODS_RPC.html">RPC</a></li>
|
|
<li><a href="METHODS_STORAGE.html">Chain state (runtime)</a></li>
|
|
<li><a href="METHODS_EXTRINSICS.html">Extrinsics (runtime)</a></li>
|
|
<li><a href="METHODS_EVENTS.html">Events (runtime)</a></li>
|
|
</ul>
|
|
<h2 id="examples">Examples</h2>
|
|
<ul>
|
|
<li><a href="examples/promise/">ApiPromise</a><ul>
|
|
<li><a href="examples/promise/01_simple_connect/">Simple connect</a></li>
|
|
<li><a href="examples/promise/02_listen_to_blocks/">Listen to blocks</a></li>
|
|
<li><a href="examples/promise/03_listen_to_balance_change/">Listen to balance change</a></li>
|
|
<li><a href="examples/promise/05_read_storage/">Read chain state</a></li>
|
|
<li><a href="examples/promise/07_transfer_dots/">Make a transfer</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2 id="the-polkadot-project">The Polkadot Project</h2>
|
|
<p>You can read more about the Polkadot Network at <a href="https://polkadot.network/" target="_blank">https://polkadot.network/</a></p>
|
|
<h2 id="github-repositories">Github repositories</h2>
|
|
<p>You can find the Polkadot repositories at:</p>
|
|
<ul>
|
|
<li><a href="https://github.com/polkadot-js" target="_blank">https://github.com/polkadot-js</a></li>
|
|
<li><a href="https://github.com/paritytech/polkadot" target="_blank">https://github.com/paritytech/polkadot</a></li>
|
|
<li><a href="https://github.com/paritytech/substrate" target="_blank">https://github.com/paritytech/substrate</a></li>
|
|
</ul>
|
|
<p>This documentation is generated from <a href="https://github.com/polkadot-js/api" target="_blank">https://github.com/polkadot-js/api</a></p>
|
|
<h2 id="contributing">Contributing</h2>
|
|
<p>Contribution to the Polkadot JS API are more than welcome. You can <a href="https://github.com/polkadot-js/api/issues/new" target="_blank">report issues</a> and <a href="https://github.com/polkadot-js/api/issues/new" target="_blank">log feature requests</a>.</p>
|
|
|
|
|
|
</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="api/" class="navigation navigation-next navigation-unique" aria-label="Next page: api">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"ApiPromise","level":"1.2.1","depth":2,"path":"api/classes/_promise_index_.apipromise.md","ref":"api/classes/_promise_index_.apipromise.md","articles":[]},{"title":"ApiRx","level":"1.2.2","depth":2,"path":"api/classes/_rx_index_.apirx.md","ref":"api/classes/_rx_index_.apirx.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":"README.md","mtime":"2018-10-22T10:28:37.840Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-10-22T10:32:23.497Z"},"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>
|
|
|