@metamask-previews/keyring-controller 7.1.0-preview.3dbf14f

package/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [7.1.0]
+### Added
+- Add `getEncryptionPublicKey` method on KeyringController ([#1569](https://github.com/MetaMask/core/pull/1569))
+
+## [7.0.0]
+### Changed
+- **BREAKING**: Remove `keyringTypes` property from the KeyringController state ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING**: Constructor `KeyringControllerOptions` type changed ([#1441](https://github.com/MetaMask/core/pull/1441))
+  - The `KeyringControllerOptions.state` accepted type is now `{ vault?: string }`
+  - The `KeyringControllerOptions.keyringBuilders` type is now `{ (): Keyring<Json>; type: string }[]`
+- **BREAKING**: The `address` type accepted by the `removeAccount` method is now `Hex` ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING**: The `signTypedMessage` method now returns a `Promise<string>` ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING**: The `signTransaction` method now requires a `TypedTransaction` from `@ethereumjs/tx@^4` for the `transaction` argument, and returns a `Promise<TxData>` ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING:** Rename `Keyring` type to `KeyringObject` ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING:** `addNewAccount` now throws if address of new account is not a hex string ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING:** `exportSeedPhrase` now throws if first keyring does not have a mnemonic ([#1441](https://github.com/MetaMask/core/pull/1441))
+- **BREAKING:** `verifySeedPhrase` now throws if HD keyring does not have a mnemonic ([#1441](https://github.com/MetaMask/core/pull/1441))
+- Update return type of `getAccountKeyringType` to `Promise<string>` ([#1441](https://github.com/MetaMask/core/pull/1441))
+- Update `@metamask/eth-keyring-controller` to `^13.0.0` ([#1441](https://github.com/MetaMask/core/pull/1441))
+- Update `@metamask/utils` to `^6.2.0` ([#1514](https://github.com/MetaMask/core/pull/1514))
+- Update `@ethereumjs/tx` to `^4.2.0` ([#1514](https://github.com/MetaMask/core/pull/1514))
+- Update `@ethereumjs/common` to `^3.2.0` ([#1514](https://github.com/MetaMask/core/pull/1514))
+- Update `@keystonehq/metamask-airgapped-keyring` to `^0.13.1` ([#1514](https://github.com/MetaMask/core/pull/1514))
+
+## [6.1.0]
+### Changed
+- Bump @metamask/eth-sig-util to ^6.0.0 ([#1483](https://github.com/MetaMask/core/pull/1483))
+
+## [6.0.0]
+### Added
+- Add messenger events `KeyringController:lock` and `KeyringController:unlock`, emitted when the inner EthKeyringController is locked/unlocked ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - Also add corresponding types `KeyringControllerLockEvent` and `KeyringControllerUnlockEvent`
+- Add `KeyringController:accountRemoved` event, fired whenever an account is removed through `removeAccount` ([#1416](https://github.com/MetaMask/core/pull/1416))
+
+### Changed
+- **BREAKING:** Update constructor to take a single argument, an options bag, instead of three arguments ([#1378](https://github.com/MetaMask/core/pull/1378))
+- **BREAKING:** Update controller so state is now accessible via `controller.state` instead of `controller.store.getState()` ([#1378](https://github.com/MetaMask/core/pull/1378))
+- **BREAKING:** Update KeyringController to take a required `messenger` option ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - The messenger will now publish `KeyringController:stateChange` on state changes thanks to BaseControllerV2
+  - The messenger features a `KeyringController:getState` action thanks to BaseControllerV2
+  - Add types `KeyringControllerGetStateAction` and `KeyringControllerStateChangeEvent` for the above
+  - Add type `KeyringControllerMessenger`
+- **BREAKING:** Update `keyringState` property in the return value of several methods from a type of `KeyringMemState` to `KeyringControllerMemState` ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - The affected methods are:
+    - `addNewAccount`
+    - `addNewAccountWithoutUpdate`
+    - `createNewVaultAndRestore`
+    - `createNewVaultAndKeychain`
+    - `importAccountWithStrategy`
+    - `removeAccount`
+    - `setLocked`
+    - `submitEncryptionKey`
+    - `submitPassword`
+  - The new type omits `vault`, `encryptionKey`, and `encryptionSalt`
+- **BREAKING:** Remove `KeyringState`, `KeyringMemState`, and `KeyringConfig` in favor of new types `KeyringControllerState`, `KeyringControllerMemState`, `KeyringControllerActions`, `KeyringControllerEvents`, and `KeyringControllerOptions` ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - `KeyringControllerState` is like the previous `KeyringMemState` but with an extra `vault` property
+  - `KeyringControllerMemState` is like the previous `KeyringMemState` but without `encryptionKey` or `encryptionSalt`
+  - `KeyringControllerOptions` incorporates the previous set of options and `KeyringConfig`
+- Add `immer` as a dependency ([#1378](https://github.com/MetaMask/core/pull/1378))
+
+### Removed
+- **BREAKING:** Remove `subscribe` and `unsubscribe` methods ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - State changes can be directly subscribed to (or unsubscribed from) via the messenger if necessary
+- **BREAKING:** Remove `lock` and `unlock` methods ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - `KeyringController:lock` and `KeyringController:unlock` may now be subscribed to via the messenger if necessary
+- **BREAKING:** Remove `fullUpdate` method ([#1378](https://github.com/MetaMask/core/pull/1378))
+  - There is no need to call this method anymore because the controller should always be up to date with the EthKeyringController instance
+- **BREAKING:** Remove `index` from the `Keyring` type ([#1378](https://github.com/MetaMask/core/pull/1378))
+
+## [5.1.0]
+### Added
+- Add `cancelQRSynchronization` method ([#1387](https://github.com/MetaMask/core.git/pull/1387))
+
+## [5.0.0]
+### Added
+- Add support for encryption keys ([#1342](https://github.com/MetaMask/core/pull/1342))
+  - The configuration option `cacheEncryptionKey` has been added, along with two new state properties (`encryptionKey` and `encryptionSalt`) and a new method (`submitEncryptionKey`)
+  - All new state and config entries are optional, so this will have no effect if you're not using this feature.
+- Make `addNewAccount` idempotent ([#1298](https://github.com/MetaMask/core/pull/1298))
+  - The `addNewAccount` method now takes an optional `accountCount` parameter. If provided, we ensure that this can be called repeatedly with the same result.
+- Add deprecated `getKeyringForAccount` and `getKeyringsByType` methods ([#1376](https://github.com/MetaMask/core/pull/1376), [#1386](https://github.com/MetaMask/core/pull/1386))
+
+### Changed
+- **BREAKING:** Bump to Node 16 ([#1262](https://github.com/MetaMask/core/pull/1262))
+- **BREAKING:** Change return type of `createNewVaultAndRestore` from `string | number[]` to `Uint8Array` ([#1349](https://github.com/MetaMask/core/pull/1349))
+- **BREAKING:** Change return type of `verifySeedPhrase` from `string` to  `Uint8Array` ([#1338](https://github.com/MetaMask/core/pull/1338))
+- **BREAKING:** Replace `validatePassword` with `verifyPassword` ([#1348](https://github.com/MetaMask/core/pull/1348))
+  - `verifyPassword` is asynchronous, unlike `validatePassword` which was not.
+  - `verifyPassword` does not return a boolean to indicate whether the password is valid. Instead an error is thrown when it's invalid.
+- **BREAKING:** `createNewVaultAndKeychain` will now skip vault creation if one already exists, rather than replacing it ([#1324](https://github.com/MetaMask/core/pull/1324))
+  - If you do want to replace a vault if one exists, you will have to remove it first before this is called.
+- **BREAKING:** `importAccountWithStrategy` and `addNewAccount` no longer update the selected address ([#1296](https://github.com/MetaMask/core/pull/1296), [#1309](https://github.com/MetaMask/core/pull/1309))
+  - If you want the newly imported account to be selected, you will have to do that manually after this is called.
+- **BREAKING:** Change `importAccountWithStrategy` return type ([#1295](https://github.com/MetaMask/core/pull/1295))
+  - `importAccountWithStrategy` now returns an object with `keyringState` and `importedAccountAddress`, rather than just the keyring state.
+- **BREAKING:** Change `addNewAccount` return type ([#1294](https://github.com/MetaMask/core/pull/1294))
+  - `addNewAccount` now returns an object with `keyringState` and `addedAccountAddress`, rather than just the keyring state.
+- **BREAKING:** Add `@metamask/preferences-controller` peer dependency ([#1393](https://github.com/MetaMask/core/pull/1393))
+- Bump @metamask/eth-keyring-controller from 10.0.0 to 10.0.1 ([#1280](https://github.com/MetaMask/core/pull/1280))
+- Bump @metamask/eth-sig-util from 5.0.2 to 5.0.3 ([#1278](https://github.com/MetaMask/core/pull/1278))
+- Update `@metamask/preferences-controller` dependency
+
+### Fixed
+- Improve validation of `from` address in `signTypedMessage` ([#1293](https://github.com/MetaMask/core/pull/1293))
+- Improve private key validation in `importAccountWithStrategy` ([#1297](https://github.com/MetaMask/core/pull/1297))
+  - A more helpful error is now thrown when the given private key has the wrong length
+- Keep `vault` state in sync with the internal `EthKeyringController` vault state ([#1384](https://github.com/MetaMask/core/pull/1384))
+  - Previously the `vault` state would never be updated after construction, becoming stale as account changes were made
+  - The old behavior was especially confusing because the `subscribe` method is overridden to return state change events from the internal `EthKeyingController` state, resulting in state change events being out of sync with controller state. They should be the same now.
+
+## [4.0.0]
+### Removed
+- **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
+  - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
+
+## [3.0.0]
+### Changed
+- **BREAKING:**: Bump eth-keyring-controller version to @metamask/eth-keyring-controller v10 ([#1072](https://github.com/MetaMask/core.git/pull/1072))
+  - `exportSeedPhrase` now returns a `Uint8Array` typed SRP (can be converted to a string using [this approach](https://github.com/MetaMask/eth-hd-keyring/blob/53b0570559595ba5b3fd8c80e900d847cd6dee3d/index.js#L40)).  It was previously a Buffer.
+  - The HD keyring included with the keyring controller has been updated from v4 to v6. See [the `eth-hd-keyring` changelog entries for v5 and v6](https://github.com/MetaMask/eth-hd-keyring/blob/main/CHANGELOG.md#600) for further details on breaking changes.
+
+## [2.0.0]
+### Changed
+- **BREAKING:**: Require ES2020 support or greater ([#914](https://github.com/MetaMask/controllers/pull/914))
+    - This change was introduced by an indirect dependency on `ethereumjs/util` v8
+- Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
+- Update `@metamask/eth-sig-util` to v5 ([#914](https://github.com/MetaMask/controllers/pull/914))
+- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041))
+
+## [1.0.1]
+### Changed
+- Relax dependencies on `@metamask/base-controller`, `@metamask/controller-utils`, `@metamask/message-manager`, and `@metamask/preferences-controller` (use `^` instead of `~`) ([#998](https://github.com/MetaMask/core/pull/998))
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/core/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/core/tree/v33.0.0), namely:
+    - Everything in `src/keyring`
+
+    All changes listed after this point were applied to this package following the monorepo conversion.
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@7.1.0...HEAD
+[7.1.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@7.0.0...@metamask/keyring-controller@7.1.0
+[7.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@6.1.0...@metamask/keyring-controller@7.0.0
+[6.1.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@6.0.0...@metamask/keyring-controller@6.1.0
+[6.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@5.1.0...@metamask/keyring-controller@6.0.0
+[5.1.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@5.0.0...@metamask/keyring-controller@5.1.0
+[5.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@4.0.0...@metamask/keyring-controller@5.0.0
+[4.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@3.0.0...@metamask/keyring-controller@4.0.0
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@2.0.0...@metamask/keyring-controller@3.0.0
+[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@1.0.1...@metamask/keyring-controller@2.0.0
+[1.0.1]: https://github.com/MetaMask/core/compare/@metamask/keyring-controller@1.0.0...@metamask/keyring-controller@1.0.1
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/keyring-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/keyring-controller`
+
+Stores identities seen in the wallet and manages interactions such as signing.
+
+## Installation
+
+`yarn add @metamask/keyring-controller`
+
+or
+
+`npm install @metamask/keyring-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/KeyringController.d.ts

@@ -0,0 +1,369 @@
+import type { TxData, TypedTransaction } from '@ethereumjs/tx';
+import { type MetaMaskKeyring as QRKeyring, type IKeyringState as IQRKeyringState } from '@keystonehq/metamask-airgapped-keyring';
+import type { RestrictedControllerMessenger } from '@metamask/base-controller';
+import { BaseControllerV2 } from '@metamask/base-controller';
+import type { PersonalMessageParams, TypedMessageParams } from '@metamask/message-manager';
+import type { PreferencesController } from '@metamask/preferences-controller';
+import { type Hex, type Keyring, type Json } from '@metamask/utils';
+import type { Patch } from 'immer';
+declare const name = "KeyringController";
+/**
+ * Available keyring types
+ */
+export declare enum KeyringTypes {
+    simple = "Simple Key Pair",
+    hd = "HD Key Tree",
+    qr = "QR Hardware Wallet Device"
+}
+/**
+ * @type KeyringControllerState
+ *
+ * Keyring controller state
+ * @property vault - Encrypted string representing keyring data
+ * @property isUnlocked - Whether vault is unlocked
+ * @property keyringTypes - Account types
+ * @property keyrings - Group of accounts
+ * @property encryptionKey - Keyring encryption key
+ * @property encryptionSalt - Keyring encryption salt
+ */
+export declare type KeyringControllerState = {
+    vault?: string;
+    isUnlocked: boolean;
+    keyrings: KeyringObject[];
+    encryptionKey?: string;
+    encryptionSalt?: string;
+};
+export declare type KeyringControllerMemState = Omit<KeyringControllerState, 'vault' | 'encryptionKey' | 'encryptionSalt'>;
+export declare type KeyringControllerGetStateAction = {
+    type: `${typeof name}:getState`;
+    handler: () => KeyringControllerState;
+};
+export declare type KeyringControllerStateChangeEvent = {
+    type: `${typeof name}:stateChange`;
+    payload: [KeyringControllerState, Patch[]];
+};
+export declare type KeyringControllerAccountRemovedEvent = {
+    type: `${typeof name}:accountRemoved`;
+    payload: [string];
+};
+export declare type KeyringControllerLockEvent = {
+    type: `${typeof name}:lock`;
+    payload: [];
+};
+export declare type KeyringControllerUnlockEvent = {
+    type: `${typeof name}:unlock`;
+    payload: [];
+};
+export declare type KeyringControllerActions = KeyringControllerGetStateAction;
+export declare type KeyringControllerEvents = KeyringControllerStateChangeEvent | KeyringControllerLockEvent | KeyringControllerUnlockEvent | KeyringControllerAccountRemovedEvent;
+export declare type KeyringControllerMessenger = RestrictedControllerMessenger<typeof name, KeyringControllerActions, KeyringControllerEvents, string, string>;
+export declare type KeyringControllerOptions = {
+    removeIdentity: PreferencesController['removeIdentity'];
+    syncIdentities: PreferencesController['syncIdentities'];
+    updateIdentities: PreferencesController['updateIdentities'];
+    setSelectedAddress: PreferencesController['setSelectedAddress'];
+    setAccountLabel?: PreferencesController['setAccountLabel'];
+    encryptor?: any;
+    keyringBuilders?: {
+        (): Keyring<Json>;
+        type: string;
+    }[];
+    cacheEncryptionKey?: boolean;
+    messenger: KeyringControllerMessenger;
+    state?: {
+        vault?: string;
+    };
+};
+/**
+ * @type KeyringObject
+ *
+ * Keyring object to return in fullUpdate
+ * @property type - Keyring type
+ * @property accounts - Associated accounts
+ */
+export declare type KeyringObject = {
+    accounts: string[];
+    type: string;
+};
+/**
+ * A strategy for importing an account
+ */
+export declare enum AccountImportStrategy {
+    privateKey = "privateKey",
+    json = "json"
+}
+/**
+ * The `signTypedMessage` version
+ *
+ * @see https://docs.metamask.io/guide/signing-data.html
+ */
+export declare enum SignTypedDataVersion {
+    V1 = "V1",
+    V3 = "V3",
+    V4 = "V4"
+}
+/**
+ * Controller responsible for establishing and managing user identity.
+ *
+ * This class is a wrapper around the `eth-keyring-controller` package. The
+ * `eth-keyring-controller` manages the "vault", which is an encrypted store of private keys, and
+ * it manages the wallet "lock" state. This wrapper class has convenience methods for interacting
+ * with the internal keyring controller and handling certain complex operations that involve the
+ * keyrings.
+ */
+export declare class KeyringController extends BaseControllerV2<typeof name, KeyringControllerState, KeyringControllerMessenger> {
+    #private;
+    private readonly mutex;
+    private readonly removeIdentity;
+    private readonly syncIdentities;
+    private readonly updateIdentities;
+    private readonly setSelectedAddress;
+    private readonly setAccountLabel?;
+    /**
+     * Creates a KeyringController instance.
+     *
+     * @param opts - Initial options used to configure this controller
+     * @param opts.removeIdentity - Remove the identity with the given address.
+     * @param opts.syncIdentities - Sync identities with the given list of addresses.
+     * @param opts.updateIdentities - Generate an identity for each address given that doesn't already have an identity.
+     * @param opts.setSelectedAddress - Set the selected address.
+     * @param opts.setAccountLabel - Set a new name for account.
+     * @param opts.encryptor - An optional object for defining encryption schemes.
+     * @param opts.keyringBuilders - Set a new name for account.
+     * @param opts.cacheEncryptionKey - Whether to cache or not encryption key.
+     * @param opts.messenger - A restricted controller messenger.
+     * @param opts.state - Initial state to set on this controller.
+     */
+    constructor({ removeIdentity, syncIdentities, updateIdentities, setSelectedAddress, setAccountLabel, encryptor, keyringBuilders, cacheEncryptionKey, messenger, state, }: KeyringControllerOptions);
+    /**
+     * Adds a new account to the default (first) HD seed phrase keyring.
+     *
+     * @param accountCount - Number of accounts before adding a new one, used to
+     * make the method idempotent.
+     * @returns Promise resolving to keyring current state and added account
+     * address.
+     */
+    addNewAccount(accountCount?: number): Promise<{
+        keyringState: KeyringControllerMemState;
+        addedAccountAddress: string;
+    }>;
+    /**
+     * Adds a new account to the specified keyring.
+     *
+     * @param keyring - Keyring to add the account to.
+     * @param accountCount - Number of accounts before adding a new one, used to make the method idempotent.
+     * @returns Promise resolving to keyring current state and added account
+     */
+    addNewAccountForKeyring(keyring: Keyring<Json>, accountCount?: number): Promise<Hex>;
+    /**
+     * Adds a new account to the default (first) HD seed phrase keyring without updating identities in preferences.
+     *
+     * @returns Promise resolving to current state when the account is added.
+     */
+    addNewAccountWithoutUpdate(): Promise<KeyringControllerMemState>;
+    /**
+     * Effectively the same as creating a new keychain then populating it
+     * using the given seed phrase.
+     *
+     * @param password - Password to unlock keychain.
+     * @param seed - A BIP39-compliant seed phrase as Uint8Array,
+     * either as a string or an array of UTF-8 bytes that represent the string.
+     * @returns Promise resolving to the restored keychain object.
+     */
+    createNewVaultAndRestore(password: string, seed: Uint8Array): Promise<KeyringControllerMemState>;
+    /**
+     * Create a new primary keychain and wipe any previous keychains.
+     *
+     * @param password - Password to unlock the new vault.
+     * @returns Newly-created keychain object.
+     */
+    createNewVaultAndKeychain(password: string): Promise<KeyringControllerMemState>;
+    /**
+     * Adds a new keyring of the given `type`.
+     *
+     * @param type - Keyring type name.
+     * @param opts - Keyring options.
+     * @throws If a builder for the given `type` does not exist.
+     * @returns Promise resolving to the added keyring.
+     */
+    addNewKeyring(type: KeyringTypes | string, opts?: unknown): Promise<Keyring<Json>>;
+    /**
+     * Method to verify a given password validity. Throws an
+     * error if the password is invalid.
+     *
+     * @param password - Password of the keyring.
+     */
+    verifyPassword(password: string): Promise<void>;
+    /**
+     * Returns the status of the vault.
+     *
+     * @returns Boolean returning true if the vault is unlocked.
+     */
+    isUnlocked(): boolean;
+    /**
+     * Gets the seed phrase of the HD keyring.
+     *
+     * @param password - Password of the keyring.
+     * @returns Promise resolving to the seed phrase.
+     */
+    exportSeedPhrase(password: string): Promise<Uint8Array>;
+    /**
+     * Gets the private key from the keyring controlling an address.
+     *
+     * @param password - Password of the keyring.
+     * @param address - Address to export.
+     * @returns Promise resolving to the private key for an address.
+     */
+    exportAccount(password: string, address: string): Promise<string>;
+    /**
+     * Returns the public addresses of all accounts for the current keyring.
+     *
+     * @returns A promise resolving to an array of addresses.
+     */
+    getAccounts(): Promise<string[]>;
+    /**
+     * Get encryption public key.
+     *
+     * @param account - An account address.
+     * @param opts - Additional encryption options.
+     * @throws If the `account` does not exist or does not support the `getEncryptionPublicKey` method
+     * @returns Promise resolving to encyption public key of the `account` if one exists.
+     */
+    getEncryptionPublicKey(account: string, opts?: Record<string, unknown>): Promise<string>;
+    /**
+     * Returns the currently initialized keyring that manages
+     * the specified `address` if one exists.
+     *
+     * @deprecated Use of this method is discouraged as actions executed directly on
+     * keyrings are not being reflected in the KeyringController state and not
+     * persisted in the vault.
+     * @param account - An account address.
+     * @returns Promise resolving to keyring of the `account` if one exists.
+     */
+    getKeyringForAccount(account: string): Promise<unknown>;
+    /**
+     * Returns all keyrings of the given type.
+     *
+     * @deprecated Use of this method is discouraged as actions executed directly on
+     * keyrings are not being reflected in the KeyringController state and not
+     * persisted in the vault.
+     * @param type - Keyring type name.
+     * @returns An array of keyrings of the given type.
+     */
+    getKeyringsByType(type: KeyringTypes | string): unknown[];
+    /**
+     * Persist all serialized keyrings in the vault.
+     *
+     * @returns Promise resolving with `true` value when the
+     * operation completes.
+     */
+    persistAllKeyrings(): Promise<boolean>;
+    /**
+     * Imports an account with the specified import strategy.
+     *
+     * @param strategy - Import strategy name.
+     * @param args - Array of arguments to pass to the underlying stategy.
+     * @throws Will throw when passed an unrecognized strategy.
+     * @returns Promise resolving to keyring current state and imported account
+     * address.
+     */
+    importAccountWithStrategy(strategy: AccountImportStrategy, args: any[]): Promise<{
+        keyringState: KeyringControllerMemState;
+        importedAccountAddress: string;
+    }>;
+    /**
+     * Removes an account from keyring state.
+     *
+     * @param address - Address of the account to remove.
+     * @fires KeyringController:accountRemoved
+     * @returns Promise resolving current state when this account removal completes.
+     */
+    removeAccount(address: Hex): Promise<KeyringControllerMemState>;
+    /**
+     * Deallocates all secrets and locks the wallet.
+     *
+     * @returns Promise resolving to current state.
+     */
+    setLocked(): Promise<KeyringControllerMemState>;
+    /**
+     * Signs message by calling down into a specific keyring.
+     *
+     * @param messageParams - PersonalMessageParams object to sign.
+     * @returns Promise resolving to a signed message string.
+     */
+    signMessage(messageParams: PersonalMessageParams): Promise<string>;
+    /**
+     * Signs personal message by calling down into a specific keyring.
+     *
+     * @param messageParams - PersonalMessageParams object to sign.
+     * @returns Promise resolving to a signed message string.
+     */
+    signPersonalMessage(messageParams: PersonalMessageParams): Promise<string>;
+    /**
+     * Signs typed message by calling down into a specific keyring.
+     *
+     * @param messageParams - TypedMessageParams object to sign.
+     * @param version - Compatibility version EIP712.
+     * @throws Will throw when passed an unrecognized version.
+     * @returns Promise resolving to a signed message string or an error if any.
+     */
+    signTypedMessage(messageParams: TypedMessageParams, version: SignTypedDataVersion): Promise<string>;
+    /**
+     * Signs a transaction by calling down into a specific keyring.
+     *
+     * @param transaction - Transaction object to sign. Must be a `ethereumjs-tx` transaction instance.
+     * @param from - Address to sign from, should be in keychain.
+     * @returns Promise resolving to a signed transaction string.
+     */
+    signTransaction(transaction: TypedTransaction, from: string): Promise<TxData>;
+    /**
+     * Attempts to decrypt the current vault and load its keyrings,
+     * using the given encryption key and salt.
+     *
+     * @param encryptionKey - Key to unlock the keychain.
+     * @param encryptionSalt - Salt to unlock the keychain.
+     * @returns Promise resolving to the current state.
+     */
+    submitEncryptionKey(encryptionKey: string, encryptionSalt: string): Promise<KeyringControllerMemState>;
+    /**
+     * Attempts to decrypt the current vault and load its keyrings,
+     * using the given password.
+     *
+     * @param password - Password to unlock the keychain.
+     * @returns Promise resolving to the current state.
+     */
+    submitPassword(password: string): Promise<KeyringControllerMemState>;
+    /**
+     * Verifies the that the seed phrase restores the current keychain's accounts.
+     *
+     * @returns Promise resolving to the seed phrase as Uint8Array.
+     */
+    verifySeedPhrase(): Promise<Uint8Array>;
+    /**
+     * Get qr hardware keyring.
+     *
+     * @returns The added keyring
+     */
+    getOrAddQRKeyring(): Promise<QRKeyring>;
+    restoreQRKeyring(serialized: any): Promise<void>;
+    resetQRKeyringState(): Promise<void>;
+    getQRKeyringState(): Promise<IQRKeyringState>;
+    submitQRCryptoHDKey(cryptoHDKey: string): Promise<void>;
+    submitQRCryptoAccount(cryptoAccount: string): Promise<void>;
+    submitQRSignature(requestId: string, ethSignature: string): Promise<void>;
+    cancelQRSignRequest(): Promise<void>;
+    /**
+     * Cancels qr keyring sync.
+     */
+    cancelQRSynchronization(): Promise<void>;
+    connectQRHardware(page: number): Promise<{
+        balance: string;
+        address: string;
+        index: number;
+    }[]>;
+    unlockQRHardwareWalletAccount(index: number): Promise<void>;
+    getAccountKeyringType(account: string): Promise<string>;
+    forgetQRDevice(): Promise<void>;
+}
+export default KeyringController;
+//# sourceMappingURL=KeyringController.d.ts.map

package/dist/KeyringController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyringController.d.ts","sourceRoot":"","sources":["../src/KeyringController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EACL,KAAK,eAAe,IAAI,SAAS,EACjC,KAAK,aAAa,IAAI,eAAe,EACtC,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,KAAK,EACV,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAGL,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,IAAI,EACV,MAAM,iBAAiB,CAAC;AAWzB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,QAAA,MAAM,IAAI,sBAAsB,CAAC;AAEjC;;GAEG;AACH,oBAAY,YAAY;IACtB,MAAM,oBAAoB;IAC1B,EAAE,gBAAgB;IAClB,EAAE,8BAA8B;CACjC;AAED;;;;;;;;;;GAUG;AACH,oBAAY,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,oBAAY,yBAAyB,GAAG,IAAI,CAC1C,sBAAsB,EACtB,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAC7C,CAAC;AAEF,oBAAY,+BAA+B,GAAG;IAC5C,IAAI,EAAE,GAAG,OAAO,IAAI,WAAW,CAAC;IAChC,OAAO,EAAE,MAAM,sBAAsB,CAAC;CACvC,CAAC;AAEF,oBAAY,iCAAiC,GAAG;IAC9C,IAAI,EAAE,GAAG,OAAO,IAAI,cAAc,CAAC;IACnC,OAAO,EAAE,CAAC,sBAAsB,EAAE,KAAK,EAAE,CAAC,CAAC;CAC5C,CAAC;AAEF,oBAAY,oCAAoC,GAAG;IACjD,IAAI,EAAE,GAAG,OAAO,IAAI,iBAAiB,CAAC;IACtC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;CACnB,CAAC;AAEF,oBAAY,0BAA0B,GAAG;IACvC,IAAI,EAAE,GAAG,OAAO,IAAI,OAAO,CAAC;IAC5B,OAAO,EAAE,EAAE,CAAC;CACb,CAAC;AAEF,oBAAY,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,IAAI,SAAS,CAAC;IAC9B,OAAO,EAAE,EAAE,CAAC;CACb,CAAC;AAEF,oBAAY,wBAAwB,GAAG,+BAA+B,CAAC;AAEvE,oBAAY,uBAAuB,GAC/B,iCAAiC,GACjC,0BAA0B,GAC1B,4BAA4B,GAC5B,oCAAoC,CAAC;AAEzC,oBAAY,0BAA0B,GAAG,6BAA6B,CACpE,OAAO,IAAI,EACX,wBAAwB,EACxB,uBAAuB,EACvB,MAAM,EACN,MAAM,CACP,CAAC;AAEF,oBAAY,wBAAwB,GAAG;IACrC,cAAc,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IACxD,cAAc,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IACxD,gBAAgB,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAC5D,kBAAkB,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IAChE,eAAe,CAAC,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;IAC3D,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,eAAe,CAAC,EAAE;QAAE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACxD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5B,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB;IAC/B,UAAU,eAAe;IACzB,IAAI,SAAS;CACd;AAED;;;;GAIG;AACH,oBAAY,oBAAoB;IAC9B,EAAE,OAAO;IACT,EAAE,OAAO;IACT,EAAE,OAAO;CACV;AA0BD;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB,CACrD,OAAO,IAAI,EACX,sBAAsB,EACtB,0BAA0B,CAC3B;;IACC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IAErC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0C;IAEzE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0C;IAEzE,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4C;IAE7E,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA8C;IAEjF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAA2C;IAI5E;;;;;;;;;;;;;;OAcG;gBACS,EACV,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,SAAS,EACT,eAAe,EACf,kBAA0B,EAC1B,SAAS,EACT,KAAK,GACN,EAAE,wBAAwB;IAmC3B;;;;;;;OAOG;IACG,aAAa,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAClD,YAAY,EAAE,yBAAyB,CAAC;QACxC,mBAAmB,EAAE,MAAM,CAAC;KAC7B,CAAC;IAqCF;;;;;;OAMG;IACG,uBAAuB,CAC3B,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,GAAG,CAAC;IAqBf;;;;OAIG;IACG,0BAA0B,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAWtE;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,yBAAyB,CAAC;IAgBrC;;;;;OAKG;IACG,yBAAyB,CAAC,QAAQ,EAAE,MAAM;IAchD;;;;;;;OAOG;IACG,aAAa,CACjB,IAAI,EAAE,YAAY,GAAG,MAAM,EAC3B,IAAI,CAAC,EAAE,OAAO,GACb,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAIzB;;;;;OAKG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM;IAIrC;;;;OAIG;IACH,UAAU,IAAI,OAAO;IAIrB;;;;;OAKG;IACG,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAM7D;;;;;;OAMG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKvE;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIhC;;;;;;;OAOG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;;;;OASG;IACG,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;;;;;;OAQG;IACH,iBAAiB,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,OAAO,EAAE;IAIzD;;;;;OAKG;IACG,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAI5C;;;;;;;;OAQG;IACG,yBAAyB,CAC7B,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,GAAG,EAAE,GACV,OAAO,CAAC;QACT,YAAY,EAAE,yBAAyB,CAAC;QACxC,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IAqDF;;;;;;OAMG;IACG,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAOrE;;;;OAIG;IACG,SAAS,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAKrD;;;;;OAKG;IACH,WAAW,CAAC,aAAa,EAAE,qBAAqB;IAOhD;;;;;OAKG;IACH,mBAAmB,CAAC,aAAa,EAAE,qBAAqB;IAIxD;;;;;;;OAOG;IACG,gBAAgB,CACpB,aAAa,EAAE,kBAAkB,EACjC,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,MAAM,CAAC;IA4BlB;;;;;;OAMG;IACH,eAAe,CACb,WAAW,EAAE,gBAAgB,EAC7B,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC;IAIlB;;;;;;;OAOG;IACG,mBAAmB,CACvB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,yBAAyB,CAAC;IAKrC;;;;;;OAMG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAO1E;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,UAAU,CAAC;IA+C7C;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,SAAS,CAAC;IAQvC,gBAAgB,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhD,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIpC,iBAAiB,IAAI,OAAO,CAAC,eAAe,CAAC;IAI7C,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC;IAIV,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1C;;OAEG;IACG,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxC,iBAAiB,CACrB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IA2B3D,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB3D,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvD,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA2DtC;AAED,eAAe,iBAAiB,CAAC"}