Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Create Developer Reference RPC page for gettxoutproof and verifytxoutproof #1012

Closed
wants to merge 15 commits into
from

Conversation

Projects
None yet
2 participants
Contributor

ChainQuery commented Aug 19, 2015

Create Developer Reference RPC page for gettxoutproof (as of core 0.11.0)

Happy to also create verifytxoutproof, but want to verify I'm submitting this properly first.

-Ian

Contributor

harding commented Aug 19, 2015

@ChainQuery thanks! I haven't had a chance to update the docs for 0.11 yet, so your help is much appreciated.

As you can see, the build failed. The reason is that you need to add the following line to _include/references.md:

[rpc gettxoutproof]: /en/developer-reference#gettxoutproof

You'll see where to add it if you search that file for gettxout. Also, can you search the following additional files for gettxout and add an entry for gettxoutproof using the format used in the nearby lines:

  • _autocrossref.yaml
  • _config.yml

Then, run from a Linux command line make manual-updates.

Sorry, I know that's a lot. If you can't do everything, do what you can and I'll send you a patch for the rest when I review the PR. Thanks again!

Contributor

ChainQuery commented Aug 19, 2015

Understood, thanks.

I'll add verifytxoutproof as well and update the additional files.

@ChainQuery ChainQuery changed the title from Create Developer Reference RPC page for gettxoutproof to Create Developer Reference RPC page for gettxoutproof and verifytxoutproof Aug 19, 2015

Contributor

ChainQuery commented Aug 19, 2015

Well, thats all I've got... I pulled it onto my Mac and ran "make manual-updates" but it still has this error:

ERROR:
_site/en/developer-reference.html#gettxoutproof not found
_site/en/developer-reference.html#verifytxoutproof not found

I'm missing something I'm sure, still learning the Git ropes...

Contributor

harding commented Aug 19, 2015

@ChainQuery it's not Git's fault, it's mine for not documenting this process. I hadn't quite realized how many places stuff needs to be done in order to add a new RPC document. To fix the current error, open the file en/developer-reference.md, search for "txout", and copy-paste-adapt lines like you did in 3fc26ca

I think that should be it... I hope. Thanks again!

Contributor

ChainQuery commented Aug 19, 2015

Ahhh, it was the "_site" reference in the error I could not find, as there is no _site directory, I understand it now, hope that did the trick...

Edit: looks like when I pulled it to my Mac it added some order changes to "_includes/helpers/summaries.md". I think I must have made these previously and not pushed them, if it's at all contentious I'll remove it.

Contributor

harding commented Aug 20, 2015

@ChainQuery I sent you a PR with some tweaks, but your descriptions were excellent.

The changes to the _includes/helpers/summaries.md were the result of you running the manual-updates command I described in a previous comment. It looks like extra lines were moved around because your locale has a different sort order than mine, so in the PR I sent you I set the locale to plain UTF-8 which should prevent the problem in the future (you don't need to do anything extra).

Once that PR is merged, I'll schedule this PR for merging into the site. Thanks again!

harding and others added some commits Aug 20, 2015

Dev Docs: Tweaks for the {get,verify}txoutproof RPCs
Also sets the sort language for the manual update.
Merge pull request #2 from harding/gettxoutproof
Dev Docs: Tweaks for the {get,verify}txoutproof RPCs
Contributor

harding commented Aug 20, 2015

@ChainQuery urgh. I messed up that last commit---sorry---can you make this change:

diff --git a/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutproof.md b/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutproof.md
index 55d8d06..bae4f6f 100644
--- a/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutproof.md
+++ b/_includes/ref/bitcoin-core/rpcs/rpcs/gettxoutproof.md
@@ -36,7 +36,7 @@ specify the block in which the transaction is included in manually (by block hea
 *Parameter #2---the block to look for txids in*

 {% itemplate ntpd1 %}
-- n: "`block hash`"
+- n: "Header hash"
   t: "string"
   p: "Optional<br>(0 or 1)"
   d: "If specified, looks for txid in the block with this hash"

@harding harding closed this in 579e406 Aug 23, 2015

harding added a commit that referenced this pull request Aug 23, 2015

Merge pulls #1009 and #1012
- 1009: Small Miscellaneous Backend Changes
- 1012: Create Developer Reference RPC page for gettxoutproof and verifytxoutproof

kevcooper added a commit to kevcooper/bitcoin.org that referenced this pull request Sep 1, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment