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.
 
 
 
 
 
 
fanquake d8f9826037
Merge bitcoin/bitcoin#27030: Update nanobench to version v4.3.10
13 hours ago
.github doc: remove usages of C++11 4 weeks ago
.tx Adjust `.tx/config` for new Transifex CLI 4 months ago
build-aux/m4 build: remove Boost lib detection from ax_boost_base 3 weeks ago
build_msvc Merge bitcoin/bitcoin#26691: Update secp256k1 subtree to libsecp256k1 version 0.2.0 3 weeks ago
ci Merge bitcoin/bitcoin#27012: ci: Print iwyu patch in git diff format 4 days ago
contrib contrib: remove install_db4.sh 3 weeks ago
depends depends: ensure we are appending to sqlite cflags 6 days ago
doc doc: release notes for #27037 2 days ago
share build: add example bitcoin conf to win installer 6 months ago
src Merge bitcoin/bitcoin#27030: Update nanobench to version v4.3.10 13 hours ago
test rpc: decode Miniscript descriptor when possible in decodescript 2 days ago
.cirrus.yml ci: Fetch no git history, unless lint 1 week 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 8 months ago
.python-version Bump minimum python version to 3.7 3 weeks ago
.style.yapf test: .style.yapf: Set column_limit=160 4 years ago
CONTRIBUTING.md doc: Explain squashing with merge commits 9 months ago
COPYING doc: Update license year range to 2023 1 month ago
INSTALL.md doc: Added hyperlink for doc/build 1 year ago
Makefile.am build: package test_bitcoin in Windows installer 6 months ago
README.md doc: Explain Bitcoin Core in README.md 9 months ago
REVIEWERS doc: empty REVIEWERS file 6 months ago
SECURITY.md doc: Add my key to SECURITY.md 6 months ago
autogen.sh scripted-diff: Bump copyright of files changed in 2019 3 years ago
configure.ac Merge bitcoin/bitcoin#26952: build: Avoid `BOOST_NO_CXX98_FUNCTION_BASE` macro redefinition 6 days 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.