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

[CI Skip] 0.34.18

Browse Source
This commit is contained in:
Travis CI
2019-02-16 11:14:15 +00:00
parent b15abe1167
commit 6bc073e07a
200 changed files with 473 additions and 470 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/keyring/classes/_index_.keyring.md
+17 -17
View File
@@ -28,7 +28,7 @@ Overview
⊕ **new Keyring**(options?: *[KeyringOptions](../modules/_types_.md#keyringoptions)*): [Keyring](_index_.keyring.md)
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L32)*
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L32)*
**Parameters:**
@@ -50,7 +50,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[decodeAddress](../interfaces/_types_.keyringinstance.md#decodeaddress)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L43)*
___
<a id="encodeaddress"></a>
@@ -61,7 +61,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[encodeAddress](../interfaces/_types_.keyringinstance.md#encodeaddress)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L44)*
___
<a id="setaddressprefix"></a>
@@ -72,7 +72,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[setAddressPrefix](../interfaces/_types_.keyringinstance.md#setaddressprefix)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L45)*
___
@@ -84,7 +84,7 @@ ___
getpairs(): `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L50)*
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L50)*
*__description__*: retrieve the pairs (alias for getPairs)
@@ -97,7 +97,7 @@ ___
getpublicKeys(): `Array`<`Uint8Array`>
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L57)*
*Defined in [index.ts:57](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L57)*
*__description__*: retrieve the publicKeys (alias for getPiblicKeys)
@@ -110,7 +110,7 @@ ___
gettype(): [KeyringPairType](../modules/_types_.md#keyringpairtype)
*Defined in [index.ts:64](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L64)*
*Defined in [index.ts:64](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L64)*
*__description__*: Returns the type of the keyring, either ed25519 of sr25519
@@ -128,7 +128,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromAddress](../interfaces/_types_.keyringinstance.md#addfromaddress)*
*Defined in [index.ts:84](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L84)*
*Defined in [index.ts:84](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L84)*
*__name__*: addFromAddress
@@ -154,7 +154,7 @@ ___
▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [index.ts:95](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L95)*
*Defined in [index.ts:95](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L95)*
*__name__*: addFromJson
@@ -179,7 +179,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)*
*Defined in [index.ts:110](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L110)*
*Defined in [index.ts:110](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L110)*
*__name__*: addFromMnemonic
@@ -206,7 +206,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)*
*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L121)*
*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L121)*
*__name__*: addFromSeed
@@ -233,7 +233,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)*
*Defined in [index.ts:72](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L72)*
*Defined in [index.ts:72](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L72)*
*__name__*: addPair
@@ -256,7 +256,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)*
*Defined in [index.ts:135](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L135)*
*Defined in [index.ts:135](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L135)*
*__name__*: getPair
@@ -281,7 +281,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)*
*Defined in [index.ts:144](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L144)*
*Defined in [index.ts:144](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L144)*
*__name__*: getPairs
@@ -300,7 +300,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)*
*Defined in [index.ts:153](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L153)*
*Defined in [index.ts:153](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L153)*
*__name__*: getPublicKeys
@@ -319,7 +319,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)*
*Defined in [index.ts:165](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L165)*
*Defined in [index.ts:165](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L165)*
*__name__*: removePair
@@ -342,7 +342,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[toJson](../interfaces/_types_.keyringinstance.md#tojson)*
*Defined in [index.ts:177](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/index.ts#L177)*
*Defined in [index.ts:177](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/index.ts#L177)*
*__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/bc2b134/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pairs.ts#L17)*
**Returns:** [Pairs](_pairs_.pairs.md)
@@ -30,7 +30,7 @@ ___
▸ **add**(pair: *[KeyringPair](../interfaces/_types_.keyringpair.md)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pairs.ts#L23)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **all**(): `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
@@ -58,7 +58,7 @@ ___
▸ **get**(address: *`string` \| `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pairs.ts#L34)*
**Parameters:**
@@ -75,7 +75,7 @@ ___
▸ **remove**(address: *`string` \| `Uint8Array`*): `void`
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pairs.ts#L49)*
**Parameters:**
docs/keyring/index.html
+1 -1
View File
@@ -397,7 +397,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"keyring/README.md","mtime":"2019-02-16T10:09:50.222Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-16T10:11:09.869Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"keyring/README.md","mtime":"2019-02-16T11:12:53.609Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-16T11:14:10.851Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/keyring/interfaces/_types_.keyringinstance.md
+16 -16
View File
@@ -16,7 +16,7 @@
**● pairs**: *`Array`<[KeyringPair](_types_.keyringpair.md)>*
*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L58)*
*Defined in [types.ts:58](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L58)*
___
<a id="publickeys"></a>
@@ -25,7 +25,7 @@ ___
**● publicKeys**: *`Array`<`Uint8Array`>*
*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L59)*
*Defined in [types.ts:59](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L59)*
___
<a id="type"></a>
@@ -34,7 +34,7 @@ ___
**● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*
*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L60)*
*Defined in [types.ts:60](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L60)*
___
@@ -46,7 +46,7 @@ ___
▸ **addFromAddress**(address: *`string` \| `Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded?: *`Uint8Array` \| `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L67)*
*Defined in [types.ts:67](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L67)*
**Parameters:**
@@ -66,7 +66,7 @@ ___
▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L70)*
*Defined in [types.ts:70](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L70)*
**Parameters:**
@@ -83,7 +83,7 @@ ___
▸ **addFromMnemonic**(mnemonic: *`string`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L68)*
*Defined in [types.ts:68](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L68)*
**Parameters:**
@@ -102,7 +102,7 @@ ___
▸ **addFromSeed**(seed: *`Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L69)*
*Defined in [types.ts:69](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L69)*
**Parameters:**
@@ -121,7 +121,7 @@ ___
▸ **addPair**(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L66)*
*Defined in [types.ts:66](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L66)*
**Parameters:**
@@ -138,7 +138,7 @@ ___
▸ **decodeAddress**(encoded: *`string` \| `Uint8Array`*): `Uint8Array`
*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L62)*
*Defined in [types.ts:62](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L62)*
**Parameters:**
@@ -155,7 +155,7 @@ ___
▸ **encodeAddress**(key: *`Uint8Array` \| `string`*): `string`
*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L63)*
*Defined in [types.ts:63](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L63)*
**Parameters:**
@@ -172,7 +172,7 @@ ___
▸ **getPair**(address: *`string` \| `Uint8Array`*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L71)*
*Defined in [types.ts:71](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L71)*
**Parameters:**
@@ -189,7 +189,7 @@ ___
▸ **getPairs**(): `Array`<[KeyringPair](_types_.keyringpair.md)>
*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L72)*
*Defined in [types.ts:72](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L72)*
**Returns:** `Array`<[KeyringPair](_types_.keyringpair.md)>
@@ -200,7 +200,7 @@ ___
▸ **getPublicKeys**(): `Array`<`Uint8Array`>
*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L73)*
*Defined in [types.ts:73](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L73)*
**Returns:** `Array`<`Uint8Array`>
@@ -211,7 +211,7 @@ ___
▸ **removePair**(address: *`string` \| `Uint8Array`*): `void`
*Defined in [types.ts:74](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L74)*
*Defined in [types.ts:74](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L74)*
**Parameters:**
@@ -228,7 +228,7 @@ ___
▸ **setAddressPrefix**(prefix: *[Prefix](../modules/_address_types_.md#prefix)*): `void`
*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L64)*
*Defined in [types.ts:64](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L64)*
**Parameters:**
@@ -245,7 +245,7 @@ ___
▸ **toJson**(address: *`string` \| `Uint8Array`*, passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
*Defined in [types.ts:75](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L75)*
*Defined in [types.ts:75](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L75)*
**Parameters:**
docs/keyring/interfaces/_types_.keyringpair.md
+13 -13
View File
@@ -12,7 +12,7 @@
**● address**: *`function`*
*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L36)*
*Defined in [types.ts:36](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L36)*
#### Type declaration
▸(): `string`
@@ -26,7 +26,7 @@ ___
**● decodePkcs8**: *`function`*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L37)*
#### Type declaration
▸(passphrase?: *`undefined` \| `string`*, encoded?: *`Uint8Array`*): `void`
@@ -47,7 +47,7 @@ ___
**● encodePkcs8**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L38)*
#### Type declaration
▸(passphrase?: *`undefined` \| `string`*): `Uint8Array`
@@ -67,7 +67,7 @@ ___
**● getMeta**: *`function`*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L39)*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L39)*
#### Type declaration
▸(): [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)
@@ -81,7 +81,7 @@ ___
**● isLocked**: *`function`*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L40)*
#### Type declaration
▸(): `boolean`
@@ -95,7 +95,7 @@ ___
**● lock**: *`function`*
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L41)*
*Defined in [types.ts:41](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L41)*
#### Type declaration
▸(): `void`
@@ -109,7 +109,7 @@ ___
**● publicKey**: *`function`*
*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L42)*
*Defined in [types.ts:42](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L42)*
#### Type declaration
▸(): `Uint8Array`
@@ -123,7 +123,7 @@ ___
**● setMeta**: *`function`*
*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L43)*
*Defined in [types.ts:43](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L43)*
#### Type declaration
▸(meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): `void`
@@ -143,7 +143,7 @@ ___
**● type**: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L34)*
*Defined in [types.ts:34](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L34)*
___
@@ -155,7 +155,7 @@ ___
▸ **sign**(message: *`Uint8Array`*): `Uint8Array`
*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L44)*
*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L44)*
**Parameters:**
@@ -172,7 +172,7 @@ ___
▸ **toJson**(passphrase?: *`undefined` \| `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L45)*
*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L45)*
**Parameters:**
@@ -189,7 +189,7 @@ ___
▸ **toType**(type: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](_types_.keyringpair.md)
*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L46)*
**Parameters:**
@@ -206,7 +206,7 @@ ___
▸ **verify**(message: *`Uint8Array`*, signature: *`Uint8Array`*): `boolean`
*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L47)*
*Defined in [types.ts:47](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L47)*
**Parameters:**
docs/keyring/interfaces/_types_.keyringpairs.md
+4 -4
View File
@@ -16,7 +16,7 @@
**● add**: *`function`*
*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L51)*
*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L51)*
#### Type declaration
▸(pair: *[KeyringPair](_types_.keyringpair.md)*): [KeyringPair](_types_.keyringpair.md)
@@ -36,7 +36,7 @@ ___
**● all**: *`function`*
*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L52)*
*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L52)*
#### Type declaration
▸(): `Array`<[KeyringPair](_types_.keyringpair.md)>
@@ -50,7 +50,7 @@ ___
**● get**: *`function`*
*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L53)*
*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L53)*
#### Type declaration
▸(address: *`string` \| `Uint8Array`*): [KeyringPair](_types_.keyringpair.md)
@@ -70,7 +70,7 @@ ___
**● remove**: *`function`*
*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L54)*
*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L54)*
#### Type declaration
▸(address: *`string` \| `Uint8Array`*): `void`
docs/keyring/modules/_address_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(encoded: *`string` \| `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array`
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/address/decode.ts#L15)*
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/address/decode.ts#L15)*
**Parameters:**
docs/keyring/modules/_address_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(_key: *`Uint8Array` \| `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string`
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/address/encode.ts#L15)*
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/address/encode.ts#L15)*
**Parameters:**
docs/keyring/modules/_address_setprefix_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **setPrefix**(prefix: *[Prefix](_address_types_.md#prefix)*): `void`
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/address/setPrefix.ts#L9)*
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/address/setPrefix.ts#L9)*
**Parameters:**
docs/keyring/modules/_address_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ Prefix**: *`0` \| `1` \| `3` \| `42` \| `43` \| `68` \| `69`*
*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/address/types.ts#L5)*
*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/address/types.ts#L5)*
___
docs/keyring/modules/_pair_decode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **decode**(passphrase?: *`undefined` \| `string`*, _encrypted?: *`Uint8Array` \| `null`*): `DecodeResult`
*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pair/decode.ts#L19)*
*Defined in [pair/decode.ts:19](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pair/decode.ts#L19)*
**Parameters:**
docs/keyring/modules/_pair_encode_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **encode**(__namedParameters: *`object`*, passphrase?: *`undefined` \| `string`*): `Uint8Array`
*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pair/encode.ts#L12)*
*Defined in [pair/encode.ts:12](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pair/encode.ts#L12)*
**Parameters:**
docs/keyring/modules/_pair_index_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **createPair**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, meta?: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*, encoded?: *`Uint8Array` \| `null`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pair/index.ts:62](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pair/index.ts#L62)*
*Defined in [pair/index.ts:62](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pair/index.ts#L62)*
*__name__*: pair
docs/keyring/modules/_pair_nobody_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **everybody**(): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pair/nobody.ts#L25)*
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pair/nobody.ts#L25)*
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
docs/keyring/modules/_pair_tojson_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **toJson**(type: *[KeyringPairType](_types_.md#keyringpairtype)*, __namedParameters: *`object`*, encoded: *`Uint8Array`*, isEncrypted: *`boolean`*): [KeyringPair$Json](_types_.md#keyringpair_json)
*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pair/toJson.ts#L15)*
*Defined in [pair/toJson.ts:15](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pair/toJson.ts#L15)*
**Parameters:**
docs/keyring/modules/_pair_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ PairInfo**: *`object`*
*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/pair/types.ts#L5)*
*Defined in [pair/types.ts:5](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/pair/types.ts#L5)*
#### Type declaration
docs/keyring/modules/_testing_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyring**(options?: *[KeyringOptions](_types_.md#keyringoptions)*): [KeyringInstance](../interfaces/_types_.keyringinstance.md)
*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/testing.ts#L41)*
*Defined in [testing.ts:41](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/testing.ts#L41)*
*__name__*: testKeyring
docs/keyring/modules/_testingpairs_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyringPairs**(options?: *[KeyringOptions](_types_.md#keyringoptions)*): `TestKeyringMap`
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/testingPairs.ts#L14)*
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/testingPairs.ts#L14)*
**Parameters:**
docs/keyring/modules/_types_.md
+6 -6
View File
@@ -27,7 +27,7 @@
**Ƭ KeyringOptions**: *`object`*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L9)*
*Defined in [types.ts:9](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L9)*
#### Type declaration
@@ -38,7 +38,7 @@ ___
**Ƭ KeyringPair$Json**: *`object`*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L26)*
*Defined in [types.ts:26](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L26)*
#### Type declaration
@@ -49,7 +49,7 @@ ___
**Ƭ KeyringPair$JsonEncoding**: *`object`*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L20)*
*Defined in [types.ts:20](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L20)*
#### Type declaration
@@ -60,7 +60,7 @@ ___
**Ƭ KeyringPair$JsonVersion**: *"0" \| "1"*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L18)*
*Defined in [types.ts:18](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L18)*
___
<a id="keyringpair_meta"></a>
@@ -69,7 +69,7 @@ ___
**Ƭ KeyringPair$Meta**: *`object`*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L14)*
*Defined in [types.ts:14](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L14)*
#### Type declaration
@@ -82,7 +82,7 @@ ___
**Ƭ KeyringPairType**: *"ed25519" \| "sr25519"*
*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/bc2b134/packages/keyring/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/b15abe1/packages/keyring/src/types.ts#L7)*
___