Skip to content

Latest commit

 

History

History
320 lines (242 loc) · 10.2 KB

build-osx.md

File metadata and controls

320 lines (242 loc) · 10.2 KB

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

Prerequisites

In order to build BTCU on Mac it is required to have a MacOS computer, with at least 3GB of free disk space (some of the dependencies will require more space, but you may have these installed already) without the database.

Preparation

The next step is required only if you don't have an already instaled XCode. Otherwise you may skip it. Install the macOS command line tools:

    xcode-select --install

When the popup appears, click Install. You can check the detailed installation guide for a proper explanation.

Then you will need to install the Homebrew. If you already have it on a computer you may skip it.

To check it you can run the followed command:

    brew --version

If it throws an error, you don't have homebrew. In that case, install homebrew using the following command.

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

It is important: Even if you had homebrew installed beforehand, update your version of homebrew and upgrade all the packages it installed by running the following command.

    brew update && brew upgrade

Troubleshooting

If you see throught brew installation process errors like LibreSSL SSL_connect: SSL_ERROR_SYSCALL in connection, try:

    networksetup -setv6off Wi-Fi

If you goes into error Error: Operation already in progress , try:

    rm -rf /usr/local/var/homebrew/locks

For other issues please check Homebrew's Troubleshooting page.

In a case when you get dmg image or sources via browser, telegramm and etc you'll face with an error Operation not permitted for the application extracted from the the dmg or in a terminal thought the building process accordingly.

Note: The described behaviour for the sources case will be overlapped with another problem while you try to complete a command cmake . from the build section. The terminal will show a successfull generation but commands for the autogen.sh and configure won't show any actual result and appopriate result files won't be generated. You can run separately a command ./autogen.sh to see the actual problem which is the same Operation not permitted as for the dmg image case.

To solve the problem in a sources folder please run:

    xattr -d com.apple.quarantine autogen.sh

To solve the problem for the image case:

    xattr -d com.apple.quarantine btcu-qt.dmg

in the download folder where you've placed the file. If the file has another name please change the command accordingly to the file name (i.e. if your file name for example if btcu-qt_somesimbols.dmg, you'll run xattr -d com.apple.quarantine btcu-qt_somesimbols.dmg).

Dependencies

    brew install automake libtool miniupnpc pkg-config python qt libevent qrencode protobuf rocksdb snappy zeromq openssl libjson-rpc-cpp google-benchmark googletest cmake
    # libscrypt from local since we need a version with cmake support but you still can get it via brew

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

    brew install librsvg

OpenSSL has it's uniq way to organize a folder structure so we have to try this command at first:

    brew link openssl --force

If you'll get a refuse result such as "Warning: Refusing to link macOS provided/shadowed software: openssl", you'll have to call this command instead:

    ( brew --prefix openssl && echo '/include/openssl'; ) | tr -d "[:space:]" | xargs -I '{}' ln -s {} /usr/local/include

Next run an important command to keep appopriate versions to run:

    export HOMEBREW_NO_AUTO_UPDATE=1
    export HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1

Next:

    # since brew has been removed the required version of the boost
    curl https://raw.githubusercontent.com/Homebrew/homebrew-core/8d748e26ccc9afc8ea0d0201ae234fda35de721e/Formula/boost.rb -o boost.rb
    brew install ./boost.rb

Also it may be usefull to add openssl bin folder to PATH as it recommended by result of the command "brew link openssl --force".

See dependencies.md for a complete overview.

Also it is important to have the exact version of the icu4c:

    brew uninstall --ignore-dependencies icu4c
    curl https://raw.githubusercontent.com/Homebrew/homebrew-core/a806a621ed3722fb580a58000fb274a2f2d86a6d/Formula/icu4c.rb -o icu4c.rb
    brew install ./icu4c.rb
    ln -s /usr/local/Cellar/icu4c/64.2 /usr/local/opt/icu4c

After finishing this steps of the dependencies installation you may run the command to undo brew configuration:

    export HOMEBREW_NO_AUTO_UPDATE=0
    export HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=0

SQLite

Usually, macOS installation already has a suitable SQLite installation. In order to check is there an installed SQLite you may run a command:

    sqlite3 --version

If you haven't SQLite installed it can be solved by the Homebrew package:

    brew install sqlite

In that case the Homebrew package will prevail.

Berkeley DB

It is recommended to use Berkeley DB 18.1.32.

The Homebrew package could be installed:

    brew install berkeley-db@18

The project is configured with the dependency Berkeley DB v18.1.32. In order to check the version you can run:

    brew info berkeley-db

If the brew installed a different version run the followed command:

    # since brew switch is depreceted it is required to use workaround
    brew uninstall berkeley-db@18
    # since brew prohibited to use Git commits urls in install command
    curl https://raw.githubusercontent.com/Homebrew/homebrew-core/f325e0637fbf513819129744dc107382de028fc5/Formula/berkeley-db.rb -o berkeley-db.rb
    brew install ./berkeley-db.rb

Build BTCU

  1. Clone the BTCU source code:
    git clone https://github.com/bitcoin-ultimatum-btcu/btcu-wallet
    cd btcu

It is important: Do not use spaces and other line breaking simbols in a path to the downloaded project because it'll cause a compilation problems.

  1. (Optional) Make the Homebrew OpenSSL headers visible to the configure script (do brew info openssl to find out why this is necessary, or if you use Homebrew with installation folders different from the default).

    export LDFLAGS="$LDFLAGS -L/usr/local/opt/openssl/lib"
export CPPFLAGS="$CPPFLAGS -I/usr/local/opt/openssl/include/openssl"

  2. Build BTCU

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

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

    The wallet support requires one or both of the dependencies (SQLite and Berkeley DB) from the previous section. To build BTCU without wallet, see Disable-wallet mode.

    To build the project run followed commands:

    cmake .
    make
  1. It is recommended to build and run the unit tests:
    make check
  1. You can also create a .dmg that contains the .app bundle (optional):
    make osx-dmg

Libscrypt (optional)

You can also make a separate libscrypt lib file. In order to do this you have to run followed commands:

    cd src/libscrypt
    cmake .
    make
    cd ../..

Cryptopp (optional)

For a separate building of a libcryptopp lib file:

    cd src/cryptopp
    cmake .
    make
    cd ../..

Secp256k1 (optional)

And for a libsecp256k1 lib file:

    cd src/secp256k1
    ./autogen.sh
    ./configure
    make
    cd ../..

Univalue (optional)

And for a libunivalue lib file:

    cd src/univalue
    ./autogen.sh
    ./configure
    make
    cd ../..

JSON CPP (optional)

And for a libjsoncpp lib file:

    cd src/jsoncpp/jsoncpp-build
    cmake ../jsoncpp 
    make
    cd ../../..

LibFF (optional)

And for a libff lib file go to src/libff and uncomment lines from 102 to 113. Then run commands:

    cd src/libff
    cmake .
    make
    cd ../..

Ethash (optional)

For libethash.a file:

    cd src/cpp-ethereum/ethash
    cmake .
    make
    cd ../../..

Compiling for different MacOS versions

In a case when you need a different version of the OSX platforms add the parameter to a cmake command (for example we use 10.10 version) :

    cmake . -DCMAKE_OSX_DEPLOYMENT_TARGET=10.10

It may be required to have an installed appopriate SDK version. You can find an instruction how to make it here.

Disable-wallet mode

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

    cmake . -DENABLE_WALLET=OFF

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

BTCU is now available at ./btcud

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

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

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

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

Other commands:

    btcud -daemon      # Starts the btcu daemon.
    btcu-cli --help    # Outputs a list of command-line options.
    btcu-cli help      # Outputs a list of RPC commands when the daemon is running.
    ./src/qt/btcu-qt   # Start GUI

Notes

  • Tested on OS X (11.1 Big Sur and 10.15 Catalina) on 64-bit Intel processors only.