Copyright (c) 2018-2019 CUT coin.
Portions Copyright (c) 2012-2013 The Cryptonote developers.
Concealed untraceable transactions coin that establishes a new level of privacy and usability.
If you want to help out, see CONTRIBUTING for a set of guidelines.
Scheduled software upgrades
Compiling CUT coin from source
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 (
|Dep||Min. version||Vendored||Debian/Ubuntu pkg||Arch pkg||Fedora||Optional||Purpose|
[^] 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/
Debian / Ubuntu one liner for all dependencies
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
Debug mode build also requires QT4, on Debian / Ubuntu
sudo apt install qt4-default
Cloning the repository
Clone recursively to pull-in needed submodule(s):
$ git clone --recursive https://github.com/cutcoin/cutcoin
If you already have a repo cloned, initialize and update:
$ cd cutcoin && git submodule init && git submodule update
CUT coin uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.
On Linux and OS X
Install the dependencies
Change to the root of the source code directory, change to the most recent release branch, and build:
cd cutcoin git checkout v0.13.0.4 make
Optional: If your machine has several cores and enough memory, enable parallel build by running
make -j<number of threads>instead of
make. 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.hppfrom https://github.com/zeromq/cppzmq to
/usr/local/includeshould fix that error.
The resulting executables can be found in
Run Cutcoin with
Optional: build and run the test suite to verify the binaries:
core_teststest may take a few hours to complete.
Optional: to build binaries suitable for debugging:
Optional: to build statically-linked binaries:
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.
Optional: build documentation in
graphvizis not installed):
HAVE_DOT=YES doxygen Doxyfile
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
To list all available options, run
./bin/cutcoind --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 is the name
of the argument without the leading dashes, for example
To run in background:
./bin/cutcoind --log-file cutcoind.log --detach
To run as a systemd service, copy
/etc/. The example
service assumes that the user
and its home is the data directory specified in the example
If you're on Mac, you may need to add the
--max-concurrency 1 option to
cutcoin-wallet-cli, and possibly cutcoind, if you get crashes refreshing.
While CUT coin isn't made to integrate with Tor, it can be used wrapped with torsocks, by setting the following configuration parameters and environment variables:
--p2p-bind-ip 127.0.0.1on the command line or
p2p-bind-ip=127.0.0.1in cutcoind.conf to disable listening for connections on external interfaces.
--no-igdon the command line or
no-igd=1in cutcoind.conf to disable IGD (UPnP port forwarding negotiation), which is pointless with Tor.
DNS_PUBLIC=tcp://x.x.x.xwhere x.x.x.x is the IP of the desired DNS server, for DNS requests to go over TCP, so that they are routed through Tor. When IP is not specified, cutcoind uses the default list of servers defined in src/common/dns_utils.cpp.
TORSOCKS_ALLOW_INBOUND=1to tell torsocks to allow cutcoind to bind to interfaces to accept connections from the wallet. On some Linux systems, torsocks allows binding to localhost by default, so setting this variable is only necessary to allow binding to local LAN/VPN interfaces to allow wallets to connect from remote hosts. On other systems, it may be needed for local wallets as well.
- Do NOT pass
--detachwhen running through torsocks with systemd, (see utils/systemd/cutcoind.service for details).
- If you use the wallet with a Tor daemon via the loopback IP (eg, 127.0.0.1:9050),
--untrusted-daemonunless it is your own hidden service.
Example command line to start cutcoind through Tor:
DNS_PUBLIC=tcp torsocks cutcoind --p2p-bind-ip 127.0.0.1 --no-igd
Using Tor on Tails
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 ./cutcoind --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
This section contains general instructions for debugging failed installs or problems encountered with CUT coin. First ensure you are running the latest version built from the Github repo.
Obtaining stack traces and core dumps on Unix systems
We generally use the tool
gdb (GNU debugger) to provide stack trace functionality,
ulimit to provide core dumps in builds which crash or segfault.
- To use gdb in order to obtain a stack trace for a build that has stalled:
Run the build.
Once it stalls, enter the following command:
gdb /path/to/cutcoind `pidof cutcoind`
thread apply all bt within gdb in order to obtain the stack trace
- If however the core dumps or segfaults:
ulimit -c unlimited on the command line to enable unlimited filesizes for core dumps
echo core | sudo tee /proc/sys/kernel/core_pattern to stop cores from being hijacked
by other tools
Run the build.
When it terminates with an output along the lines of "Segmentation fault (core dumped)",
there should be a core dump file in the same directory as cutcoind. It may be named just
core.xxxx with numbers appended.
You can now analyse this core dump with
gdb as follows:
gdb /path/to/cutcoind /path/to/dumpfile
Print the stack trace with
- To run cutcoin within gdb:
Pass command-line options with
--args followed by the relevant arguments
run to run cutcoind
Analysing memory corruption
There are two tools available:
Configure CUT coin with the -D SANITIZE=ON cmake flag, eg:
cd build/debug && cmake -D SANITIZE=ON -D CMAKE_BUILD_TYPE=Debug ../..
You can then run the cutcoin tools normally. Performance will typically halve.
Install valgrind and run as
valgrind /path/to/cutcoind. It will be very slow.
Instructions for debugging suspected blockchain corruption as per @HYC
There is an
mdb_stat command in the LMDB source that can print statistics about
the database but it's not routinely built. This can be built with the following command:
cd ~/cutcoin/external/db_drivers/liblmdb && make
The output of
mdb_stat -ea <path to blockchain dir> will indicate inconsistencies
in the blocks, block_heights and block_info table.
The output of
mdb_dump -s blocks <path to blockchain dir> and
mdb_dump -s block_info <path to blockchain dir> is useful for indicating whether
blocks and block_info contain the same keys.
These records are dumped as hex data, where the first line is the key and the second line is the data.