Find here instructions for building the Wallet Core library locally.
The following target platforms are supported:
iOS (Swift language is used)
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.
Wallet Core can be build inside the provided Docker image, or natively.
Inside Docker image: This way is easier to get the prerequisites, as they are all inside the provided Docker image. However, all building has to be done inside the Docker image.
Natively, in your dev OS (macOS, Linux).
Here is the list of required prerequisites.
brew install cmake
brew install boost
Xcode command line tools:
brew install git ninja autoconf automake libtool xcodegen clang-format
Cocoapods for iOS:
sudo gem install cocoapods
sudo apt-get install autoconf git libcurl4-openssl-dev libicu-dev libssl-dev libtool ninja-build nodejs pkg-config unzip
Ruby 2.6 (
rbenv from https://github.com/rbenv/ruby-build, then
rbenv install 2.6.3)
CMake (from https://github.com/Kitware/CMake/releases)
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).
The full build can be triggered with one top-level script:
Or, broken up in smaller steps:
This script downloads and compiles some prerequisites.
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=Debugmake -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.
Here are the instructions to build Wallet Core within the provided Docker image.
Prerequisite is a working Docker installation.
The command for starting a new Docker container with the wallet-core image, and a shell within it:
docker run -i -t trustwallet/wallet-core /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-filescmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Debugmake -Cbuild
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-corecd wallet-core./build/tests/tests tests./build/walletconsole/walletconsoleexit
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.