mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 09:50:08 +01:00
Code Issues Projects Releases Wiki Activity

Add notifications and requests to overviews.

Dave Collins 2014-04-15 14:49:00 -07:00
parent 0f963124fa
commit 1bb2d6b18a
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Websocket-JSON-RPC-API.md

@ -65,16 +65,16 @@ The [authenticate](#authenticate) command must be the first command sent after c
The following is an overview of the RPC extension requests available to websocket connections. Click the method name for further details such as parameter and return information.
|#|Method|Description|
|---|------|-----------|
|1|[authenticate](#authenticate)|Authenticate the connection against the username and passphrase configured for the RPC server.<br /><font color="orange">NOTE: This is only required if an HTTP Authorization header is not being used.</font>|
|2|[getbestblock](#getbestblock)|Get block height and hash of best block in the main chain.|
|#|Method|Description|Notifications|
|---|------|-----------|-------------|
|1|[authenticate](#authenticate)|Authenticate the connection against the username and passphrase configured for the RPC server.<br /><font color="orange">NOTE: This is only required if an HTTP Authorization header is not being used.</font>|None|
|2|[getbestblock](#getbestblock)|Get block height and hash of best block in the main chain.|None|
|3|[getcurrentnet](#getcurrentnet)|Get bitcoin network btcd is running on.|
|4|[notifyblocks](#notifyblocks)|Send notifications when a block is connected or disconnected from the best chain.|
|5|[notifyreceived](#notifyreceived)|Send notifications when a txout spends to an address.|
|6|[notifyspent](#notifyspent)|Send notification when a txout is spent.|
|7|[rescan](#rescan)|Rescan block chain for transactions to addresses.|
|8|[notifynewtransactions](#notifynewtransactions)|Send notifications for all new transactions|
|4|[notifyblocks](#notifyblocks)|Send notifications when a block is connected or disconnected from the best chain.|[blockconnected](#blockconnected) and [blockdisconnected](#blockdisconnected)|
|5|[notifyreceived](#notifyreceived)|Send notifications when a txout spends to an address.|[recvtx](#recvtx) and [redeemingtx](#redeemingtx)|
|6|[notifyspent](#notifyspent)|Send notification when a txout is spent.|[redeemingtx](#redeemingtx)|
|7|[rescan](#rescan)|Rescan block chain for transactions to addresses.|[recvtx](#recvtx), [redeemingtx](#redeemingtx), and [rescanprogress](#rescanprogress)|
|8|[notifynewtransactions](#notifynewtransactions)|Send notifications for all new transactions|[txaccepted](#txaccepted) or [txacceptedverbose](#txacceptedverbose)|
<a name="ExtensionRequestDetails" />
**3.2 Extension Request Details**<br />
@ -188,15 +188,15 @@ btcd uses standard JSON-RPC notifications to notify clients of changes, rather t
The following is an overview of the JSON-RPC notifications used for websocket connections. Click the method name for further details of the context(s) in which they are sent and their parameters.
|#|Method|Description|
|---|------|-----------|
|1|[blockconnected](#blockconnected)|Block connected to the main chain.|
|2|[blockdisconnected](#blockdisconnected)|Block disconnected from the main chain.|
|3|[recvtx](#recvtx)|Processed a transaction output spending to a wallet address.|
|4|[redeemingtx](#redeemingtx)|Processed a transaction that spends a registered outpoint.|
|5|[txaccepted](#txaccepted)|Received a new transaction after requesting simple notifications of all new transactions.|
|6|[txacceptedverbose](#txacceptedverbose)|Received a new transaction after requesting verbose notifications of all new transactions.|
|7|[rescanprogress](#rescanprogress)|A rescan operation that is underway has made progress.|
|#|Method|Description|Request|
|---|------|-----------|-------|
|1|[blockconnected](#blockconnected)|Block connected to the main chain.|[notifyblocks](#notifyblocks)|
|2|[blockdisconnected](#blockdisconnected)|Block disconnected from the main chain.|[notifyblocks](#notifyblocks)|
|3|[recvtx](#recvtx)|Processed a transaction output spending to a wallet address.|[notifyreceived](#notifyreceived) and [rescan](#rescan)|
|4|[redeemingtx](#redeemingtx)|Processed a transaction that spends a registered outpoint.|[notifyspent](#notifyspent) and [rescan](#rescan)|
|5|[txaccepted](#txaccepted)|Received a new transaction after requesting simple notifications of all new transactions.|[notifynewtransactions](#notifynewtransactions)|
|6|[txacceptedverbose](#txacceptedverbose)|Received a new transaction after requesting verbose notifications of all new transactions.|[notifynewtransactions](#notifynewtransactions)|
|7|[rescanprogress](#rescanprogress)|A rescan operation that is underway has made progress.|[rescan](#rescan)|
<a name="NotificationDetails" />
**4.2 Notification Details**<br />