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 started

Installation

Web

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

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

Yarn

yarn add @walletconnect/chat-client @walletconnect/sync-client @walletconnect/core

Bun

bun add @walletconnect/chat-client @walletconnect/sync-client @walletconnect/core

pnpm

pnpm add @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

npm install lokijs --save

Yarn

yarn add lokijs

Bun

bun add lokijs --save

pnpm

pnpm add lokijs

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

iOS

Swift implementation of WalletConnect Chat protocol for native iOS applications.

Add SDK for your project.

You can add a WalletConnect SDK to your project with Swift Package Manager. In order to do that:

1. Open XCode
2. Go to File -> Add Packages
3. Paste the repo GitHub URL: https://github.com/WalletConnect/WalletConnectSwiftV2
4. Tap Add Package
5. Select WalletConnectChat check mark

Android

Kotlin implementation of WalletConnect v2 Chat protocol for Android applications. This SDK is developed in Kotlin and usable in both Java and Kotlin files.

Android Core Chat

Requirements

• Android min SDK 23
• Java 11

Installation

root/build.gradle.kts:

allprojects {
 repositories {
    mavenCentral()
    maven { url "https://jitpack.io" }
 }
}

app/build.gradle(kts)

implementation("com.walletconnect:android-core:release_version")
implementation("com.walletconnect:chat:release_version")

React Native

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

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

Yarn

yarn add @walletconnect/chat-client @walletconnect/sync-client @walletconnect/core

Bun

bun add @walletconnect/chat-client @walletconnect/sync-client @walletconnect/core

pnpm

pnpm add @walletconnect/chat-client @walletconnect/sync-client @walletconnect/core

Next Steps

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