Tuske GUI

Copyright (c) 2024, The Tuske Project Copyright (c) 2014-2024, The Monero Project

Introduction

Tuske is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.

Privacy: Tuske uses a cryptographically sound system to allow you to send and receive funds without your transactions being easily revealed on the blockchain (the ledger of transactions that everyone has). This ensures that your purchases, receipts, and all transfers remain absolutely private by default.

Security: Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have a 25 word mnemonic seed that is only displayed once, and can be written down to backup the wallet. Wallet files are encrypted with a passphrase to ensure they are useless if stolen.

Untraceability: By taking advantage of ring signatures, a special property of a certain type of cryptography, Tuske is able to ensure that transactions are not only untraceable, but have an optional measure of ambiguity that ensures that transactions cannot easily be tied back to an individual user or computer.

License

See LICENSE.

Compiling the Tuske GUI from source

Note: Qt 5.9.7 is the minimum version required to build the GUI.

Building Reproducible Windows static binaries with Docker (any OS)

1. Install Docker https://docs.docker.com/engine/install/

2. Clone the repository

   git clone --recursive https://github.com/tuskenetwork/tuske-gui.git
   

3. Prepare build environment

   cd tuske-gui
   docker build --tag tuske:build-env-windows --build-arg THREADS=4 --file Dockerfile.windows .
   

   * 4 - number of CPU threads to use

4. Build

   docker run --rm -it -v <TUSKE_GUI_DIR_FULL_PATH>:/tuske-gui -w /tuske-gui tuske:build-env-windows sh -c 'make depends root=/depends target=x86_64-w64-mingw32 tag=win-x64 -j4'
   

   * <TUSKE_GUI_DIR_FULL_PATH> - absolute path to tuske-gui directory
   * 4 - number of CPU threads to use

5. Tuske GUI Windows static binaries will be placed in tuske-gui/build/x86_64-w64-mingw32/release/bin directory

Building Reproducible Linux static binaries with Docker (any OS)

1. Install Docker https://docs.docker.com/engine/install/

2. Clone the repository

   git clone  --recursive https://github.com/tuskenetwork/tuske-gui.git
   

3. Prepare build environment

   cd tuske-gui
   docker build --tag tuske:build-env-linux --build-arg THREADS=4 --file Dockerfile.linux .
   

   * 4 - number of CPU threads to use

4. Build

   docker run --rm -it -v <TUSKE_GUI_DIR_FULL_PATH>:/tuske-gui -w /tuske-gui tuske:build-env-linux sh -c 'make release-static -j4'
   

   * <TUSKE_GUI_DIR_FULL_PATH> - absolute path to tuske-gui directory
   * 4 - number of CPU threads to use

5. Tuske GUI Linux static binaries will be placed in tuske-gui/build/release/bin directory

Building Android APK with Docker (any OS) Experimental

• Minimum Android 9 Pie (API 28)
• ARMv8-A 64-bit CPU

1. Install Docker https://docs.docker.com/engine/install/

2. Clone the repository

   git clone --recursive https://github.com/tuskenetwork/tuske-gui.git
   

3. Prepare build environment

   cd tuske-gui
   docker build --tag tuske:build-env-android --build-arg THREADS=4 --file Dockerfile.android .
   

   * 4 - number of CPU threads to use

4. Build

   docker run --rm -it -v <TUSKE_GUI_DIR_FULL_PATH>:/tuske-gui -e THREADS=4 tuske:build-env-android
   

   * <TUSKE_GUI_DIR_FULL_PATH> - absolute path to tuske-gui directory
   * 4 - number of CPU threads to use

5. Tuske GUI APK will be placed in tuske-gui/build/Android/release/android-build directory

6. Deploy

   • Using ADB (Android debugger bridge)
     • Enable adb debugging on your device
     • Connect your device with USB and install Tuske GUI APK with adb:

     adb install build/Android/release/android-build/tuske-gui.apk
     

     • Troubleshooting:

     adb devices -l
     adb logcat
     

     • If using adb inside docker, make sure you did

     docker run -v /dev/bus/usb:/dev/bus/usb --privileged
     

   • Using a web server

     mkdir /usr/tmp
     cp build/Android/release/android-build/tuske-gui.apk /usr/tmp
     docker run -d -v /usr/tmp:/usr/share/nginx/html:ro -p 8080:80 nginx
     

     Now it should be accessible through a web browser at

     http://<your.local.ip>:8080/QtApp-debug.apk
     

Building on Linux

(Tested on Ubuntu 17.10 x64, Ubuntu 18.04 x64 and Gentoo x64)

1. Install Tuske dependencies

• For Debian distributions (Debian, Ubuntu, Mint, Tails...)

  sudo apt install build-essential cmake miniupnpc libunbound-dev graphviz doxygen libunwind8-dev pkg-config libssl-dev libzmq3-dev libsodium-dev libhidapi-dev libnorm-dev libusb-1.0-0-dev libpgm-dev libprotobuf-dev protobuf-compiler libgcrypt20-dev libboost-chrono-dev libboost-date-time-dev libboost-filesystem-dev libboost-locale-dev libboost-program-options-dev libboost-regex-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev

• For Gentoo

  sudo emerge app-arch/xz-utils app-doc/doxygen dev-cpp/gtest dev-libs/boost dev-libs/expat dev-libs/openssl dev-util/cmake media-gfx/graphviz net-dns/unbound net-libs/miniupnpc net-libs/zeromq sys-libs/libunwind dev-libs/libsodium dev-libs/hidapi dev-libs/libgcrypt

• For Fedora

  sudo dnf install make automake cmake gcc-c++ boost-devel miniupnpc-devel graphviz doxygen unbound-devel libunwind-devel pkgconfig openssl-devel libcurl-devel hidapi-devel libusb-devel zeromq-devel libgcrypt-devel

2. Install Qt:

Note: The Qt 5.9.7 or newer requirement makes some distributions (mostly based on Debian, like Ubuntu 16.x or Linux Mint 18.x) obsolete due to their repositories containing an older Qt version.

The recommended way is to install 5.9.7 from the official Qt installer or compiling it yourself. This ensures you have the correct version. Higher versions can work but as it differs from our production build target, slight differences may occur.

The following instructions will fetch Qt from your distribution's repositories instead. Take note of what version it installs. Your mileage may vary.

• For Debian distributions (Debian, Ubuntu, Mint, Tails...)

  sudo apt install qtbase5-dev qtdeclarative5-dev qml-module-qtqml-models2 qml-module-qtquick-controls qml-module-qtquick-controls2 qml-module-qtquick-dialogs qml-module-qtquick-xmllistmodel qml-module-qt-labs-settings qml-module-qt-labs-platform qml-module-qt-labs-folderlistmodel qttools5-dev-tools qml-module-qtquick-templates2 libqt5svg5-dev

• For Gentoo

  The qml USE flag must be enabled.

  sudo emerge dev-qt/qtcore:5 dev-qt/qtdeclarative:5 dev-qt/qtquickcontrols:5 dev-qt/qtquickcontrols2:5 dev-qt/qtgraphicaleffects:5

• Optional : To build the flag WITH_SCANNER

  • For Debian distributions (Debian, Ubuntu, Mint, Tails...)

    sudo apt install qtmultimedia5-dev qml-module-qtmultimedia

  • For Gentoo

    emerge dev-qt/qtmultimedia:5

3. Clone repository

   git clone --recursive https://github.com/tuskenetwork/tuske-gui.git
   cd tuske-gui
   

4. Build

   make release -j4
   

   * 4 - number of CPU threads to use
   * Add CMAKE_PREFIX_PATH environment variable to set a custom Qt install directory, e.g. CMAKE_PREFIX_PATH=$HOME/Qt/5.9.7/gcc_64 make release -j4

The executable can be found in the build/release/bin folder.

Building on OS X

1. Install Xcode from AppStore

2. Install homebrew

3. Install tuske dependencies:

brew install cmake pkg-config openssl boost unbound hidapi zmq libpgm libsodium miniupnpc expat libunwind-headers protobuf libgcrypt

4. Install Qt:

brew install qt5 (or download QT 5.9.7+ from qt.io)

5. Grab an up-to-date copy of the tuske-gui repository

   git clone --recursive https://github.com/tuskenetwork/tuske-gui.git
   cd tuske-gui
   

6. Start the build

   make release -j4
   

   * 4 - number of CPU threads to use
   * Add CMAKE_PREFIX_PATH environment variable to set a custom Qt install directory, e.g. CMAKE_PREFIX_PATH=$HOME/Qt/5.9.7/clang_64 make release -j4

The executable can be found in the build/release/bin folder.

For building an application bundle see DEPLOY.md.

Building on Windows

The Tuske GUI on Windows is 64 bits only; 32-bit Windows GUI builds are not officially supported anymore.

1. Install MSYS2, follow the instructions on that page on how to update system and packages to the latest versions

2. Open an 64-bit MSYS2 shell: Use the MSYS2 MinGW 64-bit shortcut, or use the msys2_shell.cmd batch file with a -mingw64 parameter

3. Install MSYS2 packages for Tuske dependencies; the needed 64-bit packages have x86_64 in their names

   pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium mingw-w64-x86_64-hidapi mingw-w64-x86_64-protobuf-c mingw-w64-x86_64-libusb mingw-w64-x86_64-libgcrypt mingw-w64-x86_64-unbound mingw-w64-x86_64-pcre
   

   You find more details about those dependencies in the Tuske documentation. Note that that there is no more need to compile Boost from source; like everything else, you can install it now with a MSYS2 package.

4. Install Qt5

   pacman -S mingw-w64-x86_64-qt5
   

   There is no more need to download some special installer from the Qt website, the standard MSYS2 package for Qt will do in almost all circumstances.

5. Install git

   pacman -S git
   

6. Clone repository

   git clone --recursive https://github.com/tuskenetwork/tuske-gui.git
   cd tuske-gui
   

7. Build

   make release-win64 -j4
   cd build/release
   make deploy
   

   * 4 - number of CPU threads to use

The executable can be found in the .\bin directory.