@xmtp/node-sdk 6.1.0 → 6.2.0-dev.4b7b477

package/dist/index.d.ts

@@ -1,39 +1,7 @@
 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, 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, WorkerJitterOverride, 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
- * @property {string} production - The production URL for the XMTP network
- */
-declare const ApiUrls: {
-    readonly local: "http://localhost:5556";
-    readonly dev: "https://grpc.dev.xmtp.network:443";
-    readonly production: "https://grpc.production.xmtp.network:443";
-};
-/**
- * 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";
-};
+import { DeliveryCursor, 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, AppDataChange, Identifier, StreamCloser, ConversationType, ConsentState, MessageCatchUp, Conversation as Conversation$1, Message, EncodedContent, SendMessageOpts, SendOpts, Reply, ListMessagesOptions, PermissionUpdateType, PermissionPolicy, MetadataField, Conversations as Conversations$1, CreateGroupOptions, CreateDmOptions, ListConversationsOptions, Client as Client$1, Consent, ConsentEntityType, UserPreferenceUpdate, SignatureRequestHandle, ArchiveOptions, ArchiveMetadata, GroupSyncSummary, ServerConfiguration } from '@xmtp/node-bindings';
+export { Action, ActionStyle, Actions, ApiStats, AppDataChange, ArchiveMetadata, ArchiveOptions, Attachment, AuthConfiguration, Backend, BackendBuilder, BackupElementSelectionOption, Consent, ConsentEntityType, ConsentState, ContentType, ConversationDebugInfo, ConversationListItem, ConversationType, CreateDmOptions, CreateGroupOptions, Cursor, DeliveryCursor, DeliveryStatus, EncryptedAttachment, GroupMember, GroupMembershipState, GroupMessageKind, GroupMetadata, GroupPermissions, GroupPermissionsOptions, GroupSyncSummary, GroupUpdated, HmacKey, Identifier, IdentifierKind, IdentityStats, Inbox, InboxState, Installation, Intent, KeyPackageStatus, LeaveRequest, Lifetime, LimitsConfiguration, ListConversationsOptions, ListConversationsOrderBy, ListMessagesOptions, LogLevel, LogOptions, Message, MessageCatchUp, MessageCatchUpGeneration, MessageDisappearingSettings, MessageHistorySnapshot, MessageSortBy, MessageTopicStatus, MetadataField, MetadataFieldChange, MlsConfiguration, MultiRemoteAttachment, PermissionLevel, PermissionPolicy, PermissionPolicySet, PermissionUpdateType, Reaction, ReactionAction, ReactionSchema, ReadReceipt, RemoteAttachment, Reply, RetentionConfiguration, SendMessageOpts, SendOpts, ServerConfiguration, SignatureRequestHandle, SigningKeyDescription, SortDirection, TransactionMetadata, TransactionReference, UserPreferenceUpdate, VisibilityConfirmationOptions, WalletCall, WalletSendCalls, WorkerConfigOptions, WorkerIntervalOverride, WorkerJitterOverride, 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';
 
 declare class CodecRegistry {
     #private;
@@ -67,6 +35,8 @@ declare class CodecRegistry {
  * @property {bigint} sentAtNs - Timestamp when the message was sent (in nanoseconds)
  */
 declare class DecodedMessage<ContentTypes = unknown> {
+    /** Database-local position of this delivery. Absent for ordinary history reads. */
+    deliveryCursor?: DeliveryCursor;
     content: ContentTypes | undefined;
     contentType: ContentTypeId$1;
     conversationId: string;
@@ -88,49 +58,33 @@ type HexString = `0x${string}`;
 declare function isHexString(value: unknown): value is HexString;
 declare function validHex(value: unknown): HexString;
 
-/**
- * XMTP environment
- */
-type XmtpEnv = "local" | "dev" | "production" | "testnet-staging" | "testnet-dev" | "testnet" | "mainnet";
 /**
  * Network options
  */
+/** A backend credential. Include the `Bearer ` prefix when required. */
+type Credential = {
+    /** Header name. Defaults to `authorization`. */
+    name?: string;
+    value: string;
+    /** Expiration as Unix seconds. Must be a safe integer. */
+    expiresAtSeconds: number;
+};
+/** Called when the backend needs a credential, including credential refresh. */
+type AuthCallback = () => Promise<Credential>;
 type NetworkOptions = {
-    /**
-     * Specify which XMTP environment to connect to. (default: `dev`)
-     *
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-a-client#xmtp-network-environments
-     */
-    env?: XmtpEnv;
-    /**
-     * apiUrl can be used to override the `env` flag and connect to a
-     * 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
-     */
+    /** Backend URL, including the HTTP or HTTPS scheme. */
+    backendUrl: string;
+    /** Label used only for the default database file name. */
+    env?: string;
+    /** Custom app version. */
     appVersion?: string;
+    /** Supply backend credentials. Separate from the XMTP identity signer. */
+    authCallback?: AuthCallback;
 };
 /**
  * Device sync options
  */
 type DeviceSyncOptions = {
-    /**
-     * historySyncUrl can be used to override the `env` flag and connect to a
-     * specific endpoint for syncing history
-     *
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/history-sync
-     */
-    historySyncUrl?: string | null;
     /**
      * Disable device sync
      */
@@ -147,8 +101,8 @@ type StorageOptions = {
      *
      * - `undefined` (or excluded from the client options)
      *    The database will be created in the current working directory and is based on
-     *    the XMTP environment and client inbox ID.
-     *    Example: `xmtp-dev-<inbox-id>.db3`
+     *    the environment label and client inbox ID.
+     *    Example: `xmtp-default-<inbox-id>.db3`
      *
      * - `null`
      *    No database will be created and all data will be lost once the client disconnects.
@@ -165,7 +119,7 @@ type StorageOptions = {
     /**
      * Encryption key for the local DB (32 bytes, hex)
      *
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-a-client#view-an-encrypted-database
+     * @see https://docs.xmtp.org/sdk/client/#view-an-encrypted-database
      */
     dbEncryptionKey?: Uint8Array | HexString;
     /**
@@ -220,6 +174,10 @@ type OtherOptions = {
      * Call {@link flushTelemetry} on graceful shutdown to flush buffered spans.
      */
     otelEndpoint?: string;
+    /** Service name attached to exported telemetry. */
+    otelServiceName?: string;
+    /** Fraction of root spans sampled, from 0 to 1. */
+    otelSampleRatio?: number;
     /**
      * Resource attributes attached to all exported telemetry spans
      * (e.g. `{ "service.instance.id": "herald-7", "deployment.environment": "prod" }`).
@@ -246,10 +204,26 @@ type OtherOptions = {
     /**
      * 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.
+     * When set, `registerIdentity` waits until the backend can read the registration.
      */
     waitForRegistrationVisible?: VisibilityConfirmationOptions;
+    /**
+     * Unstable: notifications for group state changes, for clients that
+     * reconcile a group's `appData` themselves.
+     *
+     * Only `appData` exists today; callbacks for the other mutable fields will
+     * be added as further optional properties. Registered at client creation
+     * because the changes they report arrive from the stream and sync paths,
+     * where no SDK call is on the stack to carry them.
+     *
+     * The `appData` callback is awaited before message processing continues, so
+     * a semantic merge — including republishing via `updateAppData` — can finish
+     * first. It fires for changes this client made as well as remote ones, so
+     * the merge must be idempotent.
+     */
+    unstableChangeCallbacks?: {
+        appData?: (change: AppDataChange) => Promise<void>;
+    };
 };
 type ClientOptions = (NetworkOptions | {
     backend: Backend;
@@ -270,8 +244,7 @@ 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 const createBackend: (options: NetworkOptions) => Promise<Backend>;
 
 declare class InboxReassignError extends Error {
     constructor();
@@ -333,6 +306,11 @@ interface AsyncStreamProxy<T> extends AsyncIterable<T> {
 
 declare const DEFAULT_RETRY_DELAY = 60000;
 declare const DEFAULT_RETRY_ATTEMPTS = 10;
+/**
+ * Notification streams created by createStream use the retry settings and hooks.
+ * Durable message streams use onValue, onError, and onEnd. Core handles their
+ * network recovery; notification retry settings and hooks do not apply.
+ */
 type StreamOptions<T = unknown, V = T> = {
     /**
      * Called when the stream ends
@@ -343,38 +321,41 @@ type StreamOptions<T = unknown, V = T> = {
      */
     onError?: (error: Error) => void;
     /**
-     * Called when the stream fails
+     * Called when a notification stream fails
      */
     onFail?: () => void;
     /**
-     * Called when the stream is restarted
+     * Called when a notification stream is restarted
      */
     onRestart?: () => void;
     /**
-     * Called when the stream is retried
+     * Called when a notification stream is retried
      */
     onRetry?: (attempts: number, maxAttempts: number) => void;
     /**
-     * Called when a value is emitted from the stream
+     * Called when a value is emitted from the stream.
+     * For message streams, this selects callback mode. Do not also iterate that stream.
+     * Message delivery is acknowledged after this callback returns successfully.
      */
-    onValue?: (value: V) => void;
+    onValue?: (value: V) => void | Promise<void>;
     /**
-     * The number of times to retry the stream
+     * The number of times to retry a notification stream
      * (default: 10)
      */
     retryAttempts?: number;
     /**
-     * The delay between retries (in milliseconds)
+     * The delay between notification stream retries (in milliseconds)
      * (default: 60000)
      */
     retryDelay?: number;
     /**
-     * Whether to retry the stream if it fails
+     * Whether to retry a notification stream if it fails
      * (default: true)
      */
     retryOnFail?: boolean;
     /**
-     * Whether to disable network sync before starting the stream
+     * Whether to skip pre-sync for notification streams.
+     * Durable message readers start receipt without a separate pre-sync.
      * (default: false)
      */
     disableSync?: boolean;
@@ -387,12 +368,14 @@ type StreamValueMutator<T = unknown, V = T> = (value: T) => V | Promise<V>;
  *
  * If the stream fails, an attempt will be made to restart it.
  *
+ * Ending the stream is terminal: no callbacks are invoked and no native
+ * stream is created after the stream ends.
+ *
  * This function is not intended to be used directly.
  *
  * @param streamFunction - The stream function to create a stream from
  * @param streamValueMutator - An optional function to mutate the value emitted from the stream
  * @param options - The options for the stream
- * @param args - Additional arguments to pass to the stream function
  * @returns An async iterable stream proxy
  * @throws {StreamInvalidRetryAttemptsError} if the retryAttempts option is less than 0 and retryOnFail is true
  * @throws {StreamFailedError} if the stream fails and can't be restarted
@@ -415,6 +398,81 @@ 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>;
 
+type MessageAcknowledgement = {
+    checkOwner(): boolean | Promise<boolean>;
+    acknowledge(): void | Promise<void>;
+    reject(): void | Promise<void>;
+};
+type MessageDelivery<T> = {
+    message: T;
+    cursor: DeliveryCursor;
+    acknowledgement: MessageAcknowledgement;
+};
+type MessageReaderSource<T> = {
+    nextDelivery(): Promise<MessageDelivery<T> | null | undefined>;
+    close(): void | Promise<void>;
+    updateScope(groupIds?: string[]): void | Promise<void>;
+    updateFilter(conversationType?: ConversationType, consentStates?: ConsentState[]): void | Promise<void>;
+    catchUpSnapshot(): MessageCatchUp | Promise<MessageCatchUp>;
+    catchUpChanged(): Promise<MessageCatchUp>;
+};
+/** One pending item. Construction selects callback mode or next-request acknowledgement. */
+declare class MessageStream<T, V> implements AsyncIterable<V> {
+    #private;
+    constructor(reader: MessageReaderSource<T>, convert: (message: T, cursor: DeliveryCursor) => V | undefined | Promise<V | undefined>, options?: StreamOptions<T, V>);
+    get isDone(): boolean;
+    get deliveredCursor(): DeliveryCursor | undefined;
+    next: () => Promise<IteratorResult<V, undefined>>;
+    return: () => Promise<IteratorReturnResult<undefined>>;
+    end: () => Promise<IteratorReturnResult<undefined>>;
+    updateScope: (groupIds?: string[]) => void | Promise<void>;
+    updateFilter: (conversationType?: ConversationType, consentStates?: ConsentState[]) => void | Promise<void>;
+    catchUpSnapshot: () => MessageCatchUp | Promise<MessageCatchUp>;
+    catchUpChanged: () => Promise<MessageCatchUp>;
+    [Symbol.asyncIterator](): this;
+}
+
+/** Delivery channel for this installation. */
+type NotificationChannel = {
+    type: "apns";
+    token: string;
+} | {
+    type: "fcm";
+    token: string;
+} | {
+    type: "http";
+    url: string;
+    signingKey: Uint8Array;
+};
+/** Notification delivery and conversation rules. */
+type NotificationConfig = {
+    channel: NotificationChannel;
+    /** Defaults to Allowed. An empty list selects no consent states. */
+    consentStates?: ConsentState[];
+    /** Defaults to true. */
+    includeWelcomes?: boolean;
+    /** Defaults to false. */
+    includeSyncGroups?: boolean;
+    /** Defaults to false. */
+    includeCommits?: boolean;
+};
+/** Reset to the configured consent rules with "default". */
+type NotificationOverride = "enabled" | "disabled" | "default";
+/** A notification failure with a stable error code. */
+declare class NotificationError extends Error {
+    readonly code: string;
+    constructor(code: string, options?: ErrorOptions);
+}
+/** Local notification state. Reading it makes no backend request. */
+type NotificationState = {
+    state: "disabled";
+} | {
+    state: "enabled";
+} | {
+    state: "failed";
+    error: NotificationError;
+};
+
 /**
  * Represents a conversation
  *
@@ -438,6 +496,10 @@ declare class Conversation<ContentTypes = unknown> {
      * Gets whether this conversation is currently active
      */
     get isActive(): boolean;
+    /** Override notification rules, or reset the override with "default". */
+    setNotifications(value: NotificationOverride): Promise<void>;
+    /** Read the effective notification value for this conversation. */
+    notificationsEnabled(): Promise<boolean>;
     /**
      * Gets the inbox ID that added this client's inbox to the conversation
      */
@@ -480,12 +542,19 @@ declare class Conversation<ContentTypes = unknown> {
      */
     sync(): Promise<void>;
     /**
-     * Creates a stream for new messages in this conversation
+     * Reads retained messages after the default acknowledgement position.
+     * Set `from` to replay after a cursor without changing default progress.
+     * Set `onValue` for callback mode, or request items with the iterator.
+     * Core owns network recovery. Legacy retry options and `disableSync` do not apply.
      *
-     * @param options - Optional stream options
+     * @param options - Optional delivery callbacks and replay cursor
      * @returns Stream instance for new messages
      */
-    stream(options?: StreamOptions<Message, DecodedMessage<ContentTypes>>): Promise<AsyncStreamProxy<DecodedMessage<ContentTypes>>>;
+    stream(options?: StreamOptions<Message, DecodedMessage<ContentTypes>> & {
+        from?: DeliveryCursor;
+    }): Promise<MessageStream<Message, DecodedMessage<ContentTypes>>>;
+    messageHistorySnapshot(limit: number): _xmtp_node_bindings.MessageHistorySnapshot;
+    beginningDeliveryCursor(): DeliveryCursor;
     /**
      * Decodes, decrypts, and persists a raw envelope from a group message stream.
      *
@@ -756,8 +825,15 @@ declare class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
      * Updates the group's app data (max 8192 bytes)
      *
      * @param appData The new app data for the group
+     * @param expectedAppData Optional compare-and-swap guard. When provided, the
+     * update is abandoned — rather than overwriting — if the committed value is
+     * no longer this, including when another member's commit wins the race after
+     * this update was published. Callers reconciling structured state should
+     * pass the value they merged against, so a concurrent write surfaces as an
+     * error instead of silently discarding someone else's change. Omit for
+     * last-writer-wins.
      */
-    updateAppData(appData: string): Promise<void>;
+    updateAppData(appData: string, expectedAppData?: string): Promise<void>;
     /**
      * The permissions of the group
      */
@@ -800,13 +876,13 @@ declare class Group<ContentTypes = unknown> extends Conversation<ContentTypes> {
      *
      * @param identifiers Array of member identifiers to add
      */
-    addMembersByIdentifiers(identifiers: Identifier[]): Promise<void>;
+    addMembersByIdentifiers(identifiers: Identifier[]): Promise<_xmtp_node_bindings.UpdateGroupMembershipResult>;
     /**
      * Adds members to the group using inbox IDs
      *
      * @param inboxIds Array of inbox IDs to add
      */
-    addMembers(inboxIds: string[]): Promise<void>;
+    addMembers(inboxIds: string[]): Promise<_xmtp_node_bindings.UpdateGroupMembershipResult>;
     /**
      * Removes members from the group using identifiers
      *
@@ -876,7 +952,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param id - The conversation ID to look up
      * @returns The conversation if found, undefined otherwise
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#conversation-helper-methods
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     getConversationById(id: string): Promise<Group<ContentTypes> | Dm<ContentTypes> | undefined>;
     /**
@@ -884,7 +960,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param inboxId - The inbox ID to look up
      * @returns The DM if found, undefined otherwise
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#conversation-helper-methods
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     getDmByInboxId(inboxId: string): Dm<ContentTypes> | undefined;
     /**
@@ -892,7 +968,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param identifier - The identifier to look up
      * @returns Promise that resolves with the DM, if found
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#conversation-helper-methods
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     fetchDmByIdentifier(identifier: Identifier): Promise<Dm<ContentTypes> | undefined>;
     /**
@@ -900,7 +976,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param id - The message ID to look up
      * @returns The decoded message if found, undefined otherwise
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#conversation-helper-methods
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     getMessageById(id: string): DecodedMessage<ContentTypes> | undefined;
     /**
@@ -908,7 +984,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param options - Optional group creation options
      * @returns The new group
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#optimistically-create-a-new-group-chat
+     * @see https://docs.xmtp.org/sdk/conversations/#optimistically-create-a-group
      */
     createGroupOptimistic(options?: CreateGroupOptions): Group<ContentTypes>;
     /**
@@ -917,7 +993,7 @@ declare class Conversations<ContentTypes = unknown> {
      * @param identifiers - Array of identifiers for group members
      * @param options - Optional group creation options
      * @returns The new group
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#create-a-new-group-chat
+     * @see https://docs.xmtp.org/sdk/conversations/#create-a-group
      */
     createGroupWithIdentifiers(identifiers: Identifier[], options?: CreateGroupOptions): Promise<Group<ContentTypes>>;
     /**
@@ -926,7 +1002,7 @@ declare class Conversations<ContentTypes = unknown> {
      * @param inboxIds - Array of inbox IDs for group members
      * @param options - Optional group creation options
      * @returns The new group
-     * @see https://docs.xmtp.org/chat-apps/core-messaging/create-conversations#create-a-new-group-chat
+     * @see https://docs.xmtp.org/sdk/conversations/#create-a-group
      */
     createGroup(inboxIds: string[], options?: CreateGroupOptions): Promise<Group<ContentTypes>>;
     /**
@@ -935,7 +1011,7 @@ declare class Conversations<ContentTypes = unknown> {
      * @param identifier - Identifier for the DM recipient
      * @param options - Optional DM creation options
      * @returns The new DM
-     * @see https://docs.xmtp.org/agents/build-agents/create-conversations#by-ethereum-address-1
+     * @see https://docs.xmtp.org/sdk/conversations/#create-a-dm
      */
     createDmWithIdentifier(identifier: Identifier, options?: CreateDmOptions): Promise<Dm<ContentTypes>>;
     /**
@@ -944,7 +1020,7 @@ declare class Conversations<ContentTypes = unknown> {
      * @param inboxId - Inbox ID for the DM recipient
      * @param options - Optional DM creation options
      * @returns The new DM
-     * @see https://docs.xmtp.org/agents/build-agents/create-conversations#by-inbox-id-1
+     * @see https://docs.xmtp.org/sdk/conversations/#create-a-dm
      */
     createDm(inboxId: string, options?: CreateDmOptions): Promise<Dm<ContentTypes>>;
     /**
@@ -952,7 +1028,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param options - Optional filtering and pagination options
      * @returns Array of conversations
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/list
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     list(options?: ListConversationsOptions): Promise<(Group<ContentTypes> | Dm<ContentTypes>)[]>;
     /**
@@ -960,7 +1036,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param options - Optional filtering and pagination options
      * @returns Array of groups
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/list#list-existing-conversations
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     listGroups(options?: Omit<ListConversationsOptions, "conversationType">): Group<ContentTypes>[];
     /**
@@ -968,14 +1044,14 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param options - Optional filtering and pagination options
      * @returns Array of DMs
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/list#list-existing-conversations
+     * @see https://docs.xmtp.org/sdk/conversations/
      */
     listDms(options?: Omit<ListConversationsOptions, "conversationType">): Dm<ContentTypes>[];
     /**
      * Synchronizes conversations for the current client from the network
      *
      * @returns Promise that resolves when sync is complete
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/sync-and-syncall
+     * @see https://docs.xmtp.org/sdk/sync/
      */
     sync(): Promise<void>;
     /**
@@ -984,7 +1060,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param consentStates - Optional array of consent states to filter by
      * @returns Promise that resolves when sync is complete
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/sync-and-syncall#sync-all-new-welcomes-conversations-messages-and-preferences
+     * @see https://docs.xmtp.org/sdk/sync/
      */
     syncAll(consentStates?: ConsentState[]): Promise<_xmtp_node_bindings.GroupSyncSummary>;
     /**
@@ -993,7 +1069,7 @@ declare class Conversations<ContentTypes = unknown> {
      * @param options - Optional stream options
      * @param options.conversationType - Optional conversation type to filter by
      * @returns Stream instance for new conversations
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/stream#stream-new-group-chat-and-dm-conversations
+     * @see https://docs.xmtp.org/sdk/stream/#stream-methods
      */
     stream(options?: StreamOptions<Conversation$1, Group<ContentTypes> | Dm<ContentTypes> | undefined> & {
         conversationType?: ConversationType;
@@ -1003,7 +1079,7 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param options - Optional stream options
      * @returns Stream instance for new group conversations
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/stream#stream-new-group-chat-and-dm-conversations
+     * @see https://docs.xmtp.org/sdk/stream/#stream-methods
      */
     streamGroups(options?: StreamOptions<Conversation$1, Group<ContentTypes>>): Promise<AsyncStreamProxy<Group<ContentTypes>>>;
     /**
@@ -1011,44 +1087,59 @@ declare class Conversations<ContentTypes = unknown> {
      *
      * @param options - Optional stream options
      * @returns Stream instance for new DM conversations
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/stream#stream-new-group-chat-and-dm-conversations
+     * @see https://docs.xmtp.org/sdk/stream/#stream-methods
      */
     streamDms(options?: StreamOptions<Conversation$1, Dm<ContentTypes>>): Promise<AsyncStreamProxy<Dm<ContentTypes>>>;
     /**
-     * Creates a stream for all new messages
+     * Reads retained messages after each group's default acknowledgement position.
+     * Set `from` to replay after a cursor without changing default progress.
+     * Set `onValue` for callback mode, or request items with the iterator.
+     * Core owns network recovery. Legacy retry options and `disableSync` do not apply.
      *
      * @param options - Optional stream options
      * @param options.conversationType - Optional conversation type to filter by
      * @param options.consentStates - Optional array of consent states to filter by
      * @returns Stream instance for new messages
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/stream#stream-new-group-chat-and-dm-messages
+     * @see https://docs.xmtp.org/sdk/stream/#stream-methods
      */
     streamAllMessages(options?: StreamOptions<Message, DecodedMessage<ContentTypes>> & {
         conversationType?: ConversationType;
         consentStates?: ConsentState[];
-    }): Promise<AsyncStreamProxy<DecodedMessage<ContentTypes>>>;
+        groupIds?: string[];
+        from?: DeliveryCursor;
+    }): Promise<MessageStream<Message, DecodedMessage<ContentTypes>>>;
+    messageHistorySnapshot(limit: number, options?: {
+        groupIds?: string[];
+        conversationType?: ConversationType;
+        consentStates?: ConsentState[];
+    }): _xmtp_node_bindings.MessageHistorySnapshot;
+    beginningDeliveryCursor(): DeliveryCursor;
     /**
-     * Creates a stream for all new group messages
+     * Reads retained group messages with default progress or an explicit replay cursor.
      *
      * @param options - Optional stream options
      * @param options.consentStates - Optional array of consent states to filter by
      * @returns Stream instance for new group messages
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/stream#stream-new-group-chat-and-dm-messages
+     * @see https://docs.xmtp.org/sdk/stream/#stream-methods
      */
     streamAllGroupMessages(options?: StreamOptions<Message, DecodedMessage<ContentTypes>> & {
         consentStates?: ConsentState[];
-    }): Promise<AsyncStreamProxy<DecodedMessage<ContentTypes>>>;
+        groupIds?: string[];
+        from?: DeliveryCursor;
+    }): Promise<MessageStream<Message, DecodedMessage<ContentTypes>>>;
     /**
-     * Creates a stream for all new DM messages
+     * Reads retained DM messages with default progress or an explicit replay cursor.
      *
      * @param options - Optional stream options
      * @param options.consentStates - Optional array of consent states to filter by
      * @returns Stream instance for new DM messages
-     * @see https://docs.xmtp.org/chat-apps/list-stream-sync/stream#stream-new-group-chat-and-dm-messages
+     * @see https://docs.xmtp.org/sdk/stream/#stream-methods
      */
     streamAllDmMessages(options?: StreamOptions<Message, DecodedMessage<ContentTypes>> & {
         consentStates?: ConsentState[];
-    }): Promise<AsyncStreamProxy<DecodedMessage<ContentTypes>>>;
+        groupIds?: string[];
+        from?: DeliveryCursor;
+    }): Promise<MessageStream<Message, DecodedMessage<ContentTypes>>>;
     /**
      * Creates a stream for message deletions that streams the message IDs of
      * deleted messages
@@ -1075,7 +1166,7 @@ declare class Conversations<ContentTypes = unknown> {
      * Gets the HMAC keys for all conversations
      *
      * @returns The HMAC keys for all conversations
-     * @see https://docs.xmtp.org/chat-apps/push-notifs/push-notifs#get-hmac-keys-for-a-conversation
+     * @see https://docs.xmtp.org/sdk/push-notifications/
      */
     hmacKeys(): Record<string, _xmtp_node_bindings.HmacKey[]>;
 }
@@ -1197,7 +1288,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?: DistributiveOmit<ClientOptions, "codecs"> & {
+    static create<ContentCodecs extends ContentCodec[] = []>(signer: Signer, options: DistributiveOmit<ClientOptions, "codecs"> & {
         codecs?: ContentCodecs;
     }): Promise<Client<ExtractCodecContentTypes<ContentCodecs>>>;
     /**
@@ -1210,7 +1301,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?: DistributiveOmit<ClientOptions, "codecs"> & {
+    static build<ContentCodecs extends ContentCodec[] = []>(identifier: Identifier, options: DistributiveOmit<ClientOptions, "codecs"> & {
         codecs?: ContentCodecs;
     }): Promise<Client<ExtractCodecContentTypes<ContentCodecs>>>;
     /**
@@ -1222,11 +1313,11 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      */
     get appVersion(): string | undefined;
     /**
-     * Gets the XMTP environment the client is connected to
+     * Gets the label used for the default database file name
      *
      * @throws {ClientNotInitializedError} if the client is not initialized
      */
-    get env(): XmtpEnv;
+    get env(): string;
     /**
      * Gets the client options
      */
@@ -1467,27 +1558,8 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @throws {SignerUnavailableError} if no signer is available
      */
     revokeInstallations(installationIds: Uint8Array[]): 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 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>;
+    /** Revoke installations with an explicit backend or network options. */
+    static revokeInstallations(signer: Signer, inboxId: string, installationIds: Uint8Array[], optionsOrBackend: NetworkOptions | Backend): Promise<void>;
     /**
      * Changes the recovery identifier for the client's inbox
      *
@@ -1556,66 +1628,12 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @throws {ClientNotInitializedError} if the client is not initialized
      */
     verifySignedWithInstallationKey(signatureText: string, signatureBytes: Uint8Array): boolean;
-    /**
-     * 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<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>>;
+    /** Fetch inbox states with an explicit backend or network options. */
+    static fetchInboxStates(inboxIds: string[], optionsOrBackend: NetworkOptions | Backend): Promise<_xmtp_node_bindings.InboxState[]>;
+    /** Fetch inbox update counts with an explicit backend or network options. */
+    static fetchLatestInboxUpdatesCount(inboxIds: string[], optionsOrBackend: NetworkOptions | Backend): Promise<Map<string, number>>;
+    /** Check identifiers with an explicit backend or network options. */
+    static canMessage(identifiers: Identifier[], optionsOrBackend: NetworkOptions | Backend): Promise<Map<string, boolean>>;
     /**
      * Verifies a signature was made with a public key
      *
@@ -1625,82 +1643,10 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @returns Whether the signature is valid
      */
     static verifySignedWithPublicKey(signatureText: string, signatureBytes: Uint8Array, publicKey: Uint8Array): boolean;
-    /**
-     * Checks if an address is authorized for an inbox
-     *
-     * @param inboxId - The inbox ID to check
-     * @param address - The address to check
-     * @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>;
-    /**
-     * Checks if an installation is authorized for an inbox
-     *
-     * @param inboxId - The inbox ID to check
-     * @param installation - The installation to check
-     * @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(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[];
+    /** Check address authorization with an explicit backend or network options. */
+    static isAddressAuthorized(inboxId: string, address: string, optionsOrBackend: NetworkOptions | Backend): Promise<boolean>;
+    /** Check installation authorization with an explicit backend or network options. */
+    static isInstallationAuthorized(inboxId: string, installation: Uint8Array, optionsOrBackend: NetworkOptions | Backend): Promise<boolean>;
     /**
      * Archive application elements to file for later restoration
      *
@@ -1734,7 +1680,176 @@ declare class Client<ContentTypes = ExtractCodecContentTypes> {
      * @returns Promise that resolves with a summary of the sync operation
      */
     syncAllDeviceSyncGroups(): Promise<GroupSyncSummary>;
+    /** Enable notifications and register the delivery channel. */
+    enableNotifications(config: NotificationConfig): Promise<NotificationState>;
+    /** Disable notifications. Per-conversation overrides remain stored. */
+    disableNotifications(): Promise<void>;
+    /** Read the local state without a backend request. */
+    notificationState(): Promise<NotificationState>;
+    /**
+     * What the deployment published about itself, as this client resolved it
+     * when it was built.
+     *
+     * Reads memory and makes no backend request. The value never changes for the
+     * life of the client: a background refresh rewrites the stored copy, and a
+     * new value takes effect at the next build.
+     *
+     * @throws {ClientNotInitializedError} if the client is not initialized
+     */
+    serverConfiguration(): ServerConfiguration;
+    /**
+     * Fetch the deployment configuration now, rewrite the stored copy, and
+     * return what was fetched.
+     *
+     * The snapshot this client holds is unchanged; use it to observe a change an
+     * operator has made without restarting.
+     *
+     * @throws {ClientNotInitializedError} if the client is not initialized
+     * @throws {ConfigurationUnavailableError} if the deployment did not answer
+     * @throws {ConfigurationInvalidError} if it published an unusable configuration
+     * @throws {BackendMismatchError} if it published a different identifier
+     * @throws {ClientVersionTooOldError} if it now requires a newer libxmtp
+     */
+    refreshServerConfiguration(): Promise<ServerConfiguration>;
+    /**
+     * Read what a deployment publishes about itself with no database, no client,
+     * and no credential.
+     *
+     * Lets an app learn `auth.enabled`, `auth.requiredScopes`, and the accepted
+     * smart contract wallet chains before it decides how to build a client.
+     * Nothing is stored and no identifier binding is applied.
+     *
+     * @param target - A backend URL, network options, or an existing backend
+     * @throws {ConfigurationUnavailableError} if the deployment did not answer
+     * @throws {ConfigurationInvalidError} if it published an unusable configuration
+     */
+    static fetchServerConfiguration(target: string | NetworkOptions | Backend): Promise<ServerConfiguration>;
+}
+
+type StreamFailureCause = {
+    kind: "target_pending" | "receipt_pending" | "processing_pending" | "blocked" | "storage" | "receiver" | "invalid_topic";
+    code: string | null;
+    message: string;
+    retryable: boolean;
+};
+type UnfinishedStreamTopic = {
+    topic: Uint8Array;
+    /** Null means that target capture did not complete. */
+    target: bigint | null;
+    received: bigint;
+    processed: bigint;
+    unresolvedWelcomes: bigint[];
+    inactive: boolean;
+    cause: StreamFailureCause | null;
+};
+type StreamBarrierFailure = {
+    reason: "blocked" | "deadline" | "cancelled";
+    unfinished: UnfinishedStreamTopic[];
+};
+type StreamFailureDetails = {
+    kind: "barrier" | "published_but_unconfirmed" | "catch_up";
+    code: string;
+    message: string;
+    retryable: boolean;
+    intentId: number | null;
+    publishedIntentIds: number[];
+    summary: {
+        messages: bigint;
+        conversations: bigint;
+        failed: bigint;
+        completed: boolean;
+    } | null;
+    barriers: StreamBarrierFailure[];
+};
+/**
+ * Reads structured progress from a stream, sync, or publication error.
+ * All sequence values are exact bigints. Invalid or absent details return undefined.
+ * A published-but-unconfirmed error does not mean that publication failed.
+ */
+declare const getStreamFailureDetails: (error: unknown) => StreamFailureDetails | undefined;
+
+/**
+ * Typed failures for the deployment configuration a backend publishes
+ * (spec 006 §7).
+ *
+ * The bindings report every one of these as an `Error` whose message begins
+ * with `[ClientError::<Variant>]`. Matching on that string is what this module
+ * removes: each of the six documented codes becomes its own class, so an app
+ * writes `error instanceof BackendMismatchError` instead of a regular
+ * expression over a message that may be reworded.
+ *
+ * Every class keeps the binding's message and the original error as `cause`,
+ * so the identifiers, versions, scopes, or chain the core reported are still
+ * readable for diagnostics.
+ */
+/**
+ * Base class of the six configuration failures. Catch this to handle any of
+ * them; catch a subclass to handle one.
+ */
+declare class ServerConfigurationError extends Error {
+    /** The stable code the bindings reported, e.g. `ClientError::AuthRequired`. */
+    readonly code: string;
+    constructor(
+    /** The stable code the bindings reported, e.g. `ClientError::AuthRequired`. */
+    code: string, message: string, options?: ErrorOptions);
+}
+/**
+ * The configuration could not be read: the deployment did not answer, answered
+ * `UNIMPLEMENTED` because it predates spec 006, or the copy could not be
+ * stored.
+ */
+declare class ConfigurationUnavailableError extends ServerConfigurationError {
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * The deployment answered with a configuration no client can use: an empty or
+ * malformed identifier, an unparseable minimum version, or a chain that is not
+ * a CAIP-2 identifier. Nothing is stored.
+ */
+declare class ConfigurationInvalidError extends ServerConfigurationError {
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * This database is bound to a different deployment. The identifier the backend
+ * published is not the one the database was created against. Recovery is a
+ * database created for the deployment the app now uses.
+ */
+declare class BackendMismatchError extends ServerConfigurationError {
+    constructor(message: string, options?: ErrorOptions);
+}
+/** The deployment requires a newer libxmtp than this SDK is built on. */
+declare class ClientVersionTooOldError extends ServerConfigurationError {
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * The deployment requires authentication and no credential source was
+ * configured. The message carries the scopes it requires.
+ */
+declare class AuthRequiredError extends ServerConfigurationError {
+    constructor(message: string, options?: ErrorOptions);
+}
+/**
+ * A smart contract wallet signature names a chain the deployment does not
+ * verify on. Raised before any network call, and only for signatures the app
+ * supplied.
+ */
+declare class ChainNotAcceptedError extends ServerConfigurationError {
+    constructor(message: string, options?: ErrorOptions);
 }
+/**
+ * Classifies an error from any SDK call as one of the six configuration
+ * failures, or `undefined` when it is something else.
+ *
+ * Use this where the SDK hands back the raw error, for instance a
+ * `ChainNotAcceptedError` raised deep inside a call that supplies a smart
+ * contract wallet signature.
+ */
+declare const toServerConfigurationError: (error: unknown) => ServerConfigurationError | undefined;
+/**
+ * Rethrows an error as its typed configuration failure, or unchanged when it
+ * is not one.
+ */
+declare const throwServerConfigurationError: (error: unknown) => never;
 
-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 };
+export { AccountAlreadyAssociatedError, AuthRequiredError, BackendMismatchError, ChainNotAcceptedError, Client, ClientNotInitializedError, ClientVersionTooOldError, CodecRegistry, ConfigurationInvalidError, ConfigurationUnavailableError, Conversation, Conversations, DEFAULT_RETRY_ATTEMPTS, DEFAULT_RETRY_DELAY, DebugInformation, DecodedMessage, Dm, Group, InboxReassignError, MessageStream, MissingContentTypeError, NotificationError, Preferences, ServerConfigurationError, SignerUnavailableError, StreamFailedError, StreamInvalidRetryAttemptsError, createBackend, createStream, generateInboxId, getInboxIdForIdentifier, getStreamFailureDetails, isActions, isAttachment, isGroupUpdated, isHexString, isIntent, isLeaveRequest, isMarkdown, isMultiRemoteAttachment, isReaction, isReadReceipt, isRemoteAttachment, isReply, isText, isTextReply, isTransactionReference, isWalletSendCalls, throwServerConfigurationError, toServerConfigurationError, validHex };
+export type { AsyncStreamProxy, AuthCallback, BuiltInContentTypes, ClientOptions, ContentOptions, Credential, DeviceSyncOptions, DistributiveOmit, EOASigner, EnrichedReply, ExtractCodecContentTypes, GetBlockNumber, GetChainId, GetIdentifier, HexString, MessageAcknowledgement, MessageDelivery, MessageReaderSource, NetworkOptions, NotificationChannel, NotificationConfig, NotificationOverride, NotificationState, OtherOptions, ResolveValue, SCWSigner, SignMessage, Signer, StorageOptions, StreamBarrierFailure, StreamCallback, StreamFailureCause, StreamFailureDetails, StreamFunction, StreamOptions, StreamValueMutator, UnfinishedStreamTopic };