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

[CI Skip] 0.33.29

Browse Source
This commit is contained in:
Travis CI
2019-01-04 13:55:24 +00:00
parent 89030f41b3
commit bff4132b75
195 changed files with 624 additions and 664 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/keyring/classes/_index_.keyring.md
+23 -23
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/d47b865/packages/keyring/src/index.ts#L33)*
*Defined in [index.ts:33](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L33)*
**Returns:** [Keyring](_index_.keyring.md)
@@ -45,7 +45,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[decodeAddress](../interfaces/_types_.keyringinstance.md#decodeaddress)*
*Defined in [index.ts:39](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L39)*
*Defined in [index.ts:39](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L39)*
___
<a id="encodeaddress"></a>
@@ -56,7 +56,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[encodeAddress](../interfaces/_types_.keyringinstance.md#encodeaddress)*
*Defined in [index.ts:40](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L40)*
*Defined in [index.ts:40](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L40)*
___
<a id="setaddressprefix"></a>
@@ -67,7 +67,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[setAddressPrefix](../interfaces/_types_.keyringinstance.md#setaddressprefix)*
*Defined in [index.ts:41](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L41)*
*Defined in [index.ts:41](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L41)*
___
@@ -77,9 +77,9 @@ ___
## addFromAddress
▸ **addFromAddress**(address: * `string` &#124; `Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, defaultEncoded?: *`Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, defaultEncoded?: *`Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [index.ts:61](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L61)*
*Defined in [index.ts:61](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L61)*
*__name__*: addFromAddress
@@ -93,7 +93,7 @@ ___
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
| `Optional` meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
| `Optional` defaultEncoded | `Uint8Array` |
@@ -106,7 +106,7 @@ ___
▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [index.ts:76](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L76)*
*Defined in [index.ts:76](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L76)*
*__name__*: addFromJson
@@ -135,7 +135,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)*
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L89)*
*Defined in [index.ts:89](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L89)*
*__name__*: addFromMnemonic
@@ -163,7 +163,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)*
*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L118)*
*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L118)*
*__name__*: addFromSeed
@@ -208,7 +208,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)*
*Defined in [index.ts:48](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L48)*
*Defined in [index.ts:48](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L48)*
*__name__*: addPair
@@ -229,11 +229,11 @@ ___
## getPair
▸ **getPair**(address: * `string` &#124; `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)*
*Defined in [index.ts:154](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L154)*
*Defined in [index.ts:154](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L154)*
*__name__*: getPair
@@ -272,7 +272,7 @@ console.log(`Are all pairs the same? : ` +
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
@@ -285,7 +285,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)*
*Defined in [index.ts:186](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L186)*
*Defined in [index.ts:186](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L186)*
*__name__*: getPairs
@@ -328,7 +328,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)*
*Defined in [index.ts:196](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L196)*
*Defined in [index.ts:196](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L196)*
*__name__*: getPublicKeys
@@ -345,11 +345,11 @@ ___
## removePair
▸ **removePair**(address: * `string` &#124; `Uint8Array`*): `void`
▸ **removePair**(address: *`string` | `Uint8Array`*): `void`
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)*
*Defined in [index.ts:211](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L211)*
*Defined in [index.ts:211](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L211)*
*__name__*: removePair
@@ -363,7 +363,7 @@ ___
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** `void`
@@ -372,11 +372,11 @@ ___
## toJson
▸ **toJson**(address: * `string` &#124; `Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[toJson](../interfaces/_types_.keyringinstance.md#tojson)*
*Defined in [index.ts:226](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/index.ts#L226)*
*Defined in [index.ts:226](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/index.ts#L226)*
*__name__*: toJson
@@ -392,8 +392,8 @@ ___
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| `Optional` passphrase | `undefined` &#124; `string`|
| address | `string` | `Uint8Array` |
| `Optional` passphrase | `undefined` | `string` |
**Returns:** [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
docs/keyring/classes/_pairs_.pairs.md
+9 -9
View File
@@ -16,7 +16,7 @@
⊕ **new Pairs**(): [Pairs](_pairs_.pairs.md)
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pairs.ts#L17)*
**Returns:** [Pairs](_pairs_.pairs.md)
@@ -30,7 +30,7 @@ ___
▸ **add**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pairs.ts#L23)*
**Parameters:**
@@ -47,7 +47,7 @@ ___
▸ **all**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
@@ -56,15 +56,15 @@ ___
## get
▸ **get**(address: * `string` &#124; `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pairs.ts#L34)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
@@ -73,15 +73,15 @@ ___
## remove
▸ **remove**(address: * `string` &#124; `Uint8Array`*): `void`
▸ **remove**(address: *`string` | `Uint8Array`*): `void`
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pairs.ts#L49)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** `void`
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-01-03T12:55:56.059Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-03T12:57:07.982Z"},"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-01-04T13:54:07.150Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-01-04T13:55:19.008Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
docs/keyring/interfaces/_types_.keyringinstance.md
+26 -26
View File
@@ -14,15 +14,15 @@
## addFromAddress
▸ **addFromAddress**(address: * `string` &#124; `Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [types.ts:49](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L49)*
*Defined in [types.ts:49](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L49)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
| `Optional` meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
@@ -34,7 +34,7 @@ ___
▸ **addFromJson**(pair: *[KeyringPair$Json](../modules/_types_.md#keyringpair_json)*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L52)*
*Defined in [types.ts:52](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L52)*
**Parameters:**
@@ -51,7 +51,7 @@ ___
▸ **addFromMnemonic**(mnemonic: *`string`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [types.ts:50](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L50)*
*Defined in [types.ts:50](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L50)*
**Parameters:**
@@ -69,7 +69,7 @@ ___
▸ **addFromSeed**(seed: *`Uint8Array`*, meta?: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L51)*
*Defined in [types.ts:51](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L51)*
**Parameters:**
@@ -87,7 +87,7 @@ ___
▸ **addPair**(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [types.ts:48](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L48)*
*Defined in [types.ts:48](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L48)*
**Parameters:**
@@ -102,15 +102,15 @@ ___
## decodeAddress
▸ **decodeAddress**(encoded: * `string` &#124; `Uint8Array`*): `Uint8Array`
▸ **decodeAddress**(encoded: *`string` | `Uint8Array`*): `Uint8Array`
*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L44)*
*Defined in [types.ts:44](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L44)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| encoded | `string` &#124; `Uint8Array`|
| encoded | `string` | `Uint8Array` |
**Returns:** `Uint8Array`
@@ -119,15 +119,15 @@ ___
## encodeAddress
▸ **encodeAddress**(key: * `Uint8Array` &#124; `string`*): `string`
▸ **encodeAddress**(key: *`Uint8Array` | `string`*): `string`
*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L45)*
*Defined in [types.ts:45](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L45)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| key | `Uint8Array` &#124; `string`|
| key | `Uint8Array` | `string` |
**Returns:** `string`
@@ -136,15 +136,15 @@ ___
## getPair
▸ **getPair**(address: * `string` &#124; `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L53)*
*Defined in [types.ts:53](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L53)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
@@ -155,7 +155,7 @@ ___
▸ **getPairs**(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L54)*
*Defined in [types.ts:54](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L54)*
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
@@ -166,7 +166,7 @@ ___
▸ **getPublicKeys**(): `Array`<`Uint8Array`>
*Defined in [types.ts:55](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L55)*
*Defined in [types.ts:55](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L55)*
**Returns:** `Array`<`Uint8Array`>
@@ -175,15 +175,15 @@ ___
## removePair
▸ **removePair**(address: * `string` &#124; `Uint8Array`*): `void`
▸ **removePair**(address: *`string` | `Uint8Array`*): `void`
*Defined in [types.ts:56](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L56)*
*Defined in [types.ts:56](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L56)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** `void`
@@ -194,7 +194,7 @@ ___
▸ **setAddressPrefix**(prefix: *[Prefix](../modules/_address_types_.md#prefix)*): `void`
*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L46)*
*Defined in [types.ts:46](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L46)*
**Parameters:**
@@ -209,16 +209,16 @@ ___
## toJson
▸ **toJson**(address: * `string` &#124; `Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `string`*): [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
*Defined in [types.ts:57](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L57)*
*Defined in [types.ts:57](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L57)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| `Optional` passphrase | `undefined` &#124; `string`|
| address | `string` | `Uint8Array` |
| `Optional` passphrase | `undefined` | `string` |
**Returns:** [KeyringPair$Json](../modules/_types_.md#keyringpair_json)
docs/keyring/interfaces/_types_.keyringpairs.md
+8 -8
View File
@@ -16,7 +16,7 @@
**● add**: *`function`*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L37)*
*Defined in [types.ts:37](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L37)*
#### Type declaration
▸(pair: *[KeyringPair](../modules/_types_.md#keyringpair)*): [KeyringPair](../modules/_types_.md#keyringpair)
@@ -36,7 +36,7 @@ ___
**● all**: *`function`*
*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L38)*
*Defined in [types.ts:38](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L38)*
#### Type declaration
▸(): `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
@@ -50,16 +50,16 @@ ___
**● get**: *`function`*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L39)*
*Defined in [types.ts:39](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L39)*
#### Type declaration
▸(address: * `string` &#124; `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
▸(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** [KeyringPair](../modules/_types_.md#keyringpair)
@@ -70,16 +70,16 @@ ___
**● remove**: *`function`*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L40)*
*Defined in [types.ts:40](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L40)*
#### Type declaration
▸(address: * `string` &#124; `Uint8Array`*): `void`
▸(address: *`string` | `Uint8Array`*): `void`
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` &#124; `Uint8Array`|
| address | `string` | `Uint8Array` |
**Returns:** `void`
docs/keyring/modules/_address_decode_.md
+3 -3
View File
@@ -6,15 +6,15 @@
## decode
▸ **decode**(encoded: * `string` &#124; `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array`
▸ **decode**(encoded: *`string` | `Uint8Array`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `Uint8Array`
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/address/decode.ts#L15)*
*Defined in [address/decode.ts:15](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/address/decode.ts#L15)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| encoded | `string` &#124; `Uint8Array`| - |
| encoded | `string` | `Uint8Array` | - |
| `Default value` prefix | [Prefix](_address_types_.md#prefix) | defaults.prefix |
**Returns:** `Uint8Array`
docs/keyring/modules/_address_encode_.md
+3 -3
View File
@@ -6,15 +6,15 @@
## encode
▸ **encode**(_key: * `Uint8Array` &#124; `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string`
▸ **encode**(_key: *`Uint8Array` | `string`*, prefix?: *[Prefix](_address_types_.md#prefix)*): `string`
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/address/encode.ts#L15)*
*Defined in [address/encode.ts:15](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/address/encode.ts#L15)*
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| _key | `Uint8Array` &#124; `string`| - |
| _key | `Uint8Array` | `string` | - |
| `Default value` prefix | [Prefix](_address_types_.md#prefix) | defaults.prefix |
**Returns:** `string`
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/d47b865/packages/keyring/src/address/setPrefix.ts#L9)*
*Defined in [address/setPrefix.ts:9](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/address/setPrefix.ts#L9)*
**Parameters:**
docs/keyring/modules/_address_types_.md
+2 -3
View File
@@ -6,10 +6,9 @@
## Prefix
**Ƭ Prefix**: * `0` &#124; `1` &#124; `3` &#124; `42` &#124; `43` &#124; `68` &#124; `69`
*
**Ƭ Prefix**: *`0` | `1` | `3` | `42` | `43` | `68` | `69`*
*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/address/types.ts#L5)*
*Defined in [address/types.ts:5](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/address/types.ts#L5)*
___
docs/keyring/modules/_pair_decode_.md
+3 -3
View File
@@ -6,15 +6,15 @@
## decode
▸ **decode**(passphrase?: * `undefined` &#124; `string`*, _encrypted?: *`Uint8Array`*): `object`
▸ **decode**(passphrase?: *`undefined` | `string`*, _encrypted?: *`Uint8Array`*): `object`
*Defined in [pair/decode.ts:15](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/decode.ts#L15)*
*Defined in [pair/decode.ts:15](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pair/decode.ts#L15)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| `Optional` passphrase | `undefined` &#124; `string`|
| `Optional` passphrase | `undefined` | `string` |
| `Optional` _encrypted | `Uint8Array` |
**Returns:** `object`
docs/keyring/modules/_pair_encode_.md
+3 -3
View File
@@ -6,16 +6,16 @@
## encode
▸ **encode**(secretKey: *`Uint8Array`*, passphrase?: * `undefined` &#124; `string`*): `Uint8Array`
▸ **encode**(secretKey: *`Uint8Array`*, passphrase?: *`undefined` | `string`*): `Uint8Array`
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/encode.ts#L10)*
*Defined in [pair/encode.ts:10](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pair/encode.ts#L10)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| secretKey | `Uint8Array` |
| `Optional` passphrase | `undefined` &#124; `string`|
| `Optional` passphrase | `undefined` | `string` |
**Returns:** `Uint8Array`
docs/keyring/modules/_pair_getmeta_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **getMeta**(state: *[PairState](_pair_types_.md#pairstate)*): [KeyringPair$Meta](_types_.md#keyringpair_meta)
*Defined in [pair/getMeta.ts:8](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/getMeta.ts#L8)*
*Defined in [pair/getMeta.ts:8](https://github.com/polkadot-js/common/blob/89030f4/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](_types_.md#keyringpair_meta)*, defaultEncoded?: *`Uint8Array`*): [KeyringPair](_types_.md#keyringpair)
*Defined in [pair/index.ts:50](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/index.ts#L50)*
*Defined in [pair/index.ts:50](https://github.com/polkadot-js/common/blob/89030f4/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](_types_.md#keyringpair)
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/nobody.ts#L25)*
*Defined in [pair/nobody.ts:25](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pair/nobody.ts#L25)*
**Returns:** [KeyringPair](_types_.md#keyringpair)
docs/keyring/modules/_pair_setmeta_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **setMeta**(state: *[PairState](_pair_types_.md#pairstate)*, meta: *[KeyringPair$Meta](_types_.md#keyringpair_meta)*): `void`
*Defined in [pair/setMeta.ts:8](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/setMeta.ts#L8)*
*Defined in [pair/setMeta.ts:8](https://github.com/polkadot-js/common/blob/89030f4/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](_types_.md#keyringpair_json)
*Defined in [pair/toJson.ts:12](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/toJson.ts#L12)*
*Defined in [pair/toJson.ts:12](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pair/toJson.ts#L12)*
**Parameters:**
docs/keyring/modules/_pair_types_.md
+1 -1
View File
@@ -8,7 +8,7 @@
**Ƭ PairState**: *`object`*
*Defined in [pair/types.ts:7](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/pair/types.ts#L7)*
*Defined in [pair/types.ts:7](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/pair/types.ts#L7)*
#### Type declaration
docs/keyring/modules/_testing_.md
+1 -1
View File
@@ -8,7 +8,7 @@
▸ **testKeyring**(): [KeyringInstance](../interfaces/_types_.keyringinstance.md)
*Defined in [testing.ts:57](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/testing.ts#L57)*
*Defined in [testing.ts:57](https://github.com/polkadot-js/common/blob/89030f4/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/d47b865/packages/keyring/src/testingPairs.ts#L14)*
*Defined in [testingPairs.ts:14](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/testingPairs.ts#L14)*
**Returns:** `TestKeyringMap`
docs/keyring/modules/_types_.md
+3 -3
View File
@@ -23,7 +23,7 @@
**Ƭ KeyringPair**: *`object`*
*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L22)*
*Defined in [types.ts:22](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L22)*
#### Type declaration
@@ -34,7 +34,7 @@ ___
**Ƭ KeyringPair$Json**: *`object`*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L11)*
*Defined in [types.ts:11](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L11)*
#### Type declaration
@@ -45,7 +45,7 @@ ___
**Ƭ KeyringPair$Meta**: *`object`*
*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/d47b865/packages/keyring/src/types.ts#L7)*
*Defined in [types.ts:7](https://github.com/polkadot-js/common/blob/89030f4/packages/keyring/src/types.ts#L7)*
#### Type declaration