Skip to content

Commit

Permalink
Dev Docs: Add 114 Pages Of New/Rewritten RPC Docs
Browse files Browse the repository at this point in the history
* All previously-documented RPCs have had their text completely
  rewritten.

* All new RPCs and changed RPCs in Bitcoin Core 0.10.0 have been
  documented, except for hidden RPCs.

* A new RPC "Quick Reference" section has been added to make finding the
  right RPC easier.

* A "See Also" subsection has been added to the end of every RPC
  pointing to other relevant information.

* All previous examples in the RPC section have been re-run and updated
  as necessary.

* Syntax highlighting has been added wherever possible.

* Hash byte order has been specified as RPC byte order everywhere it's
  used in RPCs.
  • Loading branch information
harding committed Dec 24, 2014
1 parent 414451e commit b8abfb2
Show file tree
Hide file tree
Showing 96 changed files with 5,884 additions and 5,715 deletions.
32 changes: 31 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ all: pre-build-tests build post-build-tests


## Pre-build tests which, aggregated together, take less than 5 seconds to run on a typical PC
pre-build-tests-fast: check-for-non-ascii-urls check-for-wrong-filename-assignments
pre-build-tests-fast: check-for-non-ascii-urls check-for-wrong-filename-assignments \
check-for-missing-rpc-summaries \
check-for-missing-copyright-licenses

## Post-build tests which, aggregated together, take less than 5 seconds to run on a typical PC
post-build-tests-fast: check-for-build-errors ensure-each-svg-has-a-png check-for-liquid-errors \
Expand All @@ -50,6 +52,12 @@ post-build-tests: post-build-tests-fast
@ true ## SOMEDAY: use linkchecker to find broken links
@ ## after this bug is fixed: https://github.com/wummel/linkchecker/issues/513

## All manual updates to content that should be run by a human. This
## will create or update files which should then be diffed and commited.
## It's acceptable for this to overwrite existing content as long as the
## overwritten content is under version control
manual-updates: manual-update-summaries-file




Expand Down Expand Up @@ -150,3 +158,25 @@ check-for-wrong-filename-assignments:
| xargs grep 'assign *filename' \
| grep -v '^\./\(.*\):{.*filename=.\1"' \
| eval $(ERROR_ON_OUTPUT)

check-for-missing-copyright-licenses:
## Error on any files in the _includes directory that don't include a
## statement that looks like a copyright license. (It doesn't have to
## say MIT license, but it has to say something.) This can be extended
## to include other directories by adding them after "_includes/"
$S git grep -iL 'This file is licensed' _includes/ | eval $(ERROR_ON_OUTPUT)

check-for-missing-rpc-summaries:
## Make sure the Quick Reference section has a summary for each RPC we
## have documented
$S for f in _includes/ref/bitcoin-core/rpcs/rpcs/*.md ;\
do grep -q "\[$$( grep '^##### ' $$f | sed 's/^##### *\([a-zA-Z]*\).*/\1/')\]\[" _includes/ref/bitcoin-core/rpcs/quick-ref.md || echo "missing summary for $$f" \
; done | eval $(ERROR_ON_OUTPUT)

manual-update-summaries-file:
## A manually-run command to update the summaries file (currently only
## used for RPC summaries, but maybe used for other summaries in the
## future)
$S echo "{%comment%}AUTOMATICALLY-GENERATED FILE: DO NOT EDIT THIS FILE" > _includes/helpers/summaries.md
$S echo "This file is licensed under the terms of its source texts{%endcomment%}" >> _includes/helpers/summaries.md
$S grep -rh --exclude='*summaries.md' 'assign summary_' _includes/ >> _includes/helpers/summaries.md
102 changes: 100 additions & 2 deletions _autocrossref.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,12 @@ millibitcoins:
'`MSG_FILTERED_BLOCK`': msg_filtered_block
'`MSG_TX`': msg_tx
multisig:
multisig p2sh: p2sh multisig
nbits:
network:
'`notfound` message': notfound message
'`notfound` messages': notfound message
'number (bitcoins)': proper money handling
null data:
'`op_checkmultisig`': op_checkmultisig
'`op_checksig`': op_checksig
Expand Down Expand Up @@ -253,8 +255,8 @@ regtest: regression test mode
'`reject` messages': reject message
root certificate:
root seed:
RPCs: rpc
RPC:
RPCs: rpc
RPC byte order:
satoshi:
satoshis: satoshi
Expand Down Expand Up @@ -294,13 +296,14 @@ transaction fees: transaction fee
transaction malleability:
transaction object format:
transaction version number:
'`transactions`': pp transactions
'`tx` message': tx message
'`tx` messages': tx message
txid:
txids: txid
unconfirmed:
unconfirmed transactions:
unencrypted wallet:
unlocked wallet:
unix epoch time:
unix time: unix epoch time
unique address: unique addresses
Expand All @@ -313,9 +316,16 @@ verified payments:
version 2 blocks: v2 block
'`version` message': version message
'`version` messages': version message
watch-only:
watch-only address: watch-only
watch-only addresses: watch-only
waching-only: watch-only
wallet:
wallets: wallet
wallet import format:
wallet support:
wallet support disabled: wallet support
wallet support enabled: wallet support
x.509: x509
X509Certificates:

Expand All @@ -341,79 +351,165 @@ CVE-2012-2459:

## RPCs
'`addmultisigaddress`': rpc addmultisigaddress
'`addmultisigaddress` RPC': rpc addmultisigaddress
'`addnode`': rpc addnode
'`addnode` RPC': rpc addnode
'`backupwallet`': rpc backupwallet
'`backupwallet` RPC': rpc backupwallet
'`createmultisig`': rpc createmultisig
'`createmultisig` RPC': rpc createmultisig
'`createrawtransaction`': rpc createrawtransaction
'`createrawtransaction` RPC': rpc createrawtransaction
'`decoderawtransaction`': rpc decoderawtransaction
'`decoderawtransaction` RPC': rpc decoderawtransaction
'`decodescript`': rpc decodescript
'`decodescript` RPC': rpc decodescript
'`dumpprivkey`': rpc dumpprivkey
'`dumpprivkey` RPC': rpc dumpprivkey
'`dumpwallet`': rpc dumpwallet
'`dumpwallet` RPC': rpc dumpwallet
'`encryptwallet`': rpc encryptwallet
'`encryptwallet` RPC': rpc encryptwallet
'`estimatefee`': rpc estimatefee
'`estimatefee` RPC': rpc estimatefee
'`estimatepriority`': rpc estimatepriority
'`estimatepriority` RPC': rpc estimatepriority
'`getaccount`': rpc getaccount
'`getaccount` RPC': rpc getaccount
'`getaccountaddress`': rpc getaccountaddress
'`getaccountaddress` RPC': rpc getaccountaddress
'`getaddednodeinfo`': rpc getaddednodeinfo
'`getaddednodeinfo` RPC': rpc getaddednodeinfo
'`getaddressesbyaccount`': rpc getaddressesbyaccount
'`getaddressesbyaccount` RPC': rpc getaddressesbyaccount
'`getbalance`': rpc getbalance
'`getbalance` RPC': rpc getbalance
'`getbestblockhash`': rpc getbestblockhash
'`getbestblockhash` RPC': rpc getbestblockhash
'`getblock`': rpc getblock
'`getblock` RPC': rpc getblock
'`getblockchaininfo`': rpc getblockchaininfo
'`getblockchaininfo` RPC': rpc getblockchaininfo
'`getblockcount`': rpc getblockcount
'`getblockcount` RPC': rpc getblockcount
'`getblockhash`': rpc getblockhash
'`getblockhash` RPC': rpc getblockhash
'`getblocktemplate`': rpc getblocktemplate
'`getblocktemplate` RPC': rpc getblocktemplate
'`getchaintips`': rpc getchaintips
'`getchaintips` RPC': rpc getchaintips
'`getconnectioncount`': rpc getconnectioncount
'`getconnectioncount` RPC': rpc getconnectioncount
'`getdifficulty`': rpc getdifficulty
'`getdifficulty` RPC': rpc getdifficulty
'`getgenerate`': rpc getgenerate
'`getgenerate` RPC': rpc getgenerate
'`gethashespersec`': rpc gethashespersec
'`gethashespersec` RPC': rpc gethashespersec
'`getinfo`': rpc getinfo
'`getinfo` RPC': rpc getinfo
'`getmempoolinfo`': rpc getmempoolinfo
'`getmempoolinfo` RPC': rpc getmempoolinfo
'`getmininginfo`': rpc getmininginfo
'`getmininginfo` RPC': rpc getmininginfo
'`getnettotals`': rpc getnettotals
'`getnettotals` RPC': rpc getnettotals
'`getnetworkhashps`': rpc getnetworkhashps
'`getnetworkhashps` RPC': rpc getnetworkhashps
'`getnetworkinfo`': rpc getnetworkinfo
'`getnetworkinfo` RPC': rpc getnetworkinfo
'`getnewaddress`': rpc getnewaddress
'`getnewaddress` RPC': rpc getnewaddress
'`getpeerinfo`': rpc getpeerinfo
'`getpeerinfo` RPC': rpc getpeerinfo
'`getrawchangeaddress`': rpc getrawchangeaddress
'`getrawchangeaddress` RPC': rpc getrawchangeaddress
'`getrawmempool`': rpc getrawmempool
'`getrawmempool` RPC': rpc getrawmempool
'`getrawtransaction`': rpc getrawtransaction
'`getrawtransaction` RPC': rpc getrawtransaction
'`getreceivedbyaccount`': rpc getreceivedbyaccount
'`getreceivedbyaccount` RPC': rpc getreceivedbyaccount
'`getreceivedbyaddress`': rpc getreceivedbyaddress
'`getreceivedbyaddress` RPC': rpc getreceivedbyaddress
'`gettransaction`': rpc gettransaction
'`gettransaction` RPC': rpc gettransaction
'`gettxout`': rpc gettxout
'`gettxout` RPC': rpc gettxout
'`gettxoutsetinfo`': rpc gettxoutsetinfo
'`gettxoutsetinfo` RPC': rpc gettxoutsetinfo
'`getunconfirmedbalance`': rpc getunconfirmedbalance
'`getunconfirmedbalance` RPC': rpc getunconfirmedbalance
'`getwalletinfo`': rpc getwalletinfo
'`getwalletinfo` RPC': rpc getwalletinfo
'`getwork`': rpc getwork
'`getwork` RPC': rpc getwork
'`help`': rpc help
'`help` RPC': rpc help
'`importaddress`': rpc importaddress
'`importaddress` RPC': rpc importaddress
'`importprivkey`': rpc importprivkey
'`importprivkey` RPC': rpc importprivkey
'`importwallet`': rpc importwallet
'`importwallet` RPC': rpc importwallet
'`keypoolrefill`': rpc keypoolrefill
'`keypoolrefill` RPC': rpc keypoolrefill
'`listaccounts`': rpc listaccounts
'`listaccounts` RPC': rpc listaccounts
'`listaddressgroupings`': rpc listaddressgroupings
'`listaddressgroupings` RPC': rpc listaddressgroupings
'`listlockunspent`': rpc listlockunspent
'`listlockunspent` RPC': rpc listlockunspent
'`listreceivedbyaccount`': rpc listreceivedbyaccount
'`listreceivedbyaccount` RPC': rpc listreceivedbyaccount
'`listreceivedbyaddress`': rpc listreceivedbyaddress
'`listreceivedbyaddress` RPC': rpc listreceivedbyaddress
'`listsinceblock`': rpc listsinceblock
'`listsinceblock` RPC': rpc listsinceblock
'`listtransactions`': rpc listtransactions
'`listtransactions` RPC': rpc listtransactions
'`listunspent`': rpc listunspent
'`listunspent` RPC': rpc listunspent
'`lockunspent`': rpc lockunspent
'`lockunspent` RPC': rpc lockunspent
'`move`': rpc move
'`move` RPC': rpc move
'`ping`': rpc ping
'`ping` RPC': rpc ping
'`sendfrom`': rpc sendfrom
'`sendfrom` RPC': rpc sendfrom
'`sendmany`': rpc sendmany
'`sendmany` RPC': rpc sendmany
'`sendrawtransaction`': rpc sendrawtransaction
'`sendrawtransaction` RPC': rpc sendrawtransaction
'`sendtoaddress`': rpc sendtoaddress
'`sendtoaddress` RPC': rpc sendtoaddress
'`setaccount`': rpc setaccount
'`setaccount` RPC': rpc setaccount
'`setgenerate`': rpc setgenerate
'`setgenerate` RPC': rpc setgenerate
'`settxfee`': rpc settxfee
'`settxfee` RPC': rpc settxfee
'`signmessage`': rpc signmessage
'`signmessage` RPC': rpc signmessage
'`signrawtransaction`': rpc signrawtransaction
'`signrawtransaction` RPC': rpc signrawtransaction
'`stop`': rpc stop
'`stop` RPC': rpc stop
'`submitblock`': rpc submitblock
'`submitblock` RPC': rpc submitblock
'`validateaddress`': rpc validateaddress
'`validateaddress` RPC': rpc validateaddress
'`verifychain`': rpc verifychain
'`verifychain` RPC': rpc verifychain
'`verifymessage`': rpc verifymessage
'`verifymessage` RPC': rpc verifymessage
'`walletlock`': rpc walletlock
'`walletlock` RPC': rpc walletlock
'`walletpassphrase`': rpc walletpassphrase
'`walletpassphrase` RPC': rpc walletpassphrase
'`walletpassphrasechange`': rpc walletpassphrasechange
'`walletpassphrasechange` RPC': rpc walletpassphrasechange

## Versions of Bitcoin Core (linked to Bitcoin.org release notes)
Bitcoin Core 0.1.6:
Expand All @@ -425,4 +521,6 @@ Bitcoin Core 0.6.1:
Bitcoin Core 0.7.0:
Bitcoin Core 0.8.0:
Bitcoin Core 0.9.0:
Bitcoin Core 0.9.1:
Bitcoin Core 0.9.3:
Bitcoin Core 0.10.0:
5 changes: 4 additions & 1 deletion _includes/helpers/subhead-links.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{% if filename %}<div class="subhead-links sourcefile" data-sourcefile="{{filename|uri_escape}}"
{% comment %}
This file is licensed under the MIT License (MIT) available on
http://opensource.org/licenses/MIT.
{% endcomment %}{% if filename %}<div class="subhead-links sourcefile" data-sourcefile="{{filename|uri_escape}}"
><a href="https://github.com/bitcoin/bitcoin.org/edit/master/{{filename|uri_escape}}">Edit</a>
| <a href="https://github.com/bitcoin/bitcoin.org/commits/master/{{filename|uri_escape}}">History</a>
| <a href="https://github.com/bitcoin/bitcoin.org/issues/new?body=Source%20File%3A%20{{filename|uri_escape}}%0A%0A">Report Issue</a>
Expand Down
Loading

0 comments on commit b8abfb2

Please sign in to comment.