Skip to content

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

  1. Install Xcode from the app store if you don't have it already (it's a dependency for qt5)

  2. Install the macOS command line tools:

xcode-select --install

When the popup appears, click Install.

  1. Install Homebrew.

Dependencies

Install dependencies:

brew install berkeley-db boost cmake libevent miniupnpc ninja openssl protobuf python qrencode qt zeromq

See dependencies.md for a complete overview.

If you want to build the disk image with ninja osx-dmg (.dmg / optional), you need RSVG:

brew install librsvg

If you want to run ZMQ tests with the test framework, you need the zmq python module:

pip3 install pyzmq

Build Bitcoin Cash Node

Before you start building, please make sure that your compiler supports C++14.

  1. Clone the Bitcoin Cash Node source code and cd into bitcoin-cash-node

    git clone https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node.git
    cd bitcoin-cash-node
    
  2. Build Bitcoin Cash Node:

    Configure and build the headless Bitcoin Cash Node binaries as well as the GUI.

    You can disable the GUI build by passing -DBUILD_BITCOIN_QT=OFF to cmake.

    It is recommended to create a build directory to build out-of-tree.

    mkdir build
    cd build
    cmake -GNinja ..
    ninja
    
  3. It is recommended to build and run the unit tests:

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

    ninja osx-dmg
    

Disable-wallet mode

When the intention is to run only a P2P node without a wallet, Bitcoin Cash Node may be compiled in disable-wallet mode with:

cmake -GNinja .. -DBUILD_BITCOIN_WALLET=OFF

Mining is also possible in disable-wallet mode using the getblocktemplate RPC call.

Running

Bitcoin Cash Node is now available at ./src/bitcoind

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

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

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

The first time you run bitcoind, it will start downloading the blockchain. This process could take many hours, or even days on slower than average systems.

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

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

Other commands:

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

Notes

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