Bitcoin Core integration/staging tree
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
MacroFake 73b61717a9
Merge bitcoin/bitcoin#26272: test: Prevent UB in `minisketch_tests.cpp`
1 day ago
.github doc: Remove label from good first issue template 2 years ago
.tx qt: Bump Transifex slug for 24.x 2 months ago
build-aux/m4 build: sync ax_boost_base from upstream 1 month ago
build_msvc refactor: Make 64-bit shift explicit 3 days ago
ci Remove clang-format from lint task 2 days ago
contrib Merge bitcoin/bitcoin#26208: signet/miner: reduce default interblock interval limit to 30min 4 days ago
depends Merge bitcoin/bitcoin#25917: depends: libnatpmp 07004b97cf691774efebe70404cf22201e4d330d 2 weeks ago
doc Merge bitcoin/bitcoin#26128: doc: add missing historical release notes 3 days ago
share build: add example bitcoin conf to win installer 2 months ago
src Merge bitcoin/bitcoin#26272: test: Prevent UB in `minisketch_tests.cpp` 1 day ago
test Merge bitcoin/bitcoin#26138: test: Avoid race in disconnect_nodes helper 1 week ago
.cirrus.yml ci: Workaround Windows filesystem executable bit loss 3 days ago
.editorconfig ci: Drop AppVeyor CI integration 1 year ago
.gitattributes Separate protocol versioning from clientversion 8 years ago
.gitignore refactor: cleanups post unsubtree'ing univalue 4 months ago
.python-version Bump minimum python version to 3.6 2 years ago
.style.yapf test: .style.yapf: Set column_limit=160 4 years ago
CONTRIBUTING.md doc: Explain squashing with merge commits 5 months ago
COPYING doc: Update license year range to 2022 9 months ago
INSTALL.md doc: Added hyperlink for doc/build 1 year ago
Makefile.am build: package test_bitcoin in Windows installer 2 months ago
README.md doc: Explain Bitcoin Core in README.md 5 months ago
REVIEWERS doc: empty REVIEWERS file 2 months ago
SECURITY.md doc: Add my key to SECURITY.md 1 month ago
autogen.sh scripted-diff: Bump copyright of files changed in 2019 3 years ago
configure.ac build: remove stdlib.h from header checks 2 weeks ago
libbitcoinconsensus.pc.in build: remove libcrypto as internal dependency in libbitcoinconsensus.pc 3 years ago

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 in configure) with: make check. 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.