Nexus Wallet Module Documentation

DEPRECATED! Nexus Wallet Module documentation has been moved to https://github.com/Nexusoft/NexusInterface/tree/master/docs/Modules

Project maintained by Nexusoft Hosted on GitHub Pages — Theme by mattgraham

nxs_package.json

nxs_package.json is a mandatory file that all Nexus Wallet Modules must contain, and must be located in the top-level directory of the module.

nxs_package.json contains most meta-data about the module, and helps Nexus Wallet identify if a directory is a module or not.

As the name suggests, nxs_package.json is inspired by npm’s package.json file, plays a pretty similar role in Nexus Wallet Modules as package.json does in npm packages, and has many similar fields as in package.json.

Schema

`name`

Mandatory
Type: string
Constraints: only accepts lowercase letters, digits, underscores (_) and dashes (-)

This will be used as the unique identifier of your module. If more than one modules with the same name are installed in a wallet, only one of them will work. Currently there hasn’t been a central “module store” that hosts all the Nexus Wallet Modules available, so naming collision must be taken care by the module developers yourself. When you need to name your module, please do some basic searching to see if there is already an existing module with the same name on the public.

`displayName`

Mandatory
Type: string
Constraints: no newline characters

A user-friendly name to be displayed on the GUI and most other places where your module name is needed.

Should not be too different from the name field.

`version`

Mandatory
Type: string
Constraints: must be a valid semver version

The version of your module.

`specVersion`

Mandatory
Type: string
Constraints: must be a valid semver version

The version of the Nexus Wallet Module Specifications that this version of your module was built on.

If this specVersion is lower than the lowest Spec version that user’s wallet supports, your module will be marked “invalid” and will not work.

`type`

Mandatory
Type: string
Constraints: possible values are app (the only supported module type currently)

The type of your module. This decides how your module will be used in the wallet. See Module types for more details.

`options`

Optional
Type: object

Constraints:

Available options:

{
// Whether the module's webview is wrapped inside a panel
// Only available with `app` type modules
wrapInPanel: boolean
}

`files`

Mandatory
Type: string[]
Constraints:
- Elements must be valid internal file paths
- Cannot have the same path with one of the following files: nxs_package.json, repo_info.json, storage.json
- All listed files must exist

This is where you should list ALL the files needed to run your module (without wildcards). Only those files that present in this list will be copied over when users install your module their wallets, so please don’t miss any file.

`description`

Optional
Type: string
Constraints: none

A brief description about your module.

`entry`

Optional
Type: string
Constraints: internal file paths

Path to the entry file of your module. The type of entry file depends on the module type. If your module is of type app, your entry file must be in .html format. See HTML entry file section for more details.

`icon`

Optional
Type: string
Constraints: internal file paths

Path to the icon of you module. See Module icon for more details.

`author`

Optional
Type: object
Constraints:
- Object schema:
```
{
name: string,
email: string
}
```
- name field is required

Information about the module’s author.

Commonly used constraints

Internal file paths

Must be relative paths, absolute paths are not allowed.
Wildcards are not allowed.
Parent directory notations (../) are not allowed.