Fouad
b27fa51092
* Chore/browser extension bootstrap (#3257) * init package * set up TS and Webpack * add eslint config * add prettier config * add react and mui theme * add CI * update mui theme version number * Chore/browser extension routes (#3327) * start routes * create layouts * add initial app routes * add initial app pages * add global types * create reuseable components * move password and mnemonic fields to shared react components package * refactor register routes * move client address component to shared package * move components to ui folder * create menu and appbar components * adjust layout components * add readme * use memory router * Feature/nym browser extension login and send (#3373) * init package * set up TS and Webpack * add eslint config * add prettier config * add react and mui theme * add CI * update mui theme version number * Chore/browser extension routes (#3327) * start routes * create layouts * add initial app routes * add initial app pages * add global types * create reuseable components * move password and mnemonic fields to shared react components package * refactor register routes * move client address component to shared package * move components to ui folder * create menu and appbar components * adjust layout components * add readme * use memory router * add extension to mono-repo config * fix webpack build * util functions * add TX type * refactor routes * refactor pages + add send page * add page layout for app pages * set up app context * app components * set up connection config * fix lint errors * Chore/browser extension bootstrap (#3257) * init package * set up TS and Webpack * add eslint config * add prettier config * add react and mui theme * add CI * update mui theme version number * Chore/browser extension routes (#3327) * start routes * create layouts * add initial app routes * add initial app pages * add global types * create reuseable components * move password and mnemonic fields to shared react components package * refactor register routes * move client address component to shared package * move components to ui folder * create menu and appbar components * adjust layout components * add readme * use memory router * add extension to mono-repo config * util functions * add TX type * refactor routes * refactor pages + add send page * add page layout for app pages * set up app context * app components * set up connection config * use fee simulation when sending tokens * use object argument for simulate send api * login validation + fee refinements * use components from shared components lib * add receive modal (#3408) * account storage via wasm * method to get all storage keys * Feature/nym browser extension password encryption (single account) (#3442) * build wasm * reuse components and state for password pages * refactor registration pages * use login with password * import storage as local package * add yarn preinstall script to ts lint gh action * install wasm-pack for CI * use @nym scope for ext storage package * introduced a call to check if database was already initialised (#3465) * introduced a call to check if database was already initialised * use extension storage method to check for db existance --------- Co-authored-by: fmtabbara <fmtabbara@hotmail.co.uk> * introduced mnemonic key existence check (#3462) * Browser extension - Multi-accounts + view mnemonic action (#3488) * add UI for multi-accounts + add view mnemonic for accounts * refactor routes * set up import account * add account to existing wallet * check if account name exists before creating new one * handle password errors * add token to currency conversion * fixed ClientStorageError import path * fix CI * fix CI --------- Co-authored-by: Jędrzej Stuczyński <jedrzej.stuczynski@gmail.com>
Nym Wallet
Nym is an open-source, decentralized and permissionless privacy system. It provides full-stack privacy, allowing other applications, services or blockchains to provide their users with strong metadata protection, at both the network level (mixnet), and the application level (anonymous credentials) without the need to build privacy from scratch.
The Nym desktop wallet enables you to use the Nym network and take advantage of its key capabilities
Installation prerequisites - Linux / Mac
YarnNodeJS >= v16.8.0Rust & cargo >= v1.56
Installation prerequisites - Windows
- When running on Windows you will need to install c++ build tools
- An easy guide to get rust up and running Installation
- When installing NodeJS please use the
current featuresversion - Using a package manager like Chocolatey is recommended
- The nym wallet requires you to have
Webview2installed, please head to the Installer, this will ensure a smooth app launch
Installation
Inside the nym-wallet directory, run the following command:
yarn install
Populate environment variables
The wallet requires you to supply a .env file, this populates values in the wallet once it's compiled.
In the project roots there's a .env.sample file, these values currently match what the .env file should be populated with. However, if you want to change these values you can do so accordingly.
- In the root directory, create a new file named
.env - Input the values against the variables
Terminal
The terminal is shown either in development mode, or by setting the SHOW_TERMINAL to any value, e.g. true.
When enabled, the terminal icon is shown in the nav and clicking it displays a modal that shows the inner state of the wallet. In the future, this will also allow interactions, e.g. queries or executing commands such as delegation or undelegating.
It is intended to be used during development and for troubleshooting.
Development mode
You can compile the wallet in development mode by running the following command inside the nym-wallet directory:
yarn dev
This will produce a binary in - nym-wallet/target/debug/ named nym-wallet
To launch the wallet, navigate to the directory and run the following command: ./nym-wallet
Production mode
Run the following command from the nym-wallet folder
yarn build
The output will compile different types of binaries dependent on your hardware / OS system. Once the binaries are built, they can be located as follows:
Admin mode
The admin screens can be shown by setting the environment variable ADMIN_ADDRESS. You'll need to know the admin account address for the network you are using.
QA mode
On built versions of the wallet, you can set the environment variable ENABLE_QA_MODE=true to add the QA network to the list of available networks.
Binary output directory structure
**macos**
|
└─── target/release
| |─ nym-wallet
└───target/release/bundle/dmg
│ │─ bundle_dmg.sh
│ │─ nym-wallet.*.dmg
└───target/release/bundle/macos/MacOs
│ │─ nym-wallet
|
**Linux**
└─── target/release
| │─ nym-wallet
└───target/release/bundle/appimage
│ │─ nym-wallet_*_.AppImage
│ │─ build_appimage.sh
└───target/release/bundle/deb
│ │─ nym-wallet_*_.deb
|
**Windows**
└─── target/release
| │─ nym-wallet.exe
└───target/release/bundle/msi
│ │─ nym-wallet_*_.msi
For instructions on how to release the wallet, please see RELEASE.md.