From bc754f218ea1632e9a16ecfb739c8b5b87664d73 Mon Sep 17 00:00:00 2001 From: Jack Robison Date: Fri, 14 Oct 2022 10:44:33 -0400 Subject: [PATCH] Updated Herald API (markdown) --- Herald-API.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Herald-API.md b/Herald-API.md index 16e2e56..b7219a0 100644 --- a/Herald-API.md +++ b/Herald-API.md @@ -50,13 +50,13 @@ Responses are similar: **Subscriptions** ------ -These -- `blockchain.address.subscribe` +The following APIs are for subscriptions: +- `blockchain.address.subscribe` notifies whenever an address is touched, ie it received a new tx or one of its txs has been spent - in mempool or in a new block. - `blockchain.address.unsubscribe` - `blockchain.scripthash.subscribe` - `blockchain.scripthash.unsubscribe` -- `blockchain.headers.subscribe` -- `server.peers.subscribe` +- `blockchain.headers.subscribe` notifies with new block headers as new blocks are found +- `server.peers.subscribe` notifies when the hub peers (federated hubs) changes **Methods**