To build dependencies for the current architecture + OS:
To build for another architecture/OS, you may need to install some required packages first. Please have a look at the section "Install the required dependencies" below to check for your target platform.
Once you have the required packages installed and done any necessary preparation, run
<platform> is one of the following:
For example, building the dependencies for Linux on ARM:
To use the dependencies for building Bitcoin Cash Node, you need to set
the platform file to be used by
The platform files are located under
For example, cross-building for Linux on ARM (run from the project root):
mkdir build_arm cd build_arm cmake -GNinja .. -DENABLE_MAN=OFF -DCMAKE_TOOLCHAIN_FILE=../cmake/platforms/LinuxARM.cmake ninja
Note that it will use all the CPU cores available on the machine by default.
This behavior can be changed by setting the
JOBS environment variable (see
For Mac OSX building, some preparatory steps are needed, including unpacking
the suitable SDK (how to obtain this SDK can be found in the
document). Once the SDK has been obtained, the dependency building can be
done like this:
make download mkdir SDKs tar -C SDKs -xf /path/to/MacOSX10.14.sdk.tar.xz make build-osx HOST=x86_64-apple-darwin16
Building the node against these dependencies is again a matter of (starting from the project root):
mkdir build_osx cd build_osx cmake -GNinja .. -DENABLE_MAN=OFF -DCMAKE_TOOLCHAIN_FILE=../cmake/platforms/OSX.cmake ninja
No other options are needed, the paths are automatically configured.
Install the required dependencies: Ubuntu & Debian
Common to all arch/OS
sudo apt-get install build-essential autoconf automake cmake curl git libtool ninja-build patch pkg-config python3
For macOS cross compilation
Install the following packages:
sudo apt-get install imagemagick libbz2-dev libcap-dev librsvg2-bin libtiff-tools python3-setuptools
Obtain the same SDK packge that is used in the gitian build (refer to
gitian-building.md for download instructions).
SDKs folder within the
depends folder, if it does not already exist.
Unpack the SDK tarball there.
For Win64 cross compilation
- see build-windows.md
For Linux cross compilation
Common linux dependencies:
sudo apt-get install gperf
For linux 32 bits cross compilation:
First add the i386 architecture to
sudo dpkg --add-architecture i386 sudo apt-get update
Then install the dependencies:
sudo apt-get install lib32stdc++-8-dev libc6-dev:i386
For linux ARM cross compilation:
sudo apt-get install g++-arm-linux-gnueabihf
For linux AARCH64 cross compilation:
sudo apt-get install g++-aarch64-linux-gnu
The following can be set when running make: make FOO=bar
SOURCES_PATH: downloaded sources will be placed here BASE_CACHE: built packages will be placed here SDK_PATH: Path where sdk's can be found (used by macOS) FALLBACK_DOWNLOAD_PATH: If a source file can't be fetched, try here before giving up NO_QT: Don't download/build/cache qt and its dependencies NO_ZMQ: Don't download/build/cache packages needed for enabling zeromq NO_WALLET: Don't download/build/cache libs needed to enable the wallet NO_UPNP: Don't download/build/cache packages needed for enabling upnp NO_JEMALLOC: Don't download/build/cache jemalloc DEBUG: disable some optimizations and enable more runtime checking RAPIDCHECK: build rapidcheck (experimental, requires cmake) NO_PROTOBUF: Don't download/build/cache protobuf (used for BIP70 support) HOST_ID_SALT: Optional salt to use when generating host package ids BUILD_ID_SALT: Optional salt to use when generating build package ids JOBS: Number of jobs to use for each package build
If some packages are not built, for example by building the depends with
make NO_WALLET=1, the appropriate options should be set when building Bitcoin
Cash Node using these dependencies.
In this example,
-DBUILD_BITCOIN_WALLET=OFF should be passed to the
command line to ensure that the build will not fail due to missing dependencies.
NOTE: The SDK_PATH should be set to the parent folder in which the
MacOSX10.14.sdk/ is located. Alternatively, you can unpack the SDK within
depends/SDKs/ folder or create a symbolic link named
to it from there.
download: run 'make download' to fetch all sources without building them download-osx: run 'make download-osx' to fetch all sources needed for macOS builds download-win: run 'make download-win' to fetch all sources needed for win builds download-linux: run 'make download-linux' to fetch all sources needed for linux builds build-all: build the dependencies for all the arch/OS