@metamask-previews/mfa-recovery-controller 0.0.0-preview-c5fdaa9c8 → 0.0.0-preview-5e24e4d22

package/CHANGELOG.md

@@ -7,30 +7,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Added
-
-- Add `MfaRecoveryController` for replicating an MFA recovery secret across injected escrow replicas ([#10022](https://github.com/MetaMask/core/pull/10022))
-  - Public methods: `register`, `updateRecoverySecret`, `updateIdentifiers`, `authenticateIdentifier`, `getRecoverySecret`, `resume`, `abort`, and `getPhase`
-  - Inject `RecoveryAuthProvider`, `RecoveryIdentifierAuthProvider`, `RecoveryEscrowProvider[]`, and `PendingOperationEncryptor`
-  - Persist only an encrypted `authorizing` / `writing` pending mutation (`idle` when `pendingOperation` is `null`)
-  - `register` and `updateIdentifiers` require at least two distinct identifiers (`MIN_IDENTIFIERS`)
-  - Identifier types `passkey`, `oidc`, and `siwe` are key-bound; `emailOtp` / `smsOtp` are not wired yet
-  - `getRecoverySecret` returns `{ recoverySecret, epoch }`; pass that `epoch` into later `updateRecoverySecret` / `updateIdentifiers` calls (register uses `0`). Does not block on a pending mutation; returns the highest consistent version across available escrows
-  - Mutation `payloadHash` is the hash of the logical pending payload (`identifiers` and/or `0x`-hex secret). At apply, each escrow receives `{ pkE, ciphertext }` wrapped to its own wrap key with escrow-wrap-v1
-  - `getSecret` request hashes bind the client's ephemeral `pkE`; responses are `{ ciphertext }` plus `wrapKeyId`
-  - `Mutation.audiences` is the configured replica-id list, in that order. Each replica should require an exact match
-  - `MutationReceipt` includes `receiptKeyId`. `RecoveryEscrowProvider.verifyReceipt` takes the expected escrow id and verifies with that replica's receipt key
-  - `AuthControllerToken.expiresAt` and `PoPChallenge.expiresAt` are Unix seconds
-  - Mutations require idle pending state (`resume()` / `abort()` first). `abort()` drops `authorizing` only; `writing` must be finished with `resume()`
-  - `CubistEscrowProvider` invokes Cubist escrow commands through `@cubist-labs/cubesigner-sdk` `policyInvoke` (`ping`, `generateChallenge`, `applyMutation`, `getSecret` on `cubist_secret_escrow`) and verifies receipts with a pinned receipt public key
-  - `authenticateIdentifier` returns an in-memory `IdentifierSession` for key-bound recovery-secret reads
-
-### Changed
-
-- **BREAKING:** `getRecoverySecret` now accepts an `IdentifierSession` returned by `authenticateIdentifier` instead of an `Identifier`
-
-### Fixed
-
-- Clear a pending mutation when every escrow rejects it before applying, so a second `register` or an update with a stale epoch does not stay in `writing`. `resume()` still retries an incomplete write, and `abort()` still refuses a `writing` mutation that may have been applied
-
 [Unreleased]: https://github.com/MetaMask/core/

package/LICENSE.APACHE2

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2026 MetaMask
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,13 +1,6 @@
 # `@metamask/mfa-recovery-controller`
 
-Manages MFA recovery flows across MetaMask clients. Auth and escrow storage are
-injected so the same controller can run against different identity providers and
-escrow backends.
-
-Pending mutations are persisted as encoded encrypted `authorizing` / `writing`
-state so a crash can `resume()` the same mutation. `abort()` drops `authorizing`
-only; `writing` must `resume()`. The encoded ciphertext is stored as a string so
-BaseController state serialization preserves the encrypted value.
+Manages MFA recovery flows across MetaMask clients
 
 ## Installation
 

package/dist/index.d.ts

@@ -1,9 +1,8 @@
-export { MfaRecoveryController, getDefaultMfaRecoveryControllerState, } from './MfaRecoveryController.js';
-export type { MfaRecoveryControllerActions, MfaRecoveryControllerEvents, MfaRecoveryControllerGetStateAction, MfaRecoveryControllerMessenger, MfaRecoveryControllerOptions, MfaRecoveryControllerState, MfaRecoveryControllerStateChangedEvent, } from './MfaRecoveryController.js';
-export type { MfaRecoveryControllerAbortAction, MfaRecoveryControllerAuthenticateIdentifierAction, MfaRecoveryControllerGetPhaseAction, MfaRecoveryControllerGetRecoverySecretAction, MfaRecoveryControllerRegisterAction, MfaRecoveryControllerResumeAction, MfaRecoveryControllerUpdateIdentifiersAction, MfaRecoveryControllerUpdateRecoverySecretAction, } from './MfaRecoveryController-method-action-types.js';
-export { CubistEscrowProvider } from './escrow-providers/cubist-escrow-provider.js';
-export type { CubistEscrowProviderOptions } from './escrow-providers/cubist-escrow-provider.js';
-export { IncompleteMutationError, MfaRecoveryError, MutationRejectedError, } from './errors.js';
-export { IDENTIFIER_AUTH_MODES, MIN_IDENTIFIERS, getIdentifierAuthMode, } from './identifier-auth.js';
-export type { AuthControllerToken, EcPublicJwk, EncryptedPendingOperation, Identifier, IdentifierAuthorization, IdentifierSession, Mutation, MutationPayload, MutationReceipt, PendingMutationPayload, PendingOperation, PendingOperationEncryptor, PendingRecoverySecretHex, PendingRegisterPayload, PendingUpdateIdentifiersPayload, PendingUpdateRecoverySecretPayload, RecoveryAuthProvider, RecoveryEscrowProvider, RecoveryIdentifierAuthProvider, RecoveryPhase, RecoveredSecret, WrappedSecret, WrappedSecretOutput, } from './types.js';
+/**
+ * Example function that returns a greeting for the given name.
+ *
+ * @param name - The name to greet.
+ * @returns The greeting.
+ */
+export default function greeter(name: string): string;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,mCAAmC,EACnC,8BAA8B,EAC9B,4BAA4B,EAC5B,0BAA0B,EAC1B,sCAAsC,GACvC,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACV,gCAAgC,EAChC,iDAAiD,EACjD,mCAAmC,EACnC,4CAA4C,EAC5C,mCAAmC,EACnC,iCAAiC,EACjC,4CAA4C,EAC5C,+CAA+C,GAChD,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,YAAY,EAAE,2BAA2B,EAAE,MAAM,8CAA8C,CAAC;AAChG,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,qBAAqB,EACrB,eAAe,EACf,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,mBAAmB,EACnB,WAAW,EACX,yBAAyB,EACzB,UAAU,EACV,uBAAuB,EACvB,iBAAiB,EACjB,QAAQ,EACR,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACxB,sBAAsB,EACtB,+BAA+B,EAC/B,kCAAkC,EAClC,oBAAoB,EACpB,sBAAsB,EACtB,8BAA8B,EAC9B,aAAa,EACb,eAAe,EACf,aAAa,EACb,mBAAmB,GACpB,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEpD"}

package/dist/index.js

@@ -1,5 +1,10 @@
-export { MfaRecoveryController, getDefaultMfaRecoveryControllerState, } from './MfaRecoveryController.js';
-export { CubistEscrowProvider } from './escrow-providers/cubist-escrow-provider.js';
-export { IncompleteMutationError, MfaRecoveryError, MutationRejectedError, } from './errors.js';
-export { IDENTIFIER_AUTH_MODES, MIN_IDENTIFIERS, getIdentifierAuthMode, } from './identifier-auth.js';
+/**
+ * Example function that returns a greeting for the given name.
+ *
+ * @param name - The name to greet.
+ * @returns The greeting.
+ */
+export default function greeter(name) {
+    return `Hello, ${name}!`;
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AAoBpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AAEpF,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,qBAAqB,EACrB,eAAe,EACf,qBAAqB,GACtB,MAAM,sBAAsB,CAAC","sourcesContent":["export {\n  MfaRecoveryController,\n  getDefaultMfaRecoveryControllerState,\n} from './MfaRecoveryController.js';\nexport type {\n  MfaRecoveryControllerActions,\n  MfaRecoveryControllerEvents,\n  MfaRecoveryControllerGetStateAction,\n  MfaRecoveryControllerMessenger,\n  MfaRecoveryControllerOptions,\n  MfaRecoveryControllerState,\n  MfaRecoveryControllerStateChangedEvent,\n} from './MfaRecoveryController.js';\nexport type {\n  MfaRecoveryControllerAbortAction,\n  MfaRecoveryControllerAuthenticateIdentifierAction,\n  MfaRecoveryControllerGetPhaseAction,\n  MfaRecoveryControllerGetRecoverySecretAction,\n  MfaRecoveryControllerRegisterAction,\n  MfaRecoveryControllerResumeAction,\n  MfaRecoveryControllerUpdateIdentifiersAction,\n  MfaRecoveryControllerUpdateRecoverySecretAction,\n} from './MfaRecoveryController-method-action-types.js';\nexport { CubistEscrowProvider } from './escrow-providers/cubist-escrow-provider.js';\nexport type { CubistEscrowProviderOptions } from './escrow-providers/cubist-escrow-provider.js';\nexport {\n  IncompleteMutationError,\n  MfaRecoveryError,\n  MutationRejectedError,\n} from './errors.js';\nexport {\n  IDENTIFIER_AUTH_MODES,\n  MIN_IDENTIFIERS,\n  getIdentifierAuthMode,\n} from './identifier-auth.js';\nexport type {\n  AuthControllerToken,\n  EcPublicJwk,\n  EncryptedPendingOperation,\n  Identifier,\n  IdentifierAuthorization,\n  IdentifierSession,\n  Mutation,\n  MutationPayload,\n  MutationReceipt,\n  PendingMutationPayload,\n  PendingOperation,\n  PendingOperationEncryptor,\n  PendingRecoverySecretHex,\n  PendingRegisterPayload,\n  PendingUpdateIdentifiersPayload,\n  PendingUpdateRecoverySecretPayload,\n  RecoveryAuthProvider,\n  RecoveryEscrowProvider,\n  RecoveryIdentifierAuthProvider,\n  RecoveryPhase,\n  RecoveredSecret,\n  WrappedSecret,\n  WrappedSecretOutput,\n} from './types.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,IAAY;IAC1C,OAAO,UAAU,IAAI,GAAG,CAAC;AAC3B,CAAC","sourcesContent":["/**\n * Example function that returns a greeting for the given name.\n *\n * @param name - The name to greet.\n * @returns The greeting.\n */\nexport default function greeter(name: string): string {\n  return `Hello, ${name}!`;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/mfa-recovery-controller",
-  "version": "0.0.0-preview-c5fdaa9c8",
+  "version": "0.0.0-preview-5e24e4d22",
   "description": "Manages MFA recovery flows across MetaMask clients",
   "keywords": [
     "Ethereum",
@@ -39,40 +39,24 @@
     "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/mfa-recovery-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/mfa-recovery-controller",
-    "cubesigner:invoke-escrow": "tsx scripts/invoke-escrow.ts",
-    "cubesigner:register": "tsx scripts/register-with-controller.ts",
     "lint:tsconfigs": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../scripts/lint-tsconfigs/lint-tsconfigs.ts",
     "lint:tsconfigs:fix": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../scripts/lint-tsconfigs/lint-tsconfigs.ts --fix",
-    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --check",
-    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --esm --generate",
+    "messenger-action-types:check": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
+    "messenger-action-types:generate": "node --import ../../scripts/resolver/register.ts --experimental-transform-types ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
     "since-latest-release": "../../scripts/since-latest-release.sh",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
-    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
-    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
-    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
-  },
-  "dependencies": {
-    "@cubist-labs/cubesigner-sdk": "^0.4.284",
-    "@metamask/base-controller": "^10.0.0",
-    "@metamask/messenger": "^3.0.0",
-    "@metamask/utils": "^12.0.0",
-    "@noble/ciphers": "^1.3.0",
-    "@noble/curves": "^1.9.7",
-    "@noble/hashes": "^1.8.0"
+    "test": "vitest",
+    "test:clean": "vitest --clearCache",
+    "test:verbose": "vitest --reporter=verbose",
+    "test:watch": "vitest --watch"
   },
   "devDependencies": {
-    "@cubist-labs/cubesigner-sdk-fs-storage": "^0.4.284",
     "@metamask/auto-changelog": "^6.2.1",
-    "@types/jest": "^30.0.0",
     "@typescript/native": "npm:typescript@^7.0.2",
-    "deepmerge": "^4.3.1",
-    "jest": "^30.5.2",
     "rimraf": "^6.1.3",
-    "ts-jest": "^29.4.14",
-    "tsx": "^4.20.5",
     "typedoc": "^0.28.20",
     "typedoc-plugin-missing-exports": "^4.1.4",
-    "typescript": "npm:@typescript/typescript6@^6.0.2"
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
+    "vitest": "^5.0.0"
   },
   "engines": {
     "node": "^22.14.0 || ^24"

package/dist/MfaRecoveryController-method-action-types.d.ts

@@ -1,88 +0,0 @@
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-import type { MfaRecoveryController } from './MfaRecoveryController.js';
-/**
- * Creates version 1 of a recovery record.
- *
- * @param recoverySecret - Secret replicated in full to every escrow.
- * @param identifiers - Ownership-approved identifier set. Must contain at
- * least two identifiers.
- */
-export type MfaRecoveryControllerRegisterAction = {
-    type: `MfaRecoveryController:register`;
-    handler: MfaRecoveryController['register'];
-};
-/**
- * Replaces the recovery secret.
- *
- * @param identifier - Currently registered identifier used to authorize.
- * @param recoverySecret - New secret.
- * @param epoch - Current recovery version, used as `expectedVersion`.
- */
-export type MfaRecoveryControllerUpdateRecoverySecretAction = {
-    type: `MfaRecoveryController:updateRecoverySecret`;
-    handler: MfaRecoveryController['updateRecoverySecret'];
-};
-/**
- * Replaces the complete identifier set.
- *
- * @param identifier - Currently registered identifier used to authorize.
- * @param identifiers - New identifier set. Must contain at least two
- * identifiers.
- * @param epoch - Current recovery version, used as `expectedVersion`.
- */
-export type MfaRecoveryControllerUpdateIdentifiersAction = {
-    type: `MfaRecoveryController:updateIdentifiers`;
-    handler: MfaRecoveryController['updateIdentifiers'];
-};
-/**
- * Authenticates an identifier for a subsequent recovery-secret read.
- *
- * @param identifier - Identifier to authenticate.
- * @returns Ephemeral session data required by {@link getRecoverySecret}.
- */
-export type MfaRecoveryControllerAuthenticateIdentifierAction = {
-    type: `MfaRecoveryController:authenticateIdentifier`;
-    handler: MfaRecoveryController['authenticateIdentifier'];
-};
-/**
- * Reads the recovery secret from available escrows and returns the highest
- * consistent version. `epoch` is the current recovery version and is required
- * by later mutations. Does not wait for a pending mutation to be repaired.
- *
- * @param session - Identifier authentication session used to authorize the
- * read.
- * @returns Recovered secret bytes and the selected epoch.
- */
-export type MfaRecoveryControllerGetRecoverySecretAction = {
-    type: `MfaRecoveryController:getRecoverySecret`;
-    handler: MfaRecoveryController['getRecoverySecret'];
-};
-/**
- * Completes a persisted pending mutation, if any.
- */
-export type MfaRecoveryControllerResumeAction = {
-    type: `MfaRecoveryController:resume`;
-    handler: MfaRecoveryController['resume'];
-};
-/**
- * Drops `authorizing` pending. `writing` must be finished with {@link resume}.
- */
-export type MfaRecoveryControllerAbortAction = {
-    type: `MfaRecoveryController:abort`;
-    handler: MfaRecoveryController['abort'];
-};
-/**
- * @returns Current recovery phase.
- */
-export type MfaRecoveryControllerGetPhaseAction = {
-    type: `MfaRecoveryController:getPhase`;
-    handler: MfaRecoveryController['getPhase'];
-};
-/**
- * Union of all MfaRecoveryController action types.
- */
-export type MfaRecoveryControllerMethodActions = MfaRecoveryControllerRegisterAction | MfaRecoveryControllerUpdateRecoverySecretAction | MfaRecoveryControllerUpdateIdentifiersAction | MfaRecoveryControllerAuthenticateIdentifierAction | MfaRecoveryControllerGetRecoverySecretAction | MfaRecoveryControllerResumeAction | MfaRecoveryControllerAbortAction | MfaRecoveryControllerGetPhaseAction;
-//# sourceMappingURL=MfaRecoveryController-method-action-types.d.ts.map

package/dist/MfaRecoveryController-method-action-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MfaRecoveryController-method-action-types.d.ts","sourceRoot":"","sources":["../src/MfaRecoveryController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;CAC1D,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,4CAA4C,GAAG;IACzD,IAAI,EAAE,yCAAyC,CAAC;IAChD,OAAO,EAAE,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC;CAC1C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC1C,mCAAmC,GACnC,+CAA+C,GAC/C,4CAA4C,GAC5C,iDAAiD,GACjD,4CAA4C,GAC5C,iCAAiC,GACjC,gCAAgC,GAChC,mCAAmC,CAAC"}

package/dist/MfaRecoveryController-method-action-types.js

@@ -1,6 +0,0 @@
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-export {};
-//# sourceMappingURL=MfaRecoveryController-method-action-types.js.map

package/dist/MfaRecoveryController-method-action-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MfaRecoveryController-method-action-types.js","sourceRoot":"","sources":["../src/MfaRecoveryController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { MfaRecoveryController } from './MfaRecoveryController.js';\n\n/**\n * Creates version 1 of a recovery record.\n *\n * @param recoverySecret - Secret replicated in full to every escrow.\n * @param identifiers - Ownership-approved identifier set. Must contain at\n * least two identifiers.\n */\nexport type MfaRecoveryControllerRegisterAction = {\n  type: `MfaRecoveryController:register`;\n  handler: MfaRecoveryController['register'];\n};\n\n/**\n * Replaces the recovery secret.\n *\n * @param identifier - Currently registered identifier used to authorize.\n * @param recoverySecret - New secret.\n * @param epoch - Current recovery version, used as `expectedVersion`.\n */\nexport type MfaRecoveryControllerUpdateRecoverySecretAction = {\n  type: `MfaRecoveryController:updateRecoverySecret`;\n  handler: MfaRecoveryController['updateRecoverySecret'];\n};\n\n/**\n * Replaces the complete identifier set.\n *\n * @param identifier - Currently registered identifier used to authorize.\n * @param identifiers - New identifier set. Must contain at least two\n * identifiers.\n * @param epoch - Current recovery version, used as `expectedVersion`.\n */\nexport type MfaRecoveryControllerUpdateIdentifiersAction = {\n  type: `MfaRecoveryController:updateIdentifiers`;\n  handler: MfaRecoveryController['updateIdentifiers'];\n};\n\n/**\n * Authenticates an identifier for a subsequent recovery-secret read.\n *\n * @param identifier - Identifier to authenticate.\n * @returns Ephemeral session data required by {@link getRecoverySecret}.\n */\nexport type MfaRecoveryControllerAuthenticateIdentifierAction = {\n  type: `MfaRecoveryController:authenticateIdentifier`;\n  handler: MfaRecoveryController['authenticateIdentifier'];\n};\n\n/**\n * Reads the recovery secret from available escrows and returns the highest\n * consistent version. `epoch` is the current recovery version and is required\n * by later mutations. Does not wait for a pending mutation to be repaired.\n *\n * @param session - Identifier authentication session used to authorize the\n * read.\n * @returns Recovered secret bytes and the selected epoch.\n */\nexport type MfaRecoveryControllerGetRecoverySecretAction = {\n  type: `MfaRecoveryController:getRecoverySecret`;\n  handler: MfaRecoveryController['getRecoverySecret'];\n};\n\n/**\n * Completes a persisted pending mutation, if any.\n */\nexport type MfaRecoveryControllerResumeAction = {\n  type: `MfaRecoveryController:resume`;\n  handler: MfaRecoveryController['resume'];\n};\n\n/**\n * Drops `authorizing` pending. `writing` must be finished with {@link resume}.\n */\nexport type MfaRecoveryControllerAbortAction = {\n  type: `MfaRecoveryController:abort`;\n  handler: MfaRecoveryController['abort'];\n};\n\n/**\n * @returns Current recovery phase.\n */\nexport type MfaRecoveryControllerGetPhaseAction = {\n  type: `MfaRecoveryController:getPhase`;\n  handler: MfaRecoveryController['getPhase'];\n};\n\n/**\n * Union of all MfaRecoveryController action types.\n */\nexport type MfaRecoveryControllerMethodActions =\n  | MfaRecoveryControllerRegisterAction\n  | MfaRecoveryControllerUpdateRecoverySecretAction\n  | MfaRecoveryControllerUpdateIdentifiersAction\n  | MfaRecoveryControllerAuthenticateIdentifierAction\n  | MfaRecoveryControllerGetRecoverySecretAction\n  | MfaRecoveryControllerResumeAction\n  | MfaRecoveryControllerAbortAction\n  | MfaRecoveryControllerGetPhaseAction;\n"]}

package/dist/MfaRecoveryController.d.ts

@@ -1,119 +0,0 @@
-import type { ControllerGetStateAction, ControllerStateChangedEvent } from '@metamask/base-controller';
-import { BaseController } from '@metamask/base-controller';
-import type { Messenger } from '@metamask/messenger';
-import type { MfaRecoveryControllerMethodActions } from './MfaRecoveryController-method-action-types.js';
-import type { Identifier, IdentifierSession, PendingOperationEncryptor, RecoveryAuthProvider, RecoveryEscrowProvider, RecoveryIdentifierAuthProvider, RecoveryPhase, RecoveredSecret } from './types.js';
-declare const CONTROLLER_NAME = "MfaRecoveryController";
-export type MfaRecoveryControllerState = {
-    /**
-     * Encrypted pending mutation, or `null` when idle.
-     */
-    pendingOperation: string | null;
-};
-/**
- * @returns The default {@link MfaRecoveryController} state.
- */
-export declare function getDefaultMfaRecoveryControllerState(): MfaRecoveryControllerState;
-export type MfaRecoveryControllerGetStateAction = ControllerGetStateAction<typeof CONTROLLER_NAME, MfaRecoveryControllerState>;
-export type MfaRecoveryControllerActions = MfaRecoveryControllerGetStateAction | MfaRecoveryControllerMethodActions;
-type AllowedActions = never;
-export type MfaRecoveryControllerStateChangedEvent = ControllerStateChangedEvent<typeof CONTROLLER_NAME, MfaRecoveryControllerState>;
-export type MfaRecoveryControllerEvents = MfaRecoveryControllerStateChangedEvent;
-type AllowedEvents = never;
-export type MfaRecoveryControllerMessenger = Messenger<typeof CONTROLLER_NAME, MfaRecoveryControllerActions | AllowedActions, MfaRecoveryControllerEvents | AllowedEvents>;
-export type MfaRecoveryControllerOptions = {
-    /**
-     * The messenger suited for this controller.
-     */
-    messenger: MfaRecoveryControllerMessenger;
-    /**
-     * The desired state with which to initialize this controller. Missing
-     * properties will be filled in with defaults.
-     */
-    state?: Partial<MfaRecoveryControllerState>;
-    /**
-     * Authenticates the MetaMask profile and issues request-bound attestations.
-     */
-    authProvider: RecoveryAuthProvider;
-    /**
-     * Obtains key-bound identifier tokens from an IdP.
-     */
-    identifierAuthProvider: RecoveryIdentifierAuthProvider;
-    /**
-     * Ordered, non-empty set of recovery escrow replicas. This is build-time
-     * configuration; public methods cannot override it.
-     */
-    escrows: RecoveryEscrowProvider[];
-    /**
-     * Encrypts pending mutation state using wallet secure storage.
-     */
-    pendingOperationEncryptor: PendingOperationEncryptor;
-    /**
-     * Clock used for AuthController token expiry checks. Unix seconds.
-     * Defaults to {@link unixNow}.
-     */
-    now?: () => number;
-};
-/**
- * Coordinates MFA recovery secret replication across independent escrows.
- */
-export declare class MfaRecoveryController extends BaseController<typeof CONTROLLER_NAME, MfaRecoveryControllerState, MfaRecoveryControllerMessenger> {
-    #private;
-    constructor({ messenger, state, authProvider, identifierAuthProvider, escrows, pendingOperationEncryptor, now, }: MfaRecoveryControllerOptions);
-    /**
-     * Creates version 1 of a recovery record.
-     *
-     * @param recoverySecret - Secret replicated in full to every escrow.
-     * @param identifiers - Ownership-approved identifier set. Must contain at
-     * least two identifiers.
-     */
-    register(recoverySecret: Uint8Array, identifiers: Identifier[]): Promise<void>;
-    /**
-     * Replaces the recovery secret.
-     *
-     * @param identifier - Currently registered identifier used to authorize.
-     * @param recoverySecret - New secret.
-     * @param epoch - Current recovery version, used as `expectedVersion`.
-     */
-    updateRecoverySecret(identifier: Identifier, recoverySecret: Uint8Array, epoch: number): Promise<void>;
-    /**
-     * Replaces the complete identifier set.
-     *
-     * @param identifier - Currently registered identifier used to authorize.
-     * @param identifiers - New identifier set. Must contain at least two
-     * identifiers.
-     * @param epoch - Current recovery version, used as `expectedVersion`.
-     */
-    updateIdentifiers(identifier: Identifier, identifiers: Identifier[], epoch: number): Promise<void>;
-    /**
-     * Authenticates an identifier for a subsequent recovery-secret read.
-     *
-     * @param identifier - Identifier to authenticate.
-     * @returns Ephemeral session data required by {@link getRecoverySecret}.
-     */
-    authenticateIdentifier(identifier: Identifier): Promise<IdentifierSession>;
-    /**
-     * Reads the recovery secret from available escrows and returns the highest
-     * consistent version. `epoch` is the current recovery version and is required
-     * by later mutations. Does not wait for a pending mutation to be repaired.
-     *
-     * @param session - Identifier authentication session used to authorize the
-     * read.
-     * @returns Recovered secret bytes and the selected epoch.
-     */
-    getRecoverySecret(session: IdentifierSession): Promise<RecoveredSecret>;
-    /**
-     * Completes a persisted pending mutation, if any.
-     */
-    resume(): Promise<void>;
-    /**
-     * Drops `authorizing` pending. `writing` must be finished with {@link resume}.
-     */
-    abort(): Promise<void>;
-    /**
-     * @returns Current recovery phase.
-     */
-    getPhase(): Promise<RecoveryPhase>;
-}
-export {};
-//# sourceMappingURL=MfaRecoveryController.d.ts.map

package/dist/MfaRecoveryController.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MfaRecoveryController.d.ts","sourceRoot":"","sources":["../src/MfaRecoveryController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAiCrD,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,gDAAgD,CAAC;AAOzG,OAAO,KAAK,EAGV,UAAU,EACV,iBAAiB,EAMjB,yBAAyB,EAIzB,oBAAoB,EACpB,sBAAsB,EACtB,8BAA8B,EAC9B,aAAa,EACb,eAAe,EAGhB,MAAM,YAAY,CAAC;AAEpB,QAAA,MAAM,eAAe,0BAA0B,CAAC;AAahD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC,CAAC;AAWF;;GAEG;AACH,wBAAgB,oCAAoC,IAAI,0BAA0B,CAEjF;AAED,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,eAAe,EACtB,0BAA0B,CAC3B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GACpC,mCAAmC,GACnC,kCAAkC,CAAC;AAEvC,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B,MAAM,MAAM,sCAAsC,GAChD,2BAA2B,CACzB,OAAO,eAAe,EACtB,0BAA0B,CAC3B,CAAC;AAEJ,MAAM,MAAM,2BAA2B,GACrC,sCAAsC,CAAC;AAEzC,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B,MAAM,MAAM,8BAA8B,GAAG,SAAS,CACpD,OAAO,eAAe,EACtB,4BAA4B,GAAG,cAAc,EAC7C,2BAA2B,GAAG,aAAa,CAC5C,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,SAAS,EAAE,8BAA8B,CAAC;IAE1C;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAE5C;;OAEG;IACH,YAAY,EAAE,oBAAoB,CAAC;IAEnC;;OAEG;IACH,sBAAsB,EAAE,8BAA8B,CAAC;IAEvD;;;OAGG;IACH,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAElC;;OAEG;IACH,yBAAyB,EAAE,yBAAyB,CAAC;IAErD;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB,CAAC;AAsBF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,eAAe,EACtB,0BAA0B,EAC1B,8BAA8B,CAC/B;;IAaC,YAAY,EACV,SAAS,EACT,KAAK,EACL,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,yBAAyB,EACzB,GAAa,GACd,EAAE,4BAA4B,EAgC9B;IAED;;;;;;OAMG;IACG,QAAQ,CACZ,cAAc,EAAE,UAAU,EAC1B,WAAW,EAAE,UAAU,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC,CAYf;IAED;;;;;;OAMG;IACG,oBAAoB,CACxB,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,UAAU,EAC1B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAUf;IAED;;;;;;;OAOG;IACG,iBAAiB,CACrB,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,UAAU,EAAE,EACzB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CASf;IAED;;;;;OAKG;IACG,sBAAsB,CAC1B,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,iBAAiB,CAAC,CAqB5B;IAED;;;;;;;;OAQG;IACG,iBAAiB,CACrB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,eAAe,CAAC,CAyD1B;IAED;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAI5B;IAED;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAQ3B;IAED;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,aAAa,CAAC,CAIvC;CAsXF"}