tank: handle bitcoin conf args in tank instead of backends

Author: pinheadmz

src/backends/compose/compose_backend.py

@@ -16,7 +16,6 @@
 from warnet.status import RunningStatus
 from warnet.tank import Tank
 from warnet.utils import (
-    default_bitcoin_conf_args,
     get_architecture,
     parse_raw_messages,
 )
@@ -340,24 +339,6 @@ def generate_deployment_file(self, warnet):
             dirs_exist_ok=True,
         )
 
-    def config_args(self, tank: Tank):
-        args = self.default_config_args(tank)
-        if tank.bitcoin_config is not None:
-            args = f"{args} -{tank.bitcoin_config.replace(',', ' -')}"
-        return args
-
-    def default_config_args(self, tank):
-        defaults = default_bitcoin_conf_args()
-        defaults += f" -rpcuser={tank.rpc_user}"
-        defaults += f" -rpcpassword={tank.rpc_password}"
-        defaults += f" -rpcport={tank.rpc_port}"
-        defaults += f" -zmqpubrawblock=tcp://0.0.0.0:{tank.zmqblockport}"
-        defaults += f" -zmqpubrawtx=tcp://0.0.0.0:{tank.zmqtxport}"
-        # connect to initial peers as defined in graph file
-        for dst_index in tank.init_peers:
-            defaults += f" -addnode={self.get_container_name(dst_index, ServiceType.BITCOIN)}"
-        return defaults
-
     def add_services(self, tank: Tank, compose):
         services = compose["services"]
         assert tank.index is not None
@@ -385,13 +366,17 @@ def add_services(self, tank: Tank, compose):
             # Pre-built regular release
             image = f"{DOCKER_REGISTRY}:{tank.version}"
             services[container_name]["image"] = image
+
+        peers = [self.get_container_name(dst_index, ServiceType.BITCOIN) for dst_index in tank.init_peers]
+        args = tank.get_bitcoin_conf(peers)
+
         # Add common bitcoind service details
         services[container_name].update(
             {
                 "container_name": container_name,
                 # logging with json-file to support log shipping with promtail into loki
                 "logging": {"driver": "json-file", "options": {"max-size": "10m"}},
-                "environment": {"BITCOIN_ARGS": self.config_args(tank)},
+                "environment": {"BITCOIN_ARGS": args},
                 "networks": {
                     tank.network_name: {
                         "ipv4_address": f"{tank.ipv4}",

src/backends/kubernetes/kubernetes_backend.py

@@ -17,7 +17,7 @@
 from kubernetes.stream import stream
 from warnet.status import RunningStatus
 from warnet.tank import Tank
-from warnet.utils import default_bitcoin_conf_args, parse_raw_messages
+from warnet.utils import parse_raw_messages
 
 DOCKER_REGISTRY_CORE = "bitcoindevproject/bitcoin"
 LOCAL_REGISTRY = "warnet/bitcoin-core"
@@ -313,18 +313,6 @@ def generate_deployment_file(self, warnet):
         """
         pass
 
-    def default_bitcoind_config_args(self, tank):
-        defaults = default_bitcoin_conf_args()
-        defaults += f" -rpcuser={tank.rpc_user}"
-        defaults += f" -rpcpassword={tank.rpc_password}"
-        defaults += f" -rpcport={tank.rpc_port}"
-        defaults += f" -zmqpubrawblock=tcp://0.0.0.0:{tank.zmqblockport}"
-        defaults += f" -zmqpubrawtx=tcp://0.0.0.0:{tank.zmqtxport}"
-        # connect to initial peers as defined in graph file
-        for dst_index in tank.init_peers:
-            defaults += f" -addnode={self.get_service_name(dst_index)}"
-        return defaults
-
     def create_bitcoind_container(self, tank: Tank) -> client.V1Container:
         self.log.debug(f"Creating bitcoind container for tank {tank.index}")
         container_name = BITCOIN_CONTAINER_NAME
@@ -356,8 +344,8 @@ def create_bitcoind_container(self, tank: Tank) -> client.V1Container:
         else:
             container_image = f"{DOCKER_REGISTRY_CORE}:{tank.version}"
 
-        bitcoind_options = self.default_bitcoind_config_args(tank)
-        bitcoind_options += f" {tank.bitcoin_config}"
+        peers = [self.get_service_name(dst_index) for dst_index in tank.init_peers]
+        bitcoind_options = tank.get_bitcoin_conf(peers)
         container_env = [client.V1EnvVar(name="BITCOIN_ARGS", value=bitcoind_options)]
 
         bitcoind_container = client.V1Container(

src/templates/bitcoin.conf

@@ -19,6 +19,19 @@
 
 logger = logging.getLogger("tank")
 
+CONFIG_BASE = " ".join([
+    "-regtest=1",
+    "-checkmempool=0",
+    "-acceptnonstdtxn=1",
+    "-debuglogfile=0",
+    "-logips=1",
+    "-logtimemicros=1",
+    "-capturemessages=1",
+    "-rpcallowip=0.0.0.0/0",
+    "-rpcbind=0.0.0.0",
+    "-fallbackfee=0.00001000",
+    "-listen=1"
+])
 
 class Tank:
     DEFAULT_BUILD_ARGS = "--disable-tests --with-incompatible-bdb --without-gui --disable-bench --disable-fuzz-binary --enable-suppress-external-warnings --enable-debug "
@@ -31,7 +44,6 @@ def __init__(self, index: int, warnet):
         self.version: str = ""
         self.image: str = ""
         self.bitcoin_config = ""
-        self.conf_file = None
         self.netem = None
         self.exporter = False
         self.collect_logs = False
@@ -123,6 +135,18 @@ def status(self) -> RunningStatus:
     def exec(self, cmd: str):
         return self.warnet.container_interface.exec_run(self.index, ServiceType.BITCOIN, cmd=cmd)
 
+    def get_bitcoin_conf(self, nodes: list[str]) -> str:
+        conf = CONFIG_BASE
+        conf += f" -rpcuser={self.rpc_user}"
+        conf += f" -rpcpassword={self.rpc_password}"
+        conf += f" -rpcport={self.rpc_port}"
+        conf += f" -zmqpubrawblock=tcp://0.0.0.0:{self.zmqblockport}"
+        conf += f" -zmqpubrawtx=tcp://0.0.0.0:{self.zmqtxport}"
+        conf += self.bitcoin_config
+        for node in nodes:
+            conf += f" -addnode={node}"
+        return conf
+
     def apply_network_conditions(self):
         if self.netem is None:
             return

src/warnet/tank.py

@@ -15,7 +15,6 @@
 import networkx as nx
 from jsonschema import validate
 from schema import SCHEMA
-from templates import TEMPLATES
 from test_framework.messages import ser_uint256
 from test_framework.p2p import MESSAGEMAP
 
@@ -388,22 +387,6 @@ def set_execute_permission(file_path):
     os.chmod(file_path, current_permissions | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
 
 
-def default_bitcoin_conf_args() -> str:
-    default_conf: Path = TEMPLATES / "bitcoin.conf"
-
-    with default_conf.open("r") as f:
-        defaults = parse_bitcoin_conf(f.read())
-
-    conf_args = []
-
-    for kvs in defaults.values():
-        # Skip section names, just focus on key-value pairs
-        for key, value in kvs:
-            conf_args.append(f"-{key}={value}")
-
-    return " ".join(conf_args)
-
-
 def create_cycle_graph(n: int, version: str, bitcoin_conf: str | None, random_version: bool):
     try:
         # Use nx.DiGraph() as base otherwise edges not always made in specific directions