XMTP-JS
The xmtp-js client implementation is written in TypeScript for use with JavaScript applications.
Getting started
xmtp-js can be installed from NPM using npm install @xmtp/xmtp-js or cloned directly from its GitHub repository. Detailed documentation of the package can be found here.
Functionality overview
| Function | Description |
|---|---|
| Wallet-based authentication | Connecting to a user's wallet in order to get the wallet address, to sign keys used for message signing and encryption, and to authenticate incoming messages |
| Wallet connection management | Managing changes in wallet addresses or chain ids; managing connection issues |
| Key pair generation | Creating keys used for message signing and encryption, and advertising them to the network |
| Key storage | Storing keys securely |
| Key signing | Signing keys with a connected wallet |
| Relationship initiation | Creating a secure messaging relationship between two wallets |
| Conversation initiation | Creating a container of messages between two wallets |
| Message sending | Capturing plaintext and submitting it to the network |
| Message history retrieval | Retrieving the history of messages between two wallets. Filterable by date range. |
| Message streaming | Receiving new messages in real-time |
| Message content validation | Middleware for ensuring security of messages |
| Message format validation | Middleware for ensuring messages are properly formatted for the network |