Project Icarus - Cardano ADA wallet

Icarus, a reference implementation for a lightweight wallet developed by the IOHK Engineering Team. This code base can be used as a point of reference to enable developers to create their own secure light and mobile wallets for Cardano. Icarus is a fully open-source code base that will be the first step in a range of open source initiatives to provide developers with a suite of tools to integrate with Cardano.

Installation

# clone the repository with the submodule js-cardano-wasm
$ git clone --recursive [email protected]:input-output-hk/icarus-poc.git
$ git submodule update --init --recursive

Prerequisites

• node v8.9.4 (if you are using nvm, just execute: $ nvm use)

• Install rust tools as mentioned in js-cardano-wasm

Install dependencies

$ npm run build-js-cardano-wasm 
$ npm install

Development

• Run script

# build dll dependencies
$ npm run build-dll
# build files to './dev'
# start webpack development server
$ npm run dev
# or
$ npm run start -- --env "development"

• If you're developing Inject page, please allow https://localhost:3000 connections. (Because injectpage injected GitHub (https) pages, so webpack server procotol must be https.)

• Load unpacked extensions

  Extensions that you download from the Chrome Web Store are packaged up as .crx files, which is great for distribution, but not so great for development. Recognizing this, Chrome gives you a quick way of loading up your working directory for testing. Let's do that now.

  Visit chrome://extensions in your browser (or open up the Chrome menu by clicking the icon to the far right of the Omnibox: The menu's icon is three horizontal bars. and select Extensions under the More Tools menu to get to the same place).

  Ensure that the Developer mode checkbox in the top right-hand corner is checked.

  Click Load unpacked extension… to pop up a file-selection dialog.

  Navigate to the directory in which your extension files live (./dev folder), and select it.

Dev Features

• Hot reloading React (Using Webpack and React Transform)
• Write code with ES2015+ syntax (Using Babel)
• E2E tests of Window & Popup & Inject pages (Using Chrome Driver, Selenium Webdriver)

Build

Extension can be built for both the Cardano testnet:

• Testnet

# build files to './build'
$ npm run build -- --env "testnet" 

Compress

This tasks allow to generate compressed bundles (zip and crx).

Note: The same --env flag should be used as for the build.

Zip

Zip files can be uploaded to the Chrome Web Store

# compress build folder to {manifest.name}.zip and crx
$ npm run build -- --env "${network}"
$ npm run compress -- --env "${network}" --zip-only --app-id "APP_ID" --codebase "https://www.sample.com/dw/yoroi-extension.crx"

CRX

Crx are compressed and signed chrome extension bundles

# compress build folder to {manifest.name}.zip and crx
$ npm run build -- --env "${network}"
$ npm run compress -- --env "${network}" --app-id "APP_ID" --codebase "https://www.sample.com/dw/yoroi-extension.crx" --key ./production-key.pem

Options

If you want to build crx file (auto update), please provide options, and add update.xml file url in [manifest.json](https://developer.chrome.com/extensions/autoupdate#update_url manifest.json).

• --app-id: your extension id (can be get it when you first release extension)
• --key: your private key path (default: './key.pem')
  you can use npm run compress-keygen to generate private key ./key.pem
• --codebase: your crx file url

See autoupdate guide for more information.

Test

• features: E2E tests (use chromedriver, selenium-webdriver)

# flow
$ npm run flow
# lint
$ npm run eslint
# features
$ npm run test-e2e

Update Cardano crypto library

In order to update it run the following commands:

# Update js-cardano-wasm
cd js-cardano-wasm;
git checkout master;
git pull origin master;
cd ..;

# Commit the update
git add .
git commit -S -m "${youCommitMessage}"
git push ...

# Re-install the module
$ npm run build-js-cardano-wasm 
$ npm install

# At this point you can go back to Development steps. 

LICENSE

We used as template for this repository: React Chrome Extension Boilerplate

Licensed under the Apache License, Version 2.0