Merge pull request bitcoin-dev-project#338 from 0xB10C/2024-04-add-addrman-observer

add: addrman-observer support

Author: pinheadmz

MANIFEST.in

@@ -1,6 +1,7 @@
 include src/schema/*.json
 include src/templates/bitcoin.conf
 include src/templates/fork_observer_config.toml
+include src/templates/addrman_observer_config.toml
 include src/templates/addrman.patch
 include src/templates/isroutable.patch
 graft src/templates/k8s

src/templates/addrman_observer_config.toml

@@ -0,0 +1,8 @@
+# addrman-observer base configuration file
+
+# path to the location of the static www files
+www_path = "./www"
+
+# webserver listen address
+address = "0.0.0.0:3882"
+

src/warnet/services.py

@@ -1,4 +1,5 @@
 FO_CONF_NAME = "fork_observer_config.toml"
+AO_CONF_NAME = "addrman_observer_config.toml"
 GRAFANA_PROVISIONING = "grafana-provisioning"
 PROM_CONF_NAME = "prometheus.yml"
 
@@ -33,6 +34,14 @@
         "container_port": "2323",
         "config_files": [f"{FO_CONF_NAME}:/app/config.toml"],
     },
+    "addrmanobserver": {
+        "backends": ["compose"],
+        "image": "b10c/addrman-observer:latest",
+        "container_name_suffix": "addrman-observer",
+        "warnet_port": "23005",
+        "container_port": "3882",
+        "config_files": [f"{AO_CONF_NAME}:/app/config.toml"],
+    },
     "grafana": {
         "backends": ["compose"],
         "image": "grafana/grafana:latest",

src/warnet/warnet.py

@@ -12,7 +12,7 @@
 import yaml
 from backends import ComposeBackend, KubernetesBackend
 from templates import TEMPLATES
-from warnet.services import FO_CONF_NAME, GRAFANA_PROVISIONING, PROM_CONF_NAME
+from warnet.services import AO_CONF_NAME, FO_CONF_NAME, GRAFANA_PROVISIONING, PROM_CONF_NAME
 from warnet.tank import Tank
 from warnet.utils import gen_config_dir, load_schema, validate_graph_schema
 
@@ -181,8 +181,10 @@ def generate_deployment(self):
         self.container_interface.generate_deployment_file(self)
         if "forkobserver" in self.services:
             self.write_fork_observer_config()
+        if "addrmanobserver" in self.services:
+            self.write_addrman_observer_config()
         if "grafana" in self.services:
-            self.write_grafna_config()
+            self.write_grafana_config()
         if "prometheus" in self.services:
             self.write_prometheus_config()
 
@@ -205,8 +207,27 @@ def write_fork_observer_config(self):
                 """
                 )
         logger.info(f"Wrote file: {dst}")
+        
+    def write_addrman_observer_config(self):
+        src = TEMPLATES / AO_CONF_NAME
+        dst = self.config_dir / AO_CONF_NAME
+        shutil.copy(src, dst)
+        with open(dst, "a") as f:
+            for tank in self.tanks:
+                f.write(
+                    f"""
+                    [[nodes]]
+                    id = {tank.index}
+                    name = "node-{tank.index}"
+                    rpc_host = "{tank.ipv4}"
+                    rpc_port = {tank.rpc_port}
+                    rpc_user = "{tank.rpc_user}"
+                    rpc_password = "{tank.rpc_password}"
+                """
+                )
+        logger.info(f"Wrote file: {dst}")
 
-    def write_grafna_config(self):
+    def write_grafana_config(self):
         src = TEMPLATES / GRAFANA_PROVISIONING
         dst = self.config_dir / GRAFANA_PROVISIONING
         shutil.copytree(src, dst, dirs_exist_ok=True)

test/data/services.graphml

@@ -15,12 +15,12 @@
   <key id="source_policy"   attr.name="source_policy"    attr.type="string"   for="edge" />
   <key id="target_policy"   attr.name="target_policy"    attr.type="string"   for="edge" />
   <graph edgedefault="directed">
-    <data key="services">cadvisor forkobserver grafana nodeexporter prometheus</data>
+    <data key="services">cadvisor forkobserver addrmanobserver grafana nodeexporter prometheus</data>
     <node id="0">
         <data key="version">26.0</data>
         <data key="bitcoin_config">-uacomment=w0 -debug=validation</data>
         <data key="exporter">true</data>
         <data key="ln">lnd</data>
     </node>
   </graph>
-</graphml>
+</graphml>

test/graph_test.py

@@ -70,6 +70,15 @@
     else:
         raise Exception("forkobserver not OK")
 
+    node_id = 0
+    ao_res = requests.get(f"http://localhost:23005/{node_id}")
+    assert ao_res.status_code == 200
+    addrman = ao_res.json()
+    if "new" in addrman and "tried" in addrman:
+        print("addrmanobserver OK")
+    else:
+        raise Exception("addrmanobserver not OK")
+
     grafana_res = requests.get("http://localhost:23002/api/datasources/uid/prometheusdatasource/health")
     assert grafana_res.status_code == 200
     health = grafana_res.json()