aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/JSON-RPC-interface.md26
-rw-r--r--doc/REST-interface.md16
-rw-r--r--doc/build-freebsd.md112
-rw-r--r--doc/build-openbsd.md1
-rw-r--r--doc/build-osx.md38
-rw-r--r--doc/build-unix.md26
-rw-r--r--doc/dependencies.md8
-rw-r--r--doc/developer-notes.md54
-rw-r--r--doc/fuzzing.md10
-rw-r--r--doc/guix.md3
-rw-r--r--doc/man/Makefile.am4
-rw-r--r--doc/man/bitcoin-cli.12
-rw-r--r--doc/man/bitcoin-qt.12
-rw-r--r--doc/man/bitcoin-tx.12
-rw-r--r--doc/man/bitcoin-util.15
-rw-r--r--doc/man/bitcoin-wallet.12
-rw-r--r--doc/man/bitcoind.12
-rw-r--r--doc/productivity.md1
-rw-r--r--doc/release-notes-18077.md10
-rw-r--r--doc/release-notes-19776.md9
-rw-r--r--doc/release-notes.md15
-rw-r--r--doc/release-notes/release-notes-0.21.0.md1336
-rw-r--r--doc/release-process.md36
-rw-r--r--doc/shared-libraries.md3
-rw-r--r--doc/tor.md186
25 files changed, 1767 insertions, 142 deletions
diff --git a/doc/JSON-RPC-interface.md b/doc/JSON-RPC-interface.md
index 40d8e330e2..12807bfb86 100644
--- a/doc/JSON-RPC-interface.md
+++ b/doc/JSON-RPC-interface.md
@@ -88,13 +88,14 @@ RPC interface will be abused.
- **Secure string handling:** The RPC interface does not guarantee any
escaping of data beyond what's necessary to encode it as JSON,
although it does usually provide serialized data using a hex
- representation of the bytes. If you use RPC data in your programs or
- provide its data to other programs, you must ensure any problem
- strings are properly escaped. For example, multiple websites have
- been manipulated because they displayed decoded hex strings that
- included HTML `<script>` tags. For this reason, and other
- non-security reasons, it is recommended to display all serialized data
- in hex form only.
+ representation of the bytes. If you use RPC data in your programs or
+ provide its data to other programs, you must ensure any problem strings
+ are properly escaped. For example, the `createwallet` RPC accepts
+ arguments such as `wallet_name` which is a string and could be used
+ for a path traversal attack without application level checks. Multiple
+ websites have been manipulated because they displayed decoded hex strings
+ that included HTML `<script>` tags. For this reason, and others, it is
+ recommended to display all serialized data in hex form only.
## RPC consistency guarantees
@@ -127,3 +128,14 @@ However, the wallet may not be up-to-date with the current state of the mempool
or the state of the mempool by an RPC that returned before this RPC. For
example, a wallet transaction that was BIP-125-replaced in the mempool prior to
this RPC may not yet be reflected as such in this RPC response.
+
+## Limitations
+
+There is a known issue in the JSON-RPC interface that can cause a node to crash if
+too many http connections are being opened at the same time because the system runs
+out of available file descriptors. To prevent this from happening you might
+want to increase the number of maximum allowed file descriptors in your system
+and try to prevent opening too many connections to your JSON-RPC interface at the
+same time if this is under your control. It is hard to give general advice
+since this depends on your system but if you make several hundred requests at
+once you are definitely at risk of encountering this issue.
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index 842a3964df..6237734390 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -4,7 +4,7 @@ Unauthenticated REST Interface
The REST API can be enabled with the `-rest` option.
The interface runs on the same port as the JSON-RPC interface, by default port 8332 for mainnet, port 18332 for testnet,
-and port 18443 for regtest.
+port 38332 for signet, and port 18443 for regtest.
REST Interface consistency guarantees
-------------------------------------
@@ -12,6 +12,18 @@ REST Interface consistency guarantees
The [same guarantees as for the RPC Interface](/doc/JSON-RPC-interface.md#rpc-consistency-guarantees)
apply.
+Limitations
+-----------
+
+There is a known issue in the REST interface that can cause a node to crash if
+too many http connections are being opened at the same time because the system runs
+out of available file descriptors. To prevent this from happening you might
+want to increase the number of maximum allowed file descriptors in your system
+and try to prevent opening too many connections to your rest interface at the
+same time if this is under your control. It is hard to give general advice
+since this depends on your system but if you make several hundred requests at
+once you are definitely at risk of encountering this issue.
+
Supported API
-------------
@@ -50,7 +62,7 @@ Given a height: returns hash of block in best-block-chain at height provided.
Returns various state info regarding block chain processing.
Only supports JSON as output format.
-* chain : (string) current network name (main, test, regtest)
+* chain : (string) current network name (main, test, signet, regtest)
* blocks : (numeric) the current number of blocks processed in the server
* headers : (numeric) the current number of headers we have validated
* bestblockhash : (string) the hash of the currently best block
diff --git a/doc/build-freebsd.md b/doc/build-freebsd.md
index f48855a344..18ea84c579 100644
--- a/doc/build-freebsd.md
+++ b/doc/build-freebsd.md
@@ -1,59 +1,127 @@
-FreeBSD build guide
-======================
-(updated for FreeBSD 12.0)
+# FreeBSD Build Guide
-This guide describes how to build bitcoind and command-line utilities on FreeBSD.
+**Updated for FreeBSD [12.2](https://www.freebsd.org/releases/12.2R/announce.html)**
-This guide does not contain instructions for building the GUI.
+This guide describes how to build bitcoind, command-line utilities, and GUI on FreeBSD.
+
+## Dependencies
+
+The following dependencies are **required**:
+
+ Library | Purpose | Description
+ ----------------------------------------------------------------------|------------|----------------------
+ [autoconf](https://svnweb.freebsd.org/ports/head/devel/autoconf/) | Build | Automatically configure software source code
+ [automake](https://svnweb.freebsd.org/ports/head/devel/automake/) | Build | Generate makefile (requires autoconf)
+ [libtool](https://svnweb.freebsd.org/ports/head/devel/libtool/) | Build | Shared library support
+ [pkgconf](https://svnweb.freebsd.org/ports/head/devel/pkgconf/) | Build | Configure compiler and linker flags
+ [git](https://svnweb.freebsd.org/ports/head/devel/git/) | Clone | Version control system
+ [gmake](https://svnweb.freebsd.org/ports/head/devel/gmake/) | Compile | Generate executables
+ [boost-libs](https://svnweb.freebsd.org/ports/head/devel/boost-libs/) | Utility | Library for threading, data structures, etc
+ [libevent](https://svnweb.freebsd.org/ports/head/devel/libevent/) | Networking | OS independent asynchronous networking
+
+
+The following dependencies are **optional**:
+
+ Library | Purpose | Description
+ ---------------------------------------------------------------------------|------------------|----------------------
+ [db5](https://svnweb.freebsd.org/ports/head/databases/db5/) | Berkeley DB | Wallet storage (only needed when wallet enabled)
+ [qt5](https://svnweb.freebsd.org/ports/head/devel/qt5/) | GUI | GUI toolkit (only needed when GUI enabled)
+ [libqrencode](https://svnweb.freebsd.org/ports/head/graphics/libqrencode/) | QR codes in GUI | Generating QR codes (only needed when GUI enabled)
+ [libzmq4](https://svnweb.freebsd.org/ports/head/net/libzmq4/) | ZMQ notification | Allows generating ZMQ notifications (requires ZMQ version >= 4.0.0)
+ [sqlite3](https://svnweb.freebsd.org/ports/head/databases/sqlite3/) | SQLite DB | Wallet storage (only needed when wallet enabled)
+ [python3](https://svnweb.freebsd.org/ports/head/lang/python3/) | Testing | Python Interpreter (only needed when running the test suite)
+
+ See [dependencies.md](dependencies.md) for a complete overview.
## Preparation
-You will need the following dependencies, which can be installed as root via pkg:
+### 1. Install Required Dependencies
+Install the required dependencies the usual way you [install software on FreeBSD](https://www.freebsd.org/doc/en/books/handbook/ports.html) - either with `pkg` or via the Ports collection. The example commands below use `pkg` which is usually run as `root` or via `sudo`. If you want to use `sudo`, and you haven't set it up: [use this guide](http://www.freebsdwiki.net/index.php/Sudo%2C_configuring) to setup `sudo` access on FreeBSD.
```bash
pkg install autoconf automake boost-libs git gmake libevent libtool pkgconf
+```
+
+### 2. Clone Bitcoin Repo
+Now that `git` and all the required dependencies are installed, let's 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
```
-In order to run the test suite (recommended), you will need to have Python 3 installed:
+### 3. Install Optional Dependencies
+
+#### Wallet Dependencies
+It is not necessary to build wallet functionality to run bitcoind or the GUI. To enable legacy wallets, you must install `db5`. To enable [descriptor wallets](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md), `sqlite3` is required. Skip `db5` if you intend to *exclusively* use descriptor wallets
+
+###### Legacy Wallet Support
+`db5` is required to enable support for legacy wallets. Skip if you don't intend to use legacy wallets
```bash
-pkg install python3
+pkg install db5
```
-See [dependencies.md](dependencies.md) for a complete overview.
+###### Descriptor Wallet Support
-### Building BerkeleyDB
+`sqlite3` is required to enable support for descriptor wallets. Skip if you don't intend to use descriptor wallets.
+``` bash
+pkg install sqlite3
+```
+---
-BerkeleyDB is only necessary for the wallet functionality. To skip this, pass
-`--disable-wallet` to `./configure` and skip to the next section.
+#### GUI Dependencies
+###### Qt5
+Bitcoin Core includes a GUI built with the cross-platform Qt Framework. To compile the GUI, we need to install `qt5`. Skip if you don't intend to use the GUI.
```bash
-./contrib/install_db4.sh `pwd`
-export BDB_PREFIX="$PWD/db4"
+pkg install qt5
```
+###### libqrencode
+
+The GUI can encode addresses in a QR Code. To build in QR support for the GUI, install `libqrencode`. Skip if not using the GUI or don't want QR code functionality.
+```bash
+pkg install libqrencode
+```
+---
+
+#### Test Suite Dependencies
+There is an included test suite that is useful for testing code changes when developing.
+To run the test suite (recommended), you will need to have Python 3 installed:
+
+```bash
+pkg install python3
+```
+---
## Building Bitcoin Core
-**Important**: Use `gmake` (the non-GNU `make` will exit with an error).
+### 1. Configuration
-With wallet:
+There are many ways to configure Bitcoin Core, here are a few common examples:
+##### Wallet (BDB + SQlite) Support, No GUI:
+This explicitly enables legacy wallet support and disables the GUI. If `sqlite3` is installed, then descriptor wallet support will be built.
```bash
./autogen.sh
-./configure --with-gui=no \
- BDB_LIBS="-L${BDB_PREFIX}/lib -ldb_cxx-4.8" \
- BDB_CFLAGS="-I${BDB_PREFIX}/include" \
+./configure --with-gui=no --with-incompatible-bdb \
+ BDB_LIBS="-ldb_cxx-5" \
+ BDB_CFLAGS="-I/usr/local/include/db5" \
MAKE=gmake
```
-Without wallet:
+##### Wallet (only SQlite) and GUI Support:
+This explicitly enables the GUI and disables legacy wallet support. If `qt5` is not installed, this will throw an error. If `sqlite3` is installed then descriptor wallet functionality will be built. If `sqlite3` is not installed, then wallet functionality will be disabled.
```bash
./autogen.sh
-./configure --with-gui=no --disable-wallet MAKE=gmake
+./configure --without-bdb --with-gui=yes MAKE=gmake
+```
+##### No Wallet or GUI
+``` bash
+./autogen.sh
+./configure --without-wallet --with-gui=no MAKE=gmake
```
-followed by:
+### 2. Compile
+**Important**: Use `gmake` (the non-GNU `make` will exit with an error).
```bash
gmake # use -jX here for parallelism
diff --git a/doc/build-openbsd.md b/doc/build-openbsd.md
index 2b051c078c..dccd7b1335 100644
--- a/doc/build-openbsd.md
+++ b/doc/build-openbsd.md
@@ -15,6 +15,7 @@ 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
git clone https://github.com/bitcoin/bitcoin.git
```
diff --git a/doc/build-osx.md b/doc/build-osx.md
index 2a7d71eea6..04ee43f81d 100644
--- a/doc/build-osx.md
+++ b/doc/build-osx.md
@@ -19,7 +19,7 @@ Then install [Homebrew](https://brew.sh).
## Dependencies
```shell
-brew install automake berkeley-db4 libtool boost miniupnpc pkg-config python qt libevent qrencode sqlite
+brew install automake libtool boost miniupnpc libnatpmp pkg-config python qt libevent qrencode
```
If you run into issues, check [Homebrew's troubleshooting page](https://docs.brew.sh/Troubleshooting).
@@ -30,7 +30,27 @@ If you want to build the disk image with `make deploy` (.dmg / optional), you ne
brew install librsvg
```
-## Berkeley DB
+and [`macdeployqtplus`](../contrib/macdeploy/README.md) dependencies:
+```shell
+pip3 install ds_store mac_alias
+```
+
+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:
@@ -41,7 +61,11 @@ like so:
from the root of the repository.
-**Note**: You only need Berkeley DB if the wallet is enabled (see [*Disable-wallet mode*](/doc/build-osx.md#disable-wallet-mode)).
+Also, the Homebrew package could be installed:
+
+```shell
+brew install berkeley-db4
+```
## Build Bitcoin Core
@@ -72,14 +96,14 @@ from the root of the repository.
make deploy
```
-## `disable-wallet` mode
+## 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:
+compiled in disable-wallet mode with:
```shell
./configure --disable-wallet
```
-In this case there is no dependency on Berkeley DB 4.8 and SQLite.
+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.
@@ -111,6 +135,6 @@ tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
```
## Notes
-* Tested on OS X 10.12 Sierra through macOS 10.15 Catalina on 64-bit Intel
+* 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).
diff --git a/doc/build-unix.md b/doc/build-unix.md
index ab83ceff3d..5c24886dbf 100644
--- a/doc/build-unix.md
+++ b/doc/build-unix.md
@@ -41,7 +41,8 @@ Optional dependencies:
Library | Purpose | Description
------------|------------------|----------------------
miniupnpc | UPnP Support | Firewall-jumping support
- libdb4.8 | Berkeley DB | Wallet storage (only needed when wallet enabled)
+ libnatpmp | NAT-PMP Support | Firewall-jumping support
+ libdb4.8 | Berkeley DB | Optional, wallet storage (only needed when wallet enabled)
qt | GUI | GUI toolkit (only needed when GUI enabled)
libqrencode | QR codes in GUI | Optional for generating QR codes (only needed when GUI enabled)
univalue | Utility | JSON parsing and encoding (bundled version will be used unless --with-system-univalue passed to configure)
@@ -99,9 +100,9 @@ SQLite is required for the wallet:
To build Bitcoin Core without wallet, see [*Disable-wallet mode*](/doc/build-unix.md#disable-wallet-mode)
-Optional (see `--with-miniupnpc` and `--enable-upnp-default`):
+Optional port mapping libraries (see: `--with-miniupnpc`, and `--enable-upnp-default`, `--with-natpmp`, `--enable-natpmp-default`):
- sudo apt-get install libminiupnpc-dev
+ sudo apt install libminiupnpc-dev libnatpmp-dev
ZMQ dependencies (provides ZMQ API):
@@ -133,9 +134,9 @@ Build requirements:
sudo dnf install gcc-c++ libtool make autoconf automake libevent-devel boost-devel libdb4-devel libdb4-cxx-devel python3
-Optional (see `--with-miniupnpc` and `--enable-upnp-default`):
+Optional port mapping libraries (see: `--with-miniupnpc`, and `--enable-upnp-default`, `--with-natpmp`, `--enable-natpmp-default`):
- sudo dnf install miniupnpc-devel
+ sudo dnf install miniupnpc-devel libnatpmp-devel
ZMQ dependencies (provides ZMQ API):
@@ -158,18 +159,27 @@ Notes
The release is built with GCC and then "strip bitcoind" to strip the debug
symbols, which reduces the executable size by about 90%.
-
miniupnpc
---------
[miniupnpc](https://miniupnp.tuxfamily.org) may be used for UPnP port mapping. It can be downloaded from [here](
https://miniupnp.tuxfamily.org/files/). UPnP support is compiled in and
-turned off by default. See the configure options for upnp behavior desired:
+turned off by default. See the configure options for UPnP behavior desired:
- --without-miniupnpc No UPnP support miniupnp not required
+ --without-miniupnpc No UPnP support, miniupnp not required
--disable-upnp-default (the default) UPnP support turned off by default at runtime
--enable-upnp-default UPnP support turned on by default at runtime
+libnatpmp
+---------
+
+[libnatpmp](https://miniupnp.tuxfamily.org/libnatpmp.html) may be used for NAT-PMP port mapping. It can be downloaded
+from [here](https://miniupnp.tuxfamily.org/files/). NAT-PMP support is compiled in and
+turned off by default. See the configure options for NAT-PMP behavior desired:
+
+ --without-natpmp No NAT-PMP support, libnatpmp not required
+ --disable-natpmp-default (the default) NAT-PMP support turned off by default at runtime
+ --enable-natpmp-default NAT-PMP support turned on by default at runtime
Berkeley DB
-----------
diff --git a/doc/dependencies.md b/doc/dependencies.md
index 6a743caba2..6b2b904632 100644
--- a/doc/dependencies.md
+++ b/doc/dependencies.md
@@ -6,7 +6,7 @@ These are the dependencies currently used by Bitcoin Core. You can find instruct
| Dependency | Version used | Minimum required | CVEs | Shared | [Bundled Qt library](https://doc.qt.io/qt-5/configure-options.html#third-party-libraries) |
| --- | --- | --- | --- | --- | --- |
| Berkeley DB | [4.8.30](https://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads/index.html) | 4.8.x | No | | |
-| Boost | [1.70.0](https://www.boost.org/users/download/) | [1.58.0](https://github.com/bitcoin/bitcoin/pull/19667) | No | | |
+| Boost | [1.71.0](https://www.boost.org/users/download/) | [1.58.0](https://github.com/bitcoin/bitcoin/pull/19667) | No | | |
| Clang | | [5.0+](https://releases.llvm.org/download.html) (C++17 support) | | | |
| Expat | [2.2.7](https://libexpat.github.io/) | | No | Yes | |
| fontconfig | [2.12.1](https://www.freedesktop.org/software/fontconfig/release/) | | No | Yes | |
@@ -14,6 +14,7 @@ These are the dependencies currently used by Bitcoin Core. You can find instruct
| GCC | | [7+](https://gcc.gnu.org/) (C++17 support) | | | |
| HarfBuzz-NG | | | | | [Yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk) |
| libevent | [2.1.11-stable](https://github.com/libevent/libevent/releases) | [2.0.21](https://github.com/bitcoin/bitcoin/pull/18676) | No | | |
+| libnatpmp | [20150609](https://miniupnp.tuxfamily.org/files) | | No | | |
| libpng | | | | | [Yes](https://github.com/bitcoin/bitcoin/blob/master/depends/packages/qt.mk) |
| librsvg | | | | | |
| MiniUPnPc | [2.0.20180203](https://miniupnp.tuxfamily.org/files) | | No | | |
@@ -32,8 +33,9 @@ Controlling dependencies
Some dependencies are not needed in all configurations. The following are some factors that affect the dependency list.
#### Options passed to `./configure`
-* MiniUPnPc is not needed with `--with-miniupnpc=no`.
-* Berkeley DB is not needed with `--disable-wallet`.
+* MiniUPnPc is not needed with `--without-miniupnpc`.
+* libnatpmp is not needed with `--without-natpmp`.
+* Berkeley DB is not needed with `--disable-wallet` or `--without-bdb`.
* SQLite is not needed with `--disable-wallet` or `--without-sqlite`.
* Qt is not needed with `--without-gui`.
* If the qrencode dependency is absent, QR support won't be added. To force an error when that happens, pass `--with-qrencode`.
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index fa188dbcd6..596f65cf10 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -14,7 +14,7 @@ Developer Notes
- [Compiling for debugging](#compiling-for-debugging)
- [Compiling for gprof profiling](#compiling-for-gprof-profiling)
- [`debug.log`](#debuglog)
- - [Testnet and Regtest modes](#testnet-and-regtest-modes)
+ - [Signet, testnet, and regtest modes](#signet-testnet-and-regtest-modes)
- [DEBUG_LOCKORDER](#debug_lockorder)
- [Valgrind suppressions file](#valgrind-suppressions-file)
- [Compiling for test coverage](#compiling-for-test-coverage)
@@ -135,7 +135,7 @@ Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.m
Coding Style (Doxygen-compatible comments)
------------------------------------------
-Bitcoin Core uses [Doxygen](http://www.doxygen.nl/) to generate its official documentation.
+Bitcoin Core uses [Doxygen](https://www.doxygen.nl/) to generate its official documentation.
Use Doxygen-compatible comment blocks for functions, methods, and fields.
@@ -156,7 +156,7 @@ For example, to describe a function use:
bool function(int arg1, const char *arg2, std::string& arg3)
```
-A complete list of `@xxx` commands can be found at http://www.doxygen.nl/manual/commands.html.
+A complete list of `@xxx` commands can be found at https://www.doxygen.nl/manual/commands.html.
As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this case), you don't
*need* to provide any commands for a comment to be valid; just a description text is fine.
@@ -203,7 +203,7 @@ Also not picked up by Doxygen:
*/
```
-A full list of comment syntaxes picked up by Doxygen can be found at http://www.doxygen.nl/manual/docblocks.html,
+A full list of comment syntaxes picked up by Doxygen can be found at https://www.doxygen.nl/manual/docblocks.html,
but the above styles are favored.
Recommendations:
@@ -216,7 +216,7 @@ Recommendations:
- Backticks aren't required when referring to functions Doxygen already knows
about; it will build hyperlinks for these automatically. See
- http://www.doxygen.nl/manual/autolink.html for complete info.
+ https://www.doxygen.nl/manual/autolink.html for complete info.
- Avoid linking to external documentation; links can break.
@@ -259,14 +259,15 @@ on all categories (and give you a very large `debug.log` file).
The Qt code routes `qDebug()` output to `debug.log` under category "qt": run with `-debug=qt`
to see it.
-### Testnet and Regtest modes
+### Signet, testnet, and regtest modes
-Run with the `-testnet` option to run with "play bitcoins" on the test network, if you
-are testing multi-machine code that needs to operate across the internet.
+If you are testing multi-machine code that needs to operate across the internet,
+you can run with either the `-signet` or the `-testnet` config option to test
+with "play bitcoins" on a test network.
-If you are testing something that can run on one machine, run with the `-regtest` option.
-In regression test mode, blocks can be created on-demand; see [test/functional/](/test/functional) for tests
-that run in `-regtest` mode.
+If you are testing something that can run on one machine, run with the
+`-regtest` option. In regression test mode, blocks can be created on demand;
+see [test/functional/](/test/functional) for tests that run in `-regtest` mode.
### DEBUG_LOCKORDER
@@ -276,6 +277,33 @@ configure option adds `-DDEBUG_LOCKORDER` to the compiler flags. This inserts
run-time checks to keep track of which locks are held and adds warnings to the
`debug.log` file if inconsistencies are detected.
+### Assertions and Checks
+
+The util file `src/util/check.h` offers helpers to protect against coding and
+internal logic bugs. They must never be used to validate user, network or any
+other input.
+
+* `assert` or `Assert` should be used to document assumptions when any
+ violation would mean that it is not safe to continue program execution. The
+ code is always compiled with assertions enabled.
+ - For example, a nullptr dereference or any other logic bug in validation
+ code means the program code is faulty and must terminate immediately.
+* `CHECK_NONFATAL` should be used for recoverable internal logic bugs. On
+ failure, it will throw an exception, which can be caught to recover from the
+ error.
+ - For example, a nullptr dereference or any other logic bug in RPC code
+ means that the RPC code is faulty and can not be executed. However, the
+ logic bug can be shown to the user and the program can continue to run.
+* `Assume` should be used to document assumptions when program execution can
+ safely continue even if the assumption is violated. In debug builds it
+ behaves like `Assert`/`assert` to notify developers and testers about
+ nonfatal errors. In production it doesn't warn or log anything, though the
+ expression is always evaluated.
+ - For example it can be assumed that a variable is only initialized once,
+ but a failed assumption does not result in a fatal bug. A failed
+ assumption may or may not result in a slightly degraded user experience,
+ but it is safe to continue program execution.
+
### Valgrind suppressions file
Valgrind is a programming tool for memory debugging, memory leak detection, and
@@ -516,7 +544,7 @@ General Bitcoin Core
- *Rationale*: RPC allows for better automatic testing. The test suite for
the GUI is very limited.
-- Make sure pull requests pass Travis CI before merging.
+- Make sure pull requests pass CI before merging.
- *Rationale*: Makes sure that they pass thorough testing, and that the tester will keep passing
on the master branch. Otherwise, all new pull requests will start failing the tests, resulting in
@@ -1009,7 +1037,7 @@ Scripted diffs
--------------
For reformatting and refactoring commits where the changes can be easily automated using a bash script, we use
-scripted-diff commits. The bash script is included in the commit message and our Travis CI job checks that
+scripted-diff commits. The bash script is included in the commit message and our CI job checks that
the result of the script is identical to the commit. This aids reviewers since they can verify that the script
does exactly what it is supposed to do. It is also helpful for rebasing (since the same script can just be re-run
on the new master commit).
diff --git a/doc/fuzzing.md b/doc/fuzzing.md
index c97b8d4d50..80ce821091 100644
--- a/doc/fuzzing.md
+++ b/doc/fuzzing.md
@@ -12,7 +12,7 @@ $ CC=clang CXX=clang++ ./configure --enable-fuzz --with-sanitizers=address,fuzze
# macOS users: If you have problem with this step then make sure to read "macOS hints for
# libFuzzer" on https://github.com/bitcoin/bitcoin/blob/master/doc/fuzzing.md#macos-hints-for-libfuzzer
$ make
-$ src/test/fuzz/process_message
+$ FUZZ=process_message src/test/fuzz/fuzz
# abort fuzzing using ctrl-c
```
@@ -26,7 +26,7 @@ If you specify a corpus directory then any new coverage increasing inputs will b
```sh
$ mkdir -p process_message-seeded-from-thin-air/
-$ src/test/fuzz/process_message process_message-seeded-from-thin-air/
+$ FUZZ=process_message src/test/fuzz/fuzz process_message-seeded-from-thin-air/
INFO: Seed: 840522292
INFO: Loaded 1 modules (424174 inline 8-bit counters): 424174 [0x55e121ef9ab8, 0x55e121f613a6),
INFO: Loaded 1 PC tables (424174 PCs): 424174 [0x55e121f613a8,0x55e1225da288),
@@ -70,7 +70,7 @@ To fuzz `process_message` using the [`bitcoin-core/qa-assets`](https://github.co
```sh
$ git clone https://github.com/bitcoin-core/qa-assets
-$ src/test/fuzz/process_message qa-assets/fuzz_seed_corpus/process_message/
+$ FUZZ=process_message src/test/fuzz/fuzz qa-assets/fuzz_seed_corpus/process_message/
INFO: Seed: 1346407872
INFO: Loaded 1 modules (424174 inline 8-bit counters): 424174 [0x55d8a9004ab8, 0x55d8a906c3a6),
INFO: Loaded 1 PC tables (424174 PCs): 424174 [0x55d8a906c3a8,0x55d8a96e5288),
@@ -129,7 +129,7 @@ $ make
# try compiling using: AFL_NO_X86=1 make
$ mkdir -p inputs/ outputs/
$ echo A > inputs/thin-air-input
-$ afl/afl-fuzz -i inputs/ -o outputs/ -- src/test/fuzz/bech32
+$ FUZZ=bech32 afl/afl-fuzz -i inputs/ -o outputs/ -- src/test/fuzz/fuzz
# You may have to change a few kernel parameters to test optimally - afl-fuzz
# will print an error and suggestion if so.
```
@@ -153,7 +153,7 @@ $ cd ..
$ CC=$(pwd)/honggfuzz/hfuzz_cc/hfuzz-clang CXX=$(pwd)/honggfuzz/hfuzz_cc/hfuzz-clang++ ./configure --enable-fuzz --with-sanitizers=address,undefined
$ make
$ mkdir -p inputs/
-$ honggfuzz/honggfuzz -i inputs/ -- src/test/fuzz/process_message
+$ FUZZ=process_message honggfuzz/honggfuzz -i inputs/ -- src/test/fuzz/fuzz
```
Read the [Honggfuzz documentation](https://github.com/google/honggfuzz/blob/master/docs/USAGE.md) for more information.
diff --git a/doc/guix.md b/doc/guix.md
new file mode 100644
index 0000000000..fa9c74f486
--- /dev/null
+++ b/doc/guix.md
@@ -0,0 +1,3 @@
+# Bootstrappable Bitcoin Core Builds
+
+See [contrib/guix/README.md](../contrib/guix/README.md)
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index edbc0911a1..8f890da532 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -16,6 +16,10 @@ if BUILD_BITCOIN_TX
dist_man1_MANS+=bitcoin-tx.1
endif
+if BUILD_BITCOIN_UTIL
+ dist_man1_MANS+=bitcoin-util.1
+endif
+
if ENABLE_WALLET
if BUILD_BITCOIN_WALLET
dist_man1_MANS+=bitcoin-wallet.1
diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1
index 588ae81fce..6bcad7006b 100644
--- a/doc/man/bitcoin-cli.1
+++ b/doc/man/bitcoin-cli.1
@@ -2,4 +2,4 @@
.SH NAME
bitcoin-cli \- manual page for bitcoin-cli
-This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1
index 9c75e9fe54..ff4d1d2c7a 100644
--- a/doc/man/bitcoin-qt.1
+++ b/doc/man/bitcoin-qt.1
@@ -2,4 +2,4 @@
.SH NAME
bitcoin-qt \- manual page for bitcoin-qt
-This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1
index 148a5890b0..776bb46234 100644
--- a/doc/man/bitcoin-tx.1
+++ b/doc/man/bitcoin-tx.1
@@ -2,4 +2,4 @@
.SH NAME
bitcoin-tx \- manual page for bitcoin-tx
-This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
diff --git a/doc/man/bitcoin-util.1 b/doc/man/bitcoin-util.1
new file mode 100644
index 0000000000..5c733c6e21
--- /dev/null
+++ b/doc/man/bitcoin-util.1
@@ -0,0 +1,5 @@
+.TH BITCOIN-UTIL "1"
+.SH NAME
+bitcoin-util \- manual page for bitcoin-util
+
+This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1
index 69133b33f7..2da43dec66 100644
--- a/doc/man/bitcoin-wallet.1
+++ b/doc/man/bitcoin-wallet.1
@@ -2,4 +2,4 @@
.SH NAME
bitcoin-wallet \- manual page for bitcoin-wallet
-This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1
index de338182ff..2c88f74520 100644
--- a/doc/man/bitcoind.1
+++ b/doc/man/bitcoind.1
@@ -2,4 +2,4 @@
.SH NAME
bitcoind \- manual page for bitcoind
-This is a placefolder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
+This is a placeholder file. Please follow the instructions in \fIcontrib/devtools/README.md\fR to generate the manual pages after a release.
diff --git a/doc/productivity.md b/doc/productivity.md
index 555f0afe3c..a01c6f545d 100644
--- a/doc/productivity.md
+++ b/doc/productivity.md
@@ -51,6 +51,7 @@ After running `./autogen.sh`, which generates the `./configure` file, use `./con
```sh
--without-miniupnpc
+--without-natpmp
--disable-bench
--disable-wallet
--without-gui
diff --git a/doc/release-notes-18077.md b/doc/release-notes-18077.md
new file mode 100644
index 0000000000..4034a4c19c
--- /dev/null
+++ b/doc/release-notes-18077.md
@@ -0,0 +1,10 @@
+P2P and network changes
+-----------------------
+
+- Added NAT-PMP port mapping support via [`libnatpmp`](https://miniupnp.tuxfamily.org/libnatpmp.html)
+
+Command-line options
+--------------------
+
+- The `-natpmp` option has been added to use NAT-PMP to map the listening port. If both UPnP
+and NAT-PMP are enabled, a successful allocation from UPnP prevails over one from NAT-PMP.
diff --git a/doc/release-notes-19776.md b/doc/release-notes-19776.md
new file mode 100644
index 0000000000..5553c5a7bd
--- /dev/null
+++ b/doc/release-notes-19776.md
@@ -0,0 +1,9 @@
+Updated RPCs
+------------
+
+- The `getpeerinfo` RPC returns two new boolean fields, `bip152_hb_to` and
+ `bip152_hb_from`, that respectively indicate whether we selected a peer to be
+ in compact blocks high-bandwidth mode or whether a peer selected us as a
+ compact blocks high-bandwidth peer. High-bandwidth peers send new block
+ announcements via a `cmpctblock` message rather than the usual inv/headers
+ announcements. See BIP 152 for more details. (#19776)
diff --git a/doc/release-notes.md b/doc/release-notes.md
index 57067138b0..0f248494c7 100644
--- a/doc/release-notes.md
+++ b/doc/release-notes.md
@@ -46,12 +46,12 @@ Compatibility
==============
Bitcoin Core is supported and extensively tested on operating systems
-using the Linux kernel, macOS 10.12+, and Windows 7 and newer. Bitcoin
+using the Linux kernel, macOS 10.14+, and Windows 7 and newer. Bitcoin
Core should also work on most other Unix-like systems but is not as
frequently tested on them. It is not recommended to use Bitcoin Core on
unsupported systems.
-From Bitcoin Core 0.20.0 onwards, macOS versions earlier than 10.12 are no
+From Bitcoin Core 0.22.0 onwards, macOS versions earlier than 10.14 are no
longer supported. Additionally, Bitcoin Core does not yet change appearance
when macOS "dark mode" is activated.
@@ -63,6 +63,11 @@ P2P and network changes
Updated RPCs
------------
+- `getpeerinfo` no longer returns the following fields: `addnode`, `banscore`,
+ and `whitelisted`, which were previously deprecated in 0.21. Instead of
+ `addnode`, the `connection_type` field returns manual. Instead of
+ `whitelisted`, the `permissions` field indicates if the peer has special
+ privileges. The `banscore` field has simply been removed. (#20755)
Changes to Wallet or GUI related RPCs can be found in the GUI or Wallet section below.
@@ -80,12 +85,18 @@ Updated settings
Changes to Wallet or GUI related settings can be found in the GUI or Wallet section below.
+- Passing an invalid `-rpcauth` argument now cause bitcoind to fail to start. (#20461)
+
Tools and Utilities
-------------------
Wallet
------
+- A new `listdescriptors` RPC is available to inspect the contents of descriptor-enabled wallets.
+ The RPC returns public versions of all imported descriptors, including their timestamp and flags.
+ For ranged descriptors, it also returns the range boundaries and the next index to generate addresses from. (#20226)
+
GUI changes
-----------
diff --git a/doc/release-notes/release-notes-0.21.0.md b/doc/release-notes/release-notes-0.21.0.md
new file mode 100644
index 0000000000..3baba3d49b
--- /dev/null
+++ b/doc/release-notes/release-notes-0.21.0.md
@@ -0,0 +1,1336 @@
+0.21.0 Release Notes
+====================
+
+Bitcoin Core version 0.21.0 is now available from:
+
+ <https://bitcoincore.org/bin/bitcoin-core-0.21.0/>
+
+This release includes new features, various bug fixes and performance
+improvements, as well as updated translations.
+
+Please report bugs using the issue tracker at GitHub:
+
+ <https://github.com/bitcoin/bitcoin/issues>
+
+To receive security and update notifications, please subscribe to:
+
+ <https://bitcoincore.org/en/list/announcements/join/>
+
+How to Upgrade
+==============
+
+If you are running an older version, shut it down. Wait until it has completely
+shut down (which might take a few minutes in some cases), then run the
+installer (on Windows) or just copy over `/Applications/Bitcoin-Qt` (on Mac)
+or `bitcoind`/`bitcoin-qt` (on Linux).
+
+Upgrading directly from a version of Bitcoin Core that has reached its EOL is
+possible, but it might take some time if the data directory needs to be migrated. Old
+wallet versions of Bitcoin Core are generally supported.
+
+Compatibility
+==============
+
+Bitcoin Core is supported and extensively tested on operating systems
+using the Linux kernel, macOS 10.12+, and Windows 7 and newer. Bitcoin
+Core should also work on most other Unix-like systems but is not as
+frequently tested on them. It is not recommended to use Bitcoin Core on
+unsupported systems.
+
+From Bitcoin Core 0.20.0 onwards, macOS versions earlier than 10.12 are no
+longer supported. Additionally, Bitcoin Core does not yet change appearance
+when macOS "dark mode" is activated.
+
+The node's known peers are persisted to disk in a file called `peers.dat`. The
+format of this file has been changed in a backwards-incompatible way in order to
+accommodate the storage of Tor v3 and other BIP155 addresses. This means that if
+the file is modified by 0.21.0 or newer then older versions will not be able to
+read it. Those old versions, in the event of a downgrade, will log an error
+message "Incorrect keysize in addrman deserialization" and will continue normal
+operation as if the file was missing, creating a new empty one. (#19954, #20284)
+
+Notable changes
+===============
+
+P2P and network changes
+-----------------------
+
+- The mempool now tracks whether transactions submitted via the wallet or RPCs
+ have been successfully broadcast. Every 10-15 minutes, the node will try to
+ announce unbroadcast transactions until a peer requests it via a `getdata`
+ message or the transaction is removed from the mempool for other reasons.
+ The node will not track the broadcast status of transactions submitted to the
+ node using P2P relay. This version reduces the initial broadcast guarantees
+ for wallet transactions submitted via P2P to a node running the wallet. (#18038)
+
+- The size of the set of transactions that peers have announced and we consider
+ for requests has been reduced from 100000 to 5000 (per peer), and further
+ announcements will be ignored when that limit is reached. If you need to dump
+ (very) large batches of transactions, exceptions can be made for trusted
+ peers using the "relay" network permission. For localhost for example it can
+ be enabled using the command line option `-whitelist=relay@127.0.0.1`.
+ (#19988)
+
+- This release adds support for Tor version 3 hidden services, and rumoring them
+ over the network to other peers using
+ [BIP155](https://github.com/bitcoin/bips/blob/master/bip-0155.mediawiki).
+ Version 2 hidden services are still fully supported by Bitcoin Core, but the
+ Tor network will start
+ [deprecating](https://blog.torproject.org/v2-deprecation-timeline) them in the
+ coming months. (#19954)
+
+- The Tor onion service that is automatically created by setting the
+ `-listenonion` configuration parameter will now be created as a Tor v3 service
+ instead of Tor v2. The private key that was used for Tor v2 (if any) will be
+ left untouched in the `onion_private_key` file in the data directory (see
+ `-datadir`) and can be removed if not needed. Bitcoin Core will no longer
+ attempt to read it. The private key for the Tor v3 service will be saved in a
+ file named `onion_v3_private_key`. To use the deprecated Tor v2 service (not
+ recommended), the `onion_private_key` can be copied over
+ `onion_v3_private_key`, e.g.
+ `cp -f onion_private_key onion_v3_private_key`. (#19954)
+
+- The client writes a file (`anchors.dat`) at shutdown with the network addresses
+ of the node’s two outbound block-relay-only peers (so called "anchors"). The
+ next time the node starts, it reads this file and attempts to reconnect to those
+ same two peers. This prevents an attacker from using node restarts to trigger a
+ complete change in peers, which would be something they could use as part of an
+ eclipse attack. (#17428)
+
+- This release adds support for serving
+ [BIP157](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki) compact
+ filters to peers on the network when enabled using
+ `-blockfilterindex=1 -peerblockfilters=1`. (#16442)
+
+- This release adds support for signets
+ ([BIP325](https://github.com/bitcoin/bips/blob/master/bip-0325.mediawiki)) in
+ addition to the existing mainnet, testnet, and regtest networks. Signets are
+ centrally-controlled test networks, allowing them to be more predictable
+ test environments than the older testnet. One public signet is maintained, and
+ selectable using `-signet`. It is also possible to create personal signets.
+ (#18267).
+
+- This release implements
+ [BIP339](https://github.com/bitcoin/bips/blob/master/bip-0339.mediawiki)
+ wtxid relay. When negotiated, transactions are announced using their wtxid
+ instead of their txid. (#18044).
+
+- This release implements the proposed Taproot consensus rules
+ ([BIP341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki) and
+ [BIP342](https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki)),
+ without activation on mainnet. Experimentation with Taproot can be done on
+ signet, where its rules are already active. (#19553)
+
+Updated RPCs
+------------
+
+- The `getpeerinfo` RPC has a new `network` field that provides the type of
+ network ("ipv4", "ipv6", or "onion") that the peer connected through. (#20002)
+
+- The `getpeerinfo` RPC now has additional `last_block` and `last_transaction`
+ fields that return the UNIX epoch time of the last block and the last *valid*
+ transaction received from each peer. (#19731)
+
+- `getnetworkinfo` now returns two new fields, `connections_in` and
+ `connections_out`, that provide the number of inbound and outbound peer
+ connections. These new fields are in addition to the existing `connections`
+ field, which returns the total number of peer connections. (#19405)
+
+- Exposed transaction version numbers are now treated as unsigned 32-bit
+ integers instead of signed 32-bit integers. This matches their treatment in
+ consensus logic. Versions greater than 2 continue to be non-standard
+ (matching previous behavior of smaller than 1 or greater than 2 being
+ non-standard). Note that this includes the `joinpsbt` command, which combines
+ partially-signed transactions by selecting the highest version number.
+ (#16525)
+
+- `getmempoolinfo` now returns an additional `unbroadcastcount` field. The
+ mempool tracks locally submitted transactions until their initial broadcast
+ is acknowledged by a peer. This field returns the count of transactions
+ waiting for acknowledgement.
+
+- Mempool RPCs such as `getmempoolentry` and `getrawmempool` with
+ `verbose=true` now return an additional `unbroadcast` field. This indicates
+ whether initial broadcast of the transaction has been acknowledged by a
+ peer. `getmempoolancestors` and `getmempooldescendants` are also updated.
+
+- The `getpeerinfo` RPC no longer returns the `banscore` field unless the configuration
+ option `-deprecatedrpc=banscore` is used. The `banscore` field will be fully
+ removed in the next major release. (#19469)
+
+- The `testmempoolaccept` RPC returns `vsize` and a `fees` object with the `base` fee
+ if the transaction would pass validation. (#19940)
+
+- The `getpeerinfo` RPC now returns a `connection_type` field. This indicates
+ the type of connection established with the peer. It will return one of six
+ options. For more information, see the `getpeerinfo` help documentation.
+ (#19725)
+
+- The `getpeerinfo` RPC no longer returns the `addnode` field by default. This
+ field will be fully removed in the next major release. It can be accessed
+ with the configuration option `-deprecatedrpc=getpeerinfo_addnode`. However,
+ it is recommended to instead use the `connection_type` field (it will return
+ `manual` when addnode is true). (#19725)
+
+- The `getpeerinfo` RPC no longer returns the `whitelisted` field by default.
+ This field will be fully removed in the next major release. It can be accessed
+ with the configuration option `-deprecatedrpc=getpeerinfo_whitelisted`. However,
+ it is recommended to instead use the `permissions` field to understand if specific
+ privileges have been granted to the peer. (#19770)
+
+- The `walletcreatefundedpsbt` RPC call will now fail with
+ `Insufficient funds` when inputs are manually selected but are not enough to cover
+ the outputs and fee. Additional inputs can automatically be added through the
+ new `add_inputs` option. (#16377)
+
+- The `fundrawtransaction` RPC now supports `add_inputs` option that when `false`
+ prevents adding more inputs if necessary and consequently the RPC fails.
+
+Changes to Wallet or GUI related RPCs can be found in the GUI or Wallet section below.
+
+New RPCs
+--------
+
+- The `getindexinfo` RPC returns the actively running indices of the node,
+ including their current sync status and height. It also accepts an `index_name`
+ to specify returning the status of that index only. (#19550)
+
+Build System
+------------
+
+Updated settings
+----------------
+
+- The same ZeroMQ notification (e.g. `-zmqpubhashtx=address`) can now be
+ specified multiple times to publish the same notification to different ZeroMQ
+ sockets. (#18309)
+
+- The `-banscore` configuration option, which modified the default threshold for
+ disconnecting and discouraging misbehaving peers, has been removed as part of
+ changes in 0.20.1 and in this release to the handling of misbehaving peers.
+ Refer to "Changes regarding misbehaving peers" in the 0.20.1 release notes for
+ details. (#19464)
+
+- The `-debug=db` logging category, which was deprecated in 0.20 and replaced by
+ `-debug=walletdb` to distinguish it from `coindb`, has been removed. (#19202)
+
+- A `download` permission has been extracted from the `noban` permission. For
+ compatibility, `noban` implies the `download` permission, but this may change
+ in future releases. Refer to the help of the affected settings `-whitebind`
+ and `-whitelist` for more details. (#19191)
+
+- Netmasks that contain 1-bits after 0-bits (the 1-bits are not contiguous on
+ the left side, e.g. 255.0.255.255) are no longer accepted. They are invalid
+ according to RFC 4632. Netmasks are used in the `-rpcallowip` and `-whitelist`
+ configuration options and in the `setban` RPC. (#19628)
+
+- The `-blocksonly` setting now completely disables fee estimation. (#18766)
+
+Changes to Wallet or GUI related settings can be found in the GUI or Wallet section below.
+
+Tools and Utilities
+-------------------
+
+- A new `bitcoin-cli -netinfo` command provides a network peer connections
+ dashboard that displays data from the `getpeerinfo` and `getnetworkinfo` RPCs
+ in a human-readable format. An optional integer argument from `0` to `4` may
+ be passed to see increasing levels of detail. (#19643)
+
+- A new `bitcoin-cli -generate` command, equivalent to RPC `generatenewaddress`
+ followed by `generatetoaddress`, can generate blocks for command line testing
+ purposes. This is a client-side version of the former `generate` RPC. See the
+ help for details. (#19133)
+
+- The `bitcoin-cli -getinfo` command now displays the wallet name and balance for
+ each of the loaded wallets when more than one is loaded (e.g. in multiwallet
+ mode) and a wallet is not specified with `-rpcwallet`. (#18594)
+
+- The `connections` field of `bitcoin-cli -getinfo` is now expanded to return a JSON
+ object with `in`, `out` and `total` numbers of peer connections. It previously
+ returned a single integer value for the total number of peer connections. (#19405)
+
+New settings
+------------
+
+- The `startupnotify` option is used to specify a command to
+ execute when Bitcoin Core has finished with its startup
+ sequence. (#15367)
+
+Wallet
+------
+
+- Backwards compatibility has been dropped for two `getaddressinfo` RPC
+ deprecations, as notified in the 0.20 release notes. The deprecated `label`
+ field has been removed as well as the deprecated `labels` behavior of
+ returning a JSON object containing `name` and `purpose` key-value pairs. Since
+ 0.20, the `labels` field returns a JSON array of label names. (#19200)
+
+- To improve wallet privacy, the frequency of wallet rebroadcast attempts is
+ reduced from approximately once every 15 minutes to once every 12-36 hours.
+ To maintain a similar level of guarantee for initial broadcast of wallet
+ transactions, the mempool tracks these transactions as a part of the newly
+ introduced unbroadcast set. See the "P2P and network changes" section for
+ more information on the unbroadcast set. (#18038)
+
+- The `sendtoaddress` and `sendmany` RPCs accept an optional `verbose=True`
+ argument to also return the fee reason about the sent tx. (#19501)
+
+- The wallet can create a transaction without change even when the keypool is
+ empty. Previously it failed. (#17219)
+
+- The `-salvagewallet` startup option has been removed. A new `salvage` command
+ has been added to the `bitcoin-wallet` tool which performs the salvage
+ operations that `-salvagewallet` did. (#18918)
+
+- A new configuration flag `-maxapsfee` has been added, which sets the max
+ allowed avoid partial spends (APS) fee. It defaults to 0 (i.e. fee is the
+ same with and without APS). Setting it to -1 will disable APS, unless
+ `-avoidpartialspends` is set. (#14582)
+
+- The wallet will now avoid partial spends (APS) by default, if this does not
+ result in a difference in fees compared to the non-APS variant. The allowed
+ fee threshold can be adjusted using the new `-maxapsfee` configuration
+ option. (#14582)
+
+- The `createwallet`, `loadwallet`, and `unloadwallet` RPCs now accept
+ `load_on_startup` options to modify the settings list. Unless these options
+ are explicitly set to true or false, the list is not modified, so the RPC
+ methods remain backwards compatible. (#15937)
+
+- A new `send` RPC with similar syntax to `walletcreatefundedpsbt`, including
+ support for coin selection and a custom fee rate, is added. The `send` RPC is
+ experimental and may change in subsequent releases. (#16378)
+
+- The `estimate_mode` parameter is now case-insensitive in the `bumpfee`,
+ `fundrawtransaction`, `sendmany`, `sendtoaddress`, `send` and
+ `walletcreatefundedpsbt` RPCs. (#11413)
+
+- The `bumpfee` RPC now uses `conf_target` rather than `confTarget` in the
+ options. (#11413)
+
+- `fundrawtransaction` and `walletcreatefundedpsbt` when used with the
+ `lockUnspents` argument now lock manually selected coins, in addition to
+ automatically selected coins. Note that locked coins are never used in
+ automatic coin selection, but can still be manually selected. (#18244)
+
+- The `-zapwallettxes` startup option has been removed and its functionality
+ removed from the wallet. This option was originally intended to allow for
+ rescuing wallets which were affected by a malleability attack. More recently,
+ it has been used in the fee bumping of transactions that did not signal RBF.
+ This functionality has been superseded with the abandon transaction feature. (#19671)
+
+- The error code when no wallet is loaded, but a wallet RPC is called, has been
+ changed from `-32601` (method not found) to `-18` (wallet not found).
+ (#20101)
+
+### Automatic wallet creation removed
+
+Bitcoin Core will no longer automatically create new wallets on startup. It will
+load existing wallets specified by `-wallet` options on the command line or in
+`bitcoin.conf` or `settings.json` files. And by default it will also load a
+top-level unnamed ("") wallet. However, if specified wallets don't exist,
+Bitcoin Core will now just log warnings instead of creating new wallets with
+new keys and addresses like previous releases did.
+
+New wallets can be created through the GUI (which has a more prominent create
+wallet option), through the `bitcoin-cli createwallet` or `bitcoin-wallet
+create` commands, or the `createwallet` RPC. (#15454, #20186)
+
+### Experimental Descriptor Wallets
+
+Please note that Descriptor Wallets are still experimental and not all expected functionality
+is available. Additionally there may be some bugs and current functions may change in the future.
+Bugs and missing functionality can be reported to the [issue tracker](https://github.com/bitcoin/bitcoin/issues).
+
+0.21 introduces a new type of wallet - Descriptor Wallets. Descriptor Wallets store
+scriptPubKey information using output descriptors. This is in contrast to the Legacy Wallet
+structure where keys are used to implicitly generate scriptPubKeys and addresses. Because of this
+shift to being script based instead of key based, many of the confusing things that Legacy
+Wallets do are not possible with Descriptor Wallets. Descriptor Wallets use a definition
+of "mine" for scripts which is simpler and more intuitive than that used by Legacy Wallets.
+Descriptor Wallets also uses different semantics for watch-only things and imports.
+
+As Descriptor Wallets are a new type of wallet, their introduction does not affect existing wallets.
+Users who already have a Bitcoin Core wallet can continue to use it as they did before without
+any change in behavior. Newly created Legacy Wallets (which remains the default type of wallet) will
+behave as they did in previous versions of Bitcoin Core.
+
+The differences between Descriptor Wallets and Legacy Wallets are largely limited to non user facing
+things. They are intended to behave similarly except for the import/export and watchonly functionality
+as described below.
+
+#### Creating Descriptor Wallets
+
+Descriptor wallets are not the default type of wallet.
+
+In the GUI, a checkbox has been added to the Create Wallet Dialog to indicate that a
+Descriptor Wallet should be created. And a `descriptors` option has been added to `createwallet` RPC.
+Setting `descriptors` to `true` will create a Descriptor Wallet instead of a Legacy Wallet.
+
+Without those options being set, a Legacy Wallet will be created instead.
+
+#### `IsMine` Semantics
+
+`IsMine` refers to the function used to determine whether a script belongs to the wallet.
+This is used to determine whether an output belongs to the wallet. `IsMine` in Legacy Wallets
+returns true if the wallet would be able to sign an input that spends an output with that script.
+Since keys can be involved in a variety of different scripts, this definition for `IsMine` can
+lead to many unexpected scripts being considered part of the wallet.
+
+With Descriptor Wallets, descriptors explicitly specify the set of scripts that are owned by
+the wallet. Since descriptors are deterministic and easily enumerable, users will know exactly
+what scripts the wallet will consider to belong to it. Additionally the implementation of `IsMine`
+in Descriptor Wallets is far simpler than for Legacy Wallets. Notably, in Legacy Wallets, `IsMine`
+allowed for users to take one type of address (e.g. P2PKH), mutate it into another address type
+(e.g. P2WPKH), and the wallet would still detect outputs sending to the new address type
+even without that address being requested from the wallet. Descriptor Wallets do not
+allow for this and will only watch for the addresses that were explicitly requested from the wallet.
+
+These changes to `IsMine` will make it easier to reason about what scripts the wallet will
+actually be watching for in outputs. However for the vast majority of users, this change is
+largely transparent and will not have noticeable effect.
+
+#### Imports and Exports
+
+In Legacy Wallets, raw scripts and keys could be imported to the wallet. Those imported scripts
+and keys are treated separately from the keys generated by the wallet. This complicates the `IsMine`
+logic as it has to distinguish between spendable and watchonly.
+
+Descriptor Wallets handle importing scripts and keys differently. Only complete descriptors can be
+imported. These descriptors are then added to the wallet as if it were a descriptor generated by
+the wallet itself. This simplifies the `IsMine` logic so that it no longer has to distinguish
+between spendable and watchonly. As such, the watchonly model for Descriptor Wallets is also
+different and described in more detail in the next section.
+
+To import into a Descriptor Wallet, a new `importdescriptors` RPC has been added that uses a syntax
+similar to that of `importmulti`.
+
+As Legacy Wallets and Descriptor Wallets use different mechanisms for storing and importing scripts and keys
+the existing import RPCs have been disabled for descriptor wallets.
+New export RPCs for Descriptor Wallets have not yet been added.
+
+The following RPCs are disabled for Descriptor Wallets:
+
+* `importprivkey`
+* `importpubkey`
+* `importaddress`
+* `importwallet`
+* `dumpprivkey`
+* `dumpwallet`
+* `importmulti`
+* `addmultisigaddress`
+* `sethdseed`
+
+#### Watchonly Wallets
+
+A Legacy Wallet contains both private keys and scripts that were being watched.
+Those watched scripts would not contribute to your normal balance. In order to see the watchonly
+balance and to use watchonly things in transactions, an `include_watchonly` option was added
+to many RPCs that would allow users to do that. However it is easy to forget to include this option.
+
+Descriptor Wallets move to a per-wallet watchonly model. Instead an entire wallet is considered to be
+watchonly depending on whether it was created with private keys disabled. This eliminates the need
+to distinguish between things that are watchonly and things that are not within a wallet itself.
+
+This change does have a caveat. If a Descriptor Wallet with private keys *enabled* has
+a multiple key descriptor without all of the private keys (e.g. `multi(...)` with only one private key),
+then the wallet will fail to sign and broadcast transactions. Such wallets would need to use the PSBT
+workflow but the typical GUI Send, `sendtoaddress`, etc. workflows would still be available, just
+non-functional.
+
+This issue is worsened if the wallet contains both single key (e.g. `wpkh(...)`) descriptors and such
+multiple key descriptors as some transactions could be signed and broadcast and others not. This is
+due to some transactions containing only single key inputs, while others would contain both single
+key and multiple key inputs, depending on which are available and how the coin selection algorithm
+selects inputs. However this is not considered to be a supported use case; multisigs
+should be in their own wallets which do not already have descriptors. Although users cannot export
+descriptors with private keys for now as explained earlier.
+
+#### BIP 44/49/84 Support
+
+The change to using descriptors changes the default derivation paths used by Bitcoin Core
+to adhere to BIP 44/49/84. Descriptors with different derivation paths can be imported without
+issue.
+
+#### SQLite Database Backend
+
+Descriptor wallets use SQLite for the wallet file instead of the Berkeley DB used in legacy wallets.
+This will break compatibility with any existing tooling that operates on wallets, however compatibility
+was already being broken by the move to descriptors.
+
+### Wallet RPC changes
+
+- The `upgradewallet` RPC replaces the `-upgradewallet` command line option.
+ (#15761)
+
+- The `settxfee` RPC will fail if the fee was set higher than the `-maxtxfee`
+ command line setting. The wallet will already fail to create transactions
+ with fees higher than `-maxtxfee`. (#18467)
+
+- A new `fee_rate` parameter/option denominated in satoshis per vbyte (sat/vB)
+ is introduced to the `sendtoaddress`, `sendmany`, `fundrawtransaction` and
+ `walletcreatefundedpsbt` RPCs as well as to the experimental new `send`
+ RPC. The legacy `feeRate` option in `fundrawtransaction` and
+ `walletcreatefundedpsbt` still exists for setting a fee rate in BTC per 1,000
+ vbytes (BTC/kvB), but it is expected to be deprecated soon to avoid
+ confusion. For these RPCs, the fee rate error message is updated from BTC/kB
+ to sat/vB and the help documentation in BTC/kB is updated to BTC/kvB. The
+ `send` and `sendtoaddress` RPC examples are updated to aid users in creating
+ transactions with explicit fee rates. (#20305, #11413)
+
+- The `bumpfee` RPC `fee_rate` option is changed from BTC/kvB to sat/vB and the
+ help documentation is updated. Users are warned that this is a breaking API
+ change, but it should be relatively benign: the large (100,000 times)
+ difference between BTC/kvB and sat/vB units means that a transaction with a
+ fee rate mistakenly calculated in BTC/kvB rather than sat/vB should raise an
+ error due to the fee rate being set too low. In the worst case, the
+ transaction may send at 1 sat/vB, but as Replace-by-Fee (BIP125 RBF) is active
+ by default when an explicit fee rate is used, the transaction fee can be
+ bumped. (#20305)
+
+GUI changes
+-----------
+
+- Wallets created or loaded in the GUI will now be automatically loaded on
+ startup, so they don't need to be manually reloaded next time Bitcoin Core is
+ started. The list of wallets to load on startup is stored in
+ `\<datadir\>/settings.json` and augments any command line or `bitcoin.conf`
+ `-wallet=` settings that specify more wallets to load. Wallets that are
+ unloaded in the GUI get removed from the settings list so they won't load
+ again automatically next startup. (#19754)
+
+- The GUI Peers window no longer displays a "Ban Score" field. This is part of
+ changes in 0.20.1 and in this release to the handling of misbehaving
+ peers. Refer to "Changes regarding misbehaving peers" in the 0.20.1 release
+ notes for details. (#19512)
+
+Low-level changes
+=================
+
+RPC
+---
+
+- To make RPC `sendtoaddress` more consistent with `sendmany` the following error
+ `sendtoaddress` codes were changed from `-4` to `-6`:
+ - Insufficient funds
+ - Fee estimation failed
+ - Transaction has too long of a mempool chain
+
+- The `sendrawtransaction` error code for exceeding `maxfeerate` has been changed from
+ `-26` to `-25`. The error string has been changed from "absurdly-high-fee" to
+ "Fee exceeds maximum configured by user (e.g. -maxtxfee, maxfeerate)." The
+ `testmempoolaccept` RPC returns `max-fee-exceeded` rather than `absurdly-high-fee`
+ as the `reject-reason`. (#19339)
+
+- To make wallet and rawtransaction RPCs more consistent, the error message for
+ exceeding maximum feerate has been changed to "Fee exceeds maximum configured by user
+ (e.g. -maxtxfee, maxfeerate)." (#19339)
+
+Tests
+-----
+
+- The BIP 325 default signet can be enabled by the `-chain=signet` or `-signet`
+ setting. The settings `-signetchallenge` and `-signetseednode` allow
+ enabling a custom signet.
+
+- The `generateblock` RPC allows testers using regtest mode to
+ generate blocks that consist of a custom set of transactions. (#17693)
+
+0.21.0 change log
+=================
+
+### Consensus
+- #18267 BIP-325: Signet (kallewoof)
+- #20016 uint256: 1 is a constant (ajtowns)
+- #20006 Fix misleading error message: Clean stack rule (sanket1729)
+- #19953 Implement BIP 340-342 validation (Schnorr/taproot/tapscript) (sipa)
+- #20169 Taproot follow-up: Make ComputeEntrySchnorr and ComputeEntryECDSA const to clarify contract (practicalswift)
+
+### Policy
+- #18766 Disable fee estimation in blocksonly mode (darosior)
+- #19630 Cleanup fee estimation code (darosior)
+- #20165 Only relay Taproot spends if next block has it active (sipa)
+
+### Mining
+- #17946 Fix GBT: Restore "!segwit" and "csv" to "rules" key (luke-jr)
+
+### Privacy
+- #16432 Add privacy to the Overview page (hebasto)
+- #18861 Do not answer GETDATA for to-be-announced tx (sipa)
+- #18038 Mempool tracks locally submitted transactions to improve wallet privacy (amitiuttarwar)
+- #19109 Only allow getdata of recently announced invs (sipa)
+
+### Block and transaction handling
+- #17737 Add ChainstateManager, remove BlockManager global (jamesob)
+- #18960 indexes: Add compact block filter headers cache (jnewbery)
+- #13204 Faster sigcache nonce (JeremyRubin)
+- #19088 Use std::chrono throughout some validation functions (fanquake)
+- #19142 Make VerifyDB level 4 interruptible (MarcoFalke)
+- #17994 Flush undo files after last block write (kallewoof)
+- #18990 log: Properly log txs rejected from mempool (MarcoFalke)
+- #18984 Remove unnecessary input blockfile SetPos (dgenr8)
+- #19526 log: Avoid treating remote misbehvior as local system error (MarcoFalke)
+- #18044 Use wtxid for transaction relay (sdaftuar)
+- #18637 coins: allow cache resize after init (jamesob)
+- #19854 Avoid locking CTxMemPool::cs recursively in simple cases (hebasto)
+- #19478 Remove CTxMempool::mapLinks data structure member (JeremyRubin)
+- #19927 Reduce direct `g_chainman` usage (dongcarl)
+- #19898 log: print unexpected version warning in validation log category (n-thumann)
+- #20036 signet: Add assumed values for default signet (MarcoFalke)
+- #20048 chainparams: do not log signet startup messages for other chains (jonatack)
+- #19339 re-delegate absurd fee checking from mempool to clients (glozow)
+- #20035 signet: Fix uninitialized read in validation (MarcoFalke)
+- #20157 Bugfix: chainparams: Add missing (always enabled) Taproot deployment for Signet (luke-jr)
+- #20263 Update assumed chain params (MarcoFalke)
+- #20372 Avoid signed integer overflow when loading a mempool.dat file with a malformed time field (practicalswift)
+- #18621 script: Disallow silent bool -> cscript conversion (MarcoFalke)
+- #18612, #18732 script: Remove undocumented and unused operator+ (MarcoFalke)
+- #19317 Add a left-justified width field to `log2_work` component for a uniform debug.log output (jamesgmorgan)
+
+### P2P protocol and network code
+- #18544 Limit BIP37 filter lifespan (active between `filterload`..`filterclear`) (theStack)
+- #18806 Remove is{Empty,Full} flags from CBloomFilter, clarify CVE fix (theStack)
+- #18512 Improve asmap checks and add sanity check (sipa)
+- #18877 Serve cfcheckpt requests (jnewbery)
+- #18895 Unbroadcast followups: rpcs, nLastResend, mempool sanity check (gzhao408)
+- #19010 net processing: Add support for `getcfheaders` (jnewbery)
+- #16939 Delay querying DNS seeds (ajtowns)
+- #18807 Unbroadcast follow-ups (amitiuttarwar)
+- #19044 Add support for getcfilters (jnewbery)
+- #19084 improve code documentation for dns seed behaviour (ajtowns)
+- #19260 disconnect peers that send filterclear + update existing filter msg disconnect logic (gzhao408)
+- #19284 Add seed.bitcoin.wiz.biz to DNS seeds (wiz)
+- #19322 split PushInventory() (jnewbery)
+- #19204 Reduce inv traffic during IBD (MarcoFalke)
+- #19470 banlist: log post-swept banlist size at startup (fanquake)
+- #19191 Extract download permission from noban (MarcoFalke)
+- #14033 Drop `CADDR_TIME_VERSION` checks now that `MIN_PEER_PROTO_VERSION` is greater (Empact)
+- #19464 net, rpc: remove -banscore option, deprecate banscore in getpeerinfo (jonatack)
+- #19514 [net/net processing] check banman pointer before dereferencing (jnewbery)
+- #19512 banscore updates to gui, tests, release notes (jonatack)
+- #19360 improve encapsulation of CNetAddr (vasild)
+- #19217 disambiguate block-relay-only variable names from blocksonly variables (glowang)
+- #19473 Add -networkactive option (hebasto)
+- #19472 [net processing] Reduce `cs_main` scope in MaybeDiscourageAndDisconnect() (jnewbery)
+- #19583 clean up Misbehaving() (jnewbery)
+- #19534 save the network type explicitly in CNetAddr (vasild)
+- #19569 Enable fetching of orphan parents from wtxid peers (sipa)
+- #18991 Cache responses to GETADDR to prevent topology leaks (naumenkogs)
+- #19596 Deduplicate parent txid loop of requested transactions and missing parents of orphan transactions (sdaftuar)
+- #19316 Cleanup logic around connection types (amitiuttarwar)
+- #19070 Signal support for compact block filters with `NODE_COMPACT_FILTERS` (jnewbery)
+- #19705 Shrink CAddress from 48 to 40 bytes on x64 (vasild)
+- #19704 Move ProcessMessage() to PeerLogicValidation (jnewbery)
+- #19628 Change CNetAddr::ip to have flexible size (vasild)
+- #19797 Remove old check for 3-byte shifted IP addresses from pre-0.2.9 nodes (#19797)
+- #19607 Add Peer struct for per-peer data in net processing (jnewbery)
+- #19857 improve nLastBlockTime and nLastTXTime documentation (jonatack)
+- #19724 Cleanup connection types- followups (amitiuttarwar)
+- #19670 Protect localhost and block-relay-only peers from eviction (sdaftuar)
+- #19728 Increase the ip address relay branching factor for unreachable networks (sipa)
+- #19879 Miscellaneous wtxid followups (amitiuttarwar)
+- #19697 Improvements on ADDR caching (naumenkogs)
+- #17785 Unify Send and Receive protocol versions (hebasto)
+- #19845 CNetAddr: add support to (un)serialize as ADDRv2 (vasild)
+- #19107 Move all header verification into the network layer, extend logging (troygiorshev)
+- #20003 Exit with error message if -proxy is specified without arguments (instead of continuing without proxy server) (practicalswift)
+- #19991 Use alternative port for incoming Tor connections (hebasto)
+- #19723 Ignore unknown messages before VERACK (sdaftuar)
+- #19954 Complete the BIP155 implementation and upgrade to TORv3 (vasild)
+- #20119 BIP155 follow-ups (sipa)
+- #19988 Overhaul transaction request logic (sipa)
+- #17428 Try to preserve outbound block-relay-only connections during restart (hebasto)
+- #19911 Guard `vRecvGetData` with `cs_vRecv` and `orphan_work_set` with `g_cs_orphans` (narula)
+- #19753 Don't add AlreadyHave transactions to recentRejects (troygiorshev)
+- #20187 Test-before-evict bugfix and improvements for block-relay-only peers (sdaftuar)
+- #20237 Hardcoded seeds update for 0.21 (laanwj)
+- #20212 Fix output of peer address in version message (vasild)
+- #20284 Ensure old versions don't parse peers.dat (vasild)
+- #20405 Avoid calculating onion address checksum when version is not 3 (lontivero)
+- #20564 Don't send 'sendaddrv2' to pre-70016 software, and send before 'verack' (sipa)
+- #20660 Move signet onion seed from v2 to v3 (Sjors)
+
+### Wallet
+- #18262 Exit selection when `best_waste` is 0 (achow101)
+- #17824 Prefer full destination groups in coin selection (fjahr)
+- #17219 Allow transaction without change if keypool is empty (Sjors)
+- #15761 Replace -upgradewallet startup option with upgradewallet RPC (achow101)
+- #18671 Add BlockUntilSyncedToCurrentChain to dumpwallet (MarcoFalke)
+- #16528 Native Descriptor Wallets using DescriptorScriptPubKeyMan (achow101)
+- #18777 Recommend absolute path for dumpwallet (MarcoFalke)
+- #16426 Reverse `cs_main`, `cs_wallet` lock order and reduce `cs_main` locking (ariard)
+- #18699 Avoid translating RPC errors (MarcoFalke)
+- #18782 Make sure no DescriptorScriptPubKeyMan or WalletDescriptor members are left uninitialized after construction (practicalswift)
+- #9381 Remove CWalletTx merging logic from AddToWallet (ryanofsky)
+- #16946 Include a checksum of encrypted private keys (achow101)
+- #17681 Keep inactive seeds after sethdseed and derive keys from them as needed (achow101)
+- #18918 Move salvagewallet into wallettool (achow101)
+- #14988 Fix for confirmed column in csv export for payment to self transactions (benthecarman)
+- #18275 Error if an explicit fee rate was given but the needed fee rate differed (kallewoof)
+- #19054 Skip hdKeypath of 'm' when determining inactive hd seeds (achow101)
+- #17938 Disallow automatic conversion between disparate hash types (Empact)
+- #19237 Check size after unserializing a pubkey (elichai)
+- #11413 sendtoaddress/sendmany: Add explicit feerate option (kallewoof)
+- #18850 Fix ZapSelectTx to sync wallet spends (bvbfan)
+- #18923 Never schedule MaybeCompactWalletDB when `-flushwallet` is off (MarcoFalke)
+- #19441 walletdb: Don't reinitialize desc cache with multiple cache entries (achow101)
+- #18907 walletdb: Don't remove database transaction logs and instead error (achow101)
+- #19334 Introduce WalletDatabase abstract class (achow101)
+- #19335 Cleanup and separate BerkeleyDatabase and BerkeleyBatch (achow101)
+- #19102 Introduce and use DummyDatabase instead of dummy BerkeleyDatabase (achow101)
+- #19568 Wallet should not override signing errors (fjahr)
+- #17204 Do not turn `OP_1NEGATE` in scriptSig into `0x0181` in signing code (sipa) (meshcollider)
+- #19457 Cleanup wallettool salvage and walletdb extraneous declarations (achow101)
+- #15937 Add loadwallet and createwallet `load_on_startup` options (ryanofsky)
+- #16841 Replace GetScriptForWitness with GetScriptForDestination (meshcollider)
+- #14582 always do avoid partial spends if fees are within a specified range (kallewoof)
+- #19743 -maxapsfee follow-up (kallewoof)
+- #19289 GetWalletTx and IsMine require `cs_wallet` lock (promag)
+- #19671 Remove -zapwallettxes (achow101)
+- #19805 Avoid deserializing unused records when salvaging (achow101)
+- #19754 wallet, gui: Reload previously loaded wallets on startup (achow101)
+- #19738 Avoid multiple BerkeleyBatch in DelAddressBook (promag)
+- #19919 bugfix: make LoadWallet assigns status always (AkioNak)
+- #16378 The ultimate send RPC (Sjors)
+- #15454 Remove the automatic creation and loading of the default wallet (achow101)
+- #19501 `send*` RPCs in the wallet returns the "fee reason" (stackman27)
+- #20130 Remove db mode string (S3RK)
+- #19077 Add sqlite as an alternative wallet database and use it for new descriptor wallets (achow101)
+- #20125 Expose database format in getwalletinfo (promag)
+- #20198 Show name, format and if uses descriptors in bitcoin-wallet tool (jonasschnelli)
+- #20216 Fix buffer over-read in SQLite file magic check (theStack)
+- #20186 Make -wallet setting not create wallets (ryanofsky)
+- #20230 Fix bug when just created encrypted wallet cannot get address (hebasto)
+- #20282 Change `upgradewallet` return type to be an object (jnewbery)
+- #20220 Explicit fee rate follow-ups/fixes for 0.21 (jonatack)
+- #20199 Ignore (but warn) on duplicate -wallet parameters (jonasschnelli)
+- #20324 Set DatabaseStatus::SUCCESS in MakeSQLiteDatabase (MarcoFalke)
+- #20266 Fix change detection of imported internal descriptors (achow101)
+- #20153 Do not import a descriptor with hardened derivations into a watch-only wallet (S3RK)
+- #20344 Fix scanning progress calculation for single block range (theStack)
+- #19502 Bugfix: Wallet: Soft-fail exceptions within ListWalletDir file checks (luke-jr)
+- #20378 Fix potential division by 0 in WalletLogPrintf (jonasschnelli)
+- #18836 Upgradewallet fixes and additional tests (achow101)
+- #20139 Do not return warnings from UpgradeWallet() (stackman27)
+- #20305 Introduce `fee_rate` sat/vB param/option (jonatack)
+- #20426 Allow zero-fee fundrawtransaction/walletcreatefundedpsbt and other fixes (jonatack)
+- #20573 wallet, bugfix: allow send with string `fee_rate` amounts (jonatack)
+
+### RPC and other APIs
+- #18574 cli: Call getbalances.ismine.trusted instead of getwalletinfo.balance (jonatack)
+- #17693 Add `generateblock` to mine a custom set of transactions (andrewtoth)
+- #18495 Remove deprecated migration code (vasild)
+- #18493 Remove deprecated "size" from mempool txs (vasild)
+- #18467 Improve documentation and return value of settxfee (fjahr)
+- #18607 Fix named arguments in documentation (MarcoFalke)
+- #17831 doc: Fix and extend getblockstats examples (asoltys)
+- #18785 Prevent valgrind false positive in `rest_blockhash_by_height` (ryanofsky)
+- #18999 log: Remove "No rpcpassword set" from logs (MarcoFalke)
+- #19006 Avoid crash when `g_thread_http` was never started (MarcoFalke)
+- #18594 cli: Display multiwallet balances in -getinfo (jonatack)
+- #19056 Make gettxoutsetinfo/GetUTXOStats interruptible (MarcoFalke)
+- #19112 Remove special case for unknown service flags (MarcoFalke)
+- #18826 Expose txinwitness for coinbase in JSON form from RPC (rvagg)
+- #19282 Rephrase generatetoaddress help, and use `PACKAGE_NAME` (luke-jr)
+- #16377 don't automatically append inputs in walletcreatefundedpsbt (Sjors)
+- #19200 Remove deprecated getaddressinfo fields (jonatack)
+- #19133 rpc, cli, test: add bitcoin-cli -generate command (jonatack)
+- #19469 Deprecate banscore field in getpeerinfo (jonatack)
+- #16525 Dump transaction version as an unsigned integer in RPC/TxToUniv (TheBlueMatt)
+- #19555 Deduplicate WriteHDKeypath() used in decodepsbt (theStack)
+- #19589 Avoid useless mempool query in gettxoutproof (MarcoFalke)
+- #19585 RPCResult Type of MempoolEntryDescription should be OBJ (stylesuxx)
+- #19634 Document getwalletinfo's `unlocked_until` field as optional (justinmoon)
+- #19658 Allow RPC to fetch all addrman records and add records to addrman (jnewbery)
+- #19696 Fix addnode remove command error (fjahr)
+- #18654 Separate bumpfee's psbt creation function into psbtbumpfee (achow101)
+- #19655 Catch listsinceblock `target_confirmations` exceeding block count (adaminsky)
+- #19644 Document returned error fields as optional if applicable (theStack)
+- #19455 rpc generate: print useful help and error message (jonatack)
+- #19550 Add listindices RPC (fjahr)
+- #19169 Validate provided keys for `query_options` parameter in listunspent (PastaPastaPasta)
+- #18244 fundrawtransaction and walletcreatefundedpsbt also lock manually selected coins (Sjors)
+- #14687 zmq: Enable TCP keepalive (mruddy)
+- #19405 Add network in/out connections to `getnetworkinfo` and `-getinfo` (jonatack)
+- #19878 rawtransaction: Fix argument in combinerawtransaction help message (pinheadmz)
+- #19940 Return fee and vsize from testmempoolaccept (gzhao408)
+- #13686 zmq: Small cleanups in the ZMQ code (domob1812)
+- #19386, #19528, #19717, #19849, #19994 Assert that RPCArg names are equal to CRPCCommand ones (MarcoFalke)
+- #19725 Add connection type to getpeerinfo, improve logs (amitiuttarwar)
+- #19969 Send RPC bug fix and touch-ups (Sjors)
+- #18309 zmq: Add support to listen on multiple interfaces (n-thumann)
+- #20055 Set HTTP Content-Type in bitcoin-cli (laanwj)
+- #19956 Improve invalid vout value rpc error message (n1rna)
+- #20101 Change no wallet loaded message to be clearer (achow101)
+- #19998 Add `via_tor` to `getpeerinfo` output (hebasto)
+- #19770 getpeerinfo: Deprecate "whitelisted" field (replaced by "permissions") (luke-jr)
+- #20120 net, rpc, test, bugfix: update GetNetworkName, GetNetworksInfo, regression tests (jonatack)
+- #20595 Improve heuristic hex transaction decoding (sipa)
+- #20731 Add missing description of vout in getrawtransaction help text (benthecarman)
+- #19328 Add gettxoutsetinfo `hash_type` option (fjahr)
+- #19731 Expose nLastBlockTime/nLastTXTime as last `block/last_transaction` in getpeerinfo (jonatack)
+- #19572 zmq: Create "sequence" notifier, enabling client-side mempool tracking (instagibbs)
+- #20002 Expose peer network in getpeerinfo; simplify/improve -netinfo (jonatack)
+
+### GUI
+- #17905 Avoid redundant tx status updates (ryanofsky)
+- #18646 Use `PACKAGE_NAME` in exception message (fanquake)
+- #17509 Save and load PSBT (Sjors)
+- #18769 Remove bug fix for Qt < 5.5 (10xcryptodev)
+- #15768 Add close window shortcut (IPGlider)
+- #16224 Bilingual GUI error messages (hebasto)
+- #18922 Do not translate InitWarning messages in debug.log (hebasto)
+- #18152 Use NotificationStatus enum for signals to GUI (hebasto)
+- #18587 Avoid wallet tryGetBalances calls in WalletModel::pollBalanceChanged (ryanofsky)
+- #17597 Fix height of QR-less ReceiveRequestDialog (hebasto)
+- #17918 Hide non PKHash-Addresses in signing address book (emilengler)
+- #17956 Disable unavailable context menu items in transactions tab (kristapsk)
+- #17968 Ensure that ModalOverlay is resized properly (hebasto)
+- #17993 Balance/TxStatus polling update based on last block hash (furszy)
+- #18424 Use parent-child relation to manage lifetime of OptionsModel object (hebasto)
+- #18452 Fix shutdown when `waitfor*` cmds are called from RPC console (hebasto)
+- #15202 Add Close All Wallets action (promag)
+- #19132 lock `cs_main`, `m_cached_tip_mutex` in that order (vasild)
+- #18898 Display warnings as rich text (hebasto)
+- #19231 add missing translation.h include to fix build (fanquake)
+- #18027 "PSBT Operations" dialog (gwillen)
+- #19256 Change combiner for signals to `optional_last_value` (fanquake)
+- #18896 Reset toolbar after all wallets are closed (hebasto)
+- #18993 increase console command max length (10xcryptodev)
+- #19323 Fix regression in *txoutset* in GUI console (hebasto)
+- #19210 Get rid of cursor in out-of-focus labels (hebasto)
+- #19011 Reduce `cs_main` lock accumulation during GUI startup (jonasschnelli)
+- #19844 Remove usage of boost::bind (fanquake)
+- #20479 Fix QPainter non-determinism on macOS (0.21 backport) (laanwj)
+- gui#6 Do not truncate node flag strings in debugwindow peers details tab (Saibato)
+- gui#8 Fix regression in TransactionTableModel (hebasto)
+- gui#17 doc: Remove outdated comment in TransactionTablePriv (MarcoFalke)
+- gui#20 Wrap tooltips in the intro window (hebasto)
+- gui#30 Disable the main window toolbar when the modal overlay is shown (hebasto)
+- gui#34 Show permissions instead of whitelisted (laanwj)
+- gui#35 Parse params directly instead of through node (ryanofsky)
+- gui#39 Add visual accenting for the 'Create new receiving address' button (hebasto)
+- gui#40 Clarify block height label (hebasto)
+- gui#43 bugfix: Call setWalletActionsEnabled(true) only for the first wallet (hebasto)
+- gui#97 Relax GUI freezes during IBD (jonasschnelli)
+- gui#71 Fix visual quality of text in QR image (hebasto)
+- gui#96 Slight improve create wallet dialog (Sjors)
+- gui#102 Fix SplashScreen crash when run with -disablewallet (hebasto)
+- gui#116 Fix unreasonable default size of the main window without loaded wallets (hebasto)
+- gui#120 Fix multiwallet transaction notifications (promag)
+
+### Build system
+- #18504 Drop bitcoin-tx and bitcoin-wallet dependencies on libevent (ryanofsky)
+- #18586 Bump gitian descriptors to 0.21 (laanwj)
+- #17595 guix: Enable building for `x86_64-w64-mingw32` target (dongcarl)
+- #17929 add linker optimisation flags to gitian & guix (Linux) (fanquake)
+- #18556 Drop make dist in gitian builds (hebasto)
+- #18088 ensure we aren't using GNU extensions (fanquake)
+- #18741 guix: Make source tarball using git-archive (dongcarl)
+- #18843 warn on potentially uninitialized reads (vasild)
+- #17874 make linker checks more robust (fanquake)
+- #18535 remove -Qunused-arguments workaround for clang + ccache (fanquake)
+- #18743 Add --sysroot option to mac os native compile flags (ryanofsky)
+- #18216 test, build: Enable -Werror=sign-compare (Empact)
+- #18928 don't pass -w when building for Windows (fanquake)
+- #16710 Enable -Wsuggest-override if available (hebasto)
+- #18738 Suppress -Wdeprecated-copy warnings (hebasto)
+- #18862 Remove fdelt_chk back-compat code and sanity check (fanquake)
+- #18887 enable -Werror=gnu (vasild)
+- #18956 enforce minimum required Windows version (7) (fanquake)
+- #18958 guix: Make V=1 more powerful for debugging (dongcarl)
+- #18677 Multiprocess build support (ryanofsky)
+- #19094 Only allow ASCII identifiers (laanwj)
+- #18820 Propagate well-known vars into depends (dongcarl)
+- #19173 turn on --enable-c++17 by --enable-fuzz (vasild)
+- #18297 Use pkg-config in BITCOIN_QT_CONFIGURE for all hosts including Windows (hebasto)
+- #19301 don't warn when doxygen isn't found (fanquake)
+- #19240 macOS toolchain simplification and bump (dongcarl)
+- #19356 Fix search for brew-installed BDB 4 on OS X (gwillen)
+- #19394 Remove unused `RES_IMAGES` (Bushstar)
+- #19403 improve `__builtin_clz*` detection (fanquake)
+- #19375 target Windows 7 when building libevent and fix ipv6 usage (fanquake)
+- #19331 Do not include server symbols in wallet (MarcoFalke)
+- #19257 remove BIP70 configure option (fanquake)
+- #18288 Add MemorySanitizer (MSan) in Travis to detect use of uninitialized memory (practicalswift)
+- #18307 Require pkg-config for all of the hosts (hebasto)
+- #19445 Update msvc build to use ISO standard C++17 (sipsorcery)
+- #18882 fix -Wformat-security check when compiling with GCC (fanquake)
+- #17919 Allow building with system clang (dongcarl)
+- #19553 pass -fcommon when building genisoimage (fanquake)
+- #19565 call `AC_PATH_TOOL` for dsymutil in macOS cross-compile (fanquake)
+- #19530 build LTO support into Apple's ld64 (theuni)
+- #19525 add -Wl,-z,separate-code to hardening flags (fanquake)
+- #19667 set minimum required Boost to 1.58.0 (fanquake)
+- #19672 make clean removes .gcda and .gcno files from fuzz directory (Crypt-iQ)
+- #19622 Drop ancient hack in gitian-linux descriptor (hebasto)
+- #19688 Add support for llvm-cov (hebasto)
+- #19718 Add missed gcov files to 'make clean' (hebasto)
+- #19719 Add Werror=range-loop-analysis (MarcoFalke)
+- #19015 Enable some commonly enabled compiler diagnostics (practicalswift)
+- #19689 build, qt: Add Qt version checking (hebasto)
+- #17396 modest Android improvements (icota)
+- #18405 Drop all of the ZeroMQ patches (hebasto)
+- #15704 Move Win32 defines to configure.ac to ensure they are globally defined (luke-jr)
+- #19761 improve sed robustness by not using sed (fanquake)
+- #19758 Drop deprecated and unused `GUARDED_VAR` and `PT_GUARDED_VAR` annotations (hebasto)
+- #18921 add stack-clash and control-flow protection options to hardening flags (fanquake)
+- #19803 Bugfix: Define and use `HAVE_FDATASYNC` correctly outside LevelDB (luke-jr)
+- #19685 CMake invocation cleanup (dongcarl)
+- #19861 add /usr/local/ to `LCOV_FILTER_PATTERN` for macOS builds (Crypt-iQ)
+- #19916 allow user to specify `DIR_FUZZ_SEED_CORPUS` for `cov_fuzz` (Crypt-iQ)
+- #19944 Update secp256k1 subtree (including BIP340 support) (sipa)
+- #19558 Split pthread flags out of ldflags and dont use when building libconsensus (fanquake)
+- #19959 patch qt libpng to fix powerpc build (fanquake)
+- #19868 Fix target name (hebasto)
+- #19960 The vcpkg tool has introduced a proper way to use manifests (sipsorcery)
+- #20065 fuzz: Configure check for main function (MarcoFalke)
+- #18750 Optionally skip external warnings (vasild)
+- #20147 Update libsecp256k1 (endomorphism, test improvements) (sipa)
+- #20156 Make sqlite support optional (compile-time) (luke-jr)
+- #20318 Ensure source tarball has leading directory name (MarcoFalke)
+- #20447 Patch `qt_intersect_spans` to avoid non-deterministic behavior in LLVM 8 (achow101)
+- #20505 Avoid secp256k1.h include from system (dergoegge)
+- #20527 Do not ignore Homebrew's SQLite on macOS (hebasto)
+- #20478 Don't set BDB flags when configuring without (jonasschnelli)
+- #20563 Check that Homebrew's berkeley-db4 package is actually installed (hebasto)
+- #19493 Fix clang build on Mac (bvbfan)
+
+### Tests and QA
+- #18593 Complete impl. of `msg_merkleblock` and `wait_for_merkleblock` (theStack)
+- #18609 Remove REJECT message code (hebasto)
+- #18584 Check that the version message does not leak the local address (MarcoFalke)
+- #18597 Extend `wallet_dump` test to cover comments (MarcoFalke)
+- #18596 Try once more when RPC connection fails on Windows (MarcoFalke)
+- #18451 shift coverage from getunconfirmedbalance to getbalances (jonatack)
+- #18631 appveyor: Disable functional tests for now (MarcoFalke)
+- #18628 Add various low-level p2p tests (MarcoFalke)
+- #18615 Avoid accessing free'd memory in `validation_chainstatemanager_tests` (MarcoFalke)
+- #18571 fuzz: Disable debug log file (MarcoFalke)
+- #18653 add coverage for bitcoin-cli -rpcwait (jonatack)
+- #18660 Verify findCommonAncestor always initializes outputs (ryanofsky)
+- #17669 Have coins simulation test also use CCoinsViewDB (jamesob)
+- #18662 Replace gArgs with local argsman in bench (MarcoFalke)
+- #18641 Create cached blocks not in the future (MarcoFalke)
+- #18682 fuzz: `http_request` workaround for libevent < 2.1.1 (theStack)
+- #18692 Bump timeout in `wallet_import_rescan` (MarcoFalke)
+- #18695 Replace boost::mutex with std::mutex (hebasto)
+- #18633 Properly raise FailedToStartError when rpc shutdown before warmup finished (MarcoFalke)
+- #18675 Don't initialize PrecomputedTransactionData in txvalidationcache tests (jnewbery)
+- #18691 Add `wait_for_cookie_credentials()` to framework for rpcwait tests (jonatack)
+- #18672 Add further BIP37 size limit checks to `p2p_filter.py` (theStack)
+- #18721 Fix linter issue (hebasto)
+- #18384 More specific `feature_segwit` test error messages and fixing incorrect comments (gzhao408)
+- #18575 bench: Remove requirement that all benches use same testing setup (MarcoFalke)
+- #18690 Check object hashes in `wait_for_getdata` (robot-visions)
+- #18712 display command line options passed to `send_cli()` in debug log (jonatack)
+- #18745 Check submitblock return values (MarcoFalke)
+- #18756 Use `wait_for_getdata()` in `p2p_compactblocks.py` (theStack)
+- #18724 Add coverage for -rpcwallet cli option (jonatack)
+- #18754 bench: Add caddrman benchmarks (vasild)
+- #18585 Use zero-argument super() shortcut (Python 3.0+) (theStack)
+- #18688 fuzz: Run in parallel (MarcoFalke)
+- #18770 Remove raw-tx byte juggling in `mempool_reorg` (MarcoFalke)
+- #18805 Add missing `sync_all` to `wallet_importdescriptors.py` (achow101)
+- #18759 bench: Start nodes with -nodebuglogfile (MarcoFalke)
+- #18774 Added test for upgradewallet RPC (brakmic)
+- #18485 Add `mempool_updatefromblock.py` (hebasto)
+- #18727 Add CreateWalletFromFile test (ryanofsky)
+- #18726 Check misbehavior more independently in `p2p_filter.py` (robot-visions)
+- #18825 Fix message for `ECC_InitSanityCheck` test (fanquake)
+- #18576 Use unittest for `test_framework` unit testing (gzhao408)
+- #18828 Strip down previous releases boilerplate (MarcoFalke)
+- #18617 Add factor option to adjust test timeouts (brakmic)
+- #18855 `feature_backwards_compatibility.py` test downgrade after upgrade (achow101)
+- #18864 Add v0.16.3 backwards compatibility test, bump v0.19.0.1 to v0.19.1 (Sjors)
+- #18917 fuzz: Fix vector size problem in system fuzzer (brakmic)
+- #18901 fuzz: use std::optional for `sep_pos_opt` variable (brakmic)
+- #18888 Remove RPCOverloadWrapper boilerplate (MarcoFalke)
+- #18952 Avoid os-dependent path (fametrano)
+- #18938 Fill fuzzing coverage gaps for functions in consensus/validation.h, primitives/block.h and util/translation.h (practicalswift)
+- #18986 Add capability to disable RPC timeout in functional tests (rajarshimaitra)
+- #18530 Add test for -blocksonly and -whitelistforcerelay param interaction (glowang)
+- #19014 Replace `TEST_PREVIOUS_RELEASES` env var with `test_framework` option (MarcoFalke)
+- #19052 Don't limit fuzzing inputs to 1 MB for afl-fuzz (now: ∞ ∀ fuzzers) (practicalswift)
+- #19060 Remove global `wait_until` from `p2p_getdata` (MarcoFalke)
+- #18926 Pass ArgsManager into `getarg_tests` (glowang)
+- #19110 Explain that a bug should be filed when the tests fail (MarcoFalke)
+- #18965 Implement `base58_decode` (10xcryptodev)
+- #16564 Always define the `raii_event_tests` test suite (candrews)
+- #19122 Add missing `sync_blocks` to `wallet_hd` (MarcoFalke)
+- #18875 fuzz: Stop nodes in `process_message*` fuzzers (MarcoFalke)
+- #18974 Check that invalid witness destinations can not be imported (MarcoFalke)
+- #18210 Type hints in Python tests (kiminuo)
+- #19159 Make valgrind.supp work on aarch64 (MarcoFalke)
+- #19082 Moved the CScriptNum asserts into the unit test in script.py (gillichu)
+- #19172 Do not swallow flake8 exit code (hebasto)
+- #19188 Avoid overwriting the NodeContext member of the testing setup [-Wshadow-field] (MarcoFalke)
+- #18890 `disconnect_nodes` should warn if nodes were already disconnected (robot-visions)
+- #19227 change blacklist to blocklist (TrentZ)
+- #19230 Move base58 to own module to break circular dependency (sipa)
+- #19083 `msg_mempool`, `fRelay`, and other bloomfilter tests (gzhao408)
+- #16756 Connection eviction logic tests (mzumsande)
+- #19177 Fix and clean `p2p_invalid_messages` functional tests (troygiorshev)
+- #19264 Don't import asyncio to test magic bytes (jnewbery)
+- #19178 Make `mininode_lock` non-reentrant (jnewbery)
+- #19153 Mempool compatibility test (S3RK)
+- #18434 Add a test-security target and run it in CI (fanquake)
+- #19252 Wait for disconnect in `disconnect_p2ps` + bloomfilter test followups (gzhao408)
+- #19298 Add missing `sync_blocks` (MarcoFalke)
+- #19304 Check that message sends successfully when header is split across two buffers (troygiorshev)
+- #19208 move `sync_blocks` and `sync_mempool` functions to `test_framework.py` (ycshao)
+- #19198 Check that peers with forcerelay permission are not asked to feefilter (MarcoFalke)
+- #19351 add two edge case tests for CSubNet (vasild)
+- #19272 net, test: invalid p2p messages and test framework improvements (jonatack)
+- #19348 Bump linter versions (duncandean)
+- #19366 Provide main(…) function in fuzzer. Allow building uninstrumented harnesses with --enable-fuzz (practicalswift)
+- #19412 move `TEST_RUNNER_EXTRA` into native tsan setup (fanquake)
+- #19368 Improve functional tests compatibility with BSD/macOS (S3RK)
+- #19028 Set -logthreadnames in unit tests (MarcoFalke)
+- #18649 Add std::locale::global to list of locale dependent functions (practicalswift)
+- #19140 Avoid fuzzer-specific nullptr dereference in libevent when handling PROXY requests (practicalswift)
+- #19214 Auto-detect SHA256 implementation in benchmarks (sipa)
+- #19353 Fix mistakenly swapped "previous" and "current" lock orders (hebasto)
+- #19533 Remove unnecessary `cs_mains` in `denialofservice_tests` (jnewbery)
+- #19423 add functional test for txrelay during and after IBD (gzhao408)
+- #16878 Fix non-deterministic coverage of test `DoS_mapOrphans` (davereikher)
+- #19548 fuzz: add missing overrides to `signature_checker` (jonatack)
+- #19562 Fix fuzzer compilation on macOS (freenancial)
+- #19370 Static asserts for consistency of fee defaults (domob1812)
+- #19599 clean `message_count` and `last_message` (troygiorshev)
+- #19597 test decodepsbt fee calculation (count input value only once per UTXO) (theStack)
+- #18011 Replace current benchmarking framework with nanobench (martinus)
+- #19489 Fail `wait_until` early if connection is lost (MarcoFalke)
+- #19340 Preserve the `LockData` initial state if "potential deadlock detected" exception thrown (hebasto)
+- #19632 Catch decimal.InvalidOperation from `TestNodeCLI#send_cli` (Empact)
+- #19098 Remove duplicate NodeContext hacks (ryanofsky)
+- #19649 Restore test case for p2p transaction blinding (instagibbs)
+- #19657 Wait until `is_connected` in `add_p2p_connection` (MarcoFalke)
+- #19631 Wait for 'cmpctblock' in `p2p_compactblocks` when it is expected (Empact)
+- #19674 use throwaway _ variable for unused loop counters (theStack)
+- #19709 Fix 'make cov' with clang (hebasto)
+- #19564 `p2p_feefilter` improvements (logging, refactoring, speedup) (theStack)
+- #19756 add `sync_all` to fix race condition in wallet groups test (kallewoof)
+- #19727 Removing unused classes from `p2p_leak.py` (dhruv)
+- #19722 Add test for getblockheader verboseness (torhte)
+- #19659 Add a seed corpus generation option to the fuzzing `test_runner` (darosior)
+- #19775 Activate segwit in TestChain100Setup (MarcoFalke)
+- #19760 Remove confusing mininode terminology (jnewbery)
+- #19752 Update `wait_until` usage in tests not to use the one from utils (slmtpz)
+- #19839 Set appveyor VM version to previous Visual Studio 2019 release (sipsorcery)
+- #19830 Add tsan supp for leveldb::DBImpl::DeleteObsoleteFiles (MarcoFalke)
+- #19710 bench: Prevent thread oversubscription and decreases the variance of result values (hebasto)
+- #19842 Update the vcpkg checkout commit ID in appveyor config (sipsorcery)
+- #19507 Expand functional zmq transaction tests (instagibbs)
+- #19816 Rename wait until helper to `wait_until_helper` (MarcoFalke)
+- #19859 Fixes failing functional test by changing version (n-thumann)
+- #19887 Fix flaky `wallet_basic` test (fjahr)
+- #19897 Change `FILE_CHAR_BLOCKLIST` to `FILE_CHARS_DISALLOWED` (verretor)
+- #19800 Mockwallet (MarcoFalke)
+- #19922 Run `rpc_txoutproof.py` even with wallet disabled (MarcoFalke)
+- #19936 batch rpc with params (instagibbs)
+- #19971 create default wallet in extended tests (Sjors)
+- #19781 add parameterized constructor for `msg_sendcmpct()` (theStack)
+- #19963 Clarify blocksonly whitelistforcerelay test (t-bast)
+- #20022 Use explicit p2p objects where available (guggero)
+- #20028 Check that invalid peer traffic is accounted for (MarcoFalke)
+- #20004 Add signet witness commitment section parse tests (MarcoFalke)
+- #20034 Get rid of default wallet hacks (ryanofsky)
+- #20069 Mention commit id in scripted diff error (laanwj)
+- #19947 Cover `change_type` option of "walletcreatefundedpsbt" RPC (guggero)
+- #20126 `p2p_leak_tx.py` improvements (use MiniWallet, add `p2p_lock` acquires) (theStack)
+- #20129 Don't export `in6addr_loopback` (vasild)
+- #20131 Remove unused nVersion=1 in p2p tests (MarcoFalke)
+- #20161 Minor Taproot follow-ups (sipa)
+- #19401 Use GBT to get block versions correct (luke-jr)
+- #20159 `mining_getblocktemplate_longpoll.py` improvements (use MiniWallet, add logging) (theStack)
+- #20039 Convert amounts from float to decimal (prayank23)
+- #20112 Speed up `wallet_resendwallettransactions` with mockscheduler RPC (MarcoFalke)
+- #20247 fuzz: Check for addrv1 compatibility before using addrv1 serializer. Fuzz addrv2 serialization (practicalswift)
+- #20167 Add test for -blockversion (MarcoFalke)
+- #19877 Clarify `rpc_net` & `p2p_disconnect_ban functional` tests (amitiuttarwar)
+- #20258 Remove getnettotals/getpeerinfo consistency test (jnewbery)
+- #20242 fuzz: Properly initialize PrecomputedTransactionData (MarcoFalke)
+- #20262 Skip --descriptor tests if sqlite is not compiled (achow101)
+- #18788 Update more tests to work with descriptor wallets (achow101)
+- #20289 fuzz: Check for addrv1 compatibility before using addrv1 serializer/deserializer on CService (practicalswift)
+- #20290 fuzz: Fix DecodeHexTx fuzzing harness issue (practicalswift)
+- #20245 Run `script_assets_test` even if built --with-libs=no (MarcoFalke)
+- #20300 fuzz: Add missing `ECC_Start` to `descriptor_parse` test (S3RK)
+- #20283 Only try witness deser when checking for witness deser failure (MarcoFalke)
+- #20303 fuzz: Assert expected DecodeHexTx behaviour when using legacy decoding (practicalswift)
+- #20316 Fix `wallet_multiwallet` test issue on Windows (MarcoFalke)
+- #20326 Fix `ecdsa_verify` in test framework (stepansnigirev)
+- #20328 cirrus: Skip tasks on the gui repo main branch (MarcoFalke)
+- #20355 fuzz: Check for addrv1 compatibility before using addrv1 serializer/deserializer on CSubNet (practicalswift)
+- #20332 Mock IBD in `net_processing` fuzzers (MarcoFalke)
+- #20218 Suppress `epoll_ctl` data race (MarcoFalke)
+- #20375 fuzz: Improve coverage for CPartialMerkleTree fuzzing harness (practicalswift)
+- #19669 contrib: Fixup valgrind suppressions file (MarcoFalke)
+- #18879 valgrind: remove outdated suppressions (fanquake)
+- #19226 Add BerkeleyDatabase tsan suppression (MarcoFalke)
+- #20379 Remove no longer needed UBSan suppression (float divide-by-zero in validation.cpp) (practicalswift)
+- #18190, #18736, #18744, #18775, #18783, #18867, #18994, #19065,
+ #19067, #19143, #19222, #19247, #19286, #19296, #19379, #19934,
+ #20188, #20395 Add fuzzing harnessses (practicalswift)
+- #18638 Use mockable time for ping/pong, add tests (MarcoFalke)
+- #19951 CNetAddr scoped ipv6 test coverage, rename scopeId to `m_scope_id` (jonatack)
+- #20027 Use mockable time everywhere in `net_processing` (sipa)
+- #19105 Add Muhash3072 implementation in Python (fjahr)
+- #18704, #18752, #18753, #18765, #18839, #18866, #18873, #19022,
+ #19023, #19429, #19552, #19778, #20176, #20179, #20214, #20292,
+ #20299, #20322 Fix intermittent test issues (MarcoFalke)
+- #20390 CI/Cirrus: Skip `merge_base` step for non-PRs (luke-jr)
+- #18634 ci: Add fuzzbuzz integration configuration file (practicalswift)
+- #18591 Add C++17 build to Travis (sipa)
+- #18581, #18667, #18798, #19495, #19519, #19538 CI improvements (hebasto)
+- #18683, #18705, #18735, #18778, #18799, #18829, #18912, #18929,
+ #19008, #19041, #19164, #19201, #19267, #19276, #19321, #19371,
+ #19427, #19730, #19746, #19881, #20294, #20339, #20368 CI improvements (MarcoFalke)
+- #20489, #20506 MSVC CI improvements (sipsorcery)
+
+### Miscellaneous
+- #18713 scripts: Add macho stack canary check to security-check.py (fanquake)
+- #18629 scripts: Add pe .reloc section check to security-check.py (fanquake)
+- #18437 util: `Detect posix_fallocate()` instead of assuming (vasild)
+- #18413 script: Prevent ub when computing abs value for num opcode serialize (pierreN)
+- #18443 lockedpool: avoid sensitive data in core files (FreeBSD) (vasild)
+- #18885 contrib: Move optimize-pngs.py script to the maintainer repo (MarcoFalke)
+- #18317 Serialization improvements step 6 (all except wallet/gui) (sipa)
+- #16127 More thread safety annotation coverage (ajtowns)
+- #19228 Update libsecp256k1 subtree (sipa)
+- #19277 util: Add assert identity function (MarcoFalke)
+- #19491 util: Make assert work with any value (MarcoFalke)
+- #19205 script: `previous_release.sh` rewritten in python (bliotti)
+- #15935 Add <datadir>/settings.json persistent settings storage (ryanofsky)
+- #19439 script: Linter to check commit message formatting (Ghorbanian)
+- #19654 lint: Improve commit message linter in travis (fjahr)
+- #15382 util: Add runcommandparsejson (Sjors)
+- #19614 util: Use `have_fdatasync` to determine fdatasync() use (fanquake)
+- #19813 util, ci: Hard code previous release tarball checksums (hebasto)
+- #19841 Implement Keccak and `SHA3_256` (sipa)
+- #19643 Add -netinfo peer connections dashboard (jonatack)
+- #15367 feature: Added ability for users to add a startup command (benthecarman)
+- #19984 log: Remove static log message "Initializing chainstate Chainstate [ibd] @ height -1 (null)" (practicalswift)
+- #20092 util: Do not use gargs global in argsmanager member functions (hebasto)
+- #20168 contrib: Fix `gen_key_io_test_vectors.py` imports (MarcoFalke)
+- #19624 Warn on unknown `rw_settings` (MarcoFalke)
+- #20257 Update secp256k1 subtree to latest master (sipa)
+- #20346 script: Modify security-check.py to use "==" instead of "is" for literal comparison (tylerchambers)
+- #18881 Prevent UB in DeleteLock() function (hebasto)
+- #19180, #19189, #19190, #19220, #19399 Replace RecursiveMutex with Mutex (hebasto)
+- #19347 Make `cs_inventory` nonrecursive (jnewbery)
+- #19773 Avoid recursive lock in IsTrusted (promag)
+- #18790 Improve thread naming (hebasto)
+- #20140 Restore compatibility with old CSubNet serialization (sipa)
+- #17775 DecodeHexTx: Try case where txn has inputs first (instagibbs)
+
+### Documentation
+- #18502 Update docs for getbalance (default minconf should be 0) (uzyn)
+- #18632 Fix macos comments in release-notes (MarcoFalke)
+- #18645 Update thread information in developer docs (jnewbery)
+- #18709 Note why we can't use `thread_local` with glibc back compat (fanquake)
+- #18410 Improve commenting for coins.cpp|h (jnewbery)
+- #18157 fixing init.md documentation to not require rpcpassword (jkcd)
+- #18739 Document how to fuzz Bitcoin Core using Honggfuzz (practicalswift)
+- #18779 Better explain GNU ld's dislike of ld64's options (fanquake)
+- #18663 Mention build docs in README.md (saahilshangle)
+- #18810 Update rest info on block size and json (chrisabrams)
+- #18939 Add c++17-enable flag to fuzzing instructions (mzumsande)
+- #18957 Add a link from ZMQ doc to ZMQ example in contrib/ (meeDamian)
+- #19058 Drop protobuf stuff (hebasto)
+- #19061 Add link to Visual Studio build readme (maitrebitcoin)
+- #19072 Expand section on Getting Started (MarcoFalke)
+- #18968 noban precludes maxuploadtarget disconnects (MarcoFalke)
+- #19005 Add documentation for 'checklevel' argument in 'verifychain' RPC… (kcalvinalvin)
+- #19192 Extract net permissions doc (MarcoFalke)
+- #19071 Separate repository for the gui (MarcoFalke)
+- #19018 fixing description of the field sequence in walletcreatefundedpsbt RPC method (limpbrains)
+- #19367 Span pitfalls (sipa)
+- #19408 Windows WSL build recommendation to temporarily disable Win32 PE support (sipsorcery)
+- #19407 explain why passing -mlinker-version is required when cross-compiling (fanquake)
+- #19452 afl fuzzing comment about afl-gcc and afl-g++ (Crypt-iQ)
+- #19258 improve subtree check instructions (Sjors)
+- #19474 Use precise permission flags where possible (MarcoFalke)
+- #19494 CONTRIBUTING.md improvements (jonatack)
+- #19268 Add non-thread-safe note to FeeFilterRounder::round() (hebasto)
+- #19547 Update macOS cross compilation dependencies for Focal (hebasto)
+- #19617 Clang 8 or later is required with `FORCE_USE_SYSTEM_CLANG` (fanquake)
+- #19639 Remove Reference Links #19582 (RobertHosking)
+- #19605 Set `CC_FOR_BUILD` when building on OpenBSD (fanquake)
+- #19765 Fix getmempoolancestors RPC result doc (MarcoFalke)
+- #19786 Remove label from good first issue template (MarcoFalke)
+- #19646 Updated outdated help command for getblocktemplate (jakeleventhal)
+- #18817 Document differences in bitcoind and bitcoin-qt locale handling (practicalswift)
+- #19870 update PyZMQ install instructions, fix `zmq_sub.py` file permissions (jonatack)
+- #19903 Update build-openbsd.md with GUI support (grubles)
+- #19241 help: Generate checkpoint height from chainparams (luke-jr)
+- #18949 Add CODEOWNERS file to automatically nominate PR reviewers (adamjonas)
+- #20014 Mention signet in -help output (hebasto)
+- #20015 Added default signet config for linearize script (gr0kchain)
+- #19958 Better document features of feelers (naumenkogs)
+- #19871 Clarify scope of eviction protection of outbound block-relay peers (ariard)
+- #20076 Update and improve files.md (hebasto)
+- #20107 Collect release-notes snippets (MarcoFalke)
+- #20109 Release notes and followups from 19339 (glozow)
+- #20090 Tiny followups to new getpeerinfo connection type field (amitiuttarwar)
+- #20152 Update wallet files in files.md (hebasto)
+- #19124 Document `ALLOW_HOST_PACKAGES` dependency option (skmcontrib)
+- #20271 Document that wallet salvage is experimental (MarcoFalke)
+- #20281 Correct getblockstats documentation for `(sw)total_weight` (shesek)
+- #20279 release process updates/fixups (jonatack)
+- #20238 Missing comments for signet parameters (decryp2kanon)
+- #20756 Add missing field (permissions) to the getpeerinfo help (amitiuttarwar)
+- #20668 warn that incoming conns are unlikely when not using default ports (adamjonas)
+- #19961 tor.md updates (jonatack)
+- #19050 Add warning for rest interface limitation (fjahr)
+- #19390 doc/REST-interface: Remove stale info (luke-jr)
+- #19344 docs: update testgen usage example (Bushstar)
+
+Credits
+=======
+
+Thanks to everyone who directly contributed to this release:
+
+- 10xcryptodev
+- Aaron Clauson
+- Aaron Hook
+- Adam Jonas
+- Adam Soltys
+- Adam Stein
+- Akio Nakamura
+- Alex Willmer
+- Amir Ghorbanian
+- Amiti Uttarwar
+- Andrew Chow
+- Andrew Toth
+- Anthony Fieroni
+- Anthony Towns
+- Antoine Poinsot
+- Antoine Riard
+- Ben Carman
+- Ben Woosley
+- Benoit Verret
+- Brian Liotti
+- Bushstar
+- Calvin Kim
+- Carl Dong
+- Chris Abrams
+- Chris L
+- Christopher Coverdale
+- codeShark149
+- Cory Fields
+- Craig Andrews
+- Damian Mee
+- Daniel Kraft
+- Danny Lee
+- David Reikher
+- DesWurstes
+- Dhruv Mehta
+- Duncan Dean
+- Elichai Turkel
+- Elliott Jin
+- Emil Engler
+- Ethan Heilman
+- eugene
+- Fabian Jahr
+- fanquake
+- Ferdinando M. Ametrano
+- freenancial
+- furszy
+- Gillian Chu
+- Gleb Naumenko
+- Glenn Willen
+- Gloria Zhao
+- glowang
+- gr0kchain
+- Gregory Sanders
+- grubles
+- gzhao408
+- Harris
+- Hennadii Stepanov
+- Hugo Nguyen
+- Igor Cota
+- Ivan Metlushko
+- Ivan Vershigora
+- Jake Leventhal
+- James O'Beirne
+- Jeremy Rubin
+- jgmorgan
+- Jim Posen
+- “jkcd”
+- jmorgan
+- John Newbery
+- Johnson Lau
+- Jon Atack
+- Jonas Schnelli
+- Jonathan Schoeller
+- João Barbosa
+- Justin Moon
+- kanon
+- Karl-Johan Alm
+- Kiminuo
+- Kristaps Kaupe
+- lontivero
+- Luke Dashjr
+- Marcin Jachymiak
+- MarcoFalke
+- Martin Ankerl
+- Martin Zumsande
+- maskoficarus
+- Matt Corallo
+- Matthew Zipkin
+- MeshCollider
+- Miguel Herranz
+- MIZUTA Takeshi
+- mruddy
+- Nadav Ivgi
+- Neha Narula
+- Nicolas Thumann
+- Niklas Gögge
+- Nima Yazdanmehr
+- nsa
+- nthumann
+- Oliver Gugger
+- pad
+- pasta
+- Peter Bushnell
+- pierrenn
+- Pieter Wuille
+- practicalswift
+- Prayank
+- Raúl Martínez (RME)
+- RandyMcMillan
+- Rene Pickhardt
+- Riccardo Masutti
+- Robert
+- Rod Vagg
+- Roy Shao
+- Russell Yanofsky
+- Saahil Shangle
+- sachinkm77
+- saibato
+- Samuel Dobson
+- sanket1729
+- Sebastian Falbesoner
+- Seleme Topuz
+- Sishir Giri
+- Sjors Provoost
+- skmcontrib
+- Stepan Snigirev
+- Stephan Oeste
+- Suhas Daftuar
+- t-bast
+- Tom Harding
+- Torhte Butler
+- TrentZ
+- Troy Giorshev
+- tryphe
+- Tyler Chambers
+- U-Zyn Chua
+- Vasil Dimov
+- wiz
+- Wladimir J. van der Laan
+
+As well as to everyone that helped with translations on
+[Transifex](https://www.transifex.com/bitcoin/bitcoin/).
diff --git a/doc/release-process.md b/doc/release-process.md
index cedb36d51d..84b208a0d8 100644
--- a/doc/release-process.md
+++ b/doc/release-process.md
@@ -5,7 +5,7 @@ Release Process
### Before every release candidate
-* Update translations (ping wumpus on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
+* Update translations see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations).
* Update manpages, see [gen-manpages.sh](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagessh).
* Update release candidate version in `configure.ac` (`CLIENT_VERSION_RC`).
@@ -52,6 +52,13 @@ Release Process
- Merge the release notes from the wiki into the branch.
- Ensure the "Needs release note" label is removed from all relevant pull requests and issues.
+#### Tagging a release (candidate)
+
+To tag the version (or release candidate) in git, use the `make-tag.py` script from [bitcoin-maintainer-tools](https://github.com/bitcoin-core/bitcoin-maintainer-tools). From the root of the repository run:
+
+ ../bitcoin-maintainer-tools/make-tag.py v(new version, e.g. 0.20.0)
+
+This will perform a few last-minute consistency checks in the build system files, and if they pass, create a signed tag.
## Building
@@ -73,21 +80,12 @@ Open a draft of the release notes for collaborative editing at https://github.co
For the period during which the notes are being edited on the wiki, the version on the branch should be wiped and replaced with a link to the wiki which should be used for all announcements until `-final`.
-Write the release notes. `git shortlog` helps a lot, for example:
-
- git shortlog --no-merges v(current version, e.g. 0.19.2)..v(new version, e.g. 0.20.0)
-
-(or ping @wumpus on IRC, he has specific tooling to generate the list of merged pulls
-and sort them into categories based on labels).
+Generate the change log. As this is a huge amount of work to do manually, there is the `list-pulls` script to do a pre-sorting step based on github PR metadata. See the [documentation in the README.md](https://github.com/bitcoin-core/bitcoin-maintainer-tools/blob/master/README.md#list-pulls).
Generate list of authors:
git log --format='- %aN' v(current version, e.g. 0.20.0)..v(new version, e.g. 0.20.1) | sort -fiu
-Tag the version (or release candidate) in git:
-
- git tag -s v(new version, e.g. 0.20.0)
-
### Setup and perform Gitian builds
If you're using the automated script (found in [contrib/gitian-build.py](/contrib/gitian-build.py)), then at this point you should run it with the "--build" command. Otherwise ignore this.
@@ -307,9 +305,9 @@ bitcoin.org (see below for bitcoin.org update instructions).
- First, check to see if the Bitcoin.org maintainers have prepared a
release: https://github.com/bitcoin-dot-org/bitcoin.org/labels/Core
- - If they have, it will have previously failed their Travis CI
+ - If they have, it will have previously failed their CI
checks because the final release files weren't uploaded.
- Trigger a Travis CI rebuild---if it passes, merge.
+ Trigger a CI rebuild---if it passes, merge.
- If they have not prepared a release, follow the Bitcoin.org release
instructions: https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-events-release-notes-and-alerts.md#release-notes
@@ -326,6 +324,18 @@ bitcoin.org (see below for bitcoin.org update instructions).
- bitcoincore.org RPC documentation update
+ - Install [golang](https://golang.org/doc/install)
+
+ - Install the new Bitcoin Core release
+
+ - Run bitcoind on regtest
+
+ - Clone the [bitcoincore.org repository](https://github.com/bitcoin-core/bitcoincore.org)
+
+ - Run: `go run generate.go` while being in `contrib/doc-gen` folder, and with bitcoin-cli in PATH
+
+ - Add the generated files to git
+
- Update packaging repo
- Push the flatpak to flathub, e.g. https://github.com/flathub/org.bitcoincore.bitcoin-qt/pull/2
diff --git a/doc/shared-libraries.md b/doc/shared-libraries.md
index e960863a80..147e223711 100644
--- a/doc/shared-libraries.md
+++ b/doc/shared-libraries.md
@@ -41,9 +41,10 @@ The interface is defined in the C header `bitcoinconsensus.h` located in `src/sc
- `bitcoinconsensus_ERR_TX_SIZE_MISMATCH` - `txToLen` did not match with the size of `txTo`
- `bitcoinconsensus_ERR_DESERIALIZE` - An error deserializing `txTo`
- `bitcoinconsensus_ERR_AMOUNT_REQUIRED` - Input amount is required if WITNESS is used
+- `bitcoinconsensus_ERR_INVALID_FLAGS` - Script verification `flags` are invalid (i.e. not part of the libconsensus interface)
### Example Implementations
-- [NBitcoin](https://github.com/NicolasDorier/NBitcoin/blob/master/NBitcoin/Script.cs#L814) (.NET Bindings)
+- [NBitcoin](https://github.com/MetacoSA/NBitcoin/blob/5e1055cd7c4186dee4227c344af8892aea54faec/NBitcoin/Script.cs#L979-#L1031) (.NET Bindings)
- [node-libbitcoinconsensus](https://github.com/bitpay/node-libbitcoinconsensus) (Node.js Bindings)
- [java-libbitcoinconsensus](https://github.com/dexX7/java-libbitcoinconsensus) (Java Bindings)
- [bitcoinconsensus-php](https://github.com/Bit-Wasp/bitcoinconsensus-php) (PHP Bindings)
diff --git a/doc/tor.md b/doc/tor.md
index 12b5f70245..8a2aef2d07 100644
--- a/doc/tor.md
+++ b/doc/tor.md
@@ -5,6 +5,16 @@ It is possible to run Bitcoin Core as a Tor onion service, and connect to such s
The following directions assume you have a Tor proxy running on port 9050. Many distributions default to having a SOCKS proxy listening on port 9050, but others may not. In particular, the Tor Browser Bundle defaults to listening on port 9150. See [Tor Project FAQ:TBBSocksPort](https://www.torproject.org/docs/faq.html.en#TBBSocksPort) for how to properly
configure Tor.
+## How to see information about your Tor configuration via Bitcoin Core
+
+There are several ways to see your local onion address in Bitcoin Core:
+- in the debug log (grep for "tor:" or "AddLocal")
+- in the output of RPC `getnetworkinfo` in the "localaddresses" section
+- in the output of the CLI `-netinfo` peer connections dashboard
+
+You may set the `-debug=tor` config logging option to have additional
+information in the debug log about your Tor configuration.
+
## 1. Run Bitcoin Core behind a Tor proxy
@@ -13,14 +23,19 @@ outgoing connections, but more is possible.
-proxy=ip:port Set the proxy server. If SOCKS5 is selected (default), this proxy
server will be used to try to reach .onion addresses as well.
+ You need to use -noonion or -onion=0 to explicitly disable
+ outbound access to onion services.
-onion=ip:port Set the proxy server to use for Tor onion services. You do not
- need to set this if it's the same as -proxy. You can use -noonion
+ need to set this if it's the same as -proxy. You can use -onion=0
to explicitly disable access to onion services.
+ Note: Only the -proxy option sets the proxy for DNS requests;
+ with -onion they will not route over Tor, so use -proxy if you
+ have privacy concerns.
-listen When using -proxy, listening is disabled by default. If you want
- to run an onion service (see next section), you'll need to enable
- it explicitly.
+ to manually configure an onion service (see section 3), you'll
+ need to enable it explicitly.
-connect=X When behind a Tor proxy, you can specify .onion addresses instead
-addnode=X of IP addresses or hostnames in these parameters. It requires
@@ -30,36 +45,133 @@ outgoing connections, but more is possible.
-onlynet=onion Make outgoing connections only to .onion addresses. Incoming
connections are not affected by this option. This option can be
specified multiple times to allow multiple network types, e.g.
- ipv4, ipv6, or onion.
+ ipv4, ipv6 or onion. If you use this option with values other
+ than onion you *cannot* disable onion connections; outgoing onion
+ connections will be enabled when you use -proxy or -onion. Use
+ -noonion or -onion=0 if you want to be sure there are no outbound
+ onion connections over the default proxy or your defined -proxy.
In a typical situation, this suffices to run behind a Tor proxy:
./bitcoind -proxy=127.0.0.1:9050
+## 2. Automatically create a Bitcoin Core onion service
+
+Bitcoin Core makes use of Tor's control socket API to create and destroy
+ephemeral onion services programmatically. This means that if Tor is running and
+proper authentication has been configured, Bitcoin Core automatically creates an
+onion service to listen on. The goal is to increase the number of available
+onion nodes.
+
+This feature is enabled by default if Bitcoin Core is listening (`-listen`) and
+it requires a Tor connection to work. It can be explicitly disabled with
+`-listenonion=0`. If it is not disabled, it can be configured using the
+`-torcontrol` and `-torpassword` settings.
+
+To see verbose Tor information in the bitcoind debug log, pass `-debug=tor`.
+
+### Control Port
+
+You may need to set up the Tor Control Port. On Linux distributions there may be
+some or all of the following settings in `/etc/tor/torrc`, generally commented
+out by default (if not, add them):
+
+```
+ControlPort 9051
+CookieAuthentication 1
+CookieAuthFileGroupReadable 1
+```
+
+Add or uncomment those, save, and restart Tor (usually `systemctl restart tor`
+or `sudo systemctl restart tor` on most systemd-based systems, including recent
+Debian and Ubuntu, or just restart the computer).
+
+On some systems (such as Arch Linux), you may also need to add the following
+line:
+
+```
+DataDirectoryGroupReadable 1
+```
+
+### Authentication
+
+Connecting to Tor's control socket API requires one of two authentication
+methods to be configured: cookie authentication or bitcoind's `-torpassword`
+configuration option.
+
+#### Cookie authentication
-## 2. Run a Bitcoin Core hidden server
+For cookie authentication, the user running bitcoind must have read access to
+the `CookieAuthFile` specified in the Tor configuration. In some cases this is
+preconfigured and the creation of an onion service is automatic. Don't forget to
+use the `-debug=tor` bitcoind configuration option to enable Tor debug logging.
-If you configure your Tor system accordingly, it is possible to make your node also
-reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent
-config file): *Needed for Tor version 0.2.7.0 and older versions of Tor only. For newer
-versions of Tor see [Section 3](#3-automatically-listen-on-tor).*
+If a permissions problem is seen in the debug log, e.g. `tor: Authentication
+cookie /run/tor/control.authcookie could not be opened (check permissions)`, it
+can be resolved by adding both the user running Tor and the user running
+bitcoind to the same Tor group and setting permissions appropriately.
+
+On Debian-derived systems, the Tor group will likely be `debian-tor` and one way
+to verify could be to list the groups and grep for a "tor" group name:
+
+```
+getent group | cut -d: -f1 | grep -i tor
+```
+
+You can also check the group of the cookie file. On most Linux systems, the Tor
+auth cookie will usually be `/run/tor/control.authcookie`:
+
+```
+stat -c '%G' /run/tor/control.authcookie
+```
+
+Once you have determined the `${TORGROUP}` and selected the `${USER}` that will
+run bitcoind, run this as root:
+
+```
+usermod -a -G ${TORGROUP} ${USER}
+```
+
+Then restart the computer (or log out) and log in as the `${USER}` that will run
+bitcoind.
+
+#### `torpassword` authentication
+
+For the `-torpassword=password` option, the password is the clear text form that
+was used when generating the hashed password for the `HashedControlPassword`
+option in the Tor configuration file.
+
+The hashed password can be obtained with the command `tor --hash-password
+password` (refer to the [Tor Dev
+Manual](https://2019.www.torproject.org/docs/tor-manual.html.en) for more
+details).
+
+
+## 3. Manually create a Bitcoin Core onion service
+
+You can also manually configure your node to be reachable from the Tor network.
+Add these lines to your `/etc/tor/torrc` (or equivalent config file):
HiddenServiceDir /var/lib/tor/bitcoin-service/
HiddenServicePort 8333 127.0.0.1:8334
- HiddenServicePort 18333 127.0.0.1:18334
The directory can be different of course, but virtual port numbers should be equal to
your bitcoind's P2P listen port (8333 by default), and target addresses and ports
should be equal to binding address and port for inbound Tor connections (127.0.0.1:8334 by default).
- -externalip=X You can tell bitcoin about its publicly reachable address using
- this option, and this can be a .onion address. Given the above
- configuration, you can find your .onion address in
+ -externalip=X You can tell bitcoin about its publicly reachable addresses using
+ this option, and this can be an onion address. Given the above
+ configuration, you can find your onion address in
/var/lib/tor/bitcoin-service/hostname. For connections
coming from unroutable addresses (such as 127.0.0.1, where the
- Tor proxy typically runs), .onion addresses are given
+ Tor proxy typically runs), onion addresses are given
preference for your node to advertise itself with.
+ You can set multiple local addresses with -externalip. The
+ one that will be rumoured to a particular peer is the most
+ compatible one and also using heuristics, e.g. the address
+ with the most incoming connections, etc.
+
-listen You'll need to enable listening for incoming connections, as this
is off by default behind a proxy.
@@ -72,7 +184,7 @@ should be equal to binding address and port for inbound Tor connections (127.0.0
In a typical situation, where you're only reachable via Tor, this should suffice:
- ./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen
+ ./bitcoind -proxy=127.0.0.1:9050 -externalip=7zvj7a2imdgkdbg4f2dryd5rgtrn7upivr5eeij4cicjh65pooxeshid.onion -listen
(obviously, replace the .onion address with your own). It should be noted that you still
listen on all devices and another node could establish a clearnet connection, when knowing
@@ -85,51 +197,17 @@ as well, use `discover` instead:
./bitcoind ... -discover
-and open port 8333 on your firewall (or use -upnp).
+and open port 8333 on your firewall (or use port mapping, i.e., `-upnp` or `-natpmp`).
If you only want to use Tor to reach .onion addresses, but not use it as a proxy
for normal IPv4/IPv6 communication, use:
- ./bitcoind -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover
-
-## 3. Automatically listen on Tor
-
-Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket
-API, to create and destroy 'ephemeral' onion services programmatically.
-Bitcoin Core has been updated to make use of this.
-
-This means that if Tor is running (and proper authentication has been configured),
-Bitcoin Core automatically creates an onion service to listen on. This will positively
-affect the number of available .onion nodes.
-
-This new feature is enabled by default if Bitcoin Core is listening (`-listen`), and
-requires a Tor connection to work. It can be explicitly disabled with `-listenonion=0`
-and, if not disabled, configured using the `-torcontrol` and `-torpassword` settings.
-To show verbose debugging information, pass `-debug=tor`.
-
-Connecting to Tor's control socket API requires one of two authentication methods to be
-configured. It also requires the control socket to be enabled, e.g. put `ControlPort 9051`
-in `torrc` config file. For cookie authentication the user running bitcoind must have read
-access to the `CookieAuthFile` specified in Tor configuration. In some cases this is
-preconfigured and the creation of an onion service is automatic. If permission problems
-are seen with `-debug=tor` they can be resolved by adding both the user running Tor and
-the user running bitcoind to the same group and setting permissions appropriately. On
-Debian-based systems the user running bitcoind can be added to the debian-tor group,
-which has the appropriate permissions. Before starting bitcoind you will need to re-login
-to allow debian-tor group to be applied. Otherwise you will see the following notice: "tor:
-Authentication cookie /run/tor/control.authcookie could not be opened (check permissions)"
-on debug.log.
-
-An alternative authentication method is the use
-of the `-torpassword=password` option. The `password` is the clear text form that
-was used when generating the hashed password for the `HashedControlPassword` option
-in the tor configuration file. The hashed password can be obtained with the command
-`tor --hash-password password` (read the tor manual for more details).
+ ./bitcoind -onion=127.0.0.1:9050 -externalip=7zvj7a2imdgkdbg4f2dryd5rgtrn7upivr5eeij4cicjh65pooxeshid.onion -discover
## 4. Privacy recommendations
-- Do not add anything but Bitcoin Core ports to the onion service created in section 2.
+- Do not add anything but Bitcoin Core ports to the onion service created in section 3.
If you run a web service too, create a new onion service for that.
- Otherwise it is trivial to link them, which may reduce privacy. Hidden
- services created automatically (as in section 3) always have only one port
+ Otherwise it is trivial to link them, which may reduce privacy. Onion
+ services created automatically (as in section 2) always have only one port
open.
generated by cgit v1.2.3 (git 2.26.2) at 2025-02-25 12:08:02 +0000