Skip to content

Latest commit

 

History

History
192 lines (143 loc) · 5.14 KB

README.md

File metadata and controls

192 lines (143 loc) · 5.14 KB
Raw

CircleCI

Polkadot Registrar Service (beta)

An automated registrar service for Polkadot on-chain identities.

Registrar preview

About

This service ("the challenger") is responsible for veryifing accounts and providing a HTTP and websocket API to the UI. The full list of features includes:

  • Verification
    • Display name
    • Email
    • Twitter
    • Matrix
  • API
    • Websocket API for live notifications and state changes.
    • Rest API for display name checks.
  • Communication with the watcher
    • Request pending judgement.
    • Request active display names of other identities.
    • Send judgement to the watcher to issue a judgement extrinsic.
  • Manual judgements
    • The registrar supports manual judgements via a Matrix bot.

On judgement request, the challenger generates challenges for each specified account (email, etc.) of the identity and expects those challenges to be sent to the registrar service by the user for verification. Display names are verified by matching those with the display names of already verified identities and deciding on a judgement based on a similarity ranking.

Watcher Service

This service only verifies identities, but does not interact with the Kusama/Polkadot blockchain directly. Rather, it communicates with the watcher which is responsible for any blockchain interaction.

Web App / UI

The UI can be found in the www/ directory, which is automatically built and deployed via Github Actions.

Manual Judgements

In order to submit manual judgements, admins can join a room with the Matrix account of the registrar service as specified in the config. Admins are specified as:

admins:
  - '@admin1:matrix.org'
  - '@admin2:matrix.org'
  - '@admin3:matrix.org'

If there should not be any admins, then just set the value to admins: null. Those specified admins have the permission to send Matrix messages to the bot in order to perform an action.

Identity Status

  • status <ADDR> - Gets the (verbose) verification state.

E.g.

status 1a2YiGNu1UUhJtihq8961c7FZtWGQuWDVMWTNBKJdmpGhZP

Account Verification

  • verify <ADDR> [FIELD]... - Manually verifies the provided field(s).
    • Supported fields: legalname, displayname, email, web, twitter, matrix, all.

E.g.

verify 1a2YiGNu1UUhJtihq8961c7FZtWGQuWDVMWTNBKJdmpGhZP displayname email

NOTE: The all field, as the name implies, verifies the full identity and (re-)issues a judgement extrinsic.

Help

  • help - Displays a help message.

Setup

Config

Both types of configuration, respectively the adapter listener and session notifier can be seen in the config/ directory.

Adapter Listener

db:
  uri: mongodb://localhost:27017/
  name: registrar_db
instance:
  role: adapter_listener
  config:
    watcher:
      - network: kusama
        endpoint: ws://localhost:8000
      - network: polkadot
        endpoint: ws://localhost:8001
    matrix:
      enabled: false
      homeserver: homeserver
      username: username
      password: password
      db_path: db_path
      admins: null
    twitter:
      enabled: false
      api_key: key
      api_secret: secret
      token: token
      token_secret: secret
      request_interval: 300
    email:
      enabled: false
      smtp_server: server
      imap_server: server
      inbox: inbox
      user: user
      password: password
      request_interval: 5
    display_name:
      enabled: true
      limit: 0.85

Session Notifier

db:
  uri: mongodb://localhost:27017/
  name: registrar_db
instance:
  role: session_notifier
  config:
    api_address: 0.0.0.0:8000
    display_name:
      enabled: true
      limit: 0.85

Building

To build the binary:

$ apt-get update
$ apt-get -y install --no-install-recommends \
	lld pkg-config openssl libssl-dev gcc g++ clang cmake

And to run the service:

$ cargo run --release --bin registrar

To build the UI (adjust any values in the config):

$ cd www/
$ cat config.json
{
        "http_url": "https://registrar-backend.web3.foundation/api/check_display_name",
        "ws_url": "wss://registrar-backend.web3.foundation/api/account_status"
}
$ yarn build # output in dist/

Testing

The unit test need a Mongodb instance with enabled replica set listening on localhost:27017:

mongod --replSet "rs0"

Make sure to initialize the replicaset in the mongo shell:

rs.initiate()

To run the tests, set a low thread threshold otherwise there might be some database connection timeouts which result in an error when all tests runs all at once.

cargo test -- --test-threads=3