Update `id_to_peer` docs with consistency guarantees info
authorViktor Tigerström <11711198+ViktorTigerstrom@users.noreply.github.com>
Sat, 10 Dec 2022 21:20:05 +0000 (22:20 +0100)
committerMatt Corallo <git@bluematt.me>
Mon, 9 Jan 2023 19:42:52 +0000 (19:42 +0000)
lightning/src/ln/channelmanager.rs

index 16bf148e807cbbb90cd640b8b1852c1a33577242..5ef0235eb60c66a6fc22928f1b164ef8a49a355d 100644 (file)
@@ -699,6 +699,9 @@ where
        /// the corresponding channel for the event, as we only have access to the `channel_id` during
        /// the handling of the events.
        ///
+       /// Note that no consistency guarantees are made about the existence of a peer with the
+       /// `counterparty_node_id` in our other maps.
+       ///
        /// TODO:
        /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
        /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately