1759 lines
65 KiB
HTML
1759 lines
65 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>type-primitives · 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-highlight/website.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/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="../type-storage/" />
|
|
|
|
|
|
<link rel="prev" href="../type-params/" />
|
|
|
|
|
|
</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">Intro</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">API</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" data-path="../api/">
|
|
|
|
<a href="../api/">
|
|
|
|
|
|
api
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2" data-path="../api-format/">
|
|
|
|
<a href="../api-format/">
|
|
|
|
|
|
api-format
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3" data-path="../api-provider/">
|
|
|
|
<a href="../api-provider/">
|
|
|
|
|
|
api-provider
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4" data-path="../api-rx/">
|
|
|
|
<a href="../api-rx/">
|
|
|
|
|
|
api-rx
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5" data-path="../type-extrinsics/">
|
|
|
|
<a href="../type-extrinsics/">
|
|
|
|
|
|
type-extrinsics
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6" data-path="../type-jsonrpc/">
|
|
|
|
<a href="../type-jsonrpc/">
|
|
|
|
|
|
type-jsonrpc
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7" data-path="../type-params/">
|
|
|
|
<a href="../type-params/">
|
|
|
|
|
|
type-params
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="2.8" data-path="./">
|
|
|
|
<a href="./">
|
|
|
|
|
|
type-primitives
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.9" data-path="../type-storage/">
|
|
|
|
<a href="../type-storage/">
|
|
|
|
|
|
type-storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Examples</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="3.1" data-path="../examples/">
|
|
|
|
<a href="../examples/">
|
|
|
|
|
|
Overview
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.2" data-path="../examples/01_simple_connect/">
|
|
|
|
<a href="../examples/01_simple_connect/">
|
|
|
|
|
|
Simple connect
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.3" data-path="../examples/02_listen_to_blocks/">
|
|
|
|
<a href="../examples/02_listen_to_blocks/">
|
|
|
|
|
|
Listen to blocks
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.4" data-path="../examples/03_listen_to_balance_change/">
|
|
|
|
<a href="../examples/03_listen_to_balance_change/">
|
|
|
|
|
|
Listen to balance change
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.5" data-path="../examples/04_generate_account/">
|
|
|
|
<a href="../examples/04_generate_account/">
|
|
|
|
|
|
Generate Accounts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.6" data-path="../examples/05_read_storage/">
|
|
|
|
<a href="../examples/05_read_storage/">
|
|
|
|
|
|
Read Storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.7" data-path="../examples/06_craft_extrinsic/">
|
|
|
|
<a href="../examples/06_craft_extrinsic/">
|
|
|
|
|
|
Craft Extrinsic
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.8" data-path="../examples/07_transfer_dots/">
|
|
|
|
<a href="../examples/07_transfer_dots/">
|
|
|
|
|
|
Transfer DOTs
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Contributing</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="4.1" data-path="../CONTRIBUTING.html">
|
|
|
|
<a href="../CONTRIBUTING.html">
|
|
|
|
|
|
Contributing guide
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >type-primitives</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">
|
|
|
|
<p><a href="https://polkadot.js.org" target="_blank"><img src="https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square" alt="polkadotjs"></a> <img src="https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square" alt="isc"> <a href="https://github.com/Flet/semistandard" target="_blank"><img src="https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square" alt="style"></a> <a href="https://www.npmjs.com/package/@polkadot/primitives" target="_blank"><img src="https://img.shields.io/npm/v/@polkadot/primitives.svg?style=flat-square" alt="npm"></a> <a href="https://travis-ci.org/polkadot-js/api" target="_blank"><img src="https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square" alt="travis"></a> <a href="https://codeclimate.com/github/polkadot-js/api/maintainability" target="_blank"><img src="https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square" alt="maintainability"></a> <a href="https://coveralls.io/github/polkadot-js/api?branch=master" target="_blank"><img src="https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square" alt="coverage"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/type-primitives" target="_blank"><img src="https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/type-primitives" alt="dependency"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/type-primitives#info=devDependencies" target="_blank"><img src="https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/type-primitives" alt="devDependency"></a></p>
|
|
<h1 id="polkadotprimitives">@polkadot/primitives</h1>
|
|
<p>Base <a href="https://flow.org/" target="_blank">flow</a> definitions for the base Polkadot types as defined in the <a href="https://github.com/w3f/polkadot-spec" target="_blank">specification</a>. It is useful for implementations, applications and libraries, where type-checking of the JavaScript base types is of importance.</p>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>Installation -</p>
|
|
<pre><code>npm install --save @polkadot/primitives
|
|
</code></pre><p>Usage -</p>
|
|
<pre><code class="lang-js"><span class="hljs-comment">// @flow</span>
|
|
|
|
<span class="hljs-keyword">import</span> type { AccountId, Balance } <span class="hljs-keyword">from</span> <span class="hljs-string">'@polkadot/primitives/base'</span>;
|
|
|
|
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">getBalance</span> (<span class="hljs-params">accountId: AccountId</span>): <span class="hljs-title">Balance</span> </span>{
|
|
...
|
|
}
|
|
</code></pre>
|
|
<h2 id="index">Index</h2>
|
|
<h3 id="type-aliases">Type aliases</h3>
|
|
<ul>
|
|
<li><a href="#accountid">AccountId</a></li>
|
|
<li><a href="#balance">Balance</a></li>
|
|
<li><a href="#block">Block</a></li>
|
|
<li><a href="#blockincomplete">BlockIncomplete</a></li>
|
|
<li><a href="#blocknumber">BlockNumber</a></li>
|
|
<li><a href="#bytes">Bytes</a></li>
|
|
<li><a href="#candidate">Candidate</a></li>
|
|
<li><a href="#candidatereceipt">CandidateReceipt</a></li>
|
|
<li><a href="#candidatereceipt_balanceupload">CandidateReceipt$BalanceUpload</a></li>
|
|
<li><a href="#candidatereceipt_egressqueueroot">CandidateReceipt$EgressQueueRoot</a></li>
|
|
<li><a href="#chainid">ChainId</a></li>
|
|
<li><a href="#digest">Digest</a></li>
|
|
<li><a href="#digest_log">Digest$Log</a></li>
|
|
<li><a href="#extrinsicfunction">ExtrinsicFunction</a></li>
|
|
<li><a href="#h160">H160</a></li>
|
|
<li><a href="#h256">H256</a></li>
|
|
<li><a href="#h512">H512</a></li>
|
|
<li><a href="#hash">Hash</a></li>
|
|
<li><a href="#header">Header</a></li>
|
|
<li><a href="#headerhash">HeaderHash</a></li>
|
|
<li><a href="#headerincomplete">HeaderIncomplete</a></li>
|
|
<li><a href="#index">Index</a></li>
|
|
<li><a href="#jsonaccountid">JsonAccountId</a></li>
|
|
<li><a href="#jsonauthorityid">JsonAuthorityId</a></li>
|
|
<li><a href="#jsonblock">JsonBlock</a></li>
|
|
<li><a href="#jsonblocknumber">JsonBlockNumber</a></li>
|
|
<li><a href="#jsonbntype">JsonBnType</a></li>
|
|
<li><a href="#jsonbytes">JsonBytes</a></li>
|
|
<li><a href="#jsondigest">JsonDigest</a></li>
|
|
<li><a href="#jsonh160">JsonH160</a></li>
|
|
<li><a href="#jsonh256">JsonH256</a></li>
|
|
<li><a href="#jsonh512">JsonH512</a></li>
|
|
<li><a href="#jsonhash">JsonHash</a></li>
|
|
<li><a href="#jsonheader">JsonHeader</a></li>
|
|
<li><a href="#jsonheaderhash">JsonHeaderHash</a></li>
|
|
<li><a href="#jsonjustification">JsonJustification</a></li>
|
|
<li><a href="#jsonjustification_signature">JsonJustification$Signature</a></li>
|
|
<li><a href="#jsonobjectid">JsonObjectId</a></li>
|
|
<li><a href="#jsonparachainid">JsonParaChainId</a></li>
|
|
<li><a href="#jsonsignature">JsonSignature</a></li>
|
|
<li><a href="#jsontransaction">JsonTransaction</a></li>
|
|
<li><a href="#jsonu256">JsonU256</a></li>
|
|
<li><a href="#jsonu64">JsonU64</a></li>
|
|
<li><a href="#jsonunchecked">JsonUnchecked</a></li>
|
|
<li><a href="#justification">Justification</a></li>
|
|
<li><a href="#justification_signature">Justification$Signature</a></li>
|
|
<li><a href="#misbehaviorreport">MisbehaviorReport</a></li>
|
|
<li><a href="#objectid">ObjectId</a></li>
|
|
<li><a href="#parachainid">ParaChainId</a></li>
|
|
<li><a href="#proportion">Proportion</a></li>
|
|
<li><a href="#role">Role</a></li>
|
|
<li><a href="#rolemap">RoleMap</a></li>
|
|
<li><a href="#signature">Signature</a></li>
|
|
<li><a href="#sizetype">SizeType</a></li>
|
|
<li><a href="#timestamp">Timestamp</a></li>
|
|
<li><a href="#u128">U128</a></li>
|
|
<li><a href="#u256">U256</a></li>
|
|
<li><a href="#u32">U32</a></li>
|
|
<li><a href="#u64">U64</a></li>
|
|
<li><a href="#unchecked">Unchecked</a></li>
|
|
<li><a href="#uncheckedraw">UncheckedRaw</a></li>
|
|
</ul>
|
|
<h3 id="functions">Functions</h3>
|
|
<ul>
|
|
<li><a href="#accountiddecode">accountIdDecode</a></li>
|
|
<li><a href="#accountidencode">accountIdEncode</a></li>
|
|
<li><a href="#block">block</a></li>
|
|
<li><a href="#blockdecode">blockDecode</a></li>
|
|
<li><a href="#bndecode">bnDecode</a></li>
|
|
<li><a href="#bnencode">bnEncode</a></li>
|
|
<li><a href="#bytesdecode">bytesDecode</a></li>
|
|
<li><a href="#bytesencode">bytesEncode</a></li>
|
|
<li><a href="#decodearray">decodeArray</a></li>
|
|
<li><a href="#decodeblock">decodeBlock</a></li>
|
|
<li><a href="#decodeheader">decodeHeader</a></li>
|
|
<li><a href="#decodejustification">decodeJustification</a></li>
|
|
<li><a href="#decoderaw">decodeRaw</a></li>
|
|
<li><a href="#decodeu8a">decodeU8a</a></li>
|
|
<li><a href="#encodearray">encodeArray</a></li>
|
|
<li><a href="#encodeblock">encodeBlock</a></li>
|
|
<li><a href="#encodeblockraw">encodeBlockRaw</a></li>
|
|
<li><a href="#encodeheader">encodeHeader</a></li>
|
|
<li><a href="#encodeu8a">encodeU8a</a></li>
|
|
<li><a href="#extrinsicdecode">extrinsicDecode</a></li>
|
|
<li><a href="#extrinsicsrootraw">extrinsicsRootRaw</a></li>
|
|
<li><a href="#hashdecode">hashDecode</a></li>
|
|
<li><a href="#hashencode">hashEncode</a></li>
|
|
<li><a href="#header">header</a></li>
|
|
<li><a href="#headerdecode">headerDecode</a></li>
|
|
<li><a href="#headerencode">headerEncode</a></li>
|
|
<li><a href="#headerhash">headerHash</a></li>
|
|
<li><a href="#justificationdecode">justificationDecode</a></li>
|
|
<li><a href="#justificationencode">justificationEncode</a></li>
|
|
<li><a href="#objectiddecode">objectIdDecode</a></li>
|
|
<li><a href="#objectidencode">objectIdEncode</a></li>
|
|
<li><a href="#parachainiddecode">parachainIdDecode</a></li>
|
|
<li><a href="#parachainidencode">parachainIdEncode</a></li>
|
|
<li><a href="#rolesfromid">rolesFromId</a></li>
|
|
<li><a href="#rolestoid">rolesToId</a></li>
|
|
<li><a href="#signaturedecode">signatureDecode</a></li>
|
|
<li><a href="#signatureencode">signatureEncode</a></li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="type-aliases">Type aliases</h2>
|
|
<p><a id="accountid"></a></p>
|
|
<h3 id="accountid">AccountId</h3>
|
|
<p><strong>Ƭ AccountId</strong>: <em><a href="#h256">H256</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L17" target="_blank">base.d.ts:17</a></em></p>
|
|
<hr>
|
|
<p><a id="balance"></a></p>
|
|
<h3 id="balance">Balance</h3>
|
|
<p><strong>Ƭ Balance</strong>: <em><a href="#u128">U128</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L18" target="_blank">base.d.ts:18</a></em></p>
|
|
<hr>
|
|
<p><a id="block"></a></p>
|
|
<h3 id="block">Block</h3>
|
|
<p><strong>Ƭ Block</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/block.d.ts#L8" target="_blank">block.d.ts:8</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="blockincomplete"></a></p>
|
|
<h3 id="blockincomplete">BlockIncomplete</h3>
|
|
<p><strong>Ƭ BlockIncomplete</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/create/types.d.ts#L19" target="_blank">create/types.d.ts:19</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="blocknumber"></a></p>
|
|
<h3 id="blocknumber">BlockNumber</h3>
|
|
<p><strong>Ƭ BlockNumber</strong>: <em><a href="#u64">U64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L19" target="_blank">base.d.ts:19</a></em></p>
|
|
<hr>
|
|
<p><a id="bytes"></a></p>
|
|
<h3 id="bytes">Bytes</h3>
|
|
<p><strong>Ƭ Bytes</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L7" target="_blank">base.d.ts:7</a></em></p>
|
|
<hr>
|
|
<p><a id="candidate"></a></p>
|
|
<h3 id="candidate">Candidate</h3>
|
|
<p><strong>Ƭ Candidate</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/candidate.d.ts#L7" target="_blank">candidate.d.ts:7</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="candidatereceipt"></a></p>
|
|
<h3 id="candidatereceipt">CandidateReceipt</h3>
|
|
<p><strong>Ƭ CandidateReceipt</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/candidate.d.ts#L17" target="_blank">candidate.d.ts:17</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="candidatereceipt_balanceupload"></a></p>
|
|
<h3 id="candidatereceiptbalanceupload">CandidateReceipt$BalanceUpload</h3>
|
|
<p><strong>Ƭ CandidateReceipt$BalanceUpload</strong>: <em>[<a href="#accountid">AccountId</a>, <a href="#balance">Balance</a>]</em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/candidate.d.ts#L14" target="_blank">candidate.d.ts:14</a></em></p>
|
|
<hr>
|
|
<p><a id="candidatereceipt_egressqueueroot"></a></p>
|
|
<h3 id="candidatereceiptegressqueueroot">CandidateReceipt$EgressQueueRoot</h3>
|
|
<p><strong>Ƭ CandidateReceipt$EgressQueueRoot</strong>: <em>[<a href="#chainid">ChainId</a>, <a href="#hash">Hash</a>]</em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/candidate.d.ts#L15" target="_blank">candidate.d.ts:15</a></em></p>
|
|
<hr>
|
|
<p><a id="chainid"></a></p>
|
|
<h3 id="chainid">ChainId</h3>
|
|
<p><strong>Ƭ ChainId</strong>: <em><a href="#u32">U32</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L20" target="_blank">base.d.ts:20</a></em></p>
|
|
<hr>
|
|
<p><a id="digest"></a></p>
|
|
<h3 id="digest">Digest</h3>
|
|
<p><strong>Ƭ Digest</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/digest.d.ts#L9" target="_blank">digest.d.ts:9</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="digest_log"></a></p>
|
|
<h3 id="digestlog">Digest$Log</h3>
|
|
<p><strong>Ƭ Digest$Log</strong>: <em><a href="#bytes">Bytes</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/digest.d.ts#L7" target="_blank">digest.d.ts:7</a></em></p>
|
|
<hr>
|
|
<p><a id="extrinsicfunction"></a></p>
|
|
<h3 id="extrinsicfunction">ExtrinsicFunction</h3>
|
|
<p><strong>Ƭ ExtrinsicFunction</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/extrinsic.d.ts#L8" target="_blank">extrinsic.d.ts:8</a></em></p>
|
|
<hr>
|
|
<p><a id="h160"></a></p>
|
|
<h3 id="h160">H160</h3>
|
|
<p><strong>Ƭ H160</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L9" target="_blank">base.d.ts:9</a></em></p>
|
|
<hr>
|
|
<p><a id="h256"></a></p>
|
|
<h3 id="h256">H256</h3>
|
|
<p><strong>Ƭ H256</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L10" target="_blank">base.d.ts:10</a></em></p>
|
|
<hr>
|
|
<p><a id="h512"></a></p>
|
|
<h3 id="h512">H512</h3>
|
|
<p><strong>Ƭ H512</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L11" target="_blank">base.d.ts:11</a></em></p>
|
|
<hr>
|
|
<p><a id="hash"></a></p>
|
|
<h3 id="hash">Hash</h3>
|
|
<p><strong>Ƭ Hash</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L8" target="_blank">base.d.ts:8</a></em></p>
|
|
<hr>
|
|
<p><a id="header"></a></p>
|
|
<h3 id="header">Header</h3>
|
|
<p><strong>Ƭ Header</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/header.d.ts#L8" target="_blank">header.d.ts:8</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="headerhash"></a></p>
|
|
<h3 id="headerhash">HeaderHash</h3>
|
|
<p><strong>Ƭ HeaderHash</strong>: <em><a href="#h256">H256</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L21" target="_blank">base.d.ts:21</a></em></p>
|
|
<hr>
|
|
<p><a id="headerincomplete"></a></p>
|
|
<h3 id="headerincomplete">HeaderIncomplete</h3>
|
|
<p><strong>Ƭ HeaderIncomplete</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/create/types.d.ts#L9" target="_blank">create/types.d.ts:9</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="index"></a></p>
|
|
<h3 id="index">Index</h3>
|
|
<p><strong>Ƭ Index</strong>: <em><a href="#u32">U32</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L22" target="_blank">base.d.ts:22</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonaccountid"></a></p>
|
|
<h3 id="jsonaccountid">JsonAccountId</h3>
|
|
<p><strong>Ƭ JsonAccountId</strong>: <em><a href="#jsonhash">JsonHash</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L18" target="_blank">json/types.d.ts:18</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonauthorityid"></a></p>
|
|
<h3 id="jsonauthorityid">JsonAuthorityId</h3>
|
|
<p><strong>Ƭ JsonAuthorityId</strong>: <em><a href="#jsonhash">JsonHash</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L19" target="_blank">json/types.d.ts:19</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonblock"></a></p>
|
|
<h3 id="jsonblock">JsonBlock</h3>
|
|
<p><strong>Ƭ JsonBlock</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L57" target="_blank">json/types.d.ts:57</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="jsonblocknumber"></a></p>
|
|
<h3 id="jsonblocknumber">JsonBlockNumber</h3>
|
|
<p><strong>Ƭ JsonBlockNumber</strong>: <em><a href="#jsonu64">JsonU64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L20" target="_blank">json/types.d.ts:20</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonbntype"></a></p>
|
|
<h3 id="jsonbntype">JsonBnType</h3>
|
|
<p><strong>Ƭ JsonBnType</strong>: <em><code>string</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L7" target="_blank">json/types.d.ts:7</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonbytes"></a></p>
|
|
<h3 id="jsonbytes">JsonBytes</h3>
|
|
<p><strong>Ƭ JsonBytes</strong>: <em> <code>string</code> | <code>Array</code><<code>number</code>>
|
|
</em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L10" target="_blank">json/types.d.ts:10</a></em></p>
|
|
<hr>
|
|
<p><a id="jsondigest"></a></p>
|
|
<h3 id="jsondigest">JsonDigest</h3>
|
|
<p><strong>Ƭ JsonDigest</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L37" target="_blank">json/types.d.ts:37</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="jsonh160"></a></p>
|
|
<h3 id="jsonh160">JsonH160</h3>
|
|
<p><strong>Ƭ JsonH160</strong>: <em><a href="#jsonhash">JsonHash</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L11" target="_blank">json/types.d.ts:11</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonh256"></a></p>
|
|
<h3 id="jsonh256">JsonH256</h3>
|
|
<p><strong>Ƭ JsonH256</strong>: <em><a href="#jsonhash">JsonHash</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L12" target="_blank">json/types.d.ts:12</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonh512"></a></p>
|
|
<h3 id="jsonh512">JsonH512</h3>
|
|
<p><strong>Ƭ JsonH512</strong>: <em><a href="#jsonhash">JsonHash</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L13" target="_blank">json/types.d.ts:13</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonhash"></a></p>
|
|
<h3 id="jsonhash">JsonHash</h3>
|
|
<p><strong>Ƭ JsonHash</strong>: <em><code>string</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L8" target="_blank">json/types.d.ts:8</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonheader"></a></p>
|
|
<h3 id="jsonheader">JsonHeader</h3>
|
|
<p><strong>Ƭ JsonHeader</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L41" target="_blank">json/types.d.ts:41</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="jsonheaderhash"></a></p>
|
|
<h3 id="jsonheaderhash">JsonHeaderHash</h3>
|
|
<p><strong>Ƭ JsonHeaderHash</strong>: <em><a href="#jsonh256">JsonH256</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L14" target="_blank">json/types.d.ts:14</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonjustification"></a></p>
|
|
<h3 id="jsonjustification">JsonJustification</h3>
|
|
<p><strong>Ƭ JsonJustification</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L51" target="_blank">json/types.d.ts:51</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="jsonjustification_signature"></a></p>
|
|
<h3 id="jsonjustificationsignature">JsonJustification$Signature</h3>
|
|
<p><strong>Ƭ JsonJustification$Signature</strong>: <em>[<code>string</code>, <code>string</code>]</em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L49" target="_blank">json/types.d.ts:49</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonobjectid"></a></p>
|
|
<h3 id="jsonobjectid">JsonObjectId</h3>
|
|
<p><strong>Ƭ JsonObjectId</strong>: <em><a href="#jsonu64">JsonU64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L21" target="_blank">json/types.d.ts:21</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonparachainid"></a></p>
|
|
<h3 id="jsonparachainid">JsonParaChainId</h3>
|
|
<p><strong>Ƭ JsonParaChainId</strong>: <em><a href="#jsonu64">JsonU64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L22" target="_blank">json/types.d.ts:22</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonsignature"></a></p>
|
|
<h3 id="jsonsignature">JsonSignature</h3>
|
|
<p><strong>Ƭ JsonSignature</strong>: <em><a href="#jsonhash">JsonHash</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L23" target="_blank">json/types.d.ts:23</a></em></p>
|
|
<hr>
|
|
<p><a id="jsontransaction"></a></p>
|
|
<h3 id="jsontransaction">JsonTransaction</h3>
|
|
<p><strong>Ƭ JsonTransaction</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L25" target="_blank">json/types.d.ts:25</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="jsonu256"></a></p>
|
|
<h3 id="jsonu256">JsonU256</h3>
|
|
<p><strong>Ƭ JsonU256</strong>: <em><a href="#jsonbntype">JsonBnType</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L16" target="_blank">json/types.d.ts:16</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonu64"></a></p>
|
|
<h3 id="jsonu64">JsonU64</h3>
|
|
<p><strong>Ƭ JsonU64</strong>: <em><a href="#jsonbntype">JsonBnType</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L15" target="_blank">json/types.d.ts:15</a></em></p>
|
|
<hr>
|
|
<p><a id="jsonunchecked"></a></p>
|
|
<h3 id="jsonunchecked">JsonUnchecked</h3>
|
|
<p><strong>Ƭ JsonUnchecked</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/types.d.ts#L32" target="_blank">json/types.d.ts:32</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="justification"></a></p>
|
|
<h3 id="justification">Justification</h3>
|
|
<p><strong>Ƭ Justification</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/bft.d.ts#L9" target="_blank">bft.d.ts:9</a></em>
|
|
<em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/justification.d.ts#L14" target="_blank">justification.d.ts:14</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="justification_signature"></a></p>
|
|
<h3 id="justificationsignature">Justification$Signature</h3>
|
|
<p><strong>Ƭ Justification$Signature</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/bft.d.ts#L7" target="_blank">bft.d.ts:7</a></em>
|
|
<em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/justification.d.ts#L9" target="_blank">justification.d.ts:9</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="misbehaviorreport"></a></p>
|
|
<h3 id="misbehaviorreport">MisbehaviorReport</h3>
|
|
<p><strong>Ƭ MisbehaviorReport</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/misbehavior.d.ts#L7" target="_blank">misbehavior.d.ts:7</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="objectid"></a></p>
|
|
<h3 id="objectid">ObjectId</h3>
|
|
<p><strong>Ƭ ObjectId</strong>: <em><a href="#u64">U64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L23" target="_blank">base.d.ts:23</a></em></p>
|
|
<hr>
|
|
<p><a id="parachainid"></a></p>
|
|
<h3 id="parachainid">ParaChainId</h3>
|
|
<p><strong>Ƭ ParaChainId</strong>: <em><a href="#u64">U64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L24" target="_blank">base.d.ts:24</a></em></p>
|
|
<hr>
|
|
<p><a id="proportion"></a></p>
|
|
<h3 id="proportion">Proportion</h3>
|
|
<p><strong>Ƭ Proportion</strong>: <em><a href="#u64">U64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L25" target="_blank">base.d.ts:25</a></em></p>
|
|
<hr>
|
|
<p><a id="role"></a></p>
|
|
<h3 id="role">Role</h3>
|
|
<p><strong>Ƭ Role</strong>: <em><code>keyof RoleMap</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/role/index.d.ts#L12" target="_blank">role/index.d.ts:12</a></em></p>
|
|
<hr>
|
|
<p><a id="rolemap"></a></p>
|
|
<h3 id="rolemap">RoleMap</h3>
|
|
<p><strong>Ƭ RoleMap</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/role/index.d.ts#L5" target="_blank">role/index.d.ts:5</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="signature"></a></p>
|
|
<h3 id="signature">Signature</h3>
|
|
<p><strong>Ƭ Signature</strong>: <em><a href="#h512">H512</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L26" target="_blank">base.d.ts:26</a></em></p>
|
|
<hr>
|
|
<p><a id="sizetype"></a></p>
|
|
<h3 id="sizetype">SizeType</h3>
|
|
<p><strong>Ƭ SizeType</strong>: <em> <code>32</code> | <code>64</code> | <code>128</code>
|
|
</em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/sizes.ts#L5" target="_blank">sizes.ts:5</a></em></p>
|
|
<hr>
|
|
<p><a id="timestamp"></a></p>
|
|
<h3 id="timestamp">Timestamp</h3>
|
|
<p><strong>Ƭ Timestamp</strong>: <em><a href="#u64">U64</a></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L27" target="_blank">base.d.ts:27</a></em></p>
|
|
<hr>
|
|
<p><a id="u128"></a></p>
|
|
<h3 id="u128">U128</h3>
|
|
<p><strong>Ƭ U128</strong>: <em><code>BN</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L14" target="_blank">base.d.ts:14</a></em></p>
|
|
<hr>
|
|
<p><a id="u256"></a></p>
|
|
<h3 id="u256">U256</h3>
|
|
<p><strong>Ƭ U256</strong>: <em><code>BN</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L15" target="_blank">base.d.ts:15</a></em></p>
|
|
<hr>
|
|
<p><a id="u32"></a></p>
|
|
<h3 id="u32">U32</h3>
|
|
<p><strong>Ƭ U32</strong>: <em><code>BN</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L12" target="_blank">base.d.ts:12</a></em></p>
|
|
<hr>
|
|
<p><a id="u64"></a></p>
|
|
<h3 id="u64">U64</h3>
|
|
<p><strong>Ƭ U64</strong>: <em><code>BN</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/base.d.ts#L13" target="_blank">base.d.ts:13</a></em></p>
|
|
<hr>
|
|
<p><a id="unchecked"></a></p>
|
|
<h3 id="unchecked">Unchecked</h3>
|
|
<p><strong>Ƭ Unchecked</strong>: <em><code>object</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/extrinsic.d.ts#L10" target="_blank">extrinsic.d.ts:10</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<hr>
|
|
<p><a id="uncheckedraw"></a></p>
|
|
<h3 id="uncheckedraw">UncheckedRaw</h3>
|
|
<p><strong>Ƭ UncheckedRaw</strong>: <em><code>Uint8Array</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/extrinsic.d.ts#L17" target="_blank">extrinsic.d.ts:17</a></em></p>
|
|
<hr>
|
|
<h2 id="functions">Functions</h2>
|
|
<p><a id="accountiddecode"></a></p>
|
|
<h3 id="accountiddecode">accountIdDecode</h3>
|
|
<p>▸ <strong>accountIdDecode</strong>(value: <em><a href="#jsonaccountid">JsonAccountId</a></em>): <a href="#accountid">AccountId</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/accountId/decode.ts#L10" target="_blank">json/accountId/decode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonaccountid">JsonAccountId</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#accountid">AccountId</a></p>
|
|
<hr>
|
|
<p><a id="accountidencode"></a></p>
|
|
<h3 id="accountidencode">accountIdEncode</h3>
|
|
<p>▸ <strong>accountIdEncode</strong>(value: <em><a href="#accountid">AccountId</a></em>): <a href="#jsonaccountid">JsonAccountId</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/accountId/encode.ts#L10" target="_blank">json/accountId/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#accountid">AccountId</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonaccountid">JsonAccountId</a></p>
|
|
<hr>
|
|
<p><a id="block"></a></p>
|
|
<h3 id="block">block</h3>
|
|
<p>▸ <strong>block</strong>(__namedParameters: <em><code>object</code></em>): <a href="#block">Block</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/create/block.ts#L10" target="_blank">create/block.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#block">Block</a></p>
|
|
<hr>
|
|
<p><a id="blockdecode"></a></p>
|
|
<h3 id="blockdecode">blockDecode</h3>
|
|
<p>▸ <strong>blockDecode</strong>(__namedParameters: <em><code>object</code></em>): <code>BlockDecoded</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/block/decode.ts#L14" target="_blank">json/block/decode.ts:14</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>BlockDecoded</code></p>
|
|
<hr>
|
|
<p><a id="bndecode"></a></p>
|
|
<h3 id="bndecode">bnDecode</h3>
|
|
<p>▸ <strong>bnDecode</strong>(value: <em><a href="#jsonbntype">JsonBnType</a></em>, bitLength?: <em><code>number</code></em>): <code>BN</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/bn/decode.ts#L12" target="_blank">json/bn/decode.ts:12</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonbntype">JsonBnType</a></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Default value</code> bitLength</td>
|
|
<td><code>number</code></td>
|
|
<td>-1</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>BN</code></p>
|
|
<hr>
|
|
<p><a id="bnencode"></a></p>
|
|
<h3 id="bnencode">bnEncode</h3>
|
|
<p>▸ <strong>bnEncode</strong>(value: <em> <code>BN</code> | <code>number</code></em>, bitLength?: <em><code>number</code></em>): <a href="#jsonbntype">JsonBnType</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/bn/encode.ts#L11" target="_blank">json/bn/encode.ts:11</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><code>BN</code> | <code>number</code></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Default value</code> bitLength</td>
|
|
<td><code>number</code></td>
|
|
<td>-1</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonbntype">JsonBnType</a></p>
|
|
<hr>
|
|
<p><a id="bytesdecode"></a></p>
|
|
<h3 id="bytesdecode">bytesDecode</h3>
|
|
<p>▸ <strong>bytesDecode</strong>(value: <em><a href="#jsonbytes">JsonBytes</a></em>): <a href="#bytes">Bytes</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/bytes/decode.ts#L10" target="_blank">json/bytes/decode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonbytes">JsonBytes</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#bytes">Bytes</a></p>
|
|
<hr>
|
|
<p><a id="bytesencode"></a></p>
|
|
<h3 id="bytesencode">bytesEncode</h3>
|
|
<p>▸ <strong>bytesEncode</strong>(value: <em><a href="#bytes">Bytes</a></em>): <a href="#jsonbytes">JsonBytes</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/bytes/encode.ts#L10" target="_blank">json/bytes/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#bytes">Bytes</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonbytes">JsonBytes</a></p>
|
|
<hr>
|
|
<p><a id="decodearray"></a></p>
|
|
<h3 id="decodearray">decodeArray</h3>
|
|
<p>▸ <strong>decodeArray</strong>(input: <em><code>Uint8Array</code></em>): <code>DecodedArray</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/decoder/array.ts#L12" target="_blank">codec/decoder/array.ts:12</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>input</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>DecodedArray</code></p>
|
|
<hr>
|
|
<p><a id="decodeblock"></a></p>
|
|
<h3 id="decodeblock">decodeBlock</h3>
|
|
<p>▸ <strong>decodeBlock</strong>(u8a: <em><code>Uint8Array</code></em>): <a href="#block">Block</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/block/decode.ts#L11" target="_blank">codec/block/decode.ts:11</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>u8a</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#block">Block</a></p>
|
|
<hr>
|
|
<p><a id="decodeheader"></a></p>
|
|
<h3 id="decodeheader">decodeHeader</h3>
|
|
<p>▸ <strong>decodeHeader</strong>(u8a: <em><code>Uint8Array</code></em>): <code>DecodedRaw</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/header/decodeRaw.ts#L20" target="_blank">codec/header/decodeRaw.ts:20</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>u8a</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>DecodedRaw</code></p>
|
|
<hr>
|
|
<p><a id="decodejustification"></a></p>
|
|
<h3 id="decodejustification">decodeJustification</h3>
|
|
<p>▸ <strong>decodeJustification</strong>(u8a: <em><code>Uint8Array</code></em>): <a href="#justification">Justification</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/justification/decode.ts#L9" target="_blank">codec/justification/decode.ts:9</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>u8a</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#justification">Justification</a></p>
|
|
<hr>
|
|
<p><a id="decoderaw"></a></p>
|
|
<h3 id="decoderaw">decodeRaw</h3>
|
|
<p>▸ <strong>decodeRaw</strong>(u8a: <em><code>Uint8Array</code></em>): <code>RawData</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/block/decodeRaw.ts#L19" target="_blank">codec/block/decodeRaw.ts:19</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>u8a</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>RawData</code></p>
|
|
<hr>
|
|
<p><a id="decodeu8a"></a></p>
|
|
<h3 id="decodeu8a">decodeU8a</h3>
|
|
<p>▸ <strong>decodeU8a</strong>(input: <em><code>Uint8Array</code></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/decoder/u8a.ts#L7" target="_blank">codec/decoder/u8a.ts:7</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>input</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="encodearray"></a></p>
|
|
<h3 id="encodearray">encodeArray</h3>
|
|
<p>▸ <strong>encodeArray</strong>(input: <em><code>Array</code><<code>Uint8Array</code>></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/encoder/array.ts#L5" target="_blank">codec/encoder/array.ts:5</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>input</td>
|
|
<td><code>Array</code><<code>Uint8Array</code>></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="encodeblock"></a></p>
|
|
<h3 id="encodeblock">encodeBlock</h3>
|
|
<p>▸ <strong>encodeBlock</strong>(__namedParameters: <em><code>object</code></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/block/encode.ts#L10" target="_blank">codec/block/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="encodeblockraw"></a></p>
|
|
<h3 id="encodeblockraw">encodeBlockRaw</h3>
|
|
<p>▸ <strong>encodeBlockRaw</strong>(header: <em><code>Uint8Array</code></em>, extrinsics?: <em><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/block/encodeRaw.ts#L12" target="_blank">codec/block/encodeRaw.ts:12</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>header</td>
|
|
<td><code>Uint8Array</code></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Default value</code> extrinsics</td>
|
|
<td><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></td>
|
|
<td>[]</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="encodeheader"></a></p>
|
|
<h3 id="encodeheader">encodeHeader</h3>
|
|
<p>▸ <strong>encodeHeader</strong>(__namedParameters: <em><code>object</code></em>, extrinsics?: <em><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/header/encode.ts#L17" target="_blank">codec/header/encode.ts:17</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Optional</code> extrinsics</td>
|
|
<td><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="encodeu8a"></a></p>
|
|
<h3 id="encodeu8a">encodeU8a</h3>
|
|
<p>▸ <strong>encodeU8a</strong>(input: <em><code>Uint8Array</code></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/encoder/u8a.ts#L5" target="_blank">codec/encoder/u8a.ts:5</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>input</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="extrinsicdecode"></a></p>
|
|
<h3 id="extrinsicdecode">extrinsicDecode</h3>
|
|
<p>▸ <strong>extrinsicDecode</strong>(extrinsic: <em><code>Uint8Array</code></em>): <code>BlockExtrinsicDecoded</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/extrinsic/decode.ts#L14" target="_blank">json/extrinsic/decode.ts:14</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>extrinsic</td>
|
|
<td><code>Uint8Array</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>BlockExtrinsicDecoded</code></p>
|
|
<hr>
|
|
<p><a id="extrinsicsrootraw"></a></p>
|
|
<h3 id="extrinsicsrootraw">extrinsicsRootRaw</h3>
|
|
<p>▸ <strong>extrinsicsRootRaw</strong>(extrinsics?: <em><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/create/extrinsic/rootRaw.ts#L10" target="_blank">create/extrinsic/rootRaw.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>Default value</code> extrinsics</td>
|
|
<td><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></td>
|
|
<td>[]</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="hashdecode"></a></p>
|
|
<h3 id="hashdecode">hashDecode</h3>
|
|
<p>▸ <strong>hashDecode</strong>(value: <em><a href="#jsonhash">JsonHash</a></em>, bitLength?: <em><code>number</code></em>): <a href="#hash">Hash</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/hash/decode.ts#L10" target="_blank">json/hash/decode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonhash">JsonHash</a></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Default value</code> bitLength</td>
|
|
<td><code>number</code></td>
|
|
<td>-1</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#hash">Hash</a></p>
|
|
<hr>
|
|
<p><a id="hashencode"></a></p>
|
|
<h3 id="hashencode">hashEncode</h3>
|
|
<p>▸ <strong>hashEncode</strong>(value: <em> <a href="#hash">Hash</a> | <code>string</code></em>, bitLength?: <em><code>number</code></em>): <a href="#jsonhash">JsonHash</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/hash/encode.ts#L11" target="_blank">json/hash/encode.ts:11</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#hash">Hash</a> | <code>string</code></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Default value</code> bitLength</td>
|
|
<td><code>number</code></td>
|
|
<td>-1</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonhash">JsonHash</a></p>
|
|
<hr>
|
|
<p><a id="header"></a></p>
|
|
<h3 id="header">header</h3>
|
|
<p>▸ <strong>header</strong>(__namedParameters: <em><code>object</code></em>, extrinsics?: <em><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></em>): <a href="#header">Header</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/create/header.ts#L14" target="_blank">create/header.ts:14</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Optional</code> extrinsics</td>
|
|
<td><code>Array</code><<a href="#uncheckedraw">UncheckedRaw</a>></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#header">Header</a></p>
|
|
<hr>
|
|
<p><a id="headerdecode"></a></p>
|
|
<h3 id="headerdecode">headerDecode</h3>
|
|
<p>▸ <strong>headerDecode</strong>(__namedParameters: <em><code>object</code></em>): <a href="#header">Header</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/header/decode.ts#L15" target="_blank">json/header/decode.ts:15</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#header">Header</a></p>
|
|
<hr>
|
|
<p><a id="headerencode"></a></p>
|
|
<h3 id="headerencode">headerEncode</h3>
|
|
<p>▸ <strong>headerEncode</strong>(__namedParameters: <em><code>object</code></em>): <a href="#jsonheader">JsonHeader</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/header/encode.ts#L13" target="_blank">json/header/encode.ts:13</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonheader">JsonHeader</a></p>
|
|
<hr>
|
|
<p><a id="headerhash"></a></p>
|
|
<h3 id="headerhash">headerHash</h3>
|
|
<p>▸ <strong>headerHash</strong>(header: <em><a href="#header">Header</a></em>): <code>Uint8Array</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/codec/header/hash.ts#L11" target="_blank">codec/header/hash.ts:11</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>header</td>
|
|
<td><a href="#header">Header</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Uint8Array</code></p>
|
|
<hr>
|
|
<p><a id="justificationdecode"></a></p>
|
|
<h3 id="justificationdecode">justificationDecode</h3>
|
|
<p>▸ <strong>justificationDecode</strong>(__namedParameters: <em><code>object</code></em>): <code>BlockJustificationDecoded</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/justification/decode.ts#L12" target="_blank">json/justification/decode.ts:12</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>BlockJustificationDecoded</code></p>
|
|
<hr>
|
|
<p><a id="justificationencode"></a></p>
|
|
<h3 id="justificationencode">justificationEncode</h3>
|
|
<p>▸ <strong>justificationEncode</strong>(__namedParameters: <em><code>object</code></em>): <a href="#jsonjustification">JsonJustification</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/justification/encode.ts#L10" target="_blank">json/justification/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>__namedParameters</td>
|
|
<td><code>object</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonjustification">JsonJustification</a></p>
|
|
<hr>
|
|
<p><a id="objectiddecode"></a></p>
|
|
<h3 id="objectiddecode">objectIdDecode</h3>
|
|
<p>▸ <strong>objectIdDecode</strong>(value: <em><a href="#jsonobjectid">JsonObjectId</a></em>): <a href="#objectid">ObjectId</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/objectId/decode.ts#L10" target="_blank">json/objectId/decode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonobjectid">JsonObjectId</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#objectid">ObjectId</a></p>
|
|
<hr>
|
|
<p><a id="objectidencode"></a></p>
|
|
<h3 id="objectidencode">objectIdEncode</h3>
|
|
<p>▸ <strong>objectIdEncode</strong>(value: <em><a href="#objectid">ObjectId</a></em>): <a href="#jsonobjectid">JsonObjectId</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/objectId/encode.ts#L10" target="_blank">json/objectId/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#objectid">ObjectId</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonobjectid">JsonObjectId</a></p>
|
|
<hr>
|
|
<p><a id="parachainiddecode"></a></p>
|
|
<h3 id="parachainiddecode">parachainIdDecode</h3>
|
|
<p>▸ <strong>parachainIdDecode</strong>(value: <em><a href="#jsonparachainid">JsonParaChainId</a></em>): <a href="#parachainid">ParaChainId</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/parachainId/decode.ts#L10" target="_blank">json/parachainId/decode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonparachainid">JsonParaChainId</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#parachainid">ParaChainId</a></p>
|
|
<hr>
|
|
<p><a id="parachainidencode"></a></p>
|
|
<h3 id="parachainidencode">parachainIdEncode</h3>
|
|
<p>▸ <strong>parachainIdEncode</strong>(value: <em><a href="#parachainid">ParaChainId</a></em>): <a href="#jsonparachainid">JsonParaChainId</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/parachainId/encode.ts#L10" target="_blank">json/parachainId/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#parachainid">ParaChainId</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonparachainid">JsonParaChainId</a></p>
|
|
<hr>
|
|
<p><a id="rolesfromid"></a></p>
|
|
<h3 id="rolesfromid">rolesFromId</h3>
|
|
<p>▸ <strong>rolesFromId</strong>(roleId: <em><code>number</code></em>): <code>Array</code><<a href="#role">Role</a>></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/role/fromId.ts#L9" target="_blank">role/fromId.ts:9</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>roleId</td>
|
|
<td><code>number</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Array</code><<a href="#role">Role</a>></p>
|
|
<hr>
|
|
<p><a id="rolestoid"></a></p>
|
|
<h3 id="rolestoid">rolesToId</h3>
|
|
<p>▸ <strong>rolesToId</strong>(roles: <em><code>Array</code><<a href="#role">Role</a>></em>): <code>number</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/role/toId.ts#L9" target="_blank">role/toId.ts:9</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>roles</td>
|
|
<td><code>Array</code><<a href="#role">Role</a>></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>number</code></p>
|
|
<hr>
|
|
<p><a id="signaturedecode"></a></p>
|
|
<h3 id="signaturedecode">signatureDecode</h3>
|
|
<p>▸ <strong>signatureDecode</strong>(value: <em><a href="#jsonsignature">JsonSignature</a></em>): <a href="#signature">Signature</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/signature/decode.ts#L10" target="_blank">json/signature/decode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#jsonsignature">JsonSignature</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#signature">Signature</a></p>
|
|
<hr>
|
|
<p><a id="signatureencode"></a></p>
|
|
<h3 id="signatureencode">signatureEncode</h3>
|
|
<p>▸ <strong>signatureEncode</strong>(value: <em><a href="#signature">Signature</a></em>): <a href="#jsonsignature">JsonSignature</a></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/type-primitives/src/json/signature/encode.ts#L10" target="_blank">json/signature/encode.ts:10</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><a href="#signature">Signature</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <a href="#jsonsignature">JsonSignature</a></p>
|
|
<hr>
|
|
|
|
|
|
</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="../type-params/" class="navigation navigation-prev " aria-label="Previous page: type-params">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="../type-storage/" class="navigation navigation-next " aria-label="Next page: type-storage">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"type-primitives","level":"2.8","depth":1,"next":{"title":"type-storage","level":"2.9","depth":1,"path":"type-storage/README.md","ref":"type-storage/README.md","articles":[]},"previous":{"title":"type-params","level":"2.7","depth":1,"path":"type-params/README.md","ref":"type-params/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["asciidoc-include"],"root":"docs","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"},"pluginsConfig":{"asciidoc-include":{"syntax":"asciidoc"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"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}},"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":"type-primitives/README.md","mtime":"2018-09-17T12:37:09.286Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-17T12:37:27.221Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.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>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|