Bitcoin Core integration/staging tree
Go to file
2024-10-25 09:27:30 -04:00
.github ci: remove UPnP options 2024-10-25 09:27:12 -04:00
.tx qt: Bump Transifex slug for 28.x 2024-07-30 16:14:19 +01:00
ci ci: remove UPnP options 2024-10-25 09:27:12 -04:00
cmake build: drop miniupnpc dependency 2024-10-24 18:23:31 +02:00
contrib Merge bitcoin/bitcoin#31121: guix: Enable CET for glibc package 2024-10-21 14:59:32 +01:00
depends depends: drop miniupnpc 2024-10-25 09:27:30 -04:00
doc doc: add release note for #31130 2024-10-25 09:27:30 -04:00
share Merge bitcoin/bitcoin#26334: Add Signet and testnet4 launch shortcuts for Windows 2024-10-21 15:00:32 +01:00
src build: drop miniupnpc dependency 2024-10-24 18:23:31 +02:00
test daemon: remove UPnP support 2024-10-24 18:23:30 +02:00
.cirrus.yml ci: Inline PACKAGE_MANAGER_INSTALL 2024-09-26 18:52:08 +02:00
.editorconfig code style: update .editorconfig file 2024-09-13 17:55:10 +02:00
.gitattributes Separate protocol versioning from clientversion 2014-10-29 00:24:40 -04:00
.gitignore build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
.python-version Bump python minimum supported version to 3.10 2024-08-28 15:53:07 +02:00
.style.yapf Update .style.yapf 2023-06-01 23:35:10 +05:30
CMakeLists.txt build: drop miniupnpc dependency 2024-10-24 18:23:31 +02:00
CMakePresets.json build: drop miniupnpc dependency 2024-10-24 18:23:31 +02:00
CONTRIBUTING.md doc: replace Autotools with CMake 2024-08-29 16:06:29 +01: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
libbitcoinkernel.pc.in build: Add a pkg-config file for libbitcoinkernel 2024-09-06 21:35:07 +02:00
README.md doc: cmake: prepend and explain "build/" where needed 2024-10-11 11:24:21 -06:00
SECURITY.md Update security.md contact for achow101 2023-12-14 18:14:54 -05:00
vcpkg.json build: drop miniupnpc dependency 2024-10-24 18:23:31 +02:00

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: build/test/functional/test_runner.py (assuming build is your build directory).

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.