Skip to content

Commit 67e186d

Browse files
committed
doc: update wallet build instruction
Sqlite is expected to be installed, but can still be opted out of.
1 parent ec484bd commit 67e186d

File tree

5 files changed

+41
-55
lines changed

5 files changed

+41
-55
lines changed

doc/build-freebsd.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Run the following as root to install the base dependencies for building.
1313
pkg install boost-libs cmake git libevent pkgconf
1414
```
1515

16+
SQLite is required for the wallet:
17+
18+
```bash
19+
pkg install sqlite3
20+
```
21+
22+
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
23+
1624
See [dependencies.md](dependencies.md) for a complete overview.
1725

1826
### 2. Clone Bitcoin Repo
@@ -23,17 +31,6 @@ git clone https://github.com/bitcoin/bitcoin.git
2331

2432
### 3. Install Optional Dependencies
2533

26-
#### Wallet Dependencies
27-
It is not necessary to build wallet functionality to run either `bitcoind` or `bitcoin-qt`.
28-
29-
###### Descriptor Wallet Support
30-
31-
`sqlite3` is required to support [descriptor wallets](descriptors.md).
32-
Skip if you don't intend to use descriptor wallets.
33-
```bash
34-
pkg install sqlite3
35-
```
36-
3734
#### GUI Dependencies
3835
###### Qt6
3936

@@ -79,7 +76,7 @@ pkg install python3 databases/py-sqlite3 net/py-pyzmq
7976

8077
There are many ways to configure Bitcoin Core, here are a few common examples:
8178

82-
##### Descriptor Wallet and GUI:
79+
##### Wallet and GUI:
8380
This enables the GUI, assuming `sqlite` and `qt` are installed.
8481
```bash
8582
cmake -B build -DBUILD_GUI=ON

doc/build-netbsd.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,14 @@ cmake -B build
3131
...
3232
```
3333

34+
SQLite is required for the wallet:
35+
36+
```bash
37+
pkgin sqlite3
38+
```
39+
40+
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
41+
3442
See [dependencies.md](dependencies.md) for a complete overview.
3543

3644
### 2. Clone Bitcoin Repo
@@ -43,18 +51,6 @@ git clone https://github.com/bitcoin/bitcoin.git
4351

4452
### 3. Install Optional Dependencies
4553

46-
#### Wallet Dependencies
47-
48-
It is not necessary to build wallet functionality to run bitcoind or the GUI.
49-
50-
###### Descriptor Wallet Support
51-
52-
`sqlite3` is required to enable support for [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md).
53-
54-
```bash
55-
pkgin install sqlite3
56-
```
57-
5854
#### GUI Dependencies
5955
###### Qt6
6056

doc/build-openbsd.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Run the following as root to install the base dependencies for building.
1313
pkg_add git cmake boost libevent
1414
```
1515

16+
SQLite is required for the wallet:
17+
18+
```bash
19+
pkg_add sqlite3
20+
```
21+
22+
To build Bitcoin Core without the wallet, use `-DENABLE_WALLET=OFF`.
23+
1624
See [dependencies.md](dependencies.md) for a complete overview.
1725

1826
### 2. Clone Bitcoin Repo
@@ -23,16 +31,6 @@ git clone https://github.com/bitcoin/bitcoin.git
2331

2432
### 3. Install Optional Dependencies
2533

26-
#### Wallet Dependencies
27-
28-
It is not necessary to build wallet functionality to run either `bitcoind` or `bitcoin-qt`.
29-
SQLite is required to build the wallet.
30-
31-
32-
``` bash
33-
pkg_add sqlite3
34-
```
35-
3634
#### GUI Dependencies
3735
###### Qt6
3836

@@ -77,8 +75,8 @@ pkg_add python py3-zmq # Select the newest version of the python package if nec
7775

7876
There are many ways to configure Bitcoin Core, here are a few common examples:
7977

80-
##### Descriptor Wallet and GUI:
81-
This enables descriptor wallet support and the GUI, assuming SQLite and Qt 6 are installed.
78+
##### Wallet and GUI:
79+
This enables wallet support and the GUI, assuming SQLite and Qt 6 are installed.
8280

8381
```bash
8482
cmake -B build -DBUILD_GUI=ON

doc/build-osx.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ To install, run the following from your terminal:
5151
brew install cmake boost pkgconf libevent
5252
```
5353

54+
#### Wallet Dependencies
55+
56+
If you do not need wallet functionality, you can use `-DENABLE_WALLET=OFF` in
57+
the `cmake -B` step below.
58+
59+
SQLite is required, but since macOS ships with a useable `sqlite` package, you don't need to
60+
install anything.
61+
5462
### 4. Clone Bitcoin repository
5563

5664
`git` should already be installed by default on your system.
@@ -63,19 +71,6 @@ git clone https://github.com/bitcoin/bitcoin.git
6371

6472
### 5. Install Optional Dependencies
6573

66-
#### Wallet Dependencies
67-
68-
It is not necessary to build wallet functionality to run `bitcoind` or `bitcoin-qt`.
69-
70-
###### Descriptor Wallet Support
71-
72-
`sqlite` is required to support for descriptor wallets.
73-
74-
macOS ships with a useable `sqlite` package, meaning you don't need to
75-
install anything.
76-
77-
---
78-
7974
#### GUI Dependencies
8075

8176
###### Qt

doc/build-unix.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ Now, you can either build from self-compiled [depends](#dependencies) or install
5454

5555
sudo apt-get install libevent-dev libboost-dev
5656

57-
SQLite is required for the descriptor wallet:
57+
SQLite is required for the wallet:
5858

5959
sudo apt install libsqlite3-dev
6060

61-
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
61+
To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
6262

6363
ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency:
6464

@@ -105,11 +105,11 @@ Now, you can either build from self-compiled [depends](#dependencies) or install
105105

106106
sudo dnf install libevent-devel boost-devel
107107

108-
SQLite is required for the descriptor wallet:
108+
SQLite is required for the wallet:
109109

110110
sudo dnf install sqlite-devel
111111

112-
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
112+
To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
113113

114114
ZMQ-enabled binaries are compiled with `-DWITH_ZMQ=ON` and require the following dependency:
115115

@@ -155,11 +155,11 @@ Now, you can either build from self-compiled [depends](#dependencies) or install
155155

156156
apk add libevent-dev boost-dev
157157

158-
SQLite is required for the descriptor wallet:
158+
SQLite is required for the wallet:
159159

160160
apk add sqlite-dev
161161

162-
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
162+
To build Bitcoin Core without the wallet, see [*Disable-wallet mode*](#disable-wallet-mode)
163163

164164
ZMQ dependencies (provides ZMQ API):
165165

0 commit comments

Comments
 (0)