Skip to content

Latest commit

 

History

History
177 lines (113 loc) · 5.27 KB

README.md

File metadata and controls

177 lines (113 loc) · 5.27 KB
Raw

This is the repository for the desktop wallet.

Dependencies

You need the following to build and run the project:

Ubuntu

For ubuntu, a couple of extra dependencies are needed:

  • libusb 1.0 (sudo apt-get install libusb-1.0)
  • libudev-dev (sudo apt-get install libudev-dev)
  • rpm (sudo apt-get install rpm)

Install

Clone the repo via git.

git clone https://github.com/Concordium/concordium-desktop-wallet.git
cd concordium-desktop-wallet

Make sure to initialize submodules:

git submodule update --init

Then install dependencies:

yarn

Windows

On Windows you can run the above through e.g. Git bash, or if you want to run it from the Command Prompt, then you must add sh to your PATH for the proto build to run. You can get sh bundled with Git bash.

Starting Development

Start the app in the dev environment.

yarn start

Alternatively you can, in one terminal, run:

yarn build-main-dev && yarn start-renderer-dev

This will:

  • Build the electron main script
  • Start the webpack server for the electron renderer

Then, in another terminal, run:

yarn start:dev

To open the app.

This way, you can get quicker reloads, because you only need to restart start:dev, as the renderer thread will recompile in the background. N.B. This doesn't apply for changes in the rust code, which is only recompiled with a full restart.

Targeting specific network

To build the application for a specific network you must supply the TARGET_NET variable. The value has to be one of stagenet, testnet, protonet, or mainnet, otherwise the build will fail. If TARGET_NET is not set the build will be for mainnet. Note that the TARGET_NET will be appended to the filenames for stagenet and testnet.

TARGET_NET=stagenet yarn package

Targeting Ledger emulator (Speculos)

It is possible to run the desktop wallet in development mode against a Ledger emulator (Speculos). Note that this is not safe and is only relevant for development.

LEDGER_EMULATOR_URL=http://emulator-ip-address:port yarn start

Debugging with DevTools (this flow is needed on some ubuntu versions that don't support devTools in the app)

To start the debugging client, run:

yarn start:dev-debug

The output will be similar to:

ws://127.0.0.1:9229/0f2c936f-b1cd-4ac9-aab3-f63b0f33d55e
  • Open the inspector URL in your chrome browser, as follows:
chrome://inspect/#devices

  • Click the Configure button and configure your listenAddress + port as outputted by the previous command.

  • Click on inspect.

  • The electron app is now running in your chrome browser and you can use the devTools.

Packaging for Production

To package apps for the local platform:

yarn package

Mac specific code signing and notarizing

As the software is distributed outside of the Mac App Store, it needs to be signed and notarized.

Running

yarn package

on a machine with MacOS will trigger the signing and notarizing processes. This requires a valid Developer ID Application Certificate in the Keychain of the machine used for building, and a valid Apple Developer ID has to be logged into Xcode on the same machine.

When the build has finished, the signing process will be triggered, and if it succeeds it will continue with the notarizing process.

For the notarizing process to succeed, the Apple ID and it's password also needs to be available as the following environment variables:

For the APPLEIDPASS, setting up an app-specific password for the Apple ID is recommended.

The notarizing process can take a while, and for testing purposes it can be skipped by running:

TARGET_NET=$NET yarn package-mac-no-notarize

Generating verification assets

Users are encouraged to verify the integrity of a downloaded application binary before installation. To support this, we need to generate a hash and a signature for each binary released. Furthermore, automatic updates also rely on these assets for verification of each update being installed.

To generate the assets, run:

yarn generate-verification-assets <path-to-private-key>
  • The private key used for this needs to match the public key published for verification, otherwise verification will not succeed.

By default, the script tries to generate a hash and sig file for all release binaries in release/. It also tries to verify the created signatures with Concordium's public key for the desktop wallet, which is published separately.

The script has a number of optional runtime arguments, which are documented in the underlying script file scripts/fileDigest.js.