Go to file

fanquake ce3bdd0ed1 Merge #19316 : [net] Cleanup logic around connection types `01e283068b` [net] Remove unnecessary default args on CNode constructor (Amiti Uttarwar) `bc5d65b3ca` [refactor] Remove IsOutboundDisconnectionCandidate (Amiti Uttarwar) `2f2e13b6c2` [net/refactor] Simplify multiple-connection checks (Amiti Uttarwar) `7f7b83deb2` [net/refactor] Rework ThreadOpenConnections logic (Amiti Uttarwar) `35839e963b` [net] Fix bug where AddrFetch connections would be counted as outbound full relay (Amiti Uttarwar) `4972c21b67` [net/refactor] Clarify logic for selecting connections in ThreadOpenConnections (Amiti Uttarwar) `60156f5fc4` [net/refactor] Remove fInbound flag from CNode (Amiti Uttarwar) `7b322df629` [net/refactor] Remove m_addr_fetch member var from CNode (Amiti Uttarwar) `14923422b0` [net/refactor] Remove fFeeler flag from CNode (Amiti Uttarwar) `49efac5cae` [net/refactor] Remove m_manual_connection flag from CNode (Amiti Uttarwar) `d3698b5ee3` [net/refactor] Add connection type as a member var to CNode (Amiti Uttarwar) `46578c03e9` [doc] Describe different connection types (Amiti Uttarwar) `442abae2ba` [net/refactor] Add AddrFetch connections to ConnectionType enum (Amiti Uttarwar) `af59feb052` [net/refactor] Extract m_addr_known logic from initializer list (Amiti Uttarwar) `e1bc29812d` [net/refactor] Add block relay only connections to ConnectionType enum (Amiti Uttarwar) `0e52a659a2` [net/refactor] Add feeler connections to ConnectionType enum (Amiti Uttarwar) `1521c47438` [net/refactor] Add manual connections to ConnectionType enum (Amiti Uttarwar) `26304b4100` [net/refactor] Introduce an enum to distinguish type of connection (Amiti Uttarwar) `3f1b7140e9` scripted-diff: Rename OneShot to AddrFetch (Amiti Uttarwar) Pull request description: This is part 1 of #19315, which enables the ability to test `outbound` and `block-relay-only` connections from the functional tests. Please see that PR for more information of overall functionality. This PR simplifies how we manage different connection types. It introduces an enum with the various types of connections so we can explicitly define the connection type. The existing system relies on a series of independent flags, then has asserts scattered around to ensure that conflicting flags are not enabled at the same time. I find this approach to be both brittle and confusing. While making these changes, I found a small bug due to the silent assumptions. This PR also proposes a rename from `OneShot` to `AddrFetch`. I find the name `OneShot` to be very confusing, especially when we also have `onetry` manual connections. Everyone I've talked to offline has agreed that the name is confusing, so I propose a potential alternative. I think this is a good opportunity for a rename since I'm creating an enum to explicitly define the connection types. (some context for the unfamiliar: `oneshot` or `addrfetch` connections are short-lived connections created on startup. They connect to the seed peers, send a `getaddr` to solicit addresses, then close the connection.) Overview of this PR: * rename `oneshot` to `addrfetch` * introduce `ConnectionType` enum * one by one, add different connection types to the enum * expose the `conn_type` on CNode, and use this to reduce reliance on flags (& asserts) * fix the bug in counting different type of connections * some additional cleanup to simplify logic and make expectations explicit/inclusive rather than implicit/exclusive. ACKs for top commit: jnewbery: utACK `01e283068b` laanwj: Code review ACK `01e283068b`, the commits are pretty straightforward to follow, and I think this is a move in the right direction overall vasild: ACK `01e283068` sdaftuar: ACK `01e283068b`. fanquake: ACK `01e283068b` - I don't have as much experience with the networking code but these changes look fairly straight forward, the new code seems more robust/understandable and the additional documentation is great. I'm glad that a followup branch is already underway. There might be some more review comments here later today, so keep an eye on the discussion, however I'm going to merge this now. jb55: wow this code was messy before... ACK `01e283068b` Tree-SHA512: 7bb644a6ed5849913d777ebc2ff89133ca0fbef680355a9a344e07496a979e6f9ff21a958e8eea93dcd7d5c343682b0c7174b1a3de380a4247eaae73da436e15		2020-08-12 10:01:44 +08:00
.github	doc: Add redirect for GUI issues and pull requests	2020-06-08 10:06:02 -04:00
.tx	tx: Bump transifex slug to 020x	2020-03-16 10:52:55 +01:00
build-aux/m4	configure: add ax_boost_process	2020-07-31 13:38:09 +02:00
build_msvc	[build] msvc: add boost::process	2020-07-31 13:38:09 +02:00
ci	[ci] use boost::process	2020-07-31 13:38:10 +02:00
contrib	Merge #19622 : build: Drop ancient hack in gitian-linux descriptor	2020-08-10 20:15:09 +08:00
depends	[depends] boost: patch unused variable in boost_process	2020-07-31 13:38:09 +02:00
doc	Merge #19605 : doc: set CC_FOR_BUILD when building on OpenBSD	2020-08-10 22:39:11 +08:00
share	doc: Use precise permission flags where possible	2020-07-10 15:37:42 +02:00
src	Merge #19316 : [net] Cleanup logic around connection types	2020-08-12 10:01:44 +08:00
test	Merge #19674 : refactor: test: use throwaway _ variable for unused loop counters	2020-08-11 09:24:50 +08:00
.appveyor.yml	Merge #18011 : Replace current benchmarking framework with nanobench	2020-07-30 15:34:17 +02:00
.cirrus.yml	ci: Run tsan ci config on cirrus	2020-07-02 12:22:39 -04:00
.fuzzbuzz.yml	ci: Add fuzzbuzz integration	2020-04-14 16:38:26 +00:00
.gitattributes	Separate protocol versioning from clientversion	2014-10-29 00:24:40 -04:00
.gitignore	Fix .gitignore for src/test/fuzz directory	2020-07-27 00:56:37 +03:00
.python-version	.python-version: Specify full version 3.5.6	2019-03-02 12:06:26 -05:00
.style.yapf	test: .style.yapf: Set column_limit=160	2019-03-04 18:28:13 -05:00
.travis.yml	[ci] use boost::process	2020-07-31 13:38:10 +02:00
autogen.sh	scripted-diff: Bump copyright of files changed in 2019	2019-12-30 10:42:20 +13:00
configure.ac	Merge #19667 : build: set minimum required Boost to 1.58.0	2020-08-06 19:29:09 +08:00
CONTRIBUTING.md	Replace `hidden service` with `onion service`	2020-08-07 14:55:02 +02:00
COPYING	doc: Update license year range to 2020	2019-12-26 23:11:21 +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	tests: run test-security-check.py in CI	2020-06-16 19:52:30 +08:00
README.md	doc: Mention repo split in the READMEs	2020-06-08 10:06:14 -04: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

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 usable, 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 (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, 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.