Copyright (c) 2017-2018 The Halykcoin Project.
Portions Copyright (c) 2014-2017 The Monero Project.
Portions Copyright (c) 2012-2013 The Cryptonote developers.
- Web: halykcoin.org
- Forum: bitcointalk.org
- GitHub: https://github.com/HalykCoin/halykcoin/
- Telegram: Rus Halykcoin
Halykcoin is based on Monero. Monero is a wonderful, 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.
This is the core implementation of Halykcoin/Monero. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Halykcoin/Monero that uses the protocol and network in a compatible manner.
As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.
See LICENSE.
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 | Optional | Purpose |
---|---|---|---|---|---|---|
GCC | 4.7.3 | NO | build-essential |
base-devel |
NO | |
CMake | 3.0.0 | NO | cmake |
cmake |
NO | |
pkg-config | any | NO | pkg-config |
base-devel |
NO | |
Boost | 1.58 | NO | libboost-all-dev |
boost |
NO | C++ libraries |
OpenSSL | basically any | NO | libssl-dev |
openssl |
NO | sha256 sum |
libzmq | 3.0.0 | NO | libzmq3-dev |
zeromq |
NO | ZeroMQ library |
libunbound | 1.4.16 | YES | libunbound-dev |
unbound |
NO | DNS resolver |
libminiupnpc | 2.0 | YES | libminiupnpc-dev |
miniupnpc |
YES | NAT punching |
libunwind | any | NO | libunwind8-dev |
libunwind |
YES | Stack traces |
liblzma | any | NO | liblzma-dev |
xz |
YES | For libunwind |
libreadline | 6.3.0 | NO | libreadline6-dev |
readline |
YES | Input editing |
ldns | 1.6.17 | NO | libldns-dev |
ldns |
YES | SSL toolkit |
expat | 1.1 | NO | libexpat1-dev |
expat |
YES | XML parsing |
GTest | 1.5 | YES | libgtest-dev ^ |
gtest |
YES | Test suite |
Doxygen | any | NO | doxygen |
doxygen |
YES | Documentation |
Graphviz | any | NO | graphviz |
graphviz |
YES | Documentation |
[^] 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/
Halykcoin uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.
-
Install the dependencies
-
Change to the root of the source code directory and build:
cd halykcoin make
Optional: If your machine has several cores and enough memory, enable parallel build by running
make -j<number of threads>
instead ofmake
. 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 OS X, installing
zmq.hpp
from https://github.com/zeromq/cppzmq to/usr/local/include
should fix that error. -
The resulting executables can be found in
build/release/bin
-
Add
PATH="$PATH:$HOME/halykcoin/build/release/bin"
to.profile
-
Run Halykcoin with
halykcoind --detach
-
Optional: build and run the test suite to verify the binaries:
make release-test
NOTE:
coretests
test may take a few hours to complete. -
Optional: to build binaries suitable for debugging:
make debug
-
Optional: to build statically-linked binaries:
make release-static
-
Optional: build documentation in
doc/html
(omitHAVE_DOT=YES
ifgraphviz
is not installed):HAVE_DOT=YES doxygen Doxyfile
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 -Syuu
-
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 -Syuu
-
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
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
-
Open the MingW shell via
MinGW-w64-Win64 Shell
shortcut on 64-bit Windows orMinGW-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.
Building
-
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
By default, in either dynamically or statically linked builds, binaries target the specific host processor on which the build happens and are not portable to other processors. Portable binaries can be built using the following targets:
make release-static-linux-x86_64
builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processorsmake release-static-linux-i686
builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processorsmake release-static-linux-armv8
builds binaries on Linux portable across POSIX systems on armv8 processorsmake release-static-linux-armv7
builds binaries on Linux portable across POSIX systems on armv7 processorsmake release-static-linux-armv6
builds binaries on Linux portable across POSIX systems on armv6 processorsmake release-static-win64
builds binaries on 64-bit Windows portable across 64-bit Windows systemsmake release-static-win32
builds binaries on 64-bit or 32-bit Windows portable across 32-bit Windows systems
The build places the binary in bin/
sub-directory within the build directory
from which cmake was invoked (repository root by default). To run in
foreground:
./bin/halykcoind
To list all available options, run ./bin/halykcoind --help
. Options can be
specified either on the command line or in a configuration file passed by the
--config-file
argument. To specify an option in the configuration file, add
a line with the syntax argumentname=value
, where argumentname
is the name
of the argument without the leading dashes, for example log-level=1
.
To run in background:
./bin/halykcoind --log-file halykcoind.log --detach
To run as a systemd service, copy
halykcoind.service to /etc/systemd/system/
and
halykcoind.conf to /etc/
. The example
service assumes that the user halykcoin
exists
and its home is the data directory specified in the example
config.
If you're on Mac, you may need to add the --max-concurrency 1
option to
halykcoin-wallet-cli, and possibly halykcoind, if you get crashes refreshing.
While Halykcoin/Monero isn't made to integrate with Tor, it can be used wrapped with torsocks, if you add --p2p-bind-ip 127.0.0.1 to the halykcoind command line. You also want to set DNS requests to go over TCP, so they'll be routed through Tor, by setting DNS_PUBLIC=tcp or use a particular DNS server with DNS_PUBLIC=tcp://a.b.c.d (default is 8.8.4.4, which is Google DNS). You may also disable IGD (UPnP port forwarding negotiation), which is pointless with Tor. To allow local connections from the wallet, you might have to add TORSOCKS_ALLOW_INBOUND=1, some OSes need it and some don't. Example:
DNS_PUBLIC=tcp torsocks halykcoind --p2p-bind-ip 127.0.0.1 --no-igd
or:
DNS_PUBLIC=tcp TORSOCKS_ALLOW_INBOUND=1 torsocks halykcoind --p2p-bind-ip 127.0.0.1 --no-igd
TAILS ships with a very restrictive set of firewall rules. Therefore, you need to add a rule to allow this connection too, in addition to telling torsocks to allow inbound connections. Full example:
sudo iptables -I OUTPUT 2 -p tcp -d 127.0.0.1 -m tcp --dport 18081 -j ACCEPT
DNS_PUBLIC=tcp torsocks ./halykcoind --p2p-bind-ip 127.0.0.1 --no-igd --rpc-bind-ip 127.0.0.1 --data-dir /home/amnesia/Persistent/your/directory/to/the/blockchain
./halykcoind-wallet-cli
This section contains general instructions for debugging failed installs or problems encountered with Halykcoin. First ensure you are running the latest version built from the github repo.