@xmtp/node-sdk 5.5.0 → 6.0.0-dev.3f65d25

package/dist/index.d.ts

@@ -1,11 +1,12 @@
 import { ContentCodec, ContentTypeId } from '@xmtp/content-type-primitives';
 import * as _xmtp_node_bindings from '@xmtp/node-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, StreamCloser, Conversation as Conversation$1, Message, EncodedContent, SendMessageOpts, Reply, ListMessagesOptions, ConsentState, PermissionUpdateType, PermissionPolicy, MetadataField, Conversations as Conversations$1, CreateGroupOptions, CreateDmOptions, ListConversationsOptions, ConversationType, Client as Client$1, Consent, ConsentEntityType, UserPreferenceUpdate, SignatureRequestHandle } from '@xmtp/node-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, contentTypeActions, contentTypeAttachment, contentTypeGroupUpdated, contentTypeIntent, contentTypeLeaveRequest, contentTypeMarkdown, contentTypeMultiRemoteAttachment, contentTypeReaction, contentTypeReadReceipt, contentTypeRemoteAttachment, contentTypeReply, contentTypeText, contentTypeTransactionReference, contentTypeWalletSendCalls, decryptAttachment, encodeActions, encodeAttachment, encodeIntent, encodeMarkdown, encodeMultiRemoteAttachment, encodeReaction, encodeReadReceipt, encodeRemoteAttachment, encodeText, encodeTransactionReference, encodeWalletSendCalls, encryptAttachment } from '@xmtp/node-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, VisibilityConfirmationOptions, XmtpEnv as XmtpEnv$1, Identifier, StreamCloser, Conversation as Conversation$1, Message, EncodedContent, SendMessageOpts, SendOpts, Reply, ListMessagesOptions, ConsentState, PermissionUpdateType, PermissionPolicy, MetadataField, Conversations as Conversations$1, CreateGroupOptions, CreateDmOptions, ListConversationsOptions, ConversationType, Client as Client$1, Consent, ConsentEntityType, UserPreferenceUpdate, SignatureRequestHandle, InboxState, ArchiveOptions, AvailableArchiveInfo, ArchiveMetadata, GroupSyncSummary } from '@xmtp/node-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, SendOpts, SignatureRequestHandle, SortDirection, TransactionMetadata, TransactionReference, UserPreferenceUpdate, VisibilityConfirmationOptions, WalletCall, WalletSendCalls, WorkerConfigOptions, WorkerIntervalOverride, WorkerKind, contentTypeActions, contentTypeAttachment, contentTypeGroupUpdated, contentTypeIntent, contentTypeLeaveRequest, contentTypeMarkdown, contentTypeMultiRemoteAttachment, contentTypeReaction, contentTypeReadReceipt, contentTypeRemoteAttachment, contentTypeReply, contentTypeText, contentTypeTransactionReference, contentTypeWalletSendCalls, decryptAttachment, encodeActions, encodeAttachment, encodeIntent, encodeMarkdown, encodeMultiRemoteAttachment, encodeReaction, encodeReadReceipt, encodeRemoteAttachment, encodeText, encodeTransactionReference, encodeWalletSendCalls, encryptAttachment, flushTelemetry, initLogging } from '@xmtp/node-bindings';
 
 /**
  * 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
@@ -28,6 +29,10 @@ 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 class CodecRegistry {
@@ -86,7 +91,7 @@ declare function validHex(value: unknown): HexString;
 /**
  * XMTP environment
  */
-type XmtpEnv = keyof typeof ApiUrls;
+type XmtpEnv = "local" | "dev" | "production" | "testnet-staging" | "testnet-dev" | "testnet" | "mainnet";
 /**
  * Network options
  */
@@ -102,6 +107,23 @@ type NetworkOptions = {
      * specific endpoint
      */
     apiUrl?: string;
+    /**
+     * The host of the XMTP Gateway for your application
+     *
+     * Only valid for `dev` and `production` environments
+     *
+     * @see https://docs.xmtp.org/fund-agents-apps/run-gateway
+     */
+    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
@@ -110,13 +132,9 @@ type NetworkOptions = {
      */
     historySyncUrl?: string | null;
     /**
-     * The host of the XMTP Gateway for your application
-     *
-     * Only valid for `testnet` and `mainnet` environments
-     *
-     * @see:https://docs.xmtp.org/fund-agents-apps/run-gateway
+     * Disable device sync
      */
-    gatewayHost?: string;
+    disableDeviceSync?: boolean;
 };
 /**
  * Storage options
@@ -150,6 +168,26 @@ type StorageOptions = {
      * @see https://docs.xmtp.org/chat-apps/core-messaging/create-a-client#view-an-encrypted-database
      */
     dbEncryptionKey?: Uint8Array | HexString;
+    /**
+     * Maximum number of connections in the local DB connection pool.
+     *
+     * Defaults to 25 when unset. Ignored when `useSingleConnection` is `true`.
+     */
+    maxDbPoolSize?: number;
+    /**
+     * Minimum number of connections kept warm in the local DB connection pool.
+     *
+     * Defaults to 5 when unset. Ignored when `useSingleConnection` is `true`.
+     */
+    minDbPoolSize?: number;
+    /**
+     * When `true`, the native DB uses a single connection (one file descriptor)
+     * instead of a pool. The pool-size options above are ignored. Intended for
+     * services running many clients in one process.
+     *
+     * Defaults to `false` (pooled).
+     */
+    useSingleConnection?: boolean;
 };
 type ContentOptions = {
     /**
@@ -163,28 +201,66 @@ type OtherOptions = {
      */
     structuredLogging?: boolean;
     /**
-     * Logging level
+     * Logging level. Also the level exported to OTLP when `otelEndpoint` is set.
      */
     loggingLevel?: LogLevel;
     /**
-     * Disable automatic registration when creating a client
+     * Level for the stdout console layer only. Defaults to `loggingLevel`. Set to
+     * `LogLevel.Warn` to quiet stdout below the OTLP export level — e.g. so a log
+     * shipper does not duplicate logs already exported via OTLP, while OTLP still
+     * receives `loggingLevel`.
      */
-    disableAutoRegister?: boolean;
+    stdoutLoggingLevel?: LogLevel;
     /**
-     * Disable device sync
+     * OTLP endpoint (e.g. `"http://collector:4317"`) for exporting telemetry
+     * spans and logs. When set, spans (and `tracing` events as correlated logs)
+     * are exported via OTLP to this endpoint, where a downstream OpenTelemetry
+     * Collector can derive metrics from the spans and forward the logs.
+     *
+     * Call {@link flushTelemetry} on graceful shutdown to flush buffered spans.
      */
-    disableDeviceSync?: boolean;
+    otelEndpoint?: string;
     /**
-     * Custom app version
+     * Resource attributes attached to all exported telemetry spans
+     * (e.g. `{ "service.instance.id": "herald-7", "deployment.environment": "prod" }`).
+     * Use these to attribute telemetry to its source.
      */
-    appVersion?: string;
+    resourceAttributes?: Record<string, string>;
+    /**
+     * 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;
     /**
      * The nonce to use when generating an inbox ID
      * (default: undefined = 1)
      */
     nonce?: bigint;
+    /**
+     * 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;
 };
-type ClientOptions = NetworkOptions & StorageOptions & ContentOptions & OtherOptions;
+type ClientOptions = (NetworkOptions | {
+    backend: Backend;
+}) & DeviceSyncOptions & StorageOptions & ContentOptions & OtherOptions;
+/**
+ * `Omit` that distributes over unions. The built-in `Omit` collapses a union
+ * (e.g. `ClientOptions`' `NetworkOptions | { backend }` arm) because
+ * `keyof (A | B)` only yields shared keys. This preserves each arm, so options
+ * like `{ backend }` survive `Omit<ClientOptions, "codecs">`.
+ */
+type DistributiveOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> : never;
 type EnrichedReply<T = unknown, U = unknown> = {
     referenceId: string;
     content: T;
@@ -194,6 +270,9 @@ type EnrichedReply<T = unknown, U = unknown> = {
 type BuiltInContentTypes = string | LeaveRequest | Reaction | ReadReceipt | Attachment | RemoteAttachment | TransactionReference | WalletSendCalls | Actions | Intent | MultiRemoteAttachment | GroupUpdated | DeletedMessage;
 type ExtractCodecContentTypes<C extends ContentCodec[] = []> = C extends readonly [] ? BuiltInContentTypes : [...C][number] extends ContentCodec<infer T> ? T | BuiltInContentTypes | EnrichedReply<T | BuiltInContentTypes, T | BuiltInContentTypes> : BuiltInContentTypes;
 
+declare const envToString: (env: XmtpEnv$1) => XmtpEnv;
+declare const createBackend: (options?: NetworkOptions) => Promise<Backend>;
+
 declare class InboxReassignError extends Error {
     constructor();
 }
@@ -217,7 +296,7 @@ declare class StreamInvalidRetryAttemptsError extends Error {
 }
 
 declare const generateInboxId: (identifier: Identifier, nonce?: bigint) => string;
-declare const getInboxIdForIdentifier: (identifier: Identifier, env?: XmtpEnv, gatewayHost?: string) => Promise<string | null>;
+declare const getInboxIdForIdentifier: (backend: Backend, identifier: Identifier) => Promise<string | null>;
 
 type SignMessage = (message: string) => Promise<Uint8Array> | Uint8Array;
 type GetIdentifier = () => Promise<Identifier> | Identifier;
@@ -427,8 +506,10 @@ declare class Conversation<ContentTypes = unknown> {
      * @param sendOptions - Options for sending the message
      * @param sendOptions.shouldPush - Indicates whether this message should be
      * included in push notifications
-     * @param sendOptions.isOptimistic - Indicates whether this message should be
+     * @param sendOptions.optimistic - Indicates whether this message should be
      * sent optimistically and published later via `publishMessages`
+     * @param sendOptions.idempotencyKey - Optional idempotency key; re-sending
+     * identical content with the same key produces the same deduplicated message id
      * @returns Promise that resolves with the message ID after it has been sent
      */
     send(encodedContent: EncodedContent, sendOptions?: SendMessageOpts): Promise<string>;
@@ -436,98 +517,97 @@ declare class Conversation<ContentTypes = unknown> {
      * Sends a text message
      *
      * @param text - The text to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendText(text: string, isOptimistic?: boolean): Promise<string>;
+    sendText(text: string, opts?: SendOpts): Promise<string>;
     /**
      * Sends a markdown message
      *
      * @param markdown - The markdown to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendMarkdown(markdown: string, isOptimistic?: boolean): Promise<string>;
+    sendMarkdown(markdown: string, opts?: SendOpts): Promise<string>;
     /**
      * Sends a reaction message
      *
      * @param reaction - The reaction to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendReaction(reaction: Reaction, isOptimistic?: boolean): Promise<string>;
+    sendReaction(reaction: Reaction, opts?: SendOpts): Promise<string>;
     /**
      * Sends a read receipt message
      *
-     * @param readReceipt - The read receipt to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendReadReceipt(isOptimistic?: boolean): Promise<string>;
+    sendReadReceipt(opts?: SendOpts): Promise<string>;
     /**
      * Sends a reply message
      *
      * @param reply - The reply to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendReply(reply: Reply, isOptimistic?: boolean): Promise<string>;
+    sendReply(reply: Reply, opts?: SendOpts): Promise<string>;
     /**
      * Sends a transaction reference message
      *
      * @param transactionReference - The transaction reference to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendTransactionReference(transactionReference: TransactionReference, isOptimistic?: boolean): Promise<string>;
+    sendTransactionReference(transactionReference: TransactionReference, opts?: SendOpts): Promise<string>;
     /**
      * Sends a wallet send calls message
      *
      * @param walletSendCalls - The wallet send calls to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendWalletSendCalls(walletSendCalls: WalletSendCalls, isOptimistic?: boolean): Promise<string>;
+    sendWalletSendCalls(walletSendCalls: WalletSendCalls, opts?: SendOpts): Promise<string>;
     /**
      * Sends a actions message
      *
      * @param actions - The actions to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendActions(actions: Actions, isOptimistic?: boolean): Promise<string>;
+    sendActions(actions: Actions, opts?: SendOpts): Promise<string>;
     /**
      * Sends a intent message
      *
      * @param intent - The intent to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendIntent(intent: Intent, isOptimistic?: boolean): Promise<string>;
+    sendIntent(intent: Intent, opts?: SendOpts): Promise<string>;
     /**
      * Sends an attachment message
      *
      * @param attachment - The attachment to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendAttachment(attachment: Attachment, isOptimistic?: boolean): Promise<string>;
+    sendAttachment(attachment: Attachment, opts?: SendOpts): Promise<string>;
     /**
      * Sends a multi remote attachment message
      *
      * @param multiRemoteAttachment - The multi remote attachment to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendMultiRemoteAttachment(multiRemoteAttachment: MultiRemoteAttachment, isOptimistic?: boolean): Promise<string>;
+    sendMultiRemoteAttachment(multiRemoteAttachment: MultiRemoteAttachment, opts?: SendOpts): Promise<string>;
     /**
      * Sends a remote attachment message
      *
      * @param remoteAttachment - The remote attachment to send
-     * @param isOptimistic - Whether to send the message optimistically
+     * @param opts - Send options (optimistic delivery, idempotency key)
      * @returns Promise that resolves with the message ID after it has been sent
      */
-    sendRemoteAttachment(remoteAttachment: RemoteAttachment, isOptimistic?: boolean): Promise<string>;
+    sendRemoteAttachment(remoteAttachment: RemoteAttachment, opts?: SendOpts): Promise<string>;
     /**
      * Lists messages in this conversation
      *
@@ -1117,7 +1197,7 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @param options - Optional configuration for the client
      * @returns A new client instance
      */
-    static create<ContentCodecs extends ContentCodec[] = []>(signer: Signer, options?: Omit<ClientOptions, "codecs"> & {
+    static create<ContentCodecs extends ContentCodec[] = []>(signer: Signer, options?: DistributiveOmit<ClientOptions, "codecs"> & {
         codecs?: ContentCodecs;
     }): Promise<Client<ExtractCodecContentTypes<ContentCodecs>>>;
     /**
@@ -1130,7 +1210,7 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @param options - Optional configuration for the client
      * @returns A new client instance
      */
-    static build<ContentCodecs extends ContentCodec[] = []>(identifier: Identifier, options?: Omit<ClientOptions, "codecs"> & {
+    static build<ContentCodecs extends ContentCodec[] = []>(identifier: Identifier, options?: DistributiveOmit<ClientOptions, "codecs"> & {
         codecs?: ContentCodecs;
     }): Promise<Client<ExtractCodecContentTypes<ContentCodecs>>>;
     /**
@@ -1141,6 +1221,12 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * Gets the app version used by the client
      */
     get appVersion(): string | undefined;
+    /**
+     * Gets the XMTP environment the client is connected to
+     *
+     * @throws {ClientNotInitializedError} if the client is not initialized
+     */
+    get env(): XmtpEnv;
     /**
      * Gets the client options
      */
@@ -1189,6 +1275,19 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @throws {ClientNotInitializedError} if the client is not initialized
      */
     get preferences(): Preferences;
+    /**
+     * Cleanly shuts down the client: cancels in-flight workers and detached
+     * streams, then releases the database connection.
+     *
+     * This is idempotent — calling it more than once resolves without error.
+     * Await this before deleting the database file or dropping the client
+     * reference to avoid log noise from background tasks running against a
+     * closed database.
+     *
+     * @throws {ClientNotInitializedError} if the client is not initialized
+     * @returns Promise that resolves when the client has shut down
+     */
+    close(): Promise<void>;
     /**
      * Adds a signature to a signature request using the client's signer (or the
      * provided signer)
@@ -1371,10 +1470,22 @@ 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>;
     /**
@@ -1395,6 +1506,21 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @throws {ClientNotInitializedError} if the client is not initialized
      */
     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
+     * @throws {ClientNotInitializedError} if the client is not initialized
+     */
+    fetchLatestInboxUpdatesCount(inboxIds: string[]): Promise<Map<string, number>>;
+    /**
+     * Fetches the latest inbox updates count for the client's inbox
+     *
+     * @returns The latest inbox updates count
+     * @throws {ClientNotInitializedError} if the client is not initialized
+     */
+    fetchOwnInboxUpdatesCount(): Promise<number>;
     /**
      * Fetches the key package statuses from the network for the specified
      * installation IDs
@@ -1434,17 +1560,60 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * Fetches the inbox states for the specified inbox IDs from the network
      * without a client
      *
-     * @param env - The environment to use
      * @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[], env?: XmtpEnv, gatewayHost?: string): Promise<_xmtp_node_bindings.InboxState[]>;
+    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<InboxState[]>;
+    /**
+     * 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 - The environment to use
+     * @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>>;
+    /**
+     * 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>>;
     /**
@@ -1461,8 +1630,20 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      *
      * @param inboxId - The inbox ID to check
      * @param address - The address to check
-     * @param options - Optional network options
+     * @param backend - Optional `Backend` instance created with `createBackend()`
+     * @returns Whether the address is authorized
+     */
+    static isAddressAuthorized(inboxId: string, address: string, backend?: Backend): Promise<boolean>;
+    /**
+     * Checks if an address is authorized for an inbox
+     *
+     * @param inboxId - The inbox ID to check
+     * @param address - The address to check
+     * @param env - The environment to use
+     * @param gatewayHost - Optional gateway host
      * @returns Whether the address is authorized
+     * @deprecated Pass a `Backend` instance created with `createBackend()` instead
+     * of `XmtpEnv` and `gatewayHost`.
      */
     static isAddressAuthorized(inboxId: string, address: string, env?: XmtpEnv, gatewayHost?: string): Promise<boolean>;
     /**
@@ -1470,17 +1651,90 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      *
      * @param inboxId - The inbox ID to check
      * @param installation - The installation to check
-     * @param options - Optional network options
+     * @param backend - Optional `Backend` instance created with `createBackend()`
      * @returns Whether the installation is authorized
      */
+    static isInstallationAuthorized(inboxId: string, installation: Uint8Array, backend?: Backend): Promise<boolean>;
+    /**
+     * Checks if an installation is authorized for an inbox
+     *
+     * @param inboxId - The inbox ID to check
+     * @param installation - The installation to check
+     * @param env - The environment to use
+     * @param gatewayHost - Optional gateway host
+     * @returns Whether the installation is authorized
+     * @deprecated Pass a `Backend` instance created with `createBackend()` instead
+     * of `XmtpEnv` and `gatewayHost`.
+     */
     static isInstallationAuthorized(inboxId: string, installation: Uint8Array, env?: XmtpEnv, gatewayHost?: string): Promise<boolean>;
     /**
      * 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 Array of available archive information
+     */
+    listAvailableArchives(daysCutoff: number): AvailableArchiveInfo[];
+    /**
+     * Archive application elements to file for later restoration
+     *
+     * @param path - The file path to save the archive
+     * @param key - Encryption key for the archive
+     * @param opts - Archive options specifying what to include (defaults to consent and messages)
+     * @returns Promise that resolves when the archive is created
+     */
+    createArchive(path: string, key: Uint8Array, opts?: ArchiveOptions): Promise<void>;
+    /**
+     * Import a previous archive from a file
+     *
+     * @param path - The file path to the archive
+     * @param key - Encryption key for the archive
+     * @returns Promise that resolves when the archive is imported
+     */
+    importArchive(path: string, key: Uint8Array): Promise<void>;
+    /**
+     * Load the metadata for an archive to see what it contains
+     *
+     * Reads only the metadata without loading the entire file, so this function is quick.
+     *
+     * @param path - The file path to the archive
+     * @param key - Encryption key for the archive
+     * @returns Promise that resolves with the archive metadata
+     */
+    archiveMetadata(path: string, key: Uint8Array): Promise<ArchiveMetadata>;
+    /**
+     * Manually sync all device sync groups
+     *
+     * @returns Promise that resolves with a summary of the sync operation
+     */
+    syncAllDeviceSyncGroups(): Promise<GroupSyncSummary>;
 }
 
-export { AccountAlreadyAssociatedError, ApiUrls, Client, ClientNotInitializedError, Conversation, Conversations, DEFAULT_RETRY_ATTEMPTS, DEFAULT_RETRY_DELAY, DecodedMessage, Dm, Group, HistorySyncUrls, InboxReassignError, MissingContentTypeError, SignerUnavailableError, StreamFailedError, StreamInvalidRetryAttemptsError, createStream, generateInboxId, getInboxIdForIdentifier, isActions, isAttachment, isGroupUpdated, isHexString, isIntent, isLeaveRequest, isMarkdown, isMultiRemoteAttachment, isReaction, isReadReceipt, isRemoteAttachment, isReply, isText, isTextReply, isTransactionReference, isWalletSendCalls, validHex };
-export type { AsyncStreamProxy, BuiltInContentTypes, ClientOptions, ContentOptions, EOASigner, EnrichedReply, ExtractCodecContentTypes, HexString, NetworkOptions, OtherOptions, SCWSigner, Signer, StorageOptions, StreamCallback, StreamFunction, StreamOptions, StreamValueMutator, XmtpEnv };
+export { AccountAlreadyAssociatedError, ApiUrls, Client, ClientNotInitializedError, Conversation, Conversations, DEFAULT_RETRY_ATTEMPTS, DEFAULT_RETRY_DELAY, DecodedMessage, Dm, Group, HistorySyncUrls, InboxReassignError, MissingContentTypeError, SignerUnavailableError, StreamFailedError, StreamInvalidRetryAttemptsError, createBackend, createStream, envToString, generateInboxId, getInboxIdForIdentifier, isActions, isAttachment, isGroupUpdated, isHexString, isIntent, isLeaveRequest, isMarkdown, isMultiRemoteAttachment, isReaction, isReadReceipt, isRemoteAttachment, isReply, isText, isTextReply, isTransactionReference, isWalletSendCalls, validHex };
+export type { AsyncStreamProxy, BuiltInContentTypes, ClientOptions, ContentOptions, DeviceSyncOptions, DistributiveOmit, EOASigner, EnrichedReply, ExtractCodecContentTypes, HexString, NetworkOptions, OtherOptions, SCWSigner, Signer, StorageOptions, StreamCallback, StreamFunction, StreamOptions, StreamValueMutator, XmtpEnv };