Private #privateOptional encoded: string | Uint8ArrayOptional ignoreChecksum: booleanOptional ss58Format: numberencodeAddress
Encodes the input into an ss58 representation
Optional ss58Format: numberretrieve the pairs (alias for getPairs)
retrieve the publicKeys (alias for getPublicKeys)
Returns the type of the keyring, ed25519, sr25519 or ecdsa
addFromAddress
Stores an account, given an account address, as a Key/Value (public key, pair) in Keyring Pair Dictionary
Allows user to explicitly 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.
Optional meta: KeyringPair$MetaOptional encoded: Uint8ArrayOptional type: KeypairTypeOptional ignoreChecksum: booleanOptional encType: EncryptedJsonEncoding[]addFromJson
Stores an account, given JSON data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
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.
Optional ignoreChecksum: booleanaddFromMnemonic
Stores an account, given a mnemonic, as a Key/Value (public key, pair) in Keyring Pair Dictionary
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.
Optional meta: KeyringPair$MetaOptional type: KeypairTypeaddFromSeed
Stores an account, given seed data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
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.
Optional meta: KeyringPair$MetaOptional type: KeypairTypeaddFromUri
Creates an account via an suri
Extracts the phrase, path and password from a SURI format for specifying secret keys <secret>/<soft-key>//<hard-key>///<password> (the ///password may be omitted, and /<soft-key> and //<hard-key> maybe repeated and mixed). The secret can be a hex string, mnemonic phrase or a string (to be padded)
Optional meta: KeyringPair$MetaOptional type: KeypairTypecreateFromUri
Creates a Keypair from an suri
This creates a pair from the suri, but does not add it to the keyring
Optional meta: KeyringPair$MetaOptional type: KeypairTypegetPair
Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address
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).
getPublicKeys
Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary
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.
toJson
Returns a JSON object associated with the input argument that contains metadata assocated with an account
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.
Optional passphrase: stringGenerated using TypeDoc
@polkadot/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 toaddFromAddress, or by providing the mnemonic (seed phrase) and account metadata as arguments toaddFromMnemonic. Stores the keyring pairs in a keyring pair dictionary. Removal of the keyring pairs from the keyring pair dictionary is achieved usingremovePair. Retrieval of all the stored pairs viagetPairsor perform lookup of a pair for a given account address or public key usinggetPair. JSON metadata associated with an account may be obtained usingtoJsonaccompanied by the account passphrase.