arcane-mage 2.2.0__tar.gz → 2.2.1__tar.gz

{arcane_mage-2.2.0 → arcane_mage-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: arcane-mage
-Version: 2.2.0
+Version: 2.2.1
 Summary: Automation helper for Fluxnodes
 Author-email: David White <david@runonflux.io>
 License-File: LICENSE

{arcane_mage-2.2.0 → arcane_mage-2.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "arcane-mage"
-version = "2.2.0"
+version = "2.2.1"
 description = "Automation helper for Fluxnodes"
 readme = "README.md"
 authors = [

{arcane_mage-2.2.0 → arcane_mage-2.2.1}/src/arcane_mage/models/config.py

@@ -59,7 +59,10 @@ class ArcaneOsConfig:
         ]
 
     async def write_installer_config(self, file_path: Path) -> bool:
-        res = await self.fluxnode.network.write_installer_config(file_path)
+        chain = self.fluxnode.chain
+        res = await self.fluxnode.network.write_installer_config(
+            file_path, labnet=chain is not None and chain.network == "labnet"
+        )
 
         return res
 

{arcane_mage-2.2.0 → arcane_mage-2.2.1}/src/arcane_mage/models/network.py

@@ -67,12 +67,7 @@ class Link:
     @property
     def ethernet(self) -> bool:
         # not sure how this applies for wlan interfaces as I don't have one to test
-        return (
-            self.kind is None
-            and self.name != "lo"
-            and bool(self.address)
-            and self.address != "00:00:00:00:00:00"
-        )
+        return self.kind is None and self.name != "lo" and bool(self.address) and self.address != "00:00:00:00:00:00"
 
 
 @py_dataclass
@@ -137,11 +132,7 @@ class Route:
         if not isinstance(other, Route):
             return False
 
-        return (
-            self.dst == other.dst
-            and self.link == other.link
-            and self.gateway == other.gateway
-        )
+        return self.dst == other.dst and self.link == other.link and self.gateway == other.gateway
 
 
 @py_dataclass
@@ -264,6 +255,20 @@ class NetworkConfig:
         return confs
 
 
+def chain_source_address(ip: IPv4Address, *, labnet: bool) -> bool:
+    """Whether a node may stream its chain from `ip`: a unicast address on a LAN,
+    or, installing onto labnet, on labnet's internet too. Loopback, link-local,
+    multicast, unspecified, reserved and broadcast addresses are never a source,
+    though Python counts several of them private."""
+    if ip.is_loopback or ip.is_link_local or ip.is_multicast or ip.is_unspecified or ip.is_reserved:
+        return False
+    if ip == IPv4Address("255.255.255.255"):
+        return False
+    if ip.is_private:
+        return True
+    return labnet and ip.is_global
+
+
 @py_dataclass
 class FluxnodeNetworkConfig:
     """Fluxnode-specific network settings such as UPnP and private chain sources."""
@@ -275,7 +280,10 @@ class FluxnodeNetworkConfig:
     def to_dict(self) -> dict:
         return TypeAdapter(type(self)).dump_python(self, mode="json", exclude_defaults=True)
 
-    async def write_installer_config(self, file_path: Path | str) -> bool:
+    async def write_installer_config(self, file_path: Path | str, *, labnet: bool = False) -> bool:
+        """Writes the installer's network section. A chain source is kept only at a
+        unicast address a node can stream from: on a LAN, or, for a node installing
+        onto labnet, also on labnet's internet, where the lab's donor answers."""
         # we let the configure app set the local chain sources
         ip_pattern = r"^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$"
         port_pattern = (
@@ -294,7 +302,7 @@ class FluxnodeNetworkConfig:
             if not re.match(ip_pattern, ip) or not re.match(port_pattern, port):
                 continue
 
-            if not IPv4Address(ip).is_private:
+            if not chain_source_address(IPv4Address(ip), labnet=labnet):
                 continue
 
             filtered_chain_sources.append(chain_source)

arcane_mage-2.2.1/tests/test_models/test_chain_sources.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+import yaml
+
+from arcane_mage.models.config import ArcaneOsConfig
+
+LAB_KEY = "020483178bc32818eb9922b68ac0771fe95136a6edf746016125270cfc2111fd5a"
+
+
+async def written_sources(tmp_path: Path, node: dict, sources: list[str], chain: dict | None) -> list[str]:
+    node["fluxnode"]["network"] = {"private_chain_sources": sources}
+    if chain is not None:
+        node["fluxnode"]["chain"] = chain
+    path = tmp_path / "installer.yaml"
+    assert await ArcaneOsConfig.from_dict(node).write_installer_config(path)
+    return yaml.safe_load(path.read_text())["network"]["private_chain_sources"]
+
+
+async def test_a_mainnet_install_keeps_only_private_chain_sources(tmp_path: Path, minimal_node_dict: dict):
+    sources = ["192.168.1.20:16127", "10.0.0.5:16137", "25.47.0.2:16127", "8.8.8.8:16127"]
+
+    kept = await written_sources(tmp_path, minimal_node_dict, sources, None)
+
+    assert kept == ["192.168.1.20:16127", "10.0.0.5:16137"]
+
+
+async def test_a_labnet_install_keeps_the_labs_donor_on_its_internet(tmp_path: Path, minimal_node_dict: dict):
+    sources = ["25.47.0.2:16127", "192.168.147.10:16127"]
+
+    kept = await written_sources(tmp_path, minimal_node_dict, sources, {"network": "labnet", "key": LAB_KEY})
+
+    assert kept == ["25.47.0.2:16127", "192.168.147.10:16127"]
+
+
+@pytest.mark.parametrize(
+    "source",
+    [
+        "127.0.0.1:16127",
+        "0.0.0.0:16127",
+        "169.254.10.1:16127",
+        "224.0.0.1:16127",
+        "255.255.255.255:16127",
+        "240.0.0.1:16127",
+        "25.47.0.2:99999",
+        "25.47.0.2",
+        "host.example:16127",
+    ],
+)
+async def test_a_labnet_install_still_drops_what_is_no_unicast_source(
+    tmp_path: Path, minimal_node_dict: dict, source: str
+):
+    kept = await written_sources(tmp_path, minimal_node_dict, [source], {"network": "labnet", "key": LAB_KEY})
+
+    assert kept == []
+
+
+async def test_an_explicit_mainnet_chain_keeps_only_private_chain_sources(tmp_path: Path, minimal_node_dict: dict):
+    kept = await written_sources(tmp_path, minimal_node_dict, ["25.47.0.2:16127"], {"network": "mainnet"})
+
+    assert kept == []
+
+
+@pytest.mark.parametrize(
+    "source",
+    [
+        "127.0.0.1:16127",
+        "0.0.0.0:16127",
+        "169.254.10.1:16127",
+        "255.255.255.255:16127",
+        "240.0.0.1:16127",
+    ],
+)
+async def test_a_mainnet_install_drops_what_is_no_lan_source(tmp_path: Path, minimal_node_dict: dict, source: str):
+    kept = await written_sources(tmp_path, minimal_node_dict, [source], None)
+
+    assert kept == []

{arcane_mage-2.2.0 → arcane_mage-2.2.1}/uv.lock

@@ -146,7 +146,7 @@ wheels = [
 
 [[package]]
 name = "arcane-mage"
-version = "2.2.0"
+version = "2.2.1"
 source = { editable = "." }
 dependencies = [
     { name = "aiofiles" },