dash/doc
Odysseas Gabrielides 8e2d61e634
feat: Enrich quorum listextended rpc reply (#5114)
<!--
*** Please remove the following help text before submitting: ***

Provide a general summary of your changes in the Title above

Pull requests without a rationale and clear improvement may be closed
immediately.

Please provide clear motivation for your patch and explain how it
improves
Dash Core user experience or Dash Core developer experience
significantly:

* Any test improvements or new tests that improve coverage are always
welcome.
* All other changes should have accompanying unit tests (see
`src/test/`) or
functional tests (see `test/`). Contributors should note which tests
cover
modified code. If no tests exist for a region of modified code, new
tests
  should accompany the change.
* Bug fixes are most welcome when they come with steps to reproduce or
an
explanation of the potential issue as well as reasoning for the way the
bug
  was fixed.
* Features are welcome, but might be rejected due to design or scope
issues.
If a feature is based on a lot of dependencies, contributors should
first
  consider building the system outside of Dash Core, if possible.
-->

## Issue being fixed or feature implemented
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->


## What was done?
<!--- Describe your changes in detail -->
Added the fields `numValidMembers` and `healthRatio` in `quorum
listextended` RPC reply, as we need a quick way to see the health of all
quorums with a single command.
`healthRatio` range is `[0.0 - 1.0]`
Note: The decision to include both fields was taken because we need
cover the case where a quorum was created with `minSize` members but all
of them were valid.

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->


## Breaking Changes
<!--- Please describe any breaking changes your code introduces -->


## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added or updated relevant unit/integration/functional/e2e
tests
- [x] I have made corresponding changes to the documentation

**For repository code-owners and collaborators only**
- [x] I have assigned this pull request to a milestone
2022-12-24 14:20:49 -06:00
..
gitian-building Merge #10968: Add instructions for parallel gitian builds. 2019-08-12 09:07:03 -05:00
man Merge branch 'master' into merge_master_18.0.1 2022-08-17 23:39:55 +03:00
release-notes/dash revert: merge bitcoin#20186 (Make -wallet setting not create wallets) 2022-11-08 11:54:10 -06:00
.gitignore Merge #10166: Ignore Doxyfile generated from Doxyfile.in template. 2019-05-19 20:43:00 -05:00
assets-attribution.md Merge #945: More dash->dashcore 2016-08-19 05:46:30 -06:00
benchmarking.md Merge #17081: doc: fix Makefile target in benchmarking.md 2022-05-17 01:20:21 -04:00
bips.md Merge #17370: doc: Update doc/bips.md with recent changes in master 2022-08-24 14:29:45 -04:00
bitcoin_logo_doxygen.png updated darkcoin logo 2015-01-13 11:55:07 -07:00
build-cross.md merge bitcoin#22993: set OSX_MIN_VERSION to 10.15 2021-10-05 08:04:26 +05:30
build-generic.md build/ci: Fix --enable-glibc-back-compat and its usage (#4592) 2021-11-30 14:13:18 +03:00
build-netbsd.md continued 2021-06-26 11:54:34 -05:00
build-osx.md Merge #18070: doc: add note about brew doctor 2022-10-20 11:47:02 -04:00
build-unix.md docs/build: Kubuntu 22.04 build fix (#4843) 2022-05-30 10:57:01 -05:00
build-windows.md Update Windows build instructions (#3453) 2020-04-30 13:28:12 +03:00
dash-conf.md Merge bitcoin/bitcoin#22393: doc: added info to bitcoin.conf doc 2022-03-07 09:42:58 -06:00
descriptors.md Merge #18025: doc: Add missing supported rpcs to doc/descriptors.md 2022-03-07 09:40:31 -06:00
developer-notes.md merge bitcoin#21404: Remove MakeUnique<T>() 2022-10-20 16:08:45 -05:00
dnsseed-policy.md Update dnsseed-policy.md (#2751) 2019-03-08 21:21:20 +03:00
Doxyfile.in Merge bitcoin/bitcoin#22001: doc: Generate doxygen documentation for test sources 2022-03-13 14:52:10 -05:00
files.md merge #15935: Add <datadir>/settings.json persistent settings storage 2022-06-21 19:08:55 +05:30
fuzzing.md merge bitcoin#20560: Link all targets once 2022-10-02 12:05:30 +05:30
gitian-building.md Merge #13366: Docs: Rename “OS X” to the newer “macOS” convention 2021-06-28 02:31:48 +03:00
init.md Merge #18157: doc: fixing init.md documentation to not require rpcpassword 2022-09-16 19:22:12 +05:30
instantsend.md Report instantlock: true for transactions locked via ChainLocks (#2877) 2019-04-25 18:38:26 +03:00
JSON-RPC-interface.md Merge #20741: doc: Update 'Secure string handling' 2021-09-18 21:41:46 -04:00
masternode-budget.md Remove all legacy/compatibility MN code (#2600) 2019-01-03 12:17:43 +03:00
productivity.md Merge #18382: doc: note the costs of fetching all pull requests 2022-04-07 07:22:27 +05:30
psbt.md Merge #15757: List new RPCs in psbt.md and descriptors.md 2022-01-03 18:55:35 +05:30
README_doxygen.md Merge #16912: doc: Remove Doxygen intro from src/bitcoind.cpp 2021-11-25 06:38:14 +05:30
README_windows.txt Merge #10155: build: Deduplicate version numbers 2019-06-14 01:25:59 -05:00
README.md merge bitcoin#17265: Remove OpenSSL 2022-04-25 15:29:52 +05:30
reduce-memory.md Merge bitcoin/bitcoin#21709: doc: update reduce-memory.md and bitcoin.conf -maxconnections info 2022-04-05 23:10:05 -05:00
reduce-traffic.md Merge #18464: doc: block-relay-only vs blocksonly 2022-04-03 18:08:53 -05:00
release-notes-5017.md partial bitcoin#13932: Additional utility RPCs for PSBT 2022-09-24 08:51:04 +05:30
release-notes-5076.md feat: Enrich quorum listextended rpc reply (#5114) 2022-12-24 14:20:49 -06:00
release-notes-17264.md Merge #17264: rpc: set default bip32derivs to true for psbt methods 2022-10-20 11:47:02 -04:00
release-notes.md docs: write release notes 2022-10-17 11:31:26 -05:00
release-process.md Merge pull request #4607 from humbleDasher/dec042021 2021-12-17 11:04:02 -06:00
REST-interface.md Merge #17285: doc: Bip70 removal follow-up 2022-04-27 21:08:36 +03:00
shared-libraries.md revert dash#1432: Rename consensus source library and API 2022-08-09 14:16:28 +05:30
tor.md merge bitcoin#18077: Add NAT-PMP port forwarding support 2022-02-26 17:49:13 +05:30
translation_process.md Merge #16982: build: Factor out qt translations from build system 2021-12-22 20:13:18 -05:00
translation_strings_policy.md Merge #16224: gui: Bilingual GUI error messages 2022-04-07 10:41:24 -05:00
travis-ci.md revert dash#4621: remove all the unneeded and unused (probably broken) travis stuff 2021-12-19 14:03:39 +05:30
zmq.md Revert "Merge #16404: qa: Test ZMQ notification after chain reorg" (#4646) 2022-01-03 15:30:11 +03:00

Dash Core

This is the official reference wallet for Dash digital currency and comprises the backbone of the Dash peer-to-peer network. You can download Dash Core or build it yourself using the guides below.

Running

The following are some helpful notes on how to run Dash Core on your native platform.

Unix

Unpack the files into a directory and run:

  • bin/dash-qt (GUI) or
  • bin/dashd (headless)

Windows

Unpack the files into a directory, and then run dash-qt.exe.

macOS

Drag Dash Core to your applications folder, and then run Dash Core.

Need Help?

Building

The following are developer notes on how to build Dash Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Dash Core repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license.