Difference between revisions of "Compile the Cloakcoin Client"

From CloakCoin Wiki
Jump to: navigation, search
(Marked this version for translation)
Line 53: Line 53:
 
</ol>
 
</ol>
 
<translate>
 
<translate>
= '''Build instructions for Linux headless edition''' = </translate>
+
= '''Build instructions for Linux headless edition''' = <!--T:34--> </translate>
  
  
 
<ol>
 
<ol>
<li><translate>Install git if you don't already have it</translate></li>
+
<li><translate><!--T:35--> Install git if you don't already have it</translate></li>
 
::<code>sudo apt install git</code>
 
::<code>sudo apt install git</code>
<li><translate>Clone the CloakCoin repository from GitHub</translate></li>
+
<li><translate><!--T:36--> Clone the CloakCoin repository from GitHub</translate></li>
 
::<code>git clone https://github.com/CloakProject/CloakCoin</code>
 
::<code>git clone https://github.com/CloakProject/CloakCoin</code>
 
::<code>cd CloakCoin/src</code>
 
::<code>cd CloakCoin/src</code>
Line 66: Line 66:
  
 
<translate>
 
<translate>
= '''Build instructions for the Raspberry Pi 3 headless edition''' = </translate>
+
= '''Build instructions for the Raspberry Pi 3 headless edition''' = <!--T:37--> </translate>
  
 
<translate>
 
<translate>
 +
<!--T:38-->
 
This guide covers everything you need to know to setup a portable staking wallet and enigma anonymous transactions node.
 
This guide covers everything you need to know to setup a portable staking wallet and enigma anonymous transactions node.
  

Revision as of 00:51, 19 October 2018

Other languages:
English • ‎Tiếng Việt • ‎Türkçe • ‎español • ‎português • ‎中文(中国大陆)‎

This guides cover the compilation of CloakCoin on Linux and raspberry Pi, it as been tested by Cloak team members on Ubuntu 16.04, Xubuntu 16.04 LTS and raspberry Pi3, diferent Linux distributions may need additional tweeking.










Build instructions for Ubuntu Linux QT GUI edition

  1. Install git if you don't already have it
  2. sudo apt install git
  3. Clone the CloakCoin repository from GitHub
  4. git clone https://github.com/CloakProject/CloakCoin
    cd CloakCoin/src
  5. Install the dependencies
  6. sudo apt install -y \ build-essential \ qt5-default \ qt5-qmake \ libleveldb-dev \ libboost1.58-dev \ libcurl4-openssl-dev \ openssl \ libssl-dev \ libdb++-dev \ libevent-dev \ libboost-dev \ libboost-system-dev \ libboost-filesystem-dev \ libboost-program-options-dev \ libboost-thread-dev \ libminiupnpc-dev
  7. Build from source
  8. qmake && make
  9. If all went well you cloakcoin-qt should now have been created in the root of the repository folder
  10. The first time you launch the wallet, it will have to sync with the network. This takes forever if you don't already have a lot of the blockchain downloaded. You can download it before hand like this:
  11. mkdir ~/.CloakCoin && cd ~/.CloakCoin
  12. Download ~1.1 GB of blockchain data
  13. wget https://backend.cloakcoin.com/wallet/v2/cloak_ldb.zip
    unzip cloak_ldb.zip
    rm cloak_ldb.zip
  14. Now you are ready to launch the wallet
  15. ./cloakcoin-qt
  16. You can optionally copy cloakcoin-qt to a directory in your $PATH so that you can open it from anywhere like
  17. sudo cp ./cloakcoin-qt /usr/local/bin

Build instructions for Linux headless edition

  1. Install git if you don't already have it
  2. sudo apt install git
  3. Clone the CloakCoin repository from GitHub
  4. git clone https://github.com/CloakProject/CloakCoin
    cd CloakCoin/src
    make -f makefile.unix

Build instructions for the Raspberry Pi 3 headless edition

This guide covers everything you need to know to setup a portable staking wallet and enigma anonymous transactions node.

If you follow the steps by order you should end up with a working CloakCoin wallet and have at the palm of your hand the power to support the cloakcoin network.

Prerequisites:

  1. Raspberry Pi 3
  2. 8Gb SD card (class 10 recomended)
  3. Power supply 5v 2A
  4. 2Gb USB stick for swap drive ( USB 3.0 recommended)
  5. LAN internet connection
  6. Coffee




Install a arm64 OS on the Raspberry Pi and setup a SWAP partition on a USB drive.

Pi64 is an 64-bit OS for the Raspberry Pi 3. It is based on Debian Stretch and backed by a 4.11 Linux kernel.

  1. Download pi64 lite from:
    https://github.com/bamarni/pi64/releases/download/2017-07-31/pi64-lite.zip
  2. To write the Pi64 image into the SD card, we are going to use Etcher, download etcher for your platform here:
    https://etcher.io/
  3. Execute Etcher, then click on 'select image' and select the Pi64 image you donwloaded earlier, then 'select drive' for the SD card you are going to use on the Pi, then click 'Flash!'. Wait for the 'flash completed!' message and then you have the SD card ready to use on the Raspberry Pi.
  4. Insert the SD card on the Raspberry Pi and power it up. During first boot the installation process will continue for a few minutes, then the Raspberry Pi will reboot and you'll be ready to go. The default user is pi and its password raspberry, it has passwordless root privileges escalation through sudo. On the lite version, SSH is enabled by default.
  5. Change the pi user password by issuing the command:
    passwd
  6. Update Pi64 packages lists by typing:
    sudo apt-get update
  7. Install a text editor:
    sudo apt-get install nano
  8. To create a swap partition on the USB drive, create an empty partition that should have no holes. You can then format this partition with:
    sudo mkswap /dev/sdX
    replacing /dev/sdX with your partition (type the command dmesg to identify your USB drive, on my case it is sda1).
  9. Mount this partition as swap with:
    sudo swapon -U UUID
    where UUID is that of your /dev/sdX as read from this:
    sudo blkid /dev/sdX
    Bind your new swap in /etc/fstab by editing fstab with:
    sudo nano /etc/fstab
    Adding this line (replace xxx with the UUID of your sdX):
    UUID=xxx none swap sw 0 0
  10. Reboot the system with:
    sudo reboot
  11. To vizualize the newly added swap partition type:
    free -h




Setup the building enviroment

  1. Install the dependencies and required apps by issuing the following commands:
  2. sudo apt-get update
    sudo apt-get install g++
    sudo apt-get install zlib1g-dev
    sudo apt-get install wget
    sudo apt-get install unzip
    sudo apt-get install make
    sudo apt-get install libboost-all-dev
    sudo apt-get install git
  3. Get the CloakCoin source:
  4. git clone https://github.com/CloakProject/CloakCoin

    This will clone the CloakCoin Project source to your machine. If you are in your home directory (by default /home/pi) it will clone to: /home/pi/CloakCoin

  5. Get and compile libevent
  6. sudo wget https://github.com/downloads/libevent/libevent/libevent-2.0.21-stable.tar.gz
    tar -zxf libevent-2.0.21-stable.tar.gz
    cd libevent-2.0.21-stable
    ./configure
    make
    sudo make install
  7. Get and compile libssl from source
  8. wget https://www.openssl.org/source/openssl-1.0.2k.tar.gz
    tar -zxf openssl-1.0.2k.tar.gz
    cd openssl-1.0.2k
    ./config
    make
    sudo make install_sw (no docs/manpages)
    echo libssl-dev hold | sudo dpkg --set-selections (keeps from updating)
  9. Get and compile Berkeley db 4.8
  10. wget http://ftpmirror.your.org/pub/misc/Berkeley-DB/db-4.8.30.zip
    unzip db-4.8.30.zip
    cd db-4.8.30/build_unix
    ../dist/configure --build=aarch64-unknown-linux-gnu --enable-cxx
    make
    sudo make install
  11. Compile levedb
  12. cd /home/pi/CloakCoin/src/leveldb
    chmod 755 build_detect_platform
    make clean
    make (ignore compile error, the *.a files have already been created)
    cp out-static/*.a .
  13. Get and compile miniupnpc 1.9
  14. wget http://miniupnp.tuxfamily.org/files/download.php?file=miniupnpc-1.9.20160209.tar.gz
    tar -zxf miniupnpc-1.9.20160209.tar.gz
    cd miniupnpc-1.9.20160209
    make

    copy libminiupnpc.a to (cloaksource)/src/miniupnpc with:

    cp libminupnpc.a /home/pi/CloakCoin/src/miniupnpc




Compile the wallet

  1. Change to CloakCoin source directory and compile:
  2. cd /home/pi/CloakCoin/src
    export CXXFLAG=" -DBOOST_NO_CXX11_SCOPED_ENUMS"
    make -f makefile.unix

    You should end up with cloakcoind in /home/pi/CloakCoin/src (grab a cup of coffee, it will take over an hour to complete). On completion do:

    cp ./cloakcoind /usr/local/bin




Inicialization, testing and first commands

  1. Before you start the wallet you need to open a text editor and create CloakCoin's rpc configuraion file with:
  2. nano /home/pi/.CloakCoin/CloakCoin.conf
  3. Write the following info:
  4. rpcuser=bitcoinrpc
    rpcpassword= <type some ramdom password that you dont need to remember>

    press Ctrl + O then Enter to save then Ctrl + X to exit the text editor.

  5. Set it to owner-readable-only with:
  6. chmod 400 /home/pi/.CloakCoin/CloakCoin.conf

    (If you fail to create the above CloakCoin.conf file, when starting the wallet with the command cloakcoind you will receive the following 'error: you must set rpcpassword=<password> in the configuration file: ...')

  7. To start the wallet with the database cache limited to 100Mb type:
  8. cloakcoind -dbcache=100
  9. Open another console by pressing Alt + F2 and type:
  10. cloakcoind getinfo

    if you get the response: error: couldnt connect to server Wait a few minutes and try again, as soon as you get a response your CloakCoin Pi wallet is up and running, and its a matter of waiting for the connections to come up and the syncing to start.

  11. Sinchronizing with the blockchain can take several days, its faster if you download the blockchain data manually:
  12. cd /home/pi/.CloakCoin
    wget https://backend.cloakcoin.com/wallet/v2/cloak_ldb.zip
    unzip cloak_ldb.zip
    rm cloak_ldb.zip
  13. Reboot:
  14. sudo reboot
  15. Start wallet again:
  16. cloakcoind -dbcache=100
  17. To get the full list of rpc commands type:
  18. cloakcoind help



Backup SD card image

It's sensible to keep a copy of the entire SD card image, so you can restore the card if you lose it or it becomes corrupt.

Of course make sure your wallet is encrypted, before making the backup.

  1. To create a backup image file on your computer type:
  2. sudo dd bs=4M if=/dev/sdb of=cloakpi.img
  3. To restore the image file to another SD card type:
  4. sudo dd bs=4M if=cloakpi.img of=/dev/sdb


That's it, have fun!