doc: fix injectpaymentonion schema.

I used an unknown arg and it didn't complain. injectpaymentonion's schema predated the sweep which fixed up use of "additionalProperties". Indeed, we were missing some properties! Signed-off-by: Rusty Russell <[email protected]>
rustyrussell · Dec 17, 2024 · 6311a54 · 6311a54
1 parent 597a414
commit 6311a54
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 37 deletions.
diff --git a/.msggen.json b/.msggen.json
@@ -1820,7 +1820,8 @@
         "InjectpaymentonionResponse": {
             "InjectPaymentOnion.completed_at": 2,
             "InjectPaymentOnion.created_at": 1,
-            "InjectPaymentOnion.created_index": 3
+            "InjectPaymentOnion.created_index": 3,
+            "InjectPaymentOnion.payment_preimage": 4
         },
         "InvoiceRequest": {
             "Invoice.amount_msat": 10,
@@ -7575,6 +7576,10 @@
             "added": "v24.11",
             "deprecated": null
         },
+        "InjectPaymentOnion.payment_preimage": {
+            "added": "v24.11",
+            "deprecated": null
+        },
         "Invoice": {
             "added": "pre-v0.10.1",
             "deprecated": null

diff --git a/cln-grpc/proto/node.proto b/cln-grpc/proto/node.proto
diff --git a/cln-grpc/src/convert.rs b/cln-grpc/src/convert.rs
diff --git a/cln-rpc/src/model.rs b/cln-rpc/src/model.rs
diff --git a/contrib/msggen/msggen/schema.json b/contrib/msggen/msggen/schema.json
@@ -16143,14 +16143,14 @@
     "lightning-injectpaymentonion.json": {
       "$schema": "../rpc-schema-draft.json",
       "type": "object",
-      "additionalProperties": false,
       "rpc": "injectpaymentonion",
       "title": "Send a payment with a custom onion packet",
       "description": [
         "The **injectpaymentonion** RPC command causes the node to receive a payment attempt similar to the way it would receive one from a peer. The onion packet is unwrapped, then handled normally: either as a local payment, or forwarded to the next peer.",
         "Compared to lightning-sendonion(7): the handling of blinded paths and self-payments is trivial, and the interface blocks until the payment succeeds or fails.  The call also fails if this payment_hash has already been successfully paid."
       ],
       "request": {
+        "additionalProperties": false,
         "required": [
           "onion",
           "payment_hash",
@@ -16217,6 +16217,7 @@
         }
       },
       "response": {
+        "additionalProperties": false,
         "required": [
           "created_index",
           "created_at",
@@ -16241,6 +16242,13 @@
             "description": [
               "1-based index indicating order this payment was created in."
             ]
+          },
+          "payment_preimage": {
+            "added": "v24.11",
+            "type": "secret",
+            "description": [
+              "The proof of payment: SHA256 of this is the invoice's **payment_hash**."
+            ]
           }
         }
       },

diff --git a/contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py b/contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py
diff --git a/contrib/pyln-testing/pyln/testing/grpc2py.py b/contrib/pyln-testing/pyln/testing/grpc2py.py
@@ -3218,6 +3218,7 @@ def injectpaymentonion2py(m):
         "completed_at": m.completed_at,  # PrimitiveField in generate_composite
         "created_at": m.created_at,  # PrimitiveField in generate_composite
         "created_index": m.created_index,  # PrimitiveField in generate_composite
+        "payment_preimage": hexlify(m.payment_preimage),  # PrimitiveField in generate_composite
     })
 
 

diff --git a/doc/schemas/lightning-injectpaymentonion.json b/doc/schemas/lightning-injectpaymentonion.json
@@ -1,14 +1,14 @@
 {
   "$schema": "../rpc-schema-draft.json",
   "type": "object",
-  "additionalProperties": false,
   "rpc": "injectpaymentonion",
   "title": "Send a payment with a custom onion packet",
   "description": [
     "The **injectpaymentonion** RPC command causes the node to receive a payment attempt similar to the way it would receive one from a peer. The onion packet is unwrapped, then handled normally: either as a local payment, or forwarded to the next peer.",
     "Compared to lightning-sendonion(7): the handling of blinded paths and self-payments is trivial, and the interface blocks until the payment succeeds or fails.  The call also fails if this payment_hash has already been successfully paid."
   ],
   "request": {
+    "additionalProperties": false,
     "required": [
       "onion",
       "payment_hash",
@@ -75,6 +75,7 @@
     }
   },
   "response": {
+    "additionalProperties": false,
     "required": [
       "created_index",
       "created_at",
@@ -99,6 +100,13 @@
         "description": [
           "1-based index indicating order this payment was created in."
         ]
+      },
+      "payment_preimage": {
+        "added": "v24.11",
+        "type": "secret",
+        "description": [
+          "The proof of payment: SHA256 of this is the invoice's **payment_hash**."
+        ]
       }
     }
   },