xpay: deprecate xpay-handle-pay

Changelog-Deprecated: Config: option `xpay-handle-pay`, `pay` is deprecated and will be replaced by `xpay` in v27.03.

Signed-off-by: Lagrang3 <lagrang3@protonmail.com>

Author: Lagrang3

contrib/msggen/msggen/schema.json

@@ -21894,7 +21894,11 @@
                 "value_bool": false,
                 "source": "default",
                 "plugin": "/root/lightning/plugins/cln-xpay",
-                "dynamic": true
+                "dynamic": true,
+                "deprecated": [
+                  "v26.09",
+                  "v27.03"
+                ]
               },
               "xpay-slow-mode": {
                 "value_bool": false,

doc/developers-guide/deprecated-features.md

@@ -31,6 +31,7 @@ privacy:
 | keysend                                            | Command            | v26.06           | v27.03         | Replaced by more powerful `xkeysend`.                                                                                     |
 | renepay                                            | Command            | v26.06           | v27.03         | Use `xpay` instead.                                                                                                       |
 | renepaystatus                                      | Command            | v26.06           | v27.03         | Use `xpay` notifications and `listpays` or `listsendpays` instead.                                                        |
+| xpay-handle-pay                                    | Config             | v26.09           | v27.03         | `pay` is being deprecated and `xpay` for all payments is the default.                                                     |
 
 Inevitably there are features which need to change: either to be generalized, or removed when they can no longer be supported.
 

doc/schemas/listconfigs.json

@@ -2191,7 +2191,11 @@
             "value_bool": false,
             "source": "default",
             "plugin": "/root/lightning/plugins/cln-xpay",
-            "dynamic": true
+            "dynamic": true,
+            "deprecated": [
+              "v26.09",
+              "v27.03"
+            ]
           },
           "xpay-slow-mode": {
             "value_bool": false,

plugins/xpay/xpay.c

@@ -3417,9 +3417,14 @@ int main(int argc, char *argv[])
 		    notifications, ARRAY_SIZE(notifications),
 		    hooks, ARRAY_SIZE(hooks),
 	            outgoing_notifications, ARRAY_SIZE(outgoing_notifications),
-		    plugin_option_dynamic("xpay-handle-pay", "bool",
-					  "Make xpay take over pay commands it can handle.",
-					  bool_option, bool_jsonfmt, &xpay->take_over_pay),
+		    plugin_option_deprecated_dynamic("xpay-handle-pay",
+						     "bool",
+						     "Make xpay take over pay commands it can handle.",
+						     "v26.09",
+						     "v27.03",
+						     bool_option,
+						     NULL,
+						     &xpay->take_over_pay),
 		    plugin_option_dynamic("xpay-slow-mode", "bool",
 					  "Wait until all parts have completed before returning success or failure",
 					  bool_option, bool_jsonfmt, &xpay->slow_mode),

tests/test_xpay.py

@@ -527,7 +527,8 @@ def test_xpay_takeover_null_parms(node_factory, executor):
     """Test passing through RPC a list of parameters some of which have null
     json value."""
     l1, l2, l3 = node_factory.line_graph(
-        3, wait_for_announce=True, opts={"xpay-handle-pay": True}
+        3, wait_for_announce=True, opts={"xpay-handle-pay": True,
+                                         "allow-deprecated-apis": True}
     )
 
     # Amount argument is null.