Skip to content

building.md

Latest commit

 

History

History
159 lines (108 loc) · 4.8 KB

building.md

File metadata and controls

159 lines (108 loc) · 4.8 KB

Building and Testing

Find here instructions for building the Wallet Core library locally.

Platforms

The following target platforms are supported:

  • iOS (Swift language is used)
  • Android

The following development platforms are supported:

  • macOS: is the primary development platform, as it supports compiling for both target platforms.
  • Linux: is partially supported as a development platform.

Build Methods

Wallet Core can be build inside a Docker image, or natively.

  • Inside Docker image: This way is easier to get the prerequisites, as they are all inside a Docker image. However, all building has to be done inside the Docker image.
  • Natively, in your dev OS (macOS, Linux).

Prerequisites

Here is the list of required prerequisites.

Prerequisites on macOS

  • CMake brew install cmake
  • Boost brew install boost
  • Xcode
  • Xcode command line tools: xcode-select --install
  • Other tools: brew install git ninja autoconf automake libtool xcodegen clang-format
  • Cocoapods for iOS: sudo gem install cocoapods
  • Android Studio
  • Android NDK

Prerequisites on Linux

Managed Prerequisites

Additionally, the following prerequisites are also needed, but they are managed by Wallet Core. The script tools/install-dependencies downloads and compiles them (see below).

  • Google test
  • Check
  • Json
  • Protobuf

Full Build

The full build can be triggered with one top-level script:

./bootstrap.sh

Or, broken up in smaller steps:

./tools/install-dependencies

This script downloads and compiles some prerequisites.

./tools/generate-files

This script generates source files, coin- and protobuf files. Needs to be re-run whenever coins.json or protobuf files are changes.

cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug
make -Cbuild

Standard CMake and make commands for building the library. The cmake command needs to be re-run whenever a new source file is added.

After build, unit tests can be executed:

./build/tests/tests tests --gtest_filter=*

If you'd rather use and IDE for building and debugging you can specify the -G option to cmake. For instance to use Xcode call cmake -Bxcode -GXcode -DCMAKE_BUILD_TYPE=Debug and use the generated project in the xcode folder.

Building inside Docker image

Here are the instructions to build Wallet Core with the provided Dockerfile.

Prerequisite is a working Docker installation.

The command for building the Docker image:

docker build docker/wallet-core --tag wallet-core-dev

Then launch the container:

docker run -i -t wallet-core-dev /bin/bash

Inside the container the build commands can be executed (as described above; note that install-dependencies is not necessary):

cd wallet-core
./tools/generate-files
cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug
make -Cbuild

Executing inside Docker image

The Docker image also contains a pre-built, runnable version of the library, so it is possible to run it, 'toy around' with it without any building. Note: this may not be the most recent version!

Unit tests and wallet console utility can be executed straight from this Docker image:

docker run -i -t trustwallet/wallet-core
cd wallet-core
./build/tests/tests tests
./build/walletconsole/walletconsole
exit

Linux

Building on Linux is possible, but not fully supported, it requires some extra work. If you have access to macOS we highly recommend developing on that platform. Using the Docker image is also recommended. Otherwise, the prerequisites have to be installed manually.

Unit tests with Coverage

Coverage info can be seen in the GitHub CI builds, but can be generated locally as well.

Steps for running unit tests with coverage measurement, and creating report locally:

cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debug -DCODE_COVERAGE=ON
make -Cbuild -j12 tests
find . -name "*.gcda" -exec rm {} \;
./build/tests/tests tests --gtest_filter=*
rm -rf coverage.info coverage/
tools/coverage html

See also tools/coverage and linux-ci.yml.