Skip to main content

Introduction

WalletConnect Chat is a direct messaging protocol that can enable wallets to message each other. The Chat API allows wallet users to message 1-on-1 with other wallet users in the WalletConnect network by using wallet addresses as identities to establish end-to-end messaging between peers.

Don't have a project ID?

Head over to WalletConnect Cloud and create a new project now!

Get startedcloud illustration

Installation​

caution

The WalletConnect Chat SDK is currently in Alpha and is not production-ready.

Its public API and associated documentation may still see significant and breaking changes.

Install Packages​

Install the WalletConnect ChatClient package.

npm install @walletconnect/chat-client @walletconnect/sync-client @walletconnect/core

If you are using the SDK on a server (such as Node.js), you will need to install an additional package:

npm install lokijs --save

This step is not required if you are using the SDK on the browser-side.

Next Steps​

The next section will walk you through the process of setting up your project to use the library.