@metamask-previews/profile-sync-controller 15.0.0-preview-e9f8bc88 → 15.0.0-preview-2723071f

package/dist/controllers/user-storage/contact-syncing/types.d.mts

@@ -0,0 +1,35 @@
+import type { Hex } from "@metamask/utils";
+import type { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.mjs";
+import type { UserStorageControllerMessenger } from "../UserStorageController.mjs";
+import type UserStorageController from "../UserStorageController.mjs";
+export type UserStorageContactEntry = {
+    /**
+     * The Version 'v' of the User Storage.
+     * NOTE - will allow us to support upgrade/downgrades in the future
+     */
+    [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;
+    /** the address 'a' of the contact */
+    a: string;
+    /** the name 'n' of the contact */
+    n: string;
+    /** the chainId 'c' of the contact */
+    c: Hex;
+    /** the memo 'm' of the contact (optional) */
+    m?: string;
+    /** the addressType 't' of the contact (optional) */
+    t?: string;
+    /** the lastUpdatedAt timestamp 'lu' of the contact */
+    lu?: number;
+    /** the deleted flag 'd' of the contact (optional) */
+    d?: boolean;
+    /** the deletedAt timestamp 'dt' of the contact (optional) */
+    dt?: number;
+};
+/**
+ * Options for contact syncing operations
+ */
+export type ContactSyncingOptions = {
+    getUserStorageControllerInstance: () => UserStorageController;
+    getMessenger: () => UserStorageControllerMessenger;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/controllers/user-storage/contact-syncing/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACrB,wBAAoB;AACrB,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAiC;AAC/E,OAAO,KAAK,qBAAqB,qCAAiC;AAElE,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;OAGG;IACH,CAAC,wBAAwB,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACxD,qCAAqC;IACrC,CAAC,EAAE,MAAM,CAAC;IACV,kCAAkC;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,qCAAqC;IACrC,CAAC,EAAE,GAAG,CAAC;IACP,6CAA6C;IAC7C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,oDAAoD;IACpD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,sDAAsD;IACtD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qDAAqD;IACrD,CAAC,CAAC,EAAE,OAAO,CAAC;IACZ,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,gCAAgC,EAAE,MAAM,qBAAqB,CAAC;IAC9D,YAAY,EAAE,MAAM,8BAA8B,CAAC;CACpD,CAAC"}

package/dist/controllers/user-storage/contact-syncing/types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.mjs.map

package/dist/controllers/user-storage/contact-syncing/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Hex } from '@metamask/utils';\n\nimport type {\n  USER_STORAGE_VERSION_KEY,\n  USER_STORAGE_VERSION,\n} from './constants';\nimport type { UserStorageControllerMessenger } from '../UserStorageController';\nimport type UserStorageController from '../UserStorageController';\n\nexport type UserStorageContactEntry = {\n  /**\n   * The Version 'v' of the User Storage.\n   * NOTE - will allow us to support upgrade/downgrades in the future\n   */\n  [USER_STORAGE_VERSION_KEY]: typeof USER_STORAGE_VERSION;\n  /** the address 'a' of the contact */\n  a: string;\n  /** the name 'n' of the contact */\n  n: string;\n  /** the chainId 'c' of the contact */\n  c: Hex;\n  /** the memo 'm' of the contact (optional) */\n  m?: string;\n  /** the addressType 't' of the contact (optional) */\n  t?: string;\n  /** the lastUpdatedAt timestamp 'lu' of the contact */\n  lu?: number;\n  /** the deleted flag 'd' of the contact (optional) */\n  d?: boolean;\n  /** the deletedAt timestamp 'dt' of the contact (optional) */\n  dt?: number;\n};\n\n/**\n * Options for contact syncing operations\n */\nexport type ContactSyncingOptions = {\n  getUserStorageControllerInstance: () => UserStorageController;\n  getMessenger: () => UserStorageControllerMessenger;\n};\n"]}

package/dist/controllers/user-storage/contact-syncing/utils.cjs

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapUserStorageEntryToAddressBookEntry = exports.mapAddressBookEntryToUserStorageEntry = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const constants_1 = require("./constants.cjs");
+/**
+ * Map an address book entry to a user storage address book entry
+ * Always sets a current timestamp for entries going to remote storage
+ *
+ * @param addressBookEntry - An address book entry
+ * @returns A user storage address book entry
+ */
+const mapAddressBookEntryToUserStorageEntry = (addressBookEntry) => {
+    const { address, name, chainId, memo, addressType } = addressBookEntry;
+    // Get sync metadata from the input or use current timestamp if not present
+    const syncAddressBookEntry = addressBookEntry;
+    const now = Date.now();
+    return {
+        [constants_1.USER_STORAGE_VERSION_KEY]: constants_1.USER_STORAGE_VERSION,
+        a: (0, controller_utils_1.toChecksumHexAddress)(address),
+        n: name,
+        c: chainId,
+        ...(memo ? { m: memo } : {}),
+        ...(addressType ? { t: addressType } : {}),
+        lu: syncAddressBookEntry.lastUpdatedAt || now,
+        ...(syncAddressBookEntry.deleted
+            ? { d: syncAddressBookEntry.deleted }
+            : {}),
+        ...(syncAddressBookEntry.deletedAt
+            ? { dt: syncAddressBookEntry.deletedAt }
+            : {}),
+    };
+};
+exports.mapAddressBookEntryToUserStorageEntry = mapAddressBookEntryToUserStorageEntry;
+/**
+ * Map a user storage address book entry to an address book entry
+ * Preserves sync metadata from remote storage while keeping the
+ * entry compatible with AddressBookController
+ *
+ * @param userStorageEntry - A user storage address book entry
+ * @returns An address book entry with sync metadata for internal use
+ */
+const mapUserStorageEntryToAddressBookEntry = (userStorageEntry) => {
+    // Create a standard AddressBookEntry
+    const addressBookEntry = {
+        address: (0, controller_utils_1.toChecksumHexAddress)(userStorageEntry.a),
+        name: userStorageEntry.n,
+        chainId: userStorageEntry.c,
+        memo: userStorageEntry.m || '',
+        isEns: false,
+        ...(userStorageEntry.t
+            ? { addressType: userStorageEntry.t }
+            : {}),
+    };
+    // Include remote metadata for sync operation only (not stored in AddressBookController)
+    if (userStorageEntry.d) {
+        addressBookEntry.deleted = userStorageEntry.d;
+    }
+    if (userStorageEntry.dt) {
+        addressBookEntry.deletedAt = userStorageEntry.dt;
+    }
+    if (userStorageEntry.lu) {
+        addressBookEntry.lastUpdatedAt = userStorageEntry.lu;
+    }
+    return addressBookEntry;
+};
+exports.mapUserStorageEntryToAddressBookEntry = mapUserStorageEntryToAddressBookEntry;
+//# sourceMappingURL=utils.cjs.map

package/dist/controllers/user-storage/contact-syncing/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/utils.ts"],"names":[],"mappings":";;;AAIA,iEAAkE;AAElE,+CAA6E;AAa7E;;;;;;GAMG;AACI,MAAM,qCAAqC,GAAG,CACnD,gBAAkC,EACT,EAAE;IAC3B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;IAEvE,2EAA2E;IAC3E,MAAM,oBAAoB,GAAG,gBAAwC,CAAC;IACtE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,OAAO;QACL,CAAC,oCAAwB,CAAC,EAAE,gCAAoB;QAChD,CAAC,EAAE,IAAA,uCAAoB,EAAC,OAAO,CAAC;QAChC,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,OAAO;QACV,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,EAAE,EAAE,oBAAoB,CAAC,aAAa,IAAI,GAAG;QAC7C,GAAG,CAAC,oBAAoB,CAAC,OAAO;YAC9B,CAAC,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,OAAO,EAAE;YACrC,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,oBAAoB,CAAC,SAAS;YAChC,CAAC,CAAC,EAAE,EAAE,EAAE,oBAAoB,CAAC,SAAS,EAAE;YACxC,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC,CAAC;AAxBW,QAAA,qCAAqC,yCAwBhD;AAEF;;;;;;;GAOG;AACI,MAAM,qCAAqC,GAAG,CACnD,gBAAyC,EACnB,EAAE;IACxB,qCAAqC;IACrC,MAAM,gBAAgB,GAAyB;QAC7C,OAAO,EAAE,IAAA,uCAAoB,EAAC,gBAAgB,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACxB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC3B,IAAI,EAAE,gBAAgB,CAAC,CAAC,IAAI,EAAE;QAC9B,KAAK,EAAE,KAAK;QACZ,GAAG,CAAC,gBAAgB,CAAC,CAAC;YACpB,CAAC,CAAC,EAAE,WAAW,EAAE,gBAAgB,CAAC,CAAgB,EAAE;YACpD,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;IAEF,wFAAwF;IACxF,IAAI,gBAAgB,CAAC,CAAC,EAAE;QACtB,gBAAgB,CAAC,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC;KAC/C;IAED,IAAI,gBAAgB,CAAC,EAAE,EAAE;QACvB,gBAAgB,CAAC,SAAS,GAAG,gBAAgB,CAAC,EAAE,CAAC;KAClD;IAED,IAAI,gBAAgB,CAAC,EAAE,EAAE;QACvB,gBAAgB,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAC;KACtD;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AA7BW,QAAA,qCAAqC,yCA6BhD","sourcesContent":["import type {\n  AddressBookEntry,\n  AddressType,\n} from '@metamask/address-book-controller';\nimport { toChecksumHexAddress } from '@metamask/controller-utils';\n\nimport { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from './constants';\nimport type { UserStorageContactEntry } from './types';\n\n/**\n * Extends AddressBookEntry with sync metadata\n * This is only used internally during the sync process and is not stored in AddressBookController\n */\nexport type SyncAddressBookEntry = AddressBookEntry & {\n  lastUpdatedAt?: number;\n  deleted?: boolean;\n  deletedAt?: number;\n};\n\n/**\n * Map an address book entry to a user storage address book entry\n * Always sets a current timestamp for entries going to remote storage\n *\n * @param addressBookEntry - An address book entry\n * @returns A user storage address book entry\n */\nexport const mapAddressBookEntryToUserStorageEntry = (\n  addressBookEntry: AddressBookEntry,\n): UserStorageContactEntry => {\n  const { address, name, chainId, memo, addressType } = addressBookEntry;\n\n  // Get sync metadata from the input or use current timestamp if not present\n  const syncAddressBookEntry = addressBookEntry as SyncAddressBookEntry;\n  const now = Date.now();\n\n  return {\n    [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,\n    a: toChecksumHexAddress(address),\n    n: name,\n    c: chainId,\n    ...(memo ? { m: memo } : {}),\n    ...(addressType ? { t: addressType } : {}),\n    lu: syncAddressBookEntry.lastUpdatedAt || now,\n    ...(syncAddressBookEntry.deleted\n      ? { d: syncAddressBookEntry.deleted }\n      : {}),\n    ...(syncAddressBookEntry.deletedAt\n      ? { dt: syncAddressBookEntry.deletedAt }\n      : {}),\n  };\n};\n\n/**\n * Map a user storage address book entry to an address book entry\n * Preserves sync metadata from remote storage while keeping the\n * entry compatible with AddressBookController\n *\n * @param userStorageEntry - A user storage address book entry\n * @returns An address book entry with sync metadata for internal use\n */\nexport const mapUserStorageEntryToAddressBookEntry = (\n  userStorageEntry: UserStorageContactEntry,\n): SyncAddressBookEntry => {\n  // Create a standard AddressBookEntry\n  const addressBookEntry: SyncAddressBookEntry = {\n    address: toChecksumHexAddress(userStorageEntry.a),\n    name: userStorageEntry.n,\n    chainId: userStorageEntry.c,\n    memo: userStorageEntry.m || '',\n    isEns: false, // This will be updated by the AddressBookController\n    ...(userStorageEntry.t\n      ? { addressType: userStorageEntry.t as AddressType }\n      : {}),\n  };\n\n  // Include remote metadata for sync operation only (not stored in AddressBookController)\n  if (userStorageEntry.d) {\n    addressBookEntry.deleted = userStorageEntry.d;\n  }\n\n  if (userStorageEntry.dt) {\n    addressBookEntry.deletedAt = userStorageEntry.dt;\n  }\n\n  if (userStorageEntry.lu) {\n    addressBookEntry.lastUpdatedAt = userStorageEntry.lu;\n  }\n\n  return addressBookEntry;\n};\n"]}

package/dist/controllers/user-storage/contact-syncing/utils.d.cts

@@ -0,0 +1,29 @@
+import type { AddressBookEntry } from "@metamask/address-book-controller";
+import type { UserStorageContactEntry } from "./types.cjs";
+/**
+ * Extends AddressBookEntry with sync metadata
+ * This is only used internally during the sync process and is not stored in AddressBookController
+ */
+export type SyncAddressBookEntry = AddressBookEntry & {
+    lastUpdatedAt?: number;
+    deleted?: boolean;
+    deletedAt?: number;
+};
+/**
+ * Map an address book entry to a user storage address book entry
+ * Always sets a current timestamp for entries going to remote storage
+ *
+ * @param addressBookEntry - An address book entry
+ * @returns A user storage address book entry
+ */
+export declare const mapAddressBookEntryToUserStorageEntry: (addressBookEntry: AddressBookEntry) => UserStorageContactEntry;
+/**
+ * Map a user storage address book entry to an address book entry
+ * Preserves sync metadata from remote storage while keeping the
+ * entry compatible with AddressBookController
+ *
+ * @param userStorageEntry - A user storage address book entry
+ * @returns An address book entry with sync metadata for internal use
+ */
+export declare const mapUserStorageEntryToAddressBookEntry: (userStorageEntry: UserStorageContactEntry) => SyncAddressBookEntry;
+//# sourceMappingURL=utils.d.cts.map

package/dist/controllers/user-storage/contact-syncing/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAEjB,0CAA0C;AAI3C,OAAO,KAAK,EAAE,uBAAuB,EAAE,oBAAgB;AAEvD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC,qBAC9B,gBAAgB,KACjC,uBAsBF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qCAAqC,qBAC9B,uBAAuB,KACxC,oBA2BF,CAAC"}

package/dist/controllers/user-storage/contact-syncing/utils.d.mts

@@ -0,0 +1,29 @@
+import type { AddressBookEntry } from "@metamask/address-book-controller";
+import type { UserStorageContactEntry } from "./types.mjs";
+/**
+ * Extends AddressBookEntry with sync metadata
+ * This is only used internally during the sync process and is not stored in AddressBookController
+ */
+export type SyncAddressBookEntry = AddressBookEntry & {
+    lastUpdatedAt?: number;
+    deleted?: boolean;
+    deletedAt?: number;
+};
+/**
+ * Map an address book entry to a user storage address book entry
+ * Always sets a current timestamp for entries going to remote storage
+ *
+ * @param addressBookEntry - An address book entry
+ * @returns A user storage address book entry
+ */
+export declare const mapAddressBookEntryToUserStorageEntry: (addressBookEntry: AddressBookEntry) => UserStorageContactEntry;
+/**
+ * Map a user storage address book entry to an address book entry
+ * Preserves sync metadata from remote storage while keeping the
+ * entry compatible with AddressBookController
+ *
+ * @param userStorageEntry - A user storage address book entry
+ * @returns An address book entry with sync metadata for internal use
+ */
+export declare const mapUserStorageEntryToAddressBookEntry: (userStorageEntry: UserStorageContactEntry) => SyncAddressBookEntry;
+//# sourceMappingURL=utils.d.mts.map

package/dist/controllers/user-storage/contact-syncing/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAEjB,0CAA0C;AAI3C,OAAO,KAAK,EAAE,uBAAuB,EAAE,oBAAgB;AAEvD;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG;IACpD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC,qBAC9B,gBAAgB,KACjC,uBAsBF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qCAAqC,qBAC9B,uBAAuB,KACxC,oBA2BF,CAAC"}

package/dist/controllers/user-storage/contact-syncing/utils.mjs

@@ -0,0 +1,63 @@
+import { toChecksumHexAddress } from "@metamask/controller-utils";
+import { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.mjs";
+/**
+ * Map an address book entry to a user storage address book entry
+ * Always sets a current timestamp for entries going to remote storage
+ *
+ * @param addressBookEntry - An address book entry
+ * @returns A user storage address book entry
+ */
+export const mapAddressBookEntryToUserStorageEntry = (addressBookEntry) => {
+    const { address, name, chainId, memo, addressType } = addressBookEntry;
+    // Get sync metadata from the input or use current timestamp if not present
+    const syncAddressBookEntry = addressBookEntry;
+    const now = Date.now();
+    return {
+        [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,
+        a: toChecksumHexAddress(address),
+        n: name,
+        c: chainId,
+        ...(memo ? { m: memo } : {}),
+        ...(addressType ? { t: addressType } : {}),
+        lu: syncAddressBookEntry.lastUpdatedAt || now,
+        ...(syncAddressBookEntry.deleted
+            ? { d: syncAddressBookEntry.deleted }
+            : {}),
+        ...(syncAddressBookEntry.deletedAt
+            ? { dt: syncAddressBookEntry.deletedAt }
+            : {}),
+    };
+};
+/**
+ * Map a user storage address book entry to an address book entry
+ * Preserves sync metadata from remote storage while keeping the
+ * entry compatible with AddressBookController
+ *
+ * @param userStorageEntry - A user storage address book entry
+ * @returns An address book entry with sync metadata for internal use
+ */
+export const mapUserStorageEntryToAddressBookEntry = (userStorageEntry) => {
+    // Create a standard AddressBookEntry
+    const addressBookEntry = {
+        address: toChecksumHexAddress(userStorageEntry.a),
+        name: userStorageEntry.n,
+        chainId: userStorageEntry.c,
+        memo: userStorageEntry.m || '',
+        isEns: false,
+        ...(userStorageEntry.t
+            ? { addressType: userStorageEntry.t }
+            : {}),
+    };
+    // Include remote metadata for sync operation only (not stored in AddressBookController)
+    if (userStorageEntry.d) {
+        addressBookEntry.deleted = userStorageEntry.d;
+    }
+    if (userStorageEntry.dt) {
+        addressBookEntry.deletedAt = userStorageEntry.dt;
+    }
+    if (userStorageEntry.lu) {
+        addressBookEntry.lastUpdatedAt = userStorageEntry.lu;
+    }
+    return addressBookEntry;
+};
+//# sourceMappingURL=utils.mjs.map

package/dist/controllers/user-storage/contact-syncing/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/utils.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,mCAAmC;AAElE,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,wBAAoB;AAa7E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,CACnD,gBAAkC,EACT,EAAE;IAC3B,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,gBAAgB,CAAC;IAEvE,2EAA2E;IAC3E,MAAM,oBAAoB,GAAG,gBAAwC,CAAC;IACtE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,OAAO;QACL,CAAC,wBAAwB,CAAC,EAAE,oBAAoB;QAChD,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC;QAChC,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,OAAO;QACV,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,EAAE,EAAE,oBAAoB,CAAC,aAAa,IAAI,GAAG;QAC7C,GAAG,CAAC,oBAAoB,CAAC,OAAO;YAC9B,CAAC,CAAC,EAAE,CAAC,EAAE,oBAAoB,CAAC,OAAO,EAAE;YACrC,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,oBAAoB,CAAC,SAAS;YAChC,CAAC,CAAC,EAAE,EAAE,EAAE,oBAAoB,CAAC,SAAS,EAAE;YACxC,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAG,CACnD,gBAAyC,EACnB,EAAE;IACxB,qCAAqC;IACrC,MAAM,gBAAgB,GAAyB;QAC7C,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACxB,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC3B,IAAI,EAAE,gBAAgB,CAAC,CAAC,IAAI,EAAE;QAC9B,KAAK,EAAE,KAAK;QACZ,GAAG,CAAC,gBAAgB,CAAC,CAAC;YACpB,CAAC,CAAC,EAAE,WAAW,EAAE,gBAAgB,CAAC,CAAgB,EAAE;YACpD,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;IAEF,wFAAwF;IACxF,IAAI,gBAAgB,CAAC,CAAC,EAAE;QACtB,gBAAgB,CAAC,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC;KAC/C;IAED,IAAI,gBAAgB,CAAC,EAAE,EAAE;QACvB,gBAAgB,CAAC,SAAS,GAAG,gBAAgB,CAAC,EAAE,CAAC;KAClD;IAED,IAAI,gBAAgB,CAAC,EAAE,EAAE;QACvB,gBAAgB,CAAC,aAAa,GAAG,gBAAgB,CAAC,EAAE,CAAC;KACtD;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC","sourcesContent":["import type {\n  AddressBookEntry,\n  AddressType,\n} from '@metamask/address-book-controller';\nimport { toChecksumHexAddress } from '@metamask/controller-utils';\n\nimport { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from './constants';\nimport type { UserStorageContactEntry } from './types';\n\n/**\n * Extends AddressBookEntry with sync metadata\n * This is only used internally during the sync process and is not stored in AddressBookController\n */\nexport type SyncAddressBookEntry = AddressBookEntry & {\n  lastUpdatedAt?: number;\n  deleted?: boolean;\n  deletedAt?: number;\n};\n\n/**\n * Map an address book entry to a user storage address book entry\n * Always sets a current timestamp for entries going to remote storage\n *\n * @param addressBookEntry - An address book entry\n * @returns A user storage address book entry\n */\nexport const mapAddressBookEntryToUserStorageEntry = (\n  addressBookEntry: AddressBookEntry,\n): UserStorageContactEntry => {\n  const { address, name, chainId, memo, addressType } = addressBookEntry;\n\n  // Get sync metadata from the input or use current timestamp if not present\n  const syncAddressBookEntry = addressBookEntry as SyncAddressBookEntry;\n  const now = Date.now();\n\n  return {\n    [USER_STORAGE_VERSION_KEY]: USER_STORAGE_VERSION,\n    a: toChecksumHexAddress(address),\n    n: name,\n    c: chainId,\n    ...(memo ? { m: memo } : {}),\n    ...(addressType ? { t: addressType } : {}),\n    lu: syncAddressBookEntry.lastUpdatedAt || now,\n    ...(syncAddressBookEntry.deleted\n      ? { d: syncAddressBookEntry.deleted }\n      : {}),\n    ...(syncAddressBookEntry.deletedAt\n      ? { dt: syncAddressBookEntry.deletedAt }\n      : {}),\n  };\n};\n\n/**\n * Map a user storage address book entry to an address book entry\n * Preserves sync metadata from remote storage while keeping the\n * entry compatible with AddressBookController\n *\n * @param userStorageEntry - A user storage address book entry\n * @returns An address book entry with sync metadata for internal use\n */\nexport const mapUserStorageEntryToAddressBookEntry = (\n  userStorageEntry: UserStorageContactEntry,\n): SyncAddressBookEntry => {\n  // Create a standard AddressBookEntry\n  const addressBookEntry: SyncAddressBookEntry = {\n    address: toChecksumHexAddress(userStorageEntry.a),\n    name: userStorageEntry.n,\n    chainId: userStorageEntry.c,\n    memo: userStorageEntry.m || '',\n    isEns: false, // This will be updated by the AddressBookController\n    ...(userStorageEntry.t\n      ? { addressType: userStorageEntry.t as AddressType }\n      : {}),\n  };\n\n  // Include remote metadata for sync operation only (not stored in AddressBookController)\n  if (userStorageEntry.d) {\n    addressBookEntry.deleted = userStorageEntry.d;\n  }\n\n  if (userStorageEntry.dt) {\n    addressBookEntry.deletedAt = userStorageEntry.dt;\n  }\n\n  if (userStorageEntry.lu) {\n    addressBookEntry.lastUpdatedAt = userStorageEntry.lu;\n  }\n\n  return addressBookEntry;\n};\n"]}

package/dist/shared/storage-schema.cjs

@@ -14,11 +14,13 @@ exports.USER_STORAGE_FEATURE_NAMES = {
     notifications: 'notifications',
     accounts: 'accounts_v2',
     networks: 'networks',
+    addressBook: 'addressBook',
 };
 exports.USER_STORAGE_SCHEMA = {
     [exports.USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],
     [exports.USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS],
-    [exports.USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks
+    [exports.USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS],
+    [exports.USER_STORAGE_FEATURE_NAMES.addressBook]: [ALLOW_ARBITRARY_KEYS], // keyed by address_chainId
 };
 const getFeatureAndKeyFromPath = (path, options = { validateAgainstSchema: true }) => {
     const pathRegex = /^\w+\.\w+$/u;

package/dist/shared/storage-schema.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"storage-schema.cjs","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":";;;AAAA,uDAAgD;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAEhD,QAAA,0BAA0B,GAAG;IACxC,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAKE,QAAA,mBAAmB,GAAG;IACjC,CAAC,kCAA0B,CAAC,aAAa,CAAC,EAAE,CAAC,uBAAuB,CAAC;IACrE,CAAC,kCAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,kCAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CAClF,CAAC;AAuCJ,MAAM,wBAAwB,GAAG,CACtC,IAE2C,EAC3C,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE,EAGN,EAAE;IACpC,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;KACH;IAED,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,qBAAqB,EAAE;QACjC,MAAM,iBAAiB,GAAG,OAAkC,CAAC;QAC7D,MAAM,aAAa,GAAG,GAErB,CAAC;QAEF,IAAI,CAAC,CAAC,iBAAiB,IAAI,2BAAmB,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CACb,4CAA4C,iBAAiB,qBAAqB,MAAM,CAAC,IAAI,CAC3F,2BAAmB,CACpB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;SACH;QAED,MAAM,YAAY,GAAG,2BAAmB,CACtC,iBAAiB,CACG,CAAC;QAEvB,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;YACrC,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;YACA,MAAM,SAAS,GAAG,2BAAmB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEpE,MAAM,IAAI,KAAK,CACb,yDAAyD,aAAa,iBAAiB,SAAS,EAAE,CACnG,CAAC;SACH;KACF;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAEc,CAAC;AACtC,CAAC,CAAC;AArDW,QAAA,wBAAwB,4BAqDnC;AAEK,MAAM,uBAAuB,GAAG,CACrC,IAAY,EAC8B,EAAE;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AANW,QAAA,uBAAuB,2BAMlC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAC7B,IAE2C,EAC3C,UAAkB,EAClB,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE;IAExC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAA,gCAAwB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,IAAA,6BAAgB,EAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC;AAbD,0CAaC","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 * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.\n * This can be useful for features where keys are not deterministic (eg. accounts addresses).\n */\nconst ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS' as const;\n\nexport const USER_STORAGE_FEATURE_NAMES = {\n  notifications: 'notifications',\n  accounts: 'accounts_v2',\n  networks: 'networks',\n} as const;\n\nexport type UserStorageFeatureNames =\n  (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];\n\nexport const USER_STORAGE_SCHEMA = {\n  [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],\n  [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\nexport type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatureNames;\n  key: UserStorageFeatureKeys<UserStorageFeatureNames>;\n};\n\nexport type UserStoragePathWithFeatureOnly = UserStorageFeatureNames;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatureNames]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\n/**\n * The below types are mainly used for the SDK.\n * These exist so that the SDK can be used with arbitrary feature names and keys.\n *\n * We only type enforce feature names and keys when using UserStorageController.\n * This is done so we don't end up with magic strings within the applications.\n */\n\nexport type UserStorageGenericFeatureName = string;\nexport type UserStorageGenericFeatureKey = string;\nexport type UserStorageGenericPathWithFeatureAndKey =\n  `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;\nexport type UserStorageGenericPathWithFeatureOnly =\n  UserStorageGenericFeatureName;\n\ntype UserStorageGenericFeatureAndKey = {\n  feature: UserStorageGenericFeatureName;\n  key: UserStorageGenericFeatureKey;\n};\n\nexport const getFeatureAndKeyFromPath = <T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): T extends true\n  ? UserStorageFeatureAndKey\n  : UserStorageGenericFeatureAndKey => {\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('.');\n\n  if (options.validateAgainstSchema) {\n    const featureToValidate = feature as UserStorageFeatureNames;\n    const keyToValidate = key as UserStorageFeatureKeys<\n      typeof featureToValidate\n    >;\n\n    if (!(featureToValidate in USER_STORAGE_SCHEMA)) {\n      throw new Error(\n        `user-storage - invalid feature provided: ${featureToValidate}. Valid features: ${Object.keys(\n          USER_STORAGE_SCHEMA,\n        ).join(', ')}`,\n      );\n    }\n\n    const validFeature = USER_STORAGE_SCHEMA[\n      featureToValidate\n    ] as readonly string[];\n\n    if (\n      !validFeature.includes(keyToValidate) &&\n      !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n    ) {\n      const validKeys = USER_STORAGE_SCHEMA[featureToValidate].join(', ');\n\n      throw new Error(\n        `user-storage - invalid key provided for this feature: ${keyToValidate}. Valid keys: ${validKeys}`,\n      );\n    }\n  }\n\n  return { feature, key } as T extends true\n    ? UserStorageFeatureAndKey\n    : UserStorageGenericFeatureAndKey;\n};\n\nexport const isPathWithFeatureAndKey = (\n  path: string,\n): path is UserStoragePathWithFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  return pathRegex.test(path);\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 * @param options - options object\n * @param options.validateAgainstSchema - whether to validate the path against the schema.\n * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.\n * @returns path to store entry\n */\nexport function createEntryPath<T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  storageKey: string,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path, options);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `${feature}/${hashedKey}`;\n}\n"]}
+{"version":3,"file":"storage-schema.cjs","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":";;;AAAA,uDAAgD;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAEhD,QAAA,0BAA0B,GAAG;IACxC,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,aAAa;CAClB,CAAC;AAKE,QAAA,mBAAmB,GAAG;IACjC,CAAC,kCAA0B,CAAC,aAAa,CAAC,EAAE,CAAC,uBAAuB,CAAC;IACrE,CAAC,kCAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,kCAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,kCAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CACrF,CAAC;AAuCJ,MAAM,wBAAwB,GAAG,CACtC,IAE2C,EAC3C,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE,EAGN,EAAE;IACpC,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;KACH;IAED,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,qBAAqB,EAAE;QACjC,MAAM,iBAAiB,GAAG,OAAkC,CAAC;QAC7D,MAAM,aAAa,GAAG,GAErB,CAAC;QAEF,IAAI,CAAC,CAAC,iBAAiB,IAAI,2BAAmB,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CACb,4CAA4C,iBAAiB,qBAAqB,MAAM,CAAC,IAAI,CAC3F,2BAAmB,CACpB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;SACH;QAED,MAAM,YAAY,GAAG,2BAAmB,CACtC,iBAAiB,CACG,CAAC;QAEvB,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;YACrC,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;YACA,MAAM,SAAS,GAAG,2BAAmB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEpE,MAAM,IAAI,KAAK,CACb,yDAAyD,aAAa,iBAAiB,SAAS,EAAE,CACnG,CAAC;SACH;KACF;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAEc,CAAC;AACtC,CAAC,CAAC;AArDW,QAAA,wBAAwB,4BAqDnC;AAEK,MAAM,uBAAuB,GAAG,CACrC,IAAY,EAC8B,EAAE;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AANW,QAAA,uBAAuB,2BAMlC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAC7B,IAE2C,EAC3C,UAAkB,EAClB,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE;IAExC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAA,gCAAwB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,IAAA,6BAAgB,EAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC;AAbD,0CAaC","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 * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.\n * This can be useful for features where keys are not deterministic (eg. accounts addresses).\n */\nconst ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS' as const;\n\nexport const USER_STORAGE_FEATURE_NAMES = {\n  notifications: 'notifications',\n  accounts: 'accounts_v2',\n  networks: 'networks',\n  addressBook: 'addressBook',\n} as const;\n\nexport type UserStorageFeatureNames =\n  (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];\n\nexport const USER_STORAGE_SCHEMA = {\n  [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],\n  [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n  [USER_STORAGE_FEATURE_NAMES.addressBook]: [ALLOW_ARBITRARY_KEYS], // keyed by address_chainId\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\nexport type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatureNames;\n  key: UserStorageFeatureKeys<UserStorageFeatureNames>;\n};\n\nexport type UserStoragePathWithFeatureOnly = UserStorageFeatureNames;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatureNames]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\n/**\n * The below types are mainly used for the SDK.\n * These exist so that the SDK can be used with arbitrary feature names and keys.\n *\n * We only type enforce feature names and keys when using UserStorageController.\n * This is done so we don't end up with magic strings within the applications.\n */\n\nexport type UserStorageGenericFeatureName = string;\nexport type UserStorageGenericFeatureKey = string;\nexport type UserStorageGenericPathWithFeatureAndKey =\n  `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;\nexport type UserStorageGenericPathWithFeatureOnly =\n  UserStorageGenericFeatureName;\n\ntype UserStorageGenericFeatureAndKey = {\n  feature: UserStorageGenericFeatureName;\n  key: UserStorageGenericFeatureKey;\n};\n\nexport const getFeatureAndKeyFromPath = <T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): T extends true\n  ? UserStorageFeatureAndKey\n  : UserStorageGenericFeatureAndKey => {\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('.');\n\n  if (options.validateAgainstSchema) {\n    const featureToValidate = feature as UserStorageFeatureNames;\n    const keyToValidate = key as UserStorageFeatureKeys<\n      typeof featureToValidate\n    >;\n\n    if (!(featureToValidate in USER_STORAGE_SCHEMA)) {\n      throw new Error(\n        `user-storage - invalid feature provided: ${featureToValidate}. Valid features: ${Object.keys(\n          USER_STORAGE_SCHEMA,\n        ).join(', ')}`,\n      );\n    }\n\n    const validFeature = USER_STORAGE_SCHEMA[\n      featureToValidate\n    ] as readonly string[];\n\n    if (\n      !validFeature.includes(keyToValidate) &&\n      !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n    ) {\n      const validKeys = USER_STORAGE_SCHEMA[featureToValidate].join(', ');\n\n      throw new Error(\n        `user-storage - invalid key provided for this feature: ${keyToValidate}. Valid keys: ${validKeys}`,\n      );\n    }\n  }\n\n  return { feature, key } as T extends true\n    ? UserStorageFeatureAndKey\n    : UserStorageGenericFeatureAndKey;\n};\n\nexport const isPathWithFeatureAndKey = (\n  path: string,\n): path is UserStoragePathWithFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  return pathRegex.test(path);\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 * @param options - options object\n * @param options.validateAgainstSchema - whether to validate the path against the schema.\n * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.\n * @returns path to store entry\n */\nexport function createEntryPath<T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  storageKey: string,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path, options);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `${feature}/${hashedKey}`;\n}\n"]}

package/dist/shared/storage-schema.d.cts

@@ -10,12 +10,14 @@ export declare const USER_STORAGE_FEATURE_NAMES: {
     readonly notifications: "notifications";
     readonly accounts: "accounts_v2";
     readonly networks: "networks";
+    readonly addressBook: "addressBook";
 };
 export type UserStorageFeatureNames = (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];
 export declare const USER_STORAGE_SCHEMA: {
     readonly notifications: readonly ["notification_settings"];
     readonly accounts_v2: readonly ["ALLOW_ARBITRARY_KEYS"];
     readonly networks: readonly ["ALLOW_ARBITRARY_KEYS"];
+    readonly addressBook: readonly ["ALLOW_ARBITRARY_KEYS"];
 };
 type UserStorageSchema = typeof USER_STORAGE_SCHEMA;
 export type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> = UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS ? string : UserStorageSchema[Feature][number];

package/dist/shared/storage-schema.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-schema.d.cts","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,0BAA0B;;;;CAI7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC;AAE/E,eAAO,MAAM,mBAAmB;;;;CAItB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,uBAAuB,IACxE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,oBAAoB,GAC7D,MAAM,GACN,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzC,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,uBAAuB,CAAC;IACjC,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,uBAAuB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CACpE,CAAC,8BAA8B,CAAC,CAAC;AAElC;;;;;;GAMG;AAEH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD,MAAM,MAAM,uCAAuC,GACjD,GAAG,6BAA6B,IAAI,4BAA4B,EAAE,CAAC;AACrE,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAAC;AAEhC,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,6BAA6B,CAAC;IACvC,GAAG,EAAE,4BAA4B,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;iFAqDpC,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAC5B,MAAM,6CAKb,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,OAAO,EAC/C,IAAI,EAAE,CAAC,SAAS,IAAI,GAChB,gCAAgC,GAChC,uCAAuC,EAC3C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IACP,qBAAqB,EAAE,CAAC,CAAC;CACa,GACvC,MAAM,CAKR"}
+{"version":3,"file":"storage-schema.d.cts","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,0BAA0B;;;;;CAK7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC;AAE/E,eAAO,MAAM,mBAAmB;;;;;CAKtB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,uBAAuB,IACxE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,oBAAoB,GAC7D,MAAM,GACN,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzC,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,uBAAuB,CAAC;IACjC,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,uBAAuB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CACpE,CAAC,8BAA8B,CAAC,CAAC;AAElC;;;;;;GAMG;AAEH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD,MAAM,MAAM,uCAAuC,GACjD,GAAG,6BAA6B,IAAI,4BAA4B,EAAE,CAAC;AACrE,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAAC;AAEhC,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,6BAA6B,CAAC;IACvC,GAAG,EAAE,4BAA4B,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;iFAqDpC,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAC5B,MAAM,6CAKb,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,OAAO,EAC/C,IAAI,EAAE,CAAC,SAAS,IAAI,GAChB,gCAAgC,GAChC,uCAAuC,EAC3C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IACP,qBAAqB,EAAE,CAAC,CAAC;CACa,GACvC,MAAM,CAKR"}

package/dist/shared/storage-schema.d.mts

@@ -10,12 +10,14 @@ export declare const USER_STORAGE_FEATURE_NAMES: {
     readonly notifications: "notifications";
     readonly accounts: "accounts_v2";
     readonly networks: "networks";
+    readonly addressBook: "addressBook";
 };
 export type UserStorageFeatureNames = (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];
 export declare const USER_STORAGE_SCHEMA: {
     readonly notifications: readonly ["notification_settings"];
     readonly accounts_v2: readonly ["ALLOW_ARBITRARY_KEYS"];
     readonly networks: readonly ["ALLOW_ARBITRARY_KEYS"];
+    readonly addressBook: readonly ["ALLOW_ARBITRARY_KEYS"];
 };
 type UserStorageSchema = typeof USER_STORAGE_SCHEMA;
 export type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> = UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS ? string : UserStorageSchema[Feature][number];

package/dist/shared/storage-schema.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-schema.d.mts","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,0BAA0B;;;;CAI7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC;AAE/E,eAAO,MAAM,mBAAmB;;;;CAItB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,uBAAuB,IACxE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,oBAAoB,GAC7D,MAAM,GACN,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzC,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,uBAAuB,CAAC;IACjC,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,uBAAuB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CACpE,CAAC,8BAA8B,CAAC,CAAC;AAElC;;;;;;GAMG;AAEH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD,MAAM,MAAM,uCAAuC,GACjD,GAAG,6BAA6B,IAAI,4BAA4B,EAAE,CAAC;AACrE,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAAC;AAEhC,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,6BAA6B,CAAC;IACvC,GAAG,EAAE,4BAA4B,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;iFAqDpC,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAC5B,MAAM,6CAKb,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,OAAO,EAC/C,IAAI,EAAE,CAAC,SAAS,IAAI,GAChB,gCAAgC,GAChC,uCAAuC,EAC3C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IACP,qBAAqB,EAAE,CAAC,CAAC;CACa,GACvC,MAAM,CAKR"}
+{"version":3,"file":"storage-schema.d.mts","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,oBAAoB,wBAAkC,CAAC;AAE7D,eAAO,MAAM,0BAA0B;;;;;CAK7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,OAAO,0BAA0B,CAAC,CAAC;AAE/E,eAAO,MAAM,mBAAmB;;;;;CAKtB,CAAC;AAEX,KAAK,iBAAiB,GAAG,OAAO,mBAAmB,CAAC;AAEpD,MAAM,MAAM,sBAAsB,CAAC,OAAO,SAAS,uBAAuB,IACxE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,oBAAoB,GAC7D,MAAM,GACN,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzC,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,uBAAuB,CAAC;IACjC,GAAG,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,uBAAuB,CAAC;AACrE,MAAM,MAAM,gCAAgC,GAAG;KAC5C,CAAC,IAAI,uBAAuB,GAAG,GAAG,CAAC,IAAI,sBAAsB,CAAC,CAAC,CAAC,EAAE;CACpE,CAAC,8BAA8B,CAAC,CAAC;AAElC;;;;;;GAMG;AAEH,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACnD,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD,MAAM,MAAM,uCAAuC,GACjD,GAAG,6BAA6B,IAAI,4BAA4B,EAAE,CAAC;AACrE,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAAC;AAEhC,KAAK,+BAA+B,GAAG;IACrC,OAAO,EAAE,6BAA6B,CAAC;IACvC,GAAG,EAAE,4BAA4B,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;iFAqDpC,CAAC;AAEF,eAAO,MAAM,uBAAuB,SAC5B,MAAM,6CAKb,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,OAAO,EAC/C,IAAI,EAAE,CAAC,SAAS,IAAI,GAChB,gCAAgC,GAChC,uCAAuC,EAC3C,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE;IACP,qBAAqB,EAAE,CAAC,CAAC;CACa,GACvC,MAAM,CAKR"}

package/dist/shared/storage-schema.mjs

@@ -11,11 +11,13 @@ export const USER_STORAGE_FEATURE_NAMES = {
     notifications: 'notifications',
     accounts: 'accounts_v2',
     networks: 'networks',
+    addressBook: 'addressBook',
 };
 export const USER_STORAGE_SCHEMA = {
     [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],
     [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS],
-    [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks
+    [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS],
+    [USER_STORAGE_FEATURE_NAMES.addressBook]: [ALLOW_ARBITRARY_KEYS], // keyed by address_chainId
 };
 export const getFeatureAndKeyFromPath = (path, options = { validateAgainstSchema: true }) => {
     const pathRegex = /^\w+\.\w+$/u;

package/dist/shared/storage-schema.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"storage-schema.mjs","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,+BAAqB;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAE7D,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAKX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,CAAC,uBAAuB,CAAC;IACrE,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CAClF,CAAC;AAuCX,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAE2C,EAC3C,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE,EAGN,EAAE;IACpC,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;KACH;IAED,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,qBAAqB,EAAE;QACjC,MAAM,iBAAiB,GAAG,OAAkC,CAAC;QAC7D,MAAM,aAAa,GAAG,GAErB,CAAC;QAEF,IAAI,CAAC,CAAC,iBAAiB,IAAI,mBAAmB,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CACb,4CAA4C,iBAAiB,qBAAqB,MAAM,CAAC,IAAI,CAC3F,mBAAmB,CACpB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;SACH;QAED,MAAM,YAAY,GAAG,mBAAmB,CACtC,iBAAiB,CACG,CAAC;QAEvB,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;YACrC,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;YACA,MAAM,SAAS,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEpE,MAAM,IAAI,KAAK,CACb,yDAAyD,aAAa,iBAAiB,SAAS,EAAE,CACnG,CAAC;SACH;KACF;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAEc,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAY,EAC8B,EAAE;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,IAE2C,EAC3C,UAAkB,EAClB,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE;IAExC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC","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 * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.\n * This can be useful for features where keys are not deterministic (eg. accounts addresses).\n */\nconst ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS' as const;\n\nexport const USER_STORAGE_FEATURE_NAMES = {\n  notifications: 'notifications',\n  accounts: 'accounts_v2',\n  networks: 'networks',\n} as const;\n\nexport type UserStorageFeatureNames =\n  (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];\n\nexport const USER_STORAGE_SCHEMA = {\n  [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],\n  [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\nexport type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatureNames;\n  key: UserStorageFeatureKeys<UserStorageFeatureNames>;\n};\n\nexport type UserStoragePathWithFeatureOnly = UserStorageFeatureNames;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatureNames]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\n/**\n * The below types are mainly used for the SDK.\n * These exist so that the SDK can be used with arbitrary feature names and keys.\n *\n * We only type enforce feature names and keys when using UserStorageController.\n * This is done so we don't end up with magic strings within the applications.\n */\n\nexport type UserStorageGenericFeatureName = string;\nexport type UserStorageGenericFeatureKey = string;\nexport type UserStorageGenericPathWithFeatureAndKey =\n  `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;\nexport type UserStorageGenericPathWithFeatureOnly =\n  UserStorageGenericFeatureName;\n\ntype UserStorageGenericFeatureAndKey = {\n  feature: UserStorageGenericFeatureName;\n  key: UserStorageGenericFeatureKey;\n};\n\nexport const getFeatureAndKeyFromPath = <T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): T extends true\n  ? UserStorageFeatureAndKey\n  : UserStorageGenericFeatureAndKey => {\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('.');\n\n  if (options.validateAgainstSchema) {\n    const featureToValidate = feature as UserStorageFeatureNames;\n    const keyToValidate = key as UserStorageFeatureKeys<\n      typeof featureToValidate\n    >;\n\n    if (!(featureToValidate in USER_STORAGE_SCHEMA)) {\n      throw new Error(\n        `user-storage - invalid feature provided: ${featureToValidate}. Valid features: ${Object.keys(\n          USER_STORAGE_SCHEMA,\n        ).join(', ')}`,\n      );\n    }\n\n    const validFeature = USER_STORAGE_SCHEMA[\n      featureToValidate\n    ] as readonly string[];\n\n    if (\n      !validFeature.includes(keyToValidate) &&\n      !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n    ) {\n      const validKeys = USER_STORAGE_SCHEMA[featureToValidate].join(', ');\n\n      throw new Error(\n        `user-storage - invalid key provided for this feature: ${keyToValidate}. Valid keys: ${validKeys}`,\n      );\n    }\n  }\n\n  return { feature, key } as T extends true\n    ? UserStorageFeatureAndKey\n    : UserStorageGenericFeatureAndKey;\n};\n\nexport const isPathWithFeatureAndKey = (\n  path: string,\n): path is UserStoragePathWithFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  return pathRegex.test(path);\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 * @param options - options object\n * @param options.validateAgainstSchema - whether to validate the path against the schema.\n * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.\n * @returns path to store entry\n */\nexport function createEntryPath<T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  storageKey: string,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path, options);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `${feature}/${hashedKey}`;\n}\n"]}
+{"version":3,"file":"storage-schema.mjs","sourceRoot":"","sources":["../../src/shared/storage-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,+BAAqB;AAEhD;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAE7D,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,eAAe;IAC9B,QAAQ,EAAE,aAAa;IACvB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,aAAa;CAClB,CAAC;AAKX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,CAAC,0BAA0B,CAAC,aAAa,CAAC,EAAE,CAAC,uBAAuB,CAAC;IACrE,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,oBAAoB,CAAC;IAC7D,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,oBAAoB,CAAC,EAAE,2BAA2B;CACrF,CAAC;AAuCX,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,IAE2C,EAC3C,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE,EAGN,EAAE;IACpC,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;KACH;IAED,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvC,IAAI,OAAO,CAAC,qBAAqB,EAAE;QACjC,MAAM,iBAAiB,GAAG,OAAkC,CAAC;QAC7D,MAAM,aAAa,GAAG,GAErB,CAAC;QAEF,IAAI,CAAC,CAAC,iBAAiB,IAAI,mBAAmB,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CACb,4CAA4C,iBAAiB,qBAAqB,MAAM,CAAC,IAAI,CAC3F,mBAAmB,CACpB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;SACH;QAED,MAAM,YAAY,GAAG,mBAAmB,CACtC,iBAAiB,CACG,CAAC;QAEvB,IACE,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC;YACrC,CAAC,YAAY,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAC5C;YACA,MAAM,SAAS,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEpE,MAAM,IAAI,KAAK,CACb,yDAAyD,aAAa,iBAAiB,SAAS,EAAE,CACnG,CAAC;SACH;KACF;IAED,OAAO,EAAE,OAAO,EAAE,GAAG,EAEc,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAY,EAC8B,EAAE;IAC5C,MAAM,SAAS,GAAG,aAAa,CAAC;IAEhC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,IAE2C,EAC3C,UAAkB,EAClB,UAEI,EAAE,qBAAqB,EAAE,IAAS,EAAE;IAExC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC;IAErD,OAAO,GAAG,OAAO,IAAI,SAAS,EAAE,CAAC;AACnC,CAAC","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 * Adding ALLOW_ARBITRARY_KEYS as the first key in the array allows for any key to be used for this feature.\n * This can be useful for features where keys are not deterministic (eg. accounts addresses).\n */\nconst ALLOW_ARBITRARY_KEYS = 'ALLOW_ARBITRARY_KEYS' as const;\n\nexport const USER_STORAGE_FEATURE_NAMES = {\n  notifications: 'notifications',\n  accounts: 'accounts_v2',\n  networks: 'networks',\n  addressBook: 'addressBook',\n} as const;\n\nexport type UserStorageFeatureNames =\n  (typeof USER_STORAGE_FEATURE_NAMES)[keyof typeof USER_STORAGE_FEATURE_NAMES];\n\nexport const USER_STORAGE_SCHEMA = {\n  [USER_STORAGE_FEATURE_NAMES.notifications]: ['notification_settings'],\n  [USER_STORAGE_FEATURE_NAMES.accounts]: [ALLOW_ARBITRARY_KEYS], // keyed by account addresses\n  [USER_STORAGE_FEATURE_NAMES.networks]: [ALLOW_ARBITRARY_KEYS], // keyed by chains/networks\n  [USER_STORAGE_FEATURE_NAMES.addressBook]: [ALLOW_ARBITRARY_KEYS], // keyed by address_chainId\n} as const;\n\ntype UserStorageSchema = typeof USER_STORAGE_SCHEMA;\n\nexport type UserStorageFeatureKeys<Feature extends UserStorageFeatureNames> =\n  UserStorageSchema[Feature][0] extends typeof ALLOW_ARBITRARY_KEYS\n    ? string\n    : UserStorageSchema[Feature][number];\n\ntype UserStorageFeatureAndKey = {\n  feature: UserStorageFeatureNames;\n  key: UserStorageFeatureKeys<UserStorageFeatureNames>;\n};\n\nexport type UserStoragePathWithFeatureOnly = UserStorageFeatureNames;\nexport type UserStoragePathWithFeatureAndKey = {\n  [K in UserStorageFeatureNames]: `${K}.${UserStorageFeatureKeys<K>}`;\n}[UserStoragePathWithFeatureOnly];\n\n/**\n * The below types are mainly used for the SDK.\n * These exist so that the SDK can be used with arbitrary feature names and keys.\n *\n * We only type enforce feature names and keys when using UserStorageController.\n * This is done so we don't end up with magic strings within the applications.\n */\n\nexport type UserStorageGenericFeatureName = string;\nexport type UserStorageGenericFeatureKey = string;\nexport type UserStorageGenericPathWithFeatureAndKey =\n  `${UserStorageGenericFeatureName}.${UserStorageGenericFeatureKey}`;\nexport type UserStorageGenericPathWithFeatureOnly =\n  UserStorageGenericFeatureName;\n\ntype UserStorageGenericFeatureAndKey = {\n  feature: UserStorageGenericFeatureName;\n  key: UserStorageGenericFeatureKey;\n};\n\nexport const getFeatureAndKeyFromPath = <T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): T extends true\n  ? UserStorageFeatureAndKey\n  : UserStorageGenericFeatureAndKey => {\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('.');\n\n  if (options.validateAgainstSchema) {\n    const featureToValidate = feature as UserStorageFeatureNames;\n    const keyToValidate = key as UserStorageFeatureKeys<\n      typeof featureToValidate\n    >;\n\n    if (!(featureToValidate in USER_STORAGE_SCHEMA)) {\n      throw new Error(\n        `user-storage - invalid feature provided: ${featureToValidate}. Valid features: ${Object.keys(\n          USER_STORAGE_SCHEMA,\n        ).join(', ')}`,\n      );\n    }\n\n    const validFeature = USER_STORAGE_SCHEMA[\n      featureToValidate\n    ] as readonly string[];\n\n    if (\n      !validFeature.includes(keyToValidate) &&\n      !validFeature.includes(ALLOW_ARBITRARY_KEYS)\n    ) {\n      const validKeys = USER_STORAGE_SCHEMA[featureToValidate].join(', ');\n\n      throw new Error(\n        `user-storage - invalid key provided for this feature: ${keyToValidate}. Valid keys: ${validKeys}`,\n      );\n    }\n  }\n\n  return { feature, key } as T extends true\n    ? UserStorageFeatureAndKey\n    : UserStorageGenericFeatureAndKey;\n};\n\nexport const isPathWithFeatureAndKey = (\n  path: string,\n): path is UserStoragePathWithFeatureAndKey => {\n  const pathRegex = /^\\w+\\.\\w+$/u;\n\n  return pathRegex.test(path);\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 * @param options - options object\n * @param options.validateAgainstSchema - whether to validate the path against the schema.\n * This defaults to true, and should only be set to false when using the SDK with arbitrary feature names and keys.\n * @returns path to store entry\n */\nexport function createEntryPath<T extends boolean>(\n  path: T extends true\n    ? UserStoragePathWithFeatureAndKey\n    : UserStorageGenericPathWithFeatureAndKey,\n  storageKey: string,\n  options: {\n    validateAgainstSchema: T;\n  } = { validateAgainstSchema: true as T },\n): string {\n  const { feature, key } = getFeatureAndKeyFromPath(path, options);\n  const hashedKey = createSHA256Hash(key + storageKey);\n\n  return `${feature}/${hashedKey}`;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/profile-sync-controller",
-  "version": "15.0.0-preview-e9f8bc88",
+  "version": "15.0.0-preview-2723071f",
   "description": "The profile sync helps developers synchronize data across multiple clients and devices in a privacy-preserving way. All data saved in the user storage database is encrypted client-side to preserve privacy. The user storage provides a modular design, giving developers the flexibility to construct and manage their storage spaces in a way that best suits their needs",
   "keywords": [
     "MetaMask",
@@ -113,7 +113,7 @@
   "devDependencies": {
     "@lavamoat/allow-scripts": "^3.0.4",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
-    "@metamask/accounts-controller": "^29.0.0",
+    "@metamask/accounts-controller": "^29.0.1",
     "@metamask/auto-changelog": "^3.4.4",
     "@metamask/keyring-controller": "^22.0.0",
     "@metamask/keyring-internal-api": "^6.0.1",