mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-05 14:06:27 -05:00

Bitcoin Core integration/staging tree

bitcoin c-plus-plus cryptocurrency cryptography p2p

Find a file

W. J. van der Laan 6556da77d7 Merge bitcoin/bitcoin#21056 : rpc: Add a `-rpcwaittimeout` parameter to limit time spent waiting `b9e76f1bf0` rpc: Add test for -rpcwaittimeout (Christian Decker) `f76cb10d7d` rpc: Prefix rpcwaittimeout error with details on its nature (Christian Decker) `c490e17ef6` doc: Add release notes for the `-rpcwaittimeout` cli parameter (Christian Decker) `a7fcc8eb59` rpc: Add a `-rpcwaittimeout` parameter to limit time spent waiting (Christian Decker) Pull request description: Adds a new numeric `-rpcwaittimeout` that can be used to limit the time we spend waiting on the RPC server to appear. This is used by downstream projects to provide a bit of slack when `bitcoind`s RPC interface is not available right away. This makes the `-rpcwait` argument more useful, since we can now limit how long we'll ultimately wait, before potentially giving up and reporting an error to the caller. It was discussed in the context of the BTCPayServer wanting to have c-lightning wait for the RPC interface to become available but still have the option of giving up eventually ([4355]). I checked with laanwj whether this is already possible ([comment]), and whether this would be a welcome change. Initially I intended to repurpose the (optional) argument to `-rpcwait`, however I decided against it since it would potentially break existing configurations, using things like `rpcwait=1`, or `rpcwait=true` (the former would have an unintended short timeout, when old behavior was to wait indefinitely). ~Due to its simplicity I didn't implement a test for it yet, but if that's desired I can provide one.~ Test was added during reviews. [4355]: https://github.com/ElementsProject/lightning/issues/4355 [comment]: https://github.com/ElementsProject/lightning/issues/4355#issuecomment-768288261 ACKs for top commit: laanwj: Code review ACK `b9e76f1bf0` promag: ACK `b9e76f1bf0`. Tree-SHA512: 3cd6728038ec7ca7c35c2e7ccb213bfbe963f99a49bb48bbc1e511c4dd23d9957c04f9af1f8ec57120e47b26eaf580b46817b099d5fc5083c98da7aa92db8638		2021-06-21 15:54:56 +02:00
.github	doc: Remove label from good first issue template	2020-08-24 09:31:24 +02:00
.tx	qt: Bump transifex slug for 22.x	2021-04-21 13:46:41 +02:00
build-aux/m4	build, qt: Fix libraries linking order for Linux hosts	2021-06-06 23:25:07 +03:00
build_msvc	Merge bitcoin/bitcoin#22230 : build: Fix MSVC linker /SubSystem option for bitcoin-qt.exe	2021-06-14 10:06:55 +08:00
ci	build: enable external signer by default	2021-06-16 10:48:57 +02:00
contrib	Merge bitcoin/bitcoin#22244 : devtools: Correctly extract symbol versions in symbol-check	2021-06-21 07:58:12 +02:00
depends	build, qt: Fix compiling qt package in depends with GCC 11	2021-06-08 04:16:36 +03:00
doc	Merge bitcoin/bitcoin#21056 : rpc: Add a `-rpcwaittimeout` parameter to limit time spent waiting	2021-06-21 15:54:56 +02:00
share	doc: add maxuploadtarget to bitcoin.conf example	2021-05-28 12:53:17 -04:00
src	Merge bitcoin/bitcoin#21056 : rpc: Add a `-rpcwaittimeout` parameter to limit time spent waiting	2021-06-21 15:54:56 +02:00
test	Merge bitcoin/bitcoin#21056 : rpc: Add a `-rpcwaittimeout` parameter to limit time spent waiting	2021-06-21 15:54:56 +02:00
.appveyor.yml	Switch Appveyor CI to VS2019 stable image	2021-06-14 20:35:00 +01:00
.cirrus.yml	ci: Bump macOS image to big-sur-xcode-12.5	2021-06-02 10:03:38 +02:00
.editorconfig	Add EditorConfig file.	2021-02-10 08:00:06 +01:00
.gitattributes	Separate protocol versioning from clientversion	2014-10-29 00:24:40 -04:00
.gitignore	build: add *~ to .gitignore	2021-05-12 18:10:47 +02:00
.python-version	Bump minimum python version to 3.6	2020-11-09 17:53:47 +10:00
.style.yapf	test: .style.yapf: Set column_limit=160	2019-03-04 18:28:13 -05:00
autogen.sh	scripted-diff: Bump copyright of files changed in 2019	2019-12-30 10:42:20 +13:00
configure.ac	Merge bitcoin/bitcoin#22238 : build: improve detection of eBPF support	2021-06-18 15:16:00 +08:00
CONTRIBUTING.md	doc: Fix external links (IRC, ...)	2021-05-31 17:27:57 +02:00
COPYING	doc: Update license year range to 2021	2020-12-30 16:24:47 +01:00
INSTALL.md	Update INSTALL landing redirection notice for build instructions.	2016-10-06 12:27:23 +13:00
libbitcoinconsensus.pc.in	build: remove libcrypto as internal dependency in libbitcoinconsensus.pc	2019-11-19 15:03:44 +01:00
Makefile.am	Makefile.am: use APP_DIST_DIR instead of hard-coding dist	2021-05-13 15:41:56 -04:00
README.md	doc: Rework internal and external links	2021-02-17 09:18:46 +01:00
REVIEWERS	Update REVIEWERS: I've found that I keep track of PRs in need of review without the need for DrahtBot's automated notification :)	2021-06-10 09:00:05 +00:00
SECURITY.md	doc: Remove explicit mention of version from SECURITY.md	2019-06-14 06:39:17 -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/.

Further information about Bitcoin Core is available in the doc folder.

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 read the original Bitcoin 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. 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.