dash/doc/build-osx.md
Kittywhiskers Van Gogh eed3ef3bf4 revert: revert dash#2323 (Update build documentation)
This reverts commit d7e5f02eac.
2023-05-27 23:15:04 +05:30

2.9 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.

Dependencies

brew install automake berkeley-db4 libtool boost gmp miniupnpc pkg-config python qt libevent libnatpmp qrencode sqlite

If you run into issues, check Homebrew's troubleshooting page. See dependencies.md for a complete overview.

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

brew install librsvg

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

Build Dash Core

  1. Clone the Dash Core source code:

    git clone https://github.com/dashpay/dash
    cd dash
    
  2. Build Dash Core:

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

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

    ./autogen.sh
    ./configure
    make
    
  3. It is recommended to build and run the unit tests:

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

    make deploy
    

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 and SQLite.

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.

Notes

  • Tested on OS X 10.12 Sierra through macOS 10.15 Catalina on 64-bit Intel processors only.
  • Building with downloaded Qt binaries is not officially supported. See the notes in #7714.