@xmtp/browser-sdk 0.0.23 → 1.0.0

package/src/WorkerConversation.ts

@@ -4,6 +4,7 @@ import {
   type Conversation,
   type EncodedContent,
   type GroupMember,
+  type Identifier,
   type Message,
   type MetadataField,
   type PermissionPolicy,
@@ -121,19 +122,19 @@ export class WorkerConversation {
     return this.#group.sync();
   }
 
-  async addMembers(accountAddresses: string[]) {
-    return this.#group.addMembers(accountAddresses);
+  async addMembersByIdentifiers(identifiers: Identifier[]) {
+    return this.#group.addMembers(identifiers);
   }
 
-  async addMembersByInboxId(inboxIds: string[]) {
+  async addMembers(inboxIds: string[]) {
     return this.#group.addMembersByInboxId(inboxIds);
   }
 
-  async removeMembers(accountAddresses: string[]) {
-    return this.#group.removeMembers(accountAddresses);
+  async removeMembersByIdentifiers(identifiers: Identifier[]) {
+    return this.#group.removeMembers(identifiers);
   }
 
-  async removeMembersByInboxId(inboxIds: string[]) {
+  async removeMembers(inboxIds: string[]) {
     return this.#group.removeMembersByInboxId(inboxIds);
   }
 
@@ -209,4 +210,8 @@ export class WorkerConversation {
     };
     return this.#group.stream({ on_message, on_error });
   }
+
+  pausedForVersion() {
+    return this.#group.pausedForVersion();
+  }
 }

package/src/WorkerConversations.ts

@@ -1,12 +1,11 @@
 import {
   ConversationType,
-  type Consent,
   type ConsentState,
   type Conversation,
   type ConversationListItem,
   type Conversations,
+  type Identifier,
   type Message,
-  type UserPreference,
 } from "@xmtp/wasm-bindings";
 import type { StreamCallback } from "@/AsyncStream";
 import {
@@ -96,18 +95,18 @@ export class WorkerConversations {
     );
   }
 
-  async newGroup(accountAddresses: string[], options?: SafeCreateGroupOptions) {
+  async newGroupWithIdentifiers(
+    identifiers: Identifier[],
+    options?: SafeCreateGroupOptions,
+  ) {
     const group = await this.#conversations.createGroup(
-      accountAddresses,
+      identifiers,
       options ? fromSafeCreateGroupOptions(options) : undefined,
     );
     return new WorkerConversation(this.#client, group);
   }
 
-  async newGroupByInboxIds(
-    inboxIds: string[],
-    options?: SafeCreateGroupOptions,
-  ) {
+  async newGroup(inboxIds: string[], options?: SafeCreateGroupOptions) {
     const group = await this.#conversations.createGroupByInboxIds(
       inboxIds,
       options ? fromSafeCreateGroupOptions(options) : undefined,
@@ -115,15 +114,18 @@ export class WorkerConversations {
     return new WorkerConversation(this.#client, group);
   }
 
-  async newDm(accountAddress: string, options?: SafeCreateDmOptions) {
+  async newDmWithIdentifier(
+    identifier: Identifier,
+    options?: SafeCreateDmOptions,
+  ) {
     const group = await this.#conversations.createDm(
-      accountAddress,
+      identifier,
       options ? fromSafeCreateDmOptions(options) : undefined,
     );
     return new WorkerConversation(this.#client, group);
   }
 
-  async newDmByInboxId(inboxId: string, options?: SafeCreateDmOptions) {
+  async newDm(inboxId: string, options?: SafeCreateDmOptions) {
     const group = await this.#conversations.createDmByInboxId(
       inboxId,
       options ? fromSafeCreateDmOptions(options) : undefined,
@@ -174,27 +176,4 @@ export class WorkerConversations {
       conversationType,
     );
   }
-
-  streamConsent(callback?: StreamCallback<Consent[]>) {
-    const on_consent_update = (consent: Consent[]) => {
-      void callback?.(null, consent);
-    };
-    const on_error = (error: Error | null) => {
-      void callback?.(error, undefined);
-    };
-    return this.#conversations.streamConsent({ on_consent_update, on_error });
-  }
-
-  streamPreferences(callback?: StreamCallback<UserPreference[]>) {
-    const on_user_preference_update = (preferences: UserPreference[]) => {
-      void callback?.(null, preferences);
-    };
-    const on_error = (error: Error | null) => {
-      void callback?.(error, undefined);
-    };
-    return this.#conversations.streamPreferences({
-      on_user_preference_update,
-      on_error,
-    });
-  }
 }

package/src/WorkerPreferences.ts

@@ -0,0 +1,58 @@
+import {
+  type Client,
+  type Consent,
+  type ConsentEntityType,
+  type Conversations,
+  type UserPreference,
+} from "@xmtp/wasm-bindings";
+import type { StreamCallback } from "@/AsyncStream";
+import { fromSafeConsent, type SafeConsent } from "@/utils/conversions";
+
+export class WorkerPreferences {
+  #client: Client;
+  #conversations: Conversations;
+
+  constructor(client: Client, conversations: Conversations) {
+    this.#client = client;
+    this.#conversations = conversations;
+  }
+
+  async inboxState(refreshFromNetwork: boolean) {
+    return this.#client.inboxState(refreshFromNetwork);
+  }
+
+  async getLatestInboxState(inboxId: string) {
+    return this.#client.getLatestInboxState(inboxId);
+  }
+
+  async setConsentStates(records: SafeConsent[]) {
+    return this.#client.setConsentStates(records.map(fromSafeConsent));
+  }
+
+  async getConsentState(entityType: ConsentEntityType, entity: string) {
+    return this.#client.getConsentState(entityType, entity);
+  }
+
+  streamConsent(callback?: StreamCallback<Consent[]>) {
+    const on_consent_update = (consent: Consent[]) => {
+      void callback?.(null, consent);
+    };
+    const on_error = (error: Error | null) => {
+      void callback?.(error, undefined);
+    };
+    return this.#conversations.streamConsent({ on_consent_update, on_error });
+  }
+
+  streamPreferences(callback?: StreamCallback<UserPreference[]>) {
+    const on_user_preference_update = (preferences: UserPreference[]) => {
+      void callback?.(null, preferences);
+    };
+    const on_error = (error: Error | null) => {
+      void callback?.(error, undefined);
+    };
+    return this.#conversations.streamPreferences({
+      on_user_preference_update,
+      on_error,
+    });
+  }
+}

package/src/index.ts

@@ -9,7 +9,11 @@ export { Utils } from "./Utils";
 export { ApiUrls, HistorySyncUrls } from "./constants";
 export type * from "./types";
 export * from "./utils/conversions";
-export type { UserPreference } from "@xmtp/wasm-bindings";
+export type {
+  Identifier,
+  IdentifierKind,
+  UserPreference,
+} from "@xmtp/wasm-bindings";
 export {
   Consent,
   ConsentEntityType,
@@ -37,6 +41,7 @@ export {
   Message,
   MessageDisappearingSettings,
   MetadataField,
+  Opfs,
   PermissionLevel,
   PermissionPolicy,
   PermissionPolicySet,

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" }>;