7.8 KiB
Building From Source
This guide will walk you through the process of building Bitsquare from source.
NOTE: For most users, building from source is not necessary. See the releases page, where you'll find installers for Windows, Linux and Mac OS X.
For the impatient
What follows is explained in detail in the sections below, but for those who know their way around Java, git and Maven, here are the instructions in a nutshell:
$ javac -version
javac 1.8.0_66 # must be 1.8.0_66 or better
$ git clone -b FixBloomFilters https://github.com/bitsquare/bitcoinj.git
$ cd bitcoinj
$ mvn clean install -DskipTests -Dmaven.javadoc.skip=true
$ git clone https://github.com/bitsquare/bitsquare.git
$ cd bitsquare
$ mvn clean package -DskipTests
When the build completes, you will find an executable jar: gui/target/shaded.jar.
To run it use:
$ java -jar gui/target/shaded.jar
To build the binary check out the build scripts under the package directory.
Prerequisites
The only prerequisite for building Bitsquare is installing the Java Development Kit (JDK), version 8u40 or better (as well as maven and git).
In Debian/Ubuntu systems with OpenJDK you'll need OpenJFX as well, i.e. you'll need the openjfx package besides the openjdk-8-jdk package.
1. Check the version of Java you currently have installed
$ javac -version
javac 1.8.0_66
If javac is not found, or your version is anything less than 1.8.0_66, then follow the next steps, otherwise you can skip to step 2:
1.1 Debian based systems (Ubuntu)
To install OpenJDK use:
$ sudo apt-get install openjdk-8-jdk maven libopenjfx-java
To install the Oracle JDK use:
$ sudo add-apt-repository ppa:webupd8team/java
$ sudo apt-get update
$ sudo apt-get install oracle-java8-installer
If $JAVA_HOME is not present, add it to the .bashrc file
$ touch .bashrc
$ gedit .bashrc
$ export JAVA_HOME=/usr/lib/jvm/java-8-oracle
$ echo $JAVA_HOME
1.2 Other systems
Download and install the latest JDK for your platform.
2. Enable unlimited Strength for cryptographic keys
Bitsquare uses 256 bit length keys which are still not permitted by default. Get around that ridiculous fact by adding the missing jars from Oracle. Please follow the steps described in the Readme file at the downloaded package. You will get an error when building Bitsquare package if you don't have these.
3. Copy the BountyCastle provider jar file
Copy the BountyCastle provider jar file (bcprov-jdk15on-1.53.jar) from you local maven repository (/home/.m2/repository/org/bouncycastle/bcprov-jdk15on/1.53/bcprov-jdk15on-1.53.jar) to $JavaHome/jre/lib/ext/. This prevent a "JCE cannot authenticate the provider BC" exception when starting the Bitsquare client.
4. Edit the jre\lib\security\java.security file to add BouncyCastleProvider
Add org.bouncycastle.jce.provider.BouncyCastleProvider as last entry at: List of providers and their preference orders E.g.: security.provider.10=org.bouncycastle.jce.provider.BouncyCastleProvider
5. Copy the jdkfix jar file
Copy the jdkfix jar file (lib/jdkfix-0.4.9.jar) from the Bitsquare src directory to $JavaHome/jre/lib/ext/. Jdkfix.jar include a bugfix of the SortedList class which will be released with the next JDK version. As we need to load that before the default java class we need that hack.
Steps
1. Get the source
The preferred approach is to clone the Bitsquare repository using git:
git clone https://github.com/bitsquare/bitsquare.git
However, if you're not familiar with git or it is otherwise inconvenient to use, you can also download and extract a zip file of the latest sources at https://github.com/bitsquare/bitsquare/archive/master.zip.
2. Install bitcoinj fork
Versions later than 0.13.1 has removed support for Java serialisation. In version 0.13.1 is also missing support for Java serialisation in MainNetParams (HttpDiscovery.Details). We removed usage of Cartographer/HttpDiscovery and fixed privacy issues with Bloom Filters at our fork version 0.13.1.4. Beside the Java serialisation issues there are privacy concerns regarding Cartographer. Here is a Github issue with background and open tasks regarding Bloom Filters.
$ git clone -b FixBloomFilters https://github.com/bitsquare/bitcoinj.git
$ cd bitcoinj
$ mvn clean install -DskipTests -Dmaven.javadoc.skip=true
3. Build jar
Bitsquare uses maven as a build system.
$ cd bitsquare
$ mvn clean package -DskipTests
4. Run
When the build completes, you will find an executable jar: gui/target/shaded.jar.
To run it use:
$ java -jar gui/target/shaded.jar
Please note that testnet is the default bitcoin network.
5. Development mode
Please check out our wiki for more information about testing and how to use regtest
Here are example program arguments for using regtest with localhost environment (not via Tor):
$ java -jar seednode/target/SeedNode.jar localhost:2002 2 50 true
$ java -jar gui/target/shaded.jar --useLocalhost=true --node.port=2222 --devTest=true --app.name=Bitsquare-Local-Regtest-Arbitrator
$ java -jar gui/target/shaded.jar --bitcoin.network=regtest --node.port=3332 --useLocalhost=true --devTest=true --app.name=Bitsquare-Local-Regtest-Alice
$ java -jar gui/target/shaded.jar --bitcoin.network=regtest --node.port=4442 --useLocalhost=true --devTest=true --app.name=Bitsquare-Local-Regtest-Bob
6. Running local seed node with Tor
If you want to run locally a seed node via Tor you need to add your seed node's hidden service address to the SeedNodesRepository.java class. You can find the hidden service address after you started once a seed node. Start it with a placeholder address like:
$ java -jar seednode/target/SeedNode.jar xxxxxxx.onion:8002 2 50
Once the hidden service is published (check console output) quit the seed node and copy the hidden service address from the console output. Alternatively you can navigate to the application directory and open Bitsquare_seed_node_xxxxxxx.onion_8002/tor/hiddenservice/hostname. use that hidden service address also to rename the xxxxxxx placeholder of your Bitsquare_seed_node_xxxxxxx.onion_8002 directory. Start again the SeedNode.jar now with the correct hidden service address. Instructions are also at the SeedNodesRepository class.
Here are example program arguments for using regtest and using the Tor network:
$ java -jar seednode/target/SeedNode.jar rxdkppp3vicnbgqt.onion:8002 2 50
$ java -jar gui/target/shaded.jar --bitcoin.network=regtest node.port=2222 --devTest=true --app.name=Bitsquare-Tor-Regtest-Arbitrator
$ java -jar gui/target/shaded.jar --bitcoin.network=regtest node.port=3332 --devTest=true --app.name=Bitsquare-Tor-Regtest-Alice
$ java -jar gui/target/shaded.jar --bitcoin.network=regtest node.port=4442 --devTest=true --app.name=Bitsquare-Tor-Regtest-Bob
Problems?
If the instructions above don't work for you, please raise an issue. Thanks!