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

[CI Skip] 0.34.4

Browse Source
This commit is contained in:
Travis CI
2019-02-14 09:53:14 +00:00
parent 1e6eb2c283
commit b96dffabbc
274 changed files with 719 additions and 680 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/keyring/classes/_index_.keyring.md
+15 -35
View File
@@ -27,7 +27,7 @@ Overview
⊕ **new Keyring**(options: *[KeyringOptions](../modules/_types_.md#keyringoptions)*): [Keyring](_index_.keyring.md)
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L32)*
*Defined in [index.ts:32](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L32)*
**Parameters:**
@@ -49,7 +49,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[decodeAddress](../interfaces/_types_.keyringinstance.md#decodeaddress)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L43)*
*Defined in [index.ts:43](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L43)*
___
<a id="encodeaddress"></a>
@@ -60,7 +60,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[encodeAddress](../interfaces/_types_.keyringinstance.md#encodeaddress)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L44)*
*Defined in [index.ts:44](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L44)*
___
<a id="setaddressprefix"></a>
@@ -71,7 +71,7 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[setAddressPrefix](../interfaces/_types_.keyringinstance.md#setaddressprefix)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L45)*
*Defined in [index.ts:45](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L45)*
___
@@ -83,7 +83,7 @@ ___
gettype(): [PairType](../modules/_types_.md#pairtype)
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L50)*
*Defined in [index.ts:50](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L50)*
*__description__*: Returns the type of the keyring, either ed25519 of sr25519
@@ -101,12 +101,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromAddress](../interfaces/_types_.keyringinstance.md#addfromaddress)*
*Defined in [index.ts:72](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L72)*
*Defined in [index.ts:70](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L70)*
*__name__*: addFromAddress
*__signature__*: addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, defaultEncoded?: Uint8Array): KeyringPair
*__summary__*: Stores an account, given an account address, as a Key/Value (public key, pair) in Keyring Pair Dictionary
*__description__*: Allows user to explicitely provide separate inputs including account address or public key, and optionally the associated account metadata, and the default encoded value as arguments (that may be obtained from the json file of an account backup), and then generates a keyring pair from them that it passes to `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
@@ -128,12 +126,10 @@ ___
▸ **addFromJson**(__namedParameters: *`object`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [index.ts:84](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L84)*
*Defined in [index.ts:81](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L81)*
*__name__*: addFromJson
*__signature__*: addFromJson ({ address, encoded, meta }: KeyringPair$Json): KeyringPair
*__summary__*: Stores an account, given JSON data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
*__description__*: Allows user to provide a json object argument that contains account information (that may be obtained from the json file of an account backup), and then generates a keyring pair from it that it passes to `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
@@ -155,12 +151,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromMnemonic](../interfaces/_types_.keyringinstance.md#addfrommnemonic)*
*Defined in [index.ts:97](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L97)*
*Defined in [index.ts:93](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L93)*
*__name__*: addFromMnemonic
*__signature__*: addFromMnemonic (mnemonic: string, meta?: KeyringPair$Meta): KeyringPair
*__summary__*: Stores an account, given a mnemonic, as a Key/Value (public key, pair) in Keyring Pair Dictionary
*__description__*: Allows user to provide a mnemonic (seed phrase that is provided when account is originally created) argument and a metadata argument that contains account information (that may be obtained from the json file of an account backup), and then generates a keyring pair from it that it passes to `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
@@ -183,12 +177,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addFromSeed](../interfaces/_types_.keyringinstance.md#addfromseed)*
*Defined in [index.ts:109](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L109)*
*Defined in [index.ts:104](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L104)*
*__name__*: addFromSeed
*__signature__*: addFromSeed (seed: Uint8Array, meta?: KeyringPair$Meta): KeyringPair
*__summary__*: Stores an account, given seed data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
*__description__*: Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value. Allows user to provide the account seed as an argument, and then generates a keyring pair from it that it passes to `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
@@ -211,12 +203,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[addPair](../interfaces/_types_.keyringinstance.md#addpair)*
*Defined in [index.ts:59](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L59)*
*Defined in [index.ts:58](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L58)*
*__name__*: addPair
*__signature__*: addPair (pair: KeyringPair): KeyringPair
*__summary__*: Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary
**Parameters:**
@@ -236,12 +226,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPair](../interfaces/_types_.keyringinstance.md#getpair)*
*Defined in [index.ts:124](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L124)*
*Defined in [index.ts:118](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L118)*
*__name__*: getPair
*__signature__*: getPair (address: string | Uint8Array): KeyringPair
*__summary__*: Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address
*__description__*: Returns a keyring pair value from the keyring pair dictionary by performing a key lookup using the provided account address or public key (after decoding it).
@@ -263,12 +251,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPairs](../interfaces/_types_.keyringinstance.md#getpairs)*
*Defined in [index.ts:134](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L134)*
*Defined in [index.ts:127](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L127)*
*__name__*: getPairs
*__signature__*: getPairs (): Array
*__summary__*: Retrieves all account keyring pairs from the Keyring Pair Dictionary
*__description__*: Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary.
@@ -284,12 +270,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[getPublicKeys](../interfaces/_types_.keyringinstance.md#getpublickeys)*
*Defined in [index.ts:144](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L144)*
*Defined in [index.ts:136](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L136)*
*__name__*: getPublicKeys
*__signature__*: getPublicKeys (): Array
*__summary__*: Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary
*__description__*: Returns an array list of all the public keys associated with each of the keyring pair values that are stored in the keyring pair dictionary.
@@ -305,12 +289,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[removePair](../interfaces/_types_.keyringinstance.md#removepair)*
*Defined in [index.ts:157](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L157)*
*Defined in [index.ts:148](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L148)*
*__name__*: removePair
*__signature__*: removePair (address: string | Uint8Array): void
*__description__*: Deletes the provided input address or public key from the stored Keyring Pair Dictionary.
**Parameters:**
@@ -330,12 +312,10 @@ ___
*Implementation of [KeyringInstance](../interfaces/_types_.keyringinstance.md).[toJson](../interfaces/_types_.keyringinstance.md#tojson)*
*Defined in [index.ts:170](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/index.ts#L170)*
*Defined in [index.ts:160](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/index.ts#L160)*
*__name__*: toJson
*__signature__*: toJson (address: string | Uint8Array, passphrase?: string): KeyringPair$Json
*__summary__*: Returns a JSON object associated with the input argument that contains metadata assocated with an account
*__description__*: Returns a JSON object containing the metadata associated with an account when valid address or public key and when the account passphrase is provided if the account secret is not already unlocked and available in memory. Note that in [Polkadot-JS Apps](https://github.com/polkadot-js/apps) the user may backup their account to a JSON file that contains this information.
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/06cc692/packages/keyring/src/pairs.ts#L17)*
*Defined in [pairs.ts:17](https://github.com/polkadot-js/common/blob/1e6eb2c/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/06cc692/packages/keyring/src/pairs.ts#L23)*
*Defined in [pairs.ts:23](https://github.com/polkadot-js/common/blob/1e6eb2c/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/06cc692/packages/keyring/src/pairs.ts#L30)*
*Defined in [pairs.ts:30](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L30)*
**Returns:** `Array`<[KeyringPair](../modules/_types_.md#keyringpair)>
@@ -58,7 +58,7 @@ ___
▸ **get**(address: *`string` | `Uint8Array`*): [KeyringPair](../modules/_types_.md#keyringpair)
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/06cc692/packages/keyring/src/pairs.ts#L34)*
*Defined in [pairs.ts:34](https://github.com/polkadot-js/common/blob/1e6eb2c/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/06cc692/packages/keyring/src/pairs.ts#L49)*
*Defined in [pairs.ts:49](https://github.com/polkadot-js/common/blob/1e6eb2c/packages/keyring/src/pairs.ts#L49)*
**Parameters:**