Merge branch 'develop'

Author: gabmontes

README.md

@@ -2,76 +2,90 @@
   <img src="./public/images/banner.png" alt="Metronome Wallet Desktop" width="50%">
 </h1>
 
-💻💰 Metronome wallet for desktop devices
+💻💰 Metronome Wallet for desktop computers
 
-[![Build Status](https://travis-ci.com/MetronomeToken/metronome-desktop-wallet.svg?token=zFtwnjoHbEAEPUQyswR1&branch=master)](https://travis-ci.com/MetronomeToken/metronome-desktop-wallet)
+[![Build Status](https://travis-ci.com/autonomoussoftware/metronome-wallet-desktop.svg?branch=master)](https://travis-ci.com/autonomoussoftware/metronome-wallet-desktop)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-## Index
+## Development 
 
-1.  [Requirements](#requirements)
-1.  [Configuration](#configuration)
-1.  [Dev Setup](#dev-Setup)
-1.  [Prod Setup](#prod-setup)
-1.  [Logs](#logs)
-1.  [Development Notes](#development-notes)
-1.  [License](#license)
+### Requirements
 
-## Requirements
+* [Node.js](https://nodejs.org) LTS (v8)
 
-* [Node.js](https://nodejs.org) v8 (or greater)
-
-## Dev Setup
+### Launch
 
 ```bash
 # Install dependencies
 npm i
 
 # Run dev mode
 npm run dev
-
-# Run test cases
-npm test
 ```
 
-## Prod Setup
+### Logs
 
-```bash
-# Run build process
-npm run dist
+The log output is in the next directories:
 
-# Run build process and publish to GitHub release
-npm run release
+* **Linux:** `~/.config/<app name>/log.log`
+* **macOS:** `~/Library/Logs/<app name>/log.log`
+* **Windows:** `%USERPROFILE%\AppData\Roaming\<app name>\log.log`
+
+More info [github.com/megahertz/electron-log](https://github.com/megahertz/electron-log)
+
+### Settings
+
+* **Linux**: `~/.config/metronome-desktop-wallet/Settings`
+* **macOS**: `~/Library/Application Support/metronome-desktop-wallet/Settings`
+* **Windows**: `%APPDATA%\\metronome-desktop-wallet\\Settings`
+
+To completely remove the application and start over, remove the settings file too.
+
+### Run in Ropsten Testnet
+
+Modify the `Settings` file replacing the following properties:
+
+```json
+{
+  "app": {
+    "chain": "ropsten",
+    "node": {
+      "jsonRpcApiUrl": "https://eth.met.bloqrock.net:8545",
+      "websocketApiUrl": "wss://eth.met.bloqrock.net:8546"
+    },
+    "indexerApiUrl": "https://indexer.met.bloqrock.net",
+    "tracerApiUrl": "https://tracer.met.bloqrock.net"
+  },
+  "tokens": {
+    "0xf3e9a687fdf24112745d4d7dee150ba87a07ecc3": {
+      "decimals": 18,
+      "name": "Metronome",
+      "symbol": "MET"
+    }
+  }
+}
 ```
 
-## Logs
-
-The log output is in the next directories:
+Then, start the wallet setting the proper environment variable as follows:
 
- * **Linux:** `~/.config/<app name>/log.log`
- * **macOS:** `~/Library/Logs/<app name>/log.log`
- * **Windows:** `%USERPROFILE%\AppData\Roaming\<app name>\log.log`
+```bash
+REACT_APP_ETH_CHAIN=ropsten npm run dev
+```
 
-> More info [github.com/megahertz/electron-log](https://github.com/megahertz/electron-log)
+Alternatively, a `.env` file can also be used to set the chain variable.
 
-## Development Notes
+### Production Build
 
-To remove app settings and start over again:
+```bash
+# Run build process
+npm run dist
 
-* **Linux**:
-  ```bash
-  rm ~/.config/metronome-desktop-wallet/Settings
-  ```
-* **macOS**:
-  ```bash
-  rm ~/Library/Application\ Support/metronome-desktop-wallet/Settings
-  ```
-* **Windows**:
-  ```bat
-  del %APPDATA%\\metronome-desktop-wallet\\Settings
-  ```
+# Run build process and publish to GitHub releases
+npm run release
+```
 
+To sign the macOS installers, execute `npm run dist:mac`. The signing certificate shall be in the root folder and be named `met.p12`. The certificate password will be required before signing.
 
 ## LICENSE
 
-[MIT License](https://github.com/MetronomeToken/metronome-desktop-wallet/blob/develop/LICENSE).
+MIT

package-lock.json

@@ -84,6 +84,7 @@
     "styled-components": "^3.0.2",
     "supports-color": "^5.3.0",
     "tough-cookie": "^2.3.4",
+    "universal-analytics": "0.4.17",
     "web3": "1.0.0-beta.34"
   },
   "devDependencies": {

package.json

@@ -0,0 +1,34 @@
+'use strict'
+
+const { app } = require('electron')
+const ua = require('universal-analytics')
+const { noop } = require('lodash')
+const settings = require('electron-settings')
+const isDev = require('electron-is-dev')
+
+const visitor = ua(settings.get('app.trackingId'))
+const analytics = {}
+
+visitor.set('ds', 'app')
+visitor.set('an', app.getName())
+visitor.set('av', app.getVersion())
+
+analytics.screenview = function (...args) {
+  visitor.screenview(...args).send()
+}
+
+analytics.event = function (...args) {
+  visitor.event(...args).send()
+}
+
+analytics.init = function () {
+  analytics.event('App', 'App initiated')
+}
+
+const analyticsDev = {
+  init: noop,
+  event: noop,
+  screenview: noop
+}
+
+module.exports = isDev ? analyticsDev : analytics

public/analytics.js

@@ -6,11 +6,14 @@ const Raven = require('raven')
 const { app } = require('electron')
 const isDev = require('electron-is-dev')
 
+const analytics = require('./analytics')
 const logger = require('./logger')
 const config = require('./config')
 const initMenu = require('./menu')
 const initContextMenu = require('./contextMenu')
 
+analytics.init()
+
 if (isDev) {
   require('dotenv').config()
 

public/electron.js

@@ -20,7 +20,7 @@ function transactionParser ({ transaction, receipt, walletId }) {
   }
 
   meta.contractCallFailed = receipt &&
-    (receipt.status === 0 || // byzantium fork
+    (receipt.status === false || // byzantium fork
     (input !== '0x' && gas === receipt.gasUsed && !receipt.logs.length))
 
   if (meta.ours) {

public/main/plugins/ethWallet/transactionParser.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const logger = require('electron-log')
+const analytics = require('./../../../analytics')
 
 const {
   getAuctionGasLimit
@@ -25,10 +26,19 @@ function createApi ({ ethWallet, tokens }) {
     logger.verbose('Buying MET in auction', {
       from, value, address, gasLimit, gasPrice
     })
+    analytics.event({ ec: 'Buy', ea: 'Buy MET in auction initiated' })
 
     return ethWallet.sendTransaction({
       password, from, to: address, value, gasLimit, gasPrice
     })
+      .then(function (response) {
+        analytics.event({ ec: 'Buy', ea: 'Buy MET in auction succeeded' })
+        return response
+      })
+      .catch(function (err) {
+        analytics.event({ ec: 'Buy', ea: 'Buy MET in auction failed' })
+        throw err
+      })
   }
 
   function onConvertEthToMtn ({ password, from, value, minReturn, gasLimit, gasPrice }) {
@@ -37,6 +47,7 @@ function createApi ({ ethWallet, tokens }) {
     const data = encodeConvertEthToMtn({ web3, address, value, minReturn })
 
     logger.verbose('Converting ETH to MET', { from, value, address })
+    analytics.event({ ec: 'Convert', ea: 'Convert ETH to MET initiated' })
 
     return ethWallet.sendTransaction({
       password,
@@ -47,12 +58,22 @@ function createApi ({ ethWallet, tokens }) {
       gasLimit,
       gasPrice
     })
+      .then(function (response) {
+        analytics.event({ ec: 'Convert', ea: 'Convert ETH to MET succeeded' })
+        return response
+      })
+      .catch(function (err) {
+        analytics.event({ ec: 'Convert', ea: 'Convert ETH to MET failed' })
+        throw err
+      })
   }
 
   function onConvertMtnToEth ({ password, from, value, minReturn, gasPrice, gasLimit }) {
     const token = getTokenAddress()
     const address = getConverterAddress()
 
+    analytics.event({ ec: 'Convert', ea: 'Convert MET to ETH initiated' })
+
     return tokens.getAllowance({ token, from, to: address })
       .then(function (allowance) {
         logger.debug('Current allowance', allowance)
@@ -85,6 +106,10 @@ function createApi ({ ethWallet, tokens }) {
             return ethWallet.sendTransaction({
               password, from, to: address, data, gasPrice, gasLimit
             })
+              .then(function (response) {
+                analytics.event({ ec: 'Convert', ea: 'Convert MET to ETH succeeded' })
+                return response
+              })
           })
           .catch(function (err) {
             logger.warn('Conversion failed - removing approval')
@@ -103,6 +128,7 @@ function createApi ({ ethWallet, tokens }) {
           })
       })
       .catch(function (err) {
+        analytics.event({ ec: 'Convert', ea: 'Convert MET to ETH failed' })
         throw err
       })
   }

public/main/plugins/metronome/api.js

@@ -7,7 +7,8 @@
     },
     "defaultDerivationPath": "m/44'/60'/0'/0",
     "indexerApiUrl": "https://indexer.metronome.io",
-    "tracerApiUrl": "https://tracer.metronome.io"
+    "tracerApiUrl": "https://tracer.metronome.io",
+    "trackingId": "UA-116275666-3"
   },
   "coincap": {
     "ethPriceEmitRate": 5
@@ -19,5 +20,5 @@
       "symbol": "MET"
     }
   },
-  "settingsVersion": 12
+  "settingsVersion": 13
 }