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

Update docs for blockchain.headers.subscribe

Browse Source
This commit is contained in:
Neil Booth 2018-02-09 18:43:08 +08:00
parent 900b1f59ec
commit 63733223fd
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/PROTOCOL.rst
View File

@ -434,14 +434,25 @@ Subscribe to receive block headers when a new block is found.
**Response** **Response**
The *deserialized header* [2]_ of the current block. The *deserialized header* [2]_ of the current block chain tip.
**Notification Parameters** **Notification Parameters**
As this is a subcription, the client will receive a notification As this is a subcription, the client will receive a notification
when a new block is found. The parameters are: when a new block is found. The parameters are:
[**header**] [**deserialized_header**]
**NOTE**: if a new block comes in quickly so the server has not
finished processing the prior block(s), it may skip them and only
notify of the new tip. The protocol does not guarantee
notifications of all intermediate blocks.
In a similar vein, the client also needs to be able to handle chain
reorganisations; in case of a re-org the new tip will not connect
directly onto the prior chain tip. The client needs to be able to
figure out where the connection point and request any missing block
headers.
blockchain.numblocks.subscribe blockchain.numblocks.subscribe