DragonX/dragonx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Remove recommendation to add old repos for libd4.8*

Browse Source 
It is unreasonable to ask to change the global package configuration
just to build a package. Not only that, this is potentially harmful to the system.

Also do a few punctuation fixes in REST-interface.md.

Github-Pull: #6413
Rebased-From: 9fbca205d4eaaf82be718b69c6533078aeb3081c
This commit is contained in:
tailsjoin
2015-07-13 16:43:30 +00:00
committed by Wladimir J. van der Laan
parent d26f951802
commit d7101a6d31
2 changed files with 6 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/REST-interface.md
View File

@@ -9,8 +9,7 @@ Supported API
####Transactions
`GET /rest/tx/<TX-HASH>.<bin|hex|json>`
Given a transaction hash,
Returns a transaction, in binary, hex-encoded binary or JSON formats.
Given a transaction hash: returns a transaction in binary, hex-encoded binary, or JSON formats.
For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option.
@@ -18,8 +17,7 @@ For full TX query capability, one must enable the transaction index via "txindex
`GET /rest/block/<BLOCK-HASH>.<bin|hex|json>`
`GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>`
Given a block hash,
Returns a block, in binary, hex-encoded binary or JSON formats.
Given a block hash: returns a block, in binary, hex-encoded binary or JSON formats.
The HTTP request and response are both handled entirely in-memory, thus making maximum memory usage at least 2.66MB (1 MB max block, plus hex encoding) per request.
@@ -28,8 +26,7 @@ With the /notxdetails/ option JSON response will only contain the transaction ha
####Blockheaders
`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex>`
Given a block hash,
Returns <COUNT> amount of blockheaders in upward direction.
Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
JSON is not supported.
@@ -81,4 +78,4 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
Risks
-------------
Running a webbrowser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy.
Running a web browser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy.