466 lines
14 KiB
HTML
466 lines
14 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 Common 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="keyring/" />
|
|
|
|
|
|
|
|
</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="keyring/">
|
|
|
|
<a href="keyring/">
|
|
|
|
|
|
keyring
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="trie-db/">
|
|
|
|
<a href="trie-db/">
|
|
|
|
|
|
trie-db
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" data-path="trie-hash/">
|
|
|
|
<a href="trie-hash/">
|
|
|
|
|
|
trie-hash
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5" data-path="util/">
|
|
|
|
<a href="util/">
|
|
|
|
|
|
util
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6" data-path="util-crypto/">
|
|
|
|
<a href="util-crypto/">
|
|
|
|
|
|
util-crypto
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Examples</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" data-path="examples/keyring/">
|
|
|
|
<a href="examples/keyring/">
|
|
|
|
|
|
Keyring
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.1.1" data-path="examples/keyring/01_create_account/">
|
|
|
|
<a href="examples/keyring/01_create_account/">
|
|
|
|
|
|
Create Account
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.1.2" data-path="examples/keyring/02_load_accounts/">
|
|
|
|
<a href="examples/keyring/02_load_accounts/">
|
|
|
|
|
|
Load Accounts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2" data-path="examples/util-crypto/">
|
|
|
|
<a href="examples/util-crypto/">
|
|
|
|
|
|
Util-Crypto
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.2.1" data-path="examples/util-crypto/01_encrypt_decrypt_message_nacl/">
|
|
|
|
<a href="examples/util-crypto/01_encrypt_decrypt_message_nacl/">
|
|
|
|
|
|
Encrypt & Decrypt Message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.2" data-path="examples/util-crypto/02_sign_verify_message_nacl/">
|
|
|
|
<a href="examples/util-crypto/02_sign_verify_message_nacl/">
|
|
|
|
|
|
Sign & Verify Message
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2.3" data-path="examples/util-crypto/03_mnemonic_generate_validate_bip39/">
|
|
|
|
<a href="examples/util-crypto/03_mnemonic_generate_validate_bip39/">
|
|
|
|
|
|
Create & Validate Mnemonic
|
|
|
|
</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-common">Polkadot Javascript Common</h1>
|
|
<p>Various useful utility functions that are used across all projects in the <a href="https://polkadot.js.org" target="_blank">@polkadot</a> namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.</p>
|
|
<p>It is split up into a number of internal packages, namely utilities -</p>
|
|
<ul>
|
|
<li><a href="keyring/">keyring</a> Keyring management</li>
|
|
<li><a href="util/">util</a> General utilities</li>
|
|
<li><a href="util-crypto/">util-crypto</a> Crypto and hashing utilities</li>
|
|
<li><a href="util-rlp/README.md">util-rlp</a> RLP encoding & decoding</li>
|
|
</ul>
|
|
<p>Various useful trie and database interfaces -</p>
|
|
<ul>
|
|
<li><a href="db/README.md">db</a> Sync memory and disk database interfaces</li>
|
|
<li><a href="trie-db/">trie-db</a> Merkle Patricia Tree implementation adapcted for Polkadot</li>
|
|
<li><a href="trie-hash/">trie-hash</a> Calculate hashes (either ordered or unordered) from a set of inputs</li>
|
|
</ul>
|
|
<p>This guide describes Polkadot Javascript Common.</p>
|
|
<h2 id="packages">Packages</h2>
|
|
<ul>
|
|
<li><a href="keyring/">keyring</a></li>
|
|
<li><a href="trie-db/">trie-db</a></li>
|
|
<li><a href="trie-hash/">trie-hash</a></li>
|
|
<li><a href="util/">util</a></li>
|
|
<li><a href="util-crypto/">util-crypto</a></li>
|
|
</ul>
|
|
<h2 id="examples">Examples</h2>
|
|
<ul>
|
|
<li><a href="examples/keyring/">Keyring</a><ul>
|
|
<li><a href="examples/keyring/01_create_account/">Create Account</a></li>
|
|
<li><a href="examples/keyring/02_load_accounts/">Load Accounts</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="examples/util-crypto/">Util-Crypto</a><ul>
|
|
<li><a href="examples/util-crypto/01_encrypt_decrypt_message_nacl/">Encrypt & Decrypt Message</a></li>
|
|
<li><a href="examples/util-crypto/02_sign_verify_message_nacl/">Sign & Verify Message</a></li>
|
|
<li><a href="examples/util-crypto/03_mnemonic_generate_validate_bip39/">Create & Validate Mnemonic</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 Polkadot JS Common are more than welcome. You can <a href="https://github.com/polkadot-js/common/issues/new" target="_blank">report issues</a> and <a href="https://github.com/polkadot-js/common/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="keyring/" class="navigation navigation-next navigation-unique" aria-label="Next page: keyring">
|
|
<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":"keyring","level":"1.2","depth":1,"path":"keyring/README.md","ref":"keyring/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/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 Common Book","gitbook":">=2.4.0"},"file":{"path":"README.md","mtime":"2019-01-11T09:56:09.958Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-11T10:00:10.961Z"},"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>
|
|
|