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

[CI Skip] 0.34.13

Browse Source
This commit is contained in:
Travis CI
2019-02-15 13:40:51 +00:00
parent 2efc5f7ca1
commit fcfc20fe95
200 changed files with 681 additions and 710 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/keyring/classes/_index_.keyring.md
+26 -25
View File
@@ -5,6 +5,7 @@
Overview
--------
*__name__*: Keyring
*__summary__*: Keyring management of user accounts
@@ -27,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/9f9ceff/packages/keyring/src/index.ts#L32)*
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L32)*
**Parameters:**
@@ -49,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/9f9ceff/packages/keyring/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L43)*
___
<a id="encodeaddress"></a>
@@ -60,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/9f9ceff/packages/keyring/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L44)*
___
<a id="setaddressprefix"></a>
@@ -71,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/9f9ceff/packages/keyring/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L45)*
___
@@ -83,7 +84,7 @@ ___
gettype(): [KeyringPairType](../modules/_types_.md#keyringpairtype)
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L50)*
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L50)*
*__description__*: Returns the type of the keyring, either ed25519 of sr25519
@@ -97,11 +98,11 @@ ___
## addFromAddress
▸ **addFromAddress**(address: *`string` | `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` | `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
▸ **addFromAddress**(address: *`string` \| `Uint8Array`*, meta: *[KeyringPair$Meta](../modules/_types_.md#keyringpair_meta)*, encoded: *`Uint8Array` \| `null`*, type?: *[KeyringPairType](../modules/_types_.md#keyringpairtype)*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromAddress](../interfaces/_types_.keyringinstance.md#addfromaddress)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L70)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L70)*
*__name__*: addFromAddress
@@ -113,9 +114,9 @@ ___
| Name | Type | Default value |
| ------ | ------ | ------ |
| address | `string` | `Uint8Array` | - |
| address | `string` \| `Uint8Array` | - |
| meta | [KeyringPair$Meta](../modules/_types_.md#keyringpair_meta) | - |
| encoded | `Uint8Array` | `null` | - |
| encoded | `Uint8Array` \| `null` | - |
| `Default value` type | [KeyringPairType](../modules/_types_.md#keyringpairtype) | this.type |
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
@@ -127,7 +128,7 @@ ___
▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L81)*
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L81)*
*__name__*: addFromJson
@@ -152,7 +153,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)*
*Defined in [index.ts:96](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L96)*
*Defined in [index.ts:96](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L96)*
*__name__*: addFromMnemonic
@@ -179,7 +180,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)*
*Defined in [index.ts:107](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L107)*
*Defined in [index.ts:107](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L107)*
*__name__*: addFromSeed
@@ -206,7 +207,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L58)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L58)*
*__name__*: addPair
@@ -225,11 +226,11 @@ ___
## getPair
▸ **getPair**(address: *`string` | `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
▸ **getPair**(address: *`string` \| `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)*
*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L121)*
*Defined in [index.ts:121](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L121)*
*__name__*: getPair
@@ -241,7 +242,7 @@ ___
| Name | Type |
| ------ | ------ |
| address | `string` | `Uint8Array` |
| address | `string` \| `Uint8Array` |
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
@@ -254,7 +255,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)*
*Defined in [index.ts:130](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L130)*
*Defined in [index.ts:130](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L130)*
*__name__*: getPairs
@@ -273,7 +274,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)*
*Defined in [index.ts:139](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L139)*
*Defined in [index.ts:139](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L139)*
*__name__*: getPublicKeys
@@ -288,11 +289,11 @@ ___
## removePair
▸ **removePair**(address: *`string` | `Uint8Array`*): `void`
▸ **removePair**(address: *`string` \| `Uint8Array`*): `void`
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)*
*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L151)*
*Defined in [index.ts:151](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L151)*
*__name__*: removePair
@@ -302,7 +303,7 @@ ___
| Name | Type |
| ------ | ------ |
| address | `string` | `Uint8Array` |
| address | `string` \| `Uint8Array` |
**Returns:** `void`
@@ -311,11 +312,11 @@ ___
## toJson
▸ **toJson**(address: *`string` | `Uint8Array`*, passphrase?: *`undefined` | `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:163](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/index.ts#L163)*
*Defined in [index.ts:163](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/index.ts#L163)*
*__name__*: toJson
@@ -327,8 +328,8 @@ ___
| Name | Type |
| ------ | ------ |
| address | `string` | `Uint8Array` |
| `Optional` passphrase | `undefined` | `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/9f9ceff/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/2efc5f7/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/9f9ceff/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<[KeyringPair](../interfaces/_types_.keyringpair.md)>
@@ -56,15 +56,15 @@ ___
## get
▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
▸ **get**(address: *`string` \| `Uint8Array`*): [KeyringPair](../interfaces/_types_.keyringpair.md)
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L34)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` | `Uint8Array` |
| address | `string` \| `Uint8Array` |
**Returns:** [KeyringPair](../interfaces/_types_.keyringpair.md)
@@ -73,15 +73,15 @@ ___
## remove
▸ **remove**(address: *`string` | `Uint8Array`*): `void`
▸ **remove**(address: *`string` \| `Uint8Array`*): `void`
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/9f9ceff/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/2efc5f7/packages/keyring/src/pairs.ts#L49)*
**Parameters:**
| Name | Type |
| ------ | ------ |
| address | `string` | `Uint8Array` |
| address | `string` \| `Uint8Array` |
**Returns:** `void`