joshua/dash-docs
1
0
Fork 0
mirror of https://github.com/seigler/dash-docs synced 2025-07-27 09:46:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

incorporate suggestions from feedback, closes #1025

Browse source
This commit is contained in:
Chris Arnesen 2015-08-27 11:53:24 -05:00
parent 9a0f234168
commit 532fc416ad
2 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

20
_includes/ref/bitcoin-core/rpcs/intro.md
View file

@ -13,12 +13,10 @@ Bitcoin Core provides a remote procedure call (RPC) interface for various
administrative tasks, wallet operations, and queries about network and block administrative tasks, wallet operations, and queries about network and block
chain data. chain data.
If you start Bitcoin Core using `bitcoin-xt`, the RPC interface is disabled by If you start Bitcoin Core using `bitcoin-qt`, the RPC interface is disabled by
default. To enable it, set `server=1` in `bitcoin.conf` or supply the `-server` default. To enable it, set `server=1` in `bitcoin.conf` or supply the `-server`
argument when invoking the program. argument when invoking the program. If you start Bitcoin Core using `bitcoind`,
the RPC interface is enabled by default.
If you start Bitcoin Core using `bitcoind`, the RPC interface is enabled by
default. To disable it, set `server=0` in `bitcoin.conf`.
The interface requires the user to provide a password for authenticating RPC The interface requires the user to provide a password for authenticating RPC
requests. This password can be set either using the `rpcpassword` property in requests. This password can be set either using the `rpcpassword` property in
@ -39,15 +37,15 @@ describes the Bitcoin Core RPC protocol in detail.
The Bitcoin Core RPC service listens for HTTP `POST` requests on port 8332 in The Bitcoin Core RPC service listens for HTTP `POST` requests on port 8332 in
mainnet mode or 18332 in testnet or regtest mode. The port number can be changed mainnet mode or 18332 in testnet or regtest mode. The port number can be changed
by setting `rpcport` in `bitcoin.conf`. By default the RPC service binds to your by setting `rpcport` in `bitcoin.conf`. By default the RPC service binds to your
server's [localhost](https://en.wikipedia.org/wiki/Localhost) loopback server's [localhost][Localhost] loopback
network<!--noref--> interface so it's not accessible from other servers. network<!--noref--> interface so it's not accessible from other servers.
Authentication is implemented using HTTP [basic Authentication is implemented using [HTTP basic
authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). RPC authentication][HTTP basic authentication]. RPC
HTTP requests must include a `Content-Type` header set to `text/plain` and a HTTP requests must include a `Content-Type` header set to `text/plain` and a
`Content-Length` header set to the size of the request body. `Content-Length` header set to the size of the request body.
The format of the request body and response data is based on [version 1.0 of the The format of the request body and response data is based on [version 1.0 of the
JSON-RPC specification](http://json-rpc<!--noref-->.org/wiki/specification). Specifically, JSON-RPC specification][JSON-RPC version 1.0]. Specifically,
the HTTP `POST` data of a request must be a JSON object with the following the HTTP `POST` data of a request must be a JSON object with the following
format: format:
@ -178,7 +176,7 @@ error: {"code": -8, "message": "Block height out of range"}
Starting in Bitcoin Core version 0.7.0, the RPC interface supports request Starting in Bitcoin Core version 0.7.0, the RPC interface supports request
batching as described in [version 2.0 of the JSON-RPC batching as described in [version 2.0 of the JSON-RPC
specification](http://www.jsonrpc.org/specification#batch). To initiate multiple specification][JSON-RPC version 2.0]. To initiate multiple
RPC requests within a single HTTP request, a client can `POST` a JSON array RPC requests within a single HTTP request, a client can `POST` a JSON array
filled with Request objects. The HTTP response data is then a JSON array filled filled with Request objects. The HTTP response data is then a JSON array filled
with the corresponding Response objects. Depending on your usage pattern, with the corresponding Response objects. Depending on your usage pattern,
@ -197,7 +195,7 @@ This translates into an JSON-RPC<!--noref--> Request object of the form:
{% highlight json %} {% highlight json %}
{ {
"method": "<method name>", "method": "<method name>",
"params": [ "param1", "param2", "..." ], "params": [ "<param1>", "<param2>", "..." ],
"id": "foo" "id": "foo"
} }
{% endhighlight %} {% endhighlight %}

5
_includes/references.md
View file

@ -293,12 +293,15 @@ http://opensource.org/licenses/MIT.
[forum tech support]: https://bitcointalk.org/index.php?board=4.0 [forum tech support]: https://bitcointalk.org/index.php?board=4.0
[high-speed block relay network]: https://www.mail-archive.com/bitcoin-development@lists.sourceforge.net/msg03189.html [high-speed block relay network]: https://www.mail-archive.com/bitcoin-development@lists.sourceforge.net/msg03189.html
[HMAC-SHA512]: https://en.wikipedia.org/wiki/HMAC [HMAC-SHA512]: https://en.wikipedia.org/wiki/HMAC
[HTTP JSON-RPC version 1.0]: https://en.wikipedia.org/wiki/JSON-RPC [HTTP basic authentication]: https://en.wikipedia.org/wiki/Basic_access_authentication
[HTTP longpoll]: https://en.wikipedia.org/wiki/Push_technology#Long_polling [HTTP longpoll]: https://en.wikipedia.org/wiki/Push_technology#Long_polling
[IP-to-IP payment protocol]: https://en.bitcoin.it/wiki/IP_Transactions [IP-to-IP payment protocol]: https://en.bitcoin.it/wiki/IP_Transactions
[IPv4-mapped IPv6 addresses]: http://en.wikipedia.org/wiki/IPv6#IPv4-mapped_IPv6_addresses [IPv4-mapped IPv6 addresses]: http://en.wikipedia.org/wiki/IPv6#IPv4-mapped_IPv6_addresses
[irc channels]: https://en.bitcoin.it/wiki/IRC_channels [irc channels]: https://en.bitcoin.it/wiki/IRC_channels
[JSON-RPC version 1.0]: http://json-rpc.org/wiki/specification
[JSON-RPC version 2.0]: http://www.jsonrpc.org/specification#batch
[libblkmaker]: https://github.com/bitcoin/libblkmaker [libblkmaker]: https://github.com/bitcoin/libblkmaker
[localhost]: https://en.wikipedia.org/wiki/Localhost
[makeseeds script]: https://github.com/bitcoin/bitcoin/tree/master/contrib/seeds [makeseeds script]: https://github.com/bitcoin/bitcoin/tree/master/contrib/seeds
[murmur3]: https://en.wikipedia.org/wiki/MurmurHash [murmur3]: https://en.wikipedia.org/wiki/MurmurHash
[man-in-the-middle]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack [man-in-the-middle]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack