@xmtp/browser-sdk 6.5.0 → 7.0.0-dev.b5cdc06

package/README.md

@@ -57,6 +57,23 @@ pnpm install @xmtp/browser-sdk
 yarn add @xmtp/browser-sdk
 ```
 
+## Signer utilities
+
+The SDK exports `createEOASigner` and `createSCWSigner` helper functions for creating XMTP-compatible signers. These require `viem` as a peer dependency, which is optional and only needs to be installed if you use these utilities.
+
+```bash
+npm install viem
+```
+
+**Example**
+
+```ts
+import { createEOASigner } from "@xmtp/browser-sdk";
+
+// Create an EOA signer (generates a random key if none provided)
+const eoaSigner = createEOASigner();
+```
+
 ## Developing
 
 Run `yarn dev` to build the SDK and watch for changes, which will trigger a rebuild.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _xmtp_wasm_bindings from '@xmtp/wasm-bindings';
-import { ContentTypeId as ContentTypeId$1, DeliveryStatus, GroupMessageKind, Reaction, DecodedMessage as DecodedMessage$1, LeaveRequest, ReadReceipt, Attachment, RemoteAttachment, TransactionReference, WalletSendCalls, Actions, Intent, MultiRemoteAttachment, GroupUpdated, DeletedMessage, LogLevel, Identifier, Conversations as Conversations$1, ConsentState, ListConversationsOptions, CreateGroupOptions, CreateDmOptions, Conversation as Conversation$1, ConversationType, Message, Client as Client$1, Consent, ConsentEntityType, UserPreferenceUpdate, SignatureRequestHandle, KeyPackageStatus, GroupMember, PermissionUpdateType, PermissionPolicy, MetadataField, EncodedContent, SendMessageOpts, Reply, ListMessagesOptions, MessageDisappearingSettings, HmacKey, ConversationDebugInfo, GroupPermissionsOptions, PermissionPolicySet, GroupMetadata, ApiStats, IdentityStats, InboxState, GroupSyncSummary } from '@xmtp/wasm-bindings';
-export { Action, ActionStyle, Actions, ApiStats, Attachment, Consent, ConsentEntityType, ConsentState, ContentType, ConversationDebugInfo, ConversationListItem, ConversationType, CreateDmOptions, CreateGroupOptions, Cursor, DeliveryStatus, EncryptedAttachment, GroupMember, GroupMembershipState, GroupMessageKind, GroupMetadata, GroupPermissions, GroupPermissionsOptions, GroupSyncSummary, GroupUpdated, HmacKey, Identifier, IdentifierKind, IdentityStats, Inbox, InboxState, Installation, Intent, KeyPackageStatus, LeaveRequest, Lifetime, ListConversationsOptions, ListConversationsOrderBy, ListMessagesOptions, LogLevel, LogOptions, Message, MessageDisappearingSettings, MessageSortBy, MetadataField, MetadataFieldChange, MultiRemoteAttachment, PermissionLevel, PermissionPolicy, PermissionPolicySet, PermissionUpdateType, Reaction, ReactionAction, ReactionSchema, ReadReceipt, RemoteAttachment, RemoteAttachmentInfo, Reply, SendMessageOpts, SignatureRequestHandle, SortDirection, TransactionMetadata, TransactionReference, UserPreferenceUpdate, WalletCall, WalletSendCalls } from '@xmtp/wasm-bindings';
+import { ContentTypeId as ContentTypeId$1, DeliveryStatus, GroupMessageKind, Reaction, DecodedMessage as DecodedMessage$1, LeaveRequest, ReadReceipt, Attachment, RemoteAttachment, TransactionReference, WalletSendCalls, Actions, Intent, MultiRemoteAttachment, GroupUpdated, DeletedMessage, Backend, LogLevel, WorkerConfigOptions, WasmVisibilityConfirmationOptions, Identifier, Conversations as Conversations$1, ConsentState, ListConversationsOptions, CreateGroupOptions, CreateDmOptions, Conversation as Conversation$1, ConversationType, Message, Client as Client$1, Consent, ConsentEntityType, UserPreferenceUpdate, SignatureRequestHandle, KeyPackageStatus, ArchiveOptions, AvailableArchiveInfo, ArchiveMetadata, GroupSyncSummary, GroupMember, PermissionUpdateType, PermissionPolicy, MetadataField, EncodedContent, SendMessageOpts, Reply, ListMessagesOptions, MessageDisappearingSettings, HmacKey, ConversationDebugInfo, GroupPermissionsOptions, PermissionPolicySet, GroupMetadata, ApiStats, IdentityStats, InboxState } from '@xmtp/wasm-bindings';
+export { Action, ActionStyle, Actions, ApiStats, ArchiveMetadata, ArchiveOptions, Attachment, AvailableArchiveInfo, Backend, BackendBuilder, BackupElementSelectionOption, Consent, ConsentEntityType, ConsentState, ContentType, ConversationDebugInfo, ConversationListItem, ConversationType, CreateDmOptions, CreateGroupOptions, Cursor, DeliveryStatus, EncryptedAttachment, GroupMember, GroupMembershipState, GroupMessageKind, GroupMetadata, GroupPermissions, GroupPermissionsOptions, GroupSyncSummary, GroupUpdated, HmacKey, Identifier, IdentifierKind, IdentityStats, Inbox, InboxState, Installation, Intent, KeyPackageStatus, LeaveRequest, Lifetime, ListConversationsOptions, ListConversationsOrderBy, ListMessagesOptions, LogLevel, LogOptions, Message, MessageDisappearingSettings, MessageSortBy, MetadataField, MetadataFieldChange, MultiRemoteAttachment, PermissionLevel, PermissionPolicy, PermissionPolicySet, PermissionUpdateType, Reaction, ReactionAction, ReactionSchema, ReadReceipt, RemoteAttachment, Reply, SendMessageOpts, SignatureRequestHandle, SortDirection, TransactionMetadata, TransactionReference, UserPreferenceUpdate, WalletCall, WalletSendCalls, WorkerConfigOptions, WorkerIntervalOverride, WorkerKind } from '@xmtp/wasm-bindings';
 import { ContentCodec, ContentTypeId } from '@xmtp/content-type-primitives';
 
 type ResolveValue<T> = {
@@ -82,33 +82,6 @@ type StreamValueMutator<T = unknown, V = T> = (value: T) => V | Promise<V>;
  */
 declare const createStream: <T = unknown, V = T>(streamFunction: StreamFunction<T>, streamValueMutator?: StreamValueMutator<T, V | undefined>, options?: StreamOptions<T, V>) => Promise<AsyncStreamProxy<V>>;
 
-/**
- * Pre-configured URLs for the XMTP network based on the environment
- *
- * @constant
- * @property {string} local - The local URL for the XMTP network
- * @property {string} dev - The development URL for the XMTP network
- * @property {string} production - The production URL for the XMTP network
- */
-declare const ApiUrls: {
-    readonly local: "http://localhost:5557";
-    readonly dev: "https://api.dev.xmtp.network:5558";
-    readonly production: "https://api.production.xmtp.network:5558";
-};
-/**
- * Pre-configured URLs for the XMTP history sync service based on the environment
- *
- * @constant
- * @property {string} local - The local URL for the XMTP history sync service
- * @property {string} dev - The development URL for the XMTP history sync service
- * @property {string} production - The production URL for the XMTP history sync service
- */
-declare const HistorySyncUrls: {
-    readonly local: "http://localhost:5558";
-    readonly dev: "https://message-history.dev.ephemera.network";
-    readonly production: "https://message-history.production.ephemera.network";
-};
-
 declare class CodecRegistry {
     #private;
     constructor(codecs: ContentCodec[]);
@@ -158,7 +131,8 @@ declare class DecodedMessage<ContentTypes = unknown> {
     constructor(codecRegistry: CodecRegistry, message: DecodedMessage$1);
 }
 
-type XmtpEnv = keyof typeof ApiUrls;
+type VisibilityConfirmationOptions = WasmVisibilityConfirmationOptions;
+type XmtpEnv = "local" | "dev" | "production" | "testnet-staging" | "testnet-dev" | "testnet" | "mainnet";
 /**
  * Network options
  */
@@ -172,15 +146,28 @@ type NetworkOptions = {
      * specific endpoint
      */
     apiUrl?: string;
+    /**
+     * gatewayHost can be used to override the gateway endpoint
+     */
+    gatewayHost?: string;
+    /**
+     * Custom app version
+     */
+    appVersion?: string;
+};
+/**
+ * Device sync options
+ */
+type DeviceSyncOptions = {
     /**
      * historySyncUrl can be used to override the `env` flag and connect to a
      * specific endpoint for syncing history
      */
     historySyncUrl?: string | null;
     /**
-     * gatewayHost can be used to override the gateway endpoint
+     * Disable device sync
      */
-    gatewayHost?: string | null;
+    disableDeviceSync?: boolean;
 };
 type ContentOptions = {
     /**
@@ -229,19 +216,28 @@ type OtherOptions = {
      */
     loggingLevel?: LogLevel;
     /**
-     * Disable automatic registration when creating a client
+     * 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.
      */
-    disableAutoRegister?: boolean;
+    workerConfig?: WorkerConfigOptions;
     /**
-     * Disable device sync
+     * Disable automatic registration when creating a client
      */
-    disableDeviceSync?: boolean;
+    disableAutoRegister?: boolean;
     /**
-     * Custom app version
+     * 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.
      */
-    appVersion?: string;
+    waitForRegistrationVisible?: VisibilityConfirmationOptions;
 };
-type ClientOptions = NetworkOptions & ContentOptions & StorageOptions & OtherOptions;
+type ClientOptions = (NetworkOptions | {
+    backend: Backend;
+}) & DeviceSyncOptions & ContentOptions & StorageOptions & OtherOptions;
 type EnrichedReply<T = unknown, U = unknown> = {
     referenceId: string;
     content: T;
@@ -283,6 +279,8 @@ type SafeSigner = {
     chainId: bigint;
     blockNumber?: bigint;
 };
+declare const createEOASigner: (key?: `0x${string}`) => Signer;
+declare const createSCWSigner: (address: `0x${string}`, signMessage: (message: string) => Promise<string> | string, chainId: bigint) => Signer;
 declare const toSafeSigner: (signer: Signer, signature: Uint8Array) => Promise<SafeSigner>;
 
 declare class WorkerConversations {
@@ -337,10 +335,11 @@ declare class WorkerPreferences {
 
 declare class WorkerClient {
     #private;
-    constructor(client: Client$1);
+    constructor(client: Client$1, env: XmtpEnv);
     static create(identifier: Identifier, options?: Omit<ClientOptions, "codecs">): Promise<WorkerClient>;
     get libxmtpVersion(): string;
     get appVersion(): string;
+    get env(): XmtpEnv;
     get accountIdentifier(): Identifier;
     get inboxId(): string;
     get installationId(): string;
@@ -350,6 +349,8 @@ declare class WorkerClient {
     get debugInformation(): WorkerDebugInformation;
     get preferences(): WorkerPreferences;
     canMessage(identifiers: Identifier[]): Promise<Map<string, boolean>>;
+    fetchLatestInboxUpdatesCount(inboxIds: string[]): Promise<Record<string, number>>;
+    fetchOwnInboxUpdatesCount(): Promise<number>;
     addSignature(signatureRequest: SignatureRequestHandle, signer: SafeSigner): Promise<void>;
     applySignatureRequest(signatureRequest: SignatureRequestHandle): Promise<void>;
     processSignatureRequest(signer: SafeSigner, signatureRequest: SignatureRequestHandle): Promise<void>;
@@ -359,13 +360,20 @@ declare class WorkerClient {
     revokeAllOtherInstallationsSignatureRequest(): Promise<SignatureRequestHandle | undefined>;
     revokeInstallationsSignatureRequest(installationIds: Uint8Array[]): Promise<SignatureRequestHandle>;
     changeRecoveryIdentifierSignatureRequest(identifier: Identifier): Promise<SignatureRequestHandle>;
-    registerIdentity(signer: SafeSigner, signatureRequest: SignatureRequestHandle): Promise<void>;
+    registerIdentity(signer: SafeSigner, signatureRequest: SignatureRequestHandle, visibilityConfirmationOptions?: VisibilityConfirmationOptions): Promise<void>;
     getInboxIdByIdentifier(identifier: Identifier): Promise<string | undefined>;
     signWithInstallationKey(signatureText: string): Uint8Array<ArrayBufferLike>;
     verifySignedWithInstallationKey(signatureText: string, signatureBytes: Uint8Array): boolean;
     verifySignedWithPublicKey(signatureText: string, signatureBytes: Uint8Array, publicKey: Uint8Array): boolean;
     fetchKeyPackageStatuses(installationIds: string[]): Promise<Map<string, KeyPackageStatus>>;
-    sendSyncRequest(): Promise<void>;
+    sendSyncRequest(options: ArchiveOptions, serverUrl: string): Promise<void>;
+    sendSyncArchive(options: ArchiveOptions, serverUrl: string, pin: string): Promise<void>;
+    processSyncArchive(archivePin?: string | null): Promise<void>;
+    listAvailableArchives(daysCutoff: number): AvailableArchiveInfo[];
+    createArchive(opts: ArchiveOptions, key: Uint8Array): Promise<Uint8Array>;
+    importArchive(data: Uint8Array, key: Uint8Array): Promise<void>;
+    archiveMetadata(data: Uint8Array, key: Uint8Array): Promise<ArchiveMetadata>;
+    syncAllDeviceSyncGroups(): Promise<GroupSyncSummary>;
 }
 
 declare class WorkerConversation {
@@ -463,6 +471,7 @@ type ClientAction = {
     id: string;
     result: {
         appVersion: string;
+        env: string;
         inboxId: string;
         installationId: string;
         installationIdBytes: Uint8Array;
@@ -551,6 +560,7 @@ type ClientAction = {
     data: {
         signer: SafeSigner;
         signatureRequestId: string;
+        waitForRegistrationVisible?: VisibilityConfirmationOptions;
     };
 } | {
     action: "client.addAccount";
@@ -608,6 +618,18 @@ type ClientAction = {
     data: {
         identifiers: Identifier[];
     };
+} | {
+    action: "client.fetchLatestInboxUpdatesCount";
+    id: string;
+    result: Record<string, number>;
+    data: {
+        inboxIds: string[];
+    };
+} | {
+    action: "client.fetchOwnInboxUpdatesCount";
+    id: string;
+    result: number;
+    data: Record<string, never>;
 } | {
     action: "client.getInboxIdByIdentifier";
     id: string;
@@ -650,6 +672,61 @@ type ClientAction = {
     action: "client.sendSyncRequest";
     id: string;
     result: undefined;
+    data: {
+        options: ArchiveOptions;
+        serverUrl: string;
+    };
+} | {
+    action: "client.sendSyncArchive";
+    id: string;
+    result: undefined;
+    data: {
+        options: ArchiveOptions;
+        serverUrl: string;
+        pin: string;
+    };
+} | {
+    action: "client.processSyncArchive";
+    id: string;
+    result: undefined;
+    data: {
+        archivePin?: string | null;
+    };
+} | {
+    action: "client.listAvailableArchives";
+    id: string;
+    result: AvailableArchiveInfo[];
+    data: {
+        daysCutoff: number;
+    };
+} | {
+    action: "client.createArchive";
+    id: string;
+    result: Uint8Array;
+    data: {
+        opts: ArchiveOptions;
+        key: Uint8Array;
+    };
+} | {
+    action: "client.importArchive";
+    id: string;
+    result: undefined;
+    data: {
+        data: Uint8Array;
+        key: Uint8Array;
+    };
+} | {
+    action: "client.archiveMetadata";
+    id: string;
+    result: ArchiveMetadata;
+    data: {
+        data: Uint8Array;
+        key: Uint8Array;
+    };
+} | {
+    action: "client.syncAllDeviceSyncGroups";
+    id: string;
+    result: GroupSyncSummary;
     data: undefined;
 };
 
@@ -2197,6 +2274,10 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * Gets the app version used by the client
      */
     get appVersion(): string | undefined;
+    /**
+     * Gets the XMTP environment used by this client
+     */
+    get env(): XmtpEnv | undefined;
     /**
      * Creates signature text for creating a new inbox
      *
@@ -2367,21 +2448,45 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
     /**
      * Revokes specific installations of the client's inbox without a client
      *
-     * @param env - The environment to use
      * @param signer - The signer to use
      * @param inboxId - The inbox ID to revoke installations for
      * @param installationIds - The installation IDs to revoke
+     * @param backend - Optional `Backend` instance created with `createBackend()`
+     */
+    static revokeInstallations(signer: Signer, inboxId: string, installationIds: Uint8Array[], backend?: Backend): Promise<void>;
+    /**
+     * Revokes specific installations of the client's inbox without a client
+     *
+     * @param signer - The signer to use
+     * @param inboxId - The inbox ID to revoke installations for
+     * @param installationIds - The installation IDs to revoke
+     * @param env - The environment to use
+     * @param gatewayHost - Optional gateway host
+     * @deprecated Pass a `Backend` instance created with `createBackend()` instead
+     * of `XmtpEnv` and `gatewayHost`.
      */
     static revokeInstallations(signer: Signer, inboxId: string, installationIds: Uint8Array[], env?: XmtpEnv, gatewayHost?: string): Promise<void>;
+    /**
+     * Fetches the inbox states for the specified inbox IDs from the network
+     * without a client
+     *
+     * @param inboxIds - The inbox IDs to get the state for
+     * @param backend - Optional `Backend` instance created with `createBackend()`
+     * @returns The inbox states for the specified inbox IDs
+     */
+    static fetchInboxStates(inboxIds: string[], backend?: Backend): Promise<InboxState[]>;
     /**
      * Fetches the inbox states for the specified inbox IDs from the network
      * without a client
      *
      * @param inboxIds - The inbox IDs to get the state for
      * @param env - The environment to use
+     * @param gatewayHost - Optional gateway host
      * @returns The inbox states for the specified inbox IDs
+     * @deprecated Pass a `Backend` instance created with `createBackend()` instead
+     * of `XmtpEnv` and `gatewayHost`.
      */
-    static fetchInboxStates(inboxIds: string[], env?: XmtpEnv, gatewayHost?: string): Promise<_xmtp_wasm_bindings.InboxState[]>;
+    static fetchInboxStates(inboxIds: string[], env?: XmtpEnv, gatewayHost?: string): Promise<InboxState[]>;
     /**
      * Changes the recovery identifier for the client's inbox
      *
@@ -2404,14 +2509,58 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @returns Whether the client can message the identifiers
      */
     canMessage(identifiers: Identifier[]): Promise<Map<string, boolean>>;
+    /**
+     * Fetches the latest inbox updates count for the specified inbox IDs
+     *
+     * @param inboxIds - The inbox IDs to check
+     * @returns Map of inbox IDs to their updates count
+     */
+    fetchLatestInboxUpdatesCount(inboxIds: string[]): Promise<Map<string, number>>;
+    /**
+     * Fetches the latest inbox updates count for the client's inbox
+     *
+     * @returns The latest inbox updates count
+     */
+    fetchOwnInboxUpdatesCount(): Promise<number>;
+    /**
+     * Checks if the specified identifiers can be messaged
+     *
+     * @param identifiers - The identifiers to check
+     * @param backend - Optional `Backend` instance created with `createBackend()`
+     * @returns Map of identifiers to whether they can be messaged
+     */
+    static canMessage(identifiers: Identifier[], backend?: Backend): Promise<Map<string, boolean>>;
     /**
      * Checks if the specified identifiers can be messaged
      *
      * @param identifiers - The identifiers to check
      * @param env - Optional XMTP environment
      * @returns Map of identifiers to whether they can be messaged
+     * @deprecated Pass a `Backend` instance created with `createBackend()` instead
+     * of `XmtpEnv`.
      */
     static canMessage(identifiers: Identifier[], env?: XmtpEnv): Promise<Map<string, boolean>>;
+    /**
+     * Fetches the latest inbox updates count for the specified inbox IDs
+     * without a client
+     *
+     * @param inboxIds - The inbox IDs to check
+     * @param backend - Optional `Backend` instance created with `createBackend()`
+     * @returns Map of inbox IDs to their updates count
+     */
+    static fetchLatestInboxUpdatesCount(inboxIds: string[], backendOrEnv?: Backend | XmtpEnv): Promise<Map<string, number>>;
+    /**
+     * Fetches the latest inbox updates count for the specified inbox IDs
+     * without a client
+     *
+     * @param inboxIds - The inbox IDs to check
+     * @param env - Optional XMTP environment
+     * @param gatewayHost - Optional gateway host
+     * @returns Map of inbox IDs to their updates count
+     * @deprecated Pass a `Backend` instance created with `createBackend()` instead
+     * of `XmtpEnv` and `gatewayHost`.
+     */
+    static fetchLatestInboxUpdatesCount(inboxIds: string[], env?: XmtpEnv, gatewayHost?: string): Promise<Map<string, number>>;
     /**
      * Fetches the inbox ID for a given identifier from the local database
      * If not found, fetches from the network
@@ -2455,9 +2604,67 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
     /**
      * Send a sync request to other devices on the network
      *
+     * @param options - Archive options specifying what to sync (defaults to consent and messages)
+     * @param serverUrl - The server URL for the sync request (defaults to environment-specific URL)
      * @returns Promise that resolves when the sync request is sent
      */
-    sendSyncRequest(): Promise<void>;
+    sendSyncRequest(options?: ArchiveOptions, serverUrl?: string): Promise<void>;
+    /**
+     * Send a sync archive to the sync group
+     *
+     * @param pin - The pin used for reference when importing
+     * @param options - Archive options specifying what to sync (defaults to consent and messages)
+     * @param serverUrl - The server URL for the sync archive (defaults to environment-specific URL)
+     * @returns Promise that resolves when the sync archive is sent
+     */
+    sendSyncArchive(pin: string, options?: ArchiveOptions, serverUrl?: string): Promise<void>;
+    /**
+     * Process a sync archive that matches the pin given
+     *
+     * @param archivePin - Optional pin to match. If not provided, processes the last archive sent
+     * @returns Promise that resolves when the archive is processed
+     */
+    processSyncArchive(archivePin?: string | null): Promise<void>;
+    /**
+     * List the archives available for import in the sync group
+     *
+     * You may need to manually sync the sync group before calling
+     * this function to see recently uploaded archives.
+     *
+     * @param daysCutoff - Number of days to look back for archives
+     * @returns Promise that resolves with array of available archive information
+     */
+    listAvailableArchives(daysCutoff: number): Promise<AvailableArchiveInfo[]>;
+    /**
+     * Export archive data to bytes for later restoration
+     *
+     * @param key - Encryption key for the archive
+     * @param opts - Archive options specifying what to include (defaults to consent and messages)
+     * @returns Promise that resolves with the archive data as bytes
+     */
+    createArchive(key: Uint8Array, opts?: ArchiveOptions): Promise<Uint8Array>;
+    /**
+     * Import an archive from bytes
+     *
+     * @param data - The archive data as bytes
+     * @param key - Encryption key for the archive
+     * @returns Promise that resolves when the archive is imported
+     */
+    importArchive(data: Uint8Array, key: Uint8Array): Promise<void>;
+    /**
+     * Load the metadata for an archive to see what it contains
+     *
+     * @param data - The archive data as bytes
+     * @param key - Encryption key for the archive
+     * @returns Promise that resolves with the archive metadata
+     */
+    archiveMetadata(data: Uint8Array, key: Uint8Array): Promise<ArchiveMetadata>;
+    /**
+     * Manually sync all device sync groups
+     *
+     * @returns Promise that resolves with a summary of the sync operation
+     */
+    syncAllDeviceSyncGroups(): Promise<GroupSyncSummary>;
 }
 
 declare class Opfs {
@@ -2476,6 +2683,8 @@ declare class Opfs {
     clearAll(): Promise<void>;
 }
 
+declare const createBackend: (options?: NetworkOptions) => Promise<Backend>;
+
 /**
  * Generates an inbox ID for a given identifier
  *
@@ -2485,14 +2694,13 @@ declare class Opfs {
  */
 declare const generateInboxId: (identifier: Identifier, nonce?: bigint) => Promise<string>;
 /**
- * Gets the inbox ID for a specific identifier and optional environment
+ * Gets the inbox ID for a specific identifier using a Backend
  *
+ * @param backend - The Backend instance for API communication
  * @param identifier - The identifier to get the inbox ID for
- * @param env - Optional XMTP environment configuration (default: "dev")
- * @param gatewayHost - Optional gateway host override
  * @returns Promise that resolves with the inbox ID for the identifier
  */
-declare const getInboxIdForIdentifier: (identifier: Identifier, env?: XmtpEnv, gatewayHost?: string) => Promise<string | undefined>;
+declare const getInboxIdForIdentifier: (backend: Backend, identifier: Identifier) => Promise<string | undefined>;
 
 /**
  * Gets the name of a metadata field
@@ -2502,6 +2710,38 @@ declare const getInboxIdForIdentifier: (identifier: Identifier, env?: XmtpEnv, g
  */
 declare const metadataFieldName: (field: MetadataField) => Promise<string>;
 
+/**
+ * Pre-configured URLs for the XMTP network based on the environment
+ *
+ * @deprecated Use `createBackend()` instead.
+ * @constant
+ * @property {string} local - The local URL for the XMTP network
+ * @property {string} dev - The development URL for the XMTP network
+ * @property {string} production - The production URL for the XMTP network
+ */
+declare const ApiUrls: {
+    readonly local: "http://localhost:5557";
+    readonly dev: "https://api.dev.xmtp.network:5558";
+    readonly production: "https://api.production.xmtp.network:5558";
+};
+/**
+ * Pre-configured URLs for the XMTP history sync service based on the environment
+ *
+ * @constant
+ * @property {string} local - The local URL for the XMTP history sync service
+ * @property {string} dev - The development URL for the XMTP history sync service
+ * @property {string} production - The production URL for the XMTP history sync service
+ */
+declare const HistorySyncUrls: {
+    readonly local: "http://localhost:5558";
+    readonly dev: "https://message-history.dev.ephemera.network";
+    readonly production: "https://message-history.production.ephemera.network";
+    readonly "testnet-staging": "https://message-history.dev.ephemera.network";
+    readonly "testnet-dev": "https://message-history.dev.ephemera.network";
+    readonly testnet: "https://message-history.dev.ephemera.network";
+    readonly mainnet: "https://message-history.production.ephemera.network";
+};
+
 declare const encodeActions: (actions: _xmtp_wasm_bindings.Actions) => Promise<_xmtp_wasm_bindings.EncodedContent>;
 declare const encodeAttachment: (attachment: _xmtp_wasm_bindings.Attachment) => Promise<_xmtp_wasm_bindings.EncodedContent>;
 declare const encodeIntent: (intent: _xmtp_wasm_bindings.Intent) => Promise<_xmtp_wasm_bindings.EncodedContent>;
@@ -2577,5 +2817,5 @@ declare const isIntent: (m: DecodedMessage) => m is DecodedMessage<Intent>;
 declare const isActions: (m: DecodedMessage) => m is DecodedMessage<Actions>;
 declare const isMarkdown: (m: DecodedMessage) => m is DecodedMessage<string>;
 
-export { AccountAlreadyAssociatedError, ApiUrls, Client, ClientNotInitializedError, Conversation, Conversations, DEFAULT_RETRY_ATTEMPTS, DEFAULT_RETRY_DELAY, DecodedMessage, Dm, Group, GroupNotFoundError, HistorySyncUrls, InboxReassignError, Opfs, OpfsInitializationError, OpfsNotInitializedError, SignerUnavailableError, StreamFailedError, StreamInvalidRetryAttemptsError, StreamNotFoundError, contentTypeActions, contentTypeAttachment, contentTypeGroupUpdated, contentTypeIntent, contentTypeLeaveRequest, contentTypeMarkdown, contentTypeMultiRemoteAttachment, contentTypeReaction, contentTypeReadReceipt, contentTypeRemoteAttachment, contentTypeReply, contentTypeText, contentTypeTransactionReference, contentTypeWalletSendCalls, createStream, decryptAttachment, encodeActions, encodeAttachment, encodeIntent, encodeMarkdown, encodeMultiRemoteAttachment, encodeReaction, encodeReadReceipt, encodeRemoteAttachment, encodeText, encodeTransactionReference, encodeWalletSendCalls, encryptAttachment, generateInboxId, getInboxIdForIdentifier, isActions, isAttachment, isGroupUpdated, isIntent, isLeaveRequest, isMarkdown, isMultiRemoteAttachment, isReaction, isReadReceipt, isRemoteAttachment, isReply, isText, isTextReply, isTransactionReference, isWalletSendCalls, metadataFieldName, toSafeConversation, toSafeSigner };
-export type { AsyncStreamProxy, BuiltInContentTypes, ClientOptions, ContentOptions, EOASigner, EnrichedReply, ExtractCodecContentTypes, HmacKeys, LastReadTimes, NetworkOptions, OtherOptions, SCWSigner, SafeConversation, SafeSigner, Signer, StorageOptions, StreamCallback, StreamFunction, StreamOptions, StreamValueMutator, XmtpEnv };
+export { AccountAlreadyAssociatedError, ApiUrls, Client, ClientNotInitializedError, Conversation, Conversations, DEFAULT_RETRY_ATTEMPTS, DEFAULT_RETRY_DELAY, DecodedMessage, Dm, Group, GroupNotFoundError, HistorySyncUrls, InboxReassignError, Opfs, OpfsInitializationError, OpfsNotInitializedError, SignerUnavailableError, StreamFailedError, StreamInvalidRetryAttemptsError, StreamNotFoundError, contentTypeActions, contentTypeAttachment, contentTypeGroupUpdated, contentTypeIntent, contentTypeLeaveRequest, contentTypeMarkdown, contentTypeMultiRemoteAttachment, contentTypeReaction, contentTypeReadReceipt, contentTypeRemoteAttachment, contentTypeReply, contentTypeText, contentTypeTransactionReference, contentTypeWalletSendCalls, createBackend, createEOASigner, createSCWSigner, createStream, decryptAttachment, encodeActions, encodeAttachment, encodeIntent, encodeMarkdown, encodeMultiRemoteAttachment, encodeReaction, encodeReadReceipt, encodeRemoteAttachment, encodeText, encodeTransactionReference, encodeWalletSendCalls, encryptAttachment, generateInboxId, getInboxIdForIdentifier, isActions, isAttachment, isGroupUpdated, isIntent, isLeaveRequest, isMarkdown, isMultiRemoteAttachment, isReaction, isReadReceipt, isRemoteAttachment, isReply, isText, isTextReply, isTransactionReference, isWalletSendCalls, metadataFieldName, toSafeConversation, toSafeSigner };
+export type { AsyncStreamProxy, BuiltInContentTypes, ClientOptions, ContentOptions, DeviceSyncOptions, EOASigner, EnrichedReply, ExtractCodecContentTypes, HmacKeys, LastReadTimes, NetworkOptions, OtherOptions, SCWSigner, SafeConversation, SafeSigner, Signer, StorageOptions, StreamCallback, StreamFunction, StreamOptions, StreamValueMutator, VisibilityConfirmationOptions, XmtpEnv };