Decentraland Social Client

Welcome to the Social Client library. This client can be used to interact Decentraland's users, providing the ability to send private messages and add people as friends.

Installation

npm install dcl-social-client

Usage

You can check the entire API here.

Behind the curtains

In order to provide reliable communication between users, this client connects to a Matrix server. In particular, we are using the Matrix JS SDK, since it provides easy ways to send messages of all kinds, raise events, and much more.

Refresh the API checks.

We use api-extractor to ensure not poisoning other projects with the types of the Matrix SDK. To do so, api-extractor bundles and checks that the bundle never breaks the types. The bundle is committed and should be generated every time the API changes by running

npm run build && npm run refresh-api

Contributing

Run

npm install
npm run build
npm run test