build(desktop): improve desktop build process, update assets

Gruntfile.js

@@ -210,7 +210,7 @@ module.exports = function(grunt) {
         files: [{
           expand: true,
           cwd: 'webkitbuilds/',
-          src: ['.desktop', '../www/img/app/favicon.ico', '../www/img/app/512x512.png'],
+          src: ['.desktop', '../www/img/app/favicon.ico', '../resources/<%= pkg.name %>/linux/512x512.png'],
           dest: 'webkitbuilds/<%= pkg.title %>/linux64/',
           flatten: true,
           filter: 'isFile'
@@ -223,7 +223,7 @@ module.exports = function(grunt) {
         platforms: ['win64', 'osx64', 'linux64'],
         buildDir: './webkitbuilds',
         version: '0.16.0',
-        macIcns: './www/img/app/logo.icns',
+        macIcns: './resources/<%= pkg.name %>/mac/app.icns',
         exeIco: './www/img/app/logo.ico'
       },
       src: ['./package.json', './www/**/*']

app-template/apply.js

@@ -65,6 +65,10 @@ Object.keys(templates).forEach(function(k) {
   if(k === 'config-template.xml'){
     k = 'config.xml';
   }
+
+  if (!fs.existsSync('../' + targetDir)){
+    fs.mkdirSync('../' + targetDir);
+  }
   fs.writeFileSync('../' + targetDir + k, content, 'utf8');
 });
 

app-template/build-macos.sh

@@ -17,13 +17,18 @@ fi
 
 # set up your app name, architecture, and background image file name
 APP_NAME="*USERVISIBLENAME*"
-DMG_BACKGROUND_IMG="Background.png"
+rm dmg-background.tiff
+ln -s ../resources/*PACKAGENAME*/mac/dmg-background.tiff dmg-background.tiff
+rm volume-icon.icns
+ln -s ../resources/*PACKAGENAME*/mac/volume-icon.icns volume-icon.icns
+DMG_VOLUME_ICON="volume-icon.icns"
+DMG_BACKGROUND_IMG="dmg-background.tiff"
 
 PATH_NAME="${APP_NAME}/osx64/"
 # you should not need to change these
 APP_EXE="${PATH_NAME}${APP_NAME}.app/Contents/MacOS/nwjs"
 
-VOL_NAME="${APP_NAME}-osx"
+VOL_NAME="${APP_NAME}"
 DMG_TMP="${VOL_NAME}-temp.dmg"
 DMG_FINAL="${VOL_NAME}.dmg"
 STAGING_DIR="tmp"
@@ -95,31 +100,61 @@ DEVICE=$(hdiutil attach -readwrite -noverify "${DMG_TMP}" | \
 sleep 2
 
 # add a link to the Applications dir
-echo "Add link to /Applications"
+echo "Adding link to /Applications"
 pushd /Volumes/"${VOL_NAME}"
-ln -s /Applications
+# We name the symlink with a *non-breaking space* to avoid displaying extra text
+ln -s /Applications " " # <- not your ordinary space
 popd
 
+# "bless" the folder to open it in Finder automatically when the volume is mounted
+echo "Blessing disk image"
+bless --folder /Volumes/"${VOL_NAME}" --openfolder /Volumes/"${VOL_NAME}"
+
 # add a background image
+echo "Adding background to disk image"
 mkdir /Volumes/"${VOL_NAME}"/.background
 cp "${DMG_BACKGROUND_IMG}" /Volumes/"${VOL_NAME}"/.background/
 
+echo "Adding volume icon to disk image"
+# use fileicon node_module
+cp "${DMG_VOLUME_ICON}" /Volumes/"${VOL_NAME}"/.VolumeIcon.icns
+`npm bin`/fileicon set /Volumes/"${VOL_NAME}"/ /Volumes/"${VOL_NAME}"/.VolumeIcon.icns
+
 # tell the Finder to resize the window, set the background,
 #  change the icon size, place the icons in the right position, etc.
+echo "Designing the unboxing experience..."
+WINDOW_X=400
+WINDOW_Y=100
+WINDOW_WIDTH=500
+WINDOW_HEIGHT=375
+ICON_SIZE=100
+ICON_LR_PADDING=140
+ICON_Y=185
+
+WINDOW_RIGHT=$(expr $WINDOW_X + $WINDOW_WIDTH)
+WINDOW_BOTTOM=$(expr $WINDOW_Y + $WINDOW_HEIGHT)
+RIGHT_ICON_PADDING_RIGHT=$(expr $WINDOW_WIDTH - $ICON_LR_PADDING)
+HIDE_X=100 # no need to exceed WINDOW_WIDTH – will only create another scrollbar
+HIDE_Y=$(expr $WINDOW_HEIGHT + $ICON_SIZE)
+
 echo '
    tell application "Finder"
      tell disk "'${VOL_NAME}'"
            open
            set current view of container window to icon view
            set toolbar visible of container window to false
            set statusbar visible of container window to false
-           set the bounds of container window to {400, 100, 920, 440}
+           set the bounds of container window to {'${WINDOW_X}', '${WINDOW_Y}', '${WINDOW_RIGHT}', '${WINDOW_BOTTOM}'}
            set viewOptions to the icon view options of container window
            set arrangement of viewOptions to not arranged
-           set icon size of viewOptions to 72
+           set icon size of viewOptions to '${ICON_SIZE}'
            set background picture of viewOptions to file ".background:'${DMG_BACKGROUND_IMG}'"
-           set position of item "'${APP_NAME}'.app" of container window to {160, 205}
-           set position of item "Applications" of container window to {360, 205}
+           set position of item "'${APP_NAME}'.app" of container window to {'${ICON_LR_PADDING}', '${ICON_Y}'}
+           set position of item " " of container window to {'${RIGHT_ICON_PADDING_RIGHT}', '${ICON_Y}'}
+           set position of item ".background" of container window to {'${HIDE_X}', '${HIDE_Y}'}
+           set position of item ".VolumeIcon.icns" of container window to {'${HIDE_X}', '${HIDE_Y}'}
+           set position of item ".fseventsd" of container window to {'${HIDE_X}', '${HIDE_Y}'}
+           set position of item "Icon?" of container window to {'${HIDE_X}', '${HIDE_Y}'}
            close
            open
            update without registering applications

app-template/package.json

@@ -1,4 +1,7 @@
 {
+  "//":"Having trouble with this file? Try `npm run reset`",
+  "//":"Want git to ignore changes to this file? Run `npm run ignore`",
+
   "name": "*PACKAGENAME*",
   "description": "*DESCRIPTION*",
   "author": "BitPay",
@@ -79,8 +82,7 @@
     "shelljs": "^0.3.0"
   },
   "scripts": {
-    "preinstall":             "bower install && npm install fs-extra",
-    "postinstall":            "echo && echo \"To finish, choose a distribution by running 'npm run apply:copay' or 'npm run apply:bitpay'.\" && echo",
+    "postinstall":            "bower install && echo && echo \"To finish, choose a distribution by running 'npm run apply:copay' or 'npm run apply:bitpay'.\" && echo",
     "start":                  "npm run build:www && ionic serve --nolivereload --nogulp -s",
     "start:ios":              "npm run build:www && npm run build:ios && npm run open:ios",
     "start:android":          "npm run build:www && npm run build:android && npm run run:android",
@@ -98,21 +100,24 @@
     "final:www":              "npm run build:www-release",
     "final:ios":              "npm run final:www && npm run build:ios-release && npm run open:ios",
     "final:android":          "npm run final:www && npm run build:android-release && npm run run:android",
-    "final:desktop":          "grunt desktop",
-    "sign:android":           "rm -f platforms/android/build/outputs/apk/android-release-signed-aligned.apk; jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore ../copay.keystore -signedjar platforms/android/build/outputs/apk/android-release-signed.apk  platforms/android/build/outputs/apk/android-release-unsigned.apk copay_play && ../android-sdk-macosx/build-tools/21.1.1/zipalign -v 4 platforms/android/build/outputs/apk/android-release-signed.apk platforms/android/build/outputs/apk/android-release-signed-aligned.apk",
+    "final:desktop":          "npm run build:desktop && npm run build:macos",
     "run:android":            "cordova run android --device",
     "log:android":            "adb logcat | grep chromium",
+    "sign:android":           "rm -f platforms/android/build/outputs/apk/android-release-signed-aligned.apk; jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore ../copay.keystore -signedjar platforms/android/build/outputs/apk/android-release-signed.apk  platforms/android/build/outputs/apk/android-release-unsigned.apk copay_play && ../android-sdk-macosx/build-tools/21.1.1/zipalign -v 4 platforms/android/build/outputs/apk/android-release-signed.apk platforms/android/build/outputs/apk/android-release-signed-aligned.apk",
     "apply:copay":            "cd app-template && node apply.js copay && cordova prepare",
     "apply:bitpay":           "cd app-template && node apply.js bitpay && cordova prepare",
     "test":                   "./node_modules/.bin/grunt test-coveralls",
     "clean":                  "trash platforms && trash plugins && cordova prepare",
-    "clean-all":              "git clean -dfx && npm install"
+    "ignore":                 "git update-index --skip-worktree package.json",
+    "reset":                  "git update-index --no-skip-worktree package.json",
+    "clean-all":              "npm run reset && git clean -dfx"
   },
   "devDependencies": {
     "cordova": "^6.3.1",
     "grunt": "^1.0.1",
     "ionic": "^2.1.0",
     "trash-cli": "^1.4.0",
-    "lodash": "^4.3.0"
+    "lodash": "^4.3.0",
+    "fileicon": "^0.1.8"
   }
 }

package.json

@@ -1,116 +1,18 @@
- { 
-  "//":"Changes to this file will be overwritten",
-  "//":"        Modify it in the app-template directory", 
-
-  "name": "bitpay",
-  "description": "Secure Bitcoin Wallet",
-  "author": "BitPay",
-  "version": "0.14.0",
-  "keywords": [
-    "bitcoin",
-    "wallet",
-    "bitpay",
-    "copay",
-    "multisignature",
-    "bitcore"
-  ],
-  "main": "www/index.html",
-  "window": {
-    "title": "BitPay - Secure Bitcoin Wallet",
-    "icon": "www/img/icon-128.png",
-    "toolbar": false,
-    "show": true,
-    "visible": true,
-    "resizable": true,
-    "frame": true,
-    "width": 400,
-    "height": 650,
-    "position": "center",
-    "fullscreen": false
-  },
-  "webkit": {
-    "page-cache": false,
-    "java": false,
-    "plugin": false
+{
+  "name": "distribution-not-selected",
+  "description": "Choose a distribution by running 'npm run apply:copay' or 'npm run apply:bitpay'.",
+  "primary-package-json": "See the tempate in app-template/package.json",
+  "scripts": {
+    "postinstall": "npm run apply:copay",
+    "start": "echo && echo \"Choose a distribution by running 'npm run apply:copay' or 'npm run apply:bitpay'.\" && echo",
+    "preapply": "npm i fs-extra && git update-index --skip-worktree package.json",
+    "apply:copay": "npm run preapply && cd app-template && node apply.js copay && cd .. && npm i",
+    "apply:bitpay": "npm run preapply && cd app-template && node apply.js bitpay && cd .. && npm i"
   },
-  "dom_storage_quota": 200,
-  "id": "jid1-x7bV5evAaI1P9Q",
-  "homepage": "https://bitpay.com",
   "license": "MIT",
   "repository": {
+    "url": "git://github.com/bitpay/copay.git",
     "url": "git://github.com/bitpay/bitpay-wallet.git",
     "type": "git"
-  },
-  "bugs": {
-    "url": "https://github.com/bitpay/bitpay-wallet/issues"
-  },
-  "dependencies": {
-    "adm-zip": "^0.4.7",
-    "angular": "1.4.6",
-    "angular-mocks": "1.4.10",
-    "bezier-easing": "^2.0.3",
-    "bhttp": "^1.2.1",
-    "bitauth": "^0.3.2",
-    "bitcore-wallet-client": "4.3.2",
-    "bower": "^1.7.9",
-    "chai": "^3.5.0",
-    "cordova-android": "5.1.1",
-    "cordova-custom-config": "^3.0.5",
-    "cordova-plugin-qrscanner": "^2.3.1",
-    "coveralls": "^2.11.9",
-    "express": "^4.11.2",
-    "fs": "0.0.2",
-    "fs-extra": "^0.30.0",
-    "grunt-angular-gettext": "^2.2.3",
-    "grunt-browserify": "^5.0.0",
-    "grunt-cli": "^1.2.0",
-    "grunt-contrib-compress": "^1.3.0",
-    "grunt-contrib-concat": "^1.0.1",
-    "grunt-contrib-copy": "^1.0.0",
-    "grunt-contrib-uglify": "^2.0.0",
-    "grunt-contrib-watch": "^1.0.0",
-    "grunt-exec": "^1.0.0",
-    "grunt-nw-builder": "^2.0.3",
-    "grunt-sass": "^1.2.0",
-    "load-grunt-tasks": "^3.5.0",
-    "mocha": "^2.4.5",
-    "phantomjs-prebuilt": "^2.1.7",
-    "shelljs": "^0.3.0"
-  },
-  "scripts": {
-    "preinstall":             "bower install && npm install fs-extra",
-    "postinstall":            "echo && echo \"To finish, choose a distribution by running 'npm run apply:copay' or 'npm run apply:bitpay'.\" && echo",
-    "start":                  "npm run build:www && ionic serve --nolivereload --nogulp -s",
-    "start:ios":              "npm run build:www && npm run build:ios && npm run open:ios",
-    "start:android":          "npm run build:www && npm run build:android && npm run run:android",
-    "start:desktop":          "grunt desktop",
-    "watch":                  "grunt watch",
-    "build:www":              "grunt",
-    "build:www-release":      "grunt prod",
-    "build:ios":              "cordova prepare ios && cordova build ios --debug",
-    "build:android":          "cordova prepare android && cordova build android --debug",
-    "build:ios-release":      "cordova prepare ios && cordova build ios --release",
-    "build:android-release":  "cordova prepare android && cordova build android --release",
-    "open:ios":               "open platforms/ios/*.xcodeproj",
-    "open:android":           "open -a open -a /Applications/Android\\ Studio.app platforms/android",
-    "final:www":              "npm run build:www-release",
-    "final:ios":              "npm run final:www && npm run build:ios-release && npm run open:ios",
-    "final:android":          "npm run final:www && npm run build:android-release && npm run run:android",
-    "final:desktop":          "grunt desktop",
-    "sign:android":           "rm -f platforms/android/build/outputs/apk/android-release-signed-aligned.apk; jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore ../copay.keystore -signedjar platforms/android/build/outputs/apk/android-release-signed.apk  platforms/android/build/outputs/apk/android-release-unsigned.apk copay_play && ../android-sdk-macosx/build-tools/21.1.1/zipalign -v 4 platforms/android/build/outputs/apk/android-release-signed.apk platforms/android/build/outputs/apk/android-release-signed-aligned.apk",
-    "run:android":            "cordova run android --device",
-    "log:android":            "adb logcat | grep chromium",
-    "apply:copay":            "cd app-template && node apply.js copay && cordova prepare",
-    "apply:bitpay":           "cd app-template && node apply.js bitpay && cordova prepare",
-    "test":                   "./node_modules/.bin/grunt test-coveralls",
-    "clean":                  "trash platforms && trash plugins && cordova prepare",
-    "clean-all":              "git clean -dfx && npm install"
-  },
-  "devDependencies": {
-    "cordova": "^6.3.1",
-    "grunt": "^1.0.1",
-    "ionic": "^2.1.0",
-    "trash-cli": "^1.4.0",
-    "lodash": "^4.3.0"
   }
 }

resources/generate.sh

@@ -0,0 +1,28 @@
+# This script requires Sketch on macOS – see readme.md for details
+
+# export all slices marked for export to the proper directory
+echo "Exporting all assets from src.sketch..."
+sketchtool export layers src.sketch
+
+function postprocess {
+  echo "Beginning postprocessing for $1..."
+
+  echo "Postprocessing assets for macOS..."
+  iconset $1 app
+  iconset $1 volume-icon
+
+  echo "Creating Retina-ready DMG background..."
+  tiffutil -cathidpicheck $1/mac/dmg-background.png $1/mac/[email protected] -out $1/mac/dmg-background.tiff
+  echo "Removing raw background pngs..."
+  rm $1/mac/dmg-background.png $1/mac/[email protected]
+}
+
+function iconset {
+  echo "Converting $1 $2 iconset to icns..."
+  iconutil --convert icns $1/mac/$2.iconset --output $1/mac/$2.icns
+  echo "Removing $1 $2 iconset..."
+  rm -r $1/mac/$2.iconset
+}
+
+postprocess copay
+postprocess bitpay

resources/install.sh

@@ -0,0 +1,2 @@
+# This installs sketchtool: https://www.sketchapp.com/tool/
+sh /Applications/Sketch.app/Contents/Resources/sketchtool/install.sh

resources/readme.md

@@ -0,0 +1,29 @@
+# Copay Project Resources
+
+This directory contains a `src.sketch` file from which all other assets are exported or derived.
+
+## Requirements
+
+You'll need [Sketch](https://www.sketchapp.com/) to make any changes to this directory.
+
+Sketch is only available for macOS, and several processes in `generate.sh` require utilities that ship with the OS, so this process must be performed on macOS.
+
+## Install sketchtool
+
+If you do not have `sketchtool` installed, you'll first need to install it.
+
+```sh
+install.sh
+```
+
+## Generate assets
+
+To make an update, first make the change in `src.sketch`, then run:
+
+```sh
+sh generate.sh
+```
+
+## Commit the changes
+
+Be sure to commit the modified `src.sketch`, as well as any modified exported assets.