Skip to content

Latest commit

 

History

History
244 lines (166 loc) · 7.11 KB

build-unix.md

File metadata and controls

244 lines (166 loc) · 7.11 KB

UNIX BUILD NOTES

Some notes on how to build Dash Core in Unix.

(For BSD specific instructions, see build-*bsd.md in this directory.)

To Build

cmake -B build
cmake --build build    # use "-j N" for N parallel jobs
cmake --install build  # optional

See below for instructions on how to install the dependencies on popular Linux distributions, or the dependencies section for a complete overview.

Memory Requirements

C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of memory available when compiling Dash Core. On systems with less, gcc can be tuned to conserve memory with additional CMAKE_CXX_FLAGS:

cmake -B build -DCMAKE_CXX_FLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"

Linux Distribution Specific Instructions

Ubuntu & Debian

Dependency Build Instructions

Build requirements:

sudo apt-get install build-essential cmake pkg-config python3

Now, you can either build from self-compiled depends or install the required dependencies:

sudo apt-get install libbacktrace-dev libevent-dev libboost-dev

Note: libbacktrace-dev is available in Debian 13 (Trixie) and Ubuntu 25.04+. For older releases, use the /depends/README.md which includes all required libraries.

SQLite is required for the descriptor wallet:

sudo apt-get install libsqlite3-dev

Berkeley DB is only required for the legacy wallet. Ubuntu and Debian have their own libdb-dev and libdb++-dev packages, but these will install Berkeley DB 5.3 or later. This will break binary wallet compatibility with the distributed executables, which are based on BerkeleyDB 4.8. If you do not care about wallet compatibility, pass -DWITH_BDB=ON -DWARN_INCOMPATIBLE_BDB=OFF to CMake. Otherwise, you can build Berkeley DB yourself.

To build Dash Core without wallet, see Disable-wallet mode

zstd compresses block and undo files on disk (see: -DWITH_ZSTD=ON, package libzstd-dev on Debian and Ubuntu, libzstd-devel on Fedora); a build without it cannot read block files that contain compressed records.

ZMQ dependencies (enable notifications with -DWITH_ZMQ=ON):

sudo apt-get install libzmq3-dev

User-Space, Statically Defined Tracing (USDT) dependencies (enable with -DWITH_USDT=ON):

sudo apt install systemtap-sdt-dev

GUI dependencies:

To build dash-qt, install the required Qt 5 development packages and pass -DBUILD_GUI=ON to CMake. The GUI is disabled by default.

To build with Qt 5 you need the following:

sudo apt-get install qtbase5-dev qttools5-dev qttools5-dev-tools

Additionally, to support Wayland protocol for modern desktop environments:

sudo apt-get install qtwayland5

For QR encoding support, install libqrencode:

sudo apt-get install libqrencode-dev

QR encoding is enabled when building the GUI. If libqrencode is not installed, pass -DWITH_QRENCODE=OFF to disable QR encoding.

Fedora

Dependency Build Instructions

Build requirements:

sudo dnf install gcc-c++ cmake make pkgconf-pkg-config python3

Now, you can either build from self-compiled depends or install the required dependencies:

sudo dnf install libevent-devel boost-devel

Note: Fedora repositories do not include libbacktrace. To build Dash Core without stack trace support, configure with -DENABLE_STACKTRACES=OFF.

SQLite is required for the descriptor wallet:

sudo dnf install sqlite-devel

Berkeley DB is only required for the legacy wallet. Fedora releases have only libdb-devel and libdb-cxx-devel packages, but these will install Berkeley DB 5.3 or later. This will break binary wallet compatibility with the distributed executables, which are based on Berkeley DB 4.8. If you do not care about wallet compatibility, pass -DWITH_BDB=ON -DWARN_INCOMPATIBLE_BDB=OFF to CMake. Otherwise, you can build Berkeley DB yourself.

To build Dash Core without wallet, see Disable-wallet mode

zstd compresses block and undo files on disk (see: -DWITH_ZSTD=ON, package libzstd-dev on Debian and Ubuntu, libzstd-devel on Fedora); a build without it cannot read block files that contain compressed records.

ZMQ dependencies (enable notifications with -DWITH_ZMQ=ON):

sudo dnf install zeromq-devel

User-Space, Statically Defined Tracing (USDT) dependencies (enable with -DWITH_USDT=ON):

sudo dnf install systemtap-sdt-devel

GUI dependencies:

To build dash-qt, install the required Qt 5 development packages and pass -DBUILD_GUI=ON to CMake. The GUI is disabled by default.

To build with Qt 5 you need the following:

sudo dnf install qt5-qttools-devel qt5-qtbase-devel

Additionally, to support Wayland protocol for modern desktop environments:

sudo dnf install qt5-qtwayland

For QR encoding support, install libqrencode:

sudo dnf install qrencode-devel

QR encoding is enabled when building the GUI. If libqrencode is not installed, pass -DWITH_QRENCODE=OFF to disable QR encoding.

Dependencies

See dependencies.md for a complete overview, and depends on how to compile them yourself, if you wish to not use the packages of your Linux distribution.

Berkeley DB

The legacy wallet uses Berkeley DB. To ensure backwards compatibility it is recommended to use Berkeley DB 4.8. If you have to build it yourself, and don't want to use any other libraries built in depends, you can do:

make -C depends NO_BOOST=1 NO_LIBEVENT=1 NO_QT=1 NO_SQLITE=1 NO_ZMQ=1 NO_USDT=1
...
to: /path/to/dash/depends/x86_64-pc-linux-gnu

and configure using the following:

export BDB_PREFIX="/path/to/dash/depends/x86_64-pc-linux-gnu"

cmake -B build -DWITH_BDB=ON \
    -DBerkeleyDB_INCLUDE_DIR:PATH="${BDB_PREFIX}/include"

Note: Make sure that BDB_PREFIX is an absolute path.

Note: You only need Berkeley DB if the legacy wallet is enabled (see Disable-wallet mode).

Disable-wallet mode

When the intention is to only run a P2P node, without a wallet, Dash Core can be compiled in disable-wallet mode with:

cmake -B build -DENABLE_WALLET=OFF

In this case there is no dependency on SQLite or Berkeley DB.

Mining is also possible in disable-wallet mode using the getblocktemplate RPC call.

Additional Configuration Options

A list of configuration options can be displayed with:

cmake -B build -LH

Setup and Build Example: Arch Linux

This example lists the steps necessary to setup and build a command line only distribution of the latest changes on Arch Linux:

pacman --sync --needed base-devel boost cmake gcc git libbacktrace libevent make python sqlite zstd
git clone https://github.com/dashpay/dash.git
cd dash/
cmake -B build
cmake --build build
ctest --test-dir build
./build/src/dashd

If you intend to work with legacy Berkeley DB wallets, see Berkeley DB section.