0.3.0 • Published 9 months ago

@mdip/gatekeeper v0.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

MDIP Gatekeeper

Gatekeeper is a node library for the MDIP. It manages a local database of DIDs on the MDIP network. Gatekeeper functions are used to Create, Read, Update, and Delete DIDs (CRUD).

Installation

npm install @mdip/gatekeeper

Usage

Library

The library must be configured by calling the start function with one of the supported databases:

  • JSON - @mdip/gatekeeper/db/json
  • sqlite - @mdip/gatekeeper/db/sqlite
  • mongodb - @mdip/gatekeeper/db/mongodb
import * as gatekeeper from '@mdip/gatekeeper/lib';
import * as json_db from '@mdip/gatekeeper/db/json';

await json_db.start('mdip-test');
await gatekeeper.start(json_db);

const did = 'did:test:did:test:z3v8AuaTV5VKcT9MJoSHkSTRLpXDoqcgqiKkwGBNSV4nVzb6kLk';
const docs = await gatekeeper.resolveDID(did);
console.log(JSON.stringify(docs, null, 4));

REST SDK

The SDK is used to communicate with a Gatekeeper REST API service.

import * as gatekeeper from '@mdip/gatekeeper/sdk';

gatekeeper.setURL('http://gatekeeper-host:4224');
await gatekeeper.waitUntilReady();

const did = 'did:test:did:test:z3v8AuaTV5VKcT9MJoSHkSTRLpXDoqcgqiKkwGBNSV4nVzb6kLk';
const docs = await gatekeeper.resolveDID(did);
console.log(JSON.stringify(docs, null, 4));