Haven Artemis v2.0.0

Development resources

Web: havenprotocol.org
Mail: team@havenprotocol.org
GitHub: https://github.com/haven-protocol-org/haven-main

About this project

Haven is an untraceable cryptocurrency with a mix of standard market pricing and real world asset-pegged value storage. It achieves this via a “mint and burn” process within a single blockchain.

In the simplest case, users can burn Haven (XHV) for the equivalent USD value worth of Haven Dollars (xUSD). Or, to restore to a volatile state, the user can equally burn xUSD for $1 USD worth of XHV.

Building from source

Dependencies

The following table summarizes the tools and libraries required to build. A few of the libraries are also included in this repository (marked as "Vendored"). By default, the build uses the library installed on the system, and ignores the vendored sources. However, if no library is found installed on the system, then the vendored source will be built and used. The vendored sources are also used for statically-linked builds because distribution packages often include only shared library binaries (.so) but not static library archives (.a).

Dep	Min. version	Vendored	Debian/Ubuntu pkg	Arch pkg	Void pkg	Fedora pkg	Optional	Purpose
GCC	4.7.3	NO	`build-essential`	`base-devel`	`base-devel`	`gcc`	NO
CMake	3.5	NO	`cmake`	`cmake`	`cmake`	`cmake`	NO
pkg-config	any	NO	`pkg-config`	`base-devel`	`base-devel`	`pkgconf`	NO
Boost	1.58	NO	`libboost-all-dev`	`boost`	`boost-devel`	`boost-devel`	NO	C++ libraries
OpenSSL	basically any	NO	`libssl-dev`	`openssl`	`libressl-devel`	`openssl-devel`	NO	sha256 sum
libzmq	3.0.0	NO	`libzmq3-dev`	`zeromq`	`zeromq-devel`	`zeromq-devel`	NO	ZeroMQ library
OpenPGM	?	NO	`libpgm-dev`	`libpgm`		`openpgm-devel`	NO	For ZeroMQ
libnorm[2]	?	NO	`libnorm-dev`				YES	For ZeroMQ
libunbound	1.4.16	YES	`libunbound-dev`	`unbound`	`unbound-devel`	`unbound-devel`	NO	DNS resolver
libsodium	?	NO	`libsodium-dev`	`libsodium`	`libsodium-devel`	`libsodium-devel`	NO	cryptography
libunwind	any	NO	`libunwind8-dev`	`libunwind`	`libunwind-devel`	`libunwind-devel`	YES	Stack traces
liblzma	any	NO	`liblzma-dev`	`xz`	`liblzma-devel`	`xz-devel`	YES	For libunwind
libreadline	6.3.0	NO	`libreadline6-dev`	`readline`	`readline-devel`	`readline-devel`	YES	Input editing
ldns	1.6.17	NO	`libldns-dev`	`ldns`	`libldns-devel`	`ldns-devel`	YES	SSL toolkit
expat	1.1	NO	`libexpat1-dev`	`expat`	`expat-devel`	`expat-devel`	YES	XML parsing
GTest	1.5	YES	`libgtest-dev`[1]	`gtest`	`gtest-devel`	`gtest-devel`	YES	Test suite
Doxygen	any	NO	`doxygen`	`doxygen`	`doxygen`	`doxygen`	YES	Documentation
Graphviz	any	NO	`graphviz`	`graphviz`	`graphviz`	`graphviz`	YES	Documentation
lrelease	?	NO	`qttools5-dev-tools`	`qt5-tools`	`qt5-tools`	`qt5-linguist`	YES	Translations
libhidapi	?	NO	`libhidapi-dev`	`hidapi`	`hidapi-devel`	`hidapi-devel`	YES	Hardware wallet
libusb	?	NO	`libusb-dev`	`libusb`	`libusb-devel`	`libusb-devel`	YES	Hardware wallet
libprotobuf	?	NO	`libprotobuf-dev`	`protobuf`	`protobuf-devel`	`protobuf-devel`	YES	Hardware wallet
protoc	?	NO	`protobuf-compiler`	`protobuf`	`protobuf`	`protobuf-compiler`	YES	Hardware wallet

[1] On Debian/Ubuntu libgtest-dev only includes sources and headers. You must build the library binary manually. This can be done with the following command sudo apt-get install libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv libg* /usr/lib/ [2] libnorm-dev is needed if your zmq library was built with libnorm, and not needed otherwise

Install all dependencies at once on Debian/Ubuntu:

sudo apt update && sudo apt install build-essential cmake pkg-config libboost-all-dev libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libldns-dev libexpat1-dev doxygen graphviz libpgm-dev qttools5-dev-tools libhidapi-dev libusb-dev libprotobuf-dev protobuf-compiler

Install all dependencies at once on macOS with the provided Brewfile: brew update && brew bundle --file=contrib/brew/Brewfile

FreeBSD one liner for required to build dependencies pkg install git gmake cmake pkgconf boost-libs libzmq libsodium

Cloning the repository

Clone recursively to pull-in needed submodule(s):

$ git clone --recursive https://github.com/haven-protocol-org/haven-main

If you already have a repo cloned, initialize and update:

$ cd haven-main && git submodule init && git submodule update

Build instructions

Haven uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.

On Linux and macOS

Install the dependencies
Change to the root of the source code directory, change to the most recent release branch, and build:
```
cd haven-main
git checkout v1.3.5
./build-haven.sh release
```
Optional: If your machine has several cores and enough memory, enable parallel build by running ./build-haven.sh -j<number of threads> release instead of ./build-haven.sh release. For this to be worthwhile, the machine should have one core and about 2GB of RAM available per thread.

Note: If cmake can not find zmq.hpp file on macOS, installing zmq.hpp from https://github.com/zeromq/cppzmq to /usr/local/include should fix that error.

Note: The instructions above will compile the most stable release of the Haven software. If you would like to use and test the most recent software, use git checkout master. The master branch may contain updates that are both unstable and incompatible with release software, though testing is always encouraged.
The resulting executables can be found in monero/build/release/bin
Add PATH="$PATH:$HOME/haven-main/monero/build/release/bin" to .profile
Run Haven with havend --detach

Dependencies need to be built with -fPIC. Static libraries usually aren't, so you may have to build them yourself with -fPIC. Refer to their documentation for how to build them.

On Windows:

Binaries for Windows are built on Windows using the MinGW toolchain within MSYS2 environment. The MSYS2 environment emulates a POSIX system. The toolchain runs within the environment and cross-compiles binaries that can run outside of the environment as a regular Windows application.

Preparing the build environment

Download and install the MSYS2 installer, either the 64-bit or the 32-bit package, depending on your system.
Open the MSYS shell via the MSYS2 Shell shortcut
Update packages using pacman:
```
pacman -Syu
```
Exit the MSYS shell using Alt+F4
Edit the properties for the MSYS2 Shell shortcut changing "msys2_shell.bat" to "msys2_shell.cmd -mingw64" for 64-bit builds or "msys2_shell.cmd -mingw32" for 32-bit builds
Restart MSYS shell via modified shortcut and update packages again using pacman:
```
pacman -Syu
```

Install dependencies:

To build for 64-bit Windows:

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

To build for 32-bit Windows:

pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium mingw-w64-i686-hidapi

Open the MingW shell via MinGW-w64-Win64 Shell shortcut on 64-bit Windows or MinGW-w64-Win64 Shell shortcut on 32-bit Windows. Note that if you are running 64-bit Windows, you will have both 64-bit and 32-bit MinGW shells.

Cloning

To git clone, run:

git clone --recursive https://github.com/haven-protocol-org/haven-main

Building

Change to the cloned directory, run:
```
cd haven-main
```
If you would like a specific version/tag, do a git checkout for that version. eg. 'v1.3.5'. If you don't care about the version and just want binaries from master, skip this step:
```
git checkout v1.3.5
```
If you are on a 64-bit system, run:
```
make release-static-win64
```
If you are on a 32-bit system, run:
```
make release-static-win32
```
The resulting executables can be found in build/release/bin
Optional: to build Windows binaries suitable for debugging on a 64-bit system, run:
```
make debug-static-win64
```
Optional: to build Windows binaries suitable for debugging on a 32-bit system, run:
```
make debug-static-win32
```
The resulting executables can be found in build/debug/bin

kim0/haven-main