highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-08-24 06:11:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge bitcoin/bitcoin#33179: doc: update wallet build instruction

Browse Source 
67e186deb0 doc: update wallet build instruction (Sjors Provoost)

Pull request description:

  Sqlite and the wallet are no longer optional, but they can still be opted out of. This PR updates the build instructions accordingly.

  Updating this text now reduces churn in #31802.

ACKs for top commit:
  jonatack:
    ACK 67e186deb0
  achow101:
    ACK 67e186deb0
  w0xlt:
    reACK 67e186deb0
  pablomartin4btc:
    ACK 67e186deb0
  janb84:
    ACK 67e186deb0

Tree-SHA512: ea87a83c9fcb884f9ca380a006a93ede3cd1af5eb2bb5ccb54fc8124faa532e9473ae2461d775439da59e86178fbd04983113b43ce3d4c382cabe27866acd027
This commit is contained in:
Ava Chow
2025-08-14 11:06:24 -07:00
parent 9b1a7c3e8d 67e186deb0
commit e17b5da0d6
5 changed files with 41 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/build-freebsd.md
View File

@@ -13,6 +13,14 @@ Run the following as root to install the base dependencies for building.
pkg install boost-libs cmake git libevent pkgconf pkg install boost-libs cmake git libevent pkgconf
``` ```
SQLite is required for the wallet:
```bash
pkg install sqlite3
```
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
See [dependencies.md](dependencies.md) for a complete overview. See [dependencies.md](dependencies.md) for a complete overview.
### 2. Clone Bitcoin Repo ### 2. Clone Bitcoin Repo
@@ -23,17 +31,6 @@ git clone https://github.com/bitcoin/bitcoin.git
### 3. Install Optional Dependencies ### 3. Install Optional Dependencies
#### Wallet Dependencies
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).
Skip if you don't intend to use descriptor wallets.
```bash
pkg install sqlite3
```
#### GUI Dependencies #### GUI Dependencies
###### Qt6 ###### Qt6
@@ -79,7 +76,7 @@ pkg install python3 databases/py-sqlite3 net/py-pyzmq
There are many ways to configure Bitcoin Core, here are a few common examples: There are many ways to configure Bitcoin Core, here are a few common examples:
##### Descriptor Wallet and GUI: ##### Wallet and GUI:
This enables the GUI, assuming `sqlite` and `qt` are installed. This enables the GUI, assuming `sqlite` and `qt` are installed.
```bash ```bash
cmake -B build -DBUILD_GUI=ON cmake -B build -DBUILD_GUI=ON

20
doc/build-netbsd.md
View File

@@ -31,6 +31,14 @@ cmake -B build
... ...
``` ```
SQLite is required for the wallet:
```bash
pkgin sqlite3
```
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
See [dependencies.md](dependencies.md) for a complete overview. See [dependencies.md](dependencies.md) for a complete overview.
### 2. Clone Bitcoin Repo ### 2. Clone Bitcoin Repo
@@ -43,18 +51,6 @@ git clone https://github.com/bitcoin/bitcoin.git
### 3. Install Optional Dependencies ### 3. Install Optional Dependencies
#### Wallet Dependencies
It is not necessary to build wallet functionality to run bitcoind or the GUI.
###### Descriptor Wallet Support
`sqlite3` is required to enable support for [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md).
```bash
pkgin install sqlite3
```
#### GUI Dependencies #### GUI Dependencies
###### Qt6 ###### Qt6

22
doc/build-openbsd.md
View File

@@ -13,6 +13,14 @@ Run the following as root to install the base dependencies for building.
pkg_add git cmake boost libevent pkg_add git cmake boost libevent
``` ```
SQLite is required for the wallet:
```bash
pkg_add sqlite3
```
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
See [dependencies.md](dependencies.md) for a complete overview. See [dependencies.md](dependencies.md) for a complete overview.
### 2. Clone Bitcoin Repo ### 2. Clone Bitcoin Repo
@@ -23,16 +31,6 @@ git clone https://github.com/bitcoin/bitcoin.git
### 3. Install Optional Dependencies ### 3. Install Optional Dependencies
#### Wallet Dependencies
It is not necessary to build wallet functionality to run either `bitcoind` or `bitcoin-qt`.
SQLite is required to build the wallet.
``` bash
pkg_add sqlite3
```
#### GUI Dependencies #### GUI Dependencies
###### Qt6 ###### Qt6
@@ -77,8 +75,8 @@ pkg_add python py3-zmq # Select the newest version of the python package if nec
There are many ways to configure Bitcoin Core, here are a few common examples: There are many ways to configure Bitcoin Core, here are a few common examples:
##### Descriptor Wallet and GUI: ##### Wallet and GUI:
This enables descriptor wallet support and the GUI, assuming SQLite and Qt 6 are installed. This enables wallet support and the GUI, assuming SQLite and Qt 6 are installed.
```bash ```bash
cmake -B build -DBUILD_GUI=ON cmake -B build -DBUILD_GUI=ON

21
doc/build-osx.md
View File

@@ -51,6 +51,14 @@ To install, run the following from your terminal:
brew install cmake boost pkgconf libevent brew install cmake boost pkgconf libevent
``` ```
#### Wallet Dependencies
If you do not need wallet functionality, you can use `-DENABLE_WALLET=OFF` in
the `cmake -B` step below.
SQLite is required, but since macOS ships with a useable `sqlite` package, you don't need to
install anything.
### 4. Clone Bitcoin repository ### 4. Clone Bitcoin repository
`git` should already be installed by default on your system. `git` should already be installed by default on your system.
@@ -63,19 +71,6 @@ git clone https://github.com/bitcoin/bitcoin.git
### 5. Install Optional Dependencies ### 5. Install Optional Dependencies
#### Wallet Dependencies
It is not necessary to build wallet functionality to run `bitcoind` or `bitcoin-qt`.
###### Descriptor Wallet Support
`sqlite` is required to support for descriptor wallets.
macOS ships with a useable `sqlite` package, meaning you don't need to
install anything.
---
#### GUI Dependencies #### GUI Dependencies
###### Qt ###### Qt

12
doc/build-unix.md
View File

@@ -54,11 +54,11 @@ Now, you can either build from self-compiled [depends](#dependencies) or install
sudo apt-get install libevent-dev libboost-dev sudo apt-get install libevent-dev libboost-dev
SQLite is required for the descriptor wallet: SQLite is required for the wallet:
sudo apt install libsqlite3-dev sudo apt install libsqlite3-dev
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode) To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency: ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency:
@@ -105,11 +105,11 @@ Now, you can either build from self-compiled [depends](#dependencies) or install
sudo dnf install libevent-devel boost-devel sudo dnf install libevent-devel boost-devel
SQLite is required for the descriptor wallet: SQLite is required for the wallet:
sudo dnf install sqlite-devel sudo dnf install sqlite-devel
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode) To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency: ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency:
@@ -155,11 +155,11 @@ Now, you can either build from self-compiled [depends](#dependencies) or install
apk add libevent-dev boost-dev apk add libevent-dev boost-dev
SQLite is required for the descriptor wallet: SQLite is required for the wallet:
apk add sqlite-dev apk add sqlite-dev
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode) To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
ZMQ dependencies (provides ZMQ API): ZMQ dependencies (provides ZMQ API):