zcash-hackworks
/
zcash-patched-for-explorer
mirror of https://github.com/zcash-hackworks/zcash-patched-for-explorer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5329 

199627c [REST] adding basic documentation (Jonas Schnelli)
This commit is contained in:
Wladimir J. van der Laan 2014-12-05 11:05:36 +01:00
parent 68705996a9 199627c94c
commit c932c47e34
No known key found for this signature in database
GPG Key ID: 74810B012346C9A6
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/REST-interface.md Normal file
View File

@ -0,0 +1,24 @@
Unauthenticated REST Interface
==============================
The REST API can be enabled with the `-rest` option.
Supported API
-------------
`GET /rest/tx/TX-HASH.{bin|hex|json}`
Given a transaction hash,
Returns a transaction, in binary, hex-encoded binary or JSON formats.
`GET /rest/block/BLOCK-HASH.{bin|hex|json}`
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.
For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option.
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:1234/tx/json/1234567890">` which might break the nodes privacy.