This repo contains the source code for the Smilo mobile wallet.
This project relies on the following dependencies:
- NodeJS @ 8.11.2
- NPM @ 5.6.0
- Ionic @ 4.1.1
- Cordova @ 8.0.0
- Browserify @16.2.2
First make sure you have all Node modules installed by running the following command in the root of this project:
npm install
As part of the installation the bitcoinjs-lib will also be build. For more information see the chapter Generating private and public keys.
Next run the following command to run the project locally:
ionic serve
First make sure you have the following dependencies installed:
- Java SE 1.8
- Gradle (for Mac use brew:
brew install gradle)
Next build the project for Android using the following command:
ionic cordova build android
Or directly run the project using:
ionic cordova run android
Use the following command to build a release ready version for Android:
npm run release:android
The build APK can be found at release/android.apk.
This command will use the script found at scripts/release-android.sh to build a release ready APK.
For this command to work the environment variable SMILO_WALLET_KEYSTORE_LOCATION is expected to be defined.
This variable should point to the location where the keystore used to sign the app is located.
We use Hockey App for internal testing. To build a release version and upload to Hockey App use the following command:
npm run upload-hockey-app:android
For this to work the environment variable HOCKEY_APP_TOKEN is expected to be available.
To build and upload at the same time
npm run release-upload-hockey-app:android
First make sure you have xCode installed.
Next build the project for iOS using the following command:
ionic cordova build ios
Or directly run the project using:
ionic cordova run ios
Use the following command to build a release ready version for Android:
npm run release:ios
The build IPA can be found at release/Smilo Wallet.ipa.
This command will use the script found at scripts/release-ios.sh to build a release ready IPA.
For this command to work it is expected that the development certificate is downloaded from the Apple Developer portal.
We use Hockey App for internal testing. To build a release version and upload to Hockey App use the following command:
npm run upload-hockey-app:ios
For this to work the environment variable HOCKEY_APP_TOKEN is expected to be available.
To build and upload at the same time
npm run release-upload-hockey-app:ios
We use Jasmine and Karma to unit test this project. To unit test the project run the following command in the root of this project:
npm run test
This will start a process which will watch for source file changes and rerun the tests if needed.
If you only want to run the unit tests once (for example when running on a build server) use this command:
npm run test-ci
For end-to-end testing we use Cypress and Mocha. To e2e test the project during development first ensure the project is running with ionic serve. Next run the following command in the root of this project:
npm run e2e
This will open the Cypress test runner in which you can select which tests should be run.
If you only want to run all e2e tests once (for example when running on a build server) use this command:
npm run e2e-ci
This will build and run this project and next run the e2e tests. Afterwards the running project will be killed.
To validate if all translations have a definition for all translation keys you can use the following command:
npm run validate-translations
This will, based on the English translation, check if any translation keys are missing in all other translations.
All missing translation keys will be logged. The original translation will also be amended with the missing translation key and a default value.
This default value will result in an invalid JSON string on purpose. This allows us to easily find missing strings in a code editor.
When running on a build serve you may want to skip amending the translation file. To skip amending use the following command:
npm run validate-translations:ci
This will only output the errors.
Private keys are generated based on a 24 word mnemonic sentence. We use BIP39 to generate a mnemonic sentence and extract a seed from this sentence.
Next we use BIP32 (using the hierarchical structure defined by the BIP44 standard) to generate a private key.
Lastly we use a Merkle Signature Scheme to generate private keys which can be used to sign transactions.
For BIP32 we have used code written by Ian Coleman which itself is a port of a Python implementation by Pavol Rusnak. We have adjusted this code to work as an Angular service.
For BIP32/BIP44 we use the bitcoinjs-lib. We have used Browserify to make this library available for web.
To generate the Browserified version of the bitcoinjs-lib library use the following command in the root of this project:
browserify ./bitcoin-js-wrapper/wrapper.js --standalone bitcoinjs > ./src/assets/scripts/bitcoinjs-lib.js
To build the files needed for the webplugin run this command
npm run build-webplugin
To add file watcher for transpiling the ts files
npm run dev-webplugin-ts
To add file watcher for transpiling the scss files
npm run dev-webplugin-scss
To generate a development package use:
npm run webplugin-generate-*-dev
Where the '*' can be replaced with one of the following browser names:
- chrome (also used for Opera)
- firefox
- safari
- edge
To generate a production package use:
npm run webplugin-generate-*-prod
To generate development packages for all browsers (Chrome (also Opera), Safari, Edge, Firefox):
npm run webplugin-generate-all-dev
To generate production packages for all browsers (Chrome (also Opera), Safari, Edge, Firefox):
npm run webplugin-generate-all-prod