mirror of
https://github.com/dashpay/dash.git
synced 2024-12-26 12:32:48 +01:00
4a08360143
3ed8e3d079a3860dcdf944f7c1aa37765a53da32 doc: Remove explicit network name references (Fabian Jahr) d6e493f0c2850b522a676a005935163beddaa2cc wallet: Remove left-over BIP70 comment (Fabian Jahr) Pull request description: A small follow-up to #17165 which removed BIP70 support. 1. Removes one leftover mention of BIP70 in a comment. 2. Removes BIP70 reference in comments on network/chain name strings. These can be removed as they are not really helpful and also incorrect: BIP70 only defines "main" and "test" but not "regtest". If/When signet gets merged we will add another name to the list that is not defined in BIP70. Mostly there is also an exhaustive list of the options included in the comment anyway. If we would like to keep an identifier for this naming scheme, I would suggest switching to something more generic, like 'short chain name'. Happy to implement that if that is preferred. Alternatively, we could add a reference to `CBaseChainParams`. That would also mean we don't have to change these lines again for signet. ACKs for top commit: MarcoFalke: ACK 3ed8e3d079a3860dcdf944f7c1aa37765a53da32 Tree-SHA512: 9a7c0b9cacbb67bd31a089ffdc6f1ebc7f336493e2c8266eb697da34dce2b505a431d5639a3e4fc34f9287361343e861b55dc2662e0a1d2095cc1046db77d6ee
130 lines
5.1 KiB
Markdown
130 lines
5.1 KiB
Markdown
Unauthenticated REST Interface
|
|
==============================
|
|
|
|
The REST API can be enabled with the `-rest` option.
|
|
|
|
The interface runs on the same port as the JSON-RPC interface, by default port 9998 for mainnet and port 19998 for testnet.
|
|
|
|
REST Interface consistency guarantees
|
|
-------------------------------------
|
|
|
|
The [same guarantees as for the RPC Interface](/doc/JSON-RPC-interface.md#rpc-consistency-guarantees)
|
|
apply.
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
There is a known issue in the REST interface that can cause a node to crash if
|
|
too many http connections are being opened at the same time because the system runs
|
|
out of available file descriptors. To prevent this from happening you might
|
|
want to increase the number of maximum allowed file descriptors in your system
|
|
and try to prevent opening too many connections to your rest interface at the
|
|
same time if this is under your control. It is hard to give general advice
|
|
since this depends on your system but if you make several hundred requests at
|
|
once you are definitely at risk of encountering this issue.
|
|
|
|
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.
|
|
|
|
By default, this endpoint will only search the mempool.
|
|
To query for a confirmed transaction, enable the transaction index via "txindex=1" command line / configuration option.
|
|
|
|
#### Blocks
|
|
`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.
|
|
Responds with 404 if the block doesn't exist.
|
|
|
|
The HTTP request and response are both handled entirely in-memory.
|
|
|
|
With the /notxdetails/ option JSON response will only contain the transaction hash instead of the complete transaction details. The option only affects the JSON response.
|
|
|
|
#### Blockheaders
|
|
`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
|
|
|
|
Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
|
|
Returns empty if the block doesn't exist or it isn't in the active chain.
|
|
|
|
#### Blockhash by height
|
|
`GET /rest/blockhashbyheight/<HEIGHT>.<bin|hex|json>`
|
|
|
|
Given a height: returns hash of block in best-block-chain at height provided.
|
|
|
|
#### Chaininfos
|
|
`GET /rest/chaininfo.json`
|
|
|
|
Returns various state info regarding block chain processing.
|
|
Only supports JSON as output format.
|
|
* chain : (string) current network name (main, test, regtest)
|
|
* blocks : (numeric) the current number of blocks processed in the server
|
|
* headers : (numeric) the current number of headers we have validated
|
|
* bestblockhash : (string) the hash of the currently best block
|
|
* difficulty : (numeric) the current difficulty
|
|
* mediantime : (numeric) the median time of the 11 blocks before the most recent block on the blockchain
|
|
* verificationprogress : (numeric) estimate of verification progress [0..1]
|
|
* chainwork : (string) total amount of work in active chain, in hexadecimal
|
|
* pruned : (boolean) if the blocks are subject to pruning
|
|
* pruneheight : (numeric) highest block available
|
|
* softforks : (array) status of softforks in progress
|
|
* bip9_softforks : (object) status of BIP9 softforks in progress
|
|
|
|
#### Query UTXO set
|
|
`GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>`
|
|
|
|
The getutxo command allows querying of the UTXO set given a set of outpoints.
|
|
See BIP64 for input and output serialisation:
|
|
https://github.com/bitcoin/bips/blob/master/bip-0064.mediawiki
|
|
|
|
Example:
|
|
```
|
|
$ curl localhost:19998/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff7627ff72e5e8b0f71210f92ea7a4000c5d75-0.json 2>/dev/null | json_pp
|
|
{
|
|
"chainHeight" : 325347,
|
|
"chaintipHash" : "00000000fb01a7f3745a717f8caebee056c484e6e0bfe4a9591c235bb70506fb",
|
|
"bitmap": "1",
|
|
"utxos" : [
|
|
{
|
|
"txvers" : 1
|
|
"height" : 2147483647,
|
|
"value" : 8.8687,
|
|
"scriptPubKey" : {
|
|
"asm" : "OP_DUP OP_HASH160 1c7cebb529b86a04c683dfa87be49de35bcf589e OP_EQUALVERIFY OP_CHECKSIG",
|
|
"hex" : "76a9141c7cebb529b86a04c683dfa87be49de35bcf589e88ac",
|
|
"reqSigs" : 1,
|
|
"type" : "pubkeyhash",
|
|
"addresses" : [
|
|
"mi7as51dvLJsizWnTMurtRmrP8hG2m1XvD"
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
#### Memory pool
|
|
`GET /rest/mempool/info.json`
|
|
|
|
Returns various information about the TX mempool.
|
|
Only supports JSON as output format.
|
|
* loaded : (boolean) if the mempool is fully loaded
|
|
* size : (numeric) the number of transactions in the TX mempool
|
|
* bytes : (numeric) size of the TX mempool in bytes
|
|
* usage : (numeric) total TX mempool memory usage
|
|
* maxmempool : (numeric) maximum memory usage for the mempool in bytes
|
|
* mempoolminfee : (numeric) minimum feerate (DASH per KB) for tx to be accepted
|
|
|
|
`GET /rest/mempool/contents.json`
|
|
|
|
Returns transactions in the TX mempool.
|
|
Only supports JSON as output format.
|
|
|
|
Risks
|
|
-------------
|
|
Running a web browser on the same node with a REST enabled dashd 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:19998/rest/tx/1234567890.json">` which might break the nodes privacy.
|