Bitcoin Core integration/staging tree

cryptocurrency c-plus-plus cryptography bitcoin p2p

Go to file

fanquake 083316c4fe Merge bitcoin/bitcoin#28230 : rpc: Add MaybeArg() and Arg() default helper `c00000df16` rpc: Add MaybeArg() and Arg() default helper (MarcoFalke) Pull request description: Currently the RPC method implementations have many issues: * Default RPC argument values (and their optionality state) are duplicated in the documentation and the C++ code, with no checks to prevent them from going out of sync. * Getting an optional RPC argument is verbose, using a ternary operator, or worse, a multi-line `if`. Fix all issues by adding default helper that can be called via `self.Arg<int>(0)`. The helper needs a few lines of code in the `src/rpc/util.h` header file. Everything else will be implemented in the cpp file once and if an RPC method needs it. There is also an `self.MaybeArg<int>(0)` helper that works on any arg to return the argument, the default, or a falsy value. ACKs for top commit: ajtowns: reACK `c00000df16` stickies-v: re-ACK `c00000df16` TheCharlatan: re-ACK `c00000df16` Tree-SHA512: e7ddcab3faa319bc53edbdf3f89ce83389d2c4e571d5db42401620ff105e522a4a0669dad08e08cde5fd05c790aec3b806f63261a9100c2778865a489e57381e		1 year ago
.github	Merge bitcoin/bitcoin#28322 : ci: Use concurrency for pull requests only	1 year ago
.tx	qt: Bump Transifex slug for 25.x	2 years ago
build-aux/m4	build: Bump minimum supported GCC to g++-9	2 years ago
build_msvc	Remove unused raw-pointer read helper from univalue	1 year ago
ci	Merge bitcoin/bitcoin#28330 : ci: Add missing docker.io prefix for native tasks to CI_IMAGE_NAME_TAG	1 year ago
contrib	guix: consolidate Linux GCC package	1 year ago
depends	depends: xcb-proto 1.15.2	1 year ago
doc	Merge bitcoin/bitcoin#28189 : doc: diversify network outbounds release note	1 year ago
share	depends: Bump MacOS minimum runtime requirement to 11.0	1 year ago
src	rpc: Add MaybeArg() and Arg() default helper	1 year ago
test	Merge bitcoin/bitcoin#28332 : test: previous releases: speed up fetching sources with shallow clone	1 year ago
.cirrus.yml	ci: Remove distro-name from task name	1 year ago
.editorconfig	…
.gitattributes	…
.gitignore	refactor: cleanups post unsubtree'ing univalue	2 years ago
.python-version	ci: Use DOCKER_BUILDKIT for lint image	1 year ago
.style.yapf	Update .style.yapf	1 year ago
CONTRIBUTING.md	doc: Explain squashing with merge commits	3 years ago
COPYING	doc: Update license year range to 2023	2 years ago
INSTALL.md	doc: Added hyperlink for doc/build	3 years ago
Makefile.am	build: package test_bitcoin in Windows installer	2 years ago
README.md	doc: Explain Bitcoin Core in README.md	3 years ago
SECURITY.md	doc: Add my key to SECURITY.md	2 years ago
autogen.sh	build: make sure we can overwrite config.{guess,sub}	1 year ago
configure.ac	Merge bitcoin/bitcoin#28092 : ci: document that -Wreturn-type has been fixed upstream (mingw-w64)	1 year ago
libbitcoinconsensus.pc.in	…

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.