feat(gl-sdk): add generate_diagnostic_data for support dumps

Returns a pretty-printed JSON envelope { timestamp, node, sdk } where
the node section serializes getinfo/listpeerchannels/listfunds and the
sdk section carries version + node_state. Failed sub-calls are embedded
as { "error": "..." } instead of failing the dump. Adds serde derive on
the response types so each section is real nested JSON, queryable with
jq. Payment and invoice history are intentionally excluded to avoid
leaking preimages, payment hashes, bolt11 strings, and labels into
support dumps.

Author: angelix

Cargo.lock

@@ -17,6 +17,8 @@ gl-client = { version = "0.4.0", path = "../gl-client" }
 hex = "0.4"
 lightning-invoice = "0.33"
 once_cell = "1.21.3"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
 thiserror = "2.0.17"
 tokio = { version = "1", features = ["sync"] }
 tonic.workspace = true

libs/gl-sdk/Cargo.toml

@@ -474,6 +474,8 @@ def _uniffi_check_api_checksums(lib):
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_glsdk_checksum_method_config_with_network() != 35643:
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    if lib.uniffi_glsdk_checksum_method_credentials_node_id() != 16312:
+        raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_glsdk_checksum_method_credentials_save() != 26677:
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_glsdk_checksum_method_handle_stop() != 36432:
@@ -482,6 +484,8 @@ def _uniffi_check_api_checksums(lib):
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_glsdk_checksum_method_node_disconnect() != 43626:
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    if lib.uniffi_glsdk_checksum_method_node_generate_diagnostic_data() != 41140:
+        raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_glsdk_checksum_method_node_get_info() != 39460:
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_glsdk_checksum_method_node_list_funds() != 21692:
@@ -685,6 +689,11 @@ class _UniffiForeignFutureStructVoid(ctypes.Structure):
     ctypes.POINTER(_UniffiRustCallStatus),
 )
 _UniffiLib.uniffi_glsdk_fn_constructor_credentials_load.restype = ctypes.c_void_p
+_UniffiLib.uniffi_glsdk_fn_method_credentials_node_id.argtypes = (
+    ctypes.c_void_p,
+    ctypes.POINTER(_UniffiRustCallStatus),
+)
+_UniffiLib.uniffi_glsdk_fn_method_credentials_node_id.restype = _UniffiRustBuffer
 _UniffiLib.uniffi_glsdk_fn_method_credentials_save.argtypes = (
     ctypes.c_void_p,
     ctypes.POINTER(_UniffiRustCallStatus),
@@ -746,6 +755,11 @@ class _UniffiForeignFutureStructVoid(ctypes.Structure):
     ctypes.POINTER(_UniffiRustCallStatus),
 )
 _UniffiLib.uniffi_glsdk_fn_method_node_disconnect.restype = None
+_UniffiLib.uniffi_glsdk_fn_method_node_generate_diagnostic_data.argtypes = (
+    ctypes.c_void_p,
+    ctypes.POINTER(_UniffiRustCallStatus),
+)
+_UniffiLib.uniffi_glsdk_fn_method_node_generate_diagnostic_data.restype = _UniffiRustBuffer
 _UniffiLib.uniffi_glsdk_fn_method_node_get_info.argtypes = (
     ctypes.c_void_p,
     ctypes.POINTER(_UniffiRustCallStatus),
@@ -1243,6 +1257,9 @@ class _UniffiForeignFutureStructVoid(ctypes.Structure):
 _UniffiLib.uniffi_glsdk_checksum_method_config_with_network.argtypes = (
 )
 _UniffiLib.uniffi_glsdk_checksum_method_config_with_network.restype = ctypes.c_uint16
+_UniffiLib.uniffi_glsdk_checksum_method_credentials_node_id.argtypes = (
+)
+_UniffiLib.uniffi_glsdk_checksum_method_credentials_node_id.restype = ctypes.c_uint16
 _UniffiLib.uniffi_glsdk_checksum_method_credentials_save.argtypes = (
 )
 _UniffiLib.uniffi_glsdk_checksum_method_credentials_save.restype = ctypes.c_uint16
@@ -1255,6 +1272,9 @@ class _UniffiForeignFutureStructVoid(ctypes.Structure):
 _UniffiLib.uniffi_glsdk_checksum_method_node_disconnect.argtypes = (
 )
 _UniffiLib.uniffi_glsdk_checksum_method_node_disconnect.restype = ctypes.c_uint16
+_UniffiLib.uniffi_glsdk_checksum_method_node_generate_diagnostic_data.argtypes = (
+)
+_UniffiLib.uniffi_glsdk_checksum_method_node_generate_diagnostic_data.restype = ctypes.c_uint16
 _UniffiLib.uniffi_glsdk_checksum_method_node_get_info.argtypes = (
 )
 _UniffiLib.uniffi_glsdk_checksum_method_node_get_info.restype = ctypes.c_uint16
@@ -2884,12 +2904,23 @@ class Payment:
     bolt11: "typing.Optional[str]"
     preimage: "typing.Optional[str]"
     """
-    Payment preimage as lowercase hex (64 chars), when the payment is known.
+    Payment preimage as lowercase hex (64 chars), when known.
     """
 
     destination: "typing.Optional[str]"
     """
-    Counterparty node pubkey as lowercase hex (66 chars), when known.
+    Pubkey of the counterparty in the payment, as lowercase hex
+    (66 chars).
+
+    For `PaymentType::Sent`: the recipient node we paid (when CLN
+    reports it).
+
+    For `PaymentType::Received`: always `None`. Lightning's privacy
+    model does not reveal the sender's pubkey to the recipient — the
+    HTLC arrives via one of our channel peers, but that peer is
+    usually just a router, not the original payer. The only pubkey
+    derivable from a paid invoice is the *payee* (i.e. our own
+    node), which is uninteresting to display per-row.
     """
 
     def __init__(self, *, id: "str", payment_type: "PaymentType", payment_time: "int", amount_msat: "int", fee_msat: "int", status: "PaymentStatus", description: "typing.Optional[str]", bolt11: "typing.Optional[str]", preimage: "typing.Optional[str]", destination: "typing.Optional[str]"):
@@ -4844,6 +4875,8 @@ class CredentialsProtocol(typing.Protocol):
     background.
     """
 
+    def node_id(self, ):
+        raise NotImplementedError
     def save(self, ):
         raise NotImplementedError
 # Credentials is a Rust-only trait - it's a wrapper around a Rust implementation.
@@ -4889,6 +4922,15 @@ def load(cls, raw: "bytes"):
 
 
 
+    def node_id(self, ) -> "bytes":
+        return _UniffiConverterBytes.lift(
+            _uniffi_rust_call_with_error(_UniffiConverterTypeError,_UniffiLib.uniffi_glsdk_fn_method_credentials_node_id,self._uniffi_clone_pointer(),)
+        )
+
+
+
+
+
     def save(self, ) -> "bytes":
         return _UniffiConverterBytes.lift(
             _uniffi_rust_call_with_error(_UniffiConverterTypeError,_UniffiLib.uniffi_glsdk_fn_method_credentials_save,self._uniffi_clone_pointer(),)
@@ -5111,6 +5153,19 @@ def disconnect(self, ):
         Safe to call multiple times.
         """
 
+        raise NotImplementedError
+    def generate_diagnostic_data(self, ):
+        """
+        Collect a diagnostic snapshot of the node and SDK state.
+
+        Returns a pretty-printed JSON string with shape:
+        `{ "timestamp": <unix-secs>, "node": { ... }, "sdk": { "version": ..., "node_state": ... } }`.
+        The `node` object contains one entry per CLN RPC (`getinfo`,
+        `listpeerchannels`, `listfunds`, `listpays`, `listinvoices`); each
+        value is the serialized response, or `{ "error": "..." }` if that
+        RPC failed. Intended for support tickets.
+        """
+
         raise NotImplementedError
     def get_info(self, ):
         """
@@ -5306,6 +5361,26 @@ def disconnect(self, ) -> None:
 
 
 
+    def generate_diagnostic_data(self, ) -> "str":
+        """
+        Collect a diagnostic snapshot of the node and SDK state.
+
+        Returns a pretty-printed JSON string with shape:
+        `{ "timestamp": <unix-secs>, "node": { ... }, "sdk": { "version": ..., "node_state": ... } }`.
+        The `node` object contains one entry per CLN RPC (`getinfo`,
+        `listpeerchannels`, `listfunds`, `listpays`, `listinvoices`); each
+        value is the serialized response, or `{ "error": "..." }` if that
+        RPC failed. Intended for support tickets.
+        """
+
+        return _UniffiConverterString.lift(
+            _uniffi_rust_call_with_error(_UniffiConverterTypeError,_UniffiLib.uniffi_glsdk_fn_method_node_generate_diagnostic_data,self._uniffi_clone_pointer(),)
+        )
+
+
+
+
+
     def get_info(self, ) -> "GetInfoResponse":
         """
         Get information about the node.

libs/gl-sdk/glsdk/glsdk.py

@@ -584,6 +584,70 @@ impl Node {
             inner: Mutex::new(stream),
         }))
     }
+
+    /// Collect a diagnostic snapshot of the node and SDK state.
+    ///
+    /// Returns a pretty-printed JSON string with shape:
+    /// `{ "timestamp": <unix-secs>, "node": { ... }, "sdk": { "version": ..., "node_state": ... } }`.
+    /// The `node` object contains one entry per CLN RPC (`getinfo`,
+    /// `listpeerchannels`, `listfunds`); each value is the serialized
+    /// response, or `{ "error": "..." }` if that RPC failed. Payment and
+    /// invoice history are deliberately excluded to avoid leaking
+    /// preimages, payment hashes, bolt11 strings, and labels into support
+    /// dumps. Intended for support tickets.
+    pub fn generate_diagnostic_data(&self) -> Result<String, Error> {
+        self.check_connected()?;
+
+        let timestamp = std::time::SystemTime::now()
+            .duration_since(std::time::UNIX_EPOCH)
+            .map(|d| d.as_secs())
+            .unwrap_or(0);
+
+        let getinfo = render_section(self.get_info());
+        let listpeerchannels = render_section(self.list_peer_channels());
+        let listfunds = render_section(self.list_funds());
+        let node_state = render_section(self.node_state());
+
+        build_diagnostic_json(
+            timestamp,
+            env!("CARGO_PKG_VERSION"),
+            getinfo,
+            listpeerchannels,
+            listfunds,
+            node_state,
+        )
+    }
+}
+
+fn render_section<T: serde::Serialize>(result: Result<T, Error>) -> serde_json::Value {
+    match result {
+        Ok(v) => serde_json::to_value(&v)
+            .unwrap_or_else(|e| serde_json::json!({ "error": e.to_string() })),
+        Err(e) => serde_json::json!({ "error": e.to_string() }),
+    }
+}
+
+fn build_diagnostic_json(
+    timestamp: u64,
+    sdk_version: &str,
+    getinfo: serde_json::Value,
+    listpeerchannels: serde_json::Value,
+    listfunds: serde_json::Value,
+    node_state: serde_json::Value,
+) -> Result<String, Error> {
+    let envelope = serde_json::json!({
+        "timestamp": timestamp,
+        "node": {
+            "getinfo": getinfo,
+            "listpeerchannels": listpeerchannels,
+            "listfunds": listfunds,
+        },
+        "sdk": {
+            "version": sdk_version,
+            "node_state": node_state,
+        }
+    });
+    serde_json::to_string_pretty(&envelope).map_err(|e| Error::Other(e.to_string()))
 }
 
 // Not exported through uniffi
@@ -713,7 +777,7 @@ pub struct ReceiveResponse {
     pub opening_fee_msat: u64,
 }
 
-#[derive(uniffi::Enum, Clone)]
+#[derive(uniffi::Enum, Clone, serde::Serialize)]
 pub enum PayStatus {
     COMPLETE = 0,
     PENDING = 1,
@@ -746,7 +810,7 @@ impl From<i32> for PayStatus {
 // ============================================================
 
 #[allow(unused)]
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct GetInfoResponse {
     /// Node public key as lowercase hex (66 chars).
     pub id: String,
@@ -831,13 +895,13 @@ impl From<clnpb::ListpeersPeers> for Peer {
 // ============================================================
 
 #[allow(unused)]
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct ListPeerChannelsResponse {
     pub channels: Vec<PeerChannel>,
 }
 
 #[allow(unused)]
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct PeerChannel {
     /// Peer node public key as lowercase hex (66 chars).
     pub peer_id: String,
@@ -863,7 +927,7 @@ pub struct PeerChannel {
 }
 
 /// Which side of a channel performed a given action (e.g. initiated close).
-#[derive(Clone, uniffi::Enum)]
+#[derive(Clone, serde::Serialize, uniffi::Enum)]
 pub enum ChannelSide {
     Local,
     Remote,
@@ -879,7 +943,7 @@ impl ChannelSide {
     }
 }
 
-#[derive(Clone, uniffi::Enum)]
+#[derive(Clone, serde::Serialize, uniffi::Enum)]
 pub enum ChannelState {
     Openingd,
     ChanneldAwaitingLockin,
@@ -992,14 +1056,14 @@ impl From<clnpb::ListpeerchannelsChannels> for PeerChannel {
 // ============================================================
 
 #[allow(unused)]
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct ListFundsResponse {
     pub outputs: Vec<FundOutput>,
     pub channels: Vec<FundChannel>,
 }
 
 #[allow(unused)]
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct FundOutput {
     /// Transaction id as lowercase hex (64 chars).
     pub txid: String,
@@ -1015,7 +1079,7 @@ pub struct FundOutput {
     pub reserved: bool,
 }
 
-#[derive(Clone, uniffi::Enum)]
+#[derive(Clone, serde::Serialize, uniffi::Enum)]
 pub enum OutputStatus {
     Unconfirmed,
     Confirmed,
@@ -1036,7 +1100,7 @@ impl OutputStatus {
 }
 
 #[allow(unused)]
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct FundChannel {
     /// Peer node public key as lowercase hex (66 chars).
     pub peer_id: String,
@@ -1117,7 +1181,7 @@ impl ListIndex {
 // ListInvoices response types
 // ============================================================
 
-#[derive(Clone, uniffi::Enum)]
+#[derive(Clone, serde::Serialize, uniffi::Enum)]
 pub enum InvoiceStatus {
     UNPAID,
     PAID,
@@ -1135,7 +1199,7 @@ impl From<i32> for InvoiceStatus {
     }
 }
 
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct Invoice {
     pub label: String,
     pub description: String,
@@ -1180,7 +1244,7 @@ impl From<clnpb::ListinvoicesInvoices> for Invoice {
     }
 }
 
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct ListInvoicesResponse {
     pub invoices: Vec<Invoice>,
 }
@@ -1197,7 +1261,7 @@ impl From<clnpb::ListinvoicesResponse> for ListInvoicesResponse {
 // ListPays response types
 // ============================================================
 
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct Pay {
     /// Payment hash as lowercase hex (64 chars).
     pub payment_hash: String,
@@ -1243,7 +1307,7 @@ impl From<clnpb::ListpaysPays> for Pay {
     }
 }
 
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct ListPaysResponse {
     pub pays: Vec<Pay>,
 }
@@ -1394,7 +1458,7 @@ impl From<clnpb::ListpaysPays> for Payment {
 /// connectivity. Returned by `node_state()`.
 ///
 /// All amounts are in millisatoshis (1 sat = 1000 msat).
-#[derive(Clone, uniffi::Record)]
+#[derive(Clone, serde::Serialize, uniffi::Record)]
 pub struct NodeState {
     /// The node's public key as a lowercase hex string (66 chars).
     pub id: String,
@@ -1574,3 +1638,4 @@ impl From<glpb::NodeEvent> for NodeEvent {
         }
     }
 }
+