@polkadot/keyring
Advanced tools
Comparing version 0.34.3 to 0.34.4
@@ -32,3 +32,2 @@ import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$Meta, KeyringOptions, PairType } from './types'; | ||
* @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 | ||
@@ -39,3 +38,2 @@ */ | ||
* @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 | ||
@@ -50,3 +48,2 @@ * @description Allows user to explicitely provide separate inputs including account address or public key, and optionally | ||
* @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 | ||
@@ -60,3 +57,2 @@ * @description Allows user to provide a json object argument that contains account information (that may be obtained from the json file | ||
* @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 | ||
@@ -71,3 +67,2 @@ * @description Allows user to provide a mnemonic (seed phrase that is provided when account is originally created) | ||
* @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 | ||
@@ -81,3 +76,2 @@ * @description Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value. | ||
* @name getPair | ||
* @signature getPair (address: string | Uint8Array): KeyringPair | ||
* @summary Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address | ||
@@ -90,3 +84,2 @@ * @description Returns a keyring pair value from the keyring pair dictionary by performing | ||
* @name getPairs | ||
* @signature getPairs (): Array<KeyringPair> | ||
* @summary Retrieves all account keyring pairs from the Keyring Pair Dictionary | ||
@@ -98,3 +91,2 @@ * @description Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary. | ||
* @name getPublicKeys | ||
* @signature getPublicKeys (): Array<Uint8Array> | ||
* @summary Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary | ||
@@ -106,3 +98,2 @@ * @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. | ||
* @name removePair | ||
* @signature removePair (address: string | Uint8Array): void | ||
* @description Deletes the provided input address or public key from the stored Keyring Pair Dictionary. | ||
@@ -113,3 +104,2 @@ */ | ||
* @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 | ||
@@ -116,0 +106,0 @@ * @description Returns a JSON object containing the metadata associated with an account |
10
index.js
@@ -81,3 +81,2 @@ "use strict"; | ||
* @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 | ||
@@ -92,3 +91,2 @@ */ | ||
* @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 | ||
@@ -109,3 +107,2 @@ * @description Allows user to explicitely provide separate inputs including account address or public key, and optionally | ||
* @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 | ||
@@ -126,3 +123,2 @@ * @description Allows user to provide a json object argument that contains account information (that may be obtained from the json file | ||
* @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 | ||
@@ -141,3 +137,2 @@ * @description Allows user to provide a mnemonic (seed phrase that is provided when account is originally created) | ||
* @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 | ||
@@ -158,3 +153,2 @@ * @description Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value. | ||
* @name getPair | ||
* @signature getPair (address: string | Uint8Array): KeyringPair | ||
* @summary Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address | ||
@@ -171,3 +165,2 @@ * @description Returns a keyring pair value from the keyring pair dictionary by performing | ||
* @name getPairs | ||
* @signature getPairs (): Array<KeyringPair> | ||
* @summary Retrieves all account keyring pairs from the Keyring Pair Dictionary | ||
@@ -183,3 +176,2 @@ * @description Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary. | ||
* @name getPublicKeys | ||
* @signature getPublicKeys (): Array<Uint8Array> | ||
* @summary Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary | ||
@@ -198,3 +190,2 @@ * @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. | ||
* @name removePair | ||
* @signature removePair (address: string | Uint8Array): void | ||
* @description Deletes the provided input address or public key from the stored Keyring Pair Dictionary. | ||
@@ -209,3 +200,2 @@ */ | ||
* @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 | ||
@@ -212,0 +202,0 @@ * @description Returns a JSON object containing the metadata associated with an account |
{ | ||
"name": "@polkadot/keyring", | ||
"version": "0.34.3", | ||
"version": "0.34.4", | ||
"description": "Keyring management", | ||
@@ -34,4 +34,4 @@ "main": "index.js", | ||
"@babel/runtime": "^7.2.0", | ||
"@polkadot/util": "^0.34.3", | ||
"@polkadot/util-crypto": "^0.34.3", | ||
"@polkadot/util": "^0.34.4", | ||
"@polkadot/util-crypto": "^0.34.4", | ||
"@types/bs58": "^4.0.0", | ||
@@ -38,0 +38,0 @@ "bs58": "^4.0.1" |
import { KeyringInstance, KeyringOptions } from './types'; | ||
/** | ||
* @name testKeyring | ||
* @signature testKeyring (): KeyringInstance | ||
* @summary Create an instance of Keyring pre-populated with locked test accounts | ||
@@ -6,0 +5,0 @@ * @description The test accounts (i.e. alice, bob, dave, eve, ferdie) |
@@ -38,3 +38,2 @@ "use strict"; | ||
* @name testKeyring | ||
* @signature testKeyring (): KeyringInstance | ||
* @summary Create an instance of Keyring pre-populated with locked test accounts | ||
@@ -41,0 +40,0 @@ * @description The test accounts (i.e. alice, bob, dave, eve, ferdie) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
66280
1103
Updated@polkadot/util@^0.34.4