927e5280bd
4a426d8 Add note about Valgrind suppressions file in developer-notes.md (practicalswift)
84e2462 contrib: Add Valgrind suppressions file (practicalswift)
Pull request description:
Includes known Valgrind warnings in our dependencies that cannot be fixed in-tree.
Example use:
```
$ valgrind --suppressions=contrib/valgrind.supp src/test/test_bitcoin
$ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \
--show-leak-kinds=all src/test/test_bitcoin --log_level=test_suite
```
Running with the suppressions file under Ubuntu 16.04:
```
$ valgrind --suppressions=contrib/valgrind.supp --leak-check=full --show-leak-kinds=all src/test/test_bitcoin --log_level=test_suite --run_test=wallet_crypto
…
==10769== LEAK SUMMARY:
==10769== definitely lost: 0 bytes in 0 blocks
==10769== indirectly lost: 0 bytes in 0 blocks
==10769== possibly lost: 0 bytes in 0 blocks
==10769== still reachable: 0 bytes in 0 blocks
==10769== suppressed: 72,704 bytes in 1 blocks
```
Running without the suppressions file under Ubuntu 16.04:
```
$ valgrind --leak-check=full --show-leak-kinds=all src/test/test_bitcoin --log_level=test_suite --run_test=wallet_crypto
…
==10724== 72,704 bytes in 1 blocks are still reachable in loss record 1 of 1
==10724== at 0x4C2DBF6: malloc (vg_replace_malloc.c:299)
==10724== by 0x6F74EFF: ??? (in /usr/lib/x86_64-linux-gnu/libstdc++.so.6.0.21)
==10724== by 0x40106B9: call_init.part.0 (dl-init.c:72)
==10724== by 0x40107CA: call_init (dl-init.c:30)
==10724== by 0x40107CA: _dl_init (dl-init.c:120)
==10724== by 0x4000C69: ??? (in /lib/x86_64-linux-gnu/ld-2.23.so)
==10724== by 0x2: ???
==10724== by 0x1FFF0006D2: ???
==10724== by 0x1FFF0006E8: ???
==10724== by 0x1FFF0006FF: ???
==10724==
==10724== LEAK SUMMARY:
==10724== definitely lost: 0 bytes in 0 blocks
==10724== indirectly lost: 0 bytes in 0 blocks
==10724== possibly lost: 0 bytes in 0 blocks
==10724== still reachable: 72,704 bytes in 1 blocks
==10724== suppressed: 0 bytes in 0 blocks
```
Tree-SHA512: 9c92079fc61313ea678deb6aaa16a3a71c3154c757459793eb9ca0d90a9a74c6faebfb04c9135e1b398ca34224fb7f03bd9c488ea0e8debf6894f69f030a31d3
Bitcoin Core
Setup
Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions (which is currently more than 100 GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
To download Bitcoin Core, visit bitcoincore.org.
Running
The following are some helpful notes on how to run Bitcoin on your native platform.
Unix
Unpack the files into a directory and run:
bin/bitcoin-qt(GUI) orbin/bitcoind(headless)
Windows
Unpack the files into a directory, and then run bitcoin-qt.exe.
OS X
Drag Bitcoin-Core to your applications folder, and then run Bitcoin-Core.
Need Help?
- See the documentation at the Bitcoin Wiki for help and more information.
- Ask for help on #bitcoin on Freenode. If you don't have an IRC client use webchat here.
- Ask for help on the BitcoinTalk forums, in the Technical Support board.
Building
The following are developer notes on how to build Bitcoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
- Dependencies
- OS X Build Notes
- Unix Build Notes
- Windows Build Notes
- OpenBSD Build Notes
- Gitian Building Guide
Development
The Bitcoin repo's root README contains relevant information on the development process and automated testing.
- Developer Notes
- Release Notes
- Release Process
- Source Code Documentation (External Link)
- Translation Process
- Translation Strings Policy
- Travis CI
- Unauthenticated REST Interface
- Shared Libraries
- BIPS
- Dnsseed Policy
- Benchmarking
Resources
- Discuss on the BitcoinTalk forums, in the Development & Technical Discussion board.
- Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client use webchat here.
- Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client use webchat here.
Miscellaneous
- Assets Attribution
- Files
- Fuzz-testing
- Reduce Traffic
- Tor Support
- Init Scripts (systemd/upstart/openrc)
- ZMQ
License
Distributed under the MIT software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.