doc: update pay_part_start and pay_part_end
What the developer wrote
Authored by Peter Neuroth
doc: update pay_part_start and pay_part_end
Signed-off-by: Peter Neuroth <pet.v.ne@gmail.com>
What changed, and why it matters
This commit only updates developer documentation. It changes example JSON snippets for two plugin event notifications so that the fields appear directly under 'params' instead of being nested inside a 'payload' object. There is no code change and no security relevance.
No security action needed. Treat as a normal documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies doc/developers-guide/plugin-development/event-notifications.md, flattening the documented structure of the ‘pay_part_start’ and ‘pay_part_end’ notification payloads. The previous examples wrapped fields in a ‘payload’ key; the new examples place the same fields at the top level of ‘params’. No executable code, schema enforcement, or runtime behavior is changed.
Changed components
doc/developers-guide/plugin-development/event-notifications.mdInspect captured patch +26 / −30
diff --git a/doc/developers-guide/plugin-development/event-notifications.md b/doc/developers-guide/plugin-development/event-notifications.md
index ea906c25..148719d6 100644
--- a/doc/developers-guide/plugin-development/event-notifications.md
+++ b/doc/developers-guide/plugin-development/event-notifications.md
@@ -602,29 +602,27 @@ The example shows a payment from this node via 103x1x0 (direction 1) to 022d2236
"method": "pay_part_start",
"params": {
"origin": "cln-xpay",
- "payload": {
- "payment_hash": "651b28004d41cf0dc8e39a0b3d905651a7b012d03d81199fde09314700cb5a62",
- "groupid": 5793910575598463611,
- "partid": 1,
- "total_payment_msat": 5000000,
- "attempt_msat": 5000000,
- "hops": [
- {
- "next_node": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
- "short_channel_id": "103x1x0",
- "direction": 1,
- "channel_in_msat": 5000051,
- "channel_out_msat": 5000051
- },
- {
- "next_node": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d",
- "short_channel_id": "103x2x0",
- "direction": 0,
- "channel_in_msat": 5000051,
- "channel_out_msat": 5000000
- }
- ]
- }
+ "payment_hash": "651b28004d41cf0dc8e39a0b3d905651a7b012d03d81199fde09314700cb5a62",
+ "groupid": 5793910575598463611,
+ "partid": 1,
+ "total_payment_msat": 5000000,
+ "attempt_msat": 5000000,
+ "hops": [
+ {
+ "next_node": "022d223620a359a47ff7f7ac447c85c46c923da53389221a0054c11c1e3ca31d59",
+ "short_channel_id": "103x1x0",
+ "direction": 1,
+ "channel_in_msat": 5000051,
+ "channel_out_msat": 5000051
+ },
+ {
+ "next_node": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d",
+ "short_channel_id": "103x2x0",
+ "direction": 0,
+ "channel_in_msat": 5000051,
+ "channel_out_msat": 5000000
+ }
+ ]
}
}
```
@@ -652,13 +650,11 @@ will be missing in the unusual case where the error onion is corrupted.
"method": "pay_part_end",
"params": {
"origin": "cln-xpay",
- "payload": {
- "status": "success",
- "duration": 0.220209189,
- "payment_hash": "651b28004d41cf0dc8e39a0b3d905651a7b012d03d81199fde09314700cb5a62",
- "groupid": 5793910575598463611,
- "partid": 1
- }
+ "status": "success",
+ "duration": 0.220209189,
+ "payment_hash": "651b28004d41cf0dc8e39a0b3d905651a7b012d03d81199fde09314700cb5a62",
+ "groupid": 5793910575598463611,
+ "partid": 1
}
}
```
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.