@xmtp/browser-sdk 0.0.23 → 1.0.0-rc1

package/src/types/clientEvents.ts

@@ -2,6 +2,7 @@ import type {
   ConsentEntityType,
   ConsentState,
   ConversationType,
+  Identifier,
   MetadataField,
   PermissionPolicy,
   PermissionUpdateType,
@@ -56,7 +57,7 @@ export type ClientEvents =
         installationIdBytes: Uint8Array;
       };
       data: {
-        address: string;
+        identifier: Identifier;
         encryptionKey: Uint8Array;
         options?: ClientOptions;
       };
@@ -72,7 +73,7 @@ export type ClientEvents =
       id: string;
       result: string | undefined;
       data: {
-        newAccountAddress: string;
+        newIdentifier: Identifier;
       };
     }
   | {
@@ -80,7 +81,7 @@ export type ClientEvents =
       id: string;
       result: string | undefined;
       data: {
-        accountAddress: string;
+        identifier: Identifier;
       };
     }
   | {
@@ -98,7 +99,7 @@ export type ClientEvents =
       };
     }
   | {
-      action: "addSignature";
+      action: "addEcdsaSignature";
       id: string;
       result: undefined;
       data: {
@@ -140,7 +141,7 @@ export type ClientEvents =
       id: string;
       result: Map<string, boolean>;
       data: {
-        accountAddresses: string[];
+        identifiers: Identifier[];
       };
     }
   | {
@@ -177,11 +178,11 @@ export type ClientEvents =
       };
     }
   | {
-      action: "findInboxIdByAddress";
+      action: "findInboxIdByIdentifier";
       id: string;
       result: string | undefined;
       data: {
-        address: string;
+        identifier: Identifier;
       };
     }
   | {
@@ -263,16 +264,16 @@ export type ClientEvents =
       };
     }
   | {
-      action: "newGroup";
+      action: "newGroupWithIdentifiers";
       id: string;
       result: SafeConversation;
       data: {
-        accountAddresses: string[];
+        identifiers: Identifier[];
         options?: SafeCreateGroupOptions;
       };
     }
   | {
-      action: "newGroupByInboxIds";
+      action: "newGroupWithInboxIds";
       id: string;
       result: SafeConversation;
       data: {
@@ -281,16 +282,16 @@ export type ClientEvents =
       };
     }
   | {
-      action: "newDm";
+      action: "newDmWithIdentifier";
       id: string;
       result: SafeConversation;
       data: {
-        accountAddress: string;
+        identifier: Identifier;
         options?: SafeCreateDmOptions;
       };
     }
   | {
-      action: "newDmByInboxId";
+      action: "newDmWithInboxId";
       id: string;
       result: SafeConversation;
       data: {
@@ -446,7 +447,7 @@ export type ClientEvents =
       result: undefined;
       data: {
         id: string;
-        accountAddresses: string[];
+        identifiers: Identifier[];
       };
     }
   | {
@@ -455,7 +456,7 @@ export type ClientEvents =
       result: undefined;
       data: {
         id: string;
-        accountAddresses: string[];
+        identifiers: Identifier[];
       };
     }
   | {
@@ -623,6 +624,14 @@ export type ClientEvents =
         groupId: string;
         streamId: string;
       };
+    }
+  | {
+      action: "getGroupPausedForVersion";
+      id: string;
+      result: string | undefined;
+      data: {
+        id: string;
+      };
     };
 
 export type ClientEventsActions = ClientEvents["action"];

package/src/types/utilsEvents.ts

@@ -1,3 +1,4 @@
+import type { Identifier } from "@xmtp/wasm-bindings";
 import type {
   EventsClientMessageData,
   EventsClientPostMessageData,
@@ -15,16 +16,16 @@ export type UtilsEvents =
       id: string;
       result: string;
       data: {
-        address: string;
+        identifier: Identifier;
         enableLogging: boolean;
       };
     }
   | {
-      action: "getInboxIdForAddress";
+      action: "getInboxIdForIdentifier";
       id: string;
       result: string | undefined;
       data: {
-        address: string;
+        identifier: Identifier;
         env?: XmtpEnv;
         enableLogging: boolean;
       };

package/src/utils/conversions.ts

@@ -20,6 +20,7 @@ import {
   type DeliveryStatus,
   type GroupMessageKind,
   type HmacKey,
+  type Identifier,
   type InboxState,
   type Installation,
   type Message,
@@ -394,17 +395,17 @@ export const toSafeInstallation = (
 });
 
 export type SafeInboxState = {
-  accountAddresses: string[];
+  accountIdentifiers: Identifier[];
   inboxId: string;
   installations: SafeInstallation[];
-  recoveryAddress: string;
+  recoveryIdentifier: Identifier;
 };
 
 export const toSafeInboxState = (inboxState: InboxState): SafeInboxState => ({
-  accountAddresses: inboxState.accountAddresses,
+  accountIdentifiers: inboxState.accountIdentifiers,
   inboxId: inboxState.inboxId,
   installations: inboxState.installations.map(toSafeInstallation),
-  recoveryAddress: inboxState.recoveryAddress,
+  recoveryIdentifier: inboxState.recoveryIdentifier,
 });
 
 export type SafeConsent = {
@@ -423,7 +424,7 @@ export const fromSafeConsent = (consent: SafeConsent): Consent =>
   new Consent(consent.entityType, consent.state, consent.entity);
 
 export type SafeGroupMember = {
-  accountAddresses: string[];
+  accountIdentifiers: Identifier[];
   consentState: ConsentState;
   inboxId: string;
   installationIds: string[];
@@ -431,7 +432,7 @@ export type SafeGroupMember = {
 };
 
 export const toSafeGroupMember = (member: GroupMember): SafeGroupMember => ({
-  accountAddresses: member.accountAddresses,
+  accountIdentifiers: member.accountIdentifiers,
   consentState: member.consentState,
   inboxId: member.inboxId,
   installationIds: member.installationIds,
@@ -441,7 +442,7 @@ export const toSafeGroupMember = (member: GroupMember): SafeGroupMember => ({
 export const fromSafeGroupMember = (member: SafeGroupMember): GroupMember =>
   new GroupMember(
     member.inboxId,
-    member.accountAddresses,
+    member.accountIdentifiers,
     member.installationIds,
     member.permissionLevel,
     member.consentState,

package/src/utils/createClient.ts

@@ -1,28 +1,24 @@
-import init, {
+import {
   createClient as createWasmClient,
   generateInboxId,
-  getInboxIdForAddress,
+  getInboxIdForIdentifier,
   LogOptions,
+  type Identifier,
 } from "@xmtp/wasm-bindings";
 import { ApiUrls, HistorySyncUrls } from "@/constants";
 import type { ClientOptions } from "@/types";
 
 export const createClient = async (
-  accountAddress: string,
+  identifier: Identifier,
   encryptionKey: Uint8Array,
   options?: Omit<ClientOptions, "codecs">,
 ) => {
-  // initialize WASM module
-  await init();
-
   const host = options?.apiUrl || ApiUrls[options?.env || "dev"];
-  const dbPath =
-    options?.dbPath || `xmtp-${options?.env || "dev"}-${accountAddress}.db3`;
-
   const inboxId =
-    (await getInboxIdForAddress(host, accountAddress)) ||
-    generateInboxId(accountAddress);
-
+    (await getInboxIdForIdentifier(host, identifier)) ||
+    generateInboxId(identifier);
+  const dbPath =
+    options?.dbPath || `xmtp-${options?.env || "dev"}-${inboxId}.db3`;
   const isLogging =
     options &&
     (options.loggingLevel !== undefined ||
@@ -35,7 +31,7 @@ export const createClient = async (
   return createWasmClient(
     host,
     inboxId,
-    accountAddress,
+    identifier,
     dbPath,
     encryptionKey,
     historySyncUrl,

package/src/utils/signer.ts

@@ -1,18 +1,23 @@
+import type { Identifier } from "@xmtp/wasm-bindings";
+
 export type SignMessage = (message: string) => Promise<Uint8Array> | Uint8Array;
-export type GetAddress = () => Promise<string> | string;
+export type GetIdentifier = () => Promise<Identifier> | Identifier;
 export type GetChainId = () => bigint;
 export type GetBlockNumber = () => bigint;
 
 export type Signer =
   | {
-      walletType: "EOA";
-      getAddress: GetAddress;
+      type: "EOA";
+      getIdentifier: GetIdentifier;
       signMessage: SignMessage;
     }
   | {
-      walletType: "SCW";
-      getAddress: GetAddress;
+      type: "SCW";
+      getIdentifier: GetIdentifier;
       signMessage: SignMessage;
       getBlockNumber?: GetBlockNumber;
       getChainId: GetChainId;
     };
+
+export type EOASigner = Extract<Signer, { type: "EOA" }>;
+export type SCWSigner = Extract<Signer, { type: "SCW" }>;

package/src/workers/client.ts

@@ -1,9 +1,9 @@
-import type {
-  Consent,
-  Conversation,
-  Message,
-  StreamCloser,
-  UserPreference,
+import init, {
+  type Consent,
+  type Conversation,
+  type Message,
+  type StreamCloser,
+  type UserPreference,
 } from "@xmtp/wasm-bindings";
 import type {
   ClientEventsActions,
@@ -73,11 +73,14 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
     console.log("client worker received event data", event.data);
   }
 
+  // initialize WASM module
+  await init();
+
   try {
     // init is a special action that initializes the client
     if (action === "init" && !maybeClient) {
       maybeClient = await WorkerClient.create(
-        data.address,
+        data.identifier,
         data.encryptionKey,
         data.options,
       );
@@ -138,16 +141,12 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         break;
       }
       case "addAccountSignatureText": {
-        const result = await client.addAccountSignatureText(
-          data.newAccountAddress,
-        );
+        const result = await client.addAccountSignatureText(data.newIdentifier);
         postMessage({ id, action, result });
         break;
       }
       case "removeAccountSignatureText": {
-        const result = await client.removeAccountSignatureText(
-          data.accountAddress,
-        );
+        const result = await client.removeAccountSignatureText(data.identifier);
         postMessage({ id, action, result });
         break;
       }
@@ -163,8 +162,8 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         postMessage({ id, action, result });
         break;
       }
-      case "addSignature":
-        await client.addSignature(data.type, data.bytes);
+      case "addEcdsaSignature":
+        await client.addEcdsaSignature(data.type, data.bytes);
         postMessage({ id, action, result: undefined });
         break;
       case "addScwSignature":
@@ -190,7 +189,7 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         break;
       }
       case "canMessage": {
-        const result = await client.canMessage(data.accountAddresses);
+        const result = await client.canMessage(data.identifiers);
         postMessage({ id, action, result });
         break;
       }
@@ -219,8 +218,8 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         postMessage({ id, action, result });
         break;
       }
-      case "findInboxIdByAddress": {
-        const result = await client.findInboxIdByAddress(data.address);
+      case "findInboxIdByIdentifier": {
+        const result = await client.findInboxIdByIdentifier(data.identifier);
         postMessage({ id, action, result });
         break;
       }
@@ -388,17 +387,17 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         postMessage({ id, action, result });
         break;
       }
-      case "newGroup": {
-        const conversation = await client.conversations.newGroup(
-          data.accountAddresses,
+      case "newGroupWithIdentifiers": {
+        const conversation = await client.conversations.newGroupWithIdentifiers(
+          data.identifiers,
           data.options,
         );
         const result = await toSafeConversation(conversation);
         postMessage({ id, action, result });
         break;
       }
-      case "newGroupByInboxIds": {
-        const conversation = await client.conversations.newGroupByInboxIds(
+      case "newGroupWithInboxIds": {
+        const conversation = await client.conversations.newGroup(
           data.inboxIds,
           data.options,
         );
@@ -406,17 +405,17 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         postMessage({ id, action, result });
         break;
       }
-      case "newDm": {
-        const conversation = await client.conversations.newDm(
-          data.accountAddress,
+      case "newDmWithIdentifier": {
+        const conversation = await client.conversations.newDmWithIdentifier(
+          data.identifier,
           data.options,
         );
         const result = await toSafeConversation(conversation);
         postMessage({ id, action, result });
         break;
       }
-      case "newDmByInboxId": {
-        const conversation = await client.conversations.newDmByInboxId(
+      case "newDmWithInboxId": {
+        const conversation = await client.conversations.newDm(
           data.inboxId,
           data.options,
         );
@@ -588,25 +587,25 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
       }
       case "addGroupMembers": {
         const group = getGroup(data.id);
-        await group.addMembers(data.accountAddresses);
+        await group.addMembersByIdentifiers(data.identifiers);
         postMessage({ id, action, result: undefined });
         break;
       }
       case "removeGroupMembers": {
         const group = getGroup(data.id);
-        await group.removeMembers(data.accountAddresses);
+        await group.removeMembersByIdentifiers(data.identifiers);
         postMessage({ id, action, result: undefined });
         break;
       }
       case "addGroupMembersByInboxId": {
         const group = getGroup(data.id);
-        await group.addMembersByInboxId(data.inboxIds);
+        await group.addMembers(data.inboxIds);
         postMessage({ id, action, result: undefined });
         break;
       }
       case "removeGroupMembersByInboxId": {
         const group = getGroup(data.id);
-        await group.removeMembersByInboxId(data.inboxIds);
+        await group.removeMembers(data.inboxIds);
         postMessage({ id, action, result: undefined });
         break;
       }
@@ -697,6 +696,12 @@ self.onmessage = async (event: MessageEvent<ClientEventsClientMessageData>) => {
         postMessage({ id, action, result: undefined });
         break;
       }
+      case "getGroupPausedForVersion": {
+        const group = getGroup(data.id);
+        const result = group.pausedForVersion();
+        postMessage({ id, action, result });
+        break;
+      }
     }
   } catch (e) {
     postMessageError({

package/src/workers/utils.ts

@@ -1,6 +1,7 @@
 import init, {
-  generateInboxId as generate_inbox_id,
-  getInboxIdForAddress as get_inbox_id_for_address,
+  generateInboxId,
+  getInboxIdForIdentifier as get_inbox_id_for_identifier,
+  type Identifier,
 } from "@xmtp/wasm-bindings";
 import { ApiUrls } from "@/constants";
 import type {
@@ -27,15 +28,12 @@ const postMessageError = (data: UtilsEventsErrorData) => {
   self.postMessage(data);
 };
 
-export const generateInboxId = async (address: string) => {
-  await init();
-  return generate_inbox_id(address);
-};
-
-export const getInboxIdForAddress = async (address: string, env?: XmtpEnv) => {
-  await init();
+const getInboxIdForIdentifier = async (
+  identifier: Identifier,
+  env?: XmtpEnv,
+) => {
   const host = env ? ApiUrls[env] : ApiUrls.dev;
-  return get_inbox_id_for_address(host, address);
+  return get_inbox_id_for_identifier(host, identifier);
 };
 
 self.onmessage = async (event: MessageEvent<UtilsEventsClientMessageData>) => {
@@ -44,20 +42,23 @@ self.onmessage = async (event: MessageEvent<UtilsEventsClientMessageData>) => {
     console.log("utils worker received event data", event.data);
   }
 
+  // initialize WASM module
+  await init();
+
   try {
     switch (action) {
       case "generateInboxId":
         postMessage({
           id,
           action,
-          result: await generateInboxId(data.address),
+          result: generateInboxId(data.identifier),
         });
         break;
-      case "getInboxIdForAddress":
+      case "getInboxIdForIdentifier":
         postMessage({
           id,
           action,
-          result: await getInboxIdForAddress(data.address, data.env),
+          result: await getInboxIdForIdentifier(data.identifier, data.env),
         });
         break;
       // no default