dash/doc/build-osx.md
fanquake 8a44cb5eb4
Merge #20890: doc: Add explicit macdeployqtplus dependencies install step
3e61b8c800180d350621cedda7ec46a48047ff04 doc: Add explicit macdeployqtplus dependencies install step (Hennadii Stepanov)

Pull request description:

  This PR adds to macOS docs an explicit step to install `macdeployqtplus` script dependencies that are not part of the [Python Standard Library](https://docs.python.org/3/library/index.html):
  - https://pypi.org/project/ds-store/
  - https://pypi.org/project/mac-alias/

  This change is required on macOS 11 Big Sur:

  -  #20371
  - #20878

  Close #20878.

ACKs for top commit:
  fanquake:
    ACK 3e61b8c800180d350621cedda7ec46a48047ff04

Tree-SHA512: d177139ee142d47cb27ad878d721cafcd03403ef861965ff532d712da461416380ec5878f70accf223a552a1f1e65eedb1e0ad72cb7a96791f8a55536ce28645
2024-01-16 07:57:34 -06:00

3.6 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 libtool boost gmp miniupnpc pkg-config python qt libevent libnatpmp qrencode

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

The wallet support requires one or both of the dependencies (SQLite and Berkeley DB) in the sections below. To build Dash Core without wallet, see Disable-wallet mode.

SQLite

Usually, macOS installation already has a suitable SQLite installation. Also, the Homebrew package could be installed:

brew install sqlite

In that case the Homebrew package will prevail.

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

pip3 install ds_store mac_alias

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

Also, the Homebrew package could be installed:

brew install berkeley-db4

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