mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 18:09:47 +01:00
Code Issues Projects Releases Wiki Activity
Bitcoin Core integration/staging tree
29,949 Commits 6 Branches 318 Tags 3.2 GiB
C++ 64%
Python 19.9%
C 12.4%
CMake 1.1%
Shell 0.9%
Other 1.6%
cac38cdd02
Go to file
MarcoFalke cac38cdd02
Merge bitcoin/bitcoin#21832: cli: Improve -getinfo return format 
a37e29d32f cli: Implement human readable -getinfo. (Klement Tan)

Pull request description:

  # Overview
  **Description** This PR changes the return format of `-getinfo`

  **Rationale**
  - make `-getinfo` more user-friendly
  - uses less vertical screen space.

  Fixes: Issue 17314(Not linking issue to prevent it from closing)
  > Alternative, more human-friendly, format besides JSON? Colors, progress bars

  ### Return Format
  ```bash
  // Data from getblockchaininfo
  Chain: [getblockchaininfo.chain]
  Blocks: [getblockchaininfo.blocks]
  Headers: [getblockchaininfo.headers]
  Verification progress: [getblockchaininfo.verificationprogress]
  Difficulty: [getblockchaininfo.difficulty]

  # Data from getnetworkinfo
  Network: in [getnetworkinfo.connections_in], out [getnetworkinfo.connections_out], total [getnetworkinfo.connections]
  Version: [getnetworkinfo.version]
  Time offset (s): [getnetworkinfo.timeoffset]
  Proxy: [getnetworkinfo.proxy] // "N/A" if no proxy
  Min tx relay fee rate (BTC/kvB): [getnetworkinfo.relayfee]

  # Data from getwalletinfo. Will only be present when a single wallet is loaded
  Wallet: [getnetworkinfo.walletname] // "" if walletname is empty(default wallet)
  Keypool size: [getnetworkinfo.keypoolsize]
  Unlocked until: [getnetworkinfo.unlocked_until]
  Transaction fee rate (-paytxfee) (BTC/kvB): [getnetworkinfo.paytxfee]

  # Data from getbalances. Will only be present when a single wallet is loaded
  Balance: [getbalances.mine.trusted]

  # Data from listwallets then getbalances for each wallet. Will only be present for multiple wallets loaded
  Balances
  [getbalances.mine.trusted] [listwallets[i]] // Right justify on balance

  Warnings: [getnetworkinfo.warnings]
  ```
  #### Coloring
  The following lines would be colored to better show the differences between the various `-getinfo` components. However, this will not apply for `WIN32`(ANSI code not supported) and users that connect the `stdout` to a non-terminal process.
  - `Chain: ...`:  BLUE(`\x1B[34m`)
  - `Network: ...`: GREEN(`\x1B[32m`)
  - `Wallet: ...`: MAGENTA(`\x1B[35m`)
  - `Balance: ...` CYAN(`\x1B[36m`)
  - `Balances: ...` CYAN(`\x1B[36m`)
  - `Warnings: ...` Yellow(`\x1B[33m`)

  ### Screenshots

  *No wallet loaded:*
  ![image](https://user-images.githubusercontent.com/49265907/121794631-94b62080-cc3c-11eb-8627-d0d1c25f0878.png)

  *Single wallet loaded*
  ![image](https://user-images.githubusercontent.com/49265907/121794619-6df7ea00-cc3c-11eb-8420-d0c18236b188.png)

  *Multi wallet loaded*
  ![image](https://user-images.githubusercontent.com/49265907/121794626-810aba00-cc3c-11eb-8cd7-c15ede1918ac.png)

  # Reviewing Notes

  ## Testing Scenarios

  **1. No wallet loaded**
  - When there no wallets are loaded(Unload wallet with `./src/bitcoin-cli unloadwallet "YOUR_WALLETNAME"`
  -  Test with `./src/bitcoin-cli -getinfo`.
  - Should only display `chain` and `network` segment

  **2. Single wallet loaded**
  - When only a single wallet loaded or `-rpcwallet` is set(Load wallet with `./src/bitcoin-cli loadwallet "YOUR_WALLETNAME"`)
  - Test with `./src/bitcoin-cli -rpcwallet="YOUR_WALLETNAME" -getinfo`(Load wallet with `./src/bitcoin-cli loadwallet "YOUR_WALLETNAME"`)
  - Should only display `chain`, `network`, `wallet` and `balance` segment

  **3. Multiple wallet loaded**
  - When there are multiple wallets loaded(Load wallet with `./src/bitcoin-cli loadwallet "YOUR_WALLETNAME"`)
  - Test with `./src/bitcoin-cli -getinfo`
  - Should only display `chain`, `network` and `balances` segment

  ## Implementation

  **Current Flow**
  1. `GetinfoRequestHandler` is instantiated
  2. `ConnectAndCallRPC` is called with `GetinfoRequestHandler`. It returns `UniValue::VOBJ result`
  3. If `-rpcwallet` wallet is not set, `GetWalletBalances` is called with a pointer to `result` as a parameter. It adds the balances for all the wallets to `result`

  **New Flow**
  1. `GetinfoRequestHandler` is instantiated
  2. `ConnectAndCallRPC` is called with `GetinfoRequestHandler`. It returns `UniValue::VOBJ result`
  3. If `-rpcwallet` wallet is not set, `GetWalletBalances` is called with a pointer to `result` as a parameter. It adds the balances for all the wallets to `result`
  4. **New** `ParseGetInfoResult` is called with `result` as parameter. It converts results type from `UniValue::VOBJ` to `UniValue::VSTR` according to the format stated above.

ACKs for top commit:
  theStack:
    re-ACK a37e29d32f

Tree-SHA512: 5e90606a397abfc4e5921f6db70a0a4888cbebba9da9b70cfe72d593caf669fd090de3e58eecf1cb5c20d5f448ad278999165d32d01667037d09bd352d23ac5d
2021-07-21 14:15:18 +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_msvc build: Bump master version to 22.99.0 2021-07-20 15:27:12 +02:00
build-aux/m4 build, qt: Fix libraries linking order for Linux hosts 2021-06-06 23:25:07 +03:00
ci ci: Bump Android NDK to r22 which supports std::filesystem 2021-07-18 12:10:28 +03:00
contrib Merge bitcoin/bitcoin#22465: guix: Pin kernel-header version, time-machine to upstream 1.3.0 commit 2021-07-20 12:23:56 +08:00
depends Merge bitcoin/bitcoin#22469: build: Add support for Android NDK r22+ 2021-07-21 15:36:03 +08:00
doc cli: Implement human readable -getinfo. 2021-07-21 19:27:04 +08:00
share doc: add maxuploadtarget to bitcoin.conf example 2021-05-28 12:53:17 -04:00
src cli: Implement human readable -getinfo. 2021-07-21 19:27:04 +08:00
test cli: Implement human readable -getinfo. 2021-07-21 19:27:04 +08: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 build: Bump master version to 22.99.0 2021-07-20 15:27:12 +02: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 Merge bitcoin/bitcoin#22234: build: Mark print-% target as phony. 2021-07-18 13:41:24 +08: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.