LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity
The blockchain that provides the digital content namespace for the LBRY protocol
18741 commits 22 branches 42 tags 99 MiB
C++ 66.5%
Python 15.1%
C 12.7%
M4 2.1%
Makefile 1.2%
Other 2.3%
Find a file
MarcoFalke c651265c93
Merge #14530: Use RPCHelpMan to generate RPC doc strings 
fa483e13b3 rpc: Add RPCHelpMan for machine-generated help (MarcoFalke)
fa0d36f712 rpc: Include rpc/util.h where needed for RPCHelpMan (MarcoFalke)

Pull request description:

  This introduces a manager for the RPC help generation and demonstrates its use of it in some RPCs.

  It is the first non-exhaustive step toward #14378 and I will create pull requests for the next steps after this one is merged.

Tree-SHA512: 86f68322443ff01cd964aaf0ebe186be63fbebe4c47676cf7a622cc2b5305fd176bd57badfd1bbf788a036812253eb0dead74ecc3b30664c3e0d9392b2248054
2018-11-13 12:34:50 -05:00
.github doc: Add GitHub pr template 2018-09-23 08:31:11 -04:00
.travis travis: Avoid timeout on verify-commits check 2018-11-10 13:08:33 -05:00
.tx tx: Update transifex slug 016x→017x 2018-08-02 13:42:15 +02:00
build-aux/m4 Merge #13095: build: update ax_boost_chrono/unit_test_framework 2018-07-26 08:54:59 -04:00
build_msvc Add skeleton chain and client classes 2018-11-06 11:44:40 -04:00
contrib Merge #14611: docs: align items in contrib init 2018-11-07 11:05:40 -05:00
depends build: Remove illegal spacing in darwin.mk 2018-11-03 05:03:50 -05:00
doc Merge #13381: RPC: creates possibility to preserve labels on importprivkey 2018-11-13 14:52:01 +07:00
share Merge #12783: macOS: disable AppNap during sync 2018-11-10 10:37:59 +01:00
src Merge #14530: Use RPCHelpMan to generate RPC doc strings 2018-11-13 12:34:50 -05:00
test Merge #14705: travis: Avoid timeout on verify-commits check 2018-11-13 12:25:25 -05:00
.appveyor.yml appveyor: Script improvement part II 2018-11-06 10:58:10 +08:00
.gitattributes Separate protocol versioning from clientversion 2014-10-29 00:24:40 -04:00
.gitignore gitignore contents of db4 folder 2018-10-19 12:15:47 +08:00
.travis.yml Add llvm-symbolizer directory to PATH. Needed to get symbolized stack traces from the sanitizers. 2018-11-06 17:45:54 +01:00
autogen.sh Add "export LC_ALL=C" to all shell scripts 2018-06-14 15:27:52 +02:00
configure.ac build: Add --disable-bip70 configure option 2018-10-09 03:36:14 -06:00
CONTRIBUTING.md added details about commit messages 2018-10-30 07:59:10 +01:00
COPYING [Trivial] Update license year range to 2018 2018-01-01 04:33:09 +09:00
INSTALL.md Update INSTALL landing redirection notice for build instructions. 2016-10-06 12:27:23 +13:00
libbitcoinconsensus.pc.in Unify package name to as few places as possible without major changes 2015-12-14 02:11:10 +00:00
Makefile.am Merge #14253: Build: during 'make clean', remove some files that are currently missed. 2018-10-08 04:32:48 -03:00
README.md [doc] conf: Remove deprecated options from docs, Other cleanup 2018-11-07 13:30:03 -05:00

README.md

Bitcoin Core integration/staging tree

Build Status

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 useable, 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 and tested, but is not guaranteed to be completely stable. Tags are created regularly to indicate new official, stable release versions of Bitcoin Core.

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 Travis CI system makes 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.