Cliente de JavaScript

Esta documentación se extrae de social-rpc-client-js

Configuración básica y uso

Para usar el client, instala el paquete en tu proyecto NPM:

npm install -S @dcl/social-rpc-client

Importa la función creadora del client desde el paquete instalado:

import { createSocialClient } from "@dcl/social-client";

Crea una nueva instancia del client proporcionando al client:

1. Una URL para la REST API del Social Service

2. Una URL para el endpoint WebSocket del Social Service

3. La dirección del usuario (la misma que se usa para firmar la identidad)

4. Una identidad, firmada con la wallet del usuario.

import { createSocialClient } from "@dcl/social-client";
import { Wallet } from 'ethers'

// Genera una wallet aleatoria con fines de prueba o usa la del usuario en entornos de producción.
const wallet = Wallet.createRandom()
const identity = await createIdentity(wallet, expiration)

const socialClient = await createSocialClient(
  "https://social.decentraland.org",
  "wss://social-service.decentraland.org",
  wallet.address,
  identity
);

El createSocialClient se conectará, realizará las operaciones necesarias para conectarse al Social Service y devolverá el client conectado.

Usa el client para interactuar con el Social Service:

import { createSocialClient } from "@dcl/social-client";

const socialClient = await createSocialClient(
  "https://social.decentraland.org",
  "wss://social-service.decentraland.org",
  wallet.address,
  identity
);

const friends = socialClient.getFriends()
for await (const friend of friends) {
  console.log(friend)
}

El client expone los métodos disponibles a través del protobuff social y un método de desconexión que desconecta el client del Social Service.

Generando una identidad

Para autenticar a los usuarios con el Social Service, necesitarás generar una identidad para ellos. Para hacerlo, la @dcl/crypto library proporciona el Authenticator.initializeAuthChain método. Úsalo para generar una identidad para tus usuarios:

  import { Wallet } from 'ethers'
  import { Authenticator } from '@dcl/crypto'
  // Genera una wallet aleatoria con fines de prueba o usa la del usuario en entornos de producción.
  const userWallet = Wallet.createRandom()

  // Genera una identidad para el usuario.
  const address = await userWallet.getAddress()
  const ephemeralWallet = Wallet.createRandom()
  const payload = {
    address: ephemeralWallet.address,
    privateKey: ephemeralWallet.privateKey,
    publicKey: ephemeralWallet.publicKey
  }
  const identity = await Authenticator.initializeAuthChain(address, payload, expiration, (message: string) => signer.signMessage(message))