Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

plugin: Allow plugins to publish and subscribe to custom notifications #4496

Merged
merged 17 commits into from
May 3, 2021
Merged

plugin: Allow plugins to publish and subscribe to custom notifications #4496

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
711353f
plugin: Add a list of notification topics registered by plugin
cdecker Apr 27, 2021
79e4ff9
plugin: Move the notification subscription check into a second phase
cdecker Apr 27, 2021
96eb558
plugin: Store the notification topics announced by the plugins
cdecker Apr 27, 2021
0925383
plugin: Implement custom notification dispatch for plugins
cdecker Apr 27, 2021
bdbfbb1
plugin: Prevent plugins from registering native notification topics
cdecker Apr 28, 2021
03df5fb
plugin: Move list of notification topics to each plugin
cdecker Apr 28, 2021
d4c0fc0
plugin: Remember the shortname for a plugin
cdecker Apr 28, 2021
8d30301
plugin: Wrap custom notifications in a dict with additional origin
cdecker Apr 28, 2021
6a7e001
plugin: Restrict plugin notifications only to announced topics
cdecker Apr 28, 2021
07a73ae
cleanup: Make lnprototest run only with DEVELOPER=1
cdecker Apr 28, 2021
87d32bb
libplugin: Add notification topics to plugin_main
cdecker Apr 28, 2021
cdf53d3
libplugin: Add notification topics to the manifest response
cdecker Apr 28, 2021
aebb54a
libplugin: Add functions to start and end notifications
cdecker Apr 28, 2021
799f8ce
plugin: Make unannounced notification topics no longer fatal
cdecker Apr 29, 2021
41b4cec
pay: Add notification for pay_success
cdecker Apr 28, 2021
4e3c9d6
pay: Add pay_failure notification
cdecker Apr 29, 2021
9faa907
docs: Document the custom plugin notifications
cdecker Apr 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions plugins/keysend.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,7 @@ static const struct plugin_hook hooks[] = {

static const char *notification_topics[] = {
"pay_success",
"pay_failure",
};

int main(int argc, char *argv[])
Expand Down
25 changes: 24 additions & 1 deletion plugins/libplugin-pay.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1834,6 +1834,21 @@ static void payment_json_add_attempts(struct json_stream *s,
json_array_end(s);
}

static void payment_notify_failure(struct payment *p, const char *error_message) {
struct payment *root = payment_root(p);
struct json_stream *n;
n = plugin_notification_start(p->plugin, "pay_failure");
Comment on lines +1837 to +1840
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: genuinely weird indent?

json_add_sha256(n, "payment_hash", p->payment_hash);
if (root->invstring != NULL)
json_add_string(n, "bolt11", root->invstring);

json_object_start(n, "error");
json_add_string(n, "message", error_message);
json_object_end(n); /* .error */

plugin_notification_end(p->plugin, n);
}

/* This function is called whenever a payment ends up in a final state, or all
* leafs in the subtree rooted in the payment are all in a final state. It is
* called only once, and it is guaranteed to be called in post-order
Expand Down Expand Up @@ -1901,6 +1916,9 @@ static void payment_finished(struct payment *p)
ret = jsonrpc_stream_fail(cmd, PAY_STOPPED_RETRYING,
p->aborterror);
payment_json_add_attempts(ret, "attempts", p);

payment_notify_failure(p, p->aborterror);

if (command_finished(cmd, ret)) {/* Ignore result. */}
return;
} else if (result.failure == NULL || result.failure->failcode < NODE) {
Expand All @@ -1913,6 +1931,9 @@ static void payment_finished(struct payment *p)
ret = jsonrpc_stream_fail(cmd, PAY_STOPPED_RETRYING,
msg);
payment_json_add_attempts(ret, "attempts", p);

payment_notify_failure(p, msg);

if (command_finished(cmd, ret)) {/* Ignore result. */}
return;

Expand Down Expand Up @@ -1978,7 +1999,9 @@ static void payment_finished(struct payment *p)
*failure->erring_direction);
}

if (command_finished(cmd, ret)) {/* Ignore result. */}
payment_notify_failure(p, failure->message);

if (command_finished(cmd, ret)) { /* Ignore result. */}
return;
}
} else {
Expand Down