LIGHTNING-LISTNETWORKEVENTS(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

💅 LIGHTNING-LISTNETWORKEVENTS(7) — like, the whole manual page, bestie

okay so this is lightning-listnetworkevents — a Core Lightning RPC situation. Buckle in, it's actually so good.

✨ NAME ✨

listnetworkevents — the command you use to ask your node "hey girl, what's been happening on the network lately?" 🦋

🌸 SYNOPSIS 🌸

listnetworkevents [id] [index] [start] [limit]

look at her. four optional little args. no drama. ✨

💖 DESCRIPTION 💖

fr fr, this command was added in v25.12 — so if you're on something ancient, that's why she's ghosting you. 👑

The listnetworkevents RPC command pulls up the log of connections, disconnections and pings on the network. and like… why do we care? because you can analyze it to evaluate node reliability and latency, that's why. character research, basically. 🔍

⚠️ heads up bestie: the autoclean plugin deletes network events older than 30 days. so if your history is looking a little short, that's not a glitch. you can adjust autoclean-networkevents-age to change this. 🙈

now the args, one by one:

  • id (string, optional) — a node id. if you set it, only network events for this peer come back. basically "show me only this one's receipts". 💅
  • index (string, optional) (always "created") — this controls the ordering of results. the default is created. 🔥
  • start (u64, optional) — if index is specified, start may be specified to start from that value, which is generally returned from lightning-wait(7). 🎀
  • limit (u32, optional) — if index is specified, limit can be used to specify the maximum number of entries to return. no infinite scroll here, sorry. ✨

🦋 RETURN VALUE 🦋

On success, an object containing networkevents is returned. it's an array of objects, where each object contains:

  • created_index (u64) — 1-based index indicating order this network event was created in. 1-based, so yes, the first one is 1, not 0. iykyk. 🔢
  • timestamp (u64) — time this event was recorded, in seconds since January 1 1970 UTC. the classic. ⏰
  • peer_id (pubkey) — the node the network connection was talking to. 🫶
  • type (string) — the type of event (currently ping, connect, connect_fail or disconnect). the whole little cast of characters. 🎭
  • reason (string, optional) — the cause of the event (if known). ✨
  • duration_nsec (u64, optional) — the time taken. specifically: for ping, the latency; for connect / connect_fail, the time taken to get a result; for disconnect, the time we were connected. she's versatile. 💅

🧚 if type is "connect_fail"

  • connect_attempted (boolean) — True if we found an address we could attempt to connect to, e.g. ignoring Tor addresses if we don't have a proxy, and ignoring IPv6 addresses if we don't have IPv6 support. so False here doesn't mean "we failed", it means "we never even got to try". important distinction, bestie. 😭

👑 AUTHOR 👑

Rusty Russell rusty@rustcorp.com.au is mainly responsible. legend behaviour, honestly. 🌈

🎀 SEE ALSO 🎀

⭐ RESOURCES ⭐

Main web site: https://github.com/ElementsProject/lightning — go look, it's giving main character energy. 🔥

k that's the whole page, mwah 💋 — this was Core Lightning v26.06.9, LIGHTNING-LISTNETWORKEVENTS(7), and yes she ate. periodt. 🍓💜

📦 where this page comes from