README.md

idm-client

The reference implementation of the IDM Client in JavaScript. This library is intended to be used by DApps.

Installation

$ npm install idm-client

This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.

Usage

import createIdmClient from 'idm-client';
import { createClientSide } from 'idm-bridge-postmsg';

const app = {
    name: 'My app name',
    iconUrl: 'https://my.app.com/favicon.png',
    homepageUrl: 'https://my.app.com',
};

const idmWalletUrl = 'https://nomios.io';

await (async () => {
    const idmBridge = await createClientSide(idmWalletUrl);
    const idmClient = await createIdmClient(app, bridge);
})();

API

This library is following closely the IDM Wallet Specification.

We will be providing proper API documentation once the both this library and the specification mature.

Tests

$ npm test
$ npm test -- --watch # during development

License

Released under the MIT License.