@polkadot/keyring

constructor

constructor(options?: KeyringOptions);

property decodeAddress

decodeAddress: any;

property encodeAddress

encodeAddress: (address: Uint8Array | string, ss58Format?: number) => string;

• encodeAddress Encodes the input into an ss58 representation

property pairs

readonly pairs: KeyringPair[];

• retrieve the pairs (alias for getPairs)

property publicKeys

readonly publicKeys: Uint8Array[];

• retrieve the publicKeys (alias for getPublicKeys)

property type

readonly type: KeypairType;

• Returns the type of the keyring, ed25519, sr25519 or ecdsa

method addFromAddress

addFromAddress: (
    address: string | Uint8Array,
    meta?: KeyringPair$Meta,
    encoded?: Uint8Array | null,
    type?: KeypairType,
    ignoreChecksum?: boolean,
    encType?: EncryptedJsonEncoding[]
) => KeyringPair;

• 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.

method addFromJson

addFromJson: (json: KeyringPair$Json, ignoreChecksum?: boolean) => KeyringPair;

• 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.

method addFromMnemonic

addFromMnemonic: (
    mnemonic: string,
    meta?: KeyringPair$Meta,
    type?: KeypairType
) => KeyringPair;

• addFromMnemonic 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.

method addFromPair

addFromPair: (
    pair: Keypair,
    meta?: KeyringPair$Meta,
    type?: KeypairType
) => KeyringPair;

• addFromPair Stores an account created from an explicit publicKey/secreteKey combination

method addFromSeed

addFromSeed: (
    seed: Uint8Array,
    meta?: KeyringPair$Meta,
    type?: KeypairType
) => KeyringPair;

• addFromSeed 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.

method addFromUri

addFromUri: (
    suri: string,
    meta?: KeyringPair$Meta,
    type?: KeypairType
) => KeyringPair;

• addFromUri 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)

method addPair

addPair: (pair: KeyringPair) => KeyringPair;

• addPair Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary

method createFromJson

createFromJson: (
    {
        address,
        encoded,
        encoding: { content, type, version },
        meta,
    }: KeyringPair$Json,
    ignoreChecksum?: boolean
) => KeyringPair;

• createFromJson Creates a pair from a JSON keyfile

method createFromPair

createFromPair: (
    pair: Keypair,
    meta?: KeyringPair$Meta,
    type?: KeypairType
) => KeyringPair;

• createFromPair Creates a pair from an explicit publicKey/secreteKey combination

method createFromUri

createFromUri: (
    _suri: string,
    meta?: KeyringPair$Meta,
    type?: KeypairType
) => KeyringPair;

• createFromUri Creates a Keypair from an suri This creates a pair from the suri, but does not add it to the keyring

method getPair

getPair: (address: string | Uint8Array) => KeyringPair;

• getPair 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).

method getPairs

getPairs: () => KeyringPair[];

• getPairs Retrieves all account keyring pairs from the Keyring Pair Dictionary Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary.

method getPublicKeys

getPublicKeys: () => Uint8Array[];

• 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.

method removePair

removePair: (address: string | Uint8Array) => void;

• removePair Deletes the provided input address or public key from the stored Keyring Pair Dictionary.

method setSS58Format

setSS58Format: (ss58: number) => void;

• setSS58Format; Sets the ss58 format for the keyring

method toJson

toJson: (address: string | Uint8Array, passphrase?: string) => KeyringPair$Json;

• 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](https://github.com/polkadot-js/apps) the user may backup their account to a JSON file that contains this information.