@metamask/profile-sync-controller 0.1.4 → 0.2.1

package/dist/chunk-JENTMRXO.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/UserStorageController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAIA,SAAS,sBAAsB;AAiC/B,IAAM,iBAAiB;AAchB,IAAM,eAA2C;AAAA,EACtD,yBAAyB;AAAA,EACzB,+BAA+B;AACjC;AAEA,IAAM,WAAsD;AAAA,EAC1D,yBAAyB;AAAA,IACvB,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AAAA,EACA,+BAA+B;AAAA,IAC7B,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AACF;AAjEA;AAiIA,IAAqB,wBAArB,cAAmD,eAIjD;AAAA,EA8DA,YAAY,QAIT;AACD,UAAM;AAAA,MACJ,WAAW,OAAO;AAAA,MAClB;AAAA,MACA,MAAM;AAAA,MACN,OAAO,EAAE,GAAG,cAAc,GAAG,OAAO,MAAM;AAAA,IAC5C,CAAC;AAWH;AAAA;AAAA;AAAA;AAAA;AAyJA;AAWA;AAAA;AAAA;AAAA,uBAAM;AAkBN;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAmBN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAqBN;AAhTA,8BAAQ;AAAA,MACN,gBAAgB,YAAY;AAC1B,eAAO,MAAM,KAAK,gBAAgB;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,YAAY;AACxB,cAAM,iBAAiB,MAAM,KAAK,gBAAgB;AAAA,UAChD;AAAA,QACF;AACA,eAAO,gBAAgB;AAAA,MACzB;AAAA,MACA,eAAe,MAAM;AACnB,eAAO,KAAK,gBAAgB,KAAK,qCAAqC;AAAA,MACxE;AAAA,MACA,QAAQ,YAAY;AAClB,eAAO,MAAM,KAAK,gBAAgB;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,MACA,SAAS,YAAY;AACnB,eAAO,KAAK,gBAAgB;AAAA,UAC1B;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,8CAAwB;AAAA,MACtB,6BAA6B,YAAY;AACvC,eAAO,MAAM,KAAK,gBAAgB;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,MACA,qCAAqC,YAAY;AAC/C,eAAO,KAAK,gBAAgB;AAAA,UAC1B;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,oCAAc;AAEd,2CAAqB;AAAA,MACnB,+BAA+B,MAAM;AACnC,cAAM,EAAE,WAAW,IAAI,KAAK,gBAAgB;AAAA,UAC1C;AAAA,QACF;AACA,2BAAK,aAAc;AAEnB,aAAK,gBAAgB,UAAU,4BAA4B,MAAM;AAC/D,6BAAK,aAAc;AAAA,QACrB,CAAC;AAED,aAAK,gBAAgB,UAAU,0BAA0B,MAAM;AAC7D,6BAAK,aAAc;AAAA,QACrB,CAAC;AAAA,MACH;AAAA,IACF;AA0NA,+CAA+D,CAAC;AA1M9D,SAAK,sBAAsB,OAAO;AAClC,uBAAK,oBAAmB,8BAA8B;AACtD,0BAAK,sDAAL;AAAA,EACF;AAAA,EAiCA,MAAa,uBAAsC;AACjD,QAAI;AACF,4BAAK,wEAAL,WAAuC;AAEvC,YAAM,cAAc,mBAAK,OAAM,cAAc;AAC7C,UAAI,CAAC,aAAa;AAChB,cAAM,mBAAK,OAAM,OAAO;AAAA,MAC1B;AAEA,WAAK,OAAO,CAAC,UAAU;AACrB,cAAM,0BAA0B;AAAA,MAClC,CAAC;AAED,4BAAK,wEAAL,WAAuC;AAAA,IACzC,SAAS,GAAG;AACV,4BAAK,wEAAL,WAAuC;AACvC,YAAM,eAAe,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,CAAC;AACtE,YAAM,IAAI;AAAA,QACR,GAAG,cAAc,yCAAyC,YAAY;AAAA,MACxE;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAa,2BACX,yBACe;AACf,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,0BAA0B;AAAA,IAClC,CAAC;AAAA,EACH;AAAA,EAEA,MAAa,wBAAuC;AAClD,UAAM,oBAAoB,CAAC,KAAK,MAAM;AACtC,QAAI,mBAAmB;AACrB;AAAA,IACF;AAEA,QAAI;AACF,4BAAK,wEAAL,WAAuC;AAEvC,YAAM,gCACJ,MAAM,mBAAK,uBAAsB,oCAAoC;AAEvE,UAAI,+BAA+B;AACjC,cAAM,mBAAK,uBAAsB,4BAA4B;AAAA,MAC/D;AAEA,YAAM,6BAA6B,KAAK,oBAAoB;AAE5D,UAAI,CAAC,4BAA4B;AAC/B,cAAM,mBAAK,OAAM,QAAQ;AAAA,MAC3B;AAEA,4BAAK,wEAAL,WAAuC;AAEvC,WAAK,OAAO,CAAC,UAAU;AACrB,cAAM,0BAA0B;AAAA,MAClC,CAAC;AAAA,IACH,SAAS,GAAG;AACV,4BAAK,wEAAL,WAAuC;AACvC,YAAM,eAAe,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,CAAC;AACtE,YAAM,IAAI;AAAA,QACR,GAAG,cAAc,0CAA0C,YAAY;AAAA,MACzE;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,kBACX,MACwB;AACxB,0BAAK,8DAAL;AAEA,UAAM,EAAE,aAAa,WAAW,IAC9B,MAAM,sBAAK,8DAAL;AAER,UAAM,SAAS,MAAM,eAAe;AAAA,MAClC;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,kBACX,MACA,OACe;AACf,0BAAK,8DAAL;AAEA,UAAM,EAAE,aAAa,WAAW,IAC9B,MAAM,sBAAK,8DAAL;AAER,UAAM,kBAAkB,OAAO;AAAA,MAC7B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,gBAAiC;AAC5C,0BAAK,8DAAL;AACA,UAAM,aAAa,MAAM,sBAAK,wCAAL;AACzB,WAAO;AAAA,EACT;AA8EF;AAvTE;AA2BA;AAaA;AAEA;AAwCA;AAAA,6BAAwB,WAAS;AAC/B,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,kBAAkB,KAAK,IAAI;AAAA,EAClC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,kBAAkB,KAAK,IAAI;AAAA,EAClC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,cAAc,KAAK,IAAI;AAAA,EAC9B;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,qBAAqB,KAAK,IAAI;AAAA,EACrC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,sBAAsB,KAAK,IAAI;AAAA,EACtC;AACF;AAgIA;AAAA,iCAA4B,WAAS;AACnC,MAAI,CAAC,KAAK,MAAM,yBAAyB;AACvC,UAAM,IAAI;AAAA,MACR,GAAG,cAAc;AAAA,IACnB;AAAA,EACF;AACF;AAKM;AAAA,iCAA4B,iBAG/B;AACD,QAAM,cAAc,MAAM,mBAAK,OAAM,eAAe;AACpD,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI,MAAM,oDAAoD;AAAA,EACtE;AACA,QAAM,aAAa,MAAM,sBAAK,wCAAL;AAEzB,SAAO,EAAE,aAAa,WAAW;AACnC;AAOM;AAAA,sBAAiB,iBAAoB;AACzC,QAAM,KAAa,MAAM,mBAAK,OAAM,aAAa;AACjD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI,MAAM,sDAAsD;AAAA,EACxE;AAEA,QAAM,sBAAsB,MAAM,sBAAK,sCAAL,WAAsB,YAAY,EAAE;AACtE,QAAM,aAAa,iBAAiB,mBAAmB;AACvD,SAAO;AACT;AAEA;AAQM;AAAA,qBAAgB,eAAC,SAAgD;AACrE,MAAI,mBAAK,wBAAuB,OAAO,GAAG;AACxC,WAAO,mBAAK,wBAAuB,OAAO;AAAA,EAC5C;AAEA,MAAI,CAAC,mBAAK,cAAa;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,SAAU,MAAM,KAAK,gBAAgB;AAAA,IACzC;AAAA,IACA,6BAA6B,OAAO;AAAA,EACtC;AAEA,qBAAK,wBAAuB,OAAO,IAAI;AAEvC,SAAO;AACT;AAEA;AAAA,sCAAiC,SAC/B,+BACM;AACN,OAAK,OAAO,CAAC,UAAU;AACrB,UAAM,gCAAgC;AAAA,EACxC,CAAC;AACH","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  KeyringControllerGetStateAction,\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport { createSnapSignMessageRequest } from '../authentication/auth-snap-requests';\nimport type {\n  AuthenticationControllerGetBearerToken,\n  AuthenticationControllerGetSessionProfile,\n  AuthenticationControllerIsSignedIn,\n  AuthenticationControllerPerformSignIn,\n  AuthenticationControllerPerformSignOut,\n} from '../authentication/AuthenticationController';\nimport { createSHA256Hash } from './encryption';\nimport type { UserStoragePath } from './schema';\nimport { getUserStorage, upsertUserStorage } from './services';\n\n// TODO: fix external dependencies\nexport declare type NotificationServicesControllerDisableNotificationServices =\n  {\n    type: `NotificationServicesController:disableNotificationServices`;\n    handler: () => Promise<void>;\n  };\n\nexport declare type NotificationServicesControllerSelectIsNotificationServicesEnabled =\n  {\n    type: `NotificationServicesController:selectIsNotificationServicesEnabled`;\n    handler: () => boolean;\n  };\n\nconst controllerName = 'UserStorageController';\n\n// State\nexport type UserStorageControllerState = {\n  /**\n   * Condition used by UI and to determine if we can use some of the User Storage methods.\n   */\n  isProfileSyncingEnabled: boolean | null;\n  /**\n   * Loading state for the profile syncing update\n   */\n  isProfileSyncingUpdateLoading: boolean;\n};\n\nexport const defaultState: UserStorageControllerState = {\n  isProfileSyncingEnabled: true,\n  isProfileSyncingUpdateLoading: false,\n};\n\nconst metadata: StateMetadata<UserStorageControllerState> = {\n  isProfileSyncingEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isProfileSyncingUpdateLoading: {\n    persist: false,\n    anonymous: false,\n  },\n};\n\n// Messenger Actions\ntype CreateActionsObj<Controller extends keyof UserStorageController> = {\n  [K in Controller]: {\n    type: `${typeof controllerName}:${K}`;\n    handler: UserStorageController[K];\n  };\n};\ntype ActionsObj = CreateActionsObj<\n  | 'performGetStorage'\n  | 'performSetStorage'\n  | 'getStorageKey'\n  | 'enableProfileSyncing'\n  | 'disableProfileSyncing'\n>;\nexport type Actions = ActionsObj[keyof ActionsObj];\nexport type UserStorageControllerPerformGetStorage =\n  ActionsObj['performGetStorage'];\nexport type UserStorageControllerPerformSetStorage =\n  ActionsObj['performSetStorage'];\nexport type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];\nexport type UserStorageControllerEnableProfileSyncing =\n  ActionsObj['enableProfileSyncing'];\nexport type UserStorageControllerDisableProfileSyncing =\n  ActionsObj['disableProfileSyncing'];\n\n// Allowed Actions\nexport type AllowedActions =\n  // Keyring Requests\n  | KeyringControllerGetStateAction\n  // Snap Requests\n  | HandleSnapRequest\n  // Auth Requests\n  | AuthenticationControllerGetBearerToken\n  | AuthenticationControllerGetSessionProfile\n  | AuthenticationControllerPerformSignIn\n  | AuthenticationControllerIsSignedIn\n  | AuthenticationControllerPerformSignOut\n  // Metamask Notifications\n  | NotificationServicesControllerDisableNotificationServices\n  | NotificationServicesControllerSelectIsNotificationServicesEnabled;\n\nexport type AllowedEvents =\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent;\n\n// Messenger\nexport type UserStorageControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Reusable controller that allows any team to store synchronized data for a given user.\n * These can be settings shared cross MetaMask clients, or data we want to persist when uninstalling/reinstalling.\n *\n * NOTE:\n * - data stored on UserStorage is FULLY encrypted, with the only keys stored/managed on the client.\n * - No one can access this data unless they are have the SRP and are able to run the signing snap.\n */\nexport default class UserStorageController extends BaseController<\n  typeof controllerName,\n  UserStorageControllerState,\n  UserStorageControllerMessenger\n> {\n  #auth = {\n    getBearerToken: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:getBearerToken',\n      );\n    },\n    getProfileId: async () => {\n      const sessionProfile = await this.messagingSystem.call(\n        'AuthenticationController:getSessionProfile',\n      );\n      return sessionProfile?.profileId;\n    },\n    isAuthEnabled: () => {\n      return this.messagingSystem.call('AuthenticationController:isSignedIn');\n    },\n    signIn: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:performSignIn',\n      );\n    },\n    signOut: async () => {\n      return this.messagingSystem.call(\n        'AuthenticationController:performSignOut',\n      );\n    },\n  };\n\n  #notificationServices = {\n    disableNotificationServices: async () => {\n      return await this.messagingSystem.call(\n        'NotificationServicesController:disableNotificationServices',\n      );\n    },\n    selectIsNotificationServicesEnabled: async () => {\n      return this.messagingSystem.call(\n        'NotificationServicesController:selectIsNotificationServicesEnabled',\n      );\n    },\n  };\n\n  #isUnlocked = false;\n\n  #keyringController = {\n    setupLockedStateSubscriptions: () => {\n      const { isUnlocked } = this.messagingSystem.call(\n        'KeyringController:getState',\n      );\n      this.#isUnlocked = isUnlocked;\n\n      this.messagingSystem.subscribe('KeyringController:unlock', () => {\n        this.#isUnlocked = true;\n      });\n\n      this.messagingSystem.subscribe('KeyringController:lock', () => {\n        this.#isUnlocked = false;\n      });\n    },\n  };\n\n  getMetaMetricsState: () => boolean;\n\n  constructor(params: {\n    messenger: UserStorageControllerMessenger;\n    state?: UserStorageControllerState;\n    getMetaMetricsState: () => boolean;\n  }) {\n    super({\n      messenger: params.messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...params.state },\n    });\n\n    this.getMetaMetricsState = params.getMetaMetricsState;\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performGetStorage',\n      this.performGetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performSetStorage',\n      this.performSetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:getStorageKey',\n      this.getStorageKey.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:enableProfileSyncing',\n      this.enableProfileSyncing.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:disableProfileSyncing',\n      this.disableProfileSyncing.bind(this),\n    );\n  }\n\n  public async enableProfileSyncing(): Promise<void> {\n    try {\n      this.#setIsProfileSyncingUpdateLoading(true);\n\n      const authEnabled = this.#auth.isAuthEnabled();\n      if (!authEnabled) {\n        await this.#auth.signIn();\n      }\n\n      this.update((state) => {\n        state.isProfileSyncingEnabled = true;\n      });\n\n      this.#setIsProfileSyncingUpdateLoading(false);\n    } catch (e) {\n      this.#setIsProfileSyncingUpdateLoading(false);\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to enable profile syncing - ${errorMessage}`,\n      );\n    }\n  }\n\n  public async setIsProfileSyncingEnabled(\n    isProfileSyncingEnabled: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isProfileSyncingEnabled = isProfileSyncingEnabled;\n    });\n  }\n\n  public async disableProfileSyncing(): Promise<void> {\n    const isAlreadyDisabled = !this.state.isProfileSyncingEnabled;\n    if (isAlreadyDisabled) {\n      return;\n    }\n\n    try {\n      this.#setIsProfileSyncingUpdateLoading(true);\n\n      const isNotificationServicesEnabled =\n        await this.#notificationServices.selectIsNotificationServicesEnabled();\n\n      if (isNotificationServicesEnabled) {\n        await this.#notificationServices.disableNotificationServices();\n      }\n\n      const isMetaMetricsParticipation = this.getMetaMetricsState();\n\n      if (!isMetaMetricsParticipation) {\n        await this.#auth.signOut();\n      }\n\n      this.#setIsProfileSyncingUpdateLoading(false);\n\n      this.update((state) => {\n        state.isProfileSyncingEnabled = false;\n      });\n    } catch (e) {\n      this.#setIsProfileSyncingUpdateLoading(false);\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to disable profile syncing - ${errorMessage}`,\n      );\n    }\n  }\n\n  /**\n   * Allows retrieval of stored data. Data stored is string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @returns the decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorage(\n    path: UserStoragePath,\n  ): Promise<string | null> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    const result = await getUserStorage({\n      path,\n      bearerToken,\n      storageKey,\n    });\n\n    return result;\n  }\n\n  /**\n   * Allows storage of user data. Data stored must be string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param value - The string data you want to store.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performSetStorage(\n    path: UserStoragePath,\n    value: string,\n  ): Promise<void> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    await upsertUserStorage(value, {\n      path,\n      bearerToken,\n      storageKey,\n    });\n  }\n\n  /**\n   * Retrieves the storage key, for internal use only!\n   *\n   * @returns the storage key\n   */\n  public async getStorageKey(): Promise<string> {\n    this.#assertProfileSyncingEnabled();\n    const storageKey = await this.#createStorageKey();\n    return storageKey;\n  }\n\n  #assertProfileSyncingEnabled(): void {\n    if (!this.state.isProfileSyncingEnabled) {\n      throw new Error(\n        `${controllerName}: Unable to call method, user is not authenticated`,\n      );\n    }\n  }\n\n  /**\n   * Utility to get the bearer token and storage key\n   */\n  async #getStorageKeyAndBearerToken(): Promise<{\n    bearerToken: string;\n    storageKey: string;\n  }> {\n    const bearerToken = await this.#auth.getBearerToken();\n    if (!bearerToken) {\n      throw new Error('UserStorageController - unable to get bearer token');\n    }\n    const storageKey = await this.#createStorageKey();\n\n    return { bearerToken, storageKey };\n  }\n\n  /**\n   * Rather than storing the storage key, we can compute the storage key when needed.\n   *\n   * @returns the storage key\n   */\n  async #createStorageKey(): Promise<string> {\n    const id: string = await this.#auth.getProfileId();\n    if (!id) {\n      throw new Error('UserStorageController - unable to create storage key');\n    }\n\n    const storageKeySignature = await this.#snapSignMessage(`metamask:${id}`);\n    const storageKey = createSHA256Hash(storageKeySignature);\n    return storageKey;\n  }\n\n  #_snapSignMessageCache: Record<`metamask:${string}`, string> = {};\n\n  /**\n   * Signs a specific message using an underlying auth snap.\n   *\n   * @param message - A specific tagged message to sign.\n   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(message: `metamask:${string}`): Promise<string> {\n    if (this.#_snapSignMessageCache[message]) {\n      return this.#_snapSignMessageCache[message];\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapSignMessage - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapSignMessageRequest(message),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n\n  #setIsProfileSyncingUpdateLoading(\n    isProfileSyncingUpdateLoading: boolean,\n  ): void {\n    this.update((state) => {\n      state.isProfileSyncingUpdateLoading = isProfileSyncingUpdateLoading;\n    });\n  }\n}\n"]}

package/dist/{chunk-DHKZ2NEF.js → chunk-KW3X4TT5.js}

@@ -32,7 +32,7 @@ var metadata = {
     anonymous: false
   }
 };
-var _metametrics, _registerMessageHandlers, registerMessageHandlers_fn, _assertLoggedIn, assertLoggedIn_fn, _performAuthenticationFlow, performAuthenticationFlow_fn, _hasValidSession, hasValidSession_fn, __snapPublicKeyCache, _snapGetPublicKey, snapGetPublicKey_fn, __snapSignMessageCache, _snapSignMessage, snapSignMessage_fn;
+var _metametrics, _isUnlocked, _keyringController, _registerMessageHandlers, registerMessageHandlers_fn, _assertLoggedIn, assertLoggedIn_fn, _performAuthenticationFlow, performAuthenticationFlow_fn, _hasValidSession, hasValidSession_fn, __snapPublicKeyCache, _snapGetPublicKey, snapGetPublicKey_fn, __snapSignMessageCache, _snapSignMessage, snapSignMessage_fn;
 var AuthenticationController = class extends _basecontroller.BaseController {
   constructor({
     messenger,
@@ -67,12 +67,28 @@ var AuthenticationController = class extends _basecontroller.BaseController {
      */
     _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, _snapSignMessage);
     _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, _metametrics, void 0);
+    _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, _isUnlocked, false);
+    _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, _keyringController, {
+      setupLockedStateSubscriptions: () => {
+        const { isUnlocked } = this.messagingSystem.call(
+          "KeyringController:getState"
+        );
+        _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _isUnlocked, isUnlocked);
+        this.messagingSystem.subscribe("KeyringController:unlock", () => {
+          _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _isUnlocked, true);
+        });
+        this.messagingSystem.subscribe("KeyringController:lock", () => {
+          _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _isUnlocked, false);
+        });
+      }
+    });
     _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, __snapPublicKeyCache, void 0);
     _chunkIGY2S5BCjs.__privateAdd.call(void 0, this, __snapSignMessageCache, {});
     if (!metametrics) {
       throw new Error("`metametrics` field is required");
     }
     _chunkIGY2S5BCjs.__privateSet.call(void 0, this, _metametrics, metametrics);
+    _chunkIGY2S5BCjs.__privateGet.call(void 0, this, _keyringController).setupLockedStateSubscriptions();
     _chunkIGY2S5BCjs.__privateMethod.call(void 0, this, _registerMessageHandlers, registerMessageHandlers_fn).call(this);
   }
   async performSignIn() {
@@ -113,6 +129,8 @@ var AuthenticationController = class extends _basecontroller.BaseController {
   }
 };
 _metametrics = new WeakMap();
+_isUnlocked = new WeakMap();
+_keyringController = new WeakMap();
 _registerMessageHandlers = new WeakSet();
 registerMessageHandlers_fn = function() {
   this.messagingSystem.registerActionHandler(
@@ -213,6 +231,11 @@ snapGetPublicKey_fn = async function() {
   if (_chunkIGY2S5BCjs.__privateGet.call(void 0, this, __snapPublicKeyCache)) {
     return _chunkIGY2S5BCjs.__privateGet.call(void 0, this, __snapPublicKeyCache);
   }
+  if (!_chunkIGY2S5BCjs.__privateGet.call(void 0, this, _isUnlocked)) {
+    throw new Error(
+      "#snapGetPublicKey - unable to call snap, wallet is locked"
+    );
+  }
   const result = await this.messagingSystem.call(
     "SnapController:handleRequest",
     _chunkYHGWG3EQjs.createSnapPublicKeyRequest.call(void 0, )
@@ -226,6 +249,11 @@ snapSignMessage_fn = async function(message) {
   if (_chunkIGY2S5BCjs.__privateGet.call(void 0, this, __snapSignMessageCache)[message]) {
     return _chunkIGY2S5BCjs.__privateGet.call(void 0, this, __snapSignMessageCache)[message];
   }
+  if (!_chunkIGY2S5BCjs.__privateGet.call(void 0, this, _isUnlocked)) {
+    throw new Error(
+      "#snapSignMessage - unable to call snap, wallet is locked"
+    );
+  }
   const result = await this.messagingSystem.call(
     "SnapController:handleRequest",
     _chunkYHGWG3EQjs.createSnapSignMessageRequest.call(void 0, message)
@@ -238,4 +266,4 @@ snapSignMessage_fn = async function(message) {
 
 
 exports.defaultState = defaultState; exports.AuthenticationController = AuthenticationController;
-//# sourceMappingURL=chunk-DHKZ2NEF.js.map
+//# sourceMappingURL=chunk-KW3X4TT5.js.map

package/dist/chunk-KW3X4TT5.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/authentication/AuthenticationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAIA,SAAS,sBAAsB;AAmB/B,IAAM,gBAAgB,MAAO,KAAK;AAElC,IAAM,iBAAiB;AA8BhB,IAAM,eAA8C;AAAA,EACzD,YAAY;AACd;AACA,IAAM,WAAyD;AAAA,EAC7D,YAAY;AAAA,IACV,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AAAA,EACA,aAAa;AAAA,IACX,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AACF;AAnEA;AAmHA,IAAqB,2BAArB,cAAsD,eAIpD;AAAA,EAsBA,YAAY;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAQG;AACD,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA,MAAM;AAAA,MACN,OAAO,EAAE,GAAG,cAAc,GAAG,MAAM;AAAA,IACrC,CAAC;AAgBH;AAAA;AAAA;AAAA;AAAA;AAyEA;AAQA,uBAAM;AA+DN;AAyBA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AA6BN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AA7PN;AAEA,oCAAc;AAEd,2CAAqB;AAAA,MACnB,+BAA+B,MAAM;AACnC,cAAM,EAAE,WAAW,IAAI,KAAK,gBAAgB;AAAA,UAC1C;AAAA,QACF;AACA,2BAAK,aAAc;AAEnB,aAAK,gBAAgB,UAAU,4BAA4B,MAAM;AAC/D,6BAAK,aAAc;AAAA,QACrB,CAAC;AAED,aAAK,gBAAgB,UAAU,0BAA0B,MAAM;AAC7D,6BAAK,aAAc;AAAA,QACrB,CAAC;AAAA,MACH;AAAA,IACF;AAsMA;AA4BA,+CAA+D,CAAC;AA5M9D,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI,MAAM,iCAAiC;AAAA,IACnD;AAEA,uBAAK,cAAe;AAEpB,uBAAK,oBAAmB,8BAA8B;AACtD,0BAAK,sDAAL;AAAA,EACF;AAAA,EAiCA,MAAa,gBAAiC;AAC5C,UAAM,EAAE,YAAY,IAAI,MAAM,sBAAK,0DAAL;AAC9B,WAAO;AAAA,EACT;AAAA,EAEO,iBAAuB;AAC5B,0BAAK,oCAAL;AAEA,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,aAAa;AACnB,YAAM,cAAc;AAAA,IACtB,CAAC;AAAA,EACH;AAAA,EAEA,MAAa,iBAAkC;AAC7C,0BAAK,oCAAL;AAEA,QAAI,sBAAK,sCAAL,WAAsB,KAAK,MAAM,cAAc;AACjD,aAAO,KAAK,MAAM,YAAY;AAAA,IAChC;AAEA,UAAM,EAAE,YAAY,IAAI,MAAM,sBAAK,0DAAL;AAC9B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,oBAA6C;AACxD,0BAAK,oCAAL;AAEA,QAAI,sBAAK,sCAAL,WAAsB,KAAK,MAAM,cAAc;AACjD,aAAO,KAAK,MAAM,YAAY;AAAA,IAChC;AAEA,UAAM,EAAE,QAAQ,IAAI,MAAM,sBAAK,0DAAL;AAC1B,WAAO;AAAA,EACT;AAAA,EAEO,aAAsB;AAC3B,WAAO,KAAK,MAAM;AAAA,EACpB;AAmJF;AAjRE;AAEA;AAEA;AAmDA;AAAA,6BAAwB,WAAS;AAC/B,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,eAAe,KAAK,IAAI;AAAA,EAC/B;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,kBAAkB,KAAK,IAAI;AAAA,EAClC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,WAAW,KAAK,IAAI;AAAA,EAC3B;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,cAAc,KAAK,IAAI;AAAA,EAC9B;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,eAAe,KAAK,IAAI;AAAA,EAC/B;AACF;AAgDA;AAAA,oBAAe,WAAS;AACtB,MAAI,CAAC,KAAK,MAAM,YAAY;AAC1B,UAAM,IAAI;AAAA,MACR,GAAG,cAAc;AAAA,IACnB;AAAA,EACF;AACF;AAEM;AAAA,+BAA0B,iBAG7B;AACD,MAAI;AAEF,UAAM,YAAY,MAAM,sBAAK,wCAAL;AACxB,UAAM,QAAQ,MAAM,SAAS,SAAS;AACtC,QAAI,CAAC,OAAO;AACV,YAAM,IAAI,MAAM,qBAAqB;AAAA,IACvC;AAGA,UAAM,aAAa,sBAAsB,OAAO,SAAS;AACzD,UAAM,YAAY,MAAM,sBAAK,sCAAL,WAAsB;AAC9C,UAAM,gBAAgB,MAAM,MAAM,YAAY,WAAW;AAAA,MACvD,eAAe,MAAM,mBAAK,cAAa,iBAAiB;AAAA,MACxD,OAAO,mBAAK,cAAa;AAAA,IAC3B,CAAC;AACD,QAAI,CAAC,eAAe,OAAO;AACzB,YAAM,IAAI,MAAM,iBAAiB;AAAA,IACnC;AAEA,UAAM,UAA0B;AAAA,MAC9B,cAAc,cAAc,QAAQ;AAAA,MACpC,WAAW,cAAc,QAAQ;AAAA,IACnC;AAGA,UAAM,cAAc,MAAM;AAAA,MACxB,cAAc;AAAA,MACd,mBAAK,cAAa;AAAA,IACpB;AACA,QAAI,CAAC,aAAa;AAChB,YAAM,IAAI,MAAM,4BAA4B;AAAA,IAC9C;AAGA,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,aAAa;AACnB,YAAM,YAAY,oBAAI,KAAK;AAC3B,gBAAU,QAAQ,UAAU,QAAQ,IAAI,aAAa;AACrD,YAAM,cAAc;AAAA,QAClB;AAAA,QACA;AAAA,QACA,WAAW,UAAU,SAAS;AAAA,MAChC;AAAA,IACF,CAAC;AAED,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AACV,YAAQ,MAAM,0BAA0B,CAAC;AACzC,UAAM,eACJ,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,KAAK,EAAE;AACzD,UAAM,IAAI;AAAA,MACR,GAAG,cAAc,8BAA8B,YAAY;AAAA,IAC7D;AAAA,EACF;AACF;AAEA;AAAA,qBAAgB,SACd,aAC4B;AAC5B,MAAI,CAAC,aAAa;AAChB,WAAO;AAAA,EACT;AAEA,QAAM,WAAW,KAAK,MAAM,YAAY,SAAS;AACjD,MAAI,MAAM,QAAQ,GAAG;AACnB,WAAO;AAAA,EACT;AAEA,QAAM,cAAc,oBAAI,KAAK;AAC7B,QAAM,SAAS,KAAK,IAAI,YAAY,QAAQ,IAAI,QAAQ;AAExD,SAAO,gBAAgB;AACzB;AAEA;AAOM;AAAA,sBAAiB,iBAAoB;AACzC,MAAI,mBAAK,uBAAsB;AAC7B,WAAO,mBAAK;AAAA,EACd;AAEA,MAAI,CAAC,mBAAK,cAAa;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,SAAU,MAAM,KAAK,gBAAgB;AAAA,IACzC;AAAA,IACA,2BAA2B;AAAA,EAC7B;AAEA,qBAAK,sBAAuB;AAE5B,SAAO;AACT;AAEA;AAQM;AAAA,qBAAgB,eAAC,SAAgD;AACrE,MAAI,mBAAK,wBAAuB,OAAO,GAAG;AACxC,WAAO,mBAAK,wBAAuB,OAAO;AAAA,EAC5C;AAEA,MAAI,CAAC,mBAAK,cAAa;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,SAAU,MAAM,KAAK,gBAAgB;AAAA,IACzC;AAAA,IACA,6BAA6B,OAAO;AAAA,EACtC;AAEA,qBAAK,wBAAuB,OAAO,IAAI;AAEvC,SAAO;AACT","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  KeyringControllerGetStateAction,\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport {\n  createSnapPublicKeyRequest,\n  createSnapSignMessageRequest,\n} from './auth-snap-requests';\nimport {\n  createLoginRawMessage,\n  getAccessToken,\n  getNonce,\n  login,\n} from './services';\n\nconst THIRTY_MIN_MS = 1000 * 60 * 30;\n\nconst controllerName = 'AuthenticationController';\n\n// State\ntype SessionProfile = {\n  identifierId: string;\n  profileId: string;\n};\n\ntype SessionData = {\n  /** profile - anonymous profile data for the given logged in user */\n  profile: SessionProfile;\n  /** accessToken - used to make requests authorized endpoints */\n  accessToken: string;\n  /** expiresIn - string date to determine if new access token is required  */\n  expiresIn: string;\n};\n\ntype MetaMetricsAuth = {\n  getMetaMetricsId: () => string | Promise<string>;\n  agent: 'extension' | 'mobile';\n};\n\nexport type AuthenticationControllerState = {\n  /**\n   * Global isSignedIn state.\n   * Can be used to determine if \"Profile Syncing\" is enabled.\n   */\n  isSignedIn: boolean;\n  sessionData?: SessionData;\n};\nexport const defaultState: AuthenticationControllerState = {\n  isSignedIn: false,\n};\nconst metadata: StateMetadata<AuthenticationControllerState> = {\n  isSignedIn: {\n    persist: true,\n    anonymous: true,\n  },\n  sessionData: {\n    persist: true,\n    anonymous: false,\n  },\n};\n\n// Messenger Actions\ntype CreateActionsObj<Controller extends keyof AuthenticationController> = {\n  [K in Controller]: {\n    type: `${typeof controllerName}:${K}`;\n    handler: AuthenticationController[K];\n  };\n};\ntype ActionsObj = CreateActionsObj<\n  | 'performSignIn'\n  | 'performSignOut'\n  | 'getBearerToken'\n  | 'getSessionProfile'\n  | 'isSignedIn'\n>;\nexport type Actions = ActionsObj[keyof ActionsObj];\nexport type AuthenticationControllerPerformSignIn = ActionsObj['performSignIn'];\nexport type AuthenticationControllerPerformSignOut =\n  ActionsObj['performSignOut'];\nexport type AuthenticationControllerGetBearerToken =\n  ActionsObj['getBearerToken'];\nexport type AuthenticationControllerGetSessionProfile =\n  ActionsObj['getSessionProfile'];\nexport type AuthenticationControllerIsSignedIn = ActionsObj['isSignedIn'];\n\n// Allowed Actions\nexport type AllowedActions =\n  | HandleSnapRequest\n  | KeyringControllerGetStateAction;\n\nexport type AllowedEvents =\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent;\n\n// Messenger\nexport type AuthenticationControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that enables authentication for restricted endpoints.\n * Used for Global Profile Syncing and Notifications\n */\nexport default class AuthenticationController extends BaseController<\n  typeof controllerName,\n  AuthenticationControllerState,\n  AuthenticationControllerMessenger\n> {\n  #metametrics: MetaMetricsAuth;\n\n  #isUnlocked = false;\n\n  #keyringController = {\n    setupLockedStateSubscriptions: () => {\n      const { isUnlocked } = this.messagingSystem.call(\n        'KeyringController:getState',\n      );\n      this.#isUnlocked = isUnlocked;\n\n      this.messagingSystem.subscribe('KeyringController:unlock', () => {\n        this.#isUnlocked = true;\n      });\n\n      this.messagingSystem.subscribe('KeyringController:lock', () => {\n        this.#isUnlocked = false;\n      });\n    },\n  };\n\n  constructor({\n    messenger,\n    state,\n    metametrics,\n  }: {\n    messenger: AuthenticationControllerMessenger;\n    state?: AuthenticationControllerState;\n    /**\n     * Not using the Messaging System as we\n     * do not want to tie this strictly to extension\n     */\n    metametrics: MetaMetricsAuth;\n  }) {\n    super({\n      messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...state },\n    });\n\n    if (!metametrics) {\n      throw new Error('`metametrics` field is required');\n    }\n\n    this.#metametrics = metametrics;\n\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:getBearerToken',\n      this.getBearerToken.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:getSessionProfile',\n      this.getSessionProfile.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:isSignedIn',\n      this.isSignedIn.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:performSignIn',\n      this.performSignIn.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'AuthenticationController:performSignOut',\n      this.performSignOut.bind(this),\n    );\n  }\n\n  public async performSignIn(): Promise<string> {\n    const { accessToken } = await this.#performAuthenticationFlow();\n    return accessToken;\n  }\n\n  public performSignOut(): void {\n    this.#assertLoggedIn();\n\n    this.update((state) => {\n      state.isSignedIn = false;\n      state.sessionData = undefined;\n    });\n  }\n\n  public async getBearerToken(): Promise<string> {\n    this.#assertLoggedIn();\n\n    if (this.#hasValidSession(this.state.sessionData)) {\n      return this.state.sessionData.accessToken;\n    }\n\n    const { accessToken } = await this.#performAuthenticationFlow();\n    return accessToken;\n  }\n\n  /**\n   * Will return a session profile.\n   * Throws if a user is not logged in.\n   *\n   * @returns profile for the session.\n   */\n  public async getSessionProfile(): Promise<SessionProfile> {\n    this.#assertLoggedIn();\n\n    if (this.#hasValidSession(this.state.sessionData)) {\n      return this.state.sessionData.profile;\n    }\n\n    const { profile } = await this.#performAuthenticationFlow();\n    return profile;\n  }\n\n  public isSignedIn(): boolean {\n    return this.state.isSignedIn;\n  }\n\n  #assertLoggedIn(): void {\n    if (!this.state.isSignedIn) {\n      throw new Error(\n        `${controllerName}: Unable to call method, user is not authenticated`,\n      );\n    }\n  }\n\n  async #performAuthenticationFlow(): Promise<{\n    profile: SessionProfile;\n    accessToken: string;\n  }> {\n    try {\n      // 1. Nonce\n      const publicKey = await this.#snapGetPublicKey();\n      const nonce = await getNonce(publicKey);\n      if (!nonce) {\n        throw new Error(`Unable to get nonce`);\n      }\n\n      // 2. Login\n      const rawMessage = createLoginRawMessage(nonce, publicKey);\n      const signature = await this.#snapSignMessage(rawMessage);\n      const loginResponse = await login(rawMessage, signature, {\n        metametricsId: await this.#metametrics.getMetaMetricsId(),\n        agent: this.#metametrics.agent,\n      });\n      if (!loginResponse?.token) {\n        throw new Error(`Unable to login`);\n      }\n\n      const profile: SessionProfile = {\n        identifierId: loginResponse.profile.identifier_id,\n        profileId: loginResponse.profile.profile_id,\n      };\n\n      // 3. Trade for Access Token\n      const accessToken = await getAccessToken(\n        loginResponse.token,\n        this.#metametrics.agent,\n      );\n      if (!accessToken) {\n        throw new Error(`Unable to get Access Token`);\n      }\n\n      // Update Internal State\n      this.update((state) => {\n        state.isSignedIn = true;\n        const expiresIn = new Date();\n        expiresIn.setTime(expiresIn.getTime() + THIRTY_MIN_MS);\n        state.sessionData = {\n          profile,\n          accessToken,\n          expiresIn: expiresIn.toString(),\n        };\n      });\n\n      return {\n        profile,\n        accessToken,\n      };\n    } catch (e) {\n      console.error('Failed to authenticate', e);\n      const errorMessage =\n        e instanceof Error ? e.message : JSON.stringify(e ?? '');\n      throw new Error(\n        `${controllerName}: Failed to authenticate - ${errorMessage}`,\n      );\n    }\n  }\n\n  #hasValidSession(\n    sessionData: SessionData | undefined,\n  ): sessionData is SessionData {\n    if (!sessionData) {\n      return false;\n    }\n\n    const prevDate = Date.parse(sessionData.expiresIn);\n    if (isNaN(prevDate)) {\n      return false;\n    }\n\n    const currentDate = new Date();\n    const diffMs = Math.abs(currentDate.getTime() - prevDate);\n\n    return THIRTY_MIN_MS > diffMs;\n  }\n\n  #_snapPublicKeyCache: string | undefined;\n\n  /**\n   * Returns the auth snap public key.\n   *\n   * @returns The snap public key.\n   */\n  async #snapGetPublicKey(): Promise<string> {\n    if (this.#_snapPublicKeyCache) {\n      return this.#_snapPublicKeyCache;\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapGetPublicKey - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapPublicKeyRequest(),\n    )) as string;\n\n    this.#_snapPublicKeyCache = result;\n\n    return result;\n  }\n\n  #_snapSignMessageCache: Record<`metamask:${string}`, string> = {};\n\n  /**\n   * Signs a specific message using an underlying auth snap.\n   *\n   * @param message - A specific tagged message to sign.\n   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(message: `metamask:${string}`): Promise<string> {\n    if (this.#_snapSignMessageCache[message]) {\n      return this.#_snapSignMessageCache[message];\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapSignMessage - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapSignMessageRequest(message),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n}\n"]}

package/dist/{chunk-BXPL7ZFX.js → chunk-MNVUKRZC.js}

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkDHKZ2NEFjs = require('./chunk-DHKZ2NEF.js');
+var _chunkKW3X4TT5js = require('./chunk-KW3X4TT5.js');
 
 
 
@@ -14,9 +14,9 @@ var _chunkIGY2S5BCjs = require('./chunk-IGY2S5BC.js');
 // src/controllers/authentication/index.ts
 var authentication_exports = {};
 _chunkIGY2S5BCjs.__export.call(void 0, authentication_exports, {
-  Controller: () => _chunkDHKZ2NEFjs.AuthenticationController,
+  Controller: () => _chunkKW3X4TT5js.AuthenticationController,
   Mocks: () => fixtures_exports,
-  defaultState: () => _chunkDHKZ2NEFjs.defaultState
+  defaultState: () => _chunkKW3X4TT5js.defaultState
 });
 
 // src/controllers/authentication/__fixtures__/index.ts
@@ -83,4 +83,4 @@ var getMockAuthAccessTokenResponse = () => {
 
 
 exports.fixtures_exports = fixtures_exports; exports.authentication_exports = authentication_exports;
-//# sourceMappingURL=chunk-BXPL7ZFX.js.map
+//# sourceMappingURL=chunk-MNVUKRZC.js.map

package/dist/{chunk-AXWK4Y23.mjs → chunk-NPH5AHLH.mjs}

@@ -1,3 +1,6 @@
+import {
+  createEntryPath
+} from "./chunk-ILIZJQ6X.mjs";
 import {
   createSHA256Hash,
   encryption_default
@@ -7,8 +10,7 @@ import {
 } from "./chunk-FQ5SDMRE.mjs";
 import {
   NotFoundError,
-  UserStorageError,
-  ValidationError
+  UserStorageError
 } from "./chunk-TFFQFIJV.mjs";
 import {
   __privateAdd,
@@ -16,7 +18,7 @@ import {
 } from "./chunk-U5UIDVOO.mjs";
 
 // src/sdk/user-storage.ts
-var STORAGE_URL = (env, feature, entry) => `${getEnvUrls(env).userStorageApiUrl}/api/v1/userstorage/${feature}/${entry}`;
+var STORAGE_URL = (env, encryptedPath) => `${getEnvUrls(env).userStorageApiUrl}/api/v1/userstorage/${encryptedPath}`;
 var _upsertUserStorage, upsertUserStorage_fn, _getUserStorage, getUserStorage_fn, _createEntryKey, createEntryKey_fn, _getAuthorizationHeader, getAuthorizationHeader_fn;
 var UserStorage = class {
   constructor(config, options) {
@@ -30,17 +32,11 @@ var UserStorage = class {
     this.config = config;
     this.options = options;
   }
-  async setItem(feature, key, value) {
-    if (!feature.trim() || !key.trim()) {
-      throw new ValidationError("feature or key cannot be empty strings");
-    }
-    await __privateMethod(this, _upsertUserStorage, upsertUserStorage_fn).call(this, feature, key, value);
+  async setItem(path, value) {
+    await __privateMethod(this, _upsertUserStorage, upsertUserStorage_fn).call(this, path, value);
   }
-  async getItem(feature, key) {
-    if (!feature.trim() || !key.trim()) {
-      throw new ValidationError("feature or key cannot be empty strings");
-    }
-    return __privateMethod(this, _getUserStorage, getUserStorage_fn).call(this, feature, key);
+  async getItem(path) {
+    return __privateMethod(this, _getUserStorage, getUserStorage_fn).call(this, path);
   }
   async getStorageKey() {
     const storageKey = await this.options.storage?.getStorageKey();
@@ -57,14 +53,13 @@ var UserStorage = class {
   }
 };
 _upsertUserStorage = new WeakSet();
-upsertUserStorage_fn = async function(feature, key, data) {
+upsertUserStorage_fn = async function(path, data) {
   try {
     const headers = await __privateMethod(this, _getAuthorizationHeader, getAuthorizationHeader_fn).call(this);
     const storageKey = await this.getStorageKey();
     const encryptedData = encryption_default.encryptString(data, storageKey);
-    const url = new URL(
-      STORAGE_URL(this.env, feature, __privateMethod(this, _createEntryKey, createEntryKey_fn).call(this, key, storageKey))
-    );
+    const encryptedPath = createEntryPath(path, storageKey);
+    const url = new URL(STORAGE_URL(this.env, encryptedPath));
     const response = await fetch(url.toString(), {
       method: "PUT",
       headers: {
@@ -85,18 +80,17 @@ upsertUserStorage_fn = async function(feature, key, data) {
   } catch (e) {
     const errorMessage = e instanceof Error ? e.message : JSON.stringify(e ?? "");
     throw new UserStorageError(
-      `failed to upsert user storage for feature '${feature}' and key '${key}'. ${errorMessage}`
+      `failed to upsert user storage for path '${path}'. ${errorMessage}`
     );
   }
 };
 _getUserStorage = new WeakSet();
-getUserStorage_fn = async function(feature, key) {
+getUserStorage_fn = async function(path) {
   try {
     const headers = await __privateMethod(this, _getAuthorizationHeader, getAuthorizationHeader_fn).call(this);
     const storageKey = await this.getStorageKey();
-    const url = new URL(
-      STORAGE_URL(this.env, feature, __privateMethod(this, _createEntryKey, createEntryKey_fn).call(this, key, storageKey))
-    );
+    const encryptedPath = createEntryPath(path, storageKey);
+    const url = new URL(STORAGE_URL(this.env, encryptedPath));
     const response = await fetch(url.toString(), {
       headers: {
         "Content-Type": "application/json",
@@ -105,7 +99,7 @@ getUserStorage_fn = async function(feature, key) {
     });
     if (response.status === 404) {
       throw new NotFoundError(
-        `feature/key set not found for feature '${feature}' and key '${key}'.`
+        `feature/key set not found for path '${path}'.`
       );
     }
     if (!response.ok) {
@@ -122,7 +116,7 @@ getUserStorage_fn = async function(feature, key) {
     }
     const errorMessage = e instanceof Error ? e.message : JSON.stringify(e ?? "");
     throw new UserStorageError(
-      `failed to get user storage for feature '${feature}' and key '${key}'. ${errorMessage}`
+      `failed to get user storage for path '${path}'. ${errorMessage}`
     );
   }
 };
@@ -141,4 +135,4 @@ export {
   STORAGE_URL,
   UserStorage
 };
-//# sourceMappingURL=chunk-AXWK4Y23.mjs.map
+//# sourceMappingURL=chunk-NPH5AHLH.mjs.map

package/dist/chunk-NPH5AHLH.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sdk/user-storage.ts"],"sourcesContent":["import type { UserStoragePath } from '../controllers/user-storage/schema';\nimport { createEntryPath } from '../controllers/user-storage/schema';\nimport type { IBaseAuth } from './authentication-jwt-bearer/types';\nimport encryption, { createSHA256Hash } from './encryption';\nimport type { Env } from './env';\nimport { getEnvUrls } from './env';\nimport { NotFoundError, UserStorageError } from './errors';\n\nexport const STORAGE_URL = (env: Env, encryptedPath: string) =>\n  `${getEnvUrls(env).userStorageApiUrl}/api/v1/userstorage/${encryptedPath}`;\n\nexport type UserStorageConfig = {\n  env: Env;\n  auth: Pick<IBaseAuth, 'getAccessToken' | 'getUserProfile' | 'signMessage'>;\n};\n\nexport type StorageOptions = {\n  getStorageKey: () => Promise<string | null>;\n  setStorageKey: (val: string) => Promise<void>;\n};\n\nexport type UserStorageOptions = {\n  storage?: StorageOptions;\n};\n\ntype ErrorMessage = {\n  message: string;\n  error: string;\n};\n\nexport class UserStorage {\n  protected config: UserStorageConfig;\n\n  protected options: UserStorageOptions;\n\n  protected env: Env;\n\n  constructor(config: UserStorageConfig, options: UserStorageOptions) {\n    this.env = config.env;\n    this.config = config;\n    this.options = options;\n  }\n\n  async setItem(path: UserStoragePath, value: string): Promise<void> {\n    await this.#upsertUserStorage(path, value);\n  }\n\n  async getItem(path: UserStoragePath): Promise<string> {\n    return this.#getUserStorage(path);\n  }\n\n  async getStorageKey(): Promise<string> {\n    const storageKey = await this.options.storage?.getStorageKey();\n    if (storageKey) {\n      return storageKey;\n    }\n\n    const userProfile = await this.config.auth.getUserProfile();\n    const storageKeySignature = await this.config.auth.signMessage(\n      `metamask:${userProfile.profileId}`,\n    );\n    const hashedStorageKeySignature = createSHA256Hash(storageKeySignature);\n    await this.options.storage?.setStorageKey(hashedStorageKeySignature);\n    return hashedStorageKeySignature;\n  }\n\n  async #upsertUserStorage(path: UserStoragePath, data: string): Promise<void> {\n    try {\n      const headers = await this.#getAuthorizationHeader();\n      const storageKey = await this.getStorageKey();\n      const encryptedData = encryption.encryptString(data, storageKey);\n      const encryptedPath = createEntryPath(path, storageKey);\n\n      const url = new URL(STORAGE_URL(this.env, encryptedPath));\n\n      const response = await fetch(url.toString(), {\n        method: 'PUT',\n        headers: {\n          'Content-Type': 'application/json',\n          ...headers,\n        },\n        body: JSON.stringify({ data: encryptedData }),\n      });\n\n      if (!response.ok) {\n        const responseBody: ErrorMessage = await response.json().catch(() => ({\n          message: 'unknown',\n          error: 'unknown',\n        }));\n        throw new Error(\n          `HTTP error message: ${responseBody.message}, error: ${responseBody.error}`,\n        );\n      }\n    } catch (e) {\n      /* istanbul ignore next */\n      const errorMessage =\n        e instanceof Error ? e.message : JSON.stringify(e ?? '');\n      throw new UserStorageError(\n        `failed to upsert user storage for path '${path}'. ${errorMessage}`,\n      );\n    }\n  }\n\n  async #getUserStorage(path: UserStoragePath): Promise<string> {\n    try {\n      const headers = await this.#getAuthorizationHeader();\n      const storageKey = await this.getStorageKey();\n      const encryptedPath = createEntryPath(path, storageKey);\n\n      const url = new URL(STORAGE_URL(this.env, encryptedPath));\n\n      const response = await fetch(url.toString(), {\n        headers: {\n          'Content-Type': 'application/json',\n          ...headers,\n        },\n      });\n\n      if (response.status === 404) {\n        throw new NotFoundError(\n          `feature/key set not found for path '${path}'.`,\n        );\n      }\n\n      if (!response.ok) {\n        const responseBody = (await response.json()) as ErrorMessage;\n        throw new Error(\n          `HTTP error message: ${responseBody.message}, error: ${responseBody.error}`,\n        );\n      }\n\n      const { Data: encryptedData } = await response.json();\n      return encryption.decryptString(encryptedData, storageKey);\n    } catch (e) {\n      if (e instanceof NotFoundError) {\n        throw e;\n      }\n\n      /* istanbul ignore next */\n      const errorMessage =\n        e instanceof Error ? e.message : JSON.stringify(e ?? '');\n\n      throw new UserStorageError(\n        `failed to get user storage for path '${path}'. ${errorMessage}`,\n      );\n    }\n  }\n\n  #createEntryKey(key: string, storageKey: string): string {\n    const hashedKey = createSHA256Hash(key + storageKey);\n    return hashedKey;\n  }\n\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #getAuthorizationHeader(): Promise<{ Authorization: string }> {\n    const accessToken = await this.config.auth.getAccessToken();\n    return { Authorization: `Bearer ${accessToken}` };\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAQO,IAAM,cAAc,CAAC,KAAU,kBACpC,GAAG,WAAW,GAAG,EAAE,iBAAiB,uBAAuB,aAAa;AAT1E;AA8BO,IAAM,cAAN,MAAkB;AAAA,EAOvB,YAAY,QAA2B,SAA6B;AA6BpE,uBAAM;AAqCN,uBAAM;AA6CN;AAOA;AAAA;AAAA,uBAAM;AArHJ,SAAK,MAAM,OAAO;AAClB,SAAK,SAAS;AACd,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,MAAM,QAAQ,MAAuB,OAA8B;AACjE,UAAM,sBAAK,0CAAL,WAAwB,MAAM;AAAA,EACtC;AAAA,EAEA,MAAM,QAAQ,MAAwC;AACpD,WAAO,sBAAK,oCAAL,WAAqB;AAAA,EAC9B;AAAA,EAEA,MAAM,gBAAiC;AACrC,UAAM,aAAa,MAAM,KAAK,QAAQ,SAAS,cAAc;AAC7D,QAAI,YAAY;AACd,aAAO;AAAA,IACT;AAEA,UAAM,cAAc,MAAM,KAAK,OAAO,KAAK,eAAe;AAC1D,UAAM,sBAAsB,MAAM,KAAK,OAAO,KAAK;AAAA,MACjD,YAAY,YAAY,SAAS;AAAA,IACnC;AACA,UAAM,4BAA4B,iBAAiB,mBAAmB;AACtE,UAAM,KAAK,QAAQ,SAAS,cAAc,yBAAyB;AACnE,WAAO;AAAA,EACT;AA+FF;AA7FQ;AAAA,uBAAkB,eAAC,MAAuB,MAA6B;AAC3E,MAAI;AACF,UAAM,UAAU,MAAM,sBAAK,oDAAL;AACtB,UAAM,aAAa,MAAM,KAAK,cAAc;AAC5C,UAAM,gBAAgB,mBAAW,cAAc,MAAM,UAAU;AAC/D,UAAM,gBAAgB,gBAAgB,MAAM,UAAU;AAEtD,UAAM,MAAM,IAAI,IAAI,YAAY,KAAK,KAAK,aAAa,CAAC;AAExD,UAAM,WAAW,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,MAC3C,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,GAAG;AAAA,MACL;AAAA,MACA,MAAM,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAAA,IAC9C,CAAC;AAED,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,eAA6B,MAAM,SAAS,KAAK,EAAE,MAAM,OAAO;AAAA,QACpE,SAAS;AAAA,QACT,OAAO;AAAA,MACT,EAAE;AACF,YAAM,IAAI;AAAA,QACR,uBAAuB,aAAa,OAAO,YAAY,aAAa,KAAK;AAAA,MAC3E;AAAA,IACF;AAAA,EACF,SAAS,GAAG;AAEV,UAAM,eACJ,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,KAAK,EAAE;AACzD,UAAM,IAAI;AAAA,MACR,2CAA2C,IAAI,MAAM,YAAY;AAAA,IACnE;AAAA,EACF;AACF;AAEM;AAAA,oBAAe,eAAC,MAAwC;AAC5D,MAAI;AACF,UAAM,UAAU,MAAM,sBAAK,oDAAL;AACtB,UAAM,aAAa,MAAM,KAAK,cAAc;AAC5C,UAAM,gBAAgB,gBAAgB,MAAM,UAAU;AAEtD,UAAM,MAAM,IAAI,IAAI,YAAY,KAAK,KAAK,aAAa,CAAC;AAExD,UAAM,WAAW,MAAM,MAAM,IAAI,SAAS,GAAG;AAAA,MAC3C,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,GAAG;AAAA,MACL;AAAA,IACF,CAAC;AAED,QAAI,SAAS,WAAW,KAAK;AAC3B,YAAM,IAAI;AAAA,QACR,uCAAuC,IAAI;AAAA,MAC7C;AAAA,IACF;AAEA,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,eAAgB,MAAM,SAAS,KAAK;AAC1C,YAAM,IAAI;AAAA,QACR,uBAAuB,aAAa,OAAO,YAAY,aAAa,KAAK;AAAA,MAC3E;AAAA,IACF;AAEA,UAAM,EAAE,MAAM,cAAc,IAAI,MAAM,SAAS,KAAK;AACpD,WAAO,mBAAW,cAAc,eAAe,UAAU;AAAA,EAC3D,SAAS,GAAG;AACV,QAAI,aAAa,eAAe;AAC9B,YAAM;AAAA,IACR;AAGA,UAAM,eACJ,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,KAAK,EAAE;AAEzD,UAAM,IAAI;AAAA,MACR,wCAAwC,IAAI,MAAM,YAAY;AAAA,IAChE;AAAA,EACF;AACF;AAEA;AAAA,oBAAe,SAAC,KAAa,YAA4B;AACvD,QAAM,YAAY,iBAAiB,MAAM,UAAU;AACnD,SAAO;AACT;AAIM;AAAA,4BAAuB,iBAAuC;AAClE,QAAM,cAAc,MAAM,KAAK,OAAO,KAAK,eAAe;AAC1D,SAAO,EAAE,eAAe,UAAU,WAAW,GAAG;AAClD;","names":[]}

package/dist/{chunk-3DMUUTKC.js → chunk-PSR2V3R4.js}

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkKUTU3NNSjs = require('./chunk-KUTU3NNS.js');
+var _chunkXSSIP3PJjs = require('./chunk-XSSIP3PJ.js');
 
 
 var _chunkG4NU4KP7js = require('./chunk-G4NU4KP7.js');
@@ -20,7 +20,7 @@ var _chunkPQ5T4GHYjs = require('./chunk-PQ5T4GHY.js');
 
 
 
-var _chunkP52TG263js = require('./chunk-P52TG263.js');
+var _chunkFUPEFLXBjs = require('./chunk-FUPEFLXB.js');
 
 
 
@@ -50,7 +50,7 @@ _chunkIGY2S5BCjs.__export.call(void 0, sdk_exports, {
   AuthType: () => _chunkPBRUOBEQjs.AuthType,
   Encryption: () => _chunkP4DUDLMYjs.Encryption,
   Env: () => _chunkSMKTWM6Ijs.Env,
-  JwtBearerAuth: () => _chunkKUTU3NNSjs.JwtBearerAuth,
+  JwtBearerAuth: () => _chunkXSSIP3PJjs.JwtBearerAuth,
   MESSAGE_SIGNING_SNAP: () => _chunkPQ5T4GHYjs.MESSAGE_SIGNING_SNAP,
   NonceRetrievalError: () => _chunkMBTBE4P5js.NonceRetrievalError,
   NotFoundError: () => _chunkMBTBE4P5js.NotFoundError,
@@ -59,10 +59,10 @@ _chunkIGY2S5BCjs.__export.call(void 0, sdk_exports, {
   SIWEJwtBearerAuth: () => _chunkG4NU4KP7js.SIWEJwtBearerAuth,
   SNAP_ORIGIN: () => _chunkPQ5T4GHYjs.SNAP_ORIGIN,
   SRPJwtBearerAuth: () => _chunkVD2IGTS3js.SRPJwtBearerAuth,
-  STORAGE_URL: () => _chunkP52TG263js.STORAGE_URL,
+  STORAGE_URL: () => _chunkFUPEFLXBjs.STORAGE_URL,
   SignInError: () => _chunkMBTBE4P5js.SignInError,
   UnsupportedAuthTypeError: () => _chunkMBTBE4P5js.UnsupportedAuthTypeError,
-  UserStorage: () => _chunkP52TG263js.UserStorage,
+  UserStorage: () => _chunkFUPEFLXBjs.UserStorage,
   UserStorageError: () => _chunkMBTBE4P5js.UserStorageError,
   ValidationError: () => _chunkMBTBE4P5js.ValidationError,
   connectSnap: () => _chunkPQ5T4GHYjs.connectSnap,
@@ -76,4 +76,4 @@ _chunkIGY2S5BCjs.__export.call(void 0, sdk_exports, {
 
 
 exports.sdk_exports = sdk_exports;
-//# sourceMappingURL=chunk-3DMUUTKC.js.map
+//# sourceMappingURL=chunk-PSR2V3R4.js.map

package/dist/{chunk-TUMNNWY6.mjs → chunk-QE5X2BT3.mjs}

@@ -4,14 +4,15 @@ import {
 import {
   getUserStorage,
   upsertUserStorage
-} from "./chunk-2XGRQBXI.mjs";
+} from "./chunk-FU7PSGFP.mjs";
 import {
   createSHA256Hash
 } from "./chunk-K5UKU454.mjs";
 import {
   __privateAdd,
   __privateGet,
-  __privateMethod
+  __privateMethod,
+  __privateSet
 } from "./chunk-U5UIDVOO.mjs";
 
 // src/controllers/user-storage/UserStorageController.ts
@@ -31,7 +32,7 @@ var metadata = {
     anonymous: false
   }
 };
-var _auth, _notificationServices, _registerMessageHandlers, registerMessageHandlers_fn, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn, _createStorageKey, createStorageKey_fn, __snapSignMessageCache, _snapSignMessage, snapSignMessage_fn, _setIsProfileSyncingUpdateLoading, setIsProfileSyncingUpdateLoading_fn;
+var _auth, _notificationServices, _isUnlocked, _keyringController, _registerMessageHandlers, registerMessageHandlers_fn, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn, _createStorageKey, createStorageKey_fn, __snapSignMessageCache, _snapSignMessage, snapSignMessage_fn, _setIsProfileSyncingUpdateLoading, setIsProfileSyncingUpdateLoading_fn;
 var UserStorageController = class extends BaseController {
   constructor(params) {
     super({
@@ -102,8 +103,24 @@ var UserStorageController = class extends BaseController {
         );
       }
     });
+    __privateAdd(this, _isUnlocked, false);
+    __privateAdd(this, _keyringController, {
+      setupLockedStateSubscriptions: () => {
+        const { isUnlocked } = this.messagingSystem.call(
+          "KeyringController:getState"
+        );
+        __privateSet(this, _isUnlocked, isUnlocked);
+        this.messagingSystem.subscribe("KeyringController:unlock", () => {
+          __privateSet(this, _isUnlocked, true);
+        });
+        this.messagingSystem.subscribe("KeyringController:lock", () => {
+          __privateSet(this, _isUnlocked, false);
+        });
+      }
+    });
     __privateAdd(this, __snapSignMessageCache, {});
     this.getMetaMetricsState = params.getMetaMetricsState;
+    __privateGet(this, _keyringController).setupLockedStateSubscriptions();
     __privateMethod(this, _registerMessageHandlers, registerMessageHandlers_fn).call(this);
   }
   async enableProfileSyncing() {
@@ -143,7 +160,7 @@ var UserStorageController = class extends BaseController {
       }
       const isMetaMetricsParticipation = this.getMetaMetricsState();
       if (!isMetaMetricsParticipation) {
-        this.messagingSystem.call("AuthenticationController:performSignOut");
+        await __privateGet(this, _auth).signOut();
       }
       __privateMethod(this, _setIsProfileSyncingUpdateLoading, setIsProfileSyncingUpdateLoading_fn).call(this, false);
       this.update((state) => {
@@ -161,14 +178,14 @@ var UserStorageController = class extends BaseController {
    * Allows retrieval of stored data. Data stored is string formatted.
    * Developers can extend the entry path and entry name through the `schema.ts` file.
    *
-   * @param entryKey - entry key that matches schema
+   * @param path - string in the form of `${feature}.${key}` that matches schema
    * @returns the decrypted string contents found from user storage (or null if not found)
    */
-  async performGetStorage(entryKey) {
+  async performGetStorage(path) {
     __privateMethod(this, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn).call(this);
     const { bearerToken, storageKey } = await __privateMethod(this, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn).call(this);
     const result = await getUserStorage({
-      entryKey,
+      path,
       bearerToken,
       storageKey
     });
@@ -178,15 +195,15 @@ var UserStorageController = class extends BaseController {
    * Allows storage of user data. Data stored must be string formatted.
    * Developers can extend the entry path and entry name through the `schema.ts` file.
    *
-   * @param entryKey - entry key that matches schema
+   * @param path - string in the form of `${feature}.${key}` that matches schema
    * @param value - The string data you want to store.
    * @returns nothing. NOTE that an error is thrown if fails to store data.
    */
-  async performSetStorage(entryKey, value) {
+  async performSetStorage(path, value) {
     __privateMethod(this, _assertProfileSyncingEnabled, assertProfileSyncingEnabled_fn).call(this);
     const { bearerToken, storageKey } = await __privateMethod(this, _getStorageKeyAndBearerToken, getStorageKeyAndBearerToken_fn).call(this);
     await upsertUserStorage(value, {
-      entryKey,
+      path,
       bearerToken,
       storageKey
     });
@@ -204,6 +221,8 @@ var UserStorageController = class extends BaseController {
 };
 _auth = new WeakMap();
 _notificationServices = new WeakMap();
+_isUnlocked = new WeakMap();
+_keyringController = new WeakMap();
 _registerMessageHandlers = new WeakSet();
 registerMessageHandlers_fn = function() {
   this.messagingSystem.registerActionHandler(
@@ -260,6 +279,11 @@ snapSignMessage_fn = async function(message) {
   if (__privateGet(this, __snapSignMessageCache)[message]) {
     return __privateGet(this, __snapSignMessageCache)[message];
   }
+  if (!__privateGet(this, _isUnlocked)) {
+    throw new Error(
+      "#snapSignMessage - unable to call snap, wallet is locked"
+    );
+  }
   const result = await this.messagingSystem.call(
     "SnapController:handleRequest",
     createSnapSignMessageRequest(message)
@@ -278,4 +302,4 @@ export {
   defaultState,
   UserStorageController
 };
-//# sourceMappingURL=chunk-TUMNNWY6.mjs.map
+//# sourceMappingURL=chunk-QE5X2BT3.mjs.map

package/dist/chunk-QE5X2BT3.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/UserStorageController.ts"],"sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  KeyringControllerGetStateAction,\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\n\nimport { createSnapSignMessageRequest } from '../authentication/auth-snap-requests';\nimport type {\n  AuthenticationControllerGetBearerToken,\n  AuthenticationControllerGetSessionProfile,\n  AuthenticationControllerIsSignedIn,\n  AuthenticationControllerPerformSignIn,\n  AuthenticationControllerPerformSignOut,\n} from '../authentication/AuthenticationController';\nimport { createSHA256Hash } from './encryption';\nimport type { UserStoragePath } from './schema';\nimport { getUserStorage, upsertUserStorage } from './services';\n\n// TODO: fix external dependencies\nexport declare type NotificationServicesControllerDisableNotificationServices =\n  {\n    type: `NotificationServicesController:disableNotificationServices`;\n    handler: () => Promise<void>;\n  };\n\nexport declare type NotificationServicesControllerSelectIsNotificationServicesEnabled =\n  {\n    type: `NotificationServicesController:selectIsNotificationServicesEnabled`;\n    handler: () => boolean;\n  };\n\nconst controllerName = 'UserStorageController';\n\n// State\nexport type UserStorageControllerState = {\n  /**\n   * Condition used by UI and to determine if we can use some of the User Storage methods.\n   */\n  isProfileSyncingEnabled: boolean | null;\n  /**\n   * Loading state for the profile syncing update\n   */\n  isProfileSyncingUpdateLoading: boolean;\n};\n\nexport const defaultState: UserStorageControllerState = {\n  isProfileSyncingEnabled: true,\n  isProfileSyncingUpdateLoading: false,\n};\n\nconst metadata: StateMetadata<UserStorageControllerState> = {\n  isProfileSyncingEnabled: {\n    persist: true,\n    anonymous: true,\n  },\n  isProfileSyncingUpdateLoading: {\n    persist: false,\n    anonymous: false,\n  },\n};\n\n// Messenger Actions\ntype CreateActionsObj<Controller extends keyof UserStorageController> = {\n  [K in Controller]: {\n    type: `${typeof controllerName}:${K}`;\n    handler: UserStorageController[K];\n  };\n};\ntype ActionsObj = CreateActionsObj<\n  | 'performGetStorage'\n  | 'performSetStorage'\n  | 'getStorageKey'\n  | 'enableProfileSyncing'\n  | 'disableProfileSyncing'\n>;\nexport type Actions = ActionsObj[keyof ActionsObj];\nexport type UserStorageControllerPerformGetStorage =\n  ActionsObj['performGetStorage'];\nexport type UserStorageControllerPerformSetStorage =\n  ActionsObj['performSetStorage'];\nexport type UserStorageControllerGetStorageKey = ActionsObj['getStorageKey'];\nexport type UserStorageControllerEnableProfileSyncing =\n  ActionsObj['enableProfileSyncing'];\nexport type UserStorageControllerDisableProfileSyncing =\n  ActionsObj['disableProfileSyncing'];\n\n// Allowed Actions\nexport type AllowedActions =\n  // Keyring Requests\n  | KeyringControllerGetStateAction\n  // Snap Requests\n  | HandleSnapRequest\n  // Auth Requests\n  | AuthenticationControllerGetBearerToken\n  | AuthenticationControllerGetSessionProfile\n  | AuthenticationControllerPerformSignIn\n  | AuthenticationControllerIsSignedIn\n  | AuthenticationControllerPerformSignOut\n  // Metamask Notifications\n  | NotificationServicesControllerDisableNotificationServices\n  | NotificationServicesControllerSelectIsNotificationServicesEnabled;\n\nexport type AllowedEvents =\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent;\n\n// Messenger\nexport type UserStorageControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  Actions | AllowedActions,\n  AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Reusable controller that allows any team to store synchronized data for a given user.\n * These can be settings shared cross MetaMask clients, or data we want to persist when uninstalling/reinstalling.\n *\n * NOTE:\n * - data stored on UserStorage is FULLY encrypted, with the only keys stored/managed on the client.\n * - No one can access this data unless they are have the SRP and are able to run the signing snap.\n */\nexport default class UserStorageController extends BaseController<\n  typeof controllerName,\n  UserStorageControllerState,\n  UserStorageControllerMessenger\n> {\n  #auth = {\n    getBearerToken: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:getBearerToken',\n      );\n    },\n    getProfileId: async () => {\n      const sessionProfile = await this.messagingSystem.call(\n        'AuthenticationController:getSessionProfile',\n      );\n      return sessionProfile?.profileId;\n    },\n    isAuthEnabled: () => {\n      return this.messagingSystem.call('AuthenticationController:isSignedIn');\n    },\n    signIn: async () => {\n      return await this.messagingSystem.call(\n        'AuthenticationController:performSignIn',\n      );\n    },\n    signOut: async () => {\n      return this.messagingSystem.call(\n        'AuthenticationController:performSignOut',\n      );\n    },\n  };\n\n  #notificationServices = {\n    disableNotificationServices: async () => {\n      return await this.messagingSystem.call(\n        'NotificationServicesController:disableNotificationServices',\n      );\n    },\n    selectIsNotificationServicesEnabled: async () => {\n      return this.messagingSystem.call(\n        'NotificationServicesController:selectIsNotificationServicesEnabled',\n      );\n    },\n  };\n\n  #isUnlocked = false;\n\n  #keyringController = {\n    setupLockedStateSubscriptions: () => {\n      const { isUnlocked } = this.messagingSystem.call(\n        'KeyringController:getState',\n      );\n      this.#isUnlocked = isUnlocked;\n\n      this.messagingSystem.subscribe('KeyringController:unlock', () => {\n        this.#isUnlocked = true;\n      });\n\n      this.messagingSystem.subscribe('KeyringController:lock', () => {\n        this.#isUnlocked = false;\n      });\n    },\n  };\n\n  getMetaMetricsState: () => boolean;\n\n  constructor(params: {\n    messenger: UserStorageControllerMessenger;\n    state?: UserStorageControllerState;\n    getMetaMetricsState: () => boolean;\n  }) {\n    super({\n      messenger: params.messenger,\n      metadata,\n      name: controllerName,\n      state: { ...defaultState, ...params.state },\n    });\n\n    this.getMetaMetricsState = params.getMetaMetricsState;\n    this.#keyringController.setupLockedStateSubscriptions();\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers(): void {\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performGetStorage',\n      this.performGetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:performSetStorage',\n      this.performSetStorage.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:getStorageKey',\n      this.getStorageKey.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:enableProfileSyncing',\n      this.enableProfileSyncing.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      'UserStorageController:disableProfileSyncing',\n      this.disableProfileSyncing.bind(this),\n    );\n  }\n\n  public async enableProfileSyncing(): Promise<void> {\n    try {\n      this.#setIsProfileSyncingUpdateLoading(true);\n\n      const authEnabled = this.#auth.isAuthEnabled();\n      if (!authEnabled) {\n        await this.#auth.signIn();\n      }\n\n      this.update((state) => {\n        state.isProfileSyncingEnabled = true;\n      });\n\n      this.#setIsProfileSyncingUpdateLoading(false);\n    } catch (e) {\n      this.#setIsProfileSyncingUpdateLoading(false);\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to enable profile syncing - ${errorMessage}`,\n      );\n    }\n  }\n\n  public async setIsProfileSyncingEnabled(\n    isProfileSyncingEnabled: boolean,\n  ): Promise<void> {\n    this.update((state) => {\n      state.isProfileSyncingEnabled = isProfileSyncingEnabled;\n    });\n  }\n\n  public async disableProfileSyncing(): Promise<void> {\n    const isAlreadyDisabled = !this.state.isProfileSyncingEnabled;\n    if (isAlreadyDisabled) {\n      return;\n    }\n\n    try {\n      this.#setIsProfileSyncingUpdateLoading(true);\n\n      const isNotificationServicesEnabled =\n        await this.#notificationServices.selectIsNotificationServicesEnabled();\n\n      if (isNotificationServicesEnabled) {\n        await this.#notificationServices.disableNotificationServices();\n      }\n\n      const isMetaMetricsParticipation = this.getMetaMetricsState();\n\n      if (!isMetaMetricsParticipation) {\n        await this.#auth.signOut();\n      }\n\n      this.#setIsProfileSyncingUpdateLoading(false);\n\n      this.update((state) => {\n        state.isProfileSyncingEnabled = false;\n      });\n    } catch (e) {\n      this.#setIsProfileSyncingUpdateLoading(false);\n      const errorMessage = e instanceof Error ? e.message : JSON.stringify(e);\n      throw new Error(\n        `${controllerName} - failed to disable profile syncing - ${errorMessage}`,\n      );\n    }\n  }\n\n  /**\n   * Allows retrieval of stored data. Data stored is string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @returns the decrypted string contents found from user storage (or null if not found)\n   */\n  public async performGetStorage(\n    path: UserStoragePath,\n  ): Promise<string | null> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    const result = await getUserStorage({\n      path,\n      bearerToken,\n      storageKey,\n    });\n\n    return result;\n  }\n\n  /**\n   * Allows storage of user data. Data stored must be string formatted.\n   * Developers can extend the entry path and entry name through the `schema.ts` file.\n   *\n   * @param path - string in the form of `${feature}.${key}` that matches schema\n   * @param value - The string data you want to store.\n   * @returns nothing. NOTE that an error is thrown if fails to store data.\n   */\n  public async performSetStorage(\n    path: UserStoragePath,\n    value: string,\n  ): Promise<void> {\n    this.#assertProfileSyncingEnabled();\n\n    const { bearerToken, storageKey } =\n      await this.#getStorageKeyAndBearerToken();\n\n    await upsertUserStorage(value, {\n      path,\n      bearerToken,\n      storageKey,\n    });\n  }\n\n  /**\n   * Retrieves the storage key, for internal use only!\n   *\n   * @returns the storage key\n   */\n  public async getStorageKey(): Promise<string> {\n    this.#assertProfileSyncingEnabled();\n    const storageKey = await this.#createStorageKey();\n    return storageKey;\n  }\n\n  #assertProfileSyncingEnabled(): void {\n    if (!this.state.isProfileSyncingEnabled) {\n      throw new Error(\n        `${controllerName}: Unable to call method, user is not authenticated`,\n      );\n    }\n  }\n\n  /**\n   * Utility to get the bearer token and storage key\n   */\n  async #getStorageKeyAndBearerToken(): Promise<{\n    bearerToken: string;\n    storageKey: string;\n  }> {\n    const bearerToken = await this.#auth.getBearerToken();\n    if (!bearerToken) {\n      throw new Error('UserStorageController - unable to get bearer token');\n    }\n    const storageKey = await this.#createStorageKey();\n\n    return { bearerToken, storageKey };\n  }\n\n  /**\n   * Rather than storing the storage key, we can compute the storage key when needed.\n   *\n   * @returns the storage key\n   */\n  async #createStorageKey(): Promise<string> {\n    const id: string = await this.#auth.getProfileId();\n    if (!id) {\n      throw new Error('UserStorageController - unable to create storage key');\n    }\n\n    const storageKeySignature = await this.#snapSignMessage(`metamask:${id}`);\n    const storageKey = createSHA256Hash(storageKeySignature);\n    return storageKey;\n  }\n\n  #_snapSignMessageCache: Record<`metamask:${string}`, string> = {};\n\n  /**\n   * Signs a specific message using an underlying auth snap.\n   *\n   * @param message - A specific tagged message to sign.\n   * @returns A Signature created by the snap.\n   */\n  async #snapSignMessage(message: `metamask:${string}`): Promise<string> {\n    if (this.#_snapSignMessageCache[message]) {\n      return this.#_snapSignMessageCache[message];\n    }\n\n    if (!this.#isUnlocked) {\n      throw new Error(\n        '#snapSignMessage - unable to call snap, wallet is locked',\n      );\n    }\n\n    const result = (await this.messagingSystem.call(\n      'SnapController:handleRequest',\n      createSnapSignMessageRequest(message),\n    )) as string;\n\n    this.#_snapSignMessageCache[message] = result;\n\n    return result;\n  }\n\n  #setIsProfileSyncingUpdateLoading(\n    isProfileSyncingUpdateLoading: boolean,\n  ): void {\n    this.update((state) => {\n      state.isProfileSyncingUpdateLoading = isProfileSyncingUpdateLoading;\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAIA,SAAS,sBAAsB;AAiC/B,IAAM,iBAAiB;AAchB,IAAM,eAA2C;AAAA,EACtD,yBAAyB;AAAA,EACzB,+BAA+B;AACjC;AAEA,IAAM,WAAsD;AAAA,EAC1D,yBAAyB;AAAA,IACvB,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AAAA,EACA,+BAA+B;AAAA,IAC7B,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AACF;AAjEA;AAiIA,IAAqB,wBAArB,cAAmD,eAIjD;AAAA,EA8DA,YAAY,QAIT;AACD,UAAM;AAAA,MACJ,WAAW,OAAO;AAAA,MAClB;AAAA,MACA,MAAM;AAAA,MACN,OAAO,EAAE,GAAG,cAAc,GAAG,OAAO,MAAM;AAAA,IAC5C,CAAC;AAWH;AAAA;AAAA;AAAA;AAAA;AAyJA;AAWA;AAAA;AAAA;AAAA,uBAAM;AAkBN;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAmBN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAqBN;AAhTA,8BAAQ;AAAA,MACN,gBAAgB,YAAY;AAC1B,eAAO,MAAM,KAAK,gBAAgB;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,YAAY;AACxB,cAAM,iBAAiB,MAAM,KAAK,gBAAgB;AAAA,UAChD;AAAA,QACF;AACA,eAAO,gBAAgB;AAAA,MACzB;AAAA,MACA,eAAe,MAAM;AACnB,eAAO,KAAK,gBAAgB,KAAK,qCAAqC;AAAA,MACxE;AAAA,MACA,QAAQ,YAAY;AAClB,eAAO,MAAM,KAAK,gBAAgB;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,MACA,SAAS,YAAY;AACnB,eAAO,KAAK,gBAAgB;AAAA,UAC1B;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,8CAAwB;AAAA,MACtB,6BAA6B,YAAY;AACvC,eAAO,MAAM,KAAK,gBAAgB;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,MACA,qCAAqC,YAAY;AAC/C,eAAO,KAAK,gBAAgB;AAAA,UAC1B;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,oCAAc;AAEd,2CAAqB;AAAA,MACnB,+BAA+B,MAAM;AACnC,cAAM,EAAE,WAAW,IAAI,KAAK,gBAAgB;AAAA,UAC1C;AAAA,QACF;AACA,2BAAK,aAAc;AAEnB,aAAK,gBAAgB,UAAU,4BAA4B,MAAM;AAC/D,6BAAK,aAAc;AAAA,QACrB,CAAC;AAED,aAAK,gBAAgB,UAAU,0BAA0B,MAAM;AAC7D,6BAAK,aAAc;AAAA,QACrB,CAAC;AAAA,MACH;AAAA,IACF;AA0NA,+CAA+D,CAAC;AA1M9D,SAAK,sBAAsB,OAAO;AAClC,uBAAK,oBAAmB,8BAA8B;AACtD,0BAAK,sDAAL;AAAA,EACF;AAAA,EAiCA,MAAa,uBAAsC;AACjD,QAAI;AACF,4BAAK,wEAAL,WAAuC;AAEvC,YAAM,cAAc,mBAAK,OAAM,cAAc;AAC7C,UAAI,CAAC,aAAa;AAChB,cAAM,mBAAK,OAAM,OAAO;AAAA,MAC1B;AAEA,WAAK,OAAO,CAAC,UAAU;AACrB,cAAM,0BAA0B;AAAA,MAClC,CAAC;AAED,4BAAK,wEAAL,WAAuC;AAAA,IACzC,SAAS,GAAG;AACV,4BAAK,wEAAL,WAAuC;AACvC,YAAM,eAAe,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,CAAC;AACtE,YAAM,IAAI;AAAA,QACR,GAAG,cAAc,yCAAyC,YAAY;AAAA,MACxE;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAa,2BACX,yBACe;AACf,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,0BAA0B;AAAA,IAClC,CAAC;AAAA,EACH;AAAA,EAEA,MAAa,wBAAuC;AAClD,UAAM,oBAAoB,CAAC,KAAK,MAAM;AACtC,QAAI,mBAAmB;AACrB;AAAA,IACF;AAEA,QAAI;AACF,4BAAK,wEAAL,WAAuC;AAEvC,YAAM,gCACJ,MAAM,mBAAK,uBAAsB,oCAAoC;AAEvE,UAAI,+BAA+B;AACjC,cAAM,mBAAK,uBAAsB,4BAA4B;AAAA,MAC/D;AAEA,YAAM,6BAA6B,KAAK,oBAAoB;AAE5D,UAAI,CAAC,4BAA4B;AAC/B,cAAM,mBAAK,OAAM,QAAQ;AAAA,MAC3B;AAEA,4BAAK,wEAAL,WAAuC;AAEvC,WAAK,OAAO,CAAC,UAAU;AACrB,cAAM,0BAA0B;AAAA,MAClC,CAAC;AAAA,IACH,SAAS,GAAG;AACV,4BAAK,wEAAL,WAAuC;AACvC,YAAM,eAAe,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,CAAC;AACtE,YAAM,IAAI;AAAA,QACR,GAAG,cAAc,0CAA0C,YAAY;AAAA,MACzE;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,kBACX,MACwB;AACxB,0BAAK,8DAAL;AAEA,UAAM,EAAE,aAAa,WAAW,IAC9B,MAAM,sBAAK,8DAAL;AAER,UAAM,SAAS,MAAM,eAAe;AAAA,MAClC;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,kBACX,MACA,OACe;AACf,0BAAK,8DAAL;AAEA,UAAM,EAAE,aAAa,WAAW,IAC9B,MAAM,sBAAK,8DAAL;AAER,UAAM,kBAAkB,OAAO;AAAA,MAC7B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,gBAAiC;AAC5C,0BAAK,8DAAL;AACA,UAAM,aAAa,MAAM,sBAAK,wCAAL;AACzB,WAAO;AAAA,EACT;AA8EF;AAvTE;AA2BA;AAaA;AAEA;AAwCA;AAAA,6BAAwB,WAAS;AAC/B,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,kBAAkB,KAAK,IAAI;AAAA,EAClC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,kBAAkB,KAAK,IAAI;AAAA,EAClC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,cAAc,KAAK,IAAI;AAAA,EAC9B;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,qBAAqB,KAAK,IAAI;AAAA,EACrC;AAEA,OAAK,gBAAgB;AAAA,IACnB;AAAA,IACA,KAAK,sBAAsB,KAAK,IAAI;AAAA,EACtC;AACF;AAgIA;AAAA,iCAA4B,WAAS;AACnC,MAAI,CAAC,KAAK,MAAM,yBAAyB;AACvC,UAAM,IAAI;AAAA,MACR,GAAG,cAAc;AAAA,IACnB;AAAA,EACF;AACF;AAKM;AAAA,iCAA4B,iBAG/B;AACD,QAAM,cAAc,MAAM,mBAAK,OAAM,eAAe;AACpD,MAAI,CAAC,aAAa;AAChB,UAAM,IAAI,MAAM,oDAAoD;AAAA,EACtE;AACA,QAAM,aAAa,MAAM,sBAAK,wCAAL;AAEzB,SAAO,EAAE,aAAa,WAAW;AACnC;AAOM;AAAA,sBAAiB,iBAAoB;AACzC,QAAM,KAAa,MAAM,mBAAK,OAAM,aAAa;AACjD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI,MAAM,sDAAsD;AAAA,EACxE;AAEA,QAAM,sBAAsB,MAAM,sBAAK,sCAAL,WAAsB,YAAY,EAAE;AACtE,QAAM,aAAa,iBAAiB,mBAAmB;AACvD,SAAO;AACT;AAEA;AAQM;AAAA,qBAAgB,eAAC,SAAgD;AACrE,MAAI,mBAAK,wBAAuB,OAAO,GAAG;AACxC,WAAO,mBAAK,wBAAuB,OAAO;AAAA,EAC5C;AAEA,MAAI,CAAC,mBAAK,cAAa;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,SAAU,MAAM,KAAK,gBAAgB;AAAA,IACzC;AAAA,IACA,6BAA6B,OAAO;AAAA,EACtC;AAEA,qBAAK,wBAAuB,OAAO,IAAI;AAEvC,SAAO;AACT;AAEA;AAAA,sCAAiC,SAC/B,+BACM;AACN,OAAK,OAAO,CAAC,UAAU;AACrB,UAAM,gCAAgC;AAAA,EACxC,CAAC;AACH;","names":[]}

package/dist/chunk-SLHAVOTE.js

@@ -0,0 +1,40 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkT3FNDVE3js = require('./chunk-T3FNDVE3.js');
+
+// src/controllers/user-storage/schema.ts
+var USER_STORAGE_SCHEMA = {
+  notifications: ["notificationSettings"]
+};
+var getFeatureAndKeyFromPath = (path) => {
+  const pathRegex = /^\w+\.\w+$/u;
+  if (!pathRegex.test(path)) {
+    throw new Error(
+      `user-storage - path is not in the correct format. Correct format: 'feature.key'`
+    );
+  }
+  const [feature, key] = path.split(".");
+  if (!(feature in USER_STORAGE_SCHEMA)) {
+    throw new Error(`user-storage - invalid feature provided: ${feature}`);
+  }
+  const validFeature = USER_STORAGE_SCHEMA[feature];
+  if (!validFeature.includes(key)) {
+    const validKeys = USER_STORAGE_SCHEMA[feature].join(", ");
+    throw new Error(
+      `user-storage - invalid key provided for this feature: ${key}. Valid keys: ${validKeys}`
+    );
+  }
+  return { feature, key };
+};
+function createEntryPath(path, storageKey) {
+  const { feature, key } = getFeatureAndKeyFromPath(path);
+  const hashedKey = _chunkT3FNDVE3js.createSHA256Hash.call(void 0, key + storageKey);
+  return `/${feature}/${hashedKey}`;
+}
+
+
+
+
+
+exports.USER_STORAGE_SCHEMA = USER_STORAGE_SCHEMA; exports.getFeatureAndKeyFromPath = getFeatureAndKeyFromPath; exports.createEntryPath = createEntryPath;
+//# sourceMappingURL=chunk-SLHAVOTE.js.map

package/dist/chunk-SLHAVOTE.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/controllers/user-storage/schema.ts"],"names":[],"mappings":";;;;;AAOO,IAAM,sBAAsB;AAAA,EACjC,eAAe,CAAC,sBAAsB;AACxC;AAgBO,IAAM,2BAA2B,CACtC,SAC6B;AAC7B,QAAM,YAAY;AAElB,MAAI,CAAC,UAAU,KAAK,IAAI,GAAG;AACzB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,QAAM,CAAC,SAAS,GAAG,IAAI,KAAK,MAAM,GAAG;AAKrC,MAAI,EAAE,WAAW,sBAAsB;AACrC,UAAM,IAAI,MAAM,4CAA4C,OAAO,EAAE;AAAA,EACvE;AAEA,QAAM,eAAe,oBAAoB,OAAO;AAEhD,MAAI,CAAC,aAAa,SAAS,GAAG,GAAG;AAC/B,UAAM,YAAY,oBAAoB,OAAO,EAAE,KAAK,IAAI;AAExD,UAAM,IAAI;AAAA,MACR,yDAAyD,GAAG,iBAAiB,SAAS;AAAA,IACxF;AAAA,EACF;AAEA,SAAO,EAAE,SAAS,IAAI;AACxB;AAWO,SAAS,gBACd,MACA,YACQ;AACR,QAAM,EAAE,SAAS,IAAI,IAAI,yBAAyB,IAAI;AACtD,QAAM,YAAY,iBAAiB,MAAM,UAAU;AAEnD,SAAO,IAAI,OAAO,IAAI,SAAS;AACjC","sourcesContent":["import { createSHA256Hash } from './encryption';\n\n/**\n * The User Storage Endpoint requires a feature name and a namespace key.\n * Developers can provide additional features and keys by extending these types below.\n */\n\nexport const USER_STORAGE_SCHEMA = {\n  notifications: ['notificationSettings'],\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\ntype UserStorageFeatures = keyof UserStorageSchema;\ntype UserStorageFeatureKeys<Feature extends UserStorageFeatures> =\n  UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatures;\n  key: UserStorageFeatureKeys<UserStorageFeatures>;\n};\n\nexport type UserStoragePath = {\n  [K in keyof UserStorageSchema]: `${K}.${UserStorageSchema[K][number]}`;\n}[keyof UserStorageSchema];\n\nexport const getFeatureAndKeyFromPath = (\n  path: UserStoragePath,\n): UserStorageFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  if (!pathRegex.test(path)) {\n    throw new Error(\n      `user-storage - path is not in the correct format. Correct format: 'feature.key'`,\n    );\n  }\n\n  const [feature, key] = path.split('.') as [\n    UserStorageFeatures,\n    UserStorageFeatureKeys<UserStorageFeatures>,\n  ];\n\n  if (!(feature in USER_STORAGE_SCHEMA)) {\n    throw new Error(`user-storage - invalid feature provided: ${feature}`);\n  }\n\n  const validFeature = USER_STORAGE_SCHEMA[feature] as readonly string[];\n\n  if (!validFeature.includes(key)) {\n    const validKeys = USER_STORAGE_SCHEMA[feature].join(', ');\n\n    throw new Error(\n      `user-storage - invalid key provided for this feature: ${key}. Valid keys: ${validKeys}`,\n    );\n  }\n\n  return { feature, key };\n};\n\n/**\n * Constructs a unique entry path for a user.\n * This can be done due to the uniqueness of the storage key (no users will share the same storage key).\n * The users entry is a unique hash that cannot be reversed.\n *\n * @param path - string in the form of `${feature}.${key}` that matches schema\n * @param storageKey - users storage key\n * @returns path to store entry\n */\nexport function createEntryPath(\n  path: UserStoragePath,\n  storageKey: string,\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `/${feature}/${hashedKey}`;\n}\n"]}

package/dist/{chunk-JFVONPMM.mjs → chunk-VYZPOR47.mjs}

@@ -8,6 +8,12 @@ import {
   getNonce,
   pairIdentifiers
 } from "./chunk-WB6MUIML.mjs";
+import {
+  getMetaMaskProviderEIP6963
+} from "./chunk-5XSXZTED.mjs";
+import {
+  connectSnap
+} from "./chunk-5EBUFNAN.mjs";
 import {
   PairError,
   UnsupportedAuthTypeError
@@ -42,6 +48,14 @@ var JwtBearerAuth = class {
   async getAccessToken() {
     return await __privateGet(this, _sdk).getAccessToken();
   }
+  async connectSnap() {
+    const provider = await getMetaMaskProviderEIP6963();
+    if (!provider) {
+      throw new Error("failed to get MetaMaskProviderEIP6963 provider");
+    }
+    const res = await connectSnap(provider);
+    return res;
+  }
   async getUserProfile() {
     return await __privateGet(this, _sdk).getUserProfile();
   }
@@ -103,4 +117,4 @@ assertSIWE_fn = function(type, sdk) {
 export {
   JwtBearerAuth
 };
-//# sourceMappingURL=chunk-JFVONPMM.mjs.map
+//# sourceMappingURL=chunk-VYZPOR47.mjs.map

package/dist/chunk-VYZPOR47.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/sdk/authentication.ts"],"sourcesContent":["import { SIWEJwtBearerAuth } from './authentication-jwt-bearer/flow-siwe';\nimport { SRPJwtBearerAuth } from './authentication-jwt-bearer/flow-srp';\nimport {\n  getNonce,\n  pairIdentifiers,\n} from './authentication-jwt-bearer/services';\nimport type { UserProfile, Pair } from './authentication-jwt-bearer/types';\nimport { AuthType } from './authentication-jwt-bearer/types';\nimport type { Env } from './env';\nimport { PairError, UnsupportedAuthTypeError } from './errors';\nimport { getMetaMaskProviderEIP6963 } from './utils/eip-6963-metamask-provider';\nimport { connectSnap } from './utils/messaging-signing-snap-requests';\n\n// Computing the Classes, so we only get back the public methods for the interface.\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\ntype Compute<T> = T extends infer U ? { [K in keyof U]: U[K] } : never;\ntype SIWEInterface = Compute<SIWEJwtBearerAuth>;\ntype SRPInterface = Compute<SRPJwtBearerAuth>;\n\ntype SiweParams = ConstructorParameters<typeof SIWEJwtBearerAuth>;\ntype SRPParams = ConstructorParameters<typeof SRPJwtBearerAuth>;\ntype JwtBearerAuthParams = SiweParams | SRPParams;\n\nexport class JwtBearerAuth implements SIWEInterface, SRPInterface {\n  #type: AuthType;\n\n  #env: Env;\n\n  #sdk: SIWEJwtBearerAuth | SRPJwtBearerAuth;\n\n  constructor(...args: JwtBearerAuthParams) {\n    this.#type = args[0].type;\n    this.#env = args[0].env;\n\n    if (args[0].type === AuthType.SRP) {\n      this.#sdk = new SRPJwtBearerAuth(args[0], args[1]);\n      return;\n    }\n\n    if (args[0].type === AuthType.SiWE) {\n      this.#sdk = new SIWEJwtBearerAuth(args[0], args[1]);\n      return;\n    }\n\n    throw new UnsupportedAuthTypeError('unsupported auth type');\n  }\n\n  async getAccessToken(): Promise<string> {\n    return await this.#sdk.getAccessToken();\n  }\n\n  async connectSnap(): Promise<string> {\n    const provider = await getMetaMaskProviderEIP6963();\n    if (!provider) {\n      throw new Error('failed to get MetaMaskProviderEIP6963 provider');\n    }\n    const res = await connectSnap(provider);\n    return res;\n  }\n\n  async getUserProfile(): Promise<UserProfile> {\n    return await this.#sdk.getUserProfile();\n  }\n\n  async getIdentifier(): Promise<string> {\n    return await this.#sdk.getIdentifier();\n  }\n\n  async signMessage(message: string): Promise<string> {\n    return await this.#sdk.signMessage(message);\n  }\n\n  async pairIdentifiers(pairing: Pair[]): Promise<void> {\n    const profile = await this.getUserProfile();\n    const n = await getNonce(profile.profileId, this.#env);\n\n    const logins = await Promise.all(\n      pairing.map(async (p) => {\n        try {\n          const raw = `metamask:${n.nonce}:${p.identifier}`;\n          const sig = await p.signMessage(raw);\n          return {\n            signature: sig,\n            // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n            // eslint-disable-next-line @typescript-eslint/naming-convention\n            raw_message: raw,\n            // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n            // eslint-disable-next-line @typescript-eslint/naming-convention\n            encrypted_storage_key: p.encryptedStorageKey,\n            // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n            // eslint-disable-next-line @typescript-eslint/naming-convention\n            identifier_type: p.identifierType,\n          };\n        } catch (e) {\n          /* istanbul ignore next */\n          const errorMessage =\n            e instanceof Error ? e.message : JSON.stringify(e ?? '');\n          throw new PairError(\n            `failed to sign pairing message: ${errorMessage}`,\n          );\n        }\n      }),\n    );\n\n    const accessToken = await this.getAccessToken();\n    await pairIdentifiers(n.nonce, logins, accessToken, this.#env);\n  }\n\n  prepare(signer: {\n    address: string;\n    chainId: number;\n    signMessage: (message: string) => Promise<string>;\n    domain: string;\n  }): void {\n    this.#assertSIWE(this.#type, this.#sdk);\n    this.#sdk.prepare(signer);\n  }\n\n  #assertSIWE(\n    type: AuthType,\n    sdk: SIWEJwtBearerAuth | SRPJwtBearerAuth,\n  ): asserts sdk is SIWEJwtBearerAuth {\n    if (type === AuthType.SiWE) {\n      return;\n    }\n\n    throw new UnsupportedAuthTypeError(\n      'This method is only available via SIWE auth type',\n    );\n  }\n}\n\nexport { SIWEJwtBearerAuth } from './authentication-jwt-bearer/flow-siwe';\nexport { SRPJwtBearerAuth } from './authentication-jwt-bearer/flow-srp';\nexport * from './authentication-jwt-bearer/types';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAwBO,IAAM,gBAAN,MAA2D;AAAA,EAOhE,eAAe,MAA2B;AAwF1C;AA9FA;AAEA;AAEA;AAGE,uBAAK,OAAQ,KAAK,CAAC,EAAE;AACrB,uBAAK,MAAO,KAAK,CAAC,EAAE;AAEpB,QAAI,KAAK,CAAC,EAAE,0BAAuB;AACjC,yBAAK,MAAO,IAAI,iBAAiB,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;AACjD;AAAA,IACF;AAEA,QAAI,KAAK,CAAC,EAAE,4BAAwB;AAClC,yBAAK,MAAO,IAAI,kBAAkB,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;AAClD;AAAA,IACF;AAEA,UAAM,IAAI,yBAAyB,uBAAuB;AAAA,EAC5D;AAAA,EAEA,MAAM,iBAAkC;AACtC,WAAO,MAAM,mBAAK,MAAK,eAAe;AAAA,EACxC;AAAA,EAEA,MAAM,cAA+B;AACnC,UAAM,WAAW,MAAM,2BAA2B;AAClD,QAAI,CAAC,UAAU;AACb,YAAM,IAAI,MAAM,gDAAgD;AAAA,IAClE;AACA,UAAM,MAAM,MAAM,YAAY,QAAQ;AACtC,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,iBAAuC;AAC3C,WAAO,MAAM,mBAAK,MAAK,eAAe;AAAA,EACxC;AAAA,EAEA,MAAM,gBAAiC;AACrC,WAAO,MAAM,mBAAK,MAAK,cAAc;AAAA,EACvC;AAAA,EAEA,MAAM,YAAY,SAAkC;AAClD,WAAO,MAAM,mBAAK,MAAK,YAAY,OAAO;AAAA,EAC5C;AAAA,EAEA,MAAM,gBAAgB,SAAgC;AACpD,UAAM,UAAU,MAAM,KAAK,eAAe;AAC1C,UAAM,IAAI,MAAM,SAAS,QAAQ,WAAW,mBAAK,KAAI;AAErD,UAAM,SAAS,MAAM,QAAQ;AAAA,MAC3B,QAAQ,IAAI,OAAO,MAAM;AACvB,YAAI;AACF,gBAAM,MAAM,YAAY,EAAE,KAAK,IAAI,EAAE,UAAU;AAC/C,gBAAM,MAAM,MAAM,EAAE,YAAY,GAAG;AACnC,iBAAO;AAAA,YACL,WAAW;AAAA;AAAA;AAAA,YAGX,aAAa;AAAA;AAAA;AAAA,YAGb,uBAAuB,EAAE;AAAA;AAAA;AAAA,YAGzB,iBAAiB,EAAE;AAAA,UACrB;AAAA,QACF,SAAS,GAAG;AAEV,gBAAM,eACJ,aAAa,QAAQ,EAAE,UAAU,KAAK,UAAU,KAAK,EAAE;AACzD,gBAAM,IAAI;AAAA,YACR,mCAAmC,YAAY;AAAA,UACjD;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,cAAc,MAAM,KAAK,eAAe;AAC9C,UAAM,gBAAgB,EAAE,OAAO,QAAQ,aAAa,mBAAK,KAAI;AAAA,EAC/D;AAAA,EAEA,QAAQ,QAKC;AACP,0BAAK,4BAAL,WAAiB,mBAAK,QAAO,mBAAK;AAClC,uBAAK,MAAK,QAAQ,MAAM;AAAA,EAC1B;AAcF;AA1GE;AAEA;AAEA;AA0FA;AAAA,gBAAW,SACT,MACA,KACkC;AAClC,MAAI,4BAAwB;AAC1B;AAAA,EACF;AAEA,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;","names":[]}