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

package/dist/controllers/user-storage/contact-syncing/controller-integration.mjs

@@ -0,0 +1,293 @@
+import { canPerformContactSyncing } from "./sync-utils.mjs";
+import { mapAddressBookEntryToUserStorageEntry, mapUserStorageEntryToAddressBookEntry } from "./utils.mjs";
+import { USER_STORAGE_FEATURE_NAMES } from "../../../shared/storage-schema.mjs";
+// Define a constant to use as the key for storing all contacts
+export const ADDRESS_BOOK_CONTACTS_KEY = 'contacts';
+/**
+ * Creates a unique key for a contact based on chainId and address
+ *
+ * @param contact - The contact to create a key for
+ * @returns A unique string key
+ */
+function createContactKey(contact) {
+    return `${contact.chainId}:${contact.address.toLowerCase()}`;
+}
+/**
+ * Syncs contacts between local storage and user storage (remote).
+ *
+ * Handles the following syncing scenarios:
+ * 1. First Sync: When local contacts exist but there are no remote contacts, uploads all local contacts.
+ * 2. New Device Sync: Downloads remote contacts that don't exist locally (empty local address book).
+ * 3. Simple Merge: Ensures both sides (local & remote) have all contacts.
+ * 4. Contact Naming Conflicts: When same contact has different names, uses most recent by timestamp.
+ * 5. Local Updates: When a contact was updated locally, syncs changes to remote if local is newer.
+ * 6. Remote Updates: When a contact was updated remotely, applies changes locally if remote is newer.
+ * 7. Local Deletions: Handled by real-time event handlers (deleteContactInRemoteStorage) to prevent false positives.
+ * 8. Remote Deletions: When a contact was deleted remotely, applies deletion locally.
+ * 9. Concurrent Updates: Resolves conflicts using timestamps to determine the winner.
+ * 10. Restore After Delete: If a contact is modified after being deleted, restores it.
+ * 11. ChainId Differences: Treats same address on different chains as separate contacts.
+ *
+ * @param config - Parameters used for syncing callbacks
+ * @param options - Parameters used for syncing operations
+ */
+export async function syncContactsWithUserStorage(config, options) {
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    const { onContactSyncErroneousSituation, onContactUpdated, onContactDeleted, } = config;
+    try {
+        // Cannot perform sync, conditions not met
+        if (!canPerformContactSyncing(options)) {
+            return;
+        }
+        // Activate sync semaphore to prevent event loops
+        await getUserStorageControllerInstance().setIsContactSyncingInProgress(true);
+        // Get all local contacts from AddressBookController (exclude chain "*" contacts)
+        const localVisibleContacts = getMessenger()
+            .call('AddressBookController:list')
+            .filter((contact) => String(contact.chainId) !== '*') || [];
+        // Get remote contacts from user storage API
+        const remoteContacts = await getRemoteContacts(options);
+        // SCENARIO 1: First Sync - No remote contacts but local contacts exist
+        if (!remoteContacts || remoteContacts.length === 0) {
+            if (localVisibleContacts.length > 0) {
+                await saveContactsToUserStorage(localVisibleContacts, options);
+            }
+            return;
+        }
+        // Prepare maps for efficient lookup
+        const localContactsMap = new Map();
+        const remoteContactsMap = new Map();
+        localVisibleContacts.forEach((contact) => {
+            const key = createContactKey(contact);
+            localContactsMap.set(key, contact);
+        });
+        remoteContacts.forEach((contact) => {
+            const key = createContactKey(contact);
+            remoteContactsMap.set(key, contact);
+        });
+        // Lists to track contacts that need to be synced
+        const contactsToAddOrUpdateLocally = [];
+        const contactsToDeleteLocally = [];
+        const contactsToUpdateRemotely = [];
+        // SCENARIO 2 & 6: Process remote contacts - handle new device sync and remote updates
+        for (const remoteContact of remoteContacts) {
+            const key = createContactKey(remoteContact);
+            const localContact = localContactsMap.get(key);
+            // Handle remote contact based on its status and local existence
+            if (remoteContact.deleted) {
+                // SCENARIO 8: Remote deletion - should be applied locally if contact exists locally
+                if (localContact) {
+                    contactsToDeleteLocally.push(remoteContact);
+                    if (onContactDeleted) {
+                        onContactDeleted();
+                    }
+                }
+            }
+            else if (!localContact) {
+                // SCENARIO 2: New contact from remote - import to local
+                contactsToAddOrUpdateLocally.push(remoteContact);
+                if (onContactUpdated) {
+                    onContactUpdated();
+                }
+            }
+            else {
+                // SCENARIO 4 & 6: Contact exists on both sides - check for conflicts
+                const hasContentDifference = localContact.name !== remoteContact.name ||
+                    localContact.memo !== remoteContact.memo;
+                if (hasContentDifference) {
+                    // Check timestamps to determine which version to keep
+                    const localTimestamp = localContact.lastUpdatedAt || 0;
+                    const remoteTimestamp = remoteContact.lastUpdatedAt || 0;
+                    if (localTimestamp >= remoteTimestamp) {
+                        // Local is newer (or same age) - use local version
+                        contactsToUpdateRemotely.push(localContact);
+                    }
+                    else {
+                        // Remote is newer - use remote version
+                        contactsToAddOrUpdateLocally.push(remoteContact);
+                        if (onContactUpdated) {
+                            onContactUpdated();
+                        }
+                    }
+                }
+                // Else: content is identical, no action needed
+            }
+        }
+        // SCENARIO 3 & 5: Process local contacts not in remote
+        for (const localContact of localVisibleContacts) {
+            const key = createContactKey(localContact);
+            const remoteContact = remoteContactsMap.get(key);
+            if (!remoteContact) {
+                // New local contact - add to remote
+                contactsToUpdateRemotely.push(localContact);
+            }
+        }
+        // Apply local deletions
+        for (const contact of contactsToDeleteLocally) {
+            try {
+                getMessenger().call('AddressBookController:delete', contact.chainId, contact.address);
+            }
+            catch (error) {
+                console.error('Error deleting contact:', error);
+            }
+        }
+        // Apply local additions/updates
+        for (const contact of contactsToAddOrUpdateLocally) {
+            if (!contact.deleted) {
+                try {
+                    getMessenger().call('AddressBookController:set', contact.address, contact.name || '', contact.chainId, contact.memo || '', contact.addressType);
+                }
+                catch (error) {
+                    console.error('Error updating contact:', error);
+                }
+            }
+        }
+        // Apply changes to remote storage
+        if (contactsToUpdateRemotely.length > 0) {
+            // Update existing remote contacts with new contacts
+            const updatedRemoteContacts = [...remoteContacts];
+            for (const localContact of contactsToUpdateRemotely) {
+                const key = createContactKey(localContact);
+                const existingIndex = updatedRemoteContacts.findIndex((c) => createContactKey(c) === key);
+                const now = Date.now();
+                const updatedEntry = {
+                    ...localContact,
+                    lastUpdatedAt: now,
+                    deleted: false, // Ensure it's not deleted
+                };
+                if (existingIndex !== -1) {
+                    // Update existing contact
+                    updatedRemoteContacts[existingIndex] = updatedEntry;
+                }
+                else {
+                    // Add new contact
+                    updatedRemoteContacts.push(updatedEntry);
+                }
+            }
+            // Save updated contacts to remote storage
+            await saveContactsToUserStorage(updatedRemoteContacts, options);
+        }
+    }
+    catch (error) {
+        if (onContactSyncErroneousSituation) {
+            onContactSyncErroneousSituation('Error synchronizing contacts', {
+                error,
+            });
+        }
+    }
+    finally {
+        await getUserStorageControllerInstance().setIsContactSyncingInProgress(false);
+    }
+}
+/**
+ * Retrieves remote contacts from user storage API
+ *
+ * @param options - Parameters used for retrieving remote contacts
+ * @returns Array of contacts from remote storage, or null if none found
+ */
+async function getRemoteContacts(options) {
+    const { getUserStorageControllerInstance } = options;
+    try {
+        const remoteContactsJson = await getUserStorageControllerInstance().performGetStorage(`${USER_STORAGE_FEATURE_NAMES.addressBook}.${ADDRESS_BOOK_CONTACTS_KEY}`);
+        if (!remoteContactsJson) {
+            return null;
+        }
+        // Parse the JSON and convert each entry from UserStorageContactEntry to AddressBookEntry
+        const remoteStorageEntries = JSON.parse(remoteContactsJson);
+        return remoteStorageEntries.map((entry) => mapUserStorageEntryToAddressBookEntry(entry));
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Saves local contacts to user storage
+ *
+ * @param contacts - The contacts to save to user storage
+ * @param options - Parameters used for saving contacts
+ */
+async function saveContactsToUserStorage(contacts, options) {
+    const { getUserStorageControllerInstance } = options;
+    if (!contacts || contacts.length === 0) {
+        return;
+    }
+    // Convert each AddressBookEntry to UserStorageContactEntry format before saving
+    const storageEntries = contacts.map((contact) => mapAddressBookEntryToUserStorageEntry(contact));
+    await getUserStorageControllerInstance().performSetStorage(`${USER_STORAGE_FEATURE_NAMES.addressBook}.${ADDRESS_BOOK_CONTACTS_KEY}`, JSON.stringify(storageEntries));
+}
+/**
+ * Updates a single contact in remote storage without performing a full sync
+ * This is used when a contact is updated locally to efficiently push changes to remote
+ *
+ * @param contact - The contact that was updated locally
+ * @param options - Parameters used for syncing operations
+ */
+export async function updateContactInRemoteStorage(contact, options) {
+    if (!canPerformContactSyncing(options)) {
+        return;
+    }
+    try {
+        // Get current remote contacts or initialize empty array
+        const remoteContacts = (await getRemoteContacts(options)) || [];
+        // Find if this contact already exists in remote
+        const key = createContactKey(contact);
+        const existingIndex = remoteContacts.findIndex((c) => createContactKey(c) === key);
+        const updatedRemoteContacts = [...remoteContacts];
+        // Create an updated entry with timestamp
+        const updatedEntry = {
+            ...contact,
+            lastUpdatedAt: contact.lastUpdatedAt || Date.now(),
+            deleted: false, // Explicitly set to false in case this was previously deleted
+        };
+        if (existingIndex !== -1) {
+            // Update existing contact
+            updatedRemoteContacts[existingIndex] = updatedEntry;
+        }
+        else {
+            // Add as new contact
+            updatedRemoteContacts.push(updatedEntry);
+        }
+        // Save to remote storage
+        await saveContactsToUserStorage(updatedRemoteContacts, options);
+    }
+    catch (error) {
+        console.error('🔄 Contacts Sync: Error updating contact in remote storage', error);
+    }
+}
+/**
+ * Marks a single contact as deleted in remote storage without performing a full sync
+ * This is used when a contact is deleted locally to efficiently push the deletion to remote
+ *
+ * @param contact - The contact that was deleted locally (contains at least address and chainId)
+ * @param options - Parameters used for syncing operations
+ */
+export async function deleteContactInRemoteStorage(contact, options) {
+    if (!canPerformContactSyncing(options)) {
+        return;
+    }
+    try {
+        // Get current remote contacts
+        const remoteContacts = (await getRemoteContacts(options)) || [];
+        // Find the contact in remote storage
+        const key = createContactKey(contact);
+        const existingIndex = remoteContacts.findIndex((c) => createContactKey(c) === key);
+        // If the contact exists in remote storage
+        if (existingIndex !== -1) {
+            const updatedRemoteContacts = [...remoteContacts];
+            const now = Date.now();
+            // Mark the contact as deleted
+            updatedRemoteContacts[existingIndex] = {
+                ...updatedRemoteContacts[existingIndex],
+                deleted: true,
+                deletedAt: now,
+                lastUpdatedAt: now,
+            };
+            // Save to remote storage
+            await saveContactsToUserStorage(updatedRemoteContacts, options);
+        }
+    }
+    catch (error) {
+        console.error('🔄 Contacts Sync: Error marking contact as deleted in remote storage', error);
+    }
+}
+//# sourceMappingURL=controller-integration.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"controller-integration.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/controller-integration.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,yBAAqB;AAGxD,OAAO,EACL,qCAAqC,EACrC,qCAAqC,EAEtC,oBAAgB;AACjB,OAAO,EAAE,0BAA0B,EAAE,2CAAuC;AAE5E,+DAA+D;AAC/D,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC;AAWpD;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,OAAyB;IACjD,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,MAAyC,EACzC,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IACnE,MAAM,EACJ,+BAA+B,EAC/B,gBAAgB,EAChB,gBAAgB,GACjB,GAAG,MAAM,CAAC;IAEX,IAAI;QACF,0CAA0C;QAC1C,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE;YACtC,OAAO;SACR;QAED,iDAAiD;QACjD,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,IAAI,CACL,CAAC;QAEF,iFAAiF;QACjF,MAAM,oBAAoB,GACxB,YAAY,EAAE;aACX,IAAI,CAAC,4BAA4B,CAAC;aAClC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;QAEhE,4CAA4C;QAC5C,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAExD,uEAAuE;QACvE,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAClD,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnC,MAAM,yBAAyB,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;aAChE;YACD,OAAO;SACR;QAED,oCAAoC;QACpC,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA4B,CAAC;QAC7D,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAgC,CAAC;QAElE,oBAAoB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACvC,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACtC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACjC,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACtC,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,iDAAiD;QACjD,MAAM,4BAA4B,GAA2B,EAAE,CAAC;QAChE,MAAM,uBAAuB,GAA2B,EAAE,CAAC;QAC3D,MAAM,wBAAwB,GAAuB,EAAE,CAAC;QAExD,sFAAsF;QACtF,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;YAC1C,MAAM,GAAG,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE/C,gEAAgE;YAChE,IAAI,aAAa,CAAC,OAAO,EAAE;gBACzB,oFAAoF;gBACpF,IAAI,YAAY,EAAE;oBAChB,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBAE5C,IAAI,gBAAgB,EAAE;wBACpB,gBAAgB,EAAE,CAAC;qBACpB;iBACF;aACF;iBAAM,IAAI,CAAC,YAAY,EAAE;gBACxB,wDAAwD;gBACxD,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAEjD,IAAI,gBAAgB,EAAE;oBACpB,gBAAgB,EAAE,CAAC;iBACpB;aACF;iBAAM;gBACL,qEAAqE;gBACrE,MAAM,oBAAoB,GACxB,YAAY,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI;oBACxC,YAAY,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI,CAAC;gBAE3C,IAAI,oBAAoB,EAAE;oBACxB,sDAAsD;oBACtD,MAAM,cAAc,GAAG,YAAY,CAAC,aAAa,IAAI,CAAC,CAAC;oBACvD,MAAM,eAAe,GAAG,aAAa,CAAC,aAAa,IAAI,CAAC,CAAC;oBAEzD,IAAI,cAAc,IAAI,eAAe,EAAE;wBACrC,mDAAmD;wBACnD,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;qBAC7C;yBAAM;wBACL,uCAAuC;wBACvC,4BAA4B,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;wBAEjD,IAAI,gBAAgB,EAAE;4BACpB,gBAAgB,EAAE,CAAC;yBACpB;qBACF;iBACF;gBAED,+CAA+C;aAChD;SACF;QAED,uDAAuD;QACvD,KAAK,MAAM,YAAY,IAAI,oBAAoB,EAAE;YAC/C,MAAM,GAAG,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEjD,IAAI,CAAC,aAAa,EAAE;gBAClB,oCAAoC;gBACpC,wBAAwB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7C;SACF;QAED,wBAAwB;QACxB,KAAK,MAAM,OAAO,IAAI,uBAAuB,EAAE;YAC7C,IAAI;gBACF,YAAY,EAAE,CAAC,IAAI,CACjB,8BAA8B,EAC9B,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,OAAO,CAChB,CAAC;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;aACjD;SACF;QAED,gCAAgC;QAChC,KAAK,MAAM,OAAO,IAAI,4BAA4B,EAAE;YAClD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBACpB,IAAI;oBACF,YAAY,EAAE,CAAC,IAAI,CACjB,2BAA2B,EAC3B,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,IAAI,IAAI,EAAE,EAClB,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,IAAI,IAAI,EAAE,EAClB,OAAO,CAAC,WAAW,CACpB,CAAC;iBACH;gBAAC,OAAO,KAAK,EAAE;oBACd,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;iBACjD;aACF;SACF;QAED,kCAAkC;QAClC,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,oDAAoD;YACpD,MAAM,qBAAqB,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC;YAElD,KAAK,MAAM,YAAY,IAAI,wBAAwB,EAAE;gBACnD,MAAM,GAAG,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;gBAC3C,MAAM,aAAa,GAAG,qBAAqB,CAAC,SAAS,CACnD,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,GAAG,CACnC,CAAC;gBAEF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,MAAM,YAAY,GAAG;oBACnB,GAAG,YAAY;oBACf,aAAa,EAAE,GAAG;oBAClB,OAAO,EAAE,KAAK,EAAE,0BAA0B;iBACnB,CAAC;gBAE1B,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;oBACxB,0BAA0B;oBAC1B,qBAAqB,CAAC,aAAa,CAAC,GAAG,YAAY,CAAC;iBACrD;qBAAM;oBACL,kBAAkB;oBAClB,qBAAqB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAC1C;aACF;YAED,0CAA0C;YAC1C,MAAM,yBAAyB,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;SACjE;KACF;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,+BAA+B,EAAE;YACnC,+BAA+B,CAAC,8BAA8B,EAAE;gBAC9D,KAAK;aACN,CAAC,CAAC;SACJ;KACF;YAAS;QACR,MAAM,gCAAgC,EAAE,CAAC,6BAA6B,CACpE,KAAK,CACN,CAAC;KACH;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,iBAAiB,CAC9B,OAA8B;IAE9B,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IAAI;QACF,MAAM,kBAAkB,GACtB,MAAM,gCAAgC,EAAE,CAAC,iBAAiB,CACxD,GAAG,0BAA0B,CAAC,WAAW,IAAI,yBAAyB,EAAE,CACzE,CAAC;QAEJ,IAAI,CAAC,kBAAkB,EAAE;YACvB,OAAO,IAAI,CAAC;SACb;QAED,yFAAyF;QACzF,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CACrC,kBAAkB,CACU,CAAC;QAC/B,OAAO,oBAAoB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACxC,qCAAqC,CAAC,KAAK,CAAC,CAC7C,CAAC;KACH;IAAC,MAAM;QACN,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,yBAAyB,CACtC,QAA4B,EAC5B,OAA8B;IAE9B,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAErD,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACtC,OAAO;KACR;IAED,gFAAgF;IAChF,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAC9C,qCAAqC,CAAC,OAAO,CAAC,CAC/C,CAAC;IAEF,MAAM,gCAAgC,EAAE,CAAC,iBAAiB,CACxD,GAAG,0BAA0B,CAAC,WAAW,IAAI,yBAAyB,EAAE,EACxE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,OAAyB,EACzB,OAA8B;IAE9B,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE;QACtC,OAAO;KACR;IAED,IAAI;QACF,wDAAwD;QACxD,MAAM,cAAc,GAAG,CAAC,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhE,gDAAgD;QAChD,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,cAAc,CAAC,SAAS,CAC5C,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,GAAG,CACnC,CAAC;QAEF,MAAM,qBAAqB,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC;QAElD,yCAAyC;QACzC,MAAM,YAAY,GAAG;YACnB,GAAG,OAAO;YACV,aAAa,EAAE,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,GAAG,EAAE;YAClD,OAAO,EAAE,KAAK,EAAE,8DAA8D;SACvD,CAAC;QAE1B,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;YACxB,0BAA0B;YAC1B,qBAAqB,CAAC,aAAa,CAAC,GAAG,YAAY,CAAC;SACrD;aAAM;YACL,qBAAqB;YACrB,qBAAqB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC1C;QAED,yBAAyB;QACzB,MAAM,yBAAyB,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;KACjE;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CACX,4DAA4D,EAC5D,KAAK,CACN,CAAC;KACH;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,OAAyB,EACzB,OAA8B;IAE9B,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE;QACtC,OAAO;KACR;IAED,IAAI;QACF,8BAA8B;QAC9B,MAAM,cAAc,GAAG,CAAC,MAAM,iBAAiB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhE,qCAAqC;QACrC,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,cAAc,CAAC,SAAS,CAC5C,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,GAAG,CACnC,CAAC;QAEF,0CAA0C;QAC1C,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;YACxB,MAAM,qBAAqB,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC;YAClD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEvB,8BAA8B;YAC9B,qBAAqB,CAAC,aAAa,CAAC,GAAG;gBACrC,GAAG,qBAAqB,CAAC,aAAa,CAAC;gBACvC,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,GAAG;gBACd,aAAa,EAAE,GAAG;aACnB,CAAC;YAEF,yBAAyB;YACzB,MAAM,yBAAyB,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;SACjE;KACF;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CACX,sEAAsE,EACtE,KAAK,CACN,CAAC;KACH;AACH,CAAC","sourcesContent":["import type { AddressBookEntry } from '@metamask/address-book-controller';\n\nimport { canPerformContactSyncing } from './sync-utils';\nimport type { ContactSyncingOptions } from './types';\nimport type { UserStorageContactEntry } from './types';\nimport {\n  mapAddressBookEntryToUserStorageEntry,\n  mapUserStorageEntryToAddressBookEntry,\n  type SyncAddressBookEntry,\n} from './utils';\nimport { USER_STORAGE_FEATURE_NAMES } from '../../../shared/storage-schema';\n\n// Define a constant to use as the key for storing all contacts\nexport const ADDRESS_BOOK_CONTACTS_KEY = 'contacts';\n\nexport type SyncContactsWithUserStorageConfig = {\n  onContactSyncErroneousSituation?: (\n    errorMessage: string,\n    sentryContext?: Record<string, unknown>,\n  ) => void;\n  onContactUpdated?: () => void;\n  onContactDeleted?: () => void;\n};\n\n/**\n * Creates a unique key for a contact based on chainId and address\n *\n * @param contact - The contact to create a key for\n * @returns A unique string key\n */\nfunction createContactKey(contact: AddressBookEntry): string {\n  return `${contact.chainId}:${contact.address.toLowerCase()}`;\n}\n\n/**\n * Syncs contacts between local storage and user storage (remote).\n *\n * Handles the following syncing scenarios:\n * 1. First Sync: When local contacts exist but there are no remote contacts, uploads all local contacts.\n * 2. New Device Sync: Downloads remote contacts that don't exist locally (empty local address book).\n * 3. Simple Merge: Ensures both sides (local & remote) have all contacts.\n * 4. Contact Naming Conflicts: When same contact has different names, uses most recent by timestamp.\n * 5. Local Updates: When a contact was updated locally, syncs changes to remote if local is newer.\n * 6. Remote Updates: When a contact was updated remotely, applies changes locally if remote is newer.\n * 7. Local Deletions: Handled by real-time event handlers (deleteContactInRemoteStorage) to prevent false positives.\n * 8. Remote Deletions: When a contact was deleted remotely, applies deletion locally.\n * 9. Concurrent Updates: Resolves conflicts using timestamps to determine the winner.\n * 10. Restore After Delete: If a contact is modified after being deleted, restores it.\n * 11. ChainId Differences: Treats same address on different chains as separate contacts.\n *\n * @param config - Parameters used for syncing callbacks\n * @param options - Parameters used for syncing operations\n */\nexport async function syncContactsWithUserStorage(\n  config: SyncContactsWithUserStorageConfig,\n  options: ContactSyncingOptions,\n): Promise<void> {\n  const { getMessenger, getUserStorageControllerInstance } = options;\n  const {\n    onContactSyncErroneousSituation,\n    onContactUpdated,\n    onContactDeleted,\n  } = config;\n\n  try {\n    // Cannot perform sync, conditions not met\n    if (!canPerformContactSyncing(options)) {\n      return;\n    }\n\n    // Activate sync semaphore to prevent event loops\n    await getUserStorageControllerInstance().setIsContactSyncingInProgress(\n      true,\n    );\n\n    // Get all local contacts from AddressBookController (exclude chain \"*\" contacts)\n    const localVisibleContacts =\n      getMessenger()\n        .call('AddressBookController:list')\n        .filter((contact) => String(contact.chainId) !== '*') || [];\n\n    // Get remote contacts from user storage API\n    const remoteContacts = await getRemoteContacts(options);\n\n    // SCENARIO 1: First Sync - No remote contacts but local contacts exist\n    if (!remoteContacts || remoteContacts.length === 0) {\n      if (localVisibleContacts.length > 0) {\n        await saveContactsToUserStorage(localVisibleContacts, options);\n      }\n      return;\n    }\n\n    // Prepare maps for efficient lookup\n    const localContactsMap = new Map<string, AddressBookEntry>();\n    const remoteContactsMap = new Map<string, SyncAddressBookEntry>();\n\n    localVisibleContacts.forEach((contact) => {\n      const key = createContactKey(contact);\n      localContactsMap.set(key, contact);\n    });\n\n    remoteContacts.forEach((contact) => {\n      const key = createContactKey(contact);\n      remoteContactsMap.set(key, contact);\n    });\n\n    // Lists to track contacts that need to be synced\n    const contactsToAddOrUpdateLocally: SyncAddressBookEntry[] = [];\n    const contactsToDeleteLocally: SyncAddressBookEntry[] = [];\n    const contactsToUpdateRemotely: AddressBookEntry[] = [];\n\n    // SCENARIO 2 & 6: Process remote contacts - handle new device sync and remote updates\n    for (const remoteContact of remoteContacts) {\n      const key = createContactKey(remoteContact);\n      const localContact = localContactsMap.get(key);\n\n      // Handle remote contact based on its status and local existence\n      if (remoteContact.deleted) {\n        // SCENARIO 8: Remote deletion - should be applied locally if contact exists locally\n        if (localContact) {\n          contactsToDeleteLocally.push(remoteContact);\n\n          if (onContactDeleted) {\n            onContactDeleted();\n          }\n        }\n      } else if (!localContact) {\n        // SCENARIO 2: New contact from remote - import to local\n        contactsToAddOrUpdateLocally.push(remoteContact);\n\n        if (onContactUpdated) {\n          onContactUpdated();\n        }\n      } else {\n        // SCENARIO 4 & 6: Contact exists on both sides - check for conflicts\n        const hasContentDifference =\n          localContact.name !== remoteContact.name ||\n          localContact.memo !== remoteContact.memo;\n\n        if (hasContentDifference) {\n          // Check timestamps to determine which version to keep\n          const localTimestamp = localContact.lastUpdatedAt || 0;\n          const remoteTimestamp = remoteContact.lastUpdatedAt || 0;\n\n          if (localTimestamp >= remoteTimestamp) {\n            // Local is newer (or same age) - use local version\n            contactsToUpdateRemotely.push(localContact);\n          } else {\n            // Remote is newer - use remote version\n            contactsToAddOrUpdateLocally.push(remoteContact);\n\n            if (onContactUpdated) {\n              onContactUpdated();\n            }\n          }\n        }\n\n        // Else: content is identical, no action needed\n      }\n    }\n\n    // SCENARIO 3 & 5: Process local contacts not in remote\n    for (const localContact of localVisibleContacts) {\n      const key = createContactKey(localContact);\n      const remoteContact = remoteContactsMap.get(key);\n\n      if (!remoteContact) {\n        // New local contact - add to remote\n        contactsToUpdateRemotely.push(localContact);\n      }\n    }\n\n    // Apply local deletions\n    for (const contact of contactsToDeleteLocally) {\n      try {\n        getMessenger().call(\n          'AddressBookController:delete',\n          contact.chainId,\n          contact.address,\n        );\n      } catch (error) {\n        console.error('Error deleting contact:', error);\n      }\n    }\n\n    // Apply local additions/updates\n    for (const contact of contactsToAddOrUpdateLocally) {\n      if (!contact.deleted) {\n        try {\n          getMessenger().call(\n            'AddressBookController:set',\n            contact.address,\n            contact.name || '',\n            contact.chainId,\n            contact.memo || '',\n            contact.addressType,\n          );\n        } catch (error) {\n          console.error('Error updating contact:', error);\n        }\n      }\n    }\n\n    // Apply changes to remote storage\n    if (contactsToUpdateRemotely.length > 0) {\n      // Update existing remote contacts with new contacts\n      const updatedRemoteContacts = [...remoteContacts];\n\n      for (const localContact of contactsToUpdateRemotely) {\n        const key = createContactKey(localContact);\n        const existingIndex = updatedRemoteContacts.findIndex(\n          (c) => createContactKey(c) === key,\n        );\n\n        const now = Date.now();\n        const updatedEntry = {\n          ...localContact,\n          lastUpdatedAt: now,\n          deleted: false, // Ensure it's not deleted\n        } as SyncAddressBookEntry;\n\n        if (existingIndex !== -1) {\n          // Update existing contact\n          updatedRemoteContacts[existingIndex] = updatedEntry;\n        } else {\n          // Add new contact\n          updatedRemoteContacts.push(updatedEntry);\n        }\n      }\n\n      // Save updated contacts to remote storage\n      await saveContactsToUserStorage(updatedRemoteContacts, options);\n    }\n  } catch (error) {\n    if (onContactSyncErroneousSituation) {\n      onContactSyncErroneousSituation('Error synchronizing contacts', {\n        error,\n      });\n    }\n  } finally {\n    await getUserStorageControllerInstance().setIsContactSyncingInProgress(\n      false,\n    );\n  }\n}\n\n/**\n * Retrieves remote contacts from user storage API\n *\n * @param options - Parameters used for retrieving remote contacts\n * @returns Array of contacts from remote storage, or null if none found\n */\nasync function getRemoteContacts(\n  options: ContactSyncingOptions,\n): Promise<SyncAddressBookEntry[] | null> {\n  const { getUserStorageControllerInstance } = options;\n\n  try {\n    const remoteContactsJson =\n      await getUserStorageControllerInstance().performGetStorage(\n        `${USER_STORAGE_FEATURE_NAMES.addressBook}.${ADDRESS_BOOK_CONTACTS_KEY}`,\n      );\n\n    if (!remoteContactsJson) {\n      return null;\n    }\n\n    // Parse the JSON and convert each entry from UserStorageContactEntry to AddressBookEntry\n    const remoteStorageEntries = JSON.parse(\n      remoteContactsJson,\n    ) as UserStorageContactEntry[];\n    return remoteStorageEntries.map((entry) =>\n      mapUserStorageEntryToAddressBookEntry(entry),\n    );\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Saves local contacts to user storage\n *\n * @param contacts - The contacts to save to user storage\n * @param options - Parameters used for saving contacts\n */\nasync function saveContactsToUserStorage(\n  contacts: AddressBookEntry[],\n  options: ContactSyncingOptions,\n): Promise<void> {\n  const { getUserStorageControllerInstance } = options;\n\n  if (!contacts || contacts.length === 0) {\n    return;\n  }\n\n  // Convert each AddressBookEntry to UserStorageContactEntry format before saving\n  const storageEntries = contacts.map((contact) =>\n    mapAddressBookEntryToUserStorageEntry(contact),\n  );\n\n  await getUserStorageControllerInstance().performSetStorage(\n    `${USER_STORAGE_FEATURE_NAMES.addressBook}.${ADDRESS_BOOK_CONTACTS_KEY}`,\n    JSON.stringify(storageEntries),\n  );\n}\n\n/**\n * Updates a single contact in remote storage without performing a full sync\n * This is used when a contact is updated locally to efficiently push changes to remote\n *\n * @param contact - The contact that was updated locally\n * @param options - Parameters used for syncing operations\n */\nexport async function updateContactInRemoteStorage(\n  contact: AddressBookEntry,\n  options: ContactSyncingOptions,\n): Promise<void> {\n  if (!canPerformContactSyncing(options)) {\n    return;\n  }\n\n  try {\n    // Get current remote contacts or initialize empty array\n    const remoteContacts = (await getRemoteContacts(options)) || [];\n\n    // Find if this contact already exists in remote\n    const key = createContactKey(contact);\n    const existingIndex = remoteContacts.findIndex(\n      (c) => createContactKey(c) === key,\n    );\n\n    const updatedRemoteContacts = [...remoteContacts];\n\n    // Create an updated entry with timestamp\n    const updatedEntry = {\n      ...contact,\n      lastUpdatedAt: contact.lastUpdatedAt || Date.now(),\n      deleted: false, // Explicitly set to false in case this was previously deleted\n    } as SyncAddressBookEntry;\n\n    if (existingIndex !== -1) {\n      // Update existing contact\n      updatedRemoteContacts[existingIndex] = updatedEntry;\n    } else {\n      // Add as new contact\n      updatedRemoteContacts.push(updatedEntry);\n    }\n\n    // Save to remote storage\n    await saveContactsToUserStorage(updatedRemoteContacts, options);\n  } catch (error) {\n    console.error(\n      '🔄 Contacts Sync: Error updating contact in remote storage',\n      error,\n    );\n  }\n}\n\n/**\n * Marks a single contact as deleted in remote storage without performing a full sync\n * This is used when a contact is deleted locally to efficiently push the deletion to remote\n *\n * @param contact - The contact that was deleted locally (contains at least address and chainId)\n * @param options - Parameters used for syncing operations\n */\nexport async function deleteContactInRemoteStorage(\n  contact: AddressBookEntry,\n  options: ContactSyncingOptions,\n): Promise<void> {\n  if (!canPerformContactSyncing(options)) {\n    return;\n  }\n\n  try {\n    // Get current remote contacts\n    const remoteContacts = (await getRemoteContacts(options)) || [];\n\n    // Find the contact in remote storage\n    const key = createContactKey(contact);\n    const existingIndex = remoteContacts.findIndex(\n      (c) => createContactKey(c) === key,\n    );\n\n    // If the contact exists in remote storage\n    if (existingIndex !== -1) {\n      const updatedRemoteContacts = [...remoteContacts];\n      const now = Date.now();\n\n      // Mark the contact as deleted\n      updatedRemoteContacts[existingIndex] = {\n        ...updatedRemoteContacts[existingIndex],\n        deleted: true,\n        deletedAt: now,\n        lastUpdatedAt: now,\n      };\n\n      // Save to remote storage\n      await saveContactsToUserStorage(updatedRemoteContacts, options);\n    }\n  } catch (error) {\n    console.error(\n      '🔄 Contacts Sync: Error marking contact as deleted in remote storage',\n      error,\n    );\n  }\n}\n"]}

package/dist/controllers/user-storage/contact-syncing/setup-subscriptions.cjs

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupContactSyncingSubscriptions = void 0;
+const controller_integration_1 = require("./controller-integration.cjs");
+const sync_utils_1 = require("./sync-utils.cjs");
+/**
+ * Initialize and setup events to listen to for contact syncing
+ *
+ * @param options - parameters used for initializing and enabling contact syncing
+ */
+function setupContactSyncingSubscriptions(options) {
+    const { getMessenger } = options;
+    // Listen for contact updates and immediately sync the individual contact
+    getMessenger().subscribe('AddressBookController:contactUpdated', (contactEntry) => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        (async () => {
+            if (!(0, sync_utils_1.canPerformContactSyncing)(options)) {
+                return;
+            }
+            // Skip global accounts with chainId "*" : they are contacts bridged from accounts
+            if (String(contactEntry.chainId) === '*') {
+                return;
+            }
+            try {
+                // Use the targeted method to update just this contact
+                await (0, controller_integration_1.updateContactInRemoteStorage)(contactEntry, options);
+            }
+            catch (error) {
+                console.error('Error updating contact in remote storage:', error);
+            }
+        })();
+    });
+    // Listen for contact deletions and immediately sync the individual deletion
+    getMessenger().subscribe('AddressBookController:contactDeleted', (contactEntry) => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        (async () => {
+            if (!(0, sync_utils_1.canPerformContactSyncing)(options)) {
+                return;
+            }
+            // Skip global accounts with chainId "*" : they are contacts bridged from accounts
+            if (String(contactEntry.chainId) === '*') {
+                return;
+            }
+            try {
+                // Use the targeted method to delete just this contact
+                await (0, controller_integration_1.deleteContactInRemoteStorage)(contactEntry, options);
+            }
+            catch (error) {
+                console.error('Error deleting contact from remote storage:', error);
+            }
+        })();
+    });
+}
+exports.setupContactSyncingSubscriptions = setupContactSyncingSubscriptions;
+//# sourceMappingURL=setup-subscriptions.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setup-subscriptions.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/setup-subscriptions.ts"],"names":[],"mappings":";;;AAEA,yEAGkC;AAClC,iDAAwD;AAGxD;;;;GAIG;AACH,SAAgB,gCAAgC,CAC9C,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IAEjC,yEAAyE;IACzE,YAAY,EAAE,CAAC,SAAS,CACtB,sCAAsC,EACtC,CAAC,YAA8B,EAAE,EAAE;QACjC,mEAAmE;QACnE,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC,IAAA,qCAAwB,EAAC,OAAO,CAAC,EAAE;gBACtC,OAAO;aACR;YAED,kFAAkF;YAClF,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;gBACxC,OAAO;aACR;YAED,IAAI;gBACF,sDAAsD;gBACtD,MAAM,IAAA,qDAA4B,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,KAAK,CAAC,CAAC;aACnE;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC,CACF,CAAC;IAEF,4EAA4E;IAC5E,YAAY,EAAE,CAAC,SAAS,CACtB,sCAAsC,EACtC,CAAC,YAA8B,EAAE,EAAE;QACjC,mEAAmE;QACnE,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC,IAAA,qCAAwB,EAAC,OAAO,CAAC,EAAE;gBACtC,OAAO;aACR;YAED,kFAAkF;YAClF,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;gBACxC,OAAO;aACR;YAED,IAAI;gBACF,sDAAsD;gBACtD,MAAM,IAAA,qDAA4B,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;aACrE;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC,CACF,CAAC;AACJ,CAAC;AAtDD,4EAsDC","sourcesContent":["import type { AddressBookEntry } from '@metamask/address-book-controller';\n\nimport {\n  updateContactInRemoteStorage,\n  deleteContactInRemoteStorage,\n} from './controller-integration';\nimport { canPerformContactSyncing } from './sync-utils';\nimport type { ContactSyncingOptions } from './types';\n\n/**\n * Initialize and setup events to listen to for contact syncing\n *\n * @param options - parameters used for initializing and enabling contact syncing\n */\nexport function setupContactSyncingSubscriptions(\n  options: ContactSyncingOptions,\n): void {\n  const { getMessenger } = options;\n\n  // Listen for contact updates and immediately sync the individual contact\n  getMessenger().subscribe(\n    'AddressBookController:contactUpdated',\n    (contactEntry: AddressBookEntry) => {\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\n      (async () => {\n        if (!canPerformContactSyncing(options)) {\n          return;\n        }\n\n        // Skip global accounts with chainId \"*\" : they are contacts bridged from accounts\n        if (String(contactEntry.chainId) === '*') {\n          return;\n        }\n\n        try {\n          // Use the targeted method to update just this contact\n          await updateContactInRemoteStorage(contactEntry, options);\n        } catch (error) {\n          console.error('Error updating contact in remote storage:', error);\n        }\n      })();\n    },\n  );\n\n  // Listen for contact deletions and immediately sync the individual deletion\n  getMessenger().subscribe(\n    'AddressBookController:contactDeleted',\n    (contactEntry: AddressBookEntry) => {\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\n      (async () => {\n        if (!canPerformContactSyncing(options)) {\n          return;\n        }\n\n        // Skip global accounts with chainId \"*\" : they are contacts bridged from accounts\n        if (String(contactEntry.chainId) === '*') {\n          return;\n        }\n\n        try {\n          // Use the targeted method to delete just this contact\n          await deleteContactInRemoteStorage(contactEntry, options);\n        } catch (error) {\n          console.error('Error deleting contact from remote storage:', error);\n        }\n      })();\n    },\n  );\n}\n"]}

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

@@ -0,0 +1,8 @@
+import type { ContactSyncingOptions } from "./types.cjs";
+/**
+ * Initialize and setup events to listen to for contact syncing
+ *
+ * @param options - parameters used for initializing and enabling contact syncing
+ */
+export declare function setupContactSyncingSubscriptions(options: ContactSyncingOptions): void;
+//# sourceMappingURL=setup-subscriptions.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setup-subscriptions.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/setup-subscriptions.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAgB;AAErD;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,qBAAqB,GAC7B,IAAI,CAoDN"}

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

@@ -0,0 +1,8 @@
+import type { ContactSyncingOptions } from "./types.mjs";
+/**
+ * Initialize and setup events to listen to for contact syncing
+ *
+ * @param options - parameters used for initializing and enabling contact syncing
+ */
+export declare function setupContactSyncingSubscriptions(options: ContactSyncingOptions): void;
+//# sourceMappingURL=setup-subscriptions.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setup-subscriptions.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/setup-subscriptions.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAgB;AAErD;;;;GAIG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,qBAAqB,GAC7B,IAAI,CAoDN"}

package/dist/controllers/user-storage/contact-syncing/setup-subscriptions.mjs

@@ -0,0 +1,51 @@
+import { updateContactInRemoteStorage, deleteContactInRemoteStorage } from "./controller-integration.mjs";
+import { canPerformContactSyncing } from "./sync-utils.mjs";
+/**
+ * Initialize and setup events to listen to for contact syncing
+ *
+ * @param options - parameters used for initializing and enabling contact syncing
+ */
+export function setupContactSyncingSubscriptions(options) {
+    const { getMessenger } = options;
+    // Listen for contact updates and immediately sync the individual contact
+    getMessenger().subscribe('AddressBookController:contactUpdated', (contactEntry) => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        (async () => {
+            if (!canPerformContactSyncing(options)) {
+                return;
+            }
+            // Skip global accounts with chainId "*" : they are contacts bridged from accounts
+            if (String(contactEntry.chainId) === '*') {
+                return;
+            }
+            try {
+                // Use the targeted method to update just this contact
+                await updateContactInRemoteStorage(contactEntry, options);
+            }
+            catch (error) {
+                console.error('Error updating contact in remote storage:', error);
+            }
+        })();
+    });
+    // Listen for contact deletions and immediately sync the individual deletion
+    getMessenger().subscribe('AddressBookController:contactDeleted', (contactEntry) => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        (async () => {
+            if (!canPerformContactSyncing(options)) {
+                return;
+            }
+            // Skip global accounts with chainId "*" : they are contacts bridged from accounts
+            if (String(contactEntry.chainId) === '*') {
+                return;
+            }
+            try {
+                // Use the targeted method to delete just this contact
+                await deleteContactInRemoteStorage(contactEntry, options);
+            }
+            catch (error) {
+                console.error('Error deleting contact from remote storage:', error);
+            }
+        })();
+    });
+}
+//# sourceMappingURL=setup-subscriptions.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setup-subscriptions.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/setup-subscriptions.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC7B,qCAAiC;AAClC,OAAO,EAAE,wBAAwB,EAAE,yBAAqB;AAGxD;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IAEjC,yEAAyE;IACzE,YAAY,EAAE,CAAC,SAAS,CACtB,sCAAsC,EACtC,CAAC,YAA8B,EAAE,EAAE;QACjC,mEAAmE;QACnE,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE;gBACtC,OAAO;aACR;YAED,kFAAkF;YAClF,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;gBACxC,OAAO;aACR;YAED,IAAI;gBACF,sDAAsD;gBACtD,MAAM,4BAA4B,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,2CAA2C,EAAE,KAAK,CAAC,CAAC;aACnE;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC,CACF,CAAC;IAEF,4EAA4E;IAC5E,YAAY,EAAE,CAAC,SAAS,CACtB,sCAAsC,EACtC,CAAC,YAA8B,EAAE,EAAE;QACjC,mEAAmE;QACnE,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE;gBACtC,OAAO;aACR;YAED,kFAAkF;YAClF,IAAI,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;gBACxC,OAAO;aACR;YAED,IAAI;gBACF,sDAAsD;gBACtD,MAAM,4BAA4B,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;aAC3D;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,KAAK,CAAC,CAAC;aACrE;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC,CACF,CAAC;AACJ,CAAC","sourcesContent":["import type { AddressBookEntry } from '@metamask/address-book-controller';\n\nimport {\n  updateContactInRemoteStorage,\n  deleteContactInRemoteStorage,\n} from './controller-integration';\nimport { canPerformContactSyncing } from './sync-utils';\nimport type { ContactSyncingOptions } from './types';\n\n/**\n * Initialize and setup events to listen to for contact syncing\n *\n * @param options - parameters used for initializing and enabling contact syncing\n */\nexport function setupContactSyncingSubscriptions(\n  options: ContactSyncingOptions,\n): void {\n  const { getMessenger } = options;\n\n  // Listen for contact updates and immediately sync the individual contact\n  getMessenger().subscribe(\n    'AddressBookController:contactUpdated',\n    (contactEntry: AddressBookEntry) => {\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\n      (async () => {\n        if (!canPerformContactSyncing(options)) {\n          return;\n        }\n\n        // Skip global accounts with chainId \"*\" : they are contacts bridged from accounts\n        if (String(contactEntry.chainId) === '*') {\n          return;\n        }\n\n        try {\n          // Use the targeted method to update just this contact\n          await updateContactInRemoteStorage(contactEntry, options);\n        } catch (error) {\n          console.error('Error updating contact in remote storage:', error);\n        }\n      })();\n    },\n  );\n\n  // Listen for contact deletions and immediately sync the individual deletion\n  getMessenger().subscribe(\n    'AddressBookController:contactDeleted',\n    (contactEntry: AddressBookEntry) => {\n      // eslint-disable-next-line @typescript-eslint/no-floating-promises\n      (async () => {\n        if (!canPerformContactSyncing(options)) {\n          return;\n        }\n\n        // Skip global accounts with chainId \"*\" : they are contacts bridged from accounts\n        if (String(contactEntry.chainId) === '*') {\n          return;\n        }\n\n        try {\n          // Use the targeted method to delete just this contact\n          await deleteContactInRemoteStorage(contactEntry, options);\n        } catch (error) {\n          console.error('Error deleting contact from remote storage:', error);\n        }\n      })();\n    },\n  );\n}\n"]}

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canPerformContactSyncing = void 0;
+/**
+ * Check if we can perform contact syncing
+ *
+ * @param options - parameters used for checking if we can perform contact syncing
+ * @returns whether we can perform contact syncing
+ */
+function canPerformContactSyncing(options) {
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    const { isBackupAndSyncEnabled, isContactSyncingEnabled, isContactSyncingInProgress, } = getUserStorageControllerInstance().state;
+    const isAuthEnabled = getMessenger().call('AuthenticationController:isSignedIn');
+    if (!isBackupAndSyncEnabled ||
+        !isContactSyncingEnabled ||
+        isContactSyncingInProgress ||
+        !isAuthEnabled) {
+        return false;
+    }
+    return true;
+}
+exports.canPerformContactSyncing = canPerformContactSyncing;
+//# sourceMappingURL=sync-utils.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sync-utils.cjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/sync-utils.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,SAAgB,wBAAwB,CACtC,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAEnE,MAAM,EACJ,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,GAC3B,GAAG,gCAAgC,EAAE,CAAC,KAAK,CAAC;IAC7C,MAAM,aAAa,GAAG,YAAY,EAAE,CAAC,IAAI,CACvC,qCAAqC,CACtC,CAAC;IAEF,IACE,CAAC,sBAAsB;QACvB,CAAC,uBAAuB;QACxB,0BAA0B;QAC1B,CAAC,aAAa,EACd;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAxBD,4DAwBC","sourcesContent":["import type { ContactSyncingOptions } from './types';\n\n/**\n * Check if we can perform contact syncing\n *\n * @param options - parameters used for checking if we can perform contact syncing\n * @returns whether we can perform contact syncing\n */\nexport function canPerformContactSyncing(\n  options: ContactSyncingOptions,\n): boolean {\n  const { getMessenger, getUserStorageControllerInstance } = options;\n\n  const {\n    isBackupAndSyncEnabled,\n    isContactSyncingEnabled,\n    isContactSyncingInProgress,\n  } = getUserStorageControllerInstance().state;\n  const isAuthEnabled = getMessenger().call(\n    'AuthenticationController:isSignedIn',\n  );\n\n  if (\n    !isBackupAndSyncEnabled ||\n    !isContactSyncingEnabled ||\n    isContactSyncingInProgress ||\n    !isAuthEnabled\n  ) {\n    return false;\n  }\n\n  return true;\n}\n"]}

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

@@ -0,0 +1,9 @@
+import type { ContactSyncingOptions } from "./types.cjs";
+/**
+ * Check if we can perform contact syncing
+ *
+ * @param options - parameters used for checking if we can perform contact syncing
+ * @returns whether we can perform contact syncing
+ */
+export declare function canPerformContactSyncing(options: ContactSyncingOptions): boolean;
+//# sourceMappingURL=sync-utils.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sync-utils.d.cts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/sync-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAgB;AAErD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAsBT"}

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

@@ -0,0 +1,9 @@
+import type { ContactSyncingOptions } from "./types.mjs";
+/**
+ * Check if we can perform contact syncing
+ *
+ * @param options - parameters used for checking if we can perform contact syncing
+ * @returns whether we can perform contact syncing
+ */
+export declare function canPerformContactSyncing(options: ContactSyncingOptions): boolean;
+//# sourceMappingURL=sync-utils.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sync-utils.d.mts","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/sync-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAgB;AAErD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAsBT"}

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

@@ -0,0 +1,19 @@
+/**
+ * Check if we can perform contact syncing
+ *
+ * @param options - parameters used for checking if we can perform contact syncing
+ * @returns whether we can perform contact syncing
+ */
+export function canPerformContactSyncing(options) {
+    const { getMessenger, getUserStorageControllerInstance } = options;
+    const { isBackupAndSyncEnabled, isContactSyncingEnabled, isContactSyncingInProgress, } = getUserStorageControllerInstance().state;
+    const isAuthEnabled = getMessenger().call('AuthenticationController:isSignedIn');
+    if (!isBackupAndSyncEnabled ||
+        !isContactSyncingEnabled ||
+        isContactSyncingInProgress ||
+        !isAuthEnabled) {
+        return false;
+    }
+    return true;
+}
+//# sourceMappingURL=sync-utils.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sync-utils.mjs","sourceRoot":"","sources":["../../../../src/controllers/user-storage/contact-syncing/sync-utils.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAA8B;IAE9B,MAAM,EAAE,YAAY,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC;IAEnE,MAAM,EACJ,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,GAC3B,GAAG,gCAAgC,EAAE,CAAC,KAAK,CAAC;IAC7C,MAAM,aAAa,GAAG,YAAY,EAAE,CAAC,IAAI,CACvC,qCAAqC,CACtC,CAAC;IAEF,IACE,CAAC,sBAAsB;QACvB,CAAC,uBAAuB;QACxB,0BAA0B;QAC1B,CAAC,aAAa,EACd;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import type { ContactSyncingOptions } from './types';\n\n/**\n * Check if we can perform contact syncing\n *\n * @param options - parameters used for checking if we can perform contact syncing\n * @returns whether we can perform contact syncing\n */\nexport function canPerformContactSyncing(\n  options: ContactSyncingOptions,\n): boolean {\n  const { getMessenger, getUserStorageControllerInstance } = options;\n\n  const {\n    isBackupAndSyncEnabled,\n    isContactSyncingEnabled,\n    isContactSyncingInProgress,\n  } = getUserStorageControllerInstance().state;\n  const isAuthEnabled = getMessenger().call(\n    'AuthenticationController:isSignedIn',\n  );\n\n  if (\n    !isBackupAndSyncEnabled ||\n    !isContactSyncingEnabled ||\n    isContactSyncingInProgress ||\n    !isAuthEnabled\n  ) {\n    return false;\n  }\n\n  return true;\n}\n"]}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","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/types.d.cts

@@ -0,0 +1,35 @@
+import type { Hex } from "@metamask/utils";
+import type { USER_STORAGE_VERSION_KEY, USER_STORAGE_VERSION } from "./constants.cjs";
+import type { UserStorageControllerMessenger } from "../UserStorageController.cjs";
+import type UserStorageController from "../UserStorageController.cjs";
+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.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","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"}