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.
Samuel Dobson 80486e7e2d
Merge #20952: wallet: Add BerkeleyDB version sanity check at init time
3 months ago
.github doc: Remove label from good first issue template 8 months ago
.tx tx: Update transifex slug for 0.21 7 months ago
build-aux/m4 build: improve macro for testing -latomic requirement 4 months ago
build_msvc scripted-diff: Bump copyright headers 4 months ago
ci ci: Add libnatpmp-dev package to some builds 4 months ago
contrib Merge #20937: guix: Make nsis reproducible by respecting SOURCE-DATE-EPOCH 3 months ago
depends depends: Add comment about cache invalidation 4 months ago
doc Fix 0.21.0 release note to specify correct option BIP 157 support 4 months ago
share genbuild: Specify rev-parse length 4 months ago
src Merge #20952: wallet: Add BerkeleyDB version sanity check at init time 3 months ago
test Merge #20937: guix: Make nsis reproducible by respecting SOURCE-DATE-EPOCH 3 months ago
.appveyor.yml Removed redundant git pull from appveyor config. 5 months ago
.cirrus.yml ci: Add libnatpmp-dev package to some builds 4 months ago
.fuzzbuzz.yml fuzz: remove no-longer-necessary packages from fuzzbuzz config 4 months ago
.gitattributes Separate protocol versioning from clientversion 6 years ago
.gitignore Merge #19937: signet mining utility 4 months ago
.python-version Bump minimum python version to 3.6 6 months ago
.style.yapf test: .style.yapf: Set column_limit=160 2 years ago
CONTRIBUTING.md Replace `hidden service` with `onion service` 9 months ago
COPYING doc: Update license year range to 2021 4 months ago
INSTALL.md Update INSTALL landing redirection notice for build instructions. 4 years ago
Makefile.am Merge #19937: signet mining utility 4 months ago
README.md doc: Drop mentions of Travis CI as it is no longer used 5 months ago
REVIEWERS doc: rename CODEOWNERS to REVIEWERS 5 months ago
SECURITY.md doc: Remove explicit mention of version from SECURITY.md 1 year ago
autogen.sh scripted-diff: Bump copyright of files changed in 2019 1 year ago
configure.ac Merge #19866: eBPF Linux tracepoints 4 months ago
libbitcoinconsensus.pc.in build: remove libcrypto as internal dependency in libbitcoinconsensus.pc 1 year ago

README.md

Bitcoin Core integration/staging tree

https://bitcoincore.org

What is Bitcoin?

Bitcoin is an experimental 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 Core is the name of open source software which enables the use of this currency.

For more information, as well as an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the original whitepaper.

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, that are run automatically on the build server. 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.

Translators should also subscribe to the mailing list.