@xmtp/browser-sdk 6.4.1 → 7.0.0-dev.57a7203

package/src/types/actions/conversation.ts

@@ -8,12 +8,14 @@ import type {
   GroupMember,
   Intent,
   ListMessagesOptions,
+  Message,
   MessageDisappearingSettings,
   MultiRemoteAttachment,
   Reaction,
   RemoteAttachment,
   Reply,
   SendMessageOpts,
+  SendOpts,
   TransactionReference,
   WalletSendCalls,
 } from "@xmtp/wasm-bindings";
@@ -50,6 +52,15 @@ export type ConversationAction =
         id: string;
       };
     }
+  | {
+      action: "conversation.processStreamedMessage";
+      id: string;
+      result: Message[];
+      data: {
+        id: string;
+        envelopeBytes: Uint8Array;
+      };
+    }
   | {
       action: "conversation.messages";
       id: string;
@@ -189,7 +200,7 @@ export type ConversationAction =
       data: {
         id: string;
         text: string;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -199,7 +210,7 @@ export type ConversationAction =
       data: {
         id: string;
         markdown: string;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -209,7 +220,7 @@ export type ConversationAction =
       data: {
         id: string;
         reaction: Reaction;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -218,7 +229,7 @@ export type ConversationAction =
       result: string;
       data: {
         id: string;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -228,7 +239,7 @@ export type ConversationAction =
       data: {
         id: string;
         reply: Reply;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -238,7 +249,7 @@ export type ConversationAction =
       data: {
         id: string;
         transactionReference: TransactionReference;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -248,7 +259,7 @@ export type ConversationAction =
       data: {
         id: string;
         walletSendCalls: WalletSendCalls;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -258,7 +269,7 @@ export type ConversationAction =
       data: {
         id: string;
         actions: Actions;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -268,7 +279,7 @@ export type ConversationAction =
       data: {
         id: string;
         intent: Intent;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -278,7 +289,7 @@ export type ConversationAction =
       data: {
         id: string;
         attachment: Attachment;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -288,7 +299,7 @@ export type ConversationAction =
       data: {
         id: string;
         multiRemoteAttachment: MultiRemoteAttachment;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     }
   | {
@@ -298,6 +309,6 @@ export type ConversationAction =
       data: {
         id: string;
         remoteAttachment: RemoteAttachment;
-        isOptimistic?: boolean;
+        opts?: SendOpts;
       };
     };

package/src/types/options.ts

@@ -17,9 +17,13 @@ import type {
   RemoteAttachment,
   TransactionReference,
   WalletSendCalls,
+  WasmVisibilityConfirmationOptions,
+  WorkerConfigOptions,
 } from "@xmtp/wasm-bindings";
 import type { DecodedMessage } from "@/DecodedMessage";
 
+export type VisibilityConfirmationOptions = WasmVisibilityConfirmationOptions;
+
 export type XmtpEnv =
   | "local"
   | "dev"
@@ -115,10 +119,25 @@ export type OtherOptions = {
    * Logging level
    */
   loggingLevel?: LogLevel;
+  /**
+   * Tuning for the background worker scheduler (intervals, jitter, per-worker
+   * overrides, and disabled workers). All fields are optional; omitting this
+   * object preserves the default worker behavior.
+   *
+   * Intervals are specified in nanoseconds.
+   */
+  workerConfig?: WorkerConfigOptions;
   /**
    * Disable automatic registration when creating a client
    */
   disableAutoRegister?: boolean;
+  /**
+   * Options for waiting until client registration is visible on the network.
+   *
+   * When set, `registerIdentity` will wait for the specified quorum of nodes
+   * to confirm the registration before resolving.
+   */
+  waitForRegistrationVisible?: VisibilityConfirmationOptions;
 };
 
 export type ClientOptions = (NetworkOptions | { backend: Backend }) &

package/src/utils/WorkerBridge.ts

@@ -65,7 +65,7 @@ export class WorkerBridge<T extends UnknownAction> {
     });
     const promise = new Promise((resolve, reject) => {
       this.#promises.set(promiseId, {
-        resolve: resolve as (value: unknown) => void,
+        resolve: resolve,
         reject,
       });
     });

package/src/utils/createClient.ts

@@ -6,9 +6,15 @@ import {
   type Backend,
   type Identifier,
 } from "@xmtp/wasm-bindings";
-import type { ClientOptions, NetworkOptions } from "@/types/options";
+import type { ClientOptions } from "@/types/options";
 import { createBackend, envToString } from "@/utils/createBackend";
 
+type CreateClientOptions = ClientOptions extends infer T
+  ? T extends ClientOptions
+    ? Omit<T, "codecs">
+    : never
+  : never;
+
 const networkOptionKeys = [
   "env",
   "apiUrl",
@@ -21,7 +27,7 @@ const hasBackend = (options: object): options is { backend: Backend } => {
 };
 
 const resolveBackend = async (
-  options?: Omit<ClientOptions, "codecs">,
+  options?: CreateClientOptions,
 ): Promise<Backend> => {
   if (!options) {
     return createBackend();
@@ -43,12 +49,12 @@ const resolveBackend = async (
   }
 
   // No backend provided — build one from NetworkOptions
-  return createBackend(options as NetworkOptions);
+  return createBackend(options);
 };
 
 export const createClient = async (
   identifier: Identifier,
-  options?: Omit<ClientOptions, "codecs">,
+  options?: CreateClientOptions,
 ) => {
   const backend = await resolveBackend(options);
 
@@ -80,6 +86,7 @@ export const createClient = async (
     dbPath,
     options?.dbEncryptionKey,
     deviceSyncMode,
+    options?.workerConfig,
     isLogging
       ? {
           structured: options.structuredLogging ?? false,

package/src/utils/signer.ts

@@ -1,4 +1,6 @@
-import type { Identifier } from "@xmtp/wasm-bindings";
+import { IdentifierKind, type Identifier } from "@xmtp/wasm-bindings";
+import { toBytes } from "viem";
+import { generatePrivateKey, privateKeyToAccount } from "viem/accounts";
 
 type SignMessage = (message: string) => Promise<Uint8Array> | Uint8Array;
 type GetIdentifier = () => Promise<Identifier> | Identifier;
@@ -36,6 +38,40 @@ export type SafeSigner =
       blockNumber?: bigint;
     };
 
+export const createEOASigner = (key = generatePrivateKey()): Signer => {
+  const account = privateKeyToAccount(key);
+  return {
+    type: "EOA",
+    getIdentifier: () => ({
+      identifier: account.address.toLowerCase(),
+      identifierKind: IdentifierKind.Ethereum,
+    }),
+    signMessage: async (message: string) => {
+      const signature = await account.signMessage({ message });
+      return toBytes(signature);
+    },
+  };
+};
+
+export const createSCWSigner = (
+  address: `0x${string}`,
+  signMessage: (message: string) => Promise<string> | string,
+  chainId: bigint,
+): Signer => {
+  return {
+    type: "SCW",
+    getIdentifier: () => ({
+      identifier: address.toLowerCase(),
+      identifierKind: IdentifierKind.Ethereum,
+    }),
+    signMessage: async (message: string) => {
+      const signature = await signMessage(message);
+      return toBytes(signature);
+    },
+    getChainId: () => chainId,
+  };
+};
+
 export const toSafeSigner = async (
   signer: Signer,
   signature: Uint8Array,

package/src/workers/client.ts

@@ -235,7 +235,11 @@ self.onmessage = async (
         if (!signatureRequest) {
           throw new Error("Signature request not found");
         }
-        await client.registerIdentity(data.signer, signatureRequest);
+        await client.registerIdentity(
+          data.signer,
+          signatureRequest,
+          data.waitForRegistrationVisible,
+        );
         signatureRequests.delete(data.signatureRequestId);
         postMessage({ id, action, result: undefined });
         break;
@@ -300,6 +304,16 @@ self.onmessage = async (
         postMessage({ id, action, result });
         break;
       }
+      case "client.fetchLatestInboxUpdatesCount": {
+        const result = await client.fetchLatestInboxUpdatesCount(data.inboxIds);
+        postMessage({ id, action, result });
+        break;
+      }
+      case "client.fetchOwnInboxUpdatesCount": {
+        const result = await client.fetchOwnInboxUpdatesCount();
+        postMessage({ id, action, result });
+        break;
+      }
       case "client.getInboxIdByIdentifier": {
         const result = await client.getInboxIdByIdentifier(data.identifier);
         postMessage({ id, action, result });
@@ -343,6 +357,41 @@ self.onmessage = async (
         postMessage({ id, action, result: undefined });
         break;
       }
+      case "client.sendSyncArchive": {
+        await client.sendSyncArchive(data.options, data.serverUrl, data.pin);
+        postMessage({ id, action, result: undefined });
+        break;
+      }
+      case "client.processSyncArchive": {
+        await client.processSyncArchive(data.archivePin);
+        postMessage({ id, action, result: undefined });
+        break;
+      }
+      case "client.listAvailableArchives": {
+        const result = client.listAvailableArchives(data.daysCutoff);
+        postMessage({ id, action, result });
+        break;
+      }
+      case "client.createArchive": {
+        const result = await client.createArchive(data.opts, data.key);
+        postMessage({ id, action, result });
+        break;
+      }
+      case "client.importArchive": {
+        await client.importArchive(data.data, data.key);
+        postMessage({ id, action, result: undefined });
+        break;
+      }
+      case "client.archiveMetadata": {
+        const result = await client.archiveMetadata(data.data, data.key);
+        postMessage({ id, action, result });
+        break;
+      }
+      case "client.syncAllDeviceSyncGroups": {
+        const result = await client.syncAllDeviceSyncGroups();
+        postMessage({ id, action, result });
+        break;
+      }
       /**
        * Debug information actions
        */
@@ -778,6 +827,12 @@ self.onmessage = async (
         postMessage({ id, action, result: undefined });
         break;
       }
+      case "conversation.processStreamedMessage": {
+        const group = getGroup(data.id);
+        const result = await group.processStreamedMessage(data.envelopeBytes);
+        postMessage({ id, action, result });
+        break;
+      }
       case "conversation.messages": {
         const group = getGroup(data.id);
         const messages = await group.messages(data.options);
@@ -1002,37 +1057,31 @@ self.onmessage = async (
       }
       case "conversation.sendText": {
         const group = getGroup(data.id);
-        const result = await group.sendText(data.text, data.isOptimistic);
+        const result = await group.sendText(data.text, data.opts);
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendMarkdown": {
         const group = getGroup(data.id);
-        const result = await group.sendMarkdown(
-          data.markdown,
-          data.isOptimistic,
-        );
+        const result = await group.sendMarkdown(data.markdown, data.opts);
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendReaction": {
         const group = getGroup(data.id);
-        const result = await group.sendReaction(
-          data.reaction,
-          data.isOptimistic,
-        );
+        const result = await group.sendReaction(data.reaction, data.opts);
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendReadReceipt": {
         const group = getGroup(data.id);
-        const result = await group.sendReadReceipt(data.isOptimistic);
+        const result = await group.sendReadReceipt(data.opts);
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendReply": {
         const group = getGroup(data.id);
-        const result = await group.sendReply(data.reply, data.isOptimistic);
+        const result = await group.sendReply(data.reply, data.opts);
         postMessage({ id, action, result });
         break;
       }
@@ -1040,7 +1089,7 @@ self.onmessage = async (
         const group = getGroup(data.id);
         const result = await group.sendTransactionReference(
           data.transactionReference,
-          data.isOptimistic,
+          data.opts,
         );
         postMessage({ id, action, result });
         break;
@@ -1049,29 +1098,26 @@ self.onmessage = async (
         const group = getGroup(data.id);
         const result = await group.sendWalletSendCalls(
           data.walletSendCalls,
-          data.isOptimistic,
+          data.opts,
         );
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendActions": {
         const group = getGroup(data.id);
-        const result = await group.sendActions(data.actions, data.isOptimistic);
+        const result = await group.sendActions(data.actions, data.opts);
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendIntent": {
         const group = getGroup(data.id);
-        const result = await group.sendIntent(data.intent, data.isOptimistic);
+        const result = await group.sendIntent(data.intent, data.opts);
         postMessage({ id, action, result });
         break;
       }
       case "conversation.sendAttachment": {
         const group = getGroup(data.id);
-        const result = await group.sendAttachment(
-          data.attachment,
-          data.isOptimistic,
-        );
+        const result = await group.sendAttachment(data.attachment, data.opts);
         postMessage({ id, action, result });
         break;
       }
@@ -1079,7 +1125,7 @@ self.onmessage = async (
         const group = getGroup(data.id);
         const result = await group.sendMultiRemoteAttachment(
           data.multiRemoteAttachment,
-          data.isOptimistic,
+          data.opts,
         );
         postMessage({ id, action, result });
         break;
@@ -1088,7 +1134,7 @@ self.onmessage = async (
         const group = getGroup(data.id);
         const result = await group.sendRemoteAttachment(
           data.remoteAttachment,
-          data.isOptimistic,
+          data.opts,
         );
         postMessage({ id, action, result });
         break;