Ki Desktop Wallet

This repository hosts ki-desktop-wallet, a desktop wallet for the KiChain. This wallet is still in beta stage.

Functionalities

The wallet allows:

• Importing and creating KiChain accounts (addresses).
• Maintaining multiple accounts.
• Issuing transfer transactions: send.
• Issuing staking transactions: delegate/undelegate/redelegate.
• Issuing distribution transactions: withdraw rewards and/or commissions.
• Viewing transactions (mini-explorer)
• Generate, sign and broadcast transaction files
• Perform the multi signature workflow (Generate, sign, collect, multisign)

How to run The Ki desktop Wallet

To run the Ki desktop wallet you need first to build it and then to run it or package it in electron.

Build the wallet

Start by cloning this repository. Stable code will be always available on master:

git clone https://github.com/KiFoundation/ki-desktop-wallet.git

To build the wallet you can use the provided script as follows:

# Install dependencies and build the wallet
$(cd app/ ; npm install; sh build.sh)

[Optional] If you want to test the wallet with out packaging it with electron, you can serve it in your browser with hot reload at localhost. It works as follows:

npm run dev

Run and package in electron

Now that the wallet app is built, you can package it for the various operating systems.

# Install dependencies
npm install

# [Optional] to run the app in dev mode
npm start

# Package the app for macOS
npm run package-mac

# Package the app for Windows (On windows)
npm run package-win

# Package the app for Debian distributions
npm run package-linux

Packaging the wallet for Windows (i.e. generating a .exe file) needs to be done on a system running Windows. However, you can also package the app for all of the platforms from within macOS or Debian. Therefor, you need to install Wine:

1- Install Wine for mac

# Install XQuartz (Prerequisite)
brew cask install xquartz

# install wine
brew cask install --no-quarantine wine-stable

2- Install Wine for Debian (tested on distribution 10)

# Enable 32 bit architecture
sudo dpkg --add-architecture i386

# Add WineHQ repository
sudo apt update
sudo apt -y install gnupg2 software-properties-common
wget -qO - https://dl.winehq.org/wine-builds/winehq.key | sudo apt-key add -
sudo apt-add-repository https://dl.winehq.org/wine-builds/debian/

# Install Wine 5
wget -O- -q https://download.opensuse.org/repositories/Emulators:/Wine:/Debian/Debian_10/Release.key | sudo apt-key add -
echo "deb http://download.opensuse.org/repositories/Emulators:/Wine:/Debian/Debian_10 ./" | sudo tee /etc/apt/sources.list.d/wine-obs.list
sudo apt update
sudo apt install --install-recommends winehq-stable

More details about installing wine can be found here.

Now your whole procedure to build and package the wallet for all the platforms from within macOS (or Debian) will look like:

$(cd app/ ; npm install; sh build.sh)
npm install
npm run package-mac
npm run package-win
npm run package-linux

Create installers

Packaging the wallet will produce executables which must directly run on their relative OS. They can be shared in compressed archives or, more conveniently, through installer files. The creation of the latter on each OS is shown hereafter.

Create installers separately

1 - Create Windows installer .msi:

MSI (Microsoft System Installer) installers have been lately the most common type of windows installers. It allows a high degree of configurability through the use of XML configuration scheme.

To generate the MSI installer, start by downloading and installing the Wix Toolset from their Github repo. After installinf the toolset, make sure to add its bin to the environment variable path (A full tutorial on how to configure the installer using the Wix Toolsetcan be found here. );

npm run build-installer-win

This command uses the electron-wix-msi library which is present in the package.json file and is automatically installed when the app is built and packaged. The installer can be further configured in the msiCreator constant in /installers/config/windows/createinstaller.js

2 - Create MacOS installer .dmg:

The most convenient way to build a custom disk image installer is to use the terminal as it allows a high degree of configurability while being free. To create a .dmg file from terminal, we will use a python tool called dmgbuil:

npm run build-installer-mac

Note: this only works on a MacOS system as it requires the apple proprietary hdutil library.

Building a disk image can also be done:

• Directly from the finder as shown in this tutorial.
• Or using a dedicated tool with a UI such as DMG Canvas.

3 - Create Debian installer .deb:

To create the .deb package for Debian platforms, you can use the provided script which in turn uses the electron-installer-debian library:

npm run build-installer-linux

The process might take a couple of minutes to finish generating the installer.

Security

If you discover a security vulnerability in this project, please report it to [email protected]. We will promptly address all security vulnerabilities.

Disclaimer The Ki desktop Wallet uses code parts from the math-cosmos-web-wallet project by MathWallet.