onzcoin/onz-nano

Onz Nano

Development

git clone https://github.com/OnzCoin/onz-nano.git
cd onz-nano
npm install
npm run dev

Open http://localhost:8080

For ease of development, you can setItem in localStorage to prefill a passphrase, e.g.:

localStorage.setItem('passphrase', 'wagon stock borrow episode laundry kitten salute link globe zero feed marble')

And then you can setItem in localStorage to login automatically

localStorage.setItem('autologin', true)

Build

npm run build

Electron

Start

Start the Electron client. Before staring you need to make sure the application is built. If you need to built the entire application, run

npm run build

as mentioned before. And if you want to solely build electron app, run

npm run build-electron

Then, in order to launch electron, you can run

npm run start

Trouble Shoot

[LevelDown fails installation with NPM on windows 10.]

FIX:    choco install microsoft-build-tools / npm install windows-build-tools
FIX 1:  Install python, ie: choco install python, choco install python3.6
FIX 2:  Install windows sdk version 8.1,  choco install windows-sdk-8.1 
FIX 3:  Set Enviroment varible for python.

[Unable to find Electron App Error https://i.imgur.com/9lqLVhb.png]

FIX:    npm run build && npm start
FIX 2:  Check contents of package.json make sure "main" key exists. main.js is Electron Config file.

Windows

Build package for Windows (on Windows in Git BASH).

npm run pack:win

macOS

Build package for macOS (on macOs)

npm run pack 

Linux

Build package for Linux (on Linux).

npm run pack 

Run unit tests

Single run

npm run test

Run each time a file changes

npm run test-live

Run end-to-end tests

Setup

Setup protractor

./node_modules/protractor/bin/webdriver-manager update

Setup a onz test node to run on localhost:4000 as described in https://github.com/OnzCoin/onz#tests

And run it with pm2.

Run

Start the development version of onz-nano:

npm run dev

Run the protractor tests (replace ~/git/onz/ with your path to onz core):

./e2e-test-setup.sh ~/git/onz/
npm run e2e-test

Launch React Storybook

To launch storybook sandbox with components run

npm run storybook

and go to

http://localhost:6006/

Authors

• Kan Wong [email protected]
• Mars Yau [email protected] -Ricardo Ferro [email protected] -Oliver Beddows [email protected] -Vít Stanislav [email protected] -Tobias Schwarz [email protected] -Ali Haghighatkhah [email protected] -Yashar Ayari [email protected]

License

Copyright © 2017-2018 ONZ COIN
Copyright © 2016-2017 Lisk Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

---

This program also incorporates work previously released with lisk 0.7.0 (and earlier) versions under the MIT License. To comply with the requirements of that license, the following permission notice, applicable to those parts of the code only, is included below:

Copyright © 2016-2017 Lisk Foundation
Copyright © 2015 Crypti

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.

onz-nano's Issues

Wallet address validation need to be enhanced

Expected behaviour

Able to verify e.g. "ONZvbtumyFa89QpyS3oD8LnpBGvzb7VFgMNGA"

Proposal modification

^ONZ[a-zA-Z0-9]{34}$

Adding Portuguese locale support

Expected behaviour

Portuguese should be shown on the logon page and the nano wallet should work with front end showing Portuguese .

Actual behaviour

Portuguese locale and flag have been added to the project but the wallet crashed with some exception after login. pt/common.json already verified by Brazil team.

Steps to reproduce

1. add pt block into locales/languages.js
2. npm run build
3. npm run dev
4. logon with testing passphrase and with language Japanese selected as preferred language.

Adding Korean locale support

Expected behaviour

Korean should be shown on the logon page and the nano wallet should work with front end showing Korean .

Actual behaviour

Korean locale and flag have been added to the project but the wallet crashed with some exception after login. Need help to verify the Korean locale file to make sure it is 100% correct.

Steps to reproduce

1. add ko block into locales/languages.js
2. npm run build
3. npm run dev
4. logon with testing passphrase and with language Korean selected as preferred language.

Adding Japanese locale support

Expected behaviour

Japanese should be shown on the logon page and the nano wallet should work with front end showing Japanese.

Actual behaviour

Japanese locale and flag have been added to the project but the wallet crashed with some exception after login. And also ja/common.json to be confirmed by japan team.

Steps to reproduce

1. add ja block into locales/languages.js
2. npm run build
3. npm run dev
4. logon with testing passphrase and with language Japanese selected as preferred language.

Nano wallet syncing issues

Expected behaviour

Wallet will be updated and sync automatically in realtime

Actual behaviour

A number of people reported their wallet is out-sync with the node and need to re-logon to see the transaction.

Steps to reproduce

Open wallet, ask someone to send coin to your address, and you will not able to see the transaction nor receive the coin until you re-login.

Branding / Support Links

Expected behaviour

Links should point to our sites,
ie: slack / zendesk / explorer

Actual behaviour

currently point to non existent urls.
onzcoin/onz-nano/app/src/menu.js

Locale support not fully compatible with numerals

Expected behaviour

Should be able to use ALL languages supported by Numerals package for future compatibility and translations. Currently it can only uses packages that are 2 chars long, ie: en, de, ja.
numerals supports language codes up to 5 chars, ie: pt-pt

This may be obsolete for we are using our own custom package of numerals but for the sake of easy installation and future compatibility we should change code to accept up to 5 chars for language symbol.

Fix

We still should probably change the code in onzcoin/onz-nano/app/src/main.js line 73 to 5 with some checks instead of 2 to not break cross compatibility with future versions of numeral npm package, currently it will pass only 2 letters to localeHandler.update() but numeral official languages can be up to 5 chars, ie: 12-12 instead of just 12, ie: pt-pt as in Portugal Portuguese as apposed to Brazilian.

Adding Spanish locale support

Expected behaviour

Spanish should be shown on the logon page and the nano wallet should work with front end showing Spanish.

Actual behaviour

Spanish locale and flag have been added to the project but the wallet crashed with some exception after login. And also es/common.json to be confirmed by Spain team.

Steps to reproduce

1. add es block into locales/languages.js
2. npm run build
3. npm run dev
4. logon with testing passphrase and with language Spanish selected as preferred language.

Release onz-nano 1.3.1 for testnet

Expected behaviour

onz-nano wallet need to be rebuilt with version 1.3.1 (current rc1) before testnet launch. package.json and app/package.json version number need to be updated. Binary and yml files need to be uploaded to github release directory for verification.

Actual behaviour

mac and window binary will be released under version 1.3.1 instead of rc.

Steps to reproduce

redux-mock-store need to be updated to latest version

onz-nano/package.json

Line 134 in f292132

"redux-mock-store": "1.3.1-rc.1",

update onz-js dependencies

onz-js will be submitted to npm for packaging and onz-nano package.json need to be updated to use npm package instead of github repository. Hopefully that could be done before launch testnet

on development mode network defaulted to mainnet for new account

Expected behaviour

Network should be remain as selected but no reset to mainnet which blocked new account creation in dev mode.

Actual behaviour

Network reset to mainnet which network is selected as testnet or custom, when click on new account.

Steps to reproduce

1. cd onz-nano; npm install;npm run buill;npm run dev; launch wallet locally at http://localhost:8080
2. select testnet or mainnet at the logon page
3. select new account and the network will be reset to mainnet, and the account creation will be failed because it failed to connect to testnet/custom node.

Seem that is related to known LISK issue
https://github.com/LiskHQ/lisk-nano/issues/1031#event-1429834884

Receive ONZ qr code was not displayed

Expected behavior

Receive ONZ display QR code properly (Mac version only)

Actual behaviour

Receive ONZ display QR code properly without QR code

Steps to reproduce

1. Build and install mac wallet
2. Logon (TestNet)
3. Click on the Receive ONZ button at the top
4. QR code is not displayed properly.

Adding Simplified chinese locale support

Expected behaviour

Simplified chinese should be shown on the logon page and the nano wallet should work with front end showing Simplified chinese.

Actual behaviour

Simplified chinese locale and flag have been added to the project but the wallet crashed with some exception after login. And also cn/common.json to be confirmed by China team.

Steps to reproduce

1. add cn block into locales/languages.js
2. npm run build
3. npm run dev
4. logon with testing passphrase and with language Simplified chinese selected as preferred language.