Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 3.51 KB

build-macos.md

File metadata and controls

105 lines (67 loc) · 3.51 KB
Raw

macOS Build Instructions and Notes

The commands in this guide should be executed in a Terminal application. The built-in one is located in /Applications/Utilities/Terminal.app.

Preparation

Install the macOS command line tools:

xcode-select --install

When the popup appears, click Install.

Then install Homebrew.

Dependencies

brew install automake berkeley-db4 libtool boost miniupnpc openssl pkg-config protobuf python qt libevent qrencode

In case you want to build the disk image with make deploy (.dmg / optional), you need RSVG

  brew install librsvg

Berkley DB

It is recommended to use Berkeley DB 4.8. If you have to build it yourself, you can use the installation script included in contrib/ like so: ./contrib/install_db4.sh .

from the root of the repository.

Note: You only need Berkeley DB if the wallet is enabled (see Disable-wallet mode).

Build Firo Core

  1. Build Firo-core:

    Configure and build the headless Firo binaries as well as the GUI (if Qt is found).

    In case you want to build the disk image with make deploy (.dmg / optional), by passing --with-gui to configure.

    You can disable the GUI build by passing --without-gui to configure.

    ./autogen.sh
./configure
make

  2. It is recommended to build and run the unit tests:

    make check

  3. You can also create a .dmg that contains the .app bundle (optional):

    make deploy

Running

Firo Core is now available at ./src/firod

Before running, it's recommended you create an RPC configuration file.

echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/firo/firo.conf"

chmod 600 "/Users/${USER}/Library/Application Support/firo/firo.conf"

The first time you run firod, it will start downloading the blockchain. This process could take several hours.

You can monitor the download process by looking at the debug.log file:

tail -f $HOME/Library/Application\ Support/firo/debug.log

Other commands:

./src/firod -daemon # Starts the Firo daemon.
./src/firo-cli --help # Outputs a list of command-line options.
./src/firo-cli help # Outputs a list of RPC commands when the daemon is running.

Using Qt Creator as IDE

You can use Qt Creator as an IDE, for bitcoin development. Download and install the community edition of Qt Creator. Uncheck everything except Qt Creator during the installation process.

  1. Make sure you installed everything through Homebrew mentioned above
  2. Do a proper ./configure --enable-debug
  3. In Qt Creator do "New Project" -> Import Project -> Import Existing Project
  4. Enter "bitcoin-qt" as project name, enter src/qt as location
  5. Leave the file selection as it is
  6. Confirm the "summary page"
  7. In the "Projects" tab select "Manage Kits..."
  8. Select the default "Desktop" kit and select "Clang (x86 64bit in /usr/bin)" as compiler
  9. Select LLDB as debugger (you might need to set the path to your installation)
  10. Start debugging with Qt Creator

Notes

  • Tested on macOS 10.11 through 10.14 on 64-bit Intel processors only.

  • Building with downloaded Qt binaries is not officially supported. See the notes in #7714