mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-25 10:43:19 -03:00

Bitcoin Core mirror and no, I don't give a fuck about Monero.

bitcoin c-plus-plus cryptocurrency cryptography p2p

Find a file

Ryan Ofsky f562856d02 Merge bitcoin/bitcoin#27866 : blockstorage: Return on fatal flush errors `d8041d4e04` blockstorage: Return on fatal undo file flush error (TheCharlatan) `f0207e0030` blockstorage: Return on fatal block file flush error (TheCharlatan) `5671c15f45` blockstorage: Mark FindBlockPos as nodiscard (TheCharlatan) Pull request description: The goal of this PR is to establish that fatal blockstorage flush errors should be treated as errors at their call site. Prior to this patch `FlushBlockFile` may have failed without returning in `Chainstate::FlushStateToDisk`, leading to a potential write from `WriteBlockIndexDB` that may refer to a block that is not fully flushed to disk yet. By returning if either `FlushUndoFile` or `FlushBlockFile` fail, we ensure that no further write operations take place that may lead to an inconsistent database when crashing. Add `[[nodiscard]]` annotations to them such that they are not ignored in future. Functions that call either `FlushUndoFile` or `FlushBlockFile`, need to handle these extra abort cases properly. Since `Chainstate::FlushStateToDisk` already produces an abort error in case of `WriteBlockIndexDB` failing, no extra logic for functions calling `Chainstate::FlushStateToDisk` is required. Besides `Chainstate::FlushStateToDisk`, `FlushBlockFile` is also called by `FindBlockPos`, while `FlushUndoFile` is only called by `FlushBlockFile` and `WriteUndoDataForBlock`. For both these cases, the flush error is not further bubbled up. Instead, the error is logged and a comment is provided why bubbling up an error would be less desirable in these cases. --- This pull request is part of a larger effort towards improving the shutdown / abort / fatal error handling in validation code. It is a first step towards implementing proper fatal error return type enforcement similar as proposed by theuni in this pull request [comment](https://github.com/bitcoin/bitcoin/pull/27711#issuecomment-1563561502). For ease of review of these critical changes, a first step would be checking that `AbortNode` leads to early and error-conveying returns at its call site. Further work for enforcing returns when `AbortNode` is called is done in https://github.com/bitcoin/bitcoin/pull/27862. ACKs for top commit: stickies-v: re-ACK `d8041d4` ryanofsky: Code review ACK `d8041d4e04` Tree-SHA512: 47ade9b873b15e567c8f60ca538d5a0daf32163e1031be3212a3a45eb492b866664b225f2787c9e40f3e0c089140157d8fd1039abc00c7bdfeec1b52ecd7e219		2023-09-29 13:29:51 -04:00
.github	ci: Install Homebrew's `pkg-config` package	2023-09-20 21:49:57 +01:00
.tx	qt: Bump Transifex slug for 26.x	2023-09-01 07:49:31 +01:00
build-aux/m4	build: Bump minimum supported GCC to g++-9	2023-05-18 12:24:40 +02:00
build_msvc	Remove unused raw-pointer read helper from univalue	2023-07-27 14:24:52 +02:00
ci	Merge bitcoin/bitcoin#28504 : ci: Use nproc over MAKEJOBS in 01_base_install	2023-09-20 16:14:30 +00:00
contrib	build: remove dmg dependencies	2023-09-15 13:47:50 +01:00
depends	Merge bitcoin/bitcoin#28432 : build: Produce a `.zip` for macOS distribution	2023-09-20 11:40:47 +00:00
doc	Merge bitcoin/bitcoin#28512 : doc: Be vague instead of wrong about MALLOC_ARENA_MAX	2023-09-24 18:54:16 +01:00
share	depends: Bump MacOS minimum runtime requirement to 11.0	2023-06-22 15:28:47 +00:00
src	Merge bitcoin/bitcoin#27866 : blockstorage: Return on fatal flush errors	2023-09-29 13:29:51 -04:00
test	Merge bitcoin/bitcoin#28540 : tests: Fix wallet_resendwallettransactions.py intermittent failure by using manual bumps instead of bumpfee	2023-09-28 11:22:10 -04:00
.cirrus.yml	Merge bitcoin/bitcoin#28353 : ci: Remove /ro_base bind mount, Remove LC_ALL=C from s390x task	2023-08-30 16:23:39 +01: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	build: produce a .zip for macOS distribution	2023-09-15 13:47:50 +01:00
.python-version	ci: Use DOCKER_BUILDKIT for lint image	2023-07-16 13:18:18 +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
configure.ac	build: remove dmg dependencies	2023-09-15 13:47:50 +01:00
CONTRIBUTING.md	doc: Explain squashing with merge commits	2022-05-24 08:17:41 +02:00
COPYING	doc: Update license year range to 2023	2022-12-24 11:40:16 +01:00
INSTALL.md	doc: Added hyperlink for doc/build	2021-09-09 19:53:12 +05:30
libbitcoinconsensus.pc.in	build: remove libcrypto as internal dependency in libbitcoinconsensus.pc	2019-11-19 15:03:44 +01:00
Makefile.am	build: produce a .zip for macOS distribution	2023-09-15 13:47:50 +01:00
README.md	doc: Explain Bitcoin Core in README.md	2022-05-10 07:49:09 +02:00
SECURITY.md	doc: Add my key to SECURITY.md	2022-08-23 16:57:46 -04: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 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.