core-lightning/tests/plugins/custom_notifications.py

#!/usr/bin/env python3
from pyln.client import Plugin


plugin = Plugin()


@plugin.subscribe("custom")
def on_custom_notification(origin, payload, **kwargs):
    plugin.log("Got a custom notification {} from plugin {}".format(payload, origin))


@plugin.method("emit")
def emit(plugin):
    """Emit a simple string notification to topic "custom"
    """
    plugin.notify("custom", "Hello world")


plugin.add_notification_topic("custom")
plugin.run()
plugin: Add a list of notification topics registered by plugin We will eventually start emitting and dispatching custom notifications from plugins just like we dispatch internal notifications. In order to get reasonable error messages we need to make sure that the topics plugins are asking for were correctly registered. When doing this we don't really care about whether the plugin that registered the notification is still alive or not (it might have died, but subscribers should stay up and running), so we keep a list of all topics attached to the `struct plugins` which gathers global plugin information. 2021-04-27 15:15:09 +02:00			`#!/usr/bin/env python3`
			`from pyln.client import Plugin`


			`plugin = Plugin()`


			`@plugin.subscribe("custom")`
plugin: Wrap custom notifications in a dict with additional origin This should allow us to differentiate the origin of the notification, and further prevent plugins from spoofing native notifications. 2021-04-28 16:40:35 +02:00			`def on_custom_notification(origin, payload, **kwargs):`
			`plugin.log("Got a custom notification {} from plugin {}".format(payload, origin))`
plugin: Add a list of notification topics registered by plugin We will eventually start emitting and dispatching custom notifications from plugins just like we dispatch internal notifications. In order to get reasonable error messages we need to make sure that the topics plugins are asking for were correctly registered. When doing this we don't really care about whether the plugin that registered the notification is still alive or not (it might have died, but subscribers should stay up and running), so we keep a list of all topics attached to the `struct plugins` which gathers global plugin information. 2021-04-27 15:15:09 +02:00

			`@plugin.method("emit")`
			`def emit(plugin):`
			`"""Emit a simple string notification to topic "custom"`
			`"""`
			`plugin.notify("custom", "Hello world")`


			`plugin.add_notification_topic("custom")`
			`plugin.run()`