From 45a0e049e392da6bb5c8ebdf5673e9af2c1338c0 Mon Sep 17 00:00:00 2001 From: Michael Schmoock Date: Tue, 8 Sep 2020 16:18:53 +0200 Subject: [PATCH] doc: plugin channel_state_changed --- doc/PLUGINS.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/PLUGINS.md b/doc/PLUGINS.md index a6fa2332e..0cf22eb98 100644 --- a/doc/PLUGINS.md +++ b/doc/PLUGINS.md @@ -322,6 +322,24 @@ into a block. } ``` +### `channel_state_changed` + +A notification for topic `channel_state_changed` is sent every time a channel +changes its state. The notification includes the peer and channel ids as well +as the old and the new channel states. + +```json +{ + "channel_state_changed": { + "peer_id": "03bc9337c7a28bb784d67742ebedd30a93bacdf7e4ca16436ef3798000242b2251", + "channel_id": "a2d0851832f0e30a0cf778a826d72f077ca86b69f72677e0267f23f63a0599b4", + "short_channel_id" : "561820x1020x1", + "old_state": "CHANNELD_NORMAL", + "new_state": "CHANNELD_SHUTTING_DOWN" + } +} +``` + ### `connect` A notification for topic `connect` is sent every time a new connection