read.cash Log in
@BigBlockIfTrue

Online API documentation for Bitcoin Cash Node

Good news for Bitcoin Cash developers! Two sets of Bitcoin Cash Node API documentation are now published on the project website: **Command-line interface documentation** https://docs.bitcoincashnode.org/cli/bitcoind/ **JSON-RPC interface documentation** https://docs.bitcoincashnode.org/json-rpc/ I wrote code to automatically generate these webpages from CLI/RPC help text embedded in the application. I also integrated this code into the release process of the software, so that the webpages will automatically stay up-to-date as new versions are released. The source for the webpages is also available as Markdown files in the Bitcoin Cash Node git repository - Dagur and merc1er set up the system that converts the Markdown files into a website. https://gitlab.com/bitcoin-cash-node/bitcoin-cash-node/-/tree/master/doc The contents of the pages should be familiar, but now you can easily access them without diving into the command line, and enjoy nicer formatting. However, I also made a series of improvements to the contents. The most notable changes are: I wrote a help text for the command-line options that were previously undocumented. I made hidden aliases of command-line options visible in the help text. I improved and extended the help text for various command-line options. I changed the categories of various command-line options for consistency. I made the reorg protection RPC commands visible in the RPC commands list. I removed SegWit references from RPC help text. No project funds have been used for this effort, but I hope (and am confident) you will enjoy the improved and online API documentation like myself. If you do, tips are appreciated (BigBlockIfTrue#54916; ☯). Happy developing and also enjoy the pending release of Bitcoin Cash Node v0.21.2!

$20.12

3 comments

Log in to join in Reading is open to everyone. Replying needs an account.