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

Dev Docs: REST: Add Security Note & Reindex Note

Browse source 
Added both notes to both JSON-RPC and REST docs.

Suggested by Jonas Schnelli (thanks!)
This commit is contained in:
David A. Harding 2015-01-26 14:41:05 -05:00
parent 5f532c59da
commit 73eb097dd4
No known key found for this signature in database
GPG key ID: 4B29C30FF29EC4B7
5 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
_includes/helpers/vars.md
View file

@ -73,3 +73,5 @@ bitcoins even if this parameter is set to `1` or higher.{% endcapture %}
{:.ntpd}{% endcapture %} {:.ntpd}{% endcapture %}
{% assign WARNING="![Warning icon](/img/icons/icon_warning.svg) **Warning:**" %} {% assign WARNING="![Warning icon](/img/icons/icon_warning.svg) **Warning:**" %}
{% assign reindexNote="Note: if you begin using `txindex=1` after downloading the block chain, you must rebuild your indexes by starting Bitcoin Core with the option `-reindex`. This may take several hours to complete, during which time your node will not process new blocks or transactions. This reindex only needs to be done once." %}

3
_includes/ref/bitcoin-core/rest/intro.md
View file

@ -16,6 +16,9 @@ port 18332 for testnet. It must be enabled by either starting Bitcoin
Core with the `-rest` option or by specifying `rest=1` in the Core with the `-rest` option or by specifying `rest=1` in the
configuration file. configuration file.
The interface is not intended for public access and is only accessible
from localhost by default.
{{WARNING}} A web browser can access a HTTP REST interface running on {{WARNING}} A web browser can access a HTTP REST interface running on
localhost, possibly allowing third parties to use cross-site scripting localhost, possibly allowing third parties to use cross-site scripting
attacks to download your transaction and block data, reducing your attacks to download your transaction and block data, reducing your

2
_includes/ref/bitcoin-core/rest/requests/get_tx.md
View file

@ -13,6 +13,8 @@ http://opensource.org/licenses/MIT.
The `GET tx` operation {{summary_restTx}} The `GET tx` operation {{summary_restTx}}
{{reindexNote}}
*Request* *Request*
{% highlight text %} {% highlight text %}

2
_includes/ref/bitcoin-core/rpcs/rpcs/getrawtransaction.md
View file

@ -13,6 +13,8 @@ http://opensource.org/licenses/MIT.
The `getrawtransaction` RPC {{summary_getRawTransaction}} The `getrawtransaction` RPC {{summary_getRawTransaction}}
{{reindexNote}}
*Parameter #1---the TXID of the transaction to get* *Parameter #1---the TXID of the transaction to get*
| Name | Type | Presence | Description | Name | Type | Presence | Description

3
_includes/ref_core_rpc_intro.md
View file

@ -119,6 +119,9 @@ Page][devexamples] for details. JSON-RPC starts on port 8332 for mainnet
and 18332 for testnet and regtest. By default, `bitcoind` doesn't use a and 18332 for testnet and regtest. By default, `bitcoind` doesn't use a
JSON-RPC user, but you can set one (see `bitcoind --help`). JSON-RPC user, but you can set one (see `bitcoind --help`).
The interface is not intended for public access and is only accessible
from localhost by default.
RPCs are made using the standard JSON-RPC 1.0 syntax, which sends several RPCs are made using the standard JSON-RPC 1.0 syntax, which sends several
standard arguments: standard arguments: