gentlementlegen / command-query-user

Queries a user and retrieves its related information, such as the wallet, the label access control, or the current XP.

@ubiquibot/command-query-user

This package helps users querying their information, from they wallet address, label access control or current XP.

Usage

The following commands are allowed:

/query @user

Running locally

Supabase types

You can run the type generations against a local database with

yarn supabase:generate:local

Or against an instance by setting the SUPABASE_ACCESS_TOKEN and SUPABASE_PROJECT_ID in your .env file

yarn prebuild

Worker

Start the Worker by running

yarn dev

Make requests

To trigger the worker, POST requests should be made to http://localhost:4000 with a Content-Type: application/json header and a body looking like

{
  "stateId": "",
  "eventName": "",
  "eventPayload": "",
  "settings": "",
  "ref": ""
}

For convenience, you can find an .http file with a valid request here.

Configuration

A valid configuration can be like:

- plugin: https://ubiquibot-command-query-user.ubq.fi
  with:
    allowPublicQuery: true

Testing

Jest

To start Jest tests, run

yarn test