Allow passing a backend into static methods

apps/xmtp.chat/src/components/App/AppLayout.tsx

@@ -43,12 +43,10 @@ export const AppLayout: React.FC = () => {
   }, [client]);
 
   useEffect(() => {
-    if (!client) {
+    const sessionSdkEnv = client?.env;
+    if (!client || !sessionSdkEnv) {
       return;
     }
-
-    // the session's actual SDK environment from client options
-    const sessionSdkEnv = client.options?.env ?? "dev";
     const isInvalidEnvironment =
       !envParam ||
       !isValidEnvironment(envParam) ||

apps/xmtp.chat/src/components/Conversations/ConversationsNavbar.tsx

@@ -1,4 +1,8 @@
 import { Badge, Box, Group, Stack, Text } from "@mantine/core";
+import {
+  BackupElementSelectionOption,
+  HistorySyncUrls,
+} from "@xmtp/browser-sdk";
 import { useCallback, useEffect, useRef } from "react";
 import { ConversationsList } from "@/components/Conversations/ConversationList";
 import { ConversationsMenu } from "@/components/Conversations/ConversationsMenu";
@@ -48,7 +52,21 @@ export const ConversationsNavbar: React.FC = () => {
   }, [syncAll, startStreams, stopStreams]);
 
   const handleSendSyncRequest = useCallback(async () => {
-    await client.sendSyncRequest();
+    const env = client.env;
+    if (!env) {
+      return;
+    }
+    const serverUrl = HistorySyncUrls[env];
+    await client.sendSyncRequest(
+      {
+        elements: [
+          BackupElementSelectionOption.Messages,
+          BackupElementSelectionOption.Consent,
+        ],
+        excludeDisappearingMessages: false,
+      },
+      serverUrl,
+    );
   }, [client]);
 
   // loading conversations on mount, and start streaming

apps/xmtp.chat/src/contexts/XMTPContext.tsx

@@ -2,7 +2,9 @@ import {
   Client,
   type BuiltInContentTypes,
   type ClientOptions,
+  type NetworkOptions,
   type Signer,
+  type XmtpEnv,
 } from "@xmtp/browser-sdk";
 import {
   createContext,
@@ -20,7 +22,7 @@ export type ContentTypes = BuiltInContentTypes;
 export type InitializeClientOptions = {
   apiUrl?: string;
   dbEncryptionKey?: Uint8Array;
-  env?: ClientOptions["env"];
+  env?: XmtpEnv;
   loggingLevel?: ClientOptions["loggingLevel"];
   signer: Signer;
   gatewayHost?: string;
@@ -122,7 +124,7 @@ export const XMTPProvider: React.FC<XMTPProviderProps> = ({
             dbEncryptionKey,
             appVersion: "xmtp.chat/0",
             gatewayHost,
-          });
+          } as Omit<ClientOptions & NetworkOptions, "codecs">);
           setClient(xmtpClient);
         } catch (e) {
           setClient(undefined);

apps/xmtp.chat/src/helpers/attachment.ts

@@ -146,7 +146,7 @@ export const getFileType = (filename: string) => {
   }
 };
 
-export const formatFileSize = (fileSize: number) => {
+export const formatFileSize = (fileSize: number | undefined) => {
   if (!fileSize) return "";
   const kb = fileSize / 1024;
   if (kb < 1024) {

apps/xmtp.chat/src/helpers/names.ts

@@ -1,4 +1,5 @@
 import {
+  createBackend,
   getInboxIdForIdentifier,
   IdentifierKind,
   type XmtpEnv,
@@ -84,14 +85,11 @@ export const getInboxIdForAddress = async (
     return null;
   }
 
-  const inboxId = await getInboxIdForIdentifier(
-    {
-      identifier: address.toLowerCase(),
-      identifierKind: IdentifierKind.Ethereum,
-    },
-    environment,
-    gatewayHost,
-  );
+  const backend = await createBackend({ env: environment, gatewayHost });
+  const inboxId = await getInboxIdForIdentifier(backend, {
+    identifier: address.toLowerCase(),
+    identifierKind: IdentifierKind.Ethereum,
+  });
 
   return inboxId ?? null;
 };

content-types/content-type-primitives/package.json

@@ -62,7 +62,7 @@
     ]
   },
   "dependencies": {
-    "@xmtp/node-bindings": "1.9.1"
+    "@xmtp/node-bindings": "1.10.0-dev.2334796"
   },
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.4",

packages/xmtp-cli/package.json

@@ -88,7 +88,7 @@
     "@oclif/plugin-help": "^6.2.37",
     "@oclif/plugin-not-found": "^3.2.74",
     "@oclif/plugin-warn-if-update-available": "^3.1.55",
-    "@xmtp/node-sdk": "5.3.0",
+    "@xmtp/node-sdk": "5.4.0",
     "viem": "^2.44.4"
   },
   "devDependencies": {

packages/xmtp-cli/src/commands/client/info.ts

@@ -34,7 +34,8 @@ application instance using your identity.`;
   async run(): Promise<void> {
     const client = await this.initClient();
 
-    const options = client.options ?? {};
+    const options = client.options;
+    const hasNetworkOptions = options && "env" in options;
 
     const properties = {
       address: client.accountIdentifier?.identifier,
@@ -46,17 +47,17 @@ application instance using your identity.`;
     };
 
     const clientOptions = {
-      env: options.env,
-      apiUrl: options.apiUrl,
-      historySyncUrl: options.historySyncUrl,
-      gatewayHost: options.gatewayHost,
-      dbPath: options.dbPath,
-      loggingLevel: options.loggingLevel,
-      structuredLogging: options.structuredLogging,
-      disableAutoRegister: options.disableAutoRegister,
-      disableDeviceSync: options.disableDeviceSync,
-      appVersion: options.appVersion,
-      nonce: options.nonce,
+      env: client.env,
+      apiUrl: hasNetworkOptions ? options.apiUrl : undefined,
+      historySyncUrl: options?.historySyncUrl,
+      gatewayHost: hasNetworkOptions ? options.gatewayHost : undefined,
+      dbPath: options?.dbPath,
+      loggingLevel: options?.loggingLevel,
+      structuredLogging: options?.structuredLogging,
+      disableAutoRegister: options?.disableAutoRegister,
+      disableDeviceSync: options?.disableDeviceSync,
+      appVersion: hasNetworkOptions ? options.appVersion : undefined,
+      nonce: options?.nonce,
     };
 
     if (this.jsonOutput) {

packages/xmtp-cli/src/utils/client.ts

@@ -1,6 +1,12 @@
 import { mkdir } from "node:fs/promises";
 import { dirname } from "node:path";
-import { Client, IdentifierKind, LogLevel, type Signer } from "@xmtp/node-sdk";
+import {
+  Client,
+  IdentifierKind,
+  LogLevel,
+  type NetworkOptions,
+  type Signer,
+} from "@xmtp/node-sdk";
 import { isHex, toBytes } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
 import type { XmtpConfig } from "./config.js";
@@ -79,15 +85,19 @@ export async function createClient(config: XmtpConfig): Promise<Client> {
     await mkdir(dirname(config.dbPath), { recursive: true });
   }
 
-  const client = await Client.create(signer, {
+  const networkOptions: NetworkOptions = {
     env: config.env,
+    gatewayHost: config.gatewayHost,
+    appVersion: config.appVersion,
+  };
+
+  const client = await Client.create(signer, {
+    ...networkOptions,
     dbEncryptionKey: hexToBytes(config.dbEncryptionKey),
     dbPath: config.dbPath ?? undefined,
-    gatewayHost: config.gatewayHost,
     loggingLevel: parseLogLevel(config.logLevel),
     structuredLogging: config.structuredLogging,
     disableDeviceSync: config.disableDeviceSync,
-    appVersion: config.appVersion,
   });
 
   return client;

sdks/agent-sdk/package.json

@@ -66,7 +66,7 @@
   },
   "dependencies": {
     "@xmtp/content-type-primitives": "3.0.1",
-    "@xmtp/node-sdk": "5.3.0",
+    "@xmtp/node-sdk": "5.4.0",
     "viem": "^2.37.6"
   },
   "devDependencies": {

sdks/agent-sdk/src/core/Agent.ts

@@ -3,7 +3,6 @@ import fs from "node:fs";
 import path from "node:path";
 import type { ContentCodec } from "@xmtp/content-type-primitives";
 import {
-  ApiUrls,
   Client,
   DecodedMessage,
   Dm,
@@ -37,6 +36,7 @@ import {
   type Intent,
   type LeaveRequest,
   type MultiRemoteAttachment,
+  type NetworkOptions,
   type Reaction,
   type ReadReceipt,
   type RemoteAttachment,
@@ -127,6 +127,9 @@ export type AgentErrorMiddleware<ContentTypes = unknown> = (
   next: (err?: unknown) => Promise<void> | void,
 ) => Promise<void> | void;
 
+export type AgentCreateOptions<ContentCodecs extends ContentCodec[] = []> =
+  Omit<ClientOptions & NetworkOptions, "codecs"> & { codecs?: ContentCodecs };
+
 export type AgentStreamingOptions = Omit<StreamOptions, "onValue" | "onError">;
 
 export type StreamAllMessagesOptions<ContentTypes> = Parameters<
@@ -187,7 +190,7 @@ export class Agent<ContentTypes = unknown> extends EventEmitter<
   static async create<ContentCodecs extends ContentCodec[] = []>(
     signer: Parameters<typeof Client.create>[0],
     // Note: we need to omit this so that "Client.create" can correctly infer the codecs.
-    options?: Omit<ClientOptions, "codecs"> & { codecs?: ContentCodecs },
+    options?: AgentCreateOptions<ContentCodecs>,
   ) {
     const initializedOptions = { ...(options ?? {}) };
     initializedOptions.appVersion ??= `agent-sdk/${appVersion}`;
@@ -225,7 +228,7 @@ export class Agent<ContentTypes = unknown> extends EventEmitter<
 
   static async createFromEnv<ContentCodecs extends ContentCodec[] = []>(
     // Note: we need to omit this so that "Client.create" can correctly infer the codecs.
-    options?: Omit<ClientOptions, "codecs"> & { codecs?: ContentCodecs },
+    options?: AgentCreateOptions<ContentCodecs>,
   ) {
     const {
       XMTP_DB_DIRECTORY,
@@ -253,7 +256,16 @@ export class Agent<ContentTypes = unknown> extends EventEmitter<
           : `0x${XMTP_DB_ENCRYPTION_KEY}`
         : undefined;
 
-    if (XMTP_ENV && Object.keys(ApiUrls).includes(XMTP_ENV)) {
+    const validEnvs: XmtpEnv[] = [
+      "local",
+      "dev",
+      "production",
+      "testnet-staging",
+      "testnet-dev",
+      "testnet",
+      "mainnet",
+    ];
+    if (XMTP_ENV && validEnvs.includes(XMTP_ENV as XmtpEnv)) {
       initializedOptions.env = XMTP_ENV as XmtpEnv;
     }
 

sdks/agent-sdk/src/debug/log.ts

@@ -31,19 +31,19 @@ export const parseLogLevel = (rawLevel: string) => {
 
 export const logDetails = async <ContentTypes>(agent: Agent<ContentTypes>) => {
   const xmtp = `\x1b[38;2;252;76;52m
-    ██╗  ██╗███╗   ███╗████████╗██████╗ 
+    ██╗  ██╗███╗   ███╗████████╗██████╗
     ╚██╗██╔╝████╗ ████║╚══██╔══╝██╔══██╗
      ╚███╔╝ ██╔████╔██║   ██║   ██████╔╝
-     ██╔██╗ ██║╚██╔╝██║   ██║   ██╔═══╝ 
-    ██╔╝ ██╗██║ ╚═╝ ██║   ██║   ██║     
-    ╚═╝  ╚═╝╚═╝     ╚═╝   ╚═╝   ╚═╝     
+     ██╔██╗ ██║╚██╔╝██║   ██║   ██╔═══╝
+    ██╔╝ ██╗██║ ╚═╝ ██║   ██║   ██║
+    ╚═╝  ╚═╝╚═╝     ╚═╝   ╚═╝   ╚═╝
   \x1b[0m`;
 
   const client = agent.client;
   const clientsByAddress = client.accountIdentifier?.identifier;
   const inboxId = client.inboxId;
   const installationId = client.installationId;
-  const env = client.options?.env ?? "dev";
+  const env = client.env;
 
   const urls = [`http://xmtp.chat/${env}/dm/${clientsByAddress}`];
 
@@ -64,7 +64,7 @@ export const logDetails = async <ContentTypes>(agent: Agent<ContentTypes>) => {
   }
   console.log(`
     ${xmtp}
-    
+
     ✓ XMTP Client:
     • InboxId: ${inboxId}
     • LibXMTP Version: ${agent.libxmtpVersion}
@@ -86,7 +86,7 @@ export const logDetails = async <ContentTypes>(agent: Agent<ContentTypes>) => {
  */
 export const getTestUrl = <ContentTypes>(client: Client<ContentTypes>) => {
   const address = client.accountIdentifier?.identifier;
-  const env = client.options?.env ?? "dev";
+  const env = client.env;
   return `http://xmtp.chat/${env}/dm/${address}`;
 };
 
@@ -103,10 +103,15 @@ export const getInstallationInfo = async <ContentTypes>(
   const myInboxId = client.inboxId;
   const myInstallationId = client.installationId;
 
+  const env = client.env;
+  const gatewayHost =
+    client.options && "gatewayHost" in client.options
+      ? client.options.gatewayHost
+      : undefined;
   const inboxStates = await Client.fetchInboxStates(
     [myInboxId],
-    client.options?.env,
-    client.options?.gatewayHost,
+    env,
+    gatewayHost,
   );
 
   const installations =

sdks/agent-sdk/src/util/test.ts

@@ -3,11 +3,16 @@ import {
   type ContentTypeId,
   type EncodedContent,
 } from "@xmtp/content-type-primitives";
-import { Client, generateInboxId, type ClientOptions } from "@xmtp/node-sdk";
+import {
+  Client,
+  generateInboxId,
+  type ClientOptions,
+  type NetworkOptions,
+} from "@xmtp/node-sdk";
 import { createSigner, createUser } from "@/user/User";
 
 export const createClient = async <ContentCodecs extends ContentCodec[] = []>(
-  options?: Omit<ClientOptions, "codecs"> & {
+  options?: Omit<ClientOptions & NetworkOptions, "codecs"> & {
     codecs?: ContentCodecs;
   },
 ) => {
@@ -28,6 +33,8 @@ export const createClient = async <ContentCodecs extends ContentCodec[] = []>(
     historySyncUrl: undefined,
     disableDeviceSync: true,
     env: "local",
+  } as Omit<ClientOptions & NetworkOptions, "codecs"> & {
+    codecs?: ContentCodecs;
   });
 };
 

sdks/browser-sdk/package.json

@@ -61,7 +61,7 @@
   },
   "dependencies": {
     "@xmtp/content-type-primitives": "3.0.0",
-    "@xmtp/wasm-bindings": "1.9.1"
+    "@xmtp/wasm-bindings": "1.10.0-dev.2334796"
   },
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.4",