Ecosystem/monero-lws
1
0
Fork 0
mirror of https://github.com/vtnerd/monero-lws.git synced 2025-04-06 21:57:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update zmq topic name for payment hooks

Browse source
This commit is contained in:
Lee *!* Clagett 2023-07-06 10:29:44 -04:00
parent 4b459c259a
commit a823d68c59
2 changed files with 13 additions and 13 deletions

16
docs/zmq.md
View file

@ -7,24 +7,24 @@ Monero daemon, and ZeroMQ-PUB to notify external applications of payment_id
## External "pub" socket
The bind location of the ZMQ-PUB socket is specified with the `--zmq-pub`
option. Users are still required to "subscribe" to topics:
* `json-full-hooks`: A JSON array of webhook events that have recently
triggered (identical output as webhook).
* `msgpack-full-hooks`: A msgpack array of webhook events that have recently
triggered (identical output as webhook).
* `json-full-pyment_hook`: A JSON array of webhook payment events that have
recently triggered (identical output as webhook).
* `msgpack-full-payment_hook`: A msgpack array of webhook payment events that
have recently triggered (identical output as webhook).
### `json-full-hooks`/`msgpack-full-hooks`i
### `json-full-payment_hook`/`msgpack-full-payment_hook`
These topics receive PUB messages when a webhook ([`webhook_add`](administration.md)),
event is triggered. If the specified URL is `zmq`, then notifications are only
done over the ZMQ-PUB socket, otherwise the notification is sent over ZMQ-PUB
socket AND the specified URL. Invoking `webhook_add` with a `payment_id` of
zeroes (the field is optional in `webhook_add), will match on all transactions
that lack a payment_id`.
that lack a `payment_id`.
Example of the "raw" output from ZMQ-SUB side:
```json
json-full-hooks:{
json-full-payment_hook:{
"index": 2,
"event": {
"event": "tx-confirmation",
@ -55,7 +55,7 @@ json-full-hooks:{
```
Notice the `json-full-hooks:` prefix - this is required for the ZMQ PUB/SUB
Notice the `json-full-payment_hook:` prefix - this is required for the ZMQ PUB/SUB
subscription model. The subscriber requests data from a certain "topic" where
matching is done by string prefixes.

10
src/scanner.cpp
View file

@ -281,12 +281,12 @@ namespace lws
for (const auto& event : events)
{
const zmq_index_single index{ordering.current++, event};
MINFO("Sending ZMQ-PUB topics json-full-hooks and msgpack-full-hooks");
MINFO("Sending ZMQ-PUB topics json-full-payment_hook and msgpack-full-payment_hook");
expect<void> result = success();
if (!(result = client.publish<wire::json>("json-full-hooks:", index)))
MERROR("Failed to serialize+send json-full-hooks: " << result.error().message());
if (!(result = client.publish<wire::msgpack>("msgpack-full-hooks:", index)))
MERROR("Failed to serialize+send msgpack-full-hooks: " << result.error().message());
if (!(result = client.publish<wire::json>("json-full-payment_hook:", index)))
MERROR("Failed to serialize+send json-full-payment_hook: " << result.error().message());
if (!(result = client.publish<wire::msgpack>("msgpack-full-payment_hook:", index)))
MERROR("Failed to serialize+send msgpack-full-payment_hook: " << result.error().message());
}
}
}