mirror of https://github.com/bitcoin/bitcoin
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 lines
3.6 KiB
136 lines
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:
|
|
|
|
```shell
|
|
xcode-select --install
|
|
```
|
|
|
|
When the popup appears, click `Install`.
|
|
|
|
Then install [Homebrew](https://brew.sh).
|
|
|
|
## Dependencies
|
|
```shell
|
|
brew install automake libtool boost miniupnpc pkg-config python qt libevent qrencode
|
|
```
|
|
|
|
If you run into issues, check [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).
|
|
See [dependencies.md](dependencies.md) for a complete overview.
|
|
|
|
If you want to build the disk image with `make deploy` (.dmg / optional), you need RSVG:
|
|
```shell
|
|
brew install librsvg
|
|
```
|
|
|
|
The wallet support requires one or both of the dependencies ([*SQLite*](#sqlite) and [*Berkeley DB*](#berkeley-db)) in the sections below.
|
|
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode).
|
|
|
|
#### SQLite
|
|
|
|
Usually, macOS installation already has a suitable SQLite installation.
|
|
Also, the Homebrew package could be installed:
|
|
|
|
```shell
|
|
brew install sqlite
|
|
```
|
|
|
|
In that case the Homebrew package will prevail.
|
|
|
|
#### Berkeley DB
|
|
|
|
It is recommended to use Berkeley DB 4.8. If you have to build it yourself,
|
|
you can use [this](/contrib/install_db4.sh) script to install it
|
|
like so:
|
|
|
|
```shell
|
|
./contrib/install_db4.sh .
|
|
```
|
|
|
|
from the root of the repository.
|
|
|
|
Also, the Homebrew package could be installed:
|
|
|
|
```shell
|
|
brew install berkeley-db4
|
|
```
|
|
|
|
## Build Bitcoin Core
|
|
|
|
1. Clone the Bitcoin Core source code:
|
|
```shell
|
|
git clone https://github.com/bitcoin/bitcoin
|
|
cd bitcoin
|
|
```
|
|
|
|
2. Build Bitcoin Core:
|
|
|
|
Configure and build the headless Bitcoin Core binaries as well as the GUI (if Qt is found).
|
|
|
|
You can disable the GUI build by passing `--without-gui` to configure.
|
|
```shell
|
|
./autogen.sh
|
|
./configure
|
|
make
|
|
```
|
|
|
|
3. It is recommended to build and run the unit tests:
|
|
```shell
|
|
make check
|
|
```
|
|
|
|
4. You can also create a `.dmg` that contains the `.app` bundle (optional):
|
|
```shell
|
|
make deploy
|
|
```
|
|
|
|
## Disable-wallet mode
|
|
When the intention is to run only a P2P node without a wallet, Bitcoin Core may be
|
|
compiled in disable-wallet mode with:
|
|
```shell
|
|
./configure --disable-wallet
|
|
```
|
|
|
|
In this case there is no dependency on [*Berkeley DB*](#berkeley-db) and [*SQLite*](#sqlite).
|
|
|
|
Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
|
|
|
|
## Running
|
|
Bitcoin Core is now available at `./src/bitcoind`
|
|
|
|
Before running, you may create an empty configuration file:
|
|
```shell
|
|
mkdir -p "/Users/${USER}/Library/Application Support/Bitcoin"
|
|
|
|
touch "/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:
|
|
```shell
|
|
tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
|
|
```
|
|
|
|
## Other commands:
|
|
```shell
|
|
./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
|
|
* Tested on OS X 10.14 Mojave through macOS 11 Big Sur on 64-bit Intel
|
|
processors only.
|
|
* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/issues/7714).
|