dash-docs/en/developer-reference.md
David A. Harding 037cd4553a
Add New Glossary Page And Developer Search Feature
This commit adds the code necessary to generate a new
en/developre-glossary page with entry pages in the en/glossary/
directory, e.g. en/glossary/51-percent-attack.

The glossary page and the individual term pages feature a JavaScript
search engine (no CGI) for just glossary terms.  This search box has
also been added to the following pages:

    * Developer Documentation (the index page)
    * Developer Guide
    * Developer Reference
    * Developer Examples

The search box requires the following MIT-licensed libraries:

    * JQuery
    * JQuery UI
    * JQuery UI CSS stylesheet

These allow our JS code to be almost trivially simple in js/devsearch.js

This commit adds only code.  Actual glossary entry data will be added in
a subsequent commit.
2015-03-19 15:31:28 -04:00

7.7 KiB

layout lang id title
base en developer-reference Developer Reference - Bitcoin

Bitcoin Developer Reference

Find technical details and API documentation.

{% include fragment_reviews_needed.md %}

{% include ref_intro.md %}

{% include ref_block_chain.md %}

{% include ref_transactions.md %}

{% include ref_wallets.md %}

{% include ref_p2p_networking.md %}

{% include ref/bitcoin-core/api-intro.md %}

{% include ref/bitcoin-core/rpcs/intro.md %}

{% include ref/bitcoin-core/rpcs/quick-ref.md %}

RPCs

{{WARNING}} the block chain and memory pool can include arbitrary data which several of the commands below will return in hex format. If you convert this data to another format in an executable context, it could be used in an exploit. For example, displaying a pubkey script as ASCII text in a webpage could add arbitrary Javascript to that page and create a cross-site scripting (XSS) exploit. To avoid problems, please treat block chain and memory pool data as an arbitrary input from an untrusted source.

{% include ref/bitcoin-core/rpcs/rpcs/addmultisigaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/addnode.md %}

{% include ref/bitcoin-core/rpcs/rpcs/backupwallet.md %}

{% include ref/bitcoin-core/rpcs/rpcs/createmultisig.md %}

{% include ref/bitcoin-core/rpcs/rpcs/createrawtransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/decoderawtransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/decodescript.md %}

{% include ref/bitcoin-core/rpcs/rpcs/dumpprivkey.md %}

{% include ref/bitcoin-core/rpcs/rpcs/dumpwallet.md %}

{% include ref/bitcoin-core/rpcs/rpcs/encryptwallet.md %}

{% include ref/bitcoin-core/rpcs/rpcs/estimatefee.md %}

{% include ref/bitcoin-core/rpcs/rpcs/estimatepriority.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getaccountaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getaccount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getaddednodeinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getaddressesbyaccount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getbalance.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getbestblockhash.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getblock.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getblockchaininfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getblockcount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getblockhash.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getblocktemplate.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getchaintips.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getconnectioncount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getdifficulty.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getgenerate.md %}

{% include ref/bitcoin-core/rpcs/rpcs/gethashespersec.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getmempoolinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getmininginfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getnettotals.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getnetworkhashps.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getnetworkinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getnewaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getpeerinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getrawchangeaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getrawmempool.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getrawtransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getreceivedbyaccount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getreceivedbyaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/gettransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/gettxout.md %}

{% include ref/bitcoin-core/rpcs/rpcs/gettxoutsetinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getunconfirmedbalance.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getwalletinfo.md %}

{% include ref/bitcoin-core/rpcs/rpcs/getwork.md %}

{% include ref/bitcoin-core/rpcs/rpcs/help.md %}

{% include ref/bitcoin-core/rpcs/rpcs/importaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/importprivkey.md %}

{% include ref/bitcoin-core/rpcs/rpcs/importwallet.md %}

{% include ref/bitcoin-core/rpcs/rpcs/keypoolrefill.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listaccounts.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listaddressgroupings.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listlockunspent.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listreceivedbyaccount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listreceivedbyaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listsinceblock.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listtransactions.md %}

{% include ref/bitcoin-core/rpcs/rpcs/listunspent.md %}

{% include ref/bitcoin-core/rpcs/rpcs/lockunspent.md %}

{% include ref/bitcoin-core/rpcs/rpcs/move.md %}

{% include ref/bitcoin-core/rpcs/rpcs/ping.md %}

{% include ref/bitcoin-core/rpcs/rpcs/prioritisetransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/sendfrom.md %}

{% include ref/bitcoin-core/rpcs/rpcs/sendmany.md %}

{% include ref/bitcoin-core/rpcs/rpcs/sendrawtransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/sendtoaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/setaccount.md %}

{% include ref/bitcoin-core/rpcs/rpcs/setgenerate.md %}

{% include ref/bitcoin-core/rpcs/rpcs/settxfee.md %}

{% include ref/bitcoin-core/rpcs/rpcs/signmessage.md %}

{% include ref/bitcoin-core/rpcs/rpcs/signrawtransaction.md %}

{% include ref/bitcoin-core/rpcs/rpcs/stop.md %}

{% include ref/bitcoin-core/rpcs/rpcs/submitblock.md %}

{% include ref/bitcoin-core/rpcs/rpcs/validateaddress.md %}

{% include ref/bitcoin-core/rpcs/rpcs/verifychain.md %}

{% include ref/bitcoin-core/rpcs/rpcs/verifymessage.md %}

{% include ref/bitcoin-core/rpcs/rpcs/walletlock.md %}

{% include ref/bitcoin-core/rpcs/rpcs/walletpassphrase.md %}

{% include ref/bitcoin-core/rpcs/rpcs/walletpassphrasechange.md %}

{% include ref/bitcoin-core/rest/intro.md %}

{% include ref/bitcoin-core/rest/quick-reference.md %}

Requests

{{WARNING}} the block chain and memory pool can include arbitrary data which several of the commands below will return in hex format. If you convert this data to another format in an executable context, it could be used in an exploit. For example, displaying a pubkey script as ASCII text in a webpage could add arbitrary Javascript to that page and create a cross-site scripting (XSS) exploit. To avoid problems, please treat block chain and memory pool data as an arbitrary input from an untrusted source.

{% include ref/bitcoin-core/rest/requests/get_block.md %}

{% include ref/bitcoin-core/rest/requests/get_block-notxdetails.md %}

{% include ref/bitcoin-core/rest/requests/get_tx.md %}

{% include references.md %} {{site.glossary_links}}