Cliente JavaScript

Esta documentação foi extraída de social-rpc-client-js

Configuração básica e utilização

Para usar o client, instale o pacote no seu projeto NPM:

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

Importe a função de criação do client do pacote instalado:

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

Crie uma nova instância de client fornecendo ao client:

1. Um URL para a API REST do Social Service

2. Um URL para o endpoint WebSocket do Social Service

3. O endereço do utilizador (o mesmo usado para assinar a identidade)

4. Uma identidade, assinada com a wallet do utilizador.

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

// Gere uma wallet aleatória para fins de teste ou use a do utilizador em ambientes de produção.
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
);

O createSocialClient irá ligar, executará as operações necessárias para se ligar ao Social Service e devolverá o client ligado.

Use o client para interagir com o 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)
}

O client expõe os métodos disponíveis através do social protobuff e um método disconnect que desconecta o client do Social Service.

Gerar uma identidade

Para autenticar utilizadores com o Social Service, terá de gerar uma identidade para eles. Para tal, a @dcl/crypto biblioteca disponibiliza o Authenticator.initializeAuthChain método. Use-o para gerar uma identidade para os seus utilizadores:

  import { Wallet } from 'ethers'
  import { Authenticator } from '@dcl/crypto'
  // Gere uma wallet aleatória para fins de teste ou use a do utilizador em ambientes de produção.
  const userWallet = Wallet.createRandom()

  // Gere uma identidade para o utilizador.
  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))