Removes redundant notes for setting CC & CXX now that Clang is well and
truly the base compiler.
Cleans up the wallet docs, i.e #23446.
Make the notes more similar to FreeBSD.
This guide describes how to build bitcoind, bitcoin-qt, and command-line utilities on OpenBSD.
**Updated for OpenBSD [7.0](https://www.openbsd.org/70.html)**
Preparation
-------------
This guide describes how to build bitcoind, command-line utilities, and GUI on OpenBSD.
Run the following as root to install the base dependencies for building:
## Preparation
### 1. Install Required Dependencies
Run the following as root to install the base dependencies for building.
```bash
pkg_add git gmake libevent libtool boost
pkg_add qt5 # (optional for enabling the GUI)
pkg_add autoconf # (select highest version, e.g. 2.69)
pkg_add automake # (select highest version, e.g. 1.16)
pkg_add python # (select highest version, e.g. 3.8)
pkg_add bash
pkg_add bash git gmake libevent libtool boost
# Select the newest version of the follow packages:
pkg_add autoconf automake python
```
See [dependencies.md](dependencies.md) for a complete overview.
### 2. Clone Bitcoin Repo
Clone the Bitcoin Core repository to a directory. All build scripts and commands will run from this directory.
``` bash
git clone https://github.com/bitcoin/bitcoin.git
```
See [dependencies.md](dependencies.md) for a complete overview.
### 3. Install Optional Dependencies
**Important**: From OpenBSD 6.2 onwards a C++11-supporting clang compiler is
part of the base image, and while building it is necessary to make sure that
this compiler is used and not ancient g++ 4.2.1. This is done by appending
`CC=cc CXX=c++` to configuration commands. Mixing different compilers within
the same executable will result in errors.
#### Wallet Dependencies
### Building BerkeleyDB
It is not necessary to build wallet functionality to run either `bitcoind` or `bitcoin-qt`.
###### Descriptor Wallet Support
`sqlite3` is required to support [descriptor wallets](descriptors.md).
``` bash
pkg_add install sqlite3
```
BerkeleyDB is only necessary for the wallet functionality. To skip this, pass
`--disable-wallet` to `./configure` and skip to the next section.
###### Legacy Wallet Support
BerkeleyDB is only required to support legacy wallets.
It is recommended to use Berkeley DB 4.8. You cannot use the BerkeleyDB library
from ports, for the same reason as boost above (g++/libstd++ incompatibility).
If you have to build it yourself, you can use [the installation script included
in contrib/](/contrib/install_db4.sh) like so:
from ports. However you can build it yourself, [using the installation script included in contrib/](/contrib/install_db4.sh), like so, from the root of the repository.
```bash
./contrib/install_db4.sh `pwd` CC=cc CXX=c++
./contrib/install_db4.sh `pwd`
```
from the root of the repository. Then set `BDB_PREFIX` for the next section:
Then set `BDB_PREFIX`:
```bash
export BDB_PREFIX="$PWD/db4"
```
### Building Bitcoin Core
#### GUI Dependencies
###### Qt5
Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, Qt 5 is required.
```bash
pkg_add qt5
```
## Building Bitcoin Core
**Important**: Use `gmake` (the non-GNU `make` will exit with an error).
Preparation:
```bash
# Replace this with the autoconf version that you installed. Include only
# the major and minor parts of the version: use "2.69" for "autoconf-2.69p2".
export AUTOCONF_VERSION=2.69
# Replace this with the automake version that you installed. Include only
# the major and minor parts of the version: use "1.16" for "automake-1.16.1".
# Adapt the following for the version you installed (major.minor only):
export AUTOCONF_VERSION=2.71
export AUTOMAKE_VERSION=1.16
./autogen.sh
```
Make sure `BDB_PREFIX` is set to the appropriate path from the above steps.
### 1. Configuration
Note that building with external signer support currently fails on OpenBSD,
hence you have to explicitly disable it by passing the parameter
`--disable-external-signer` to the configure script.
(Background: the feature requires the header-only library boost::process, which
is available on OpenBSD 6.9 via Boost 1.72.0, but contains certain system calls
and preprocessor defines like `waitid()` and `WEXITED` that are not available.)
`--disable-external-signer` to the configure script. The feature requires the
header-only library boost::process, which is available on OpenBSD, but contains
certain system calls and preprocessor defines like `waitid()` and `WEXITED` that
fanquake
3 years ago