14 KiB
@polkadot/common/keyring
Overview
name: Keyring
summary: Keyring management of user accounts
description: Allows generation of keyring pairs from a variety of input combinations, such as json object containing account address or public key, account metadata, and account encoded using addFromJson, or by providing those values as arguments separately to addFromAddress, or by providing the mnemonic (seed phrase) and account metadata as arguments to addFromMnemonic. Stores the keyring pairs in a keyring pair dictionary. Removal of the keyring pairs from the keyring pair dictionary is achieved using removePair. Retrieval of all the stored pairs via getPairs or perform lookup of a pair for a given account address or public key using getPair. JSON metadata associated with an account may be obtained using toJson accompanied by the account passphrase.
Hierarchy
Keyring
Implements
Constructors
constructor
⊕ new Keyring(options?: KeyringOptions): Keyring
Defined in index.ts:32
Parameters:
| Name | Type | Default value |
|---|---|---|
Default value options |
KeyringOptions | { type: 'ed25519' } |
Returns: Keyring
Properties
decodeAddress
● decodeAddress: decode = decodeAddress
Implementation of KeyringInstance.decodeAddress
Defined in index.ts:43
encodeAddress
● encodeAddress: encode = encodeAddress
Implementation of KeyringInstance.encodeAddress
Defined in index.ts:44
setAddressPrefix
● setAddressPrefix: setPrefix = setAddressPrefix
Implementation of KeyringInstance.setAddressPrefix
Defined in index.ts:45
Accessors
pairs
get pairs(): Array<KeyringPair>
Defined in index.ts:50
description: retrieve the pairs (alias for getPairs)
Returns: Array<KeyringPair>
publicKeys
get publicKeys(): Array<Uint8Array>
Defined in index.ts:57
description: retrieve the publicKeys (alias for getPiblicKeys)
Returns: Array<Uint8Array>
type
get type(): KeyringPairType
Defined in index.ts:64
description: Returns the type of the keyring, either ed25519 of sr25519
Returns: KeyringPairType
Methods
addFromAddress
▸ addFromAddress(address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeyringPairType): KeyringPair
Implementation of KeyringInstance.addFromAddress
Defined in index.ts:84
name: addFromAddress
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.
Parameters:
| Name | Type | Default value |
|---|---|---|
| address | string | Uint8Array |
- |
Default value meta |
KeyringPair$Meta | {} |
Default value encoded |
Uint8Array | null |
null |
Default value type |
KeyringPairType | this.type |
Returns: KeyringPair
addFromJson
▸ addFromJson(__namedParameters: object): KeyringPair
Defined in index.ts:95
name: addFromJson
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.
Parameters:
| Name | Type |
|---|---|
| __namedParameters | object |
Returns: KeyringPair
addFromMnemonic
▸ addFromMnemonic(mnemonic: string, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair
Implementation of KeyringInstance.addFromMnemonic
Defined in index.ts:110
name: addFromMnemonic
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.
Parameters:
| Name | Type | Default value |
|---|---|---|
| mnemonic | string |
- |
Default value meta |
KeyringPair$Meta | {} |
Default value type |
KeyringPairType | this.type |
Returns: KeyringPair
addFromSeed
▸ addFromSeed(seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeyringPairType): KeyringPair
Implementation of KeyringInstance.addFromSeed
Defined in index.ts:121
name: addFromSeed
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.
Parameters:
| Name | Type | Default value |
|---|---|---|
| seed | Uint8Array |
- |
Default value meta |
KeyringPair$Meta | {} |
Default value type |
KeyringPairType | this.type |
Returns: KeyringPair
addPair
▸ addPair(pair: KeyringPair): KeyringPair
Implementation of KeyringInstance.addPair
Defined in index.ts:72
name: addPair
summary: Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary
Parameters:
| Name | Type |
|---|---|
| pair | KeyringPair |
Returns: KeyringPair
getPair
▸ getPair(address: string | Uint8Array): KeyringPair
Implementation of KeyringInstance.getPair
Defined in index.ts:135
name: getPair
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).
Parameters:
| Name | Type |
|---|---|
| address | string | Uint8Array |
Returns: KeyringPair
getPairs
▸ getPairs(): Array<KeyringPair>
Implementation of KeyringInstance.getPairs
Defined in index.ts:144
name: getPairs
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.
Returns: Array<KeyringPair>
getPublicKeys
▸ getPublicKeys(): Array<Uint8Array>
Implementation of KeyringInstance.getPublicKeys
Defined in index.ts:153
name: getPublicKeys
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.
Returns: Array<Uint8Array>
removePair
▸ removePair(address: string | Uint8Array): void
Implementation of KeyringInstance.removePair
Defined in index.ts:165
name: removePair
description: Deletes the provided input address or public key from the stored Keyring Pair Dictionary.
Parameters:
| Name | Type |
|---|---|
| address | string | Uint8Array |
Returns: void
toJson
▸ toJson(address: string | Uint8Array, passphrase?: undefined | string): KeyringPair$Json
Implementation of KeyringInstance.toJson
Defined in index.ts:177
name: toJson
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 the user may backup their account to a JSON file that contains this information.
Parameters:
| Name | Type |
|---|---|
| address | string | Uint8Array |
Optional passphrase |
undefined | string |
Returns: KeyringPair$Json