Nimiq Keyguard(-next)

This README is about setting up your own instances of Nimiq Keyguard.

For information about using the client please refer to the Keyguard Client README.

Development

Install the dev dependencies:

yarn

Then you can:

• run the build script with yarn build [config].
• run the tests with yarn test.
• run the typechecker with yarn typecheck.
• run the typecheck file watcher with yarn watch.
• run the linter with yarn lint.
• automatically fix basic things like spacing, commas, indentation and quotes with yarn lintfix.
• run yarn pr to run all three checks (typecheck, lint, test) as they would for a PR.

Note that it is mostly not necessary to run the build script for development purposes, as the code in src is fully functional and you can use it as an endpoint.

Coding Style

• Code style is enforced with ESLint. Run yarn lint to see errors.
• Folder names are in Kebab Case: sign-transaction.
• Class files are named in Pascal Case: PinInput.js, RpcServer.js.
• JSDoc @type and @param annotations must have a hyphen between the argument name and description:

/**
 * @param {string} address - The address to search for
 */

• Folder structure:

- src
    - lib
    - components
    - request
- types
- tests
- config
- tools
- demos
- client
    - src
    - types

Configuration

You can configure the following values by either environment variables or configuration files:

• KEYGUARD_ALLOWED_ORIGIN: The origin from which requests are accepted. '*' allows all origins. Be aware that slashes have to be masked by \. Defaults to 'https://accounts.nimiq-testnet.com'.
• KEYGUARD_CDN: The CDN (content delivery network) from which the core library is served. Defaults to 'https://cdn.nimiq-testnet.com'.

The best way is to use a configuration file, which has to be placed in the config folder, and pass its name as an argument to the build script. yarn build local uses local.conf. Some sample files are provided.

If you have a CI (Continuous Integration) which builds on your webserver, you can also set those values in your server's configuration via environment variables. Please refer to your server's configuration, e.g. [https://httpd.apache.org/docs/2.4/env.html] for Apache.

In any case, please note that those settings are compile-time, so you have to rebuild to update them.

I18n usage

Setup

First, import the I18n.js lib in your HTML's head section. Then, setup your dictionary (details see below) and initialize I18n passing your dictionary and the fallback language that should be used if no translation in the current language has been found.

var myDictionary = {
    'en': {
        ...
    }
};

I18n.initialize(myDictionary, 'en');

I18n will automatically use the language set up in the user's browser.

Translate tag content

<div data-i18n="my-translation">My content</div>

When the I18n gets started, or when the language has been switched, it will look for tags with the data-i18n attribute and put in the appropriate translation. My content will be replaced.

Translate placeholders and value

<input data-i18n-placeholder="my-placeholder-translation"/>
<input data-i18n-value="my-value-translation"/>

Similarily, I18n will translate the texts for value and placeholder.

Dictionary

Format:

{
    "en": {
        "my-translation": "Content in English"
    },
    "de": {
        "my-translation": "Inhalt auf Deutsch"
    }
}

Language picker

Add LanguagePicker.js to your head and then add a language picker widget to your page:

    const languagePicker = new LanguagePicker();
    document.body.appendChild(languagePicker.getElement());