quantus/common
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

[CI Skip] 0.34.6

Browse Source
This commit is contained in:
Travis CI
2019-02-14 21:11:42 +00:00
parent c3fafbeab7
commit 4f155f2a8d
200 changed files with 754 additions and 561 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/GLOSSARY.html
+1 -1
View File
@@ -359,7 +359,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"dir":"neutral"},"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":"GLOSSARY.md","mtime":"2019-02-14T14:15:14.593Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"dir":"neutral"},"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":"GLOSSARY.md","mtime":"2019-02-14T21:07:28.811Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/chainspec/modules/_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ Chainspec**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/chainspec/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/chainspec/src/types.ts#L5)*
#### Type declaration
docs/db/classes/_disk_.diskdb.md
+12 -12
View File
@@ -74,7 +74,7 @@ diskDb.close();
*Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/Disk.ts#L66)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/Disk.ts#L66)*
**Parameters:**
@@ -100,7 +100,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -115,7 +115,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -136,7 +136,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -151,7 +151,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -166,7 +166,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -208,7 +208,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -223,7 +223,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -245,7 +245,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -267,7 +267,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -280,7 +280,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/classes/_engines_filetreedb_.filetreedb.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new FileTreeDb**(location: *`string`*): [FileTreeDb](_engines_filetreedb_.filetreedb.md)
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L21)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
**● _location**: *`string`*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L21)*
___
@@ -50,7 +50,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)*
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L46)*
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L46)*
**Returns:** `void`
@@ -63,7 +63,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)*
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L76)*
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L76)*
**Parameters:**
@@ -82,7 +82,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)*
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L50)*
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L50)*
**Returns:** `void`
@@ -95,7 +95,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)*
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L54)*
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L54)*
**Returns:** `void`
@@ -108,7 +108,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)*
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L86)*
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L86)*
**Parameters:**
@@ -127,7 +127,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)*
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L68)*
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L68)*
**Parameters:**
@@ -146,7 +146,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)*
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L42)*
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L42)*
**Returns:** `void`
@@ -159,7 +159,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)*
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L100)*
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L100)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)*
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L58)*
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L58)*
**Parameters:**
@@ -199,7 +199,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)*
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/FileTreeDb.ts#L62)*
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/FileTreeDb.ts#L62)*
**Returns:** `number`
docs/db/classes/_engines_lrudb_.lrudb.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new LruDb**(backing: *[BaseDb](../interfaces/_types_.basedb.md)*, itemCount?: *`number`*): [LruDb](_engines_lrudb_.lrudb.md)
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L20)*
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L20)*
**Parameters:**
@@ -37,7 +37,7 @@ ___
▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` | `undefined`
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L87)*
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L87)*
**Parameters:**
@@ -56,7 +56,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)*
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L27)*
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L27)*
**Returns:** `void`
@@ -69,7 +69,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)*
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L64)*
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L64)*
**Parameters:**
@@ -88,7 +88,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)*
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L41)*
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L41)*
**Returns:** `void`
@@ -101,7 +101,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)*
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L45)*
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L45)*
**Returns:** `void`
@@ -114,7 +114,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)*
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L71)*
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L71)*
**Parameters:**
@@ -133,7 +133,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)*
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L56)*
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L56)*
**Parameters:**
@@ -152,7 +152,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)*
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L34)*
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L34)*
**Returns:** `void`
@@ -165,7 +165,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)*
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L91)*
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L91)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)*
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L52)*
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L52)*
**Parameters:**
@@ -205,7 +205,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)*
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/LruDb.ts#L60)*
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/LruDb.ts#L60)*
**Returns:** `number`
docs/db/classes/_engines_memorydb_.memorydb.md
+11 -11
View File
@@ -16,7 +16,7 @@
⊕ **new MemoryDb**(options?: *[BaseDbOptions](../modules/_types_.md#basedboptions)*): [MemoryDb](_engines_memorydb_.memorydb.md)
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L16)*
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L16)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)*
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L22)*
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L22)*
**Returns:** `void`
@@ -51,7 +51,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)*
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L56)*
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L56)*
**Parameters:**
@@ -70,7 +70,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)*
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L30)*
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L30)*
**Returns:** `void`
@@ -83,7 +83,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)*
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L34)*
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L34)*
**Returns:** `void`
@@ -96,7 +96,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)*
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L62)*
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L62)*
**Parameters:**
@@ -115,7 +115,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)*
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L42)*
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L42)*
**Parameters:**
@@ -134,7 +134,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)*
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L26)*
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L26)*
**Returns:** `void`
@@ -147,7 +147,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)*
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L68)*
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L68)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)*
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L38)*
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L38)*
**Parameters:**
@@ -187,7 +187,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)*
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/MemoryDb.ts#L50)*
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/MemoryDb.ts#L50)*
**Returns:** `number`
docs/db/classes/_engines_transactiondb_.transactiondb.md
+12 -12
View File
@@ -20,7 +20,7 @@
⊕ **new TransactionDb**(backing: *[BaseDb](../interfaces/_types_.basedb.md)*): [TransactionDb](_engines_transactiondb_.transactiondb.md)
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L21)*
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L21)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[close](../interfaces/_types_.txdb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -55,7 +55,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[del](../interfaces/_types_.txdb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -74,7 +74,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[drop](../interfaces/_types_.txdb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -87,7 +87,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[empty](../interfaces/_types_.txdb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -100,7 +100,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[get](../interfaces/_types_.txdb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -119,7 +119,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[maintain](../interfaces/_types_.txdb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[open](../interfaces/_types_.txdb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -151,7 +151,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[put](../interfaces/_types_.txdb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[rename](../interfaces/_types_.txdb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -191,7 +191,7 @@ ___
*Implementation of [TxDb](../interfaces/_types_.txdb.md).[size](../interfaces/_types_.txdb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -202,7 +202,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/classes/_fileflatdb_cache_.cache.md
+1 -1
View File
@@ -18,7 +18,7 @@
*Overrides [File](_fileflatdb_file_.file.md).[constructor](_fileflatdb_file_.file.md#constructor)*
*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/Cache.ts#L15)*
*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/Cache.ts#L15)*
**Parameters:**
docs/db/classes/_fileflatdb_compact_.compact.md
+2 -2
View File
@@ -12,7 +12,7 @@
⊕ **new Compact**(file: *`string`*): [Compact](_fileflatdb_compact_.compact.md)
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/Compact.ts#L17)*
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/Compact.ts#L17)*
**Parameters:**
@@ -32,7 +32,7 @@ ___
▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void`
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/Compact.ts#L24)*
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/Compact.ts#L24)*
**Parameters:**
docs/db/classes/_fileflatdb_file_.file.md
+1 -1
View File
@@ -16,7 +16,7 @@
⊕ **new File**(base: *`string`*, file: *`string`*, options: *[BaseDbOptions](../modules/_types_.md#basedboptions)*): [File](_fileflatdb_file_.file.md)
*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/File.ts#L19)*
*Defined in [FileFlatDb/File.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/File.ts#L19)*
**Parameters:**
docs/db/classes/_fileflatdb_impl_.impl.md
+1 -1
View File
@@ -20,7 +20,7 @@
*Overrides [File](_fileflatdb_file_.file.md).[constructor](_fileflatdb_file_.file.md#constructor)*
*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/Cache.ts#L15)*
*Defined in [FileFlatDb/Cache.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/Cache.ts#L15)*
**Parameters:**
docs/db/classes/_fileflatdb_index_.fileflatdb.md
+11 -11
View File
@@ -20,7 +20,7 @@
*Overrides [Cache](_fileflatdb_cache_.cache.md).[constructor](_fileflatdb_cache_.cache.md#constructor)*
*Defined in [FileFlatDb/index.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L18)*
*Defined in [FileFlatDb/index.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L18)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[close](../interfaces/_types_.basedb.md#close)*
*Defined in [FileFlatDb/index.ts:31](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L31)*
*Defined in [FileFlatDb/index.ts:31](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L31)*
**Returns:** `void`
@@ -57,7 +57,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[del](../interfaces/_types_.basedb.md#del)*
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L74)*
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L74)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[drop](../interfaces/_types_.basedb.md#drop)*
*Defined in [FileFlatDb/index.ts:39](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L39)*
*Defined in [FileFlatDb/index.ts:39](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L39)*
**Returns:** `void`
@@ -89,7 +89,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[empty](../interfaces/_types_.basedb.md#empty)*
*Defined in [FileFlatDb/index.ts:45](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L45)*
*Defined in [FileFlatDb/index.ts:45](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L45)*
**Returns:** `void`
@@ -102,7 +102,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[get](../interfaces/_types_.basedb.md#get)*
*Defined in [FileFlatDb/index.ts:78](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L78)*
*Defined in [FileFlatDb/index.ts:78](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L78)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[maintain](../interfaces/_types_.basedb.md#maintain)*
*Defined in [FileFlatDb/index.ts:66](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L66)*
*Defined in [FileFlatDb/index.ts:66](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L66)*
**Parameters:**
@@ -140,7 +140,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[open](../interfaces/_types_.basedb.md#open)*
*Defined in [FileFlatDb/index.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L23)*
*Defined in [FileFlatDb/index.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L23)*
**Returns:** `void`
@@ -153,7 +153,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[put](../interfaces/_types_.basedb.md#put)*
*Defined in [FileFlatDb/index.ts:96](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L96)*
*Defined in [FileFlatDb/index.ts:96](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L96)*
**Parameters:**
@@ -173,7 +173,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[rename](../interfaces/_types_.basedb.md#rename)*
*Defined in [FileFlatDb/index.ts:55](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L55)*
*Defined in [FileFlatDb/index.ts:55](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L55)*
**Parameters:**
@@ -193,7 +193,7 @@ ___
*Implementation of [BaseDb](../interfaces/_types_.basedb.md).[size](../interfaces/_types_.basedb.md#size)*
*Defined in [FileFlatDb/index.ts:51](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/index.ts#L51)*
*Defined in [FileFlatDb/index.ts:51](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/index.ts#L51)*
**Returns:** `number`
docs/db/classes/_memory_.memory.md
+12 -12
View File
@@ -72,7 +72,7 @@ memoryDb.close();
*Overrides [TransactionDb](_engines_transactiondb_.transactiondb.md).[constructor](_engines_transactiondb_.transactiondb.md#constructor)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/Memory.ts#L66)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/Memory.ts#L66)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[close](_engines_transactiondb_.transactiondb.md#close)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -111,7 +111,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[del](_engines_transactiondb_.transactiondb.md#del)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -132,7 +132,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[drop](_engines_transactiondb_.transactiondb.md#drop)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -147,7 +147,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[empty](_engines_transactiondb_.transactiondb.md#empty)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -162,7 +162,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[get](_engines_transactiondb_.transactiondb.md#get)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -183,7 +183,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[maintain](_engines_transactiondb_.transactiondb.md#maintain)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -204,7 +204,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[open](_engines_transactiondb_.transactiondb.md#open)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -219,7 +219,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[put](_engines_transactiondb_.transactiondb.md#put)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -241,7 +241,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[rename](_engines_transactiondb_.transactiondb.md#rename)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -263,7 +263,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[size](_engines_transactiondb_.transactiondb.md#size)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -276,7 +276,7 @@ ___
*Inherited from [TransactionDb](_engines_transactiondb_.transactiondb.md).[transaction](_engines_transactiondb_.transactiondb.md#transaction)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/engines/TransactionDb.ts#L29)*
**Parameters:**
docs/db/enums/_fileflatdb_types_.slot.md
+3 -3
View File
@@ -18,7 +18,7 @@
**BRANCH**: = 1
*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/types.ts#L7)*
*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/types.ts#L7)*
___
<a id="empty"></a>
@@ -27,7 +27,7 @@ ___
**EMPTY**: = 0
*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/types.ts#L6)*
*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/types.ts#L6)*
___
<a id="leaf"></a>
@@ -36,7 +36,7 @@ ___
**LEAF**: = 2
*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/types.ts#L8)*
*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/types.ts#L8)*
___
docs/db/interfaces/_types_.basedb.md
+10 -10
View File
@@ -21,7 +21,7 @@
▸ **close**(): `void`
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L18)*
**Returns:** `void`
@@ -32,7 +32,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L26)*
**Parameters:**
@@ -49,7 +49,7 @@ ___
▸ **drop**(): `void`
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L20)*
**Returns:** `void`
@@ -60,7 +60,7 @@ ___
▸ **empty**(): `void`
*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L21)*
**Returns:** `void`
@@ -71,7 +71,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L27)*
*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L27)*
**Parameters:**
@@ -88,7 +88,7 @@ ___
▸ **maintain**(fn: *[ProgressCb](../modules/_types_.md#progresscb)*): `void`
*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L22)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
▸ **open**(): `void`
*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L19)*
**Returns:** `void`
@@ -116,7 +116,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L28)*
**Parameters:**
@@ -134,7 +134,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L23)*
**Parameters:**
@@ -152,7 +152,7 @@ ___
▸ **size**(): `number`
*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L24)*
**Returns:** `number`
docs/db/interfaces/_types_.txdb.md
+11 -11
View File
@@ -22,7 +22,7 @@
*Inherited from [BaseDb](_types_.basedb.md).[close](_types_.basedb.md#close)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L18)*
**Returns:** `void`
@@ -35,7 +35,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[del](_types_.basedb.md#del)*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L26)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[drop](_types_.basedb.md#drop)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L20)*
**Returns:** `void`
@@ -67,7 +67,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[empty](_types_.basedb.md#empty)*
*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L21)*
*Defined in [types.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L21)*
**Returns:** `void`
@@ -80,7 +80,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[get](_types_.basedb.md#get)*
*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L27)*
*Defined in [types.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L27)*
**Parameters:**
@@ -99,7 +99,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[maintain](_types_.basedb.md#maintain)*
*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L22)*
**Parameters:**
@@ -118,7 +118,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[open](_types_.basedb.md#open)*
*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L19)*
*Defined in [types.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L19)*
**Returns:** `void`
@@ -131,7 +131,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[put](_types_.basedb.md#put)*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L28)*
**Parameters:**
@@ -151,7 +151,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[rename](_types_.basedb.md#rename)*
*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L23)*
*Defined in [types.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L23)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
*Inherited from [BaseDb](_types_.basedb.md).[size](_types_.basedb.md#size)*
*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L24)*
*Defined in [types.ts:24](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L24)*
**Returns:** `number`
@@ -182,7 +182,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L32)*
**Parameters:**
docs/db/modules/_fileflatdb_types_.md
+3 -3
View File
@@ -22,7 +22,7 @@
**Ƭ Key**: *`object`*
*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/types.ts#L16)*
*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/types.ts#L16)*
#### Type declaration
@@ -33,7 +33,7 @@ ___
**Ƭ NibbleBuffer**: *`object`*
*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/types.ts#L11)*
*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/types.ts#L11)*
#### Type declaration
@@ -44,7 +44,7 @@ ___
**Ƭ Value**: *`object`*
*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/FileFlatDb/types.ts#L22)*
*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/FileFlatDb/types.ts#L22)*
#### Type declaration
docs/db/modules/_types_.md
+3 -3
View File
@@ -23,7 +23,7 @@
**Ƭ BaseDbOptions**: *`object`*
*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L13)*
*Defined in [types.ts:13](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L13)*
#### Type declaration
@@ -34,7 +34,7 @@ ___
**Ƭ ProgressCb**: *`function`*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L11)*
#### Type declaration
▸(progress: *[ProgressValue](_types_.md#progressvalue)*): `void`
@@ -54,7 +54,7 @@ ___
**Ƭ ProgressValue**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L5)*
#### Type declaration
docs/examples/keyring/01_create_account/index.html
+1 -1
View File
@@ -393,7 +393,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Create Account","level":"2.1.1","depth":2,"next":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]},"previous":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/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":"examples/keyring/01_create_account/README.md","mtime":"2019-02-14T14:15:14.593Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Create Account","level":"2.1.1","depth":2,"next":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]},"previous":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/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":"examples/keyring/01_create_account/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/keyring/02_load_accounts/index.html
+1 -1
View File
@@ -405,7 +405,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Load Accounts","level":"2.1.2","depth":2,"next":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]}]},"previous":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/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":"examples/keyring/02_load_accounts/README.md","mtime":"2019-02-14T14:15:14.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Load Accounts","level":"2.1.2","depth":2,"next":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]}]},"previous":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/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":"examples/keyring/02_load_accounts/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/keyring/index.html
+1 -1
View File
@@ -378,7 +378,7 @@ yarn&#xA0;start
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Keyring","level":"2.1","depth":1,"next":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},"previous":{"title":"util-crypto","level":"1.6","depth":1,"path":"util-crypto/README.md","ref":"util-crypto/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":"examples/keyring/README.md","mtime":"2019-02-14T14:15:14.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Keyring","level":"2.1","depth":1,"next":{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},"previous":{"title":"util-crypto","level":"1.6","depth":1,"path":"util-crypto/README.md","ref":"util-crypto/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":"examples/keyring/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.html
+1 -1
View File
@@ -397,7 +397,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"next":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},"previous":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/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":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","mtime":"2019-02-14T14:15:14.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"next":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},"previous":{"title":"Util-Crypto","level":"2.2","depth":1,"path":"examples/util-crypto/README.md","ref":"examples/util-crypto/README.md","articles":[{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/README.md","articles":[]},{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/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":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/02_sign_verify_message_nacl/index.html
+1 -1
View File
@@ -403,7 +403,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"next":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]},"previous":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/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":"examples/util-crypto/02_sign_verify_message_nacl/README.md","mtime":"2019-02-14T14:15:14.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"next":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"path":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","ref":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","articles":[]},"previous":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/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":"examples/util-crypto/02_sign_verify_message_nacl/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.html
+1 -1
View File
@@ -392,7 +392,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"previous":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/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":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","mtime":"2019-02-14T14:15:14.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Create & Validate Mnemonic","level":"2.2.3","depth":2,"previous":{"title":"Sign & Verify Message","level":"2.2.2","depth":2,"path":"examples/util-crypto/02_sign_verify_message_nacl/README.md","ref":"examples/util-crypto/02_sign_verify_message_nacl/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":"examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../../..","book":{"language":""}});
});
</script>
</div>
docs/examples/util-crypto/index.html
+1 -1
View File
@@ -378,7 +378,7 @@ yarn&#xA0;start
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Util-Crypto","level":"2.2","depth":1,"next":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},"previous":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/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":"examples/util-crypto/README.md","mtime":"2019-02-14T14:15:14.597Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"../..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Util-Crypto","level":"2.2","depth":1,"next":{"title":"Encrypt & Decrypt Message","level":"2.2.1","depth":2,"path":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","ref":"examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md","articles":[]},"previous":{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/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":"examples/util-crypto/README.md","mtime":"2019-02-14T21:07:28.815Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
docs/index.html
+1 -1
View File
@@ -415,7 +415,7 @@
<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-02-14T14:15:14.593Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":".","book":{"language":""}});
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-02-14T21:07:28.811Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/keyring/SUMMARY.md
+1
View File
@@ -28,4 +28,5 @@
* [&quot;testingPairs.spec&quot;](modules/_testingpairs_spec_.md)
* [&quot;types&quot;](modules/_types_.md)
* [KeyringInstance](interfaces/_types_.keyringinstance.md)
* [KeyringPair](interfaces/_types_.keyringpair.md)
* [KeyringPairs](interfaces/_types_.keyringpairs.md)
docs/keyring/classes/_index_.keyring.md
+48 -45
View File
@@ -27,7 +27,7 @@ Overview
⊕ **new Keyring**(options: *[KeyringOptions](../modules/_types_.md#keyringoptions)*): [Keyring](_index_.keyring.md)
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L32)*
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L32)*
**Parameters:**
@@ -49,7 +49,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[decodeAddress](../interfaces/_types_.keyringinstance.md#decodeaddress)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L43)*
___
<a id="encodeaddress"></a>
@@ -60,7 +60,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[encodeAddress](../interfaces/_types_.keyringinstance.md#encodeaddress)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L44)*
___
<a id="setaddressprefix"></a>
@@ -71,7 +71,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[setAddressPrefix](../interfaces/_types_.keyringinstance.md#setaddressprefix)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L45)*
___
@@ -81,13 +81,13 @@ ___
## type
gettype(): [PairType](../modules/_types_.md#pairtype)
gettype(): [KeyringPairType](../modules/_types_.md#keyringpairtype)
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L50)*
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L50)*
*__description__*: Returns the type of the keyring, either ed25519 of sr25519
**Returns:** [PairType](../modules/_types_.md#pairtype)
**Returns:** [KeyringPairType](../modules/_types_.md#keyringpairtype)
___
@@ -97,11 +97,11 @@ ___
## addFromAddress
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromAddress](../interfaces/_types_.keyringinstance.md#addfromaddress)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L70)*
*__name__*: addFromAddress
@@ -111,22 +111,23 @@ ___
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` | `Uint8Array` |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| encoded | `Uint8Array` | `null` |
| Name | Type | Default value |
| ------ | ------ | ------ |
| address | `string` | `Uint8Array` | - |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) | - |
| encoded | `Uint8Array` | `null` | - |
| `Default value` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) | this.type |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="addfromjson"></a>
## addFromJson
▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L81)*
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L81)*
*__name__*: addFromJson
@@ -140,18 +141,18 @@ ___
| ------ | ------ |
| __namedParameters | `object` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="addfrommnemonic"></a>
## addFromMnemonic
▸ **addFromMnemonic**(mnemonic: *`string`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromMnemonic**(mnemonic: *`string`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L93)*
*Defined in [index.ts:96](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L96)*
*__name__*: addFromMnemonic
@@ -161,23 +162,24 @@ ___
**Parameters:**
| Name | Type |
| ------ | ------ |
| mnemonic | `string` |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| Name | Type | Default value |
| ------ | ------ | ------ |
| mnemonic | `string` | - |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) | - |
| `Default value` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) | this.type |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="addfromseed"></a>
## addFromSeed
▸ **addFromSeed**(seed: *`Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromSeed**(seed: *`Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)*
*Defined in [index.ts:104](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L104)*
*Defined in [index.ts:107](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L107)*
*__name__*: addFromSeed
@@ -187,23 +189,24 @@ ___
**Parameters:**
| Name | Type |
| ------ | ------ |
| seed | `Uint8Array` |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| Name | Type | Default value |
| ------ | ------ | ------ |
| seed | `Uint8Array` | - |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) | - |
| `Default value` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) | this.type |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="addpair"></a>
## addPair
▸ **addPair**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addPair**(pair: *[KeyringPair](../interfaces/_types_.keyringpair.md)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L58)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L58)*
*__name__*: addPair
@@ -213,20 +216,20 @@ ___
| Name | Type |
| ------ | ------ |
| pair | [KeyringPair](../modules/_types_.md#keyringpair) |
| pair | [KeyringPair](../interfaces/_types_.keyringpair.md) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="getpair"></a>
## getPair
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)*
*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L118)*
*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L121)*
*__name__*: getPair
@@ -240,18 +243,18 @@ ___
| ------ | ------ |
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="getpairs"></a>
## getPairs
▸ **getPairs**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
▸ **getPairs**(): `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)*
*Defined in [index.ts:127](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L127)*
*Defined in [index.ts:130](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L130)*
*__name__*: getPairs
@@ -259,7 +262,7 @@ ___
*__description__*: Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary.
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
**Returns:** `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
___
<a id="getpublickeys"></a>
@@ -270,7 +273,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)*
*Defined in [index.ts:136](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L136)*
*Defined in [index.ts:139](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L139)*
*__name__*: getPublicKeys
@@ -289,7 +292,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)*
*Defined in [index.ts:148](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L148)*
*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L151)*
*__name__*: removePair
@@ -312,7 +315,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[toJson](../interfaces/_types_.keyringinstance.md#tojson)*
*Defined in [index.ts:160](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/index.ts#L160)*
*Defined in [index.ts:163](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/index.ts#L163)*
*__name__*: toJson
docs/keyring/classes/_pairs_.pairs.md
+12 -12
View File
@@ -16,7 +16,7 @@
⊕ **new Pairs**(): [Pairs](_pairs_.pairs.md)
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pairs.ts#L17)*
**Returns:** [Pairs](_pairs_.pairs.md)
@@ -28,37 +28,37 @@ ___
## add
▸ **add**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **add**(pair: *[KeyringPair](../interfaces/_types_.keyringpair.md)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pairs.ts#L23)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | [KeyringPair](../modules/_types_.md#keyringpair) |
| pair | [KeyringPair](../interfaces/_types_.keyringpair.md) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="all"></a>
## all
▸ **all**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
▸ **all**(): `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
**Returns:** `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
___
<a id="get"></a>
## get
▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pairs.ts#L34)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
| ------ | ------ |
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
<a id="remove"></a>
@@ -75,7 +75,7 @@ ___
▸ **remove**(address: *`string` | `Uint8Array`*): `void`
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pairs.ts#L49)*
**Parameters:**
docs/keyring/index.html
+1 -1
View File
@@ -397,7 +397,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"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":"keyring/README.md","mtime":"2019-02-14T14:18:00.130Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"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":"keyring/README.md","mtime":"2019-02-14T21:10:24.654Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/keyring/interfaces/_types_.keyringinstance.md
+33 -30
View File
@@ -14,9 +14,9 @@
## type
**● type**: *[PairType](../modules/_types_.md#pairtype)*
**● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*
*Defined in [types.ts:55](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L55)*
*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L58)*
___
@@ -26,9 +26,9 @@ ___
## addFromAddress
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L62)*
*Defined in [types.ts:65](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L65)*
**Parameters:**
@@ -37,17 +37,18 @@ ___
| address | `string` | `Uint8Array` |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| encoded | `Uint8Array` | `null` |
| `Optional` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="addfromjson"></a>
## addFromJson
▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:65](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L65)*
*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L68)*
**Parameters:**
@@ -55,16 +56,16 @@ ___
| ------ | ------ |
| pair | [KeyringPair$Json](../modules/_types_.md#keyringpair_json) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="addfrommnemonic"></a>
## addFromMnemonic
▸ **addFromMnemonic**(mnemonic: *`string`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromMnemonic**(mnemonic: *`string`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L63)*
*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L66)*
**Parameters:**
@@ -72,17 +73,18 @@ ___
| ------ | ------ |
| mnemonic | `string` |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| `Optional` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="addfromseed"></a>
## addFromSeed
▸ **addFromSeed**(seed: *`Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromSeed**(seed: *`Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L64)*
*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L67)*
**Parameters:**
@@ -90,25 +92,26 @@ ___
| ------ | ------ |
| seed | `Uint8Array` |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| `Optional` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="addpair"></a>
## addPair
▸ **addPair**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addPair**(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:61](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L61)*
*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L64)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | [KeyringPair](../modules/_types_.md#keyringpair) |
| pair | [KeyringPair](_types_.keyringpair.md) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="decodeaddress"></a>
@@ -117,7 +120,7 @@ ___
▸ **decodeAddress**(encoded: *`string` | `Uint8Array`*): `Uint8Array`
*Defined in [types.ts:57](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L57)*
*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L60)*
**Parameters:**
@@ -134,7 +137,7 @@ ___
▸ **encodeAddress**(key: *`Uint8Array` | `string`*): `string`
*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L58)*
*Defined in [types.ts:61](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L61)*
**Parameters:**
@@ -149,9 +152,9 @@ ___
## getPair
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L66)*
*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L69)*
**Parameters:**
@@ -159,18 +162,18 @@ ___
| ------ | ------ |
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="getpairs"></a>
## getPairs
▸ **getPairs**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
▸ **getPairs**(): `Array`<[KeyringPair](_types_.keyringpair.md)>
*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L67)*
*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L70)*
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
**Returns:** `Array`<[KeyringPair](_types_.keyringpair.md)>
___
<a id="getpublickeys"></a>
@@ -179,7 +182,7 @@ ___
▸ **getPublicKeys**(): `Array`<`Uint8Array`>
*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L68)*
*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L71)*
**Returns:** `Array`<`Uint8Array`>
@@ -190,7 +193,7 @@ ___
▸ **removePair**(address: *`string` | `Uint8Array`*): `void`
*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L69)*
*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L72)*
**Parameters:**
@@ -207,7 +210,7 @@ ___
▸ **setAddressPrefix**(prefix: *[Prefix](../modules/_address_types_.md#prefix)*): `void`
*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L59)*
*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L62)*
**Parameters:**
@@ -224,7 +227,7 @@ ___
▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L70)*
*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L73)*
**Parameters:**
docs/keyring/interfaces/_types_.keyringpair.md
+221
View File
@@ -0,0 +1,221 @@
# Hierarchy
**KeyringPair**
# Properties
<a id="address"></a>
## address
**● address**: *`function`*
*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L36)*
#### Type declaration
▸(): `string`
**Returns:** `string`
___
<a id="decodepkcs8"></a>
## decodePkcs8
**● decodePkcs8**: *`function`*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L37)*
#### Type declaration
▸(passphrase?: *`undefined` | `string`*, encoded?: *`Uint8Array`*): `void`
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` passphrase | `undefined` | `string` |
| `Optional` encoded | `Uint8Array` |
**Returns:** `void`
___
<a id="encodepkcs8"></a>
## encodePkcs8
**● encodePkcs8**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L38)*
#### Type declaration
▸(passphrase?: *`undefined` | `string`*): `Uint8Array`
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` passphrase | `undefined` | `string` |
**Returns:** `Uint8Array`
___
<a id="getmeta"></a>
## getMeta
**● getMeta**: *`function`*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L39)*
#### Type declaration
▸(): [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)
**Returns:** [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)
___
<a id="islocked"></a>
## isLocked
**● isLocked**: *`function`*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L40)*
#### Type declaration
▸(): `boolean`
**Returns:** `boolean`
___
<a id="lock"></a>
## lock
**● lock**: *`function`*
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L41)*
#### Type declaration
▸(): `void`
**Returns:** `void`
___
<a id="publickey"></a>
## publicKey
**● publicKey**: *`function`*
*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L42)*
#### Type declaration
▸(): `Uint8Array`
**Returns:** `Uint8Array`
___
<a id="setmeta"></a>
## setMeta
**● setMeta**: *`function`*
*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L43)*
#### Type declaration
▸(meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): `void`
**Parameters:**
| Name | Type |
| ------ | ------ |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
**Returns:** `void`
___
<a id="type"></a>
## type
**● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L34)*
___
# Methods
<a id="sign"></a>
## sign
▸ **sign**(message: *`Uint8Array`*): `Uint8Array`
*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L44)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| message | `Uint8Array` |
**Returns:** `Uint8Array`
___
<a id="tojson"></a>
## toJson
▸ **toJson**(passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L45)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` passphrase | `undefined` | `string` |
**Returns:** [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
___
<a id="totype"></a>
## toType
▸ **toType**(type: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L46)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| type | [KeyringPairType](../modules/_types_.md#keyringpairtype) |
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="verify"></a>
## verify
▸ **verify**(message: *`Uint8Array`*, signature: *`Uint8Array`*): `boolean`
*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L47)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| message | `Uint8Array` |
| signature | `Uint8Array` |
**Returns:** `boolean`
___
docs/keyring/interfaces/_types_.keyringpairs.md
+11 -11
View File
@@ -16,18 +16,18 @@
**● add**: *`function`*
*Defined in [types.ts:48](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L48)*
*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L51)*
#### Type declaration
▸(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md)
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | [KeyringPair](../modules/_types_.md#keyringpair) |
| pair | [KeyringPair](_types_.keyringpair.md) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="all"></a>
@@ -36,12 +36,12 @@ ___
**● all**: *`function`*
*Defined in [types.ts:49](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L49)*
*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L52)*
#### Type declaration
▸(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
▸(): `Array`<[KeyringPair](_types_.keyringpair.md)>
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
**Returns:** `Array`<[KeyringPair](_types_.keyringpair.md)>
___
<a id="get"></a>
@@ -50,10 +50,10 @@ ___
**● get**: *`function`*
*Defined in [types.ts:50](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L50)*
*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L53)*
#### Type declaration
▸(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸(address: *`string` | `Uint8Array`*): [KeyringPair](_types_.keyringpair.md)
**Parameters:**
@@ -61,7 +61,7 @@ ___
| ------ | ------ |
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
**Returns:** [KeyringPair](_types_.keyringpair.md)
___
<a id="remove"></a>
@@ -70,7 +70,7 @@ ___
**● remove**: *`function`*
*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L51)*
*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L54)*
#### Type declaration
▸(address: *`string` | `Uint8Array`*): `void`
docs/keyring/modules/_address_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(encoded: *`string` | `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array`
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/address/decode.ts#L15)*
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/address/decode.ts#L15)*
**Parameters:**
docs/keyring/modules/_address_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(_key: *`Uint8Array` | `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string`
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/address/encode.ts#L15)*
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/address/encode.ts#L15)*
**Parameters:**
docs/keyring/modules/_address_setprefix_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **setPrefix**(prefix: *[Prefix](_address_types_.md#prefix)*): `void`
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/address/setPrefix.ts#L9)*
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/address/setPrefix.ts#L9)*
**Parameters:**
docs/keyring/modules/_address_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ Prefix**: *`0` | `1` | `3` | `42` | `43` | `68` | `69`*
*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/address/types.ts#L5)*
*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/address/types.ts#L5)*
___
docs/keyring/modules/_pair_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(passphrase?: *`undefined` | `string`*, _encrypted?: *`Uint8Array` | `null`*): `DecodeResult`
*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pair/decode.ts#L19)*
*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pair/decode.ts#L19)*
**Parameters:**
docs/keyring/modules/_pair_encode_.md
+3 -4
View File
@@ -6,16 +6,15 @@
## encode
▸ **encode**(publicKey: *`Uint8Array`*, seed?: *`Uint8Array` | `null`*, passphrase?: *`undefined` | `string`*): `Uint8Array`
▸ **encode**(__namedParameters: *`object`*, passphrase?: *`undefined` | `string`*): `Uint8Array`
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pair/encode.ts#L10)*
*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pair/encode.ts#L12)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| publicKey | `Uint8Array` |
| `Optional` seed | `Uint8Array` | `null` |
| __namedParameters | `object` |
| `Optional` passphrase | `undefined` | `string` |
**Returns:** `Uint8Array`
docs/keyring/modules/_pair_index_.md
+6 -6
View File
@@ -2,13 +2,13 @@
# Functions
<a id="pair"></a>
<a id="createpair"></a>
## pair
## createPair
▸ **pair**(type: *[PairType](_types_.md#pairtype)*, __namedParameters: *`object`*, meta?: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](_types_.md#keyringpair)
▸ **createPair**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, meta?: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pair/index.ts:47](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pair/index.ts#L47)*
*Defined in [pair/index.ts:62](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pair/index.ts#L62)*
*__name__*: pair
@@ -30,12 +30,12 @@ It has properties whose values are functions that may be called to perform accou
| Name | Type | Default value |
| ------ | ------ | ------ |
| type | [PairType](_types_.md#pairtype) | - |
| type | [KeyringPairType](_types_.md#keyringpairtype) | - |
| __namedParameters | `object` | - |
| `Default value` meta | [KeyringPair$Meta](_types_.md#keyringpair_meta) | {} |
| encoded | `Uint8Array` | `null` | - |
**Returns:** [KeyringPair](_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
docs/keyring/modules/_pair_nobody_.md
+3 -3
View File
@@ -6,11 +6,11 @@
## everybody
▸ **everybody**(): [KeyringPair](_types_.md#keyringpair)
▸ **everybody**(): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pair/nobody.ts#L25)*
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pair/nobody.ts#L25)*
**Returns:** [KeyringPair](_types_.md#keyringpair)
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
___
docs/keyring/modules/_pair_tojson_.md
+3 -2
View File
@@ -6,14 +6,15 @@
## toJson
▸ **toJson**(__namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): [KeyringPair$Json](_types_.md#keyringpair_json)
▸ **toJson**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): [KeyringPair$Json](_types_.md#keyringpair_json)
*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pair/toJson.ts#L15)*
*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pair/toJson.ts#L15)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| type | [KeyringPairType](_types_.md#keyringpairtype) |
| __namedParameters | `object` |
| encoded | `Uint8Array` |
| isEncrypted | `boolean` |
docs/keyring/modules/_pair_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ PairInfo**: *`object`*
*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/pair/types.ts#L5)*
*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/pair/types.ts#L5)*
#### Type declaration
docs/keyring/modules/_testing_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyring**(options: *[KeyringOptions](_types_.md#keyringoptions)*): [KeyringInstance](../interfaces/_types_.keyringinstance.md)
*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/testing.ts#L41)*
*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/testing.ts#L41)*
*__name__*: testKeyring
docs/keyring/modules/_testingpairs_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyringPairs**(options: *[KeyringOptions](_types_.md#keyringoptions)*): `TestKeyringMap`
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/testingPairs.ts#L14)*
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/testingPairs.ts#L14)*
**Parameters:**
docs/keyring/modules/_types_.md
+11 -22
View File
@@ -5,17 +5,17 @@
### Interfaces
* [KeyringInstance](../interfaces/_types_.keyringinstance.md)
* [KeyringPair](../interfaces/_types_.keyringpair.md)
* [KeyringPairs](../interfaces/_types_.keyringpairs.md)
### Type aliases
* [KeyringOptions](_types_.md#keyringoptions)
* [KeyringPair](_types_.md#keyringpair)
* [KeyringPair$Json](_types_.md#keyringpair_json)
* [KeyringPair$JsonEncoding](_types_.md#keyringpair_jsonencoding)
* [KeyringPair$JsonVersion](_types_.md#keyringpair_jsonversion)
* [KeyringPair$Meta](_types_.md#keyringpair_meta)
* [PairType](_types_.md#pairtype)
* [KeyringPairType](_types_.md#keyringpairtype)
---
@@ -27,18 +27,7 @@
**Ƭ KeyringOptions**: *`object`*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L9)*
#### Type declaration
___
<a id="keyringpair"></a>
## KeyringPair
**Ƭ KeyringPair**: *`object`*
*Defined in [types.ts:33](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L33)*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L9)*
#### Type declaration
@@ -49,7 +38,7 @@ ___
**Ƭ KeyringPair$Json**: *`object`*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L26)*
#### Type declaration
@@ -60,7 +49,7 @@ ___
**Ƭ KeyringPair$JsonEncoding**: *`object`*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L20)*
#### Type declaration
@@ -71,7 +60,7 @@ ___
**Ƭ KeyringPair$JsonVersion**: *"0" | "1"*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L18)*
___
<a id="keyringpair_meta"></a>
@@ -80,20 +69,20 @@ ___
**Ƭ KeyringPair$Meta**: *`object`*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L14)*
#### Type declaration
[index: `string`]: `any`
___
<a id="pairtype"></a>
<a id="keyringpairtype"></a>
## PairType
## KeyringPairType
**Ƭ PairType**: *"ed25519" | "sr25519"*
**Ƭ KeyringPairType**: *"ed25519" | "sr25519"*
*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/keyring/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/keyring/src/types.ts#L7)*
___
docs/trie-codec/classes/_nodeheader_.extensionheader.md
+2 -2
View File
@@ -16,7 +16,7 @@
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L21)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L21)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L27)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L27)*
**Returns:** `number`
docs/trie-codec/classes/_nodeheader_.leafheader.md
+2 -2
View File
@@ -16,7 +16,7 @@
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L21)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L21)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L27)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L27)*
**Returns:** `number`
docs/trie-codec/classes/_nodeheader_.nibbleheader.md
+2 -2
View File
@@ -16,7 +16,7 @@
⊕ **new NibbleHeader**(input: *`number`*): [NibbleHeader](_nodeheader_.nibbleheader.md)
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L21)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L21)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
▸ **toNumber**(): `number`
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L27)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L27)*
**Returns:** `number`
docs/trie-codec/classes/_nodeheader_.nodeheader.md
+5 -5
View File
@@ -12,7 +12,7 @@
⊕ **new NodeHeader**(input?: *`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>*): [NodeHeader](_nodeheader_.nodeheader.md)
*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L40)*
*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L40)*
**Parameters:**
@@ -32,7 +32,7 @@ ___
getencodedLength(): `number`
*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L92)*
*Defined in [NodeHeader.ts:92](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L92)*
**Returns:** `number`
@@ -43,7 +43,7 @@ ___
getnodeType(): `number`
*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L114)*
*Defined in [NodeHeader.ts:114](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L114)*
**Returns:** `number`
@@ -54,7 +54,7 @@ ___
getvalue(): [Null](_nodeheader_.null.md) | [BranchHeader](_nodeheader_.branchheader.md) | [ExtensionHeader](_nodeheader_.extensionheader.md) | [LeafHeader](_nodeheader_.leafheader.md)
*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L118)*
*Defined in [NodeHeader.ts:118](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L118)*
**Returns:** [Null](_nodeheader_.null.md) | [BranchHeader](_nodeheader_.branchheader.md) | [ExtensionHeader](_nodeheader_.extensionheader.md) | [LeafHeader](_nodeheader_.leafheader.md)
@@ -68,7 +68,7 @@ ___
▸ **toU8a**(): `Uint8Array`
*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/NodeHeader.ts#L122)*
*Defined in [NodeHeader.ts:122](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/NodeHeader.ts#L122)*
**Returns:** `Uint8Array`
docs/trie-codec/modules/_constants_.md
+15 -15
View File
@@ -8,7 +8,7 @@
**● BRANCH_NODE_NO_VALUE**: *`254`* = 254
*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L10)*
*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L10)*
___
<a id="branch_node_with_value"></a>
@@ -17,7 +17,7 @@ ___
**● BRANCH_NODE_WITH_VALUE**: *`255`* = 255
*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L11)*
*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L11)*
___
<a id="empty_trie"></a>
@@ -26,7 +26,7 @@ ___
**● EMPTY_TRIE**: *`0`* = 0
*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L5)*
*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L5)*
___
<a id="extension_node_big"></a>
@@ -35,7 +35,7 @@ ___
**● EXTENSION_NODE_BIG**: *`253`* = 253
*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L9)*
*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L9)*
___
<a id="extension_node_offset"></a>
@@ -44,7 +44,7 @@ ___
**● EXTENSION_NODE_OFFSET**: *`128`* = 128
*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L8)*
*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L8)*
___
<a id="extension_node_small_max"></a>
@@ -53,7 +53,7 @@ ___
**● EXTENSION_NODE_SMALL_MAX**: *`number`* = EXTENSION_NODE_BIG - 1
*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L15)*
*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L15)*
___
<a id="extension_node_threshold"></a>
@@ -62,7 +62,7 @@ ___
**● EXTENSION_NODE_THRESHOLD**: *`number`* = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET
*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L13)*
*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L13)*
___
<a id="leaf_node_big"></a>
@@ -71,7 +71,7 @@ ___
**● LEAF_NODE_BIG**: *`127`* = 127
*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L7)*
*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L7)*
___
<a id="leaf_node_offset"></a>
@@ -80,7 +80,7 @@ ___
**● LEAF_NODE_OFFSET**: *`1`* = 1
*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L6)*
*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L6)*
___
<a id="leaf_node_small_max"></a>
@@ -89,7 +89,7 @@ ___
**● LEAF_NODE_SMALL_MAX**: *`number`* = LEAF_NODE_BIG - 1
*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L14)*
*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L14)*
___
<a id="leaf_node_threshold"></a>
@@ -98,7 +98,7 @@ ___
**● LEAF_NODE_THRESHOLD**: *`number`* = LEAF_NODE_BIG - LEAF_NODE_OFFSET
*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L12)*
*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L12)*
___
<a id="node_type_branch"></a>
@@ -107,7 +107,7 @@ ___
**● NODE_TYPE_BRANCH**: *`1`* = 1
*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L17)*
*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L17)*
___
<a id="node_type_ext"></a>
@@ -116,7 +116,7 @@ ___
**● NODE_TYPE_EXT**: *`2`* = 2
*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L18)*
*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L18)*
___
<a id="node_type_leaf"></a>
@@ -125,7 +125,7 @@ ___
**● NODE_TYPE_LEAF**: *`3`* = 3
*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L19)*
*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L19)*
___
<a id="node_type_null"></a>
@@ -134,7 +134,7 @@ ___
**● NODE_TYPE_NULL**: *`0`* = 0
*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/constants.ts#L16)*
*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/constants.ts#L16)*
___
docs/trie-codec/modules/_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(input: *`null` | `Uint8Array`*): `Uint8Array` | `null` | `Array`<`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>>
*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/decode.ts#L95)*
*Defined in [decode.ts:95](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/decode.ts#L95)*
**Parameters:**
docs/trie-codec/modules/_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(input?: *`null` | `Uint8Array` | `Array`<`null` | `Uint8Array`>*): `Uint8Array`
*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/encode.ts#L101)*
*Defined in [encode.ts:101](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/encode.ts#L101)*
**Parameters:**
docs/trie-codec/modules/_nibbles_.md
+7 -7
View File
@@ -8,7 +8,7 @@
▸ **addNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L31)*
*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L31)*
**Parameters:**
@@ -25,7 +25,7 @@ ___
▸ **decodeNibbles**(value: *`null` | `Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L52)*
*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L52)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
▸ **encodeNibbles**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L65)*
*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L65)*
**Parameters:**
@@ -59,7 +59,7 @@ ___
▸ **extractKey**(key: *`null` | `Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L15)*
*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L15)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **extractNodeKey**(__namedParameters: *[`null` | `Uint8Array`]*): `Uint8Array`
*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L21)*
*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L21)*
**Parameters:**
@@ -93,7 +93,7 @@ ___
▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean`
*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L27)*
*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L27)*
**Parameters:**
@@ -110,7 +110,7 @@ ___
▸ **removeNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/nibbles.ts#L44)*
*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/nibbles.ts#L44)*
**Parameters:**
docs/trie-codec/modules/_stream_createbranch_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createBranch**(value: *`Uint8Array` | `null`*, hasChildren: *`Array`<`boolean`>*): `Uint8Array`
*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/createBranch.ts#L10)*
*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/createBranch.ts#L10)*
**Parameters:**
docs/trie-codec/modules/_stream_createempty_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createEmpty**(): `Uint8Array`
*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/createEmpty.ts#L7)*
*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/createEmpty.ts#L7)*
**Returns:** `Uint8Array`
docs/trie-codec/modules/_stream_createextension_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createExtension**(key: *`Uint8Array`*): `Uint8Array`
*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/createExtension.ts#L7)*
*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/createExtension.ts#L7)*
**Parameters:**
docs/trie-codec/modules/_stream_createleaf_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createLeaf**(key: *`Uint8Array`*, value: *`Uint8Array`*): `Uint8Array`
*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/createLeaf.ts#L10)*
*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/createLeaf.ts#L10)*
**Parameters:**
docs/trie-codec/modules/_stream_createsubstream_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createSubstream**(value: *`Uint8Array`*): `Uint8Array`
*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/createSubstream.ts#L8)*
*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/createSubstream.ts#L8)*
**Parameters:**
docs/trie-codec/modules/_stream_createvalue_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createValue**(value: *`null` | `Uint8Array`*): `Uint8Array`
*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/createValue.ts#L9)*
*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/createValue.ts#L9)*
**Parameters:**
docs/trie-codec/modules/_stream_endbranch_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encBranch**(value: *`Uint8Array` | `null`*): `Uint8Array`
*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/stream/endBranch.ts#L7)*
*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/stream/endBranch.ts#L7)*
**Parameters:**
docs/trie-codec/modules/_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ Codec**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/types.ts#L5)*
#### Type declaration
docs/trie-codec/modules/_util_fromnibbles_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fromNibbles**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/util/fromNibbles.ts#L19)*
*Defined in [util/fromNibbles.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/util/fromNibbles.ts#L19)*
*__name__*: fromNibbles
docs/trie-codec/modules/_util_fusenibbles_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **fuseNibbles**(nibbles: *`Uint8Array`*, isLeaf: *`boolean`*): `Uint8Array`
*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/util/fuseNibbles.ts#L12)*
*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/util/fuseNibbles.ts#L12)*
**Parameters:**
docs/trie-codec/modules/_util_sharedprefixlength_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **sharedPrefixLength**(first: *`Uint8Array`*, second: *`Uint8Array`*): `number`
*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)*
*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)*
**Parameters:**
docs/trie-codec/modules/_util_tonibbles_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toNibbles**(input?: *`Uint8Array` | `null`*): `Uint8Array`
*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-codec/src/util/toNibbles.ts#L19)*
*Defined in [util/toNibbles.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-codec/src/util/toNibbles.ts#L19)*
*__name__*: toNibbles
docs/trie-db/classes/_checkpoint_.checkpoint.md
+1 -1
View File
@@ -14,7 +14,7 @@
⊕ **new Checkpoint**(rootHash: *`Uint8Array`*): [Checkpoint](_checkpoint_.checkpoint.md)
*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/Checkpoint.ts#L7)*
*Defined in [Checkpoint.ts:7](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/Checkpoint.ts#L7)*
**Parameters:**
docs/trie-db/classes/_impl_.impl.md
+2 -2
View File
@@ -29,7 +29,7 @@ Overview
*Overrides [Checkpoint](_checkpoint_.checkpoint.md).[constructor](_checkpoint_.checkpoint.md#constructor)*
*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/Impl.ts#L38)*
*Defined in [Impl.ts:38](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/Impl.ts#L38)*
**Parameters:**
@@ -51,7 +51,7 @@ ___
**● db**: *`TxDb`*
*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/Impl.ts#L36)*
*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/Impl.ts#L36)*
___
docs/trie-db/classes/_index_.trie.md
+17 -17
View File
@@ -31,7 +31,7 @@ Overview
*Overrides [Impl](_impl_.impl.md).[constructor](_impl_.impl.md#constructor)*
*Defined in [index.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L27)*
*Defined in [index.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L27)*
**Parameters:**
@@ -57,7 +57,7 @@ ___
*Inherited from [Impl](_impl_.impl.md).[db](_impl_.impl.md#db)*
*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/Impl.ts#L36)*
*Defined in [Impl.ts:36](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/Impl.ts#L36)*
___
@@ -71,7 +71,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[close](../interfaces/_types_.triedb.md#close)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L58)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L58)*
**Returns:** `void`
@@ -84,7 +84,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[del](../interfaces/_types_.triedb.md#del)*
*Defined in [index.ts:82](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L82)*
*Defined in [index.ts:82](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L82)*
**Parameters:**
@@ -103,7 +103,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[drop](../interfaces/_types_.triedb.md#drop)*
*Defined in [index.ts:66](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L66)*
*Defined in [index.ts:66](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L66)*
**Returns:** `void`
@@ -116,7 +116,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[empty](../interfaces/_types_.triedb.md#empty)*
*Defined in [index.ts:62](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L62)*
*Defined in [index.ts:62](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L62)*
**Returns:** `void`
@@ -129,7 +129,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[get](../interfaces/_types_.triedb.md#get)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L93)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L93)*
**Parameters:**
@@ -146,7 +146,7 @@ ___
▸ **getNode**(hash?: *`Uint8Array`*): [Node](../modules/_types_.md#node)
*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L124)*
*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L124)*
**Parameters:**
@@ -165,7 +165,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[getRoot](../interfaces/_types_.triedb.md#getroot)*
*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L114)*
*Defined in [index.ts:114](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L114)*
**Returns:** `Uint8Array`
@@ -178,7 +178,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[maintain](../interfaces/_types_.triedb.md#maintain)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L70)*
**Parameters:**
@@ -197,7 +197,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[open](../interfaces/_types_.triedb.md#open)*
*Defined in [index.ts:54](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L54)*
*Defined in [index.ts:54](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L54)*
**Returns:** `void`
@@ -210,7 +210,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[put](../interfaces/_types_.triedb.md#put)*
*Defined in [index.ts:102](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L102)*
*Defined in [index.ts:102](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L102)*
**Parameters:**
@@ -230,7 +230,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[rename](../interfaces/_types_.triedb.md#rename)*
*Defined in [index.ts:74](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L74)*
*Defined in [index.ts:74](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L74)*
**Parameters:**
@@ -250,7 +250,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[setRoot](../interfaces/_types_.triedb.md#setroot)*
*Defined in [index.ts:128](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L128)*
*Defined in [index.ts:128](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L128)*
**Parameters:**
@@ -269,7 +269,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[size](../interfaces/_types_.triedb.md#size)*
*Defined in [index.ts:78](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L78)*
*Defined in [index.ts:78](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L78)*
**Returns:** `number`
@@ -282,7 +282,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[snapshot](../interfaces/_types_.triedb.md#snapshot)*
*Defined in [index.ts:133](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L133)*
*Defined in [index.ts:133](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L133)*
**Parameters:**
@@ -300,7 +300,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [index.ts:34](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/index.ts#L34)*
*Defined in [index.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/index.ts#L34)*
**Parameters:**
docs/trie-db/enums/_types_.nodetype.md
+4 -4
View File
@@ -19,7 +19,7 @@
**BRANCH**: = 3
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L11)*
___
<a id="empty"></a>
@@ -28,7 +28,7 @@ ___
**EMPTY**: = 0
*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L8)*
___
<a id="extension"></a>
@@ -37,7 +37,7 @@ ___
**EXTENSION**: = 2
*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L10)*
___
<a id="leaf"></a>
@@ -46,7 +46,7 @@ ___
**LEAF**: = 1
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L9)*
___
docs/trie-db/index.html
+1 -1
View File
@@ -401,7 +401,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"trie-db","level":"1.3","depth":1,"next":{"title":"trie-hash","level":"1.4","depth":1,"path":"trie-hash/README.md","ref":"trie-hash/README.md","articles":[]},"previous":{"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":"trie-db/README.md","mtime":"2019-02-14T14:18:14.654Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"trie-db","level":"1.3","depth":1,"next":{"title":"trie-hash","level":"1.4","depth":1,"path":"trie-hash/README.md","ref":"trie-hash/README.md","articles":[]},"previous":{"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":"trie-db/README.md","mtime":"2019-02-14T21:10:39.199Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/trie-db/interfaces/_types_.triedb.md
+15 -15
View File
@@ -18,7 +18,7 @@
**● db**: *`TxDb`*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L37)*
___
@@ -32,7 +32,7 @@ ___
*Inherited from BaseDb.close*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L18)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L18)*
**Returns:** `void`
@@ -45,7 +45,7 @@ ___
*Inherited from BaseDb.del*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L26)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:26](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L26)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
*Inherited from BaseDb.drop*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L20)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L20)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
*Inherited from BaseDb.empty*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L21)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L21)*
**Returns:** `void`
@@ -90,7 +90,7 @@ ___
*Inherited from BaseDb.get*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L27)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:27](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L27)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **getRoot**(): `Uint8Array`
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L39)*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L39)*
**Returns:** `Uint8Array`
@@ -120,7 +120,7 @@ ___
*Inherited from BaseDb.maintain*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L22)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:22](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L22)*
**Parameters:**
@@ -139,7 +139,7 @@ ___
*Inherited from BaseDb.open*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L19)*
**Returns:** `void`
@@ -152,7 +152,7 @@ ___
*Inherited from BaseDb.put*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L28)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:28](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L28)*
**Parameters:**
@@ -172,7 +172,7 @@ ___
*Inherited from BaseDb.rename*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L23)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L23)*
**Parameters:**
@@ -190,7 +190,7 @@ ___
▸ **setRoot**(rootHash: *`Uint8Array`*): `void`
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L40)*
**Parameters:**
@@ -209,7 +209,7 @@ ___
*Inherited from BaseDb.size*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L24)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:24](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L24)*
**Returns:** `number`
@@ -220,7 +220,7 @@ ___
▸ **snapshot**(dest: *[TrieDb](_types_.triedb.md)*, fn: *`ProgressCb`*): `number`
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L41)*
**Parameters:**
@@ -240,7 +240,7 @@ ___
*Inherited from TxDb.transaction*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32](https://github.com/polkadot-js/common/blob/0710c73/packages/db/src/types.ts#L32)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.ts:32](https://github.com/polkadot-js/common/blob/c3fafbe/packages/db/src/types.ts#L32)*
**Parameters:**
docs/trie-db/modules/_constants_.md
+2 -2
View File
@@ -8,7 +8,7 @@
**Ƭ Constants**: *`object`*
*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/constants.ts#L9)*
*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/constants.ts#L9)*
#### Type declaration
@@ -22,7 +22,7 @@ ___
▸ **default**(codec: *`Codec`*): `object`
*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/constants.ts#L14)*
*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/constants.ts#L14)*
**Parameters:**
docs/trie-db/modules/_types_.md
+8 -8
View File
@@ -31,7 +31,7 @@
**Ƭ EncodedPath**: *`Uint8Array` | `null`*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L28)*
___
<a id="node"></a>
@@ -40,7 +40,7 @@ ___
**Ƭ Node**: *[NodeEmpty](_types_.md#nodeempty) | [NodeNotEmpty](_types_.md#nodenotempty)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L34)*
___
<a id="nodebranch"></a>
@@ -49,7 +49,7 @@ ___
**Ƭ NodeBranch**: *[[NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L20)*
___
<a id="nodeempty"></a>
@@ -58,7 +58,7 @@ ___
**Ƭ NodeEmpty**: *`null`*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L14)*
___
<a id="nodeencoded"></a>
@@ -67,7 +67,7 @@ ___
**Ƭ NodeEncoded**: *`Uint8Array`*
*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L16)*
___
<a id="nodeencodedorempty"></a>
@@ -76,7 +76,7 @@ ___
**Ƭ NodeEncodedOrEmpty**: *[NodeEncoded](_types_.md#nodeencoded) | [NodeEmpty](_types_.md#nodeempty)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L18)*
___
<a id="nodekv"></a>
@@ -85,7 +85,7 @@ ___
**Ƭ NodeKv**: *[[EncodedPath](_types_.md#encodedpath), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]*
*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L30)*
___
<a id="nodenotempty"></a>
@@ -94,7 +94,7 @@ ___
**Ƭ NodeNotEmpty**: *[NodeKv](_types_.md#nodekv) | [NodeBranch](_types_.md#nodebranch)*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/types.ts#L32)*
___
docs/trie-db/modules/_util_is_.md
+5 -5
View File
@@ -8,7 +8,7 @@
▸ **isBranchNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/is.ts#L52)*
*Defined in [util/is.ts:52](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/is.ts#L52)*
*__name__*: isBranchNode
@@ -31,7 +31,7 @@ ___
▸ **isEmptyNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/is.ts#L16)*
*Defined in [util/is.ts:16](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/is.ts#L16)*
*__name__*: isEmptyNode
@@ -54,7 +54,7 @@ ___
▸ **isExtensionNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/is.ts#L34)*
*Defined in [util/is.ts:34](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/is.ts#L34)*
*__name__*: isExtensionNode
@@ -77,7 +77,7 @@ ___
▸ **isKvNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/is.ts#L25)*
*Defined in [util/is.ts:25](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/is.ts#L25)*
*__name__*: isKvNode
@@ -100,7 +100,7 @@ ___
▸ **isLeafNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/is.ts#L43)*
*Defined in [util/is.ts:43](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/is.ts#L43)*
*__name__*: isLeafNode
docs/trie-db/modules/_util_key_.md
+6 -6
View File
@@ -8,7 +8,7 @@
▸ **computeExtensionKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath)
*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/key.ts#L36)*
*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/key.ts#L36)*
**Parameters:**
@@ -25,7 +25,7 @@ ___
▸ **computeLeafKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath)
*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/key.ts#L40)*
*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/key.ts#L40)*
**Parameters:**
@@ -42,7 +42,7 @@ ___
▸ **consumeCommonPrefix**(left: *`Uint8Array`*, right: *`Uint8Array`*): [`Uint8Array`, `Uint8Array`, `Uint8Array`]
*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/key.ts#L56)*
*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/key.ts#L56)*
**Parameters:**
@@ -60,7 +60,7 @@ ___
▸ **getCommonPrefixLength**(left: *`Uint8Array`*, right: *`Uint8Array`*): `number`
*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/key.ts#L46)*
*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/key.ts#L46)*
**Parameters:**
@@ -78,7 +78,7 @@ ___
▸ **keyEquals**(key: *`Uint8Array` | `null`*, test: *`Uint8Array` | `null`*): `boolean`
*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/key.ts#L10)*
*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/key.ts#L10)*
**Parameters:**
@@ -96,7 +96,7 @@ ___
▸ **keyStartsWith**(key: *`Uint8Array` | `null`*, partial: *`Uint8Array` | `null`*): `boolean`
*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/key.ts#L20)*
*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/key.ts#L20)*
**Parameters:**
docs/trie-db/modules/_util_node_.md
+3 -3
View File
@@ -8,7 +8,7 @@
▸ **decodeNode**(codec: *`Codec`*, encoded: *`Uint8Array` | [Node](_types_.md#node)*): [Node](_types_.md#node)
*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/node.ts#L30)*
*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/node.ts#L30)*
**Parameters:**
@@ -26,7 +26,7 @@ ___
▸ **encodeNode**(codec: *`Codec`*, node: *[Node](_types_.md#node)*): `Uint8Array`
*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/node.ts#L46)*
*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/node.ts#L46)*
**Parameters:**
@@ -44,7 +44,7 @@ ___
▸ **getNodeType**(node: *[Node](_types_.md#node)*): [NodeType](../enums/_types_.nodetype.md)
*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-db/src/util/node.ts#L13)*
*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-db/src/util/node.ts#L13)*
**Parameters:**
docs/trie-hash/index.html
+1 -1
View File
@@ -391,7 +391,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"trie-hash","level":"1.4","depth":1,"next":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/README.md","articles":[]},"previous":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/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":"trie-hash/README.md","mtime":"2019-02-14T14:18:22.162Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"trie-hash","level":"1.4","depth":1,"next":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/README.md","articles":[]},"previous":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/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":"trie-hash/README.md","mtime":"2019-02-14T21:10:46.419Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/trie-hash/modules/_buildtrie_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **buildTrie**(input: *`Array`<[`Uint8Array`, `Uint8Array`]>*, cursor?: *`number`*, codec?: *`Codec`*, stream?: *`any`*): `Uint8Array`
*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-hash/src/buildTrie.ts#L77)*
*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-hash/src/buildTrie.ts#L77)*
**Parameters:**
docs/trie-hash/modules/_trieroot_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **trieRoot**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array`
*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-hash/src/trieRoot.ts#L29)*
*Defined in [trieRoot.ts:29](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-hash/src/trieRoot.ts#L29)*
*__name__*: trieRoot
docs/trie-hash/modules/_trierootordered_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **trieRootOrdered**(input: *`Array`<`Uint8Array`>*, codec?: *`Codec`*): `Uint8Array`
*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-hash/src/trieRootOrdered.ts#L30)*
*Defined in [trieRootOrdered.ts:30](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-hash/src/trieRootOrdered.ts#L30)*
*__name__*: trieRootOrdered
docs/trie-hash/modules/_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ TriePair**: *`object`*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-hash/src/types.ts#L5)*
*Defined in [types.ts:5](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-hash/src/types.ts#L5)*
#### Type declaration
docs/trie-hash/modules/_unhashedtrie_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **unhashedTrie**(input: *`Array`<[TriePair](_types_.md#triepair)>*, codec?: *`Codec`*): `Uint8Array`
*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/0710c73/packages/trie-hash/src/unhashedTrie.ts#L14)*
*Defined in [unhashedTrie.ts:14](https://github.com/polkadot-js/common/blob/c3fafbe/packages/trie-hash/src/unhashedTrie.ts#L14)*
**Parameters:**
docs/util-crypto/SUMMARY.md
-2
View File
@@ -47,8 +47,6 @@
* [&quot;random/asU8a.spec&quot;](modules/_random_asu8a_spec_.md)
* [&quot;random/index&quot;](modules/_random_index_.md)
* [&quot;schnorrkel/index&quot;](modules/_schnorrkel_index_.md)
* [&quot;schnorrkel/keypair/fromRandom&quot;](modules/_schnorrkel_keypair_fromrandom_.md)
* [&quot;schnorrkel/keypair/fromRandom.spec&quot;](modules/_schnorrkel_keypair_fromrandom_spec_.md)
* [&quot;schnorrkel/keypair/fromSeed&quot;](modules/_schnorrkel_keypair_fromseed_.md)
* [&quot;schnorrkel/keypair/fromSeed.spec&quot;](modules/_schnorrkel_keypair_fromseed_spec_.md)
* [&quot;schnorrkel/schnorrkel-js/index&quot;](modules/_schnorrkel_schnorrkel_js_index_.md)
docs/util-crypto/index.html
+1 -1
View File
@@ -485,7 +485,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"util-crypto","level":"1.6","depth":1,"next":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]}]},"previous":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/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":"util-crypto/README.md","mtime":"2019-02-14T14:18:37.570Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T14:19:14.592Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"util-crypto","level":"1.6","depth":1,"next":{"title":"Keyring","level":"2.1","depth":1,"path":"examples/keyring/README.md","ref":"examples/keyring/README.md","articles":[{"title":"Create Account","level":"2.1.1","depth":2,"path":"examples/keyring/01_create_account/README.md","ref":"examples/keyring/01_create_account/README.md","articles":[]},{"title":"Load Accounts","level":"2.1.2","depth":2,"path":"examples/keyring/02_load_accounts/README.md","ref":"examples/keyring/02_load_accounts/README.md","articles":[]}]},"previous":{"title":"util","level":"1.5","depth":1,"path":"util/README.md","ref":"util/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":"util-crypto/README.md","mtime":"2019-02-14T21:11:01.347Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-14T21:11:38.452Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/util-crypto/modules/_blake2_ashex_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2AsHex**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*): `string`
*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/blake2/asHex.ts#L21)*
*Defined in [blake2/asHex.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/blake2/asHex.ts#L21)*
*__name__*: blake2AsHex
docs/util-crypto/modules/_blake2_asu8a_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2AsU8a**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*, key?: *`Uint8Array`*): `Uint8Array`
*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/blake2/asU8a.ts#L21)*
*Defined in [blake2/asU8a.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/blake2/asU8a.ts#L21)*
*__name__*: blake2AsU8a
docs/util-crypto/modules/_blake2_blake2b_ashex_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2bAsHex**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*): `string`
*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)*
*Defined in [blake2/blake2b/asHex.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/blake2/blake2b/asHex.ts#L23)*
*__name__*: blake2bAsHex
docs/util-crypto/modules/_blake2_blake2b_asu8a_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **blake2bAsU8a**(data: *`Uint8Array` | `string`*, bitLength?: *`number`*, key?: *`Uint8Array` | `null`*): `Uint8Array`
*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)*
*Defined in [blake2/blake2b/asU8a.ts:22](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/blake2/blake2b/asU8a.ts#L22)*
*__name__*: blake2bAsU8a
docs/util-crypto/modules/_keccak_ashex_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **keccakAsHex**(value: *`Buffer` | `Uint8Array` | `string`*): `string`
*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/keccak/asHex.ts#L23)*
*Defined in [keccak/asHex.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/keccak/asHex.ts#L23)*
*__name__*: keccakAsHex
docs/util-crypto/modules/_keccak_asu8a_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **keccakAsU8a**(value: *`Buffer` | `Uint8Array` | `string`*): `Uint8Array`
*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/keccak/asU8a.ts#L21)*
*Defined in [keccak/asU8a.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/keccak/asU8a.ts#L21)*
*__name__*: keccakAsU8a
docs/util-crypto/modules/_mnemonic_generate_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **mnemonicGenerate**(): `string`
*Defined in [mnemonic/generate.ts:19](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/mnemonic/generate.ts#L19)*
*Defined in [mnemonic/generate.ts:19](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/mnemonic/generate.ts#L19)*
*__name__*: mnemonicGenerate
docs/util-crypto/modules/_mnemonic_tosecret_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toSecret**(mnemonic: *`string`*): `Uint8Array`
*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/mnemonic/toSecret.ts#L8)*
*Defined in [mnemonic/toSecret.ts:8](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/mnemonic/toSecret.ts#L8)*
**Parameters:**
docs/util-crypto/modules/_mnemonic_toseed_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toSeed**(mnemonic: *`string`*): `Uint8Array`
*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/mnemonic/toSeed.ts#L24)*
*Defined in [mnemonic/toSeed.ts:24](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/mnemonic/toSeed.ts#L24)*
*__name__*: toSeed
docs/util-crypto/modules/_mnemonic_validate_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **mnemonicValidate**(mnemonic: *`string`*): `boolean`
*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/mnemonic/validate.ts#L20)*
*Defined in [mnemonic/validate.ts:20](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/mnemonic/validate.ts#L20)*
*__name__*: mnemonicValidate
docs/util-crypto/modules/_nacl_decrypt_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **naclDecrypt**(encrypted: *`Uint8Array`*, nonce: *`Uint8Array`*, secret: *`Uint8Array`*): `Uint8Array` | `null`
*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/nacl/decrypt.ts#L21)*
*Defined in [nacl/decrypt.ts:21](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/nacl/decrypt.ts#L21)*
*__name__*: naclDecrypt
docs/util-crypto/modules/_nacl_encrypt_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **naclEncrypt**(message: *`Uint8Array`*, secret: *`Uint8Array`*, nonce?: *`Uint8Array`*): `Encrypted`
*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/nacl/encrypt.ts#L28)*
*Defined in [nacl/encrypt.ts:28](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/nacl/encrypt.ts#L28)*
*__name__*: naclEncrypt
docs/util-crypto/modules/_nacl_keypair_fromrandom_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromRandom**(): [KeypairType](_types_.md#keypairtype)
*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)*
*Defined in [nacl/keypair/fromRandom.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/nacl/keypair/fromRandom.ts#L23)*
*__name__*: naclKeypairFromRandom
docs/util-crypto/modules/_nacl_keypair_fromsecret_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromSecret**(secret: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype)
*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)*
*Defined in [nacl/keypair/fromSecret.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/nacl/keypair/fromSecret.ts#L23)*
*__name__*: naclKeypairFromSecret
docs/util-crypto/modules/_nacl_keypair_fromseed_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **naclKeypairFromSeed**(seed: *`Uint8Array`*): [KeypairType](_types_.md#keypairtype)
*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/0710c73/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)*
*Defined in [nacl/keypair/fromSeed.ts:23](https://github.com/polkadot-js/common/blob/c3fafbe/packages/util-crypto/src/nacl/keypair/fromSeed.ts#L23)*
*__name__*: naclKeypairFromSeed

Some files were not shown because too many files have changed in this diff Show More