feat(account-api): add wallet.status

Author: ccharly

packages/account-api/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add wallet `status` ([#367](https://github.com/MetaMask/accounts/pull/367))
+
 ## [0.10.0]
 
 ### Added

packages/account-api/src/api/multichain/wallet.ts

@@ -6,7 +6,7 @@ import {
 import type { MultichainAccountGroup } from './group';
 import type { Bip44Account } from '../bip44';
 import type { AccountWallet } from '../wallet';
-import { AccountWalletType } from '../wallet';
+import { AccountWalletStatus, AccountWalletType } from '../wallet';
 
 /**
  * Multichain account wallet ID.
@@ -28,6 +28,34 @@ export type ParsedMultichainAccountWalletId = {
   subId: string;
 };
 
+/**
+ * Wallet status.
+ *
+ * Those status are used to report in which "state" the wallet is currently
+ * in. All of those operations cannot run concurrently, thus, the wallet
+ * cannot have multiple status at once.
+ */
+export const MultichainAccountWalletStatus = {
+  ...AccountWalletStatus,
+
+  /**
+   * Discovery is in progress for this wallet. New account groups will be
+   * automatically added based on the account provider discovery result.
+   */
+  DiscoveryInProgress: 'discovery-in-progress',
+  /**
+   * Alignment is in progress for this wallet. Account groups will be
+   * automatically updated based on the active account providers.
+   */
+  AlignmentInProgress: 'alignment-in-progress',
+  /**
+   * An on-going operation (creating/deleting) is in progress for this
+   * wallet. Account groups will either be created or deleted during
+   * this operation.
+   */
+  OperationInProgress: 'operation-in-progress',
+} as const;
+
 /**
  * A multichain account wallet that holds multiple multichain accounts (one multichain account per
  * group index).
@@ -50,6 +78,11 @@ export type MultichainAccountWallet<
    */
   get entropySource(): EntropySourceId;
 
+  /**
+   * Multichain account wallet status.
+   */
+  get status(): (typeof MultichainAccountWalletStatus)[keyof typeof MultichainAccountWalletStatus];
+
   /**
    * Gets multichain account for a given index.
    *

packages/account-api/src/api/wallet.ts

@@ -30,6 +30,24 @@ export type AccountWalletId = `${AccountWalletType}:${string}`;
 export const ACCOUNT_WALLET_ID_REGEX =
   /^(?<walletType>entropy|keyring|snap):(?<walletSubId>.+)$/u;
 
+/**
+ * Wallet status.
+ *
+ * Those status are used to report in which "state" the wallet is currently
+ * in. All of those operations cannot run concurrently, thus, the wallet
+ * cannot have multiple status at once.
+ */
+export const AccountWalletStatus = {
+  /**
+   * The wallet is not initialized yet.
+   */
+  Uninitialized: 'uninitialized',
+  /**
+   * The wallet is ready to run any operation.
+   */
+  Ready: 'ready',
+} as const;
+
 /**
  * Parsed account wallet ID with its wallet type and sub-ID.
  */
@@ -52,6 +70,11 @@ export type AccountWallet<Account extends KeyringAccount> = {
    */
   get type(): AccountWalletType;
 
+  /**
+   * Account wallet status.
+   */
+  get status(): (typeof AccountWalletStatus)[keyof typeof AccountWalletStatus];
+
   /**
    * Gets account group for a given ID.
    *