lightningd: add option for minimum seeker autoconnect peers

endothermicdev · rustyrussell · commit dc878dc937ca · 2024-11-22T15:21:45.000+10:30
Changelog-added: Added option --autoconnect-seeker-peers, allowing seeker to reach out to new nodes for additional gossip.
diff --git a/.msggen.json b/.msggen.json
@@ -1620,6 +1620,7 @@
             "ListConfigs.configs.announce-addr-discovered": 54,
             "ListConfigs.configs.announce-addr-discovered-port": 55,
             "ListConfigs.configs.announce-addr-dns": 67,
+            "ListConfigs.configs.autoconnect-seeker-peers": 71,
             "ListConfigs.configs.autolisten": 51,
             "ListConfigs.configs.bind-addr": 49,
             "ListConfigs.configs.clear-plugins": 3,
@@ -1718,6 +1719,10 @@
             "ListConfigs.configs.announce-addr-dns.source": 2,
             "ListConfigs.configs.announce-addr-dns.value_bool": 1
         },
+        "ListconfigsConfigsAutoconnect-seeker-peers": {
+            "ListConfigs.configs.autoconnect-seeker-peers.source": 2,
+            "ListConfigs.configs.autoconnect-seeker-peers.value_int": 1
+        },
         "ListconfigsConfigsAutolisten": {
             "ListConfigs.configs.autolisten.source": 2,
             "ListConfigs.configs.autolisten.value_bool": 1
@@ -1989,6 +1994,7 @@
             "ListConfigs.announce-addr-discovered": 52,
             "ListConfigs.announce-addr-discovered-port": 53,
             "ListConfigs.announce-addr-dns": 66,
+            "ListConfigs.autoconnect-seeker-peers": 72,
             "ListConfigs.autolisten": 49,
             "ListConfigs.bind-addr": 47,
             "ListConfigs.bookkeeper-db": 12,
@@ -6698,6 +6704,10 @@
             "added": "v22.11.1",
             "deprecated": "v23.08"
         },
+        "ListConfigs.autoconnect-seeker-peers": {
+            "added": "v24.11",
+            "deprecated": null
+        },
         "ListConfigs.autolisten": {
             "added": "pre-v0.10.1",
             "deprecated": "v23.08"
@@ -6854,6 +6864,18 @@
             "added": "pre-v0.10.1",
             "deprecated": null
         },
+        "ListConfigs.configs.autoconnect-seeker-peers": {
+            "added": "v24.11",
+            "deprecated": null
+        },
+        "ListConfigs.configs.autoconnect-seeker-peers.source": {
+            "added": "v24.11",
+            "deprecated": null
+        },
+        "ListConfigs.configs.autoconnect-seeker-peers.value_int": {
+            "added": "v24.11",
+            "deprecated": null
+        },
         "ListConfigs.configs.autolisten": {
             "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
@@ -19817,6 +19817,31 @@
                     ]
                   }
                 }
+              },
+              "autoconnect-seeker-peers": {
+                "added": "v24.11",
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "value_int",
+                  "source"
+                ],
+                "properties": {
+                  "value_int": {
+                    "type": "u32",
+                    "added": "v24.11",
+                    "description": [
+                      "Field from config or cmdline, or default."
+                    ]
+                  },
+                  "source": {
+                    "type": "string",
+                    "added": "v24.11",
+                    "description": [
+                      "Source of configuration setting."
+                    ]
+                  }
+                }
               }
             }
           },
@@ -20581,6 +20606,13 @@
             "description": [
               "Additional commitment feerate applied by channel owner."
             ]
+          },
+          "autoconnect-seeker-peers": {
+            "type": "u32",
+            "added": "v24.11",
+            "description": [
+              "Minimum number of gossip peers. Seeker connects to random nodes until this number is reached."
+            ]
           }
         },
         "pre_return_value_notes": [
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
@@ -2108,6 +2108,13 @@ def listconfigs_configs_announce_addr_dns2py(m):
     })
 
 
+def listconfigs_configs_autoconnect_seeker_peers2py(m):
+    return remove_default({
+        "source": m.source,  # PrimitiveField in generate_composite
+        "value_int": m.value_int,  # PrimitiveField in generate_composite
+    })
+
+
 def listconfigs_configs_autolisten2py(m):
     return remove_default({
         "source": m.source,  # PrimitiveField in generate_composite
@@ -2582,6 +2589,7 @@ def listconfigs2py(m):
         "announce_addr_discovered": m.announce_addr_discovered,  # PrimitiveField in generate_composite
         "announce_addr_discovered_port": m.announce_addr_discovered_port,  # PrimitiveField in generate_composite
         "announce_addr_dns": m.announce_addr_dns,  # PrimitiveField in generate_composite
+        "autoconnect_seeker_peers": m.autoconnect_seeker_peers,  # PrimitiveField in generate_composite
         "autolisten": m.autolisten,  # PrimitiveField in generate_composite
         "bind_addr": m.bind_addr,  # PrimitiveField in generate_composite
         "bookkeeper_db": m.bookkeeper_db,  # PrimitiveField in generate_composite
diff --git a/doc/lightningd-config.5.md b/doc/lightningd-config.5.md
@@ -645,6 +645,10 @@ its use disables autolisten.
 can be useful for maintenance and forensics, so is usually specified on
 the command line. Overrides all *addr* and *bind-addr* options.
 
+* **autoconnect-seeker-peers**=*NUMBER* (added in v24.11)
+
+  Sets the number of peers to gossip with: if we don't have this many connections, we will try to connect to random peers until we do.  The default is 10.
+
 * **autolisten**=*BOOL*
 
   By default, we bind (and maybe announce) on IPv4 and IPv6 interfaces if
diff --git a/doc/schemas/lightning-listconfigs.json b/doc/schemas/lightning-listconfigs.json
@@ -1675,6 +1675,31 @@
                 ]
               }
             }
+          },
+          "autoconnect-seeker-peers": {
+            "added": "v24.11",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "value_int",
+              "source"
+            ],
+            "properties": {
+              "value_int": {
+                "type": "u32",
+                "added": "v24.11",
+                "description": [
+                  "Field from config or cmdline, or default."
+                ]
+              },
+              "source": {
+                "type": "string",
+                "added": "v24.11",
+                "description": [
+                  "Source of configuration setting."
+                ]
+              }
+            }
           }
         }
       },
@@ -2439,6 +2464,13 @@
         "description": [
           "Additional commitment feerate applied by channel owner."
         ]
+      },
+      "autoconnect-seeker-peers": {
+        "type": "u32",
+        "added": "v24.11",
+        "description": [
+          "Minimum number of gossip peers. Seeker connects to random nodes until this number is reached."
+        ]
       }
     },
     "pre_return_value_notes": [
diff --git a/lightningd/lightningd.c b/lightningd/lightningd.c
@@ -370,6 +370,9 @@ static struct lightningd *new_lightningd(const tal_t *ctx)
 	 * which is due for complete removal. */
 	ld->api_begs = tal_arr(ld, const char *, 0);
 
+	/* The gossip seeker automatically connects to a this many peers */
+	ld->autoconnect_seeker_peers = 10;
+
 	return ld;
 }
 
diff --git a/lightningd/lightningd.h b/lightningd/lightningd.h
@@ -419,6 +419,9 @@ struct lightningd {
 
 	/* Explicitly re-enabled deprecated APIs. */
 	const char **api_begs;
+
+	/* Minimum number of peers seeker should maintain. */
+	u32 autoconnect_seeker_peers;
 };
 
 /* Turning this on allows a tal allocation to return NULL, rather than aborting.
diff --git a/lightningd/options.c b/lightningd/options.c
@@ -970,6 +970,10 @@ static void dev_register_opts(struct lightningd *ld)
 		     opt_ignore,
 		     NULL,
 		     "Fire up a terminal window with a debugger in it on initialization");
+	clnopt_witharg("--autoconnect-seeker-peers", OPT_SHOWINT,
+		       opt_set_u32, opt_show_u32,
+		       &ld->autoconnect_seeker_peers,
+		       "Seeker autoconnects to maintain this minimum number of gossip peers");
 }
 
 static const struct config testnet_config = {

Original file line number	Diff line number	Diff line change
`@@ -370,6 +370,9 @@ static struct lightningd new_lightningd(const tal_t ctx)`
`370`	`370`	`* which is due for complete removal. */`
`371`	`371`	`ld->api_begs = tal_arr(ld, const char *, 0);`
`372`	`372`
	`373`	`+ /* The gossip seeker automatically connects to a this many peers */`
	`374`	`+ ld->autoconnect_seeker_peers = 10;`
	`375`	`+`
`373`	`376`	`return ld;`
`374`	`377`	`}`
`375`	`378`