diff --git a/contrib/debian/control b/contrib/debian/control
index 7f833a35c..8a1899b28 100644
--- a/contrib/debian/control
+++ b/contrib/debian/control
@@ -1,87 +1,85 @@
Source: bitcoinabc
Section: utils
Priority: optional
Maintainer: Bitcoin ABC Package Maintainers <package-maintainers@bitcoinabc.org>
Uploaders: Jason B. Cox <jasonbcox@bitcoinabc.org>
Build-Depends: cmake (>= 3.16),
debhelper (>=12.1),
devscripts,
git,
help2man,
libdb5.3++-dev,
libevent-dev,
libjemalloc-dev,
libminiupnpc-dev,
libnatpmp-dev,
- libboost-filesystem-dev,
- libboost-system-dev,
libboost-thread-dev,
libboost-test-dev,
libprotobuf-dev,
libqrencode-dev,
libssl-dev,
libsqlite3-dev,
libzmq3-dev,
lld,
ninja-build,
protobuf-compiler,
python3,
qttools5-dev,
qttools5-dev-tools,
xvfb
Standards-Version: 3.9.2
Homepage: https://bitcoinabc.org/
Vcs-Git: ssh://vcs@reviews.bitcoinabc.org:2221/source/bitcoin-abc.git
Vcs-Browser: https://reviews.bitcoinabc.org/source/bitcoin-abc/
Package: bitcoind
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: peer-to-peer network based digital currency - daemon
Bitcoin is an experimental new digital currency that enables instant
payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer
technology to operate with no central authority: managing transactions
and issuing money are carried out collectively by the network. Bitcoin ABC
is the name of the open source software which enables the use of this currency.
.
This package provides the daemon, bitcoind, and the CLI tool
bitcoin-cli to interact with the daemon.
Package: bitcoin-qt
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: peer-to-peer network based digital currency - Qt GUI
Bitcoin is an experimental new digital currency that enables instant
payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer
technology to operate with no central authority: managing transactions
and issuing money are carried out collectively by the network. Bitcoin ABC
is the name of the open source software which enables the use of this currency.
.
This package provides Bitcoin-Qt, a GUI for Bitcoin based on Qt.
Package: bitcoin-tx
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: peer-to-peer digital currency - standalone transaction tool
Bitcoin is an experimental new digital currency that enables instant
payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer
technology to operate with no central authority: managing transactions
and issuing money are carried out collectively by the network. Bitcoin ABC
is the name of the open source software which enables the use of this currency.
.
This package provides bitcoin-tx, a command-line transaction creation
tool which can be used without a bitcoin daemon. Some means of
exchanging minimal transaction data with peers is still required.
Package: bitcoin-wallet
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: peer-to-peer digital currency - wallet tool
Bitcoin is an experimental new digital currency that enables instant
payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer
technology to operate with no central authority: managing transactions
and issuing money are carried out collectively by the network. Bitcoin ABC
is the name of the open source software which enables the use of this currency.
.
This package provides bitcoin-wallet, an offline tool for creating and
interacting with Bitcoin ABC wallet files.
diff --git a/contrib/valgrind.supp b/contrib/valgrind.supp
index 58516620d..554bf95f5 100644
--- a/contrib/valgrind.supp
+++ b/contrib/valgrind.supp
@@ -1,113 +1,99 @@
# Valgrind suppressions file for Bitcoin.
#
# Includes known Valgrind warnings in our dependencies that cannot be fixed
# in-tree.
#
# Example use:
# $ valgrind --suppressions=../contrib/valgrind.supp --child-silent-after-fork=yes \
# src/test/test_bitcoin
# $ valgrind --suppressions=../contrib/valgrind.supp --leak-check=full \
# --show-leak-kinds=all --child-silent-after-fork=yes src/test/test_bitcoin
#
# To create suppressions for found issues, use the --gen-suppressions=all option:
# $ valgrind --suppressions=../contrib/valgrind.supp --leak-check=full \
# --show-leak-kinds=all --gen-suppressions=all --show-reachable=yes \
# --child-silent-after-fork=yes --error-limit=no src/test/test_bitcoin
#
# Note that suppressions may depend on OS and/or library versions.
{
Suppress libstdc++ warning - https://gcc.gnu.org/bugzilla/show_bug.cgi?id=65434
Memcheck:Leak
match-leak-kinds: reachable
fun:malloc
obj:*/libstdc++.*
fun:call_init.part.0
fun:call_init
fun:_dl_init
obj:*/ld-*.so
}
{
Suppress libdb warning - https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=662917
Memcheck:Cond
obj:*/libdb_cxx-*.so
fun:__log_put
obj:*/libdb_cxx-*.so
fun:__log_put_record
}
{
Suppress libdb warning
Memcheck:Param
pwrite64(buf)
fun:pwrite
fun:__os_io
obj:*/libdb_cxx-*.so
}
{
Suppress leveldb warning (leveldb::InitModule()) - https://github.com/google/leveldb/issues/113
Memcheck:Leak
match-leak-kinds: reachable
fun:_Znwm
fun:_ZN7leveldbL10InitModuleEv
}
{
Suppress leveldb warning (leveldb::Env::Default()) - https://github.com/google/leveldb/issues/113
Memcheck:Leak
match-leak-kinds: reachable
fun:_Znwm
...
fun:_ZN7leveldbL14InitDefaultEnvEv
}
{
Suppress wcsnrtombs glibc SSE4 warning (could be related: https://stroika.atlassian.net/browse/STK-626)
Memcheck:Addr16
fun:__wcsnlen_sse4_1
fun:wcsnrtombs
}
-{
- Suppress boost::filesystem warning (fixed in boost 1.70: https://github.com/boostorg/filesystem/commit/bbe9d1771e5d679b3f10c42a58fc81f7e8c024a9)
- Memcheck:Cond
- fun:_ZN5boost10filesystem6detail28directory_iterator_incrementERNS0_18directory_iteratorEPNS_6system10error_codeE
- fun:_ZN5boost10filesystem6detail28directory_iterator_constructERNS0_18directory_iteratorERKNS0_4pathEPNS_6system10error_codeE
- obj:*/libboost_filesystem.so.*
-}
-{
- Suppress boost::filesystem warning (could be related: https://stackoverflow.com/questions/9830182/function-boostfilesystemcomplete-being-reported-as-possible-memory-leak-by-v)
- Memcheck:Leak
- match-leak-kinds: reachable
- fun:_Znwm
- fun:_ZN5boost10filesystem8absoluteERKNS0_4pathES3_
-}
{
Suppress boost still reachable memory warning
Memcheck:Leak
match-leak-kinds: reachable
fun:_Znwm
...
fun:_M_construct_aux<char*>
fun:_M_construct<char*>
fun:basic_string
fun:path
}
{
Suppress LogInstance still reachable memory warning
Memcheck:Leak
match-leak-kinds: reachable
fun:_Znwm
fun:_Z11LogInstancev
}
{
Suppress secp256k1_context_create still reachable memory warning
Memcheck:Leak
match-leak-kinds: reachable
fun:malloc
...
fun:secp256k1_context_create
}
{
Suppress BCLog::Logger::StartLogging() still reachable memory warning
Memcheck:Leak
match-leak-kinds: reachable
fun:malloc
...
fun:_ZN5BCLog6Logger12StartLoggingEv
}
diff --git a/depends/packages/boost.mk b/depends/packages/boost.mk
index 1fec22c02..5cae843c8 100644
--- a/depends/packages/boost.mk
+++ b/depends/packages/boost.mk
@@ -1,45 +1,45 @@
package=boost
$(package)_version=1_70_0
$(package)_download_path=https://dl.bintray.com/boostorg/release/1.70.0/source/
$(package)_file_name=$(package)_$($(package)_version).tar.bz2
$(package)_sha256_hash=430ae8354789de4fd19ee52f3b1f739e1fba576f0aded0897c3c2bc00fb38778
$(package)_patches=unused_var_in_process.patch
define $(package)_set_vars
$(package)_config_opts_release=variant=release
$(package)_config_opts_debug=variant=debug
$(package)_config_opts=--layout=tagged --build-type=complete --user-config=user-config.jam
$(package)_config_opts+=threading=multi link=static -sNO_BZIP2=1 -sNO_ZLIB=1
$(package)_config_opts_linux=target-os=linux threadapi=pthread runtime-link=shared
$(package)_config_opts_darwin=target-os=darwin runtime-link=shared
$(package)_config_opts_mingw32=target-os=windows binary-format=pe threadapi=win32 runtime-link=static
$(package)_config_opts_x86_64_mingw32=address-model=64
$(package)_config_opts_i686_mingw32=address-model=32
$(package)_config_opts_i686_linux=address-model=32 architecture=x86
$(package)_toolset_$(host_os)=gcc
$(package)_toolset_darwin=clang
ifneq (,$(findstring clang,$($(package)_cxx)))
$(package)_toolset_$(host_os)=clang
endif
$(package)_archiver_$(host_os)=$($(package)_ar)
-$(package)_config_libraries=atomic,date_time,filesystem,system,thread,test
+$(package)_config_libraries=atomic,date_time,thread,test
$(package)_cxxflags=-std=c++17 -fvisibility=hidden
$(package)_cxxflags_linux=-fPIC
endef
define $(package)_preprocess_cmds
patch -p1 < $($(package)_patch_dir)/unused_var_in_process.patch && \
echo "using $($(package)_toolset_$(host_os)) : : $($(package)_cxx) : <cxxflags>\"$($(package)_cxxflags) $($(package)_cppflags)\" <linkflags>\"$($(package)_ldflags)\" <archiver>\"$($(package)_archiver_$(host_os))\" <striper>\"$(host_STRIP)\" <ranlib>\"$(host_RANLIB)\" <rc>\"$(host_WINDRES)\" : ;" > user-config.jam
endef
define $(package)_config_cmds
./bootstrap.sh --without-icu --with-libraries=$($(package)_config_libraries) --with-toolset=$($(package)_toolset_$(host_os))
endef
define $(package)_build_cmds
./b2 -d2 -j$(JOBS) -d1 --prefix=$($(package)_staging_prefix_dir) $($(package)_config_opts) toolset=$($(package)_toolset_$(host_os)) stage
endef
define $(package)_stage_cmds
./b2 -d0 -j4 --prefix=$($(package)_staging_prefix_dir) $($(package)_config_opts) toolset=$($(package)_toolset_$(host_os)) install
endef
diff --git a/doc/build-unix.md b/doc/build-unix.md
index ec4b4cc69..134aee1cf 100644
--- a/doc/build-unix.md
+++ b/doc/build-unix.md
@@ -1,347 +1,347 @@
UNIX BUILD NOTES
====================
Some notes on how to build Bitcoin ABC in Unix.
To Build
---------------------
Before you start building, please make sure that your compiler supports C++17.
It is recommended to create a build directory to build out-of-tree.
```bash
mkdir build
cd build
cmake -GNinja ..
ninja
ninja install # optional
```
This will build bitcoin-qt as well.
Dependencies
---------------------
*Note: Bitcoin ABC provides a [Docker image with all the dependencies preinstalled](#build-using-a-docker-container).*
These dependencies are required:
Library | Purpose | Description
------------|------------------|----------------------
libssl | Crypto | Random Number Generation, Elliptic Curve Cryptography
libboost | Utility | Library for threading, data structures, etc
libevent | Networking | OS independent asynchronous networking
Optional dependencies:
Library | Purpose | Description
------------|------------------|----------------------
miniupnpc | UPnP Support | Firewall-jumping support
libnatpmp | NAT-PMP Support | Firewall-jumping support
libdb | Berkeley DB | Wallet storage (only needed when wallet enabled)
libsqlite3 | SQLite 3 | Wallet storage (only needed when wallet enabled)
jemalloc | Memory allocator | Library to enhance the memory allocation and improve performances
qt | GUI | GUI toolkit (only needed when GUI enabled)
protobuf | Payments in GUI | Data interchange format used for payment protocol (only needed when BIP70 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)
libzmq3 | ZMQ notification | Optional, allows generating ZMQ notifications (requires ZMQ version >= 4.1.5)
systemtap | Tracing (USDT) | Optional, statically defined tracepoints
For the versions used, see [dependencies.md](dependencies.md)
Memory Requirements
--------------------
C++ compilers are memory-hungry. It is recommended to have at least 1.5 GB of
memory available when compiling Bitcoin ABC. On systems with less, gcc can be
tuned to conserve memory with additional CXXFLAGS:
cmake -GNinja .. -DCMAKE_CXX_FLAGS="--param ggc-min-expand=1 --param ggc-min-heapsize=32768"
Dependency Build Instructions: Ubuntu & Debian
----------------------------------------------
Build requirements:
sudo apt-get install bsdmainutils build-essential cmake libssl-dev libevent-dev lld ninja-build python3
**Installing cmake on older distribution (Debian < 11 or Ubuntu < 20.04):**
On Debian Buster (10), `cmake` should be installed from the backports repository:
echo "deb http://deb.debian.org/debian buster-backports main" | sudo tee -a /etc/apt/sources.list
sudo apt-get update
sudo apt-get -t buster-backports install cmake
If the `cmake` packaged version is too old it can be installed from the Kitware APT repository:
sudo apt-get install apt-transport-https ca-certificates gnupg software-properties-common wget
wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | sudo apt-key add -
Add the repository corresponding to your version (see [instructions from Kitware](https://apt.kitware.com)). For Ubuntu Bionic (18.04):
sudo apt-add-repository 'deb https://apt.kitware.com/ubuntu/ bionic main'
Then update the package list and install `cmake`:
sudo apt update
sudo apt install cmake
Now, you can either build from self-compiled [depends](/depends/README.md) or
install the required dependencies with the following instructions.
Options when installing required Boost library files:
1. On at least Ubuntu 16.04+ and Debian 9+ there are generic names for the
individual boost development packages, so the following can be used to only
install necessary parts of boost:
- sudo apt-get install libboost-system-dev libboost-filesystem-dev libboost-test-dev libboost-thread-dev
+ sudo apt-get install libboost-test-dev libboost-thread-dev
2. If that doesn't work, you can install all boost development packages with:
sudo apt-get install libboost-all-dev
BerkeleyDB 5.3 or later and SQLite 3.7 or later are required for the wallet. These can be installed with:
sudo apt-get install libdb-dev libdb++-dev libsqlite3-dev
See the section "Disable-wallet mode" to build Bitcoin ABC without wallet.
Port mapping dependencies MiniUPnPc and NAT-PMP (can be disabled by passing `-DENABLE_UPNP=OFF` and `-DENABLE_NATPMP=OFF` on the cmake command line):
sudo apt-get install libminiupnpc-dev libnatpmp-dev
ZMQ dependencies (provides ZMQ API, can be disabled by passing `-DBUILD_BITCOIN_ZMQ=OFF` on the cmake command line):
sudo apt-get install libzmq3-dev
jemalloc dependencies (provides the jemalloc library, can be disabled by passing `-DUSE_JEMALLOC=OFF` on the cmake command line):
sudo apt-get install libjemalloc-dev
User-Space, Statically Defined Tracing (USDT) dependencies (provides the tracepoint library, can be disabled by passing `-DENABLE_TRACING=OFF` on the cmake command line):
sudo apt install systemtap-sdt-dev
Dependencies for the GUI: Ubuntu & Debian
-----------------------------------------
If you want to build bitcoin-qt, make sure that the required packages for Qt development
are installed. Qt 5 is necessary to build the GUI.
To build without GUI pass `-DBUILD_BITCOIN_QT=OFF` on the cmake command line.
To build with Qt 5 you need the following:
sudo apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler
libqrencode dependencies (can be disabled by passing `-DENABLE_QRCODE=OFF` on the cmake command line):
sudo apt-get install libqrencode-dev
Dependency Build Instructions: Fedora
-------------------------------------
Build requirements:
sudo dnf install boost-devel cmake gcc-c++ libdb-cxx-devel libdb-devel libevent-devel ninja-build openssl-devel python3
Port mapping dependencies MiniUPnPc and NAT-PMP (can be disabled by passing `-DENABLE_UPNP=OFF` and `-DENABLE_NATPMP=OFF` on the cmake command line):
sudo dnf install miniupnpc-devel libnatpmp-devel
ZMQ dependencies (can be disabled by passing `-DBUILD_BITCOIN_ZMQ=OFF` on the cmake command line):
sudo dnf install zeromq-devel
User-Space, Statically Defined Tracing (USDT) dependencies (provides the tracepoint library, can be disabled by passing `-DENABLE_TRACING=OFF` on the cmake command line):
sudo dnf install systemtap
To build with Qt 5 you need the following:
sudo dnf install qt5-qttools-devel qt5-qtbase-devel protobuf-devel
libqrencode dependencies (can be disabled by passing `-DENABLE_QRCODE=OFF`):
sudo dnf install qrencode-devel
SQLite can be installed with:
sudo dnf install sqlite-devel
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 cmake options for UPnP behavior desired:
ENABLE_UPNP Enable UPnP support (miniupnp required, default ON)
START_WITH_UPNP UPnP support turned on by default at runtime (default OFF)
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:
ENABLE_NATPMP NAT-PMP support (libnatpmp required, default ON)
START_WITH_NATPMP NAT-PMP support turned on by default at runtime (default OFF)
Boost
-----
For documentation on building Boost look at their official documentation: http://www.boost.org/build/doc/html/bbv2/installation.html
Security
--------
To help make your Bitcoin ABC installation more secure by making certain attacks impossible to
exploit even if a vulnerability is found, binaries are hardened by default.
This can be disabled by passing `-DENABLE_HARDENING=OFF`.
Hardening enables the following features:
* _Position Independent Executable_: Build position independent code to take advantage of Address Space Layout Randomization
offered by some kernels. Attackers who can cause execution of code at an arbitrary memory
location are thwarted if they don't know where anything useful is located.
The stack and heap are randomly located by default, but this allows the code section to be
randomly located as well.
On an AMD64 processor where a library was not compiled with -fPIC, this will cause an error
such as: "relocation R_X86_64_32 against `......' can not be used when making a shared object;"
To test that you have built PIE executable, install scanelf, part of paxutils, and use:
scanelf -e ./bitcoin
The output should contain:
TYPE
ET_DYN
* _Non-executable Stack_: If the stack is executable then trivial stack-based buffer overflow exploits are possible if
vulnerable buffers are found. By default, Bitcoin ABC should be built with a non-executable stack,
but if one of the libraries it uses asks for an executable stack or someone makes a mistake
and uses a compiler extension which requires an executable stack, it will silently build an
executable without the non-executable stack protection.
To verify that the stack is non-executable after compiling use:
scanelf -e ./bitcoin
The output should contain:
STK/REL/PTL
RW- R-- RW-
The `STK RW-` means that the stack is readable and writeable but not executable.
Disable-wallet mode
--------------------
When the intention is to run only a P2P node without a wallet, Bitcoin ABC may be compiled in
disable-wallet mode by passing `-DBUILD_BITCOIN_WALLET=OFF` on the cmake command line.
Mining is also possible in disable-wallet mode using the `getblocktemplate` RPC call.
Additional cmake options
--------------------------
A list of the cmake options and their current value can be displayed.
From the build subdirectory (see above), run `cmake -LH ..`.
Setup and Build Example: Arch Linux
-----------------------------------
This example lists the steps necessary to setup and build a command line only,
non-wallet distribution of the latest changes on Arch Linux:
pacman -S base-devel boost cmake git libevent ninja python
git clone https://github.com/Bitcoin-ABC/bitcoin-abc.git
cd bitcoin-abc/
mkdir build
cd build
cmake -GNinja .. -DBUILD_BITCOIN_WALLET=OFF -DBUILD_BITCOIN_QT=OFF -DENABLE_UPNP=OFF -DBUILD_BITCOIN_ZMQ=OFF -DUSE_JEMALLOC=OFF
ninja
ARM Cross-compilation
-------------------
These steps can be performed on, for example, a Debian VM. The depends system
will also work on other Linux distributions, however the commands for
installing the toolchain will be different.
Make sure you install all the build requirements mentioned above.
Then, install the toolchain and some additional dependencies:
sudo apt-get install autoconf automake curl g++-arm-linux-gnueabihf gcc-arm-linux-gnueabihf gperf pkg-config
To build executables for ARM:
cd depends
make build-linux-arm
cd ..
mkdir build
cd build
cmake -GNinja .. -DCMAKE_TOOLCHAIN_FILE=../cmake/platforms/LinuxARM.cmake -DENABLE_GLIBC_BACK_COMPAT=ON -DENABLE_STATIC_LIBSTDCXX=ON
ninja
For further documentation on the depends system see [README.md](../depends/README.md) in the depends directory.
Build using a Docker container
-------------------------------
Bitcoin ABC provides a
[Docker image](https://hub.docker.com/r/bitcoinabc/bitcoin-abc-dev) with all the
dependencies pre-installed, based on Debian. If the dependencies cannot be
installed on your system but it can run a Docker container, this image can be
pulled and used for the build.
*Note: The image has all the dependencies and can weight a few gigabytes.*
To get the latest image (current master):
```shell
docker pull bitcoinabc/bitcoin-abc-dev
```
It is also possible to use a release version. Example for 0.22.4:
```shell
docker pull bitcoinabc/bitcoin-abc-dev:0.22.4
```
Running the container will start a `bash` shell at the project root:
```shell
# On the host
docker run -it bitcoinabc/bitcoin-abc-dev
# Start the build in the container
mkdir build
cd build
cmake -GNinja ..
ninja
```
It is possible to bind the project to a local directory on the host machine.
First create an empty volume on the host:
```shell
# On the host
mkdir bitcoin-abc-volume
docker volume create \
--driver local \
--opt type=none \
--opt device=${PWD}/bitcoin-abc-volume \
--opt o=bind \
bitcoin-abc-volume
```
Then start the container with the volume bound to `/bitcoin-abc`:
```shell
docker run -it -v bitcoin-abc-volume:/bitcoin-abc bitcoinabc/bitcoin-abc-dev
```