mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-02 09:46:52 -05:00

Bitcoin Core integration/staging tree

bitcoin c-plus-plus cryptocurrency cryptography p2p

Find a file

merge-script 338bc2cd26 Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system `41051290ab` cmake: Ignore build subdirectories within source directory (Hennadii Stepanov) `6ce50fd9d0` doc: Update for CMake-based build system (Hennadii Stepanov) `9730288a0c` ci: Migrate CI scripts to CMake (Hennadii Stepanov) `c360837ca5` cmake, lint: Adjust `lint_includes_build_config` (Hennadii Stepanov) `3885441ee0` cmake: Add presets for native Windows builds (Hennadii Stepanov) `7681746b20` cmake: Add vcpkg manifest file (Hennadii Stepanov) `8b6f1c4353` cmake: Add `Coverage` and `CoverageFuzz` scripts (Hennadii Stepanov) `65bdbc1ff2` cmake: Add `docs` build target (Hennadii Stepanov) `fb75ebbc33` cmake: Add compiler diagnostic flags (Hennadii Stepanov) `e821f0a37a` cmake: Migrate Guix build scripts to CMake (Hennadii Stepanov) `747adb6ffe` cmake: Add `Maintenance` module (Hennadii Stepanov) `1f60b30df0` cmake: Add `APPEND_{CPP,C,CXX,LD}FLAGS` cache variables (Hennadii Stepanov) `2b43c45b13` cmake: Add `AddWindowsResources` module (Hennadii Stepanov) `973a3b0c5d` cmake: Implement `install` build target (Hennadii Stepanov) `84ac35cfd4` cmake: Add cross-compiling support (Hennadii Stepanov) `0d01c228a7` build: Generate `toolchain.cmake` in depends (Hennadii Stepanov) `91a799247d` depends: Add host-specific `cmake_system_version` variables (Hennadii Stepanov) `9b31209b4c` depends: Rename `cmake_system` -> `cmake_system_name` (Hennadii Stepanov) `4a5208a81d` Revert "build, qt: Do not install .prl files" (Hennadii Stepanov) `6522af62af` depends: Amend handling flags environment variables (Hennadii Stepanov) `90cec4d251` cmake: Add `MULTIPROCESS` option (Hennadii Stepanov) `bb1a450dcb` cmake: Build `bitcoin-chainstate` executable (Hennadii Stepanov) `aed38ea58c` cmake: Build `bitcoinkernel` library (Hennadii Stepanov) `975d67369b` cmake: Build `test_bitcoin-qt` executable (Hennadii Stepanov) `10fcc668a3` cmake: Add `WITH_DBUS` option (Hennadii Stepanov) `5bb5a4bc75` cmake: Add `libqrencode` optional package support (Hennadii Stepanov) `57a6e2ef4a` cmake: Build `bitcoin-qt` executable (Hennadii Stepanov) `30f642952c` cmake: Add `WERROR` option (Hennadii Stepanov) `c98d4a4c34` cmake: Add `REDUCE_EXPORTS` option (Hennadii Stepanov) `a01cb6e63f` cmake: Add `HARDENING` option (Hennadii Stepanov) `a8a2e364ac` cmake: Add Python-based tests (Hennadii Stepanov) `3d85379570` cmake: Add fuzzing options (Hennadii Stepanov) `908530e312` cmake: Add `SANITIZERS` option (Hennadii Stepanov) `8bb0e85631` cmake: Build `bench_bitcoin` executable (Hennadii Stepanov) `801735163a` cmake: Add external signer support (Hennadii Stepanov) `353e0c9e96` cmake: Add `systemtap-sdt` optional package support (Hennadii Stepanov) `d2fda82b49` cmake: Add `libzmq` optional package support (Hennadii Stepanov) `ae7b39a0e1` cmake: Add `libminiupnpc` optional package support (Hennadii Stepanov) `6480e1dcdb` cmake: Add `libnatpmp` optional package support (Hennadii Stepanov) `e73e9304a1` cmake: Build `bitcoin-util` executable (Hennadii Stepanov) `027c6d7caa` cmake: Build `bitcoin-tx` executable (Hennadii Stepanov) `d10c5c34c3` cmake: Add wallet functionality (Hennadii Stepanov) `ab2e99b0d9` cmake: Create test suite for `ctest` (Hennadii Stepanov) `959370bd76` cmake: Build `test_bitcoin` executable (Hennadii Stepanov) `b27bf9700d` cmake: Build `bitcoin-cli` executable (Hennadii Stepanov) `a9813df826` cmake: Build `bitcoind` executable (Hennadii Stepanov) `97829ce2d5` cmake: Add `FindLibevent` module (Hennadii Stepanov) `3118e40c61` cmake: Build `bitcoin_consensus` library (Hennadii Stepanov) `809a2f1929` cmake: Build `bitcoin_util` static library (Hennadii Stepanov) `0a9a521a70` cmake: Build `bitcoin_crypto` library (Hennadii Stepanov) `958971f476` cmake: Build `univalue` static library (Hennadii Stepanov) `752747fda8` cmake: Generate `obj/build.h` header (Hennadii Stepanov) `1f0a78edf3` cmake: Build `minisketch` static library (Hennadii Stepanov) `12bfbc8154` cmake: Build `leveldb` static library (Hennadii Stepanov) `51985c5304` cmake: Build `crc32c` static library (Hennadii Stepanov) `db7a198f29` cmake: Build `secp256k1` subtree (Hennadii Stepanov) `dbb7ed14e8` cmake: Add `ccache` support (Hennadii Stepanov) `cedfdf6c72` cmake: Redefine/adjust per-configuration flags (Hennadii Stepanov) `b6b5e732c8` cmake: Add global compiler and linker flags (Hennadii Stepanov) `f98327931b` cmake: Add `TryAppendLinkerFlag` module (Hennadii Stepanov) `4a0af29697` cmake: Add `TryAppendCXXFlags` module (Hennadii Stepanov) `35cffc497d` cmake: Add POSIX threads support (Hennadii Stepanov) `fd72d00ffe` cmake: Add position independent code support (Hennadii Stepanov) `07069e2bb0` cmake: Add introspection module (Hennadii Stepanov) `27d687fc1f` cmake: Add `config/bitcoin-config.h` support (Hennadii Stepanov) `fe5cdace5f` cmake: Print compiler and linker flags in summary (Hennadii Stepanov) `70683884c5` cmake: Introduce interface libraries to encapsulate common flags (Hennadii Stepanov) `a2317e27b7` cmake: Add root `CMakeLists.txt` file (Hennadii Stepanov) Pull request description: This PR introduces a new CMake-based build system, which is a drop-in replacement for the current Autotools-based build system. ML announcement: https://groups.google.com/g/bitcoindev/c/hgKkfQWzrTo As discussed during the recent CoreDev meetup in April, the switch from Autotools to CMake is intended to happen as soon as possible after branching 28.x off, which means that 29.0 will be built using CMake. This PR branch is essentially the [staging branch](https://github.com/hebasto/bitcoin/tree/cmake-staging), with every change reviewed and tested by a group of contributors, including (in alphabetical order): - [achow101](https://github.com/achow101) - [fanquake](https://github.com/fanquake) - [maflcko](https://github.com/maflcko) - [m3dwards](https://github.com/m3dwards) - [pablomartin4btc](https://github.com/pablomartin4btc) - [real-or-random](https://github.com/real-or-random) - [ryanofsky](https://github.com/ryanofsky) - [sipsorcery](https://github.com/sipsorcery) - [TheCharlatan](https://github.com/TheCharlatan) - [theStack](https://github.com/theStack) - [theuni](https://github.com/theuni) - [vasild*](https://github.com/vasild) Reviewing in a separate staging repo was suggested in https://github.com/bitcoin/bitcoin/pull/27060#issuecomment-1431798320. The accompanying changes to the OSS-Fuzz project are available in https://github.com/hebasto/oss-fuzz/pull/8. Please refer to the [build options parity table](https://gist.github.com/hebasto/2ef97d3a726bfce08ded9df07f7dab5e). The "auto" value is no longer available; non-default values must be specified explicitly. Additionally, the new default values have been chosen to suit the everyday build experience for the majority of developers. System requirements for using the CMake-based build system: - CMake >= 3.22 (if not available in your system's repository, it can be downloaded from https://cmake.org/download/) - a build tool of your choice: - any Make (GNU Make is no longer a requirement); GNU Make is still required to build depends - Ninja (https://ninja-build.org/) - MSBuild - Xcode A note for Windows users: The default installation of the latest version of MSVC 17.10.4 includes both CMake 3.28.3 and the vcpkg package manager). --- We, the build system developers, kindly ask reviewers to refrain from making suggestions that are not directly related to the migration process or can be implemented separately. Bugs in the scripts and errors in the updated documentation should be the focus of this PR. Please be advised that comments not aligned with this PR's goal may be ignored. Thank you all for your understanding. ACKs for top commit: maflcko: review ACK `41051290ab` 🐥 sipsorcery: ACK `41051290ab`. vasild: ACK `41051290ab` TheCharlatan: ACK `41051290ab` pablomartin4btc: tACK `41051290ab` i-am-yuvi: tACK [`4105129`](`41051290ab`) theuni: ACK `41051290ab`. fanquake: ACK `41051290ab` Tree-SHA512: 6c1445054436c6c00ad63bfa0f19d64091a2b25c9bd694f85bf2218ac358ffb774d6c000685b3ca1e9b50401babed989fa2a0694b774c211d226bfd1944c9b39		2024-08-28 10:51:24 +01:00
.github	ci: Migrate CI scripts to CMake	2024-08-16 21:19:13 +01:00
.tx	qt: Bump Transifex slug for 28.x	2024-07-30 16:14:19 +01:00
build-aux/m4	qt, build: Drop `QT_STATICPLUGIN` macro	2024-08-01 14:01:07 +01:00
build_msvc	build: remove check for __declspec(dllexport)	2024-08-05 14:54:56 +01:00
ci	Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system	2024-08-28 10:51:24 +01:00
cmake	cmake: Add `Coverage` and `CoverageFuzz` scripts	2024-08-16 21:19:12 +01:00
contrib	Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system	2024-08-28 10:51:24 +01:00
depends	doc: Update for CMake-based build system	2024-08-16 21:24:08 +01:00
doc	Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system	2024-08-28 10:51:24 +01:00
share	contrib: rpcauth.py - Add new option (-j/--json) to output text in json format	2024-04-25 08:32:28 -05:00
src	Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system	2024-08-28 10:51:24 +01:00
test	Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system	2024-08-28 10:51:24 +01:00
.cirrus.yml	ci: forks can opt-out of CI branch push (Cirrus only)	2024-06-25 20:03:44 +02:00
.editorconfig	ci: Drop AppVeyor CI integration	2021-09-07 06:12:53 +03:00
.gitattributes	Separate protocol versioning from clientversion	2014-10-29 00:24:40 -04:00
.gitignore	cmake: Ignore build subdirectories within source directory	2024-08-16 21:24:08 +01:00
.python-version	Bump .python-version from 3.9.17 to 3.9.18	2023-10-24 18:51:24 +02:00
.style.yapf	Update .style.yapf	2023-06-01 23:35:10 +05:30
autogen.sh	build: make sure we can overwrite config.{guess,sub}	2023-06-13 14:58:43 +02:00
CMakeLists.txt	cmake: Add `Coverage` and `CoverageFuzz` scripts	2024-08-16 21:19:12 +01:00
CMakePresets.json	cmake: Add presets for native Windows builds	2024-08-16 21:19:12 +01:00
configure.ac	build: Bump to 28.99	2024-08-26 15:12:58 -04:00
CONTRIBUTING.md	doc: Correct pull request prefix for scripts and tools	2024-05-22 09:59:58 +02:00
COPYING	doc: upgrade Bitcoin Core license to 2024	2024-01-10 16:29:01 -06:00
INSTALL.md	doc: Added hyperlink for doc/build	2021-09-09 19:53:12 +05:30
Makefile.am	contrib: use c++ rather than c for binary tests	2024-07-04 20:16:16 +00:00
README.md	doc: Update for CMake-based build system	2024-08-16 21:24:08 +01:00
SECURITY.md	Update security.md contact for achow101	2023-12-14 18:14:54 -05:00
vcpkg.json	cmake: Add vcpkg manifest file	2024-08-16 21:19:12 +01:00

README.md

Bitcoin Core integration/staging tree

https://bitcoincore.org

For an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/.

What is Bitcoin Core?

Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully validate blocks and transactions. It also includes a wallet and graphical user interface, which can be optionally built.

Further information about Bitcoin Core is available in the doc folder.

License

Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

Development Process

The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be completely stable. Tags are created regularly from release branches to indicate new official, stable release versions of Bitcoin Core.

The https://github.com/bitcoin-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.

Automated Testing

Developers are strongly encouraged to write unit tests for new code, and to submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled during the generation of the build system) with: ctest. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The CI (Continuous Integration) systems make sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.

Translations

Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.