RanchiMall/fcoin
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update rest-rpc-api urls

Browse Source
This commit is contained in:
Node 2017-07-27 00:45:49 +04:00
parent 9d90704b83
commit 4438cb6bab
No known key found for this signature in database
GPG Key ID: 8E1B4DC29040BD90
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/REST-RPC-API.md
View File

@ -80,6 +80,8 @@ Example:
Get coins by address. Returns coins in bcoin coin json format. Get coins by address. Returns coins in bcoin coin json format.
*Note: Without `index-address` option, it won't return from chain(only mempool).*
### GET /coin/:hash/:index ### GET /coin/:hash/:index
Get coin by outpoint (hash and index). Returns coin in bcoin coin json format. Get coin by outpoint (hash and index). Returns coin in bcoin coin json format.
@ -95,7 +97,9 @@ Example:
### GET /tx/:hash ### GET /tx/:hash
Get transaction by TXID. Returns TX in bcoin transaction json format. Get transaction by TXID from Chain or Mempool. Returns TX in bcoin transaction json format.
*Note: Without `index-tx` option, it won't return from chain.*
### GET /tx/address/:address ### GET /tx/address/:address
@ -173,29 +177,29 @@ POST /wallet/:id/send
GET /wallet/:id/tx/:hash?token=[64 character hex string] GET /wallet/:id/tx/:hash?token=[64 character hex string]
``` ```
### POST /rescan ### POST /wallet/_admin/rescan
Initiates a blockchain rescan for the walletdb. Wallets will be rolled back to the specified height (transactions above this height will be unconfirmed). Initiates a blockchain rescan for the walletdb. Wallets will be rolled back to the specified height (transactions above this height will be unconfirmed).
Example: Example:
- Request: POST /rescan?height=100000 - Request: POST /wallet/_admin/rescan?height=100000
- Response Body: `{"success":true}` - Response Body: `{"success":true}`
### POST /resend ### POST /wallet/_admin/resend
Rebroadcast all pending transactions in all wallets. Rebroadcast all pending transactions in all wallets.
### POST /backup ### POST /wallet/_admin/backup
Safely backup the wallet database to specified path (creates a clone of the database). Safely backup the wallet database to specified path (creates a clone of the database).
Example: Example:
- Request: POST /backup?path=/home/user/walletdb-backup.ldb - Request: POST /wallet/_admin/backup?path=/home/user/walletdb-backup.ldb
- Response Body: `{"success":true}` - Response Body: `{"success":true}`
### GET /wallets ### GET /wallet/_admin/wallets
List all wallet IDs. Returns an array of strings. List all wallet IDs. Returns an array of strings.
@ -716,7 +720,7 @@ Example:
List all wallet coins available. List all wallet coins available.
### GET /wallet/:id/coin/locked ### GET /wallet/:id/locked
Get all locked outpoints. Get all locked outpoints.
@ -728,11 +732,11 @@ Example:
[{"hash":"dd1a110edcdcbb3110a1cbe0a545e4b0a7813ffa5e77df691478205191dad66f","index":0}] [{"hash":"dd1a110edcdcbb3110a1cbe0a545e4b0a7813ffa5e77df691478205191dad66f","index":0}]
``` ```
### PUT /wallet/:id/coin/locked ### PUT /wallet/:id/locked/:hash/:index
Lock outpoints. Lock outpoints.
### DEL /wallet/:id/coin/locked ### DEL /wallet/:id/locked/:hash/:index
Unlock outpoints. Unlock outpoints.
@ -951,4 +955,4 @@ Example:
"type": "pubkeyhash", "type": "pubkeyhash",
"address": "mwX8J1CDGUqeQcJPnjNBG4s97vhQsJG7Eq" "address": "mwX8J1CDGUqeQcJPnjNBG4s97vhQsJG7Eq"
} }
``` ```