mirror of
https://github.com/dashpay/dash.git
synced 2024-12-26 12:32:48 +01:00
d509165193
c456302d4258e3abc4b8afde20fba808632771b2 doc: minor improvements in getutxos REST endpoint synopsis (Sebastian Falbesoner)
Pull request description:
Describing an optional sub-path as `<checkmempool>` in the synopsis could be misleading as the angle brackets normally indicate that the field has to be replaced a custom value. Clarify that by showing two variants instead, similar to the `block` endpoint with the `notxdetails` option:
```
#### Blocks
`GET /rest/block/<BLOCK-HASH>.<bin|hex|json>`
`GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>`
```
Further improvements:
- uppercase `<TXID>` and `<N>`, to match the description of the other endpoints
- s/getutxo command/getutxos endpoint/
- describe what the `checkmempool` option does
- s/serialisation/serialization/ (the US spelling is more dominant than the UK spelling in the project, and there is indeed no other instance of the string "serialis*" in the source tree, except once in a release note)
- link to BIP64 within the text instead of only showing bare URL
- mention that BIP64 is only relevant for `bin` and `hex` output formats
- show two endpoint formats of the block section as list
ACKs for top commit:
stickies-v:
ACK c456302d4258e3abc4b8afde20fba808632771b2 - also checked that current master (cc12b8947) doesn't have any other lines changes that would require updates as per the outlined improvement points.
Tree-SHA512: b025aac0812397f5fbf78c805c13aeb5afa6862a049d13c0b101178799cdaff1ccd3abc368a5c103ea6ebf17cdff76584c54638d0f8d303d81ade2d71443d305
|
||
|---|---|---|
| .. | ||
| man | ||
| release-notes/dash | ||
| .gitignore | ||
| assets-attribution.md | ||
| benchmarking.md | ||
| bips.md | ||
| bitcoin_logo_doxygen.png | ||
| build-freebsd.md | ||
| build-netbsd.md | ||
| build-openbsd.md | ||
| build-osx.md | ||
| build-unix.md | ||
| build-windows.md | ||
| dash-conf.md | ||
| dependencies.md | ||
| descriptors.md | ||
| developer-notes.md | ||
| dnsseed-policy.md | ||
| Doxyfile.in | ||
| files.md | ||
| fuzzing.md | ||
| guix.md | ||
| i2p.md | ||
| init.md | ||
| instantsend.md | ||
| JSON-RPC-interface.md | ||
| managing-wallets.md | ||
| masternode-budget.md | ||
| multiprocess.md | ||
| productivity.md | ||
| psbt.md | ||
| README_doxygen.md | ||
| README_windows.txt | ||
| README.md | ||
| reduce-memory.md | ||
| reduce-traffic.md | ||
| release-notes-5342.md | ||
| release-notes-5493.md | ||
| release-notes.md | ||
| release-process.md | ||
| REST-interface.md | ||
| shared-libraries.md | ||
| tor.md | ||
| translation_process.md | ||
| translation_strings_policy.md | ||
| zmq.md | ||
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) orbin/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?
- See the Dash documentation for help and more information.
- Ask for help on Dash Discord
- Ask for help on the Dash Forum
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.
- Dependencies
- macOS Build Notes
- Unix Build Notes
- Windows Build Notes
- OpenBSD Build Notes
- NetBSD Build Notes
- Android Build Notes
Development
The Dash Core repo's root README contains relevant information on the development process and automated testing.
- Developer Notes
- Productivity Notes
- Release Notes
- Release Process
- Source Code Documentation TODO
- Translation Process
- Translation Strings Policy
- JSON-RPC Interface
- Unauthenticated REST Interface
- Shared Libraries
- BIPS
- Dnsseed Policy
- Benchmarking
Resources
- See the Dash Developer Documentation for technical specifications and implementation details.
- Discuss on the Dash Forum, in the Development & Technical Discussion board.
- Discuss on Dash Discord
- Discuss on Dash Developers Discord
Miscellaneous
- Assets Attribution
- dash.conf Configuration File
- Files
- Fuzz-testing
- I2P Support
- Init Scripts (systemd/upstart/openrc)
- Managing Wallets
- PSBT support
- Reduce Memory
- Reduce Traffic
- Tor Support
- ZMQ
License
Distributed under the MIT software license.