Skip to content

Latest commit

 

History

History
334 lines (250 loc) · 11.3 KB

building.md

File metadata and controls

334 lines (250 loc) · 11.3 KB
Raw

Building taraxa-node

Compile-Time Options (cmake)

CMAKE_BUILD_TYPE=[Release/Debug/RelWithDebInfo]

Specifies whether to build with or without optimization and without or with the symbol table for debugging. Unless you are specifically debugging or running tests, it is recommended to build as release.

Building on Ubuntu 22.04

For Ubuntu 22.04 users, after installing the right packages with apt taraxa-node will build out of the box without further effort:

Install taraxa-node dependencies:

# Required packages
sudo apt-get install -y \
    libtool \
    autoconf \
    ccache \
    cmake \
    clang-format-14 \
    clang-tidy-14 \
    golang-go \
    python3-pip \
    # this libs are required for arm build by go part. you can skip it for amd64 build
    libzstd-dev \
    libsnappy-dev \
    rapidjson-dev \
    libgmp-dev \
    libmpfr-dev

# Optional. Needed to run py_test. This won't install on arm64 OS because package is missing in apt
sudo add-apt-repository ppa:ethereum/ethereum
sudo apt-get update
sudo apt install solc

# Install conan package manager
sudo python3 -m pip install conan

# Setup clang as default compiler either in your IDE or by env. variables"
export C="clang-14"
export CXX="clang++-14"

Clone the Repository

git clone https://github.com/Taraxa-project/taraxa-node.git --branch testnet
cd taraxa-node
git submodule update --init --recursive

Compile

# Optional - one time action
# Create clang profile
# It is recommended to use clang because on other compilers you could face some errors
conan profile new clang --detect && \
conan profile update settings.compiler=clang clang && \
conan profile update settings.compiler.version=14 clang && \
conan profile update settings.compiler.libcxx=libstdc++11 clang && \
conan profile update env.CC=clang-14 clang && \
conan profile update env.CXX=clang++-14 clang

# Export needed var for conan
export CONAN_REVISIONS_ENABLED=1

# Fetch and compile libraries fetched from conan
conan remote add -f bincrafters "https://bincrafters.jfrog.io/artifactory/api/conan/public-conan"

# Compile project using cmake
mkdir cmake-build
cd cmake-build
cmake -DCONAN_PROFILE=clang -DCMAKE_BUILD_TYPE=RelWithDebInfo ../
make -j$(nproc)

Building on Ubuntu 20.04

For Ubuntu 20.04 users, after installing the right packages with apt taraxa-node will build out of the box without further effort:

Install taraxa-node dependencies:

# Required packages
sudo apt-get install -y \
    libtool \
    autoconf \
    ccache cmake gcc g++ clang-format clang-tidy cppcheck \
    libgflags-dev\
    libjsoncpp-dev \
    libjsonrpccpp-dev \
    python3-pip \
    rapidjson-dev \
    libgmp-dev \
    libmpfr-dev


# Install conan package manager
# >= 1.36.0 version is required to work properly with clang-14
sudo python3 -m pip install conan

# Install cmake
# >= 3.20 version is required for JSON subcommand
# Setup your IDE accordingly to use this version
sudo python3 -m pip install cmake

# Go (required)
curl -LO https://go.dev/dl/go1.18.3.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.18.3.linux-amd64.tar.gz
rm -rf go1.18.3.linux-amd64.tar.gz

# Add go to PATH
# Add these env. variables to the ~/.profile to persist go settings even after restart
export GOROOT=/usr/local/go
export GOPATH=$HOME/.go
export PATH=$GOPATH/bin:$GOROOT/bin:$PATH

# Optional
# We are using clang from llvm toolchain as default compiler as well as clang-format and clang-tidy
# It is possible to build taraxa-node also with other C++ compilers but to contribute to the official repo,
# changes must pass clang-format/clang-tidy checks for which we internally use llvm version=13
# To install llvm:
sudo su

curl -SL -o llvm.sh https://apt.llvm.org/llvm.sh && \
chmod +x llvm.sh && \
./llvm.sh 14 && \
apt-get install -y clang-format-14 clang-tidy-14 && \
rm -f llvm.sh

# Setup clang as default compiler either in your IDE or by env. variables"
export C="clang-14"
export CXX="clang++-14"

Clone the Repository

git clone https://github.com/Taraxa-project/taraxa-node.git --branch testnet
cd taraxa-node
git submodule update --init --recursive

Compile

# Optional - one time action
# Create clang profile
# It is recommended to use clang because on other compilers you could face some errors
conan profile new clang --detect && \
conan profile update settings.compiler=clang clang && \
conan profile update settings.compiler.version=14 clang && \
conan profile update settings.compiler.libcxx=libstdc++11 clang && \
conan profile update env.CC=clang-14 clang && \
conan profile update env.CXX=clang++-14 clang

# Export needed var for conan
export CONAN_REVISIONS_ENABLED=1

# Fetch and compile libraries fetched from conan
conan remote add -f bincrafters "https://bincrafters.jfrog.io/artifactory/api/conan/public-conan"

# Compile project using cmake
mkdir cmake-build
cd cmake-build
cmake -DCONAN_PROFILE=clang -DCMAKE_BUILD_TYPE=RelWithDebInfo ../
make -j$(nproc)

And optional:

# optional
make install  # defaults to /usr/local

Building on MacOS

Install taraxa-node dependencies:

First you need to get (Brew)[https://brew.sh/] package manager. After that you need tot install dependencies with it. Currently there is no llvm-14 in brew, but it works well with llvm-13

brew update
brew install coreutils go autoconf automake gflags git libtool llvm@13 make pkg-config cmake conan snappy zstd rapidjson gmp mpfr

Clone the Repository

git clone https://github.com/Taraxa-project/taraxa-node.git --branch testnet
cd taraxa-node
git submodule update --init --recursive

Compile

# Optional - one time action
# It is recommended to use clang because on other compilers you could face some errors
conan profile new clang --detect && \
conan profile update settings.compiler=clang clang && \
conan profile update settings.compiler.version=13 clang && \
conan profile update settings.compiler.libcxx=libc++ clang && \
conan profile update env.CC=clang clang && \
conan profile update env.CXX=clang++ clang

# Export needed var for conan
export CONAN_REVISIONS_ENABLED=1
# Add bincrafters remote
conan remote add -f bincrafters "https://bincrafters.jfrog.io/artifactory/api/conan/public-conan"

# Build project
mkdir cmake-build
cd cmake-build
cmake -DCONAN_PROFILE=clang -DCMAKE_BUILD_TYPE=RelWithDebInfo ../
make -j$(nproc)

And optional:

# optional
make install  # defaults to /usr/local

Known issues

Issues with conan cache

Sometimes conan cache goes wrong, so you should clean it up. You could face error like:

ERROR: boost/1.76.0: Error in package_info() method, line 1492
    raise ConanException("These libraries were expected to be built, but were not built: {}".format(non_built))
    ConanException: These libraries were expected to be built, but were not built: {'boost_math_c99l', 'boost_json', 'boost_math_c99', 'boost_nowide', 'boost_math_tr1l', 'boost_math_tr1f', 'boost_math_tr1', 'boost_math_c99f'}

It could be cleaned up with:

rm -rf ~/.conan/data

Project building issue

If you are facing strange errors with project compilation it could be a problem that after install of llvm clang if pointing to a default apple clang. You could check that with clang --version. It should not point to /Library/Developer/CommandLineTools/usr/bin, but something like /usr/local/opt/llvm/bin. So you should specify full paths to a compiler:

  1. Check full path with brew info llvm. Search for command that looks like
    echo 'export PATH="/usr/local/opt/llvm/bin:$PATH"' >> ~/.zshrc
  1. Take bin path from it. In our case this is /usr/local/opt/llvm/bin It shouldn't differ for most cases.
  2. Append compiler to it and specify it in conan profile:
    conan profile update env.CC=/usr/local/opt/llvm/bin/clang clang && \
    conan profile update env.CXX=/usr/local/opt/llvm/bin/clang++ clang
  1. Specify compiler with full path to cmake:
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=/usr/local/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/usr/local/opt/llvm/bin/clang++ ../
  1. After successfull finish of that command processing compile project with:
make -j$(nproc)

Building on M1 Macs for x86_64 with Rosetta2

You should be able to build project following default MacOS building process. But here is a guide how to build project for x86_64 arch with Rosetta2.

Install Rosetta2

softwareupdate --install-rosetta

Run an x86_64 session

arch -x86_64 zsh

Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install dependencies

/usr/local/bin/brew install coreutils go autoconf automake gflags git libtool llvm@13 make pkg-config cmake conan snappy zstd rapidjson gmp mpfr

Clone the Repository

git clone https://github.com/Taraxa-project/taraxa-node.git --branch testnet
cd taraxa-node
git submodule update --init --recursive

Compile

# Optional - one time action
# It is recommended to use clang because on other compilers you could face some errors
# Make sure that you executing this from x86_64 CLI. Could be verified with `arch` command
# It output should be equal to `i386`
conan profile new clang --detect && \
conan profile update settings.compiler=clang clang && \
conan profile update settings.compiler.version=13 clang && \
conan profile update settings.compiler.libcxx=libc++ clang && \
conan profile update env.CC=/usr/local/opt/llvm/bin/clang clang && \
conan profile update env.CXX=/usr/local/opt/llvm/bin/clang++ clang
# Export needed var for conan
export CONAN_REVISIONS_ENABLED=1
# Add bincrafters remote
conan remote add -f bincrafters "https://bincrafters.jfrog.io/artifactory/api/conan/public-conan"

# Build project
mkdir cmake-build
cd cmake-build
# Make sure that you are specifying the full path to C and CXX compilers
cmake -DCONAN_PROFILE=clang -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_C_COMPILER=/usr/local/opt/llvm/bin/clang -DCMAKE_CXX_COMPILER=/usr/local/opt/llvm/bin/clang++ ../
make -j$(nproc)

Run

Running tests

OSX: maybe you need to set a new limit for max open files per thread/process: ulimit -n 200000

cd cmake-build-release
make all_tests

or

cd cd cmake-build-release/tests
ctest

Running taraxa-node

cd cmake-build-release/src/taraxad

Run taraxa node with default testnet config which on initial run will generate default config and wallet file in ~/.taraxa/config.json and ~/.taraxa/wallet.json

# run taraxa-node
./taraxad

Run taraxa node with specified config and wallet files

# run taraxa-node
./taraxad --config /path/to/config/file --wallet /path/to/wallet/file

Run help message to display all command line options to run and configure node in devnet, testnet or custom network

# help
./taraxad --help

Building using "taraxa-builder" docker image

TODO: tutorial How to use docker image for remote building will be added soon