Selfkey Identity Wallet

Coverage

master

dev

Overview

The Official SelfKey Identity Wallet for Desktop

Features

Storage of identity docs in the Identity Wallet locally on the user’s computer
Marketplace where the user can view a list of available Exchanges
Exchange Details Page where the user can view Exchange information and stake KEY tokens
System to fetch a user’s staking status (stake/no-stake) for an Exchange from the blockchain
Token staking and reclamation flow
Submission / upload of KYC package for processing to KYC-Chain
Transfer of ETH, KEY and Custom ERC20 Tokens
Viewing of token balances and transaction logs for ETH, KEY and ERC20 Tokens

Prerequisites

NodeJS version 9 or better
Wine and RPM packages for OSX/Linux

Using Windows?

patch.exe (for snyk protect)
VC++ 2015.3 v14.00 (v140) toolset for desktop
Windows-Build-Tools

Install Dependencies

yarn
yarn install-app-deps

Build on OSX/macOS/Linux

yarn dist

Development

Scripts

  "scripts": {
    "dev": "gulp && electron-webpack dev",
    "install-app-deps": "electron-builder install-app-deps buildDependenciesFromSource",
    "install-all": "yarn && yarn install-app-deps",
    "compile": "gulp && electron-webpack",
    "dist": "yarn compile && electron-builder",
    "dist:dir": "yarn dist --dir -c.compression=store -c.mac.identity=null",
    "test": "yarn test:unit && yarn test:e2e",
    "test:unit": "jest -i --forceExit",
    "test:unit:coverage": "yarn test:unit --coverage",
    "test:e2e": "node test/test.js e2e",
    "publish-build": "yarn compile && electron-builder -p always",
    "precommit": "npm run check-deps-precommit && pretty-quick --staged && lint-staged",
    "commitmsg": "commitlint -E GIT_PARAMS",
    "check-deps-precommit": "npm-check -i eslint -i redux -s || true",
    "check-deps": "npm-check -i common",
    "coveralls": "cat dist/coverage/lcov.info | coveralls"
  }

Run the App on OSX/macOS/Linux/Windows

yarn dev

Tests

yarn test

Contributing

Please see the contributing notes.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SelfKeyFoundation/Identity-Wallet