Skip to content

BUILD-manual.md

Latest commit

 

History

History
70 lines (51 loc) · 1.74 KB

BUILD-manual.md

File metadata and controls

70 lines (51 loc) · 1.74 KB

Building manually

This guide should mostly work for Linux and OS X operating systems. It does not include instructions for Windows. For Windows, Build with CONAN is strongly encouraged.

Prerequisites

  • git.
  • python 3.7+.
  • openssl 1.1.1g+.
  • About 15 GB of free disk space.

These instructions have been verified to work on Ubuntu 20.04 with 8 GB of RAM and 4 CPU cores. On an Ubuntu system, all prerequisites can be installed with the following commands:

apt update
apt -y upgrade
apt -y install git gcc g++ cmake curl libssl-dev ninja-build pkg-config python3-pip

Step 1: Clone catapult-client

As usual, clone the git repository:

git clone https://github.com/symbol/catapult-client.git
cd catapult-client

Step 2: Download, build and install all dependencies from source

Type this into a terminal:

NOTE: If you want to build with clang, add the --use-clang flag.

PYTHONPATH="./scripts/build" python3 "./scripts/build/installDepsLocal.py" \
	--target "./_deps" \
	--versions "./scripts/build/versions.properties" \
	--download \
	--build

Step 3: Build catapult

To create or update the _build directory type into a terminal:

NOTE: When building with clang, add -DENABLE_FUZZ_BUILD=ON to build with UBSAN and ASAN (recommended for development).

mkdir -p _build && cd _build
BOOST_ROOT="$(realpath ../_deps/boost)" cmake .. \
	-DCMAKE_BUILD_TYPE=RelWithDebInfo \
	-DCMAKE_PREFIX_PATH="$(realpath ../_deps/facebook);$(realpath ../_deps/google);$(realpath ../_deps/mongodb);$(realpath ../_deps/zeromq)" \
	-GNinja
ninja publish
ninja

Step 4: Verification

Verify that the tools are working correctly by running:

./bin/catapult.tools.address --help