Merge branch 'master' into master

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,2 @@
+<!-- Note: This website is for bug reports, not general questions.
+Do not post issues about non-bitcoin versions of Electrum. -->

.travis.yml

@@ -4,11 +4,28 @@ python:
     - 3.5
     - 3.6
 install:
-  - pip install -r requirements_travis.txt
+  - pip install -r contrib/requirements/requirements-travis.txt
 cache:
-  - pip
+  - pip: true
+  - directories:
+    - /tmp/electrum-build
 script:
     - tox
 after_success:
     - if [ "$TRAVIS_BRANCH" = "master" ]; then pip install pycurl requests && contrib/make_locale; fi
     - coveralls
+jobs:
+  include:
+    - stage: windows build
+      sudo: true
+      python: 3.5
+      install:
+        - sudo dpkg --add-architecture i386
+        - wget -nc https://dl.winehq.org/wine-builds/Release.key
+        - sudo apt-key add Release.key
+        - sudo apt-add-repository https://dl.winehq.org/wine-builds/ubuntu/
+        - sudo apt-get update -qq
+        - sudo apt-get install -qq winehq-stable dirmngr gnupg2 p7zip-full
+      before_script: ls -lah /tmp/electrum-build
+      script: ./contrib/build-wine/build.sh
+      after_success: true

Dockerfile

@@ -1,6 +1,6 @@
 FROM ubuntu:18.04
 
-ENV VERSION 1.0.6
+ENV VERSION 1.0.7
 
 RUN set -x \
     && apt-get update \

README.rst

@@ -101,30 +101,18 @@ Run the docker image::
     ./run-docker.sh
 
 
-Building Releases
-=================
-
-
-MacOS
-------
-
-Simply - ::
-
-    ./setup-mac.sh
-
-    sudo ./create-dmg.sh
+See `contrib/build-osx/`.
 
 Windows
 -------
 
-See `contrib/build-wine/README` file.
+See `contrib/build-wine/`.
 
 
 Android
 -------
 
 See `gui/kivy/Readme.txt` file.
-UPSTREAM PATCH: https://github.com/spesmilo/electrum/blob/master/gui/kivy/Readme.md
 
 ---
 

RELEASE-NOTES

@@ -1,3 +1,80 @@
+
+# Release 3.1 - (March 5, 2018)
+
+ * Memory-pool based fee estimation. Dynamic fees can target a desired
+   depth in the memory pool. This feature is optional, and ETA-based
+   estimates from Bitcoin Core are still available. Note that miners
+   could exploit this feature, if they conspired and filled the memory
+   pool with expensive transactions that never get mined. However,
+   since the Electrum client already trusts an Electrum server with
+   fee estimates, activating this feature does not introduce any new
+   vulnerability. In addition, the client uses a hard threshold to
+   protect itself from servers sending excessive fee estimates. In
+   practice, ETA-based estimates have resulted in sticky fees, and
+   caused many users to overpay for transactions. Advanced users tend
+   to visit (and trust) websites that display memory-pool data in
+   order to set their fees.
+ * Capital gains: For each outgoing transaction, the difference
+   between the acquisition and liquidation prices of outgoing coins is
+   displayed in the wallet history. By default, historical exchange
+   rates are used to compute acquisition and liquidation prices. These
+   values can also be entered manually, in order to match the actual
+   price realized by the user. The order of liquidation of coins is
+   the natural order defined by the blockchain; this results in
+   capital gain values that are invariant to changes in the set of
+   addresses that are in the wallet. Any other ordering strategy (such
+   as FIFO, LIFO) would result in capital gain values that depend on
+   the presence of other addresses in the wallet.
+ * Local transactions: Transactions can be saved in the wallet without
+   being broadcast. The inputs of local transactions are considered as
+   spent, and their change outputs can be re-used in subsequent
+   transactions. This can be combined with cold storage, in order to
+   create several transactions before broadcasting them. Outgoing
+   transactions that have been removed from the memory pool are also
+   saved in the wallet, and can be broadcast again.
+ * Checkpoints: The initial download of a headers file was replaced
+   with hardcoded checkpoints. The wallet uses one checkpoint per
+   retargeting period. The headers for a retargeting period are
+   downloaded only if transactions need to be verified in this period.
+ * The 'privacy' and 'priority' coin selection policies have been
+   merged into one. Previously, the 'privacy' policy has been unusable
+   because it was was not prioritizing confirmed coins. The new policy
+   is similar to 'privacy', except that it de-prioritizes addresses
+   that have unconfirmed coins.
+ * The 'Send' tab of the Qt GUI displays how transaction fees are
+   computed from transaction size.
+ * The wallet history can be filtered by time interval.
+ * Replace-by-fee is enabled by default. Note that this might cause
+   some issues with wallets that do not display RBF transactions until
+   they are confirmed.
+ * Watching-only wallets and hardware wallets can be encrypted.
+ * Semi-automated crash reporting
+ * The SSL checkbox option was removed from the GUI.
+ * The Trezor T hardware wallet is now supported.
+ * BIP84: native segwit p2wpkh scripts for bip39 seeds and hardware
+   wallets can now be created when specifying a BIP84 derivation
+   path. This is usable with Trezor and Ledger.
+ * Windows: the binaries now include ZBar, and QR code scanning should work.
+ * The Wallet Import Format (WIF) for private keys that was extended in 3.0
+   is changed. Keys in the previous format can be imported, compatibility
+   is maintained. Newly exported keys will be serialized as
+   "script_type:original_wif_format_key".
+ * BIP32 master keys for testnet once again have different version bytes than
+   on mainnet. For the mainnet prefixes {x,y,Y,z,Z}|{pub,prv}, the
+   corresponding testnet prefixes are   {t,u,U,v,V}|{pub,prv}.
+   More details and exact version bytes are specified at:
+   https://github.com/spesmilo/electrum-docs/blob/master/xpub_version_bytes.rst
+   Note that due to this change, testnet wallet files created with previous
+   versions of Electrum must be considered broken, and they need to be
+   recreated from seed words.
+ * A new version of the Electrum protocol is required by the client
+   (version 1.2). Servers using older versions of the protocol will
+   not be displayed in the GUI.
+
+
+# Release 3.0.6 :
+  * Fix transaction parsing bug #3788
+
 # Release 3.0.5 : (Security update)
 
 This is a follow-up to the 3.0.4 release, which did not completely fix

contrib/build-osx/README.md

@@ -0,0 +1,17 @@
+Building Mac OS binaries
+========================
+
+This guide explains how to build Electrum binaries for macOS systems.
+We build our binaries on El Capitan (10.11.6) as building it on High Sierra
+makes the binaries incompatible with older versions.
+
+This assumes that the Xcode command line tools (and thus git) are already installed. 
+
+
+## 1. Run the script
+
+
+
+    ./make_osx
+
+## 2. Done

contrib/build-osx/make_osx

@@ -0,0 +1,84 @@
+#!/bin/bash
+RED='\033[0;31m'
+BLUE='\033[0,34m'
+NC='\033[0m' # No Color
+function info {
+	printf "\r💬 ${BLUE}INFO:${NC} ${1}\n"
+}
+function fail {
+    printf "\r🗯 ${RED}ERROR:${NC} ${1}\n"
+    exit 1
+}
+
+build_dir=$(dirname "$0")
+test -n "$build_dir" -a -d "$build_dir" || exit
+cd $build_dir/../..
+
+export PYTHONHASHSEED=22
+VERSION=`git describe --tags`
+
+# Paramterize
+PYTHON_VERSION=3.6.4
+BUILDDIR=/tmp/electrum-build
+PACKAGE=Electrum-ZCL
+GIT_REPO=https://github.com/z-classic/electrum-zcl
+
+
+info "Installing Python $PYTHON_VERSION"
+export PATH="~/.pyenv/bin:~/.pyenv/shims:~/Library/Python/3.6/bin:$PATH"
+if [ -d "~/.pyenv" ]; then
+  pyenv update
+else
+  curl -L https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer | bash > /dev/null 2>&1
+fi
+PYTHON_CONFIGURE_OPTS="--enable-framework" pyenv install -s $PYTHON_VERSION && \
+pyenv global $PYTHON_VERSION || \
+fail "Unable to use Python $PYTHON_VERSION"
+
+
+info "Installing pyinstaller"
+python3 -m pip install git+https://github.com/ecdsa/pyinstaller@fix_2952 -I --user || fail "Could not install pyinstaller"
+
+info "Using these versions for building $PACKAGE:"
+sw_vers
+python3 --version
+echo -n "Pyinstaller "
+pyinstaller --version
+
+rm -rf ./dist
+
+
+rm  -rf $BUILDDIR > /dev/null 2>&1
+mkdir $BUILDDIR
+
+info "Downloading icons and locale..."
+for repo in icons locale; do
+  git clone $GIT_REPO-$repo $BUILDDIR/electrum-$repo
+done
+
+cp -R $BUILDDIR/electrum-locale/locale/ ./lib/locale/
+cp    $BUILDDIR/electrum-icons/icons_rc.py ./gui/qt/
+
+
+info "Downloading libusb..."
+curl https://homebrew.bintray.com/bottles/libusb-1.0.21.el_capitan.bottle.tar.gz | \
+tar xz --directory $BUILDDIR
+cp $BUILDDIR/libusb/1.0.21/lib/libusb-1.0.dylib contrib/build-osx
+
+info "Installing requirements..."
+python3 -m pip install -Ir ./contrib/deterministic-build/requirements.txt --user && \
+python3 -m pip install -Ir ./contrib/deterministic-build/requirements-binaries.txt --user || \
+fail "Could not install requirements"
+
+info "Installing hardware wallet requirements..."
+python3 -m pip install -Ir ./contrib/deterministic-build/requirements-hw.txt --user || \
+fail "Could not install hardware wallet requirements"
+
+info "Building $PACKAGE..."
+python3 setup.py install --user > /dev/null || fail "Could not build $PACKAGE"
+
+info "Building binary"
+pyinstaller --noconfirm --ascii --name $VERSION contrib/build-osx/osx.spec || fail "Could not build binary"
+
+info "Creating .DMG"
+hdiutil create -fs HFS+ -volname $PACKAGE -srcfolder dist/$PACKAGE.app dist/Electrum-ZCL-$VERSION.dmg || fail "Could not create .DMG"

contrib/build-osx/osx.spec

@@ -0,0 +1,99 @@
+# -*- mode: python -*-
+
+from PyInstaller.utils.hooks import collect_data_files, collect_submodules, collect_dynamic_libs
+
+import sys
+import os
+
+PACKAGE='Electrum-ZCL'
+PYPKG='electrum'
+MAIN_SCRIPT='electrum'
+ICONS_FILE='electrum.icns'
+
+for i, x in enumerate(sys.argv):
+    if x == '--name':
+        VERSION = sys.argv[i+1]
+        break
+else:
+    raise BaseException('no version')
+
+electrum = os.path.abspath(".") + "/"
+block_cipher = None
+
+# see https://github.com/pyinstaller/pyinstaller/issues/2005
+hiddenimports = []
+hiddenimports += collect_submodules('trezorlib')
+hiddenimports += collect_submodules('btchip')
+hiddenimports += collect_submodules('keepkeylib')
+hiddenimports += collect_submodules('websocket')
+
+datas = [
+    (electrum+'lib/currencies.json', PYPKG),
+    (electrum+'lib/servers.json', PYPKG),
+    (electrum+'lib/checkpoints.json', PYPKG),
+    (electrum+'lib/servers_testnet.json', PYPKG),
+    (electrum+'lib/checkpoints_testnet.json', PYPKG),
+    (electrum+'lib/wordlist/english.txt', PYPKG + '/wordlist'),
+    (electrum+'lib/locale', PYPKG + '/locale'),
+    (electrum+'plugins', PYPKG + '_plugins'),
+]
+datas += collect_data_files('trezorlib')
+datas += collect_data_files('btchip')
+datas += collect_data_files('keepkeylib')
+
+# Add libusb so Trezor will work
+binaries = [(electrum + "contrib/build-osx/libusb-1.0.dylib", ".")]
+
+# Workaround for "Retro Look":
+binaries += [b for b in collect_dynamic_libs('PyQt5') if 'macstyle' in b[0]]
+
+# We don't put these files in to actually include them in the script but to make the Analysis method scan them for imports
+a = Analysis([electrum+MAIN_SCRIPT,
+              electrum+'gui/qt/main_window.py',
+              electrum+'gui/text.py',
+              electrum+'lib/util.py',
+              electrum+'lib/wallet.py',
+              electrum+'lib/simple_config.py',
+              electrum+'lib/bitcoin.py',
+              electrum+'lib/dnssec.py',
+              electrum+'lib/commands.py',
+              electrum+'plugins/cosigner_pool/qt.py',
+              electrum+'plugins/email_requests/qt.py',
+              electrum+'plugins/trezor/client.py',
+              electrum+'plugins/trezor/qt.py',
+              electrum+'plugins/keepkey/qt.py',
+              electrum+'plugins/ledger/qt.py',
+              ],
+             binaries=binaries,
+             datas=datas,
+             hiddenimports=hiddenimports,
+             hookspath=[])
+
+# http://stackoverflow.com/questions/19055089/pyinstaller-onefile-warning-pyconfig-h-when-importing-scipy-or-scipy-signal
+for d in a.datas:
+    if 'pyconfig' in d[0]:
+        a.datas.remove(d)
+        break
+
+pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
+
+exe = EXE(pyz,
+          a.scripts,
+          a.binaries,
+          a.datas,
+          name=PACKAGE,
+          debug=False,
+          strip=False,
+          upx=True,
+          icon=electrum+ICONS_FILE,
+          console=False)
+
+app = BUNDLE(exe,
+             version = VERSION,
+             name=PACKAGE + '.app',
+             icon=electrum+ICONS_FILE,
+             bundle_identifier=None,
+             info_plist = {
+                 'NSHighResolutionCapable':'True'
+             }
+)

contrib/build-wine/README.md

@@ -2,7 +2,7 @@ Windows Binary Builds
 =====================
 
 These scripts can be used for cross-compilation of Windows Electrum executables from Linux/Wine.
-Produced binaries are deterministic so you should be able to generate binaries that match the official releases.
+Produced binaries are deterministic, so you should be able to generate binaries that match the official releases. 
 
 
 Usage:
@@ -12,15 +12,15 @@ Usage:
 
  - dirmngr
  - gpg
+ - 7Zip
  - Wine (>= v2)
 
 
 For example:
 
 
 ```
-$ sudo apt-get install wine-development dirmngr gnupg2
-$ sudo ln -sf /usr/bin/wine-development /usr/local/bin/wine
+$ sudo apt-get install wine-development dirmngr gnupg2 p7zip-full
 $ wine --version
  wine-2.0 (Debian 2.0-3+b2)
 ```