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

[CI Skip] 0.33.1

Browse Source
This commit is contained in:
Travis CI
2018-11-22 13:34:27 +00:00
parent f82092e603
commit aac39f97e3
216 changed files with 1355 additions and 814 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":"2018-11-21T14:42:19.470Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.801Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/chainspec/README.md
+6
View File
@@ -0,0 +1,6 @@
@polkadot/chainspec
===================
Chainspecs for known chains
docs/chainspec/SUMMARY.md
+2
View File
@@ -0,0 +1,2 @@
* [&quot;bbqbirch&quot;](modules/_bbqbirch_.md)
* [&quot;krummelanke&quot;](modules/_krummelanke_.md)
docs/chainspec/modules/_bbqbirch_.md
+2
View File
@@ -0,0 +1,2 @@
docs/chainspec/modules/_krummelanke_.md
+2
View File
@@ -0,0 +1,2 @@
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/477be90/packages/db/src/Disk.ts#L66)*
*Defined in [Disk.ts:66](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/Disk.ts#L66)*
**Parameters:**
@@ -98,7 +98,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/477be90/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -130,7 +130,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/477be90/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -143,7 +143,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/477be90/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -156,7 +156,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/477be90/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -175,7 +175,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/477be90/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -194,7 +194,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/477be90/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -207,7 +207,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/477be90/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -227,7 +227,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/477be90/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -247,7 +247,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/477be90/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -260,7 +260,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/477be90/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/engines/FileTreeDb.ts#L21)*
*Defined in [engines/FileTreeDb.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L21)*
___
@@ -48,7 +48,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L46)*
*Defined in [engines/FileTreeDb.ts:46](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L46)*
**Returns:** `void`
@@ -59,7 +59,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L76)*
*Defined in [engines/FileTreeDb.ts:76](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L76)*
**Parameters:**
@@ -76,7 +76,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L50)*
*Defined in [engines/FileTreeDb.ts:50](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L50)*
**Returns:** `void`
@@ -87,7 +87,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L54)*
*Defined in [engines/FileTreeDb.ts:54](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L54)*
**Returns:** `void`
@@ -98,7 +98,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L86)*
*Defined in [engines/FileTreeDb.ts:86](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L86)*
**Parameters:**
@@ -115,7 +115,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L68)*
*Defined in [engines/FileTreeDb.ts:68](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L68)*
**Parameters:**
@@ -132,7 +132,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L42)*
*Defined in [engines/FileTreeDb.ts:42](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L42)*
**Returns:** `void`
@@ -143,7 +143,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L100)*
*Defined in [engines/FileTreeDb.ts:100](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L100)*
**Parameters:**
@@ -161,7 +161,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L58)*
*Defined in [engines/FileTreeDb.ts:58](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/FileTreeDb.ts#L58)*
**Parameters:**
@@ -179,7 +179,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/FileTreeDb.ts#L62)*
*Defined in [engines/FileTreeDb.ts:62](https://github.com/polkadot-js/common/blob/f82092e/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`*, itemCount?: *`number`*): [LruDb](_engines_lrudb_.lrudb.md)
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L20)*
*Defined in [engines/LruDb.ts:20](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L20)*
**Parameters:**
@@ -37,7 +37,7 @@ ___
▸ **_getLru**(key: *`Uint8Array`*): `CachedValue` &#124; `undefined`
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L87)*
*Defined in [engines/LruDb.ts:87](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L87)*
**Parameters:**
@@ -54,7 +54,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L27)*
*Defined in [engines/LruDb.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L27)*
**Returns:** `void`
@@ -65,7 +65,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L64)*
*Defined in [engines/LruDb.ts:64](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L64)*
**Parameters:**
@@ -82,7 +82,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L41)*
*Defined in [engines/LruDb.ts:41](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L41)*
**Returns:** `void`
@@ -93,7 +93,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L45)*
*Defined in [engines/LruDb.ts:45](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L45)*
**Returns:** `void`
@@ -104,7 +104,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L71)*
*Defined in [engines/LruDb.ts:71](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L71)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L56)*
*Defined in [engines/LruDb.ts:56](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L56)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L34)*
*Defined in [engines/LruDb.ts:34](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L34)*
**Returns:** `void`
@@ -149,7 +149,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L91)*
*Defined in [engines/LruDb.ts:91](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L91)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L52)*
*Defined in [engines/LruDb.ts:52](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/LruDb.ts#L52)*
**Parameters:**
@@ -185,7 +185,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/LruDb.ts#L60)*
*Defined in [engines/LruDb.ts:60](https://github.com/polkadot-js/common/blob/f82092e/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`*): [MemoryDb](_engines_memorydb_.memorydb.md)
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L16)*
*Defined in [engines/MemoryDb.ts:16](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L16)*
**Parameters:**
@@ -36,7 +36,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L22)*
*Defined in [engines/MemoryDb.ts:22](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L22)*
**Returns:** `void`
@@ -47,7 +47,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L56)*
*Defined in [engines/MemoryDb.ts:56](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L56)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L30)*
*Defined in [engines/MemoryDb.ts:30](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L30)*
**Returns:** `void`
@@ -75,7 +75,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L34)*
*Defined in [engines/MemoryDb.ts:34](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L34)*
**Returns:** `void`
@@ -86,7 +86,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L62)*
*Defined in [engines/MemoryDb.ts:62](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L62)*
**Parameters:**
@@ -103,7 +103,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L42)*
*Defined in [engines/MemoryDb.ts:42](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L42)*
**Parameters:**
@@ -120,7 +120,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L26)*
*Defined in [engines/MemoryDb.ts:26](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L26)*
**Returns:** `void`
@@ -131,7 +131,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L68)*
*Defined in [engines/MemoryDb.ts:68](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L68)*
**Parameters:**
@@ -149,7 +149,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L38)*
*Defined in [engines/MemoryDb.ts:38](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/MemoryDb.ts#L38)*
**Parameters:**
@@ -167,7 +167,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/MemoryDb.ts#L50)*
*Defined in [engines/MemoryDb.ts:50](https://github.com/polkadot-js/common/blob/f82092e/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`*): [TransactionDb](_engines_transactiondb_.transactiondb.md)
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L21)*
*Defined in [engines/TransactionDb.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L21)*
**Parameters:**
@@ -40,7 +40,7 @@ ___
▸ **close**(): `void`
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -51,7 +51,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -68,7 +68,7 @@ ___
▸ **drop**(): `void`
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -79,7 +79,7 @@ ___
▸ **empty**(): `void`
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -90,7 +90,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -124,7 +124,7 @@ ___
▸ **open**(): `void`
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -135,7 +135,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -153,7 +153,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -171,7 +171,7 @@ ___
▸ **size**(): `number`
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -182,7 +182,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L29)*
**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/477be90/packages/db/src/FileFlatDb/Compact.ts#L17)*
*Defined in [FileFlatDb/Compact.ts:17](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/Compact.ts#L17)*
**Parameters:**
@@ -32,7 +32,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/Compact.ts#L24)*
*Defined in [FileFlatDb/Compact.ts:24](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/Compact.ts#L24)*
**Parameters:**
docs/db/classes/_fileflatdb_index_.fileflatdb.md
+11 -11
View File
@@ -16,7 +16,7 @@
⊕ **new FileFlatDb**(base: *`string`*, file?: *`string`*, options?: *`BaseDbOptions`*): [FileFlatDb](_fileflatdb_index_.fileflatdb.md)
*Defined in [FileFlatDb/index.ts:32](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L32)*
*Defined in [FileFlatDb/index.ts:32](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L32)*
**Parameters:**
@@ -38,7 +38,7 @@ ___
▸ **close**(): `void`
*Defined in [FileFlatDb/index.ts:58](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L58)*
*Defined in [FileFlatDb/index.ts:58](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L58)*
**Returns:** `void`
@@ -49,7 +49,7 @@ ___
▸ **del**(key: *`Uint8Array`*): `void`
*Defined in [FileFlatDb/index.ts:105](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L105)*
*Defined in [FileFlatDb/index.ts:105](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L105)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
▸ **drop**(): `void`
*Defined in [FileFlatDb/index.ts:68](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L68)*
*Defined in [FileFlatDb/index.ts:68](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L68)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
▸ **empty**(): `void`
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L74)*
*Defined in [FileFlatDb/index.ts:74](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L74)*
**Returns:** `void`
@@ -88,7 +88,7 @@ ___
▸ **get**(key: *`Uint8Array`*): `Uint8Array` &#124; `null`
*Defined in [FileFlatDb/index.ts:109](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L109)*
*Defined in [FileFlatDb/index.ts:109](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L109)*
**Parameters:**
@@ -105,7 +105,7 @@ ___
▸ **maintain**(fn: *`ProgressCb`*): `void`
*Defined in [FileFlatDb/index.ts:97](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L97)*
*Defined in [FileFlatDb/index.ts:97](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L97)*
**Parameters:**
@@ -122,7 +122,7 @@ ___
▸ **open**(): `void`
*Defined in [FileFlatDb/index.ts:48](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L48)*
*Defined in [FileFlatDb/index.ts:48](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L48)*
**Returns:** `void`
@@ -133,7 +133,7 @@ ___
▸ **put**(key: *`Uint8Array`*, value: *`Uint8Array`*): `void`
*Defined in [FileFlatDb/index.ts:127](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L127)*
*Defined in [FileFlatDb/index.ts:127](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L127)*
**Parameters:**
@@ -151,7 +151,7 @@ ___
▸ **rename**(base: *`string`*, file: *`string`*): `void`
*Defined in [FileFlatDb/index.ts:85](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L85)*
*Defined in [FileFlatDb/index.ts:85](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L85)*
**Parameters:**
@@ -169,7 +169,7 @@ ___
▸ **size**(): `number`
*Defined in [FileFlatDb/index.ts:81](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/FileFlatDb/index.ts#L81)*
*Defined in [FileFlatDb/index.ts:81](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/index.ts#L81)*
**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/477be90/packages/db/src/Memory.ts#L66)*
*Defined in [Memory.ts:66](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/Memory.ts#L66)*
**Parameters:**
@@ -94,7 +94,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/477be90/packages/db/src/engines/TransactionDb.ts#L51)*
*Defined in [engines/TransactionDb.ts:51](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L51)*
**Returns:** `void`
@@ -107,7 +107,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/477be90/packages/db/src/engines/TransactionDb.ts#L81)*
*Defined in [engines/TransactionDb.ts:81](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L81)*
**Parameters:**
@@ -126,7 +126,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/477be90/packages/db/src/engines/TransactionDb.ts#L59)*
*Defined in [engines/TransactionDb.ts:59](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L59)*
**Returns:** `void`
@@ -139,7 +139,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/477be90/packages/db/src/engines/TransactionDb.ts#L63)*
*Defined in [engines/TransactionDb.ts:63](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L63)*
**Returns:** `void`
@@ -152,7 +152,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/477be90/packages/db/src/engines/TransactionDb.ts#L93)*
*Defined in [engines/TransactionDb.ts:93](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L93)*
**Parameters:**
@@ -171,7 +171,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/477be90/packages/db/src/engines/TransactionDb.ts#L71)*
*Defined in [engines/TransactionDb.ts:71](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L71)*
**Parameters:**
@@ -190,7 +190,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/477be90/packages/db/src/engines/TransactionDb.ts#L55)*
*Defined in [engines/TransactionDb.ts:55](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L55)*
**Returns:** `void`
@@ -203,7 +203,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/477be90/packages/db/src/engines/TransactionDb.ts#L107)*
*Defined in [engines/TransactionDb.ts:107](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L107)*
**Parameters:**
@@ -223,7 +223,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/477be90/packages/db/src/engines/TransactionDb.ts#L67)*
*Defined in [engines/TransactionDb.ts:67](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L67)*
**Parameters:**
@@ -243,7 +243,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/477be90/packages/db/src/engines/TransactionDb.ts#L77)*
*Defined in [engines/TransactionDb.ts:77](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/engines/TransactionDb.ts#L77)*
**Returns:** `number`
@@ -256,7 +256,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/477be90/packages/db/src/engines/TransactionDb.ts#L29)*
*Defined in [engines/TransactionDb.ts:29](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/FileFlatDb/types.ts#L7)*
*Defined in [FileFlatDb/types.ts:7](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/FileFlatDb/types.ts#L6)*
*Defined in [FileFlatDb/types.ts:6](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/FileFlatDb/types.ts#L8)*
*Defined in [FileFlatDb/types.ts:8](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/types.ts#L8)*
___
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/477be90/packages/db/src/FileFlatDb/types.ts#L16)*
*Defined in [FileFlatDb/types.ts:16](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/FileFlatDb/types.ts#L11)*
*Defined in [FileFlatDb/types.ts:11](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/db/src/FileFlatDb/types.ts#L22)*
*Defined in [FileFlatDb/types.ts:22](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/FileFlatDb/types.ts#L22)*
#### 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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.474Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.805Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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":"2018-11-21T14:42:19.470Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:30:26.801Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
docs/keyring/classes/_index_.keyring.md
+14 -14
View File
@@ -29,7 +29,7 @@ Overview
⊕ **new Keyring**(): [Keyring](_index_.keyring.md)
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L33)*
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L33)*
**Returns:** [Keyring](_index_.keyring.md)
@@ -43,7 +43,7 @@ ___
**● decodeAddress**: *[decode](../modules/_address_decode_.md#decode)* = decodeAddress
*Defined in [index.ts:39](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L39)*
*Defined in [index.ts:39](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L39)*
___
<a id="encodeaddress"></a>
@@ -52,7 +52,7 @@ ___
**● encodeAddress**: *[encode](../modules/_address_encode_.md#encode)* = encodeAddress
*Defined in [index.ts:40](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L40)*
___
<a id="setaddressprefix"></a>
@@ -61,7 +61,7 @@ ___
**● setAddressPrefix**: *[setPrefix](../modules/_address_setprefix_.md#setprefix)* = setAddressPrefix
*Defined in [index.ts:41](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L41)*
*Defined in [index.ts:41](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L41)*
___
@@ -73,7 +73,7 @@ ___
▸ **addFromAddress**(address: * `string` &#124; `Uint8Array`*, meta?: *`KeyringPair$Meta`*, defaultEncoded?: *`Uint8Array`*): `KeyringPair`
*Defined in [index.ts:61](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L61)*
*Defined in [index.ts:61](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L61)*
*__name__*: addFromAddress
@@ -100,7 +100,7 @@ ___
▸ **addFromJson**(__namedParameters: *`object`*): `KeyringPair`
*Defined in [index.ts:76](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L76)*
*Defined in [index.ts:76](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L76)*
*__name__*: addFromJson
@@ -127,7 +127,7 @@ ___
▸ **addFromMnemonic**(mnemonic: *`string`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L89)*
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L89)*
*__name__*: addFromMnemonic
@@ -153,7 +153,7 @@ ___
▸ **addFromSeed**(seed: *`Uint8Array`*, meta?: *`KeyringPair$Meta`*): `KeyringPair`
*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L118)*
*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L118)*
*__name__*: addFromSeed
@@ -196,7 +196,7 @@ ___
▸ **addPair**(pair: *`KeyringPair`*): `KeyringPair`
*Defined in [index.ts:48](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L48)*
*Defined in [index.ts:48](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L48)*
*__name__*: addPair
@@ -219,7 +219,7 @@ ___
▸ **getPair**(address: * `string` &#124; `Uint8Array`*): `KeyringPair`
*Defined in [index.ts:154](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L154)*
*Defined in [index.ts:154](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L154)*
*__name__*: getPair
@@ -269,7 +269,7 @@ ___
▸ **getPairs**(): `Array`<`KeyringPair`>
*Defined in [index.ts:186](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L186)*
*Defined in [index.ts:186](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L186)*
*__name__*: getPairs
@@ -310,7 +310,7 @@ ___
▸ **getPublicKeys**(): `Array`<`Uint8Array`>
*Defined in [index.ts:196](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L196)*
*Defined in [index.ts:196](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L196)*
*__name__*: getPublicKeys
@@ -329,7 +329,7 @@ ___
▸ **removePair**(address: * `string` &#124; `Uint8Array`*): `void`
*Defined in [index.ts:211](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L211)*
*Defined in [index.ts:211](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L211)*
*__name__*: removePair
@@ -354,7 +354,7 @@ ___
▸ **toJson**(address: * `string` &#124; `Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): `KeyringPair$Json`
*Defined in [index.ts:226](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/index.ts#L226)*
*Defined in [index.ts:226](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/index.ts#L226)*
*__name__*: toJson
docs/keyring/classes/_pairs_.pairs.md
+5 -5
View File
@@ -16,7 +16,7 @@
⊕ **new Pairs**(): [Pairs](_pairs_.pairs.md)
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pairs.ts#L17)*
**Returns:** [Pairs](_pairs_.pairs.md)
@@ -30,7 +30,7 @@ ___
▸ **add**(pair: *`KeyringPair`*): `KeyringPair`
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pairs.ts#L23)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **all**(): `Array`<`KeyringPair`>
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<`KeyringPair`>
@@ -58,7 +58,7 @@ ___
▸ **get**(address: * `string` &#124; `Uint8Array`*): `KeyringPair`
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pairs.ts#L34)*
**Parameters:**
@@ -75,7 +75,7 @@ ___
▸ **remove**(address: * `string` &#124; `Uint8Array`*): `void`
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/f82092e/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":"2018-11-21T14:44:57.827Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:33:09.761Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/keyring/modules/_address_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(encoded: * `string` &#124; `Uint8Array`*, prefix?: *`Prefix`*): `Uint8Array`
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/address/decode.ts#L15)*
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/f82092e/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` &#124; `string`*, prefix?: *`Prefix`*): `string`
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/address/encode.ts#L15)*
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/f82092e/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`*): `void`
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/address/setPrefix.ts#L9)*
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/address/setPrefix.ts#L9)*
**Parameters:**
docs/keyring/modules/_pair_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(passphrase?: * `undefined` &#124; `string`*, _encrypted?: *`Uint8Array`*): `object`
*Defined in [pair/decode.ts:15](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/decode.ts#L15)*
*Defined in [pair/decode.ts:15](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/decode.ts#L15)*
**Parameters:**
docs/keyring/modules/_pair_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(secretKey: *`Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): `Uint8Array`
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/encode.ts#L10)*
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/encode.ts#L10)*
**Parameters:**
docs/keyring/modules/_pair_getmeta_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **getMeta**(state: *`PairState`*): `KeyringPair$Meta`
*Defined in [pair/getMeta.ts:8](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/getMeta.ts#L8)*
*Defined in [pair/getMeta.ts:8](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/getMeta.ts#L8)*
**Parameters:**
docs/keyring/modules/_pair_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **pair**(__namedParameters: *`object`*, meta?: *`KeyringPair$Meta`*, defaultEncoded?: *`Uint8Array`*): `KeyringPair`
*Defined in [pair/index.ts:50](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/index.ts#L50)*
*Defined in [pair/index.ts:50](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/index.ts#L50)*
*__name__*: pair
docs/keyring/modules/_pair_nobody_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **everybody**(): `KeyringPair`
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/nobody.ts#L25)*
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/nobody.ts#L25)*
**Returns:** `KeyringPair`
docs/keyring/modules/_pair_setmeta_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **setMeta**(state: *`PairState`*, meta: *`KeyringPair$Meta`*): `void`
*Defined in [pair/setMeta.ts:8](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/setMeta.ts#L8)*
*Defined in [pair/setMeta.ts:8](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/setMeta.ts#L8)*
**Parameters:**
docs/keyring/modules/_pair_tojson_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toJson**(__namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): `KeyringPair$Json`
*Defined in [pair/toJson.ts:12](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/pair/toJson.ts#L12)*
*Defined in [pair/toJson.ts:12](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/pair/toJson.ts#L12)*
**Parameters:**
docs/keyring/modules/_testing_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyring**(): `KeyringInstance`
*Defined in [testing.ts:57](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/testing.ts#L57)*
*Defined in [testing.ts:57](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/testing.ts#L57)*
*__name__*: testKeyring
docs/keyring/modules/_testingpairs_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyringPairs**(): `TestKeyringMap`
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/477be90/packages/keyring/src/testingPairs.ts#L14)*
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/f82092e/packages/keyring/src/testingPairs.ts#L14)*
**Returns:** `TestKeyringMap`
docs/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/trie-codec/README.md
+6
View File
@@ -0,0 +1,6 @@
@polkadot/trie-codec
====================
Implementation of the Substrate-specific codec for a Trie
docs/trie-codec/SUMMARY.md
+30
View File
@@ -0,0 +1,30 @@
* [&quot;NodeHeader&quot;](modules/_nodeheader_.md)
* [BranchHeader](classes/_nodeheader_.branchheader.md)
* [ExtensionHeader](classes/_nodeheader_.extensionheader.md)
* [LeafHeader](classes/_nodeheader_.leafheader.md)
* [NibbleHeader](classes/_nodeheader_.nibbleheader.md)
* [NodeHeader](classes/_nodeheader_.nodeheader.md)
* [Null](classes/_nodeheader_.null.md)
* [&quot;constants&quot;](modules/_constants_.md)
* [&quot;decode&quot;](modules/_decode_.md)
* [&quot;decode.spec&quot;](modules/_decode_spec_.md)
* [&quot;encode&quot;](modules/_encode_.md)
* [&quot;encode.spec&quot;](modules/_encode_spec_.md)
* [&quot;hashing&quot;](modules/_hashing_.md)
* [&quot;index&quot;](modules/_index_.md)
* [&quot;nibbles&quot;](modules/_nibbles_.md)
* [&quot;stream/createBranch&quot;](modules/_stream_createbranch_.md)
* [&quot;stream/createEmpty&quot;](modules/_stream_createempty_.md)
* [&quot;stream/createExtension&quot;](modules/_stream_createextension_.md)
* [&quot;stream/createLeaf&quot;](modules/_stream_createleaf_.md)
* [&quot;stream/createSubstream&quot;](modules/_stream_createsubstream_.md)
* [&quot;stream/createValue&quot;](modules/_stream_createvalue_.md)
* [&quot;stream/endBranch&quot;](modules/_stream_endbranch_.md)
* [&quot;stream/index&quot;](modules/_stream_index_.md)
* [&quot;util/fromNibbles&quot;](modules/_util_fromnibbles_.md)
* [&quot;util/fromNibbles.spec&quot;](modules/_util_fromnibbles_spec_.md)
* [&quot;util/fuseNibbles&quot;](modules/_util_fusenibbles_.md)
* [&quot;util/index&quot;](modules/_util_index_.md)
* [&quot;util/sharedPrefixLength&quot;](modules/_util_sharedprefixlength_.md)
* [&quot;util/toNibbles&quot;](modules/_util_tonibbles_.md)
* [&quot;util/toNibbles.spec&quot;](modules/_util_tonibbles_spec_.md)
docs/trie-codec/classes/_nodeheader_.branchheader.md
+38
View File
@@ -0,0 +1,38 @@
# Hierarchy
`Boolean`
**↳ BranchHeader**
# Properties
<a id="boolean"></a>
## `<Static>` Boolean
**● Boolean**: *`BooleanConstructor`*
*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:470*
___
# Methods
<a id="valueof"></a>
## valueOf
▸ **valueOf**(): `boolean`
*Inherited from Boolean.valueOf*
*Defined in /home/travis/build/polkadot-js/common/node_modules/typescript/lib/lib.es5.d.ts:461*
Returns the primitive value of the specified object.
**Returns:** `boolean`
___
docs/trie-codec/classes/_nodeheader_.extensionheader.md
+46
View File
@@ -0,0 +1,46 @@
# Hierarchy
[NibbleHeader](_nodeheader_.nibbleheader.md)
**↳ ExtensionHeader**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new ExtensionHeader**(input: *`number`*): [ExtensionHeader](_nodeheader_.extensionheader.md)
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L21)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| input | `number` |
**Returns:** [ExtensionHeader](_nodeheader_.extensionheader.md)
___
# Methods
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L27)*
**Returns:** `number`
___
docs/trie-codec/classes/_nodeheader_.leafheader.md
+46
View File
@@ -0,0 +1,46 @@
# Hierarchy
[NibbleHeader](_nodeheader_.nibbleheader.md)
**↳ LeafHeader**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new LeafHeader**(input: *`number`*): [LeafHeader](_nodeheader_.leafheader.md)
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[constructor](_nodeheader_.nibbleheader.md#constructor)*
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L21)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| input | `number` |
**Returns:** [LeafHeader](_nodeheader_.leafheader.md)
___
# Methods
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Inherited from [NibbleHeader](_nodeheader_.nibbleheader.md).[toNumber](_nodeheader_.nibbleheader.md#tonumber)*
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L27)*
**Returns:** `number`
___
docs/trie-codec/classes/_nodeheader_.nibbleheader.md
+44
View File
@@ -0,0 +1,44 @@
# Hierarchy
**NibbleHeader**
↳ [ExtensionHeader](_nodeheader_.extensionheader.md)
↳ [LeafHeader](_nodeheader_.leafheader.md)
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new NibbleHeader**(input: *`number`*): [NibbleHeader](_nodeheader_.nibbleheader.md)
*Defined in [NodeHeader.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L21)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| input | `number` |
**Returns:** [NibbleHeader](_nodeheader_.nibbleheader.md)
___
# Methods
<a id="tonumber"></a>
## toNumber
▸ **toNumber**(): `number`
*Defined in [NodeHeader.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L27)*
**Returns:** `number`
___
docs/trie-codec/classes/_nodeheader_.nodeheader.md
+76
View File
@@ -0,0 +1,76 @@
# Hierarchy
**NodeHeader**
# Constructors
<a id="constructor"></a>
## constructor
⊕ **new NodeHeader**(input?: * `null` &#124; `Uint8Array` &#124; `Array`< `null` &#124; `Uint8Array`>*): [NodeHeader](_nodeheader_.nodeheader.md)
*Defined in [NodeHeader.ts:40](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L40)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` input | `null` &#124; `Uint8Array` &#124; `Array`< `null` &#124; `Uint8Array`>|
**Returns:** [NodeHeader](_nodeheader_.nodeheader.md)
___
# Accessors
<a id="encodedlength"></a>
## encodedLength
getencodedLength(): `number`
*Defined in [NodeHeader.ts:127](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L127)*
**Returns:** `number`
___
<a id="nodetype"></a>
## nodeType
getnodeType(): `number`
*Defined in [NodeHeader.ts:149](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L149)*
**Returns:** `number`
___
<a id="value"></a>
## value
getvalue(): [Null](_nodeheader_.null.md) &#124; [BranchHeader](_nodeheader_.branchheader.md) &#124; [ExtensionHeader](_nodeheader_.extensionheader.md) &#124; [LeafHeader](_nodeheader_.leafheader.md)
*Defined in [NodeHeader.ts:153](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L153)*
**Returns:** [Null](_nodeheader_.null.md) &#124; [BranchHeader](_nodeheader_.branchheader.md) &#124; [ExtensionHeader](_nodeheader_.extensionheader.md) &#124; [LeafHeader](_nodeheader_.leafheader.md)
___
# Methods
<a id="tou8a"></a>
## toU8a
▸ **toU8a**(): `Uint8Array`
*Defined in [NodeHeader.ts:157](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/NodeHeader.ts#L157)*
**Returns:** `Uint8Array`
___
docs/trie-codec/classes/_nodeheader_.null.md
+6
View File
@@ -0,0 +1,6 @@
# Hierarchy
**Null**
docs/trie-codec/modules/_constants_.md
+140
View File
@@ -0,0 +1,140 @@
# Variables
<a id="branch_node_no_value"></a>
## `<Const>` BRANCH_NODE_NO_VALUE
**● BRANCH_NODE_NO_VALUE**: *`254`* = 254
*Defined in [constants.ts:10](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L10)*
___
<a id="branch_node_with_value"></a>
## `<Const>` BRANCH_NODE_WITH_VALUE
**● BRANCH_NODE_WITH_VALUE**: *`255`* = 255
*Defined in [constants.ts:11](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L11)*
___
<a id="empty_trie"></a>
## `<Const>` EMPTY_TRIE
**● EMPTY_TRIE**: *`0`* = 0
*Defined in [constants.ts:5](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L5)*
___
<a id="extension_node_big"></a>
## `<Const>` EXTENSION_NODE_BIG
**● EXTENSION_NODE_BIG**: *`253`* = 253
*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L9)*
___
<a id="extension_node_offset"></a>
## `<Const>` EXTENSION_NODE_OFFSET
**● EXTENSION_NODE_OFFSET**: *`128`* = 128
*Defined in [constants.ts:8](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L8)*
___
<a id="extension_node_small_max"></a>
## `<Const>` EXTENSION_NODE_SMALL_MAX
**● EXTENSION_NODE_SMALL_MAX**: *`number`* = EXTENSION_NODE_BIG - 1
*Defined in [constants.ts:15](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L15)*
___
<a id="extension_node_threshold"></a>
## `<Const>` EXTENSION_NODE_THRESHOLD
**● EXTENSION_NODE_THRESHOLD**: *`number`* = EXTENSION_NODE_BIG - EXTENSION_NODE_OFFSET
*Defined in [constants.ts:13](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L13)*
___
<a id="leaf_node_big"></a>
## `<Const>` LEAF_NODE_BIG
**● LEAF_NODE_BIG**: *`127`* = 127
*Defined in [constants.ts:7](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L7)*
___
<a id="leaf_node_offset"></a>
## `<Const>` LEAF_NODE_OFFSET
**● LEAF_NODE_OFFSET**: *`1`* = 1
*Defined in [constants.ts:6](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L6)*
___
<a id="leaf_node_small_max"></a>
## `<Const>` LEAF_NODE_SMALL_MAX
**● LEAF_NODE_SMALL_MAX**: *`number`* = LEAF_NODE_BIG - 1
*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L14)*
___
<a id="leaf_node_threshold"></a>
## `<Const>` LEAF_NODE_THRESHOLD
**● LEAF_NODE_THRESHOLD**: *`number`* = LEAF_NODE_BIG - LEAF_NODE_OFFSET
*Defined in [constants.ts:12](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L12)*
___
<a id="node_type_branch"></a>
## `<Const>` NODE_TYPE_BRANCH
**● NODE_TYPE_BRANCH**: *`1`* = 1
*Defined in [constants.ts:17](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L17)*
___
<a id="node_type_ext"></a>
## `<Const>` NODE_TYPE_EXT
**● NODE_TYPE_EXT**: *`2`* = 2
*Defined in [constants.ts:18](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L18)*
___
<a id="node_type_leaf"></a>
## `<Const>` NODE_TYPE_LEAF
**● NODE_TYPE_LEAF**: *`3`* = 3
*Defined in [constants.ts:19](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L19)*
___
<a id="node_type_null"></a>
## `<Const>` NODE_TYPE_NULL
**● NODE_TYPE_NULL**: *`0`* = 0
*Defined in [constants.ts:16](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/constants.ts#L16)*
___
docs/trie-codec/modules/_decode_.md
+22
View File
@@ -0,0 +1,22 @@
# Functions
<a id="decode"></a>
## decode
▸ **decode**(input: * `null` &#124; `Uint8Array`*): `Uint8Array` &#124; `null` &#124; `Array`< `null` &#124; `Uint8Array` &#124; `Array`< `null` &#124; `Uint8Array`>>
*Defined in [decode.ts:86](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/decode.ts#L86)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| input | `null` &#124; `Uint8Array`|
**Returns:** `Uint8Array` &#124; `null` &#124; `Array`< `null` &#124; `Uint8Array` &#124; `Array`< `null` &#124; `Uint8Array`>>
___
docs/trie-codec/modules/_decode_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-codec/modules/_encode_.md
+22
View File
@@ -0,0 +1,22 @@
# Functions
<a id="encode"></a>
## encode
▸ **encode**(input?: * `null` &#124; `Uint8Array` &#124; `Array`< `null` &#124; `Uint8Array`>*): `Uint8Array`
*Defined in [encode.ts:94](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/encode.ts#L94)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` input | `null` &#124; `Uint8Array` &#124; `Array`< `null` &#124; `Uint8Array`>|
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_encode_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-codec/modules/_hashing_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-codec/modules/_index_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-codec/modules/_nibbles_.md
+124
View File
@@ -0,0 +1,124 @@
# Functions
<a id="addnibblesterminator"></a>
## addNibblesTerminator
▸ **addNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:31](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L31)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `Uint8Array`
___
<a id="decodenibbles"></a>
## decodeNibbles
▸ **decodeNibbles**(value: * `null` &#124; `Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:52](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L52)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| value | `null` &#124; `Uint8Array`|
**Returns:** `Uint8Array`
___
<a id="encodenibbles"></a>
## encodeNibbles
▸ **encodeNibbles**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:65](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L65)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `Uint8Array`
___
<a id="extractkey"></a>
## extractKey
▸ **extractKey**(key: * `null` &#124; `Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:15](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L15)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `null` &#124; `Uint8Array`|
**Returns:** `Uint8Array`
___
<a id="extractnodekey"></a>
## extractNodeKey
▸ **extractNodeKey**(__namedParameters: *[`null` &#124; `Uint8Array`]*): `Uint8Array`
*Defined in [nibbles.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L21)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| __namedParameters | [`null` &#124; `Uint8Array`] |
**Returns:** `Uint8Array`
___
<a id="isnibblesterminated"></a>
## isNibblesTerminated
▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean`
*Defined in [nibbles.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L27)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `boolean`
___
<a id="removenibblesterminator"></a>
## removeNibblesTerminator
▸ **removeNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [nibbles.ts:44](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/nibbles.ts#L44)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_nodeheader_.md
+15
View File
@@ -0,0 +1,15 @@
# Index
### Classes
* [BranchHeader](../classes/_nodeheader_.branchheader.md)
* [ExtensionHeader](../classes/_nodeheader_.extensionheader.md)
* [LeafHeader](../classes/_nodeheader_.leafheader.md)
* [NibbleHeader](../classes/_nodeheader_.nibbleheader.md)
* [NodeHeader](../classes/_nodeheader_.nodeheader.md)
* [Null](../classes/_nodeheader_.null.md)
---
docs/trie-codec/modules/_stream_createbranch_.md
+23
View File
@@ -0,0 +1,23 @@
# Functions
<a id="createbranch"></a>
## createBranch
▸ **createBranch**(value: * `Uint8Array` &#124; `null`*, hasChildren: *`Array`<`boolean`>*): `Uint8Array`
*Defined in [stream/createBranch.ts:10](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/createBranch.ts#L10)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| value | `Uint8Array` &#124; `null`|
| hasChildren | `Array`<`boolean`> |
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_createempty_.md
+16
View File
@@ -0,0 +1,16 @@
# Functions
<a id="createempty"></a>
## createEmpty
▸ **createEmpty**(): `Uint8Array`
*Defined in [stream/createEmpty.ts:7](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/createEmpty.ts#L7)*
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_createextension_.md
+22
View File
@@ -0,0 +1,22 @@
# Functions
<a id="createextension"></a>
## createExtension
▸ **createExtension**(key: *`Uint8Array`*): `Uint8Array`
*Defined in [stream/createExtension.ts:7](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/createExtension.ts#L7)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `Uint8Array` |
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_createleaf_.md
+23
View File
@@ -0,0 +1,23 @@
# Functions
<a id="createleaf"></a>
## createLeaf
▸ **createLeaf**(key: *`Uint8Array`*, value: *`Uint8Array`*): `Uint8Array`
*Defined in [stream/createLeaf.ts:10](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/createLeaf.ts#L10)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `Uint8Array` |
| value | `Uint8Array` |
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_createsubstream_.md
+22
View File
@@ -0,0 +1,22 @@
# Functions
<a id="createsubstream"></a>
## createSubstream
▸ **createSubstream**(value: *`Uint8Array`*): `Uint8Array`
*Defined in [stream/createSubstream.ts:8](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/createSubstream.ts#L8)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| value | `Uint8Array` |
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_createvalue_.md
+22
View File
@@ -0,0 +1,22 @@
# Functions
<a id="createvalue"></a>
## createValue
▸ **createValue**(value: * `null` &#124; `Uint8Array`*): `Uint8Array`
*Defined in [stream/createValue.ts:9](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/createValue.ts#L9)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| value | `null` &#124; `Uint8Array`|
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_endbranch_.md
+22
View File
@@ -0,0 +1,22 @@
# Functions
<a id="encbranch"></a>
## encBranch
▸ **encBranch**(value: * `Uint8Array` &#124; `null`*): `Uint8Array`
*Defined in [stream/endBranch.ts:7](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/stream/endBranch.ts#L7)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| value | `Uint8Array` &#124; `null`|
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_stream_index_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-hash/modules/_util_fromnibbles_.md → docs/trie-codec/modules/_util_fromnibbles_.md
+5 -5
View File
@@ -6,9 +6,9 @@
## fromNibbles
▸ **fromNibbles**(nibbles: * `Uint8Array` &#124; `Array`<`number`>*): `Uint8Array`
▸ **fromNibbles**(input: *`Uint8Array`*): `Uint8Array`
*Defined in [util/fromNibbles.ts:20](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/util/fromNibbles.ts#L20)*
*Defined in [util/fromNibbles.ts:20](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/util/fromNibbles.ts#L20)*
*__name__*: fromNibbles
@@ -21,16 +21,16 @@
*__example__*:
```javascript
import { fromNibbles } from '@polkadot/trie-hash/util';
import { fromNibbles } from '@polkadot/trie-codec/util';
asNibbles(new Uint8Array([4, 1, 2, 0])); // => Uint8Array([0x41, 0x20]
fromNibbles(new Uint8Array([4, 1, 2, 0])); // => Uint8Array([0x41, 0x20]
```
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` &#124; `Array`<`number`>|
| input | `Uint8Array` |
**Returns:** `Uint8Array`
docs/trie-codec/modules/_util_fromnibbles_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-codec/modules/_util_fusenibbles_.md
+23
View File
@@ -0,0 +1,23 @@
# Functions
<a id="fusenibbles"></a>
## fuseNibbles
▸ **fuseNibbles**(nibbles: *`Uint8Array`*, isLeaf: *`boolean`*): `Uint8Array`
*Defined in [util/fuseNibbles.ts:12](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/util/fuseNibbles.ts#L12)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
| isLeaf | `boolean` |
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_util_index_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-codec/modules/_util_sharedprefixlength_.md
+23
View File
@@ -0,0 +1,23 @@
# Functions
<a id="sharedprefixlength"></a>
## sharedPrefixLength
▸ **sharedPrefixLength**(first: *`Uint8Array`*, second: *`Uint8Array`*): `number`
*Defined in [util/sharedPrefixLength.ts:5](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/util/sharedPrefixLength.ts#L5)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| first | `Uint8Array` |
| second | `Uint8Array` |
**Returns:** `number`
___
docs/trie-codec/modules/_util_tonibbles_.md
+38
View File
@@ -0,0 +1,38 @@
# Functions
<a id="tonibbles"></a>
## toNibbles
▸ **toNibbles**(input?: * `Uint8Array` &#124; `null`*): `Uint8Array`
*Defined in [util/toNibbles.ts:20](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-codec/src/util/toNibbles.ts#L20)*
*__name__*: toNibbles
*__signature__*: toNibbles (input: Uint8Array): Uint8Array
*__summary__*: Converts the input to Nibbles.
*__description__*: From an `Uint8Array` input, calculate and return a list of nibbles that makes up the input.
*__example__*:
```javascript
import { toNibbles } from '@polkadot/trie-codec/util';
toNibbles(new Uint8Array([0x41, 0x20]); // => Uint8Array([4, 1, 2, 0])
```
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` input | `Uint8Array` &#124; `null`|
**Returns:** `Uint8Array`
___
docs/trie-codec/modules/_util_tonibbles_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/README.md
+1 -1
View File
@@ -4,7 +4,7 @@
A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.
This is a JavaScript port of the [Python Ethereum Trie](https://github.com/ethereum/py-trie) with additions to support transactions (checkpoints) and multiple hashing (npot only Keccak, but also Blake2 as found in Polkadot).
This is a JavaScript port of the [Python Ethereum Trie](https://github.com/ethereum/py-trie) with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.
Usage
-----
docs/trie-db/SUMMARY.md
+6 -1
View File
@@ -1,10 +1,15 @@
* [&quot;constants&quot;](modules/_constants_.md)
* [&quot;ethereum.spec&quot;](modules/_ethereum_spec_.md)
* [&quot;ethereumCodec&quot;](modules/_ethereumcodec_.md)
* [&quot;genesis.spec&quot;](modules/_genesis_spec_.md)
* [&quot;index&quot;](modules/_index_.md)
* [Trie](classes/_index_.trie.md)
* [&quot;index.spec&quot;](modules/_index_spec_.md)
* [&quot;snapshot.spec&quot;](modules/_snapshot_spec_.md)
* [&quot;subtrate.spec&quot;](modules/_subtrate_spec_.md)
* [&quot;types&quot;](modules/_types_.md)
* [NodeType](enums/_types_.nodetype.md)
* [TrieDb](interfaces/_types_.triedb.md)
* [&quot;util/is&quot;](modules/_util_is_.md)
* [&quot;util/key&quot;](modules/_util_key_.md)
* [&quot;util/nibbles&quot;](modules/_util_nibbles_.md)
* [&quot;util/node&quot;](modules/_util_node_.md)
docs/trie-db/classes/_index_.trie.md
+21 -20
View File
@@ -25,16 +25,17 @@ Overview
## constructor
⊕ **new Trie**(db?: *`TxDb`*, rootHash?: *`Uint8Array`*): [Trie](_index_.trie.md)
⊕ **new Trie**(db?: *`TxDb`*, rootHash?: *`Uint8Array`*, codec?: *`Codec`*): [Trie](_index_.trie.md)
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L33)*
*Defined in [index.ts:36](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L36)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| `Optional` db | `TxDb` | - |
| `Default value` rootHash | `Uint8Array` | EMPTY_HASH |
| `Default value` db | `TxDb` | new MemoryDb() |
| `Optional` rootHash | `Uint8Array` | - |
| `Default value` codec | `Codec` | substrateCodec |
**Returns:** [Trie](_index_.trie.md)
@@ -50,7 +51,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[db](../interfaces/_types_.triedb.md#db)*
*Defined in [index.ts:31](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L31)*
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L32)*
___
@@ -64,7 +65,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[close](../interfaces/_types_.triedb.md#close)*
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L81)*
*Defined in [index.ts:88](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L88)*
**Returns:** `void`
@@ -77,7 +78,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[del](../interfaces/_types_.triedb.md#del)*
*Defined in [index.ts:105](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L105)*
*Defined in [index.ts:112](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L112)*
**Parameters:**
@@ -96,7 +97,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[drop](../interfaces/_types_.triedb.md#drop)*
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L89)*
*Defined in [index.ts:96](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L96)*
**Returns:** `void`
@@ -109,7 +110,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[empty](../interfaces/_types_.triedb.md#empty)*
*Defined in [index.ts:85](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L85)*
*Defined in [index.ts:92](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L92)*
**Returns:** `void`
@@ -122,7 +123,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[get](../interfaces/_types_.triedb.md#get)*
*Defined in [index.ts:116](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L116)*
*Defined in [index.ts:123](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L123)*
**Parameters:**
@@ -139,7 +140,7 @@ ___
▸ **getNode**(hash?: *`Uint8Array`*): [Node](../modules/_types_.md#node)
*Defined in [index.ts:147](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L147)*
*Defined in [index.ts:154](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L154)*
**Parameters:**
@@ -158,7 +159,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[getRoot](../interfaces/_types_.triedb.md#getroot)*
*Defined in [index.ts:137](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L137)*
*Defined in [index.ts:144](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L144)*
**Returns:** `Uint8Array`
@@ -171,7 +172,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[maintain](../interfaces/_types_.triedb.md#maintain)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L93)*
*Defined in [index.ts:100](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L100)*
**Parameters:**
@@ -190,7 +191,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[open](../interfaces/_types_.triedb.md#open)*
*Defined in [index.ts:77](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L77)*
*Defined in [index.ts:84](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L84)*
**Returns:** `void`
@@ -203,7 +204,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[put](../interfaces/_types_.triedb.md#put)*
*Defined in [index.ts:125](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L125)*
*Defined in [index.ts:132](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L132)*
**Parameters:**
@@ -223,7 +224,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[rename](../interfaces/_types_.triedb.md#rename)*
*Defined in [index.ts:97](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L97)*
*Defined in [index.ts:104](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L104)*
**Parameters:**
@@ -243,7 +244,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[setRoot](../interfaces/_types_.triedb.md#setroot)*
*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L151)*
*Defined in [index.ts:158](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L158)*
**Parameters:**
@@ -262,7 +263,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[size](../interfaces/_types_.triedb.md#size)*
*Defined in [index.ts:101](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L101)*
*Defined in [index.ts:108](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L108)*
**Returns:** `number`
@@ -275,7 +276,7 @@ ___
*Implementation of [TrieDb](../interfaces/_types_.triedb.md).[snapshot](../interfaces/_types_.triedb.md#snapshot)*
*Defined in [index.ts:156](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L156)*
*Defined in [index.ts:163](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L163)*
**Parameters:**
@@ -293,7 +294,7 @@ ___
▸ **transaction**(fn: *`function`*): `boolean`
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/index.ts#L57)*
*Defined in [index.ts:64](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/index.ts#L64)*
**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/477be90/packages/trie-db/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/trie-db/src/types.ts#L8)*
*Defined in [types.ts:8](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/trie-db/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/polkadot-js/common/blob/f82092e/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/477be90/packages/trie-db/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L9)*
___
docs/trie-db/index.html
+2 -2
View File
@@ -330,7 +330,7 @@
<h1 id="polkadottrie-db">@polkadot/trie-db</h1>
<p>A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.</p>
<p>This is a JavaScript port of the <a href="https://github.com/ethereum/py-trie" target="_blank">Python Ethereum Trie</a> with additions to support transactions (checkpoints) and multiple hashing (npot only Keccak, but also Blake2 as found in Polkadot).</p>
<p>This is a JavaScript port of the <a href="https://github.com/ethereum/py-trie" target="_blank">Python Ethereum Trie</a> with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.</p>
<h2 id="usage">Usage</h2>
<p>Installation -</p>
<pre><code>yarn add @polkadot/trie-db
@@ -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":"2018-11-21T14:45:06.207Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:33:24.072Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"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/477be90/packages/trie-db/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/f82092e/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.d.ts:18](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L18)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:18](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L18)*
**Returns:** `void`
@@ -45,7 +45,7 @@ ___
*Inherited from BaseDb.del*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:26](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L26)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:26](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L26)*
**Parameters:**
@@ -64,7 +64,7 @@ ___
*Inherited from BaseDb.drop*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:20](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L20)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:20](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L20)*
**Returns:** `void`
@@ -77,7 +77,7 @@ ___
*Inherited from BaseDb.empty*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:21](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L21)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:21](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L21)*
**Returns:** `void`
@@ -90,7 +90,7 @@ ___
*Inherited from BaseDb.get*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:27](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L27)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L27)*
**Parameters:**
@@ -107,7 +107,7 @@ ___
▸ **getRoot**(): `Uint8Array`
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L39)*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/f82092e/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.d.ts:22](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L22)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:22](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L22)*
**Parameters:**
@@ -139,7 +139,7 @@ ___
*Inherited from BaseDb.open*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:19](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L19)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:19](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L19)*
**Returns:** `void`
@@ -152,7 +152,7 @@ ___
*Inherited from BaseDb.put*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:28](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L28)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:28](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L28)*
**Parameters:**
@@ -172,7 +172,7 @@ ___
*Inherited from BaseDb.rename*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:23](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L23)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:23](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L23)*
**Parameters:**
@@ -190,7 +190,7 @@ ___
▸ **setRoot**(rootHash: *`Uint8Array`*): `void`
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/f82092e/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.d.ts:24](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L24)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:24](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.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/477be90/packages/trie-db/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/f82092e/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.d.ts:32](https://github.com/polkadot-js/common/blob/477be90/packages/db/src/types.d.ts#L32)*
*Defined in [/home/travis/build/polkadot-js/common/packages/db/src/types.d.ts:32](https://github.com/polkadot-js/common/blob/f82092e/packages/db/src/types.d.ts#L32)*
**Parameters:**
docs/trie-db/modules/_constants_.md
+34
View File
@@ -1,2 +1,36 @@
# Type aliases
<a id="constants"></a>
## Constants
**Ƭ Constants**: *`object`*
*Defined in [constants.ts:9](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/constants.ts#L9)*
#### Type declaration
___
# Functions
<a id="default"></a>
## default
▸ **default**(codec: *`Codec`*): `object`
*Defined in [constants.ts:14](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/constants.ts#L14)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| codec | `Codec` |
**Returns:** `object`
___
docs/trie-db/modules/_ethereum_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/modules/_ethereumcodec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/modules/_genesis_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/modules/_index_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/modules/_snapshot_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/modules/_subtrate_spec_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-db/modules/_types_.md
+8 -8
View File
@@ -32,7 +32,7 @@
**Ƭ EncodedPath**: * `Uint8Array` &#124; `null`
*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L28)*
*Defined in [types.ts:28](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L28)*
___
<a id="node"></a>
@@ -42,7 +42,7 @@ ___
**Ƭ Node**: * [NodeEmpty](_types_.md#nodeempty) &#124; [NodeNotEmpty](_types_.md#nodenotempty)
*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L34)*
___
<a id="nodebranch"></a>
@@ -51,7 +51,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/477be90/packages/trie-db/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L20)*
___
<a id="nodeempty"></a>
@@ -60,7 +60,7 @@ ___
**Ƭ NodeEmpty**: *`null`*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L14)*
___
<a id="nodeencoded"></a>
@@ -69,7 +69,7 @@ ___
**Ƭ NodeEncoded**: *`Uint8Array`*
*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L16)*
*Defined in [types.ts:16](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L16)*
___
<a id="nodeencodedorempty"></a>
@@ -79,7 +79,7 @@ ___
**Ƭ NodeEncodedOrEmpty**: * [NodeEncoded](_types_.md#nodeencoded) &#124; [NodeEmpty](_types_.md#nodeempty)
*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L18)*
___
<a id="nodekv"></a>
@@ -88,7 +88,7 @@ ___
**Ƭ NodeKv**: *[[EncodedPath](_types_.md#encodedpath), [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)]*
*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L30)*
*Defined in [types.ts:30](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/types.ts#L30)*
___
<a id="nodenotempty"></a>
@@ -98,7 +98,7 @@ ___
**Ƭ NodeNotEmpty**: * [NodeKv](_types_.md#nodekv) &#124; [NodeBranch](_types_.md#nodebranch)
*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/types.ts#L32)*
*Defined in [types.ts:32](https://github.com/polkadot-js/common/blob/f82092e/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:57](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/is.ts#L57)*
*Defined in [util/is.ts:57](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/is.ts#L57)*
*__name__*: isBranchNode
@@ -33,7 +33,7 @@ ___
▸ **isEmptyNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:17](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/is.ts#L17)*
*Defined in [util/is.ts:17](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/is.ts#L17)*
*__name__*: isEmptyNode
@@ -58,7 +58,7 @@ ___
▸ **isExtensionNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:37](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/is.ts#L37)*
*Defined in [util/is.ts:37](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/is.ts#L37)*
*__name__*: isExtensionNode
@@ -83,7 +83,7 @@ ___
▸ **isKvNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:27](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/is.ts#L27)*
*Defined in [util/is.ts:27](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/is.ts#L27)*
*__name__*: isKvNode
@@ -108,7 +108,7 @@ ___
▸ **isLeafNode**(node: *[Node](_types_.md#node)*): `boolean`
*Defined in [util/is.ts:47](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/is.ts#L47)*
*Defined in [util/is.ts:47](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/is.ts#L47)*
*__name__*: isLeafNode
docs/trie-db/modules/_util_key_.md
+6 -23
View File
@@ -8,7 +8,7 @@
▸ **computeExtensionKey**(nibbles: *`Uint8Array`*): [EncodedPath](_types_.md#encodedpath)
*Defined in [util/key.ts:50](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L50)*
*Defined in [util/key.ts:36](https://github.com/polkadot-js/common/blob/f82092e/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:54](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L54)*
*Defined in [util/key.ts:40](https://github.com/polkadot-js/common/blob/f82092e/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:70](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L70)*
*Defined in [util/key.ts:56](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/key.ts#L56)*
**Parameters:**
@@ -53,23 +53,6 @@ ___
**Returns:** [`Uint8Array`, `Uint8Array`, `Uint8Array`]
___
<a id="extractkey"></a>
## extractKey
▸ **extractKey**(node: *[Node](_types_.md#node)*): `Uint8Array`
*Defined in [util/key.ts:12](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L12)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| node | [Node](_types_.md#node) |
**Returns:** `Uint8Array`
___
<a id="getcommonprefixlength"></a>
@@ -77,7 +60,7 @@ ___
▸ **getCommonPrefixLength**(left: *`Uint8Array`*, right: *`Uint8Array`*): `number`
*Defined in [util/key.ts:60](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L60)*
*Defined in [util/key.ts:46](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/key.ts#L46)*
**Parameters:**
@@ -95,7 +78,7 @@ ___
▸ **keyEquals**(key: * `Uint8Array` &#124; `null`*, test: * `Uint8Array` &#124; `null`*): `boolean`
*Defined in [util/key.ts:24](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L24)*
*Defined in [util/key.ts:10](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/key.ts#L10)*
**Parameters:**
@@ -113,7 +96,7 @@ ___
▸ **keyStartsWith**(key: * `Uint8Array` &#124; `null`*, partial: * `Uint8Array` &#124; `null`*): `boolean`
*Defined in [util/key.ts:34](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/key.ts#L34)*
*Defined in [util/key.ts:20](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/key.ts#L20)*
**Parameters:**
docs/trie-db/modules/_util_nibbles_.md
-90
View File
@@ -1,90 +0,0 @@
# Functions
<a id="addnibblesterminator"></a>
## addNibblesTerminator
▸ **addNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [util/nibbles.ts:22](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/nibbles.ts#L22)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `Uint8Array`
___
<a id="decodenibbles"></a>
## decodeNibbles
▸ **decodeNibbles**(value: *[NodeEncodedOrEmpty](_types_.md#nodeencodedorempty)*): `Uint8Array`
*Defined in [util/nibbles.ts:43](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/nibbles.ts#L43)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| value | [NodeEncodedOrEmpty](_types_.md#nodeencodedorempty) |
**Returns:** `Uint8Array`
___
<a id="encodenibbles"></a>
## encodeNibbles
▸ **encodeNibbles**(nibbles: *`Uint8Array`*): [NodeEncoded](_types_.md#nodeencoded)
*Defined in [util/nibbles.ts:56](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/nibbles.ts#L56)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** [NodeEncoded](_types_.md#nodeencoded)
___
<a id="isnibblesterminated"></a>
## isNibblesTerminated
▸ **isNibblesTerminated**(nibbles: *`Uint8Array`*): `boolean`
*Defined in [util/nibbles.ts:18](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/nibbles.ts#L18)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `boolean`
___
<a id="removenibblesterminator"></a>
## removeNibblesTerminator
▸ **removeNibblesTerminator**(nibbles: *`Uint8Array`*): `Uint8Array`
*Defined in [util/nibbles.ts:35](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/nibbles.ts#L35)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` |
**Returns:** `Uint8Array`
___
docs/trie-db/modules/_util_node_.md
+7 -5
View File
@@ -6,14 +6,15 @@
## decodeNode
▸ **decodeNode**(encoded: * `Uint8Array` &#124; [Node](_types_.md#node)*): [Node](_types_.md#node)
▸ **decodeNode**(codec: *`Codec`*, encoded: * `Uint8Array` &#124; [Node](_types_.md#node)*): [Node](_types_.md#node)
*Defined in [util/node.ts:31](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/node.ts#L31)*
*Defined in [util/node.ts:30](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/node.ts#L30)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| codec | `Codec` |
| encoded | `Uint8Array` &#124; [Node](_types_.md#node)|
**Returns:** [Node](_types_.md#node)
@@ -23,14 +24,15 @@ ___
## encodeNode
▸ **encodeNode**(node: *[Node](_types_.md#node)*): `Uint8Array`
▸ **encodeNode**(codec: *`Codec`*, node: *[Node](_types_.md#node)*): `Uint8Array`
*Defined in [util/node.ts:48](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/node.ts#L48)*
*Defined in [util/node.ts:46](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/node.ts#L46)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| codec | `Codec` |
| node | [Node](_types_.md#node) |
**Returns:** `Uint8Array`
@@ -42,7 +44,7 @@ ___
▸ **getNodeType**(node: *[Node](_types_.md#node)*): [NodeType](../enums/_types_.nodetype.md)
*Defined in [util/node.ts:14](https://github.com/polkadot-js/common/blob/477be90/packages/trie-db/src/util/node.ts#L14)*
*Defined in [util/node.ts:13](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-db/src/util/node.ts#L13)*
**Parameters:**
docs/trie-hash/README.md
+3 -18
View File
@@ -2,7 +2,7 @@
@polkadot/trie-hash
===================
Calculate ordered and unordered [Ethereum Trie hashes](https://github.com/ethereum/wiki/wiki/Patricia-Tree) from inputs.
Calculate ordered and unordered [Trie hashes](https://github.com/ethereum/wiki/wiki/Patricia-Tree) from inputs.
Usage
-----
@@ -26,21 +26,6 @@ Below is a list of currently exposed methods published at the [Polkadot-JS Commo
* [trie-hash](https://polkadot.js.org/common/trie-hash/README.md)
* Functions
* Encode
* [encode](https://polkadot.js.org/common/trie-hash/modules/_encode_index_.md)
* [encodeAux](https://polkadot.js.org/common/trie-hash/modules/_encode_aux_.md)
* [encodeHexPrefix](https://polkadot.js.org/common/trie-hash/modules/_encode_hexprefix_.md)
* [encodePairs](https://polkadot.js.org/common/trie-hash/modules/_encode_pairs_.md)
* [encodeShared](https://polkadot.js.org/common/trie-hash/modules/_encode_shared_.md)
* [encodeSingle](https://polkadot.js.org/common/trie-hash/modules/_encode_single_.md)
* Trie Root
* [trieRoot](https://polkadot.js.org/common/trie-hash/modules/_root_.md)
* [trieRootOrdered](https://polkadot.js.org/common/trie-hash/modules/_rootordered_.md)
* Util
* [asNibbles](https://polkadot.js.org/common/trie-hash/modules/_util_asnibbles_.md)
* [fromNibbles](https://polkadot.js.org/common/trie-hash/modules/_util_fromnibbles_.md)
* [genRoot](https://polkadot.js.org/common/trie-hash/modules/_util_genroot_.md)
* [getSharedLength](https://polkadot.js.org/common/trie-hash/modules/_util_sharedlength_.md)
* [pairsUniq](https://polkadot.js.org/common/trie-hash/modules/_util_pairsuniq_.md)
* [sharedPrefixLength](https://polkadot.js.org/common/trie-hash/modules/_util_sharedprefixlength_.md)
* [trieRoot](https://polkadot.js.org/common/trie-hash/modules/_trieroot_.md)
* [trieRootOrdered](https://polkadot.js.org/common/trie-hash/modules/_trierootordered_.md)
docs/trie-hash/SUMMARY.md
+9 -14
View File
@@ -1,15 +1,10 @@
* [&quot;encode/aux&quot;](modules/_encode_aux_.md)
* [&quot;encode/hexPrefix&quot;](modules/_encode_hexprefix_.md)
* [&quot;encode/index&quot;](modules/_encode_index_.md)
* [&quot;encode/pairs&quot;](modules/_encode_pairs_.md)
* [&quot;encode/shared&quot;](modules/_encode_shared_.md)
* [&quot;encode/single&quot;](modules/_encode_single_.md)
* [&quot;buildTrie&quot;](modules/_buildtrie_.md)
* [&quot;defaults&quot;](modules/_defaults_.md)
* [&quot;genesis.spec&quot;](modules/_genesis_spec_.md)
* [&quot;index&quot;](modules/_index_.md)
* [&quot;root&quot;](modules/_root_.md)
* [&quot;rootOrdered&quot;](modules/_rootordered_.md)
* [&quot;util/asNibbles&quot;](modules/_util_asnibbles_.md)
* [&quot;util/fromNibbles&quot;](modules/_util_fromnibbles_.md)
* [&quot;util/genRoot&quot;](modules/_util_genroot_.md)
* [&quot;util/pairsUniq&quot;](modules/_util_pairsuniq_.md)
* [&quot;util/sharedLength&quot;](modules/_util_sharedlength_.md)
* [&quot;util/sharedPrefixLength&quot;](modules/_util_sharedprefixlength_.md)
* [&quot;trieRoot&quot;](modules/_trieroot_.md)
* [&quot;trieRoot.spec&quot;](modules/_trieroot_spec_.md)
* [&quot;trieRootOrdered&quot;](modules/_trierootordered_.md)
* [&quot;trieRootOrdered.spec&quot;](modules/_trierootordered_spec_.md)
* [&quot;unhashedTrie&quot;](modules/_unhashedtrie_.md)
* [&quot;unhashedTrie.spec&quot;](modules/_unhashedtrie_spec_.md)
docs/trie-hash/index.html
+4 -25
View File
@@ -329,7 +329,7 @@
<section class="normal markdown-section">
<h1 id="polkadottrie-hash">@polkadot/trie-hash</h1>
<p>Calculate ordered and unordered <a href="https://github.com/ethereum/wiki/wiki/Patricia-Tree" target="_blank">Ethereum Trie hashes</a> from inputs.</p>
<p>Calculate ordered and unordered <a href="https://github.com/ethereum/wiki/wiki/Patricia-Tree" target="_blank">Trie hashes</a> from inputs.</p>
<h2 id="usage">Usage</h2>
<p>Installation -</p>
<pre><code>yarn add @polkadot/trie-hash
@@ -341,29 +341,8 @@
<ul>
<li><a href="https://polkadot.js.org/common/trie-hash/README.md" target="_blank">trie-hash</a><ul>
<li>Functions<ul>
<li>Encode<ul>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_encode_index_.md" target="_blank">encode</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_encode_aux_.md" target="_blank">encodeAux</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_encode_hexprefix_.md" target="_blank">encodeHexPrefix</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_encode_pairs_.md" target="_blank">encodePairs</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_encode_shared_.md" target="_blank">encodeShared</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_encode_single_.md" target="_blank">encodeSingle</a></li>
</ul>
</li>
<li>Trie Root<ul>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_root_.md" target="_blank">trieRoot</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_rootordered_.md" target="_blank">trieRootOrdered</a></li>
</ul>
</li>
<li>Util<ul>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_util_asnibbles_.md" target="_blank">asNibbles</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_util_fromnibbles_.md" target="_blank">fromNibbles</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_util_genroot_.md" target="_blank">genRoot</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_util_sharedlength_.md" target="_blank">getSharedLength</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_util_pairsuniq_.md" target="_blank">pairsUniq</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_util_sharedprefixlength_.md" target="_blank">sharedPrefixLength</a></li>
</ul>
</li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_trieroot_.md" target="_blank">trieRoot</a></li>
<li><a href="https://polkadot.js.org/common/trie-hash/modules/_trierootordered_.md" target="_blank">trieRootOrdered</a></li>
</ul>
</li>
</ul>
@@ -412,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":"2018-11-21T14:45:13.939Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-21T14:46:09.418Z"},"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":"2018-11-22T13:33:31.240Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-22T13:34:22.054Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/trie-hash/modules/_buildtrie_.md
+25
View File
@@ -0,0 +1,25 @@
# Functions
<a id="buildtrie"></a>
## buildTrie
▸ **buildTrie**(input: *`Array`<[`Uint8Array`, `Uint8Array`]>*, cursor?: *`number`*, codec?: *`Codec`*, stream?: *`any`*): `Uint8Array`
*Defined in [buildTrie.ts:77](https://github.com/polkadot-js/common/blob/f82092e/packages/trie-hash/src/buildTrie.ts#L77)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| input | `Array`<[`Uint8Array`, `Uint8Array`]> | - |
| `Default value` cursor | `number` | 0 |
| `Default value` codec | `Codec` | DEFAULT_CODEC |
| `Default value` stream | `any` | DEFAULT_STREAM |
**Returns:** `Uint8Array`
___
docs/trie-hash/modules/_defaults_.md
+2
View File
@@ -0,0 +1,2 @@
docs/trie-hash/modules/_encode_aux_.md
-23
View File
@@ -1,23 +0,0 @@
# Functions
<a id="encodeaux"></a>
## encodeAux
▸ **encodeAux**(pairs: *`Trie$Pairs`*, preLength: *`number`*): `Uint8Array` &#124; `any`[]
*Defined in [encode/aux.ts:12](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/encode/aux.ts#L12)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pairs | `Trie$Pairs` |
| preLength | `number` |
**Returns:** `Uint8Array` &#124; `any`[]
___
docs/trie-hash/modules/_encode_hexprefix_.md
-23
View File
@@ -1,23 +0,0 @@
# Functions
<a id="encodehexprefix"></a>
## encodeHexPrefix
▸ **encodeHexPrefix**(nibbles: * `Uint8Array` &#124; `Array`<`number`>*, isLeaf: *`boolean`*): `Uint8Array`
*Defined in [encode/hexPrefix.ts:5](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/encode/hexPrefix.ts#L5)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| nibbles | `Uint8Array` &#124; `Array`<`number`>|
| isLeaf | `boolean` |
**Returns:** `Uint8Array`
___
docs/trie-hash/modules/_encode_index_.md
-37
View File
@@ -1,37 +0,0 @@
# Functions
<a id="encode"></a>
## encode
▸ **encode**(pairs: *`Trie$Pairs`*, preLength: *`number`*): `Array`<`any`>
*Defined in [encode/index.ts:36](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/encode/index.ts#L36)*
*__name__*: encode
*__signature__*: encode (pairs: Trie$Pairs, preLength: number): Array
*__summary__*: Encodes Trie Pairs depending on a provided Prefix Length and the amount of pairs
*__description__*: * `encode` is called and provided arguments including Trie Pairs and Prefix Length.
* If the Trie Pairs have no length then return an empty array
* If the Trie Pairs have a length of 1 then we call `encodeSingle` to return a single encoded array with two elements. The first element is a u8a calculated from calling `encodeHexPrefix` with arguments including a slice up to the Prefix Length of the pair's key (aka nibbles), and whether it's a leaf. The second element is the pair's value.
* If the Trie Pairs have a length > 1 and we calculate that their Shared Prefix Length > Prefix Length then we return early with the results of calling `encodeShared` to return a single encoded array with two elements. The first element is a u8a calculated as previously with `encodeHexPrefix` and whereas second element is calculated from calling `encodeAux`, which recursively calls this function `encode` to obtain an encoded value, and then Recursive Length Prefix (RLP) encodes it. If the length of the RLP encoded u8a is less than 32 then return the RLP encoded value, otherwise return call the Keccak-256 hash function from [js-sha3](https://www.npmjs.com/package/js-sha3) library on the RLP encoded value and return the result.
* If the Trie Pairs have a length > 1 and the calculated Share Prefix Length <= Prefix Length then we return the array result of calling `encodePairs` and push the pair's value onto the end of the array if the Prefix Length !== Pair's Key Length.
*__description__*: Refer to [Merkle Patricia Trie specification](https://github.com/ethereum/wiki/wiki/Patricia-Tree#optimization)
**Parameters:**
| Name | Type |
| ------ | ------ |
| pairs | `Trie$Pairs` |
| preLength | `number` |
**Returns:** `Array`<`any`>
___
docs/trie-hash/modules/_encode_pairs_.md
-23
View File
@@ -1,23 +0,0 @@
# Functions
<a id="encodepairs"></a>
## encodePairs
▸ **encodePairs**(pairs: *`Trie$Pairs`*, preLength: *`number`*): `Array`<`any`>
*Defined in [encode/pairs.ts:23](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/encode/pairs.ts#L23)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pairs | `Trie$Pairs` |
| preLength | `number` |
**Returns:** `Array`<`any`>
___
docs/trie-hash/modules/_encode_shared_.md
-24
View File
@@ -1,24 +0,0 @@
# Functions
<a id="encodeshared"></a>
## encodeShared
▸ **encodeShared**(pairs: *`Trie$Pairs`*, preLength: *`number`*, sharedLength: *`number`*): `Array`<`any`>
*Defined in [encode/shared.ts:10](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/encode/shared.ts#L10)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pairs | `Trie$Pairs` |
| preLength | `number` |
| sharedLength | `number` |
**Returns:** `Array`<`any`>
___
docs/trie-hash/modules/_encode_single_.md
-23
View File
@@ -1,23 +0,0 @@
# Functions
<a id="encodesingle"></a>
## encodeSingle
▸ **encodeSingle**(pair: *`Trie$Pair`*, preLength: *`number`*): `Array`<`any`>
*Defined in [encode/single.ts:9](https://github.com/polkadot-js/common/blob/477be90/packages/trie-hash/src/encode/single.ts#L9)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| pair | `Trie$Pair` |
| preLength | `number` |
**Returns:** `Array`<`any`>
___

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