mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-19 05:45:05 +01:00
Code Issues Projects Releases Wiki Activity
Bitcoin Core integration/staging tree
43,004 Commits 6 Branches 321 Tags 5.7 GiB
C++ 64%
Python 19.9%
C 12.4%
CMake 1.2%
Shell 0.9%
Other 1.5%
05aebe3790
Go to file
Ava Chow 05aebe3790
Merge bitcoin/bitcoin#30930: netinfo: add peer services column and outbound-only option 
87532fe558 netinfo: allow setting an outbound-only peer list (Jon Atack)
681ebcceca netinfo: rename and hoist max level constant to use in top-level help (Jon Atack)
e7d307ce8c netinfo: clarify relaytxes and addr_relay_enabled help docs (Jon Atack)
eef2a9d406 netinfo: add peer services column (Jon Atack)

Pull request description:

  Been using this since May 2023.

  - add a peer services column (considered displaying the p2p_v2 flag as "p" or "2"; proposing "2" here for continuity with the "v" column, but "p" is fine for me as well)
  - clarify in the help that "relaytxes" and "addr_relay_enabled" are from getpeerinfo
  - hoist (and rename) the max level constant to use in top-level help, to avoid overlooking to update the top-level help if the value of the constant changes (as caught by Larry Ruane in review below)
  - add an optional "outonly" (or "o") argument for an outbound-only peer list, as suggested by Vasil Dimov in his review below. Several people have requested this, to keep the output within screen limits when running netinfo as a live dashboard (i.e. with `watch`) on a node with many peers. While doing this, also permit passing "h" for the help in addition to "help".

ACKs for top commit:
  achow101:
    ACK 87532fe558
  rkrux:
    tACK 87532fe558
  tdb3:
    cr re ACK 87532fe558
  brunoerg:
    crACK 87532fe558

Tree-SHA512: 35b1b0de28dfecaad58bf5af194757a5e0f563553cf69ea4d76f2e1963f8d662717254df2549114c7bba4a041bf5282d5cb3fba8d436b2807f2a00560787d64c
2024-11-04 15:50:59 -05:00
.github ci: Do not error on unused-member-function in test each commit 2024-10-30 13:58:52 -04:00
.tx qt: Bump Transifex slug for 28.x 2024-07-30 16:14:19 +01:00
ci Merge bitcoin/bitcoin#31130: Drop miniupnp dependency 2024-10-28 10:47:34 +00:00
cmake Merge bitcoin/bitcoin#30903: cmake: Add FindZeroMQ module 2024-10-29 16:21:07 +00:00
contrib Merge bitcoin/bitcoin#31121: guix: Enable CET for glibc package 2024-10-21 14:59:32 +01:00
depends Merge bitcoin/bitcoin#30903: cmake: Add FindZeroMQ module 2024-10-29 16:21:07 +00:00
doc doc: archive release notes for v27.2 2024-11-04 11:19:54 +00:00
share build: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:35:55 +00:00
src Merge bitcoin/bitcoin#30930: netinfo: add peer services column and outbound-only option 2024-11-04 15:50:59 -05:00
test Merge bitcoin/bitcoin#31139: test: added test to assert TX decode rpc error on submitpackage rpc 2024-11-01 17:21:04 -04:00
.cirrus.yml ci: Inline PACKAGE_MANAGER_INSTALL 2024-09-26 18:52:08 +02:00
.editorconfig code style: update .editorconfig file 2024-09-13 17:55:10 +02:00
.gitattributes
.gitignore build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
.python-version Bump python minimum supported version to 3.10 2024-08-28 15:53:07 +02:00
.style.yapf Update .style.yapf 2023-06-01 23:35:10 +05:30
CMakeLists.txt Merge bitcoin/bitcoin#31015: build: have "make test" depend on "make all" 2024-10-30 17:11:10 -04:00
CMakePresets.json build: drop miniupnpc dependency 2024-10-24 18:23:31 +02:00
CONTRIBUTING.md doc: replace Autotools with CMake 2024-08-29 16:06:29 +01:00
COPYING doc: upgrade Bitcoin Core license to 2024 2024-01-10 16:29:01 -06:00
INSTALL.md doc: Added hyperlink for doc/build 2021-09-09 19:53:12 +05:30
libbitcoinkernel.pc.in build: Rename PACKAGE_* variables to CLIENT_* 2024-10-28 12:35:55 +00:00
README.md doc: cmake: prepend and explain "build/" where needed 2024-10-11 11:24:21 -06:00
SECURITY.md Update security.md contact for achow101 2023-12-14 18:14:54 -05:00
vcpkg.json build: drop miniupnpc dependency 2024-10-24 18:23:31 +02: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/.

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 during the generation of the build system) with: ctest. 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: build/test/functional/test_runner.py (assuming build is your build directory).

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.