Skip to content

Latest commit

 

History

History
116 lines (99 loc) · 4.26 KB

README.md

File metadata and controls

116 lines (99 loc) · 4.26 KB
Raw

@dotbit/plugin-web3mq

This is an official plugin integrating the brilliant Web3MQ with .bit.

Web3MQ is Web3-native communications protocol native to wallets and contracts.

Properties

name type Parameters Description
web3Mq Client Web3-MQ Client

Methods

name type Parameters Description response
searchWeb3mqUser function 1. did: string 2.didType: DID_TYPE_ENUM [{userid: string}]
sendMessageToUser function 1. msg: string 2. userId: string void
onMessage function callback void
getMessageList function 1. pageOption:{page: number, size: number} 2. userid: string void

types

DID_TYPE_ENUM

  export enum DID_TYPE_ENUM {
    ETH = 'ETH',
    WEB3_MQ = 'web3-mq',
    DOTBIT = 'dotbit',
    ENS = 'ens',
  }

Usage

onMessage()

'onMessage' function is used to subscribe to the 'message.getlist' and 'message.Delivered' events in web3MQ. The user can get the latest message list in the callback function.

import { createInstance, sleep } from "dotbit";
import { BitPluginWeb3MQ, DID_TYPE_ENUM } from "plugin-web3mq";
const plugin = new BitPluginWeb3MQ('vAUJTFXbBZRkEDRE');
await dotbit.installPlugin(plugin);

dotbit.onMessage(function (event: any) {
    console.log(event);
    if (!dotbit.web3Mq) {
        return false;
    }
    const { messageList, msg_text } = dotbit.web3Mq.message;
    if (event.type === "message.getList") {
        // final message list
        console.log(messageList, "messageList");
    }

    if (event.type === "message.delivered") {
        const list = messageList || [];
        // new sent message
        let newSentMessage = {
            content: msg_text,
            id: list.length + 1,
            senderId: dotbit.web3Mq.keys.userid || "Unnamed",
        };
        // final messag list
        console.log([...list, newSentMessage], "final message list");
    }
});

searchWeb3mqUser()

Query web3mq user information based on user addresses of different platforms.

  • Query the account information of ETH linked to web3mq.
  • Query the account information of .bit linked to web3mq.
  • Query the account information of web3mq through userid.
  • Query the account information of ENS linked to web3mq(Coming soon).
import { createInstance, sleep } from "dotbit";
import { BitPluginWeb3MQ, DID_TYPE_ENUM } from "plugin-web3mq";
const plugin = new BitPluginWeb3MQ('vAUJTFXbBZRkEDRE');
await dotbit.installPlugin(plugin);
const res = await dotbit.searchWeb3mqUser(
  "0xbe29848b6ED4A78A02A06bA490Cf3B561Ab329e3",
  DID_TYPE_ENUM.ETH
);
console.log(res, "res");

sendMessageToUser()

send messsage with web3mq user. In the sendMessageToUser method, pass in the message content and the userid of the recipient user.

import { createInstance, sleep } from "dotbit";
import { BitPluginWeb3MQ, DID_TYPE_ENUM } from "plugin-web3mq";
const plugin = new BitPluginWeb3MQ('vAUJTFXbBZRkEDRE');
await dotbit.installPlugin(plugin);
const userId =
  "user:df327dc8c07ab20dba69e504881e82112736529c9751358b15fb5004a70f0c6b";
const res = await dotbit.sendMessageToUser(
  "hello!",
  userId
);
console.log(res, "res");

getMessageList()

Get a list of messages for the current channel.You need to Pass in the paging object and userid

import { createInstance, sleep } from "dotbit";
import { BitPluginWeb3MQ, DID_TYPE_ENUM } from "plugin-web3mq";
const plugin = new BitPluginWeb3MQ('vAUJTFXbBZRkEDRE');
await dotbit.installPlugin(plugin);

const userId =
  "user:df327dc8c07ab20dba69e504881e82112736529c9751358b15fb5004a70f0c6b";
await dotbit.getMessageList({ page: 1, size: 999 }, userId);
console.log(dotbit.web3Mq?.message.messageList);