idm-bridge-postmsg

The postMessage bridge to be used by both IDM Wallets and IDM Clients.

Installation

$ npm install idm-bridge-postmsg

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

On the client-side of the bridge:

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 = 'http://nomios.io';

await (async () => {
    const clientSide = await createClientSide(app, idmWalletUrl);
})();

On the mediator-side of the bridge (operating on the wallet domain):

import { createMediatorSide } from 'idm-bridge-postmsg';

await (async () => {
    const options = {
        minWidth: 500 // Defaults to 620
        minHeight: 630 // Defaults to 700
    };

    const mediatorSide = await createMediatorSide(options);

    mediatorSide.setPrompts({
        unlock: ({ pristine, lockTypes, unlockFn }) => {
            // Show the lock screen and unlock with `unlockFn(lockType, input)`

            // response = { ok };
            return response;
        },
        authenticate: async ({ app, identities }) => {
            // Show a prompt to either accept or deny
            const response = await promptToAcceptAndChooseIdentity(app, identities);

            // response = { ok, identityId };
            return response;
        },
        sign: async ({ app, identity, data }) => {
            // Show a prompt to either accept or deny
            const response = await promptToAcceptSigning(app, identity, data);

            // response = { ok };
            return response;
        },
    });
})();

On the wallet-side of the bridge:

import { createWalletSide } from 'idm-bridge-postmsg';
import createIdmWallet from 'idm-wallet';

await (async () => {
    const idmWallet = await createIdmWallet();
    const walletSide = await createWalletSide(idmWallet);
})();

NOTE: To know if you either must use createMediatorSide or createWalletSide you may use the hasParent function:

import { hasParent } from 'idm-bridge-postmsg';

if (hasParent()) {
    // Create mediator side
} else {
    // Create wallet side
}

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.