Class Client<ContentTypes>

Type Parameters

ContentTypes extends DefaultContentTypes = DefaultContentTypes

Index

Constructors

Properties

conversations dbPath debugInformation environment inboxId installationId preferences publicIdentity codecRegistry

Methods

addAccount archiveMetadata canMessage createArchive decryptAttachment deleteLocalDatabase dropLocalDatabaseConnection encryptAttachment ffiAddEcdsaSignature ffiAddIdentitySignatureText ffiAddScwSignature ffiApplySignature ffiCreateSignatureText ffiRegisterIdentity ffiRemoveIdentitySignatureText ffiRevokeAllOtherInstallationsSignatureText ffiRevokeInstallationsSignatureText findInboxIdFromIdentity importArchive inboxState inboxStates reconnectLocalDatabase removeAccount revokeAllOtherInstallations revokeInstallations signWithInstallationKey verifySignature activatePersistentLibXMTPLogWriter build canMessage clearXMTPLogs create createRandom deactivatePersistentLibXMTPLogWriter dropClient exportNativeLogs ffiAddEcdsaSignature ffiAddScwSignature ffiApplySignatureRequest ffiCreateClient ffiRevokeInstallationsSignatureText getOrCreateInboxId getXMTPLogFilePaths inboxStatesForInboxIds isLogWriterActive readXMTPLogFile register revokeInstallations

Constructors

constructor

new Client<ContentTypes>(inboxId, installationId, dbPath, publicIdentity, environment, codecs?): Client<ContentTypes>
Type Parameters
- ContentTypes extends DefaultContentTypes = DefaultContentTypes
Parameters
- inboxId: string
- installationId: InstallationId
- dbPath: string
- publicIdentity: PublicIdentity
- environment: XMTPEnvironment
- codecs: ContentCodec<ContentTypes>[] = []
Returns Client<ContentTypes>
- Defined in src/lib/Client.ts:611

Properties

conversations

conversations: default<ContentTypes>

dbPath

dbPath: string

debugInformation

debugInformation: default

environment

environment: XMTPEnvironment

inboxId

inboxId: string

installationId

installationId: InstallationId

preferences

preferences: default

publicIdentity

publicIdentity: PublicIdentity

`Static` codecRegistry

codecRegistry: {
[key: string]: ContentCodec<unknown>;
}

Type declaration

[key: string]: ContentCodec<unknown>

Methods

addAccount

addAccount(newAccount, allowReassignInboxId?): Promise<void>
Add this account to the current inboxId. Adding a identity already associated with an inboxId will cause the identity to lose access to that inbox.
Parameters
- newAccount: Signer | {}
  The signer of the new account to be added.
- allowReassignInboxId: boolean = false
  A boolean specifying if the inboxId should be reassigned or not.
Returns Promise<void>
- Defined in src/lib/Client.ts:649

archiveMetadata

archiveMetadata(path, encryptionKey): Promise<ArchiveMetadata>
Retrieves metadata from an existing encrypted archive.
Parameters
- path: string
  The file system path of the archive.
- encryptionKey: Uint8Array<ArrayBufferLike>
  The encryption key used to decrypt the archive metadata.
Returns Promise<ArchiveMetadata>
A Promise that resolves to an ArchiveMetadata object.

Throws
Will reject if the archive is invalid or decryption fails.
- Defined in src/lib/Client.ts:1031

canMessage

canMessage(identities): Promise<{
[key: string]: boolean;
}>
Determines whether the current user can send messages to the specified peers.

This method checks if the specified peers are using clients that are on the network.
Parameters
- identities: PublicIdentity[]
  The identities of the peers to check for messaging eligibility.
Returns Promise<{
[key: string]: boolean;
}>
A Promise resolving to a hash of identifiers and booleans if they can message on the network.
- Defined in src/lib/Client.ts:943

createArchive

createArchive(path, encryptionKey, opts?): Promise<void>
Creates a new archive at the specified path with encryption.
Parameters
- path: string
  The file system path where the archive should be created.
- encryptionKey: Uint8Array<ArrayBufferLike>
  A binary encryption key (must match key used for decryption).
- Optional opts: ArchiveOptions
  Optional archive configuration settings.
Returns Promise<void>
A Promise that resolves when the archive is successfully created.

Throws
Will reject if the operation fails or parameters are invalid.
- Defined in src/lib/Client.ts:996

decryptAttachment

decryptAttachment(encryptedFile): Promise<DecryptedLocalAttachment>
Decrypts an encrypted local attachment.

This asynchronous method takes an encrypted local attachment and decrypts it.
Parameters
- encryptedFile: EncryptedLocalAttachment
  The encrypted local attachment to be decrypted.
Returns Promise<DecryptedLocalAttachment>
A Promise that resolves to the decrypted local attachment.

Throws
Throws an error if the attachment is not a local file URI (must start with "file://").
- Defined in src/lib/Client.ts:975

deleteLocalDatabase

deleteLocalDatabase(): Promise<any>
Deletes the local database. This cannot be undone and these stored messages will not be refetched from the network.

Returns Promise<any>
- Defined in src/lib/Client.ts:882

dropLocalDatabaseConnection

dropLocalDatabaseConnection(): Promise<any>
Drop the local database connection. This function is delicate and should be used with caution. App will error if database not properly reconnected. See: reconnectLocalDatabase()

Returns Promise<any>
- Defined in src/lib/Client.ts:889

encryptAttachment

encryptAttachment(file): Promise<EncryptedLocalAttachment>
Encrypts a local attachment for secure transmission.

This asynchronous method takes a file, checks if it's a local file URI, and encrypts the attachment for secure transmission.
Parameters
- file: DecryptedLocalAttachment
  The local attachment to be encrypted.
Returns Promise<EncryptedLocalAttachment>
A Promise that resolves to the encrypted local attachment.

Throws
Throws an error if the attachment is not a local file URI (must start with "file://").
- Defined in src/lib/Client.ts:958

ffiAddEcdsaSignature

ffiAddEcdsaSignature(signature): Promise<void>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use create() instead. Adds the Ecdsa signature to the identity to be registered
Parameters
- signature: Uint8Array<ArrayBufferLike>
Returns Promise<void>
- Defined in src/lib/Client.ts:1059

ffiAddIdentitySignatureText

ffiAddIdentitySignatureText(identityToAdd, allowReassignInboxId?): Promise<string>
This function is delicate and should be used with caution. Should only be used if trying to manage the create and register flow independently otherwise use addWallet() instead. Gets the signature text for the add identity action
Parameters
- identityToAdd: PublicIdentity
- allowReassignInboxId: boolean = false
Returns Promise<string>
- Defined in src/lib/Client.ts:1154

ffiAddScwSignature

ffiAddScwSignature(signature, address, chainId, blockNumber?): Promise<void>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use create() instead. Adds the SCW signature to the identity to be registered
Parameters
- signature: Uint8Array<ArrayBufferLike>
- address: string
- chainId: number
- Optional blockNumber: number
Returns Promise<void>
- Defined in src/lib/Client.ts:1071

ffiApplySignature

ffiApplySignature(): Promise<void>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use addAccount(), removeAccount(), or revoke() instead. Applys the signature after adding signature

Returns Promise<void>
- Defined in src/lib/Client.ts:1173

ffiCreateSignatureText

ffiCreateSignatureText(): Promise<string>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use create() instead. Gets the signature text to be signed

Returns Promise<string>
- Defined in src/lib/Client.ts:1047

ffiRegisterIdentity

ffiRegisterIdentity(): Promise<void>
This function is delicate and should be used with caution. Should only be used if trying to manage the create and register flow independently otherwise use create() instead. Registers the identity to the XMTP network

Returns Promise<void>
- Defined in src/lib/Client.ts:1094

ffiRemoveIdentitySignatureText

ffiRemoveIdentitySignatureText(identityToRemove): Promise<string>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use removeWallet() instead. Gets the signature text for the removed identity action
Parameters
- identityToRemove: PublicIdentity
Returns Promise<string>
- Defined in src/lib/Client.ts:1137

ffiRevokeAllOtherInstallationsSignatureText

ffiRevokeAllOtherInstallationsSignatureText(): Promise<string>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use revokeAllOtherInstallations() instead. Gets the signature text for the revoke installations action

Returns Promise<string>
- Defined in src/lib/Client.ts:1123

ffiRevokeInstallationsSignatureText

ffiRevokeInstallationsSignatureText(installationIds): Promise<string>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use revokeInstallations() instead. Gets the signature text for the revoke installations action
Parameters
- installationIds: InstallationId[]
Returns Promise<string>
- Defined in src/lib/Client.ts:1106

findInboxIdFromIdentity

findInboxIdFromIdentity(identity): Promise<undefined | string>
Find the InboxId associated with this identity
Parameters
- identity: PublicIdentity
  The identity of the peer to check for inboxId.
Returns Promise<undefined | string>
A Promise resolving to the InboxId.
- Defined in src/lib/Client.ts:870

importArchive

importArchive(path, encryptionKey): Promise<void>
Imports an existing archive from disk using the provided encryption key.
Parameters
- path: string
  The file system path of the archive to import.
- encryptionKey: Uint8Array<ArrayBufferLike>
  The encryption key that was used to secure the archive.
Returns Promise<void>
A Promise that resolves when the archive has been successfully imported.

Throws
Will reject if the archive cannot be found, is invalid, or the decryption fails.
- Defined in src/lib/Client.ts:1019

inboxState

inboxState(refreshFromNetwork): Promise<InboxState>
Make a request for your inbox state.
Parameters
- refreshFromNetwork: boolean
  If you want to refresh the current state of in the inbox from the network or not.
Returns Promise<InboxState>
A Promise resolving to a InboxState.
- Defined in src/lib/Client.ts:910

inboxStates

inboxStates(refreshFromNetwork, inboxIds): Promise<InboxState[]>
Make a request for a list of inbox states.
Parameters
- refreshFromNetwork: boolean
  If you want to refresh the current state the inbox from the network or not.
- inboxIds: string[]
  The inboxIds to get the associate inbox states for.
Returns Promise<InboxState[]>
A Promise resolving to a list of InboxState.
- Defined in src/lib/Client.ts:924

reconnectLocalDatabase

reconnectLocalDatabase(): Promise<any>
Reconnects the local database after being dropped.

Returns Promise<any>
- Defined in src/lib/Client.ts:900

removeAccount

removeAccount(signer, identityToRemove): Promise<void>
Remove this account from the current inboxId.
Parameters
- signer: Signer | {}
  The signer object used for authenticate the removal.
- identityToRemove: PublicIdentity
  The identity of the signer you'd like to remove from the account.
Returns Promise<void>
- Defined in src/lib/Client.ts:701

revokeAllOtherInstallations

revokeAllOtherInstallations(signer): Promise<void>
Revoke all other installations but the current one.
Parameters
- signer: null | Signer | {}
  The signer object used for authenticate the revoke.
Returns Promise<void>
- Defined in src/lib/Client.ts:796

revokeInstallations

revokeInstallations(signer, installationIds): Promise<void>
Revoke a list of installations.
Parameters
- signer: null | Signer | {}
  The signer object used for authenticate the revoke.
- installationIds: InstallationId[]
  A list of installationIds to revoke access to the inboxId.
Returns Promise<void>
- Defined in src/lib/Client.ts:749

signWithInstallationKey

signWithInstallationKey(message): Promise<Uint8Array<ArrayBufferLike>>
Sign this message with the current installation key.
Parameters
- message: string
  The message to sign.
Returns Promise<Uint8Array<ArrayBufferLike>>
A Promise resolving to the signature bytes.
- Defined in src/lib/Client.ts:840

verifySignature

verifySignature(message, signature): Promise<boolean>
Verify the signature was signed with this clients installation key.
Parameters
- message: string
  The message that was signed.
- signature: Uint8Array<ArrayBufferLike>
  The signature.
Returns Promise<boolean>
A Promise resolving to a boolean if the signature verified or not.
- Defined in src/lib/Client.ts:853

`Static` activatePersistentLibXMTPLogWriter

activatePersistentLibXMTPLogWriter(logLevel, logRotation, logMaxFiles): void
Activates persistent logging for libXMTP with specified configuration.
Parameters
- logLevel: LogLevel
  The minimum log level to record (e.g., debug, info, warn, error)
- logRotation: LogRotation
  How often the log files will rotate into a new file
- logMaxFiles: number
  Maximum number of log files to keep before rotation
Returns void
Promise that resolves when logging is activated
- Defined in src/lib/Client.ts:550

`Static` build

build<ContentCodecs>(identity, options, inboxId?): Promise<Client<ContentCodecs>>
Builds a instance of the Client class using the provided identity and chainId if SCW.
Type Parameters
- ContentCodecs extends DefaultContentTypes = DefaultContentTypes
Parameters
- identity: PublicIdentity
  The identity of the account to build
- options: ClientOptions & {
  codecs?: ContentCodecs;
  }
- Optional inboxId: string
Returns Promise<Client<ContentCodecs>>
A Promise that resolves to a new Client instance.

See XMTP Docs for more information.
- Defined in src/lib/Client.ts:222

`Static` canMessage

canMessage(env, identities): Promise<{
[key: string]: boolean;
}>
Determines whether the current user can send messages to the specified peers.

This method checks if the specified peers are using clients that are on the network.
Parameters
- env: XMTPEnvironment
  Environment to see if the identity is on the network for
- identities: PublicIdentity[]
  The identities of the peers to check for messaging eligibility.
Returns Promise<{
[key: string]: boolean;
}>
A Promise resolving to a hash of identifiers and booleans if they can message on the network.
- Defined in src/lib/Client.ts:377

`Static` clearXMTPLogs

clearXMTPLogs(): number
Clears all XMTP log files.

Returns number
Number of log files that were cleared
- Defined in src/lib/Client.ts:607

`Static` create

create<ContentCodecs>(signer, options): Promise<Client<ContentCodecs>>
Creates a new instance of the Client class using the provided signer.
Type Parameters
- ContentCodecs extends DefaultContentTypes = DefaultContentTypes
Parameters
- signer: null | Signer | {}
  The signer object used for authentication and message signing.
- options: ClientOptions & {
  codecs?: ContentCodecs;
  }
Returns Promise<Client<ContentCodecs>>
A Promise that resolves to a new Client instance.

See XMTP Docs for more information.
- Defined in src/lib/Client.ts:135

`Static` createRandom

createRandom<ContentTypes>(options): Promise<Client<ContentTypes>>
Creates a new instance of the XMTP Client with a randomly generated address.
Type Parameters
- ContentTypes extends DefaultContentTypes
Parameters
- options: ClientOptions & {
  codecs?: ContentTypes;
  }
Returns Promise<Client<ContentTypes>>
A Promise that resolves to a new Client instance with a random address.
- Defined in src/lib/Client.ts:94

`Static` deactivatePersistentLibXMTPLogWriter

deactivatePersistentLibXMTPLogWriter(): void
Deactivates the persistent log writer for libXMTP. This stops recording logs to persistent storage.

Returns void
Promise that resolves when logging is deactivated
- Defined in src/lib/Client.ts:568

`Static` dropClient

dropClient(installationId): Promise<any>
Drop the client from memory. Use when you want to remove the client from memory and are done with it.
Parameters
- installationId: InstallationId
Returns Promise<any>
- Defined in src/lib/Client.ts:308

`Static` exportNativeLogs

exportNativeLogs(): Promise<any>
Returns Promise<any>
- Defined in src/lib/Client.ts:49

`Static` ffiAddEcdsaSignature

ffiAddEcdsaSignature(signatureType, signature): Promise<void>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use create() instead. Adds the Ecdsa signature to the identity to be registered
Parameters
- signatureType: "revokeInstallations"
- signature: Uint8Array<ArrayBufferLike>
Returns Promise<void>
- Defined in src/lib/Client.ts:507

`Static` ffiAddScwSignature

ffiAddScwSignature(signatureType, signature, address, chainId, blockNumber?): Promise<void>
This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use create() instead. Adds the SCW signature to the identity to be registered
Parameters
- signatureType: "revokeInstallations"
- signature: Uint8Array<ArrayBufferLike>
- address: string
- chainId: number
- Optional blockNumber: number
Returns Promise<void>
- Defined in src/lib/Client.ts:522

`Static` ffiApplySignatureRequest

ffiApplySignatureRequest(env, signatureType): Promise<void>
⚠️ This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use revokeInstallations() instead

Applies the signature.
Parameters
- env: XMTPEnvironment
  Environment to apply the signature request
- signatureType: "revokeInstallations"
Returns Promise<void>
- Defined in src/lib/Client.ts:491

`Static` ffiCreateClient

ffiCreateClient<ContentCodecs>(identity, options): Promise<Client<ContentCodecs>>
⚠️ This function is delicate and should be used with caution. Creating an FfiClient without signing or registering will create a broken experience use create() instead

Creates a new instance of the Client class using the provided identity.
Type Parameters
- ContentCodecs extends DefaultContentTypes = DefaultContentTypes
Parameters
- identity: PublicIdentity
  The identity of the account to create
- options: ClientOptions & {
  codecs?: ContentCodecs;
  }
Returns Promise<Client<ContentCodecs>>
A Promise that resolves to a new Client instance.
- Defined in src/lib/Client.ts:267

`Static` ffiRevokeInstallationsSignatureText

ffiRevokeInstallationsSignatureText(env, identity, inboxId, installationIds): Promise<string>
⚠️ This function is delicate and should be used with caution. Should only be used if trying to manage the signature flow independently otherwise use revokeInstallations() instead

Revoke a list of installations. Revoking a installation will cause that installation to lose access to the inbox.
Parameters
- env: XMTPEnvironment
  Environment to revoke installation from.
- identity: PublicIdentity
- inboxId: string
- installationIds: InstallationId[]
Returns Promise<string>
- Defined in src/lib/Client.ts:465

`Static` getOrCreateInboxId

getOrCreateInboxId(identity, env): Promise<string>
Static method to determine the inboxId for the identity.
Parameters
- identity: PublicIdentity
  The identity of the peer to check for messaging eligibility.
- env: XMTPEnvironment
  Environment to get the inboxId from
Returns Promise<string>
- Defined in src/lib/Client.ts:361

`Static` getXMTPLogFilePaths

getXMTPLogFilePaths(): string[]
Gets the file paths of all XMTP log files.

Returns string[]
Array of file paths to log files
- Defined in src/lib/Client.ts:588

`Static` inboxStatesForInboxIds

inboxStatesForInboxIds(env, inboxIds): Promise<InboxState[]>
Determines whether the current user can send messages to the specified peers.

This method checks if the specified peers are using clients that are on the network.
Parameters
- env: XMTPEnvironment
  Environment to see if the identity is on the network for
- inboxIds: string[]
  The inboxIds to get the associated inbox states for.
Returns Promise<InboxState[]>
A Promise resolving to a list of inbox states.
- Defined in src/lib/Client.ts:393

`Static` isLogWriterActive

isLogWriterActive(): any
Checks if the persistent log writer is currently active. Note that persistent logging may be killed by OS when app is backgrounded. When app is foregrounded, logging will resume if isLogWriterActive is set to true.

Returns any
True if logging is active, false otherwise
- Defined in src/lib/Client.ts:579

`Static` readXMTPLogFile

readXMTPLogFile(filePath): Promise<string>
Reads the contents of a specific XMTP log file.
Parameters
- filePath: string
  Path to the log file to read
Returns Promise<string>
Promise resolving to the contents of the log file
- Defined in src/lib/Client.ts:598

`Static` register

register<T, Codec>(contentCodec): void
Type Parameters
- T
- Codec extends ContentCodec<T>
Parameters
- contentCodec: Codec
Returns void
- Defined in src/lib/Client.ts:636

`Static` revokeInstallations

revokeInstallations(env, signer, inboxId, installationIds): Promise<void>
Revoke a list of installations. Revoking a installation will cause that installation to lose access to the inbox.
Parameters
- env: XMTPEnvironment
  Environment to revoke installation from.
- signer: Signer | {}
  The signer of the recovery account to sign the revocation.
- inboxId: string
- installationIds: InstallationId[]
Returns Promise<void>
- Defined in src/lib/Client.ts:408

Class Client<ContentTypes>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Client<ContentTypes>

Properties

conversations

dbPath

debugInformation

environment

inboxId

installationId

preferences

publicIdentity

Static codecRegistry

Type declaration

[key: string]: ContentCodec<unknown>

Methods

addAccount

Parameters

Returns Promise<void>

archiveMetadata

Parameters

Returns Promise<ArchiveMetadata>

Throws

canMessage

Parameters

Returns Promise<{ [key: string]: boolean; }>

createArchive

Parameters

Returns Promise<void>

Throws

decryptAttachment

Parameters

Returns Promise<DecryptedLocalAttachment>

Throws

deleteLocalDatabase

Returns Promise<any>

dropLocalDatabaseConnection

Returns Promise<any>

encryptAttachment

Parameters

Returns Promise<EncryptedLocalAttachment>

Throws

ffiAddEcdsaSignature

Parameters

Returns Promise<void>

ffiAddIdentitySignatureText

Parameters

Returns Promise<string>

ffiAddScwSignature

Parameters

Returns Promise<void>

ffiApplySignature

Returns Promise<void>

ffiCreateSignatureText

Returns Promise<string>

ffiRegisterIdentity

Returns Promise<void>

ffiRemoveIdentitySignatureText

Parameters

Returns Promise<string>

ffiRevokeAllOtherInstallationsSignatureText

Returns Promise<string>

ffiRevokeInstallationsSignatureText

Parameters

Returns Promise<string>

findInboxIdFromIdentity

Parameters

Returns Promise<undefined | string>

importArchive

Parameters

Returns Promise<void>

Throws

`Static` codecRegistry

Returns Promise<{
[key: string]: boolean;
}>

`Static` activatePersistentLibXMTPLogWriter

`Static` build

`Static` canMessage

Returns Promise<{
[key: string]: boolean;
}>

`Static` clearXMTPLogs

`Static` create

`Static` createRandom

`Static` deactivatePersistentLibXMTPLogWriter

`Static` dropClient

`Static` exportNativeLogs

`Static` ffiAddEcdsaSignature

`Static` ffiAddScwSignature

`Static` ffiApplySignatureRequest

`Static` ffiCreateClient

`Static` ffiRevokeInstallationsSignatureText

`Static` getOrCreateInboxId

`Static` getXMTPLogFilePaths