Merge pull request #74 from bitcoin-dot-org/wbnns-rpc-helper

rpc: Add helper

Author: Will Binns

helpers/rpc/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cornelius Schumacher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

helpers/rpc/README.md

@@ -0,0 +1,7 @@
+This repository contains a tool to generate Bitcoin Core RPC documentation. It
+requires a running `bitcoin-cli` client and puts out the documentation in
+Markdown format as used on [bitcoin.org](https://github.com/bitcoin-dot-org/bitcoin.org/tree/master/_data/devdocs/en/bitcoin-core/rpcs).
+
+Run `rpc-docs-helper` to get command line help. Run `rpc-docs-helper generate`
+to generate the markdown. Run `pytest` to run the unit tests if you want to work
+on the tool itself.

helpers/rpc/TODO.md

@@ -0,0 +1,30 @@
+# RPC helper To do
+
+* Add RST
+  * Add basic renderer
+  * Try rendered result
+  * Add unit tests
+  * Refactor (share between backends, abstract rst page)
+
+* Fix description
+  * gettxoutproof (first line cut off before "txids")
+
+* Fix result
+  * importmulti (include example output)
+
+* Fix examples in description
+  * deriveaddresses
+  * scantxoutset
+
+* Fix arguments
+  * sighashtype parameter table
+    * signrawtransactionwithwallet
+    * walletprocesspsbt
+  * multi-line argument description
+    * listsinceblock (include_removed)
+
+* Results of example commands
+  (https://github.com/cornelius/rpc-docs-helper/issues/4)
+  * Check how many commands have example results and how many are up to date
+  * Recreate current state with manually edited annotations file
+  * Look into auto-generating example results