dash/doc/build-osx.md
fanquake 44a47b963f Merge #18070: doc: add note about brew doctor
63ce882760e1ceb4114c716851aedaf911ebb93b doc: link to homebrew's troubleshooting page (Gastón I. Silva)

Pull request description:

  A trivial documentation update.

  When I was following the build steps for mac, I had some errors installing the dependencies. After searching on the Internet, and correcting the errors, I found that `brew doctor` had all the answers I needed. Could have skipped the Internet searches all together.

ACKs for top commit:
  fanquake:
    ACK 63ce882760e1ceb4114c716851aedaf911ebb93b - a link to the troubleshooting page seems fine. I wouldn't really want our README to have anything more specific than that.

Tree-SHA512: 12c96cd9c9bd39ada21f3f27cbec3ed4bef4b8e74dec7872c892fc6a92a70418a5cc0882ff449883e91d96c01e1ca7104b076590917f397334c82931ec7fda1c
2022-10-20 11:47:02 -04:00

2.1 KiB

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.

Base build dependencies

brew install automake libtool pkg-config libnatpmp

If you run into issues, check Homebrew's troubleshooting page.

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

brew install librsvg

Building

It's possible that your PATH environment variable contains some problematic strings, run

export PATH=$(echo "$PATH" | sed -e '/\\/!s/ /\\ /g') # fix whitespaces

Next, follow the instructions in build-generic

disable-wallet mode

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

./configure --disable-wallet

In this case there is no dependency on Berkeley DB 4.8.

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

Running

Dash Core is now available at ./src/dashd

Before running, you may create an empty configuration file:

mkdir -p "/Users/${USER}/Library/Application Support/DashCore"

touch "/Users/${USER}/Library/Application Support/DashCore/dash.conf"

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

The first time you run dashd, 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/DashCore/debug.log

Other commands:

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