README.md

• Introduction
• What is Nova Spektr
  • Key features
  • Changelog
• Development
  • Requirements
  • Commands
  • Project localisation
• Contributing
• Support

Introduction

What is Nova Spektr

Polkadot & Kusama ecosystem Enterprise Desktop application.

Key features

1. Hardware wallet (Polkadot Vault) support
2. Multishard wallet and multishard operations
3. Show wallet balances for any supported token (assets, ORML, balances)
4. Token transfer for any supported token (assets, ORML, balances)
5. Multisig account and transactions without passing callData off-chain
6. Relay Chain staking

Changelog

Detailed changelog with releases description is located in the changelog file.

Development

Requirements

Minimum version of Node.js is v20.x.

Minimum version of pnpm is v9.x.

Commands

# Setup dev environment.
pnpm install

# Start Electron and prebuild app in staging mode. You can also access app with browser.
pnpm preview

# Start Electron app in dev mode. You can also access app with browser.
pnpm start

# Start renderer without Electron (not recommended).
pnpm start:renderer

# Run unit tests for renderer.
pnpm test

# Run linter.
pnpm lint

# Run typescript typechecker.
pnpm types

# Build app in staging mode.
pnpm staging:sequence

# Build app in production mode.
pnpm prod:sequence

Difference between environments

Development configuration uses:

1. chains_dev.json file that contains testnets in order to debug and test new features
2. debug tools are enabled by default
3. error handling is turned off in order to pay developer's attention to errors

Stage configuration uses:

1. chains.json file for chains configuration
2. debug tools are enabled by default
3. errors are handled in a smooth way in order not to interrupt the user

Production configuration uses:

1. chains.json file for chains configuration
2. debug tools are disabled by default
3. errors are handled in a smooth way in order not to interrupt the user

Project localisation

All the localisation files are stored in the /src/shared/i18n/locales folder.

ESlint checks if localisation files are well-formed and valid including:

1. Valid json formatting
2. Json files contain the same set of keys
3. Each key contains the same amount of placeholders for all locales
4. All tsx files are translated

How to ignore localisation errors

In some cases there is no need to translate the text, so ESlint ignore rules should be used.

<span className="font-bold">
  {/* eslint-disable-next-line i18next/no-literal-string */}
  {data?.asset.symbol} ({data?.asset.name})
</span>

or

//eslint-disable-next-line i18next/no-literal-string
const qrCodePayload = `substrate:${address}:${wallet.accountId}`;

Troubleshooting

Log files help to solve your problem. Logs are collected in the nova-spektr.log that is located in the folder:

1. macOS ~/Library/Logs/nova-spektr/nova-spektr.log
2. Windows %USERPROFILE%\AppData\Roaming\nova-spektr\logs\nova-spektr.log
3. Linux ~/.config/nova-spektr/logs/nova-spektr.log

Sharing logs when you're contacting the support will speed up the problem fix.

Contributing

Contributing guide is described in the CONTRIBUTING.md

Support

Check the official support channels:

1. wiki (https://docs.novaspektr.io)
2. Telegram group
3. GitHub issues

All issues are being tracked in the Nova Spektr Support project

Feedback

Your feedback is welcome. Use GitHub issues for submitting the feedback. All feedback is being tracked in the Nova Spektr Feedback project

License

Nova Spektr - Polkadot, Kusama enterprise application is available under the Apache 2.0 license. See the LICENSE file for more info. © Novasama Technologies GmbH 2023