XMTP-JS SDK

xmtp-js provides a TypeScript implementation of the XMTP client protocol for use with JavaScript and React applications.

For xmtp-js TypeDocs, see https://xmtp-js.pages.dev/.

Overview of functions

Function	Description
Wallet-based authentication	Connect to a user's wallet to get the wallet address, sign keys used for message signing and encryption, and authenticate incoming messages.
Wallet connection management	Manage changes in wallet addresses or chain IDs. Manage connection issues.
Key pair generation	Create keys used for message signing and encryption and advertising public keys to the network.
Key storage	Store keys securely.
Key signing	Sign keys with a connected wallet.
Relationship initiation	Create a secure messaging relationship between two wallets.
Conversation initiation	Create a container of messages between two wallets.
Message sending	Capture plaintext and submit it to the network.
Message history retrieval	Retrieve the history of messages between two wallets, filterable by date range.
Message streaming	Receive new messages in real-time.
Message content validation	Ensure message security using this middleware.
Message format validation	Ensure messages are properly formatted for the XMTP network using this middleware.

Explore example-chat-react on GitHub, an example React app for xmtp-js that you can customize and deploy.
Try the hosted deployment of example-chat-react.

Have questions? Get help from the XMTP community on Discord. Request access