Remove all dependences on -cln or -lnd name to determine type - use pod metadata

Author: macgyver13

resources/charts/bitcoincore/charts/cln/templates/_helpers.tpl

@@ -35,12 +35,7 @@ If release name contains chart name it will be used as a full name.
 {{- if .Values.fullnameOverride }}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
-{{- $name := default .Chart.Name .Values.nameOverride }}
-{{- if contains $name .Release.Name }}
-{{- .Release.Name | trunc 63 | trimSuffix "-" }}
-{{- else }}
-{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
-{{- end }}
+{{- printf "%s-ln" .Release.Name | trunc 63 | trimSuffix "-" }}
 {{- end }}
 {{- end }}
 

resources/charts/bitcoincore/charts/lnd/templates/_helpers.tpl

@@ -23,7 +23,7 @@ If release name contains chart name it will be used as a full name.
 Expand the name of the chart.
 */}}
 {{- define "lnd.name" -}}
-{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}-lnd
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
 {{- end }}
 
 {{/*
@@ -35,7 +35,7 @@ If release name contains chart name it will be used as a full name.
 {{- if .Values.fullnameOverride }}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
 {{- else }}
-{{- printf "%s" .Release.Name | trunc 63 | trimSuffix "-" }}-lnd
+{{- printf "%s-ln" .Release.Name | trunc 63 | trimSuffix "-" }}
 {{- end }}
 {{- end }}
 

resources/networks/hello/network.yaml

@@ -29,7 +29,7 @@ nodes:
         - id:
             block: 300
             index: 1
-          target: tank-0004-lnd
+          target: tank-0004-ln
           capacity: 100000
           push_amt: 50000
 
@@ -43,7 +43,7 @@ nodes:
         - id:
             block: 300
             index: 2
-          target: tank-0005-lnd
+          target: tank-0005-ln
           capacity: 50000
           push_amt: 25000
 
@@ -66,7 +66,7 @@ plugins:  # Each plugin section has a number of hooks available (preDeploy, post
       helloTo: "postDeploy!"
     simln:  # You can have multiple plugins per hook
       entrypoint: "../../plugins/simln"
-      activity: '[{"source": "tank-0003-lnd", "destination": "tank-0005-lnd", "interval_secs": 1, "amount_msat": 2000}]'
+      activity: '[{"source": "tank-0003-ln", "destination": "tank-0005-ln", "interval_secs": 1, "amount_msat": 2000}]'
   preNode:  # preNode plugins run before each node is deployed
     hello:
       entrypoint: "../../plugins/hello"

resources/plugins/simln/README.md

@@ -13,7 +13,7 @@ SimLN also requires access details for each node; however, the SimLN plugin will
 
 ```` JSON
 {
-  "id": <node_id>-lnd,
+  "id": <node_id>,
   "address": https://<ip:port or domain:port>,
   "macaroon": <path_to_selected_macaroon>,
   "cert": <path_to_tls_cert>
@@ -22,11 +22,11 @@ SimLN also requires access details for each node; however, the SimLN plugin will
 SimLN also supports Core Lightning (CLN).  CLN nodes connection details are transfered from the CLN node to SimLN node during launch-activity processing.
 ```` JSON
 {
-  "id": <node_id>-cln,
+  "id": <node_id>,
   "address": https://<domain:port>,
-  "ca_cert": /working/<node_id>-cln-ca.pem,
-  "client_cert": /working/<node_id>-cln-client.pem,
-  "client_key": /working/<node_id>-cln-client-key.pem
+  "ca_cert": /working/<node_id>-ca.pem,
+  "client_cert": /working/<node_id>-client.pem,
+  "client_key": /working/<node_id>-client-key.pem
 }
 ````
 
@@ -35,7 +35,7 @@ Since SimLN already has access to those LND and CLN connection details, it means
 ### Launch activity definitions from the command line
 The SimLN plugin takes "activity" definitions like so:
 
-`./simln/plugin.py launch-activity '[{\"source\": \"tank-0003-lnd\", \"destination\": \"tank-0005-lnd\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"''`
+`./simln/plugin.py launch-activity '[{\"source\": \"tank-0003-ln\", \"destination\": \"tank-0005-ln\", \"interval_secs\": 1, \"amount_msat\": 2000}]'"''`
 
 ### Launch activity definitions from within `network.yaml`
 When you initialize a new Warnet network, Warnet will create a new `network.yaml` file.  If your `network.yaml` file includes lightning nodes, then you can use SimLN to produce activity between those nodes like this:
@@ -75,7 +75,7 @@ nodes:
         - id:
             block: 300
             index: 1
-          target: tank-0004-lnd
+          target: tank-0004-ln
           capacity: 100000
           push_amt: 50000
 
@@ -89,7 +89,7 @@ nodes:
         - id:
             block: 300
             index: 2
-          target: tank-0005-lnd
+          target: tank-0005-ln
           capacity: 50000
           push_amt: 25000
 
@@ -103,7 +103,7 @@ plugins:
   postDeploy:
     simln:
       entrypoint: "../../plugins/simln"  # This is the path to the simln plugin folder (relative to the network.yaml file).
-      activity: '[{"source": "tank-0003-lnd", "destination": "tank-0005-lnd", "interval_secs": 1, "amount_msat": 2000}]'
+      activity: '[{"source": "tank-0003-ln", "destination": "tank-0005-ln", "interval_secs": 1, "amount_msat": 2000}]'
 ````
 
 </details>

resources/plugins/simln/plugin.py

@@ -168,7 +168,7 @@ def _generate_activity_json(activity: Optional[list[dict]]) -> str:
         ln_name = i.metadata.name
         port = 10009
         node = {"id": ln_name}
-        if "-cln" in ln_name:
+        if "cln" in i.metadata.labels["app.kubernetes.io/name"]:
             port = 9736
             node["ca_cert"] = f"/working/{ln_name}-ca.pem"
             node["client_cert"] = f"/working/{ln_name}-client.pem"
@@ -192,7 +192,7 @@ def transfer_cln_certs(name):
     cln_root = "/root/.lightning/regtest"
     for i in get_mission(LIGHTNING_MISSION):
         ln_name = i.metadata.name
-        if "cln" in ln_name:
+        if "cln" in i.metadata.labels["app.kubernetes.io/name"]:
             copyfile(
                 ln_name,
                 "cln",

resources/scenarios/ln_framework/ln.py

@@ -112,8 +112,8 @@ def to_lnd_chanpolicy(self, capacity):
 
 class LNNode(ABC):
     @abstractmethod
-    def __init__(self, pod_name):
-        self.log = None
+    def __init__(self, pod_name, logger=None):
+        self.log = logger
         self.name = pod_name
 
     def setLogger(self, logger):
@@ -164,8 +164,8 @@ def update(self, txid_hex: str, policy: dict, capacity: int) -> dict:
 
 
 class CLN(LNNode):
-    def __init__(self, pod_name):
-        super().__init__(pod_name)
+    def __init__(self, pod_name, logger=None):
+        super().__init__(pod_name, logger)
         self.headers = {}
         self.impl = "cln"
 
@@ -329,8 +329,8 @@ def update(self, txid_hex: str, policy: dict, capacity: int, max_tries=2) -> dic
 
 
 class LND(LNNode):
-    def __init__(self, pod_name):
-        super().__init__(pod_name)
+    def __init__(self, pod_name, logger=None):
+        super().__init__(pod_name, logger)
         self.conn = http.client.HTTPSConnection(
             host=pod_name, port=8080, timeout=5, context=INSECURE_CONTEXT
         )

src/warnet/ln.py

@@ -32,7 +32,7 @@ def _rpc(pod_name: str, method: str, params: str = "", namespace: Optional[str]
     namespace = get_default_namespace_or(namespace)
     chain = pod.metadata.labels["chain"]
     ln_client = "lncli"
-    if "-cln" in pod_name:
+    if "cln" in pod.metadata.labels["app.kubernetes.io/name"]:
         ln_client = "lightning-cli"
     cmd = f"kubectl -n {namespace} exec {pod_name} -- {ln_client} --network {chain} {method} {' '.join(map(str, params))}"
     return run_command(cmd)
@@ -49,10 +49,11 @@ def pubkey(
     print(_pubkey(pod))
 
 
-def _pubkey(pod: str):
-    info = _rpc(pod, "getinfo")
+def _pubkey(pod_name: str):
+    info = _rpc(pod_name, "getinfo")
+    pod = get_pod(pod_name)
     pubkey_key = "identity_pubkey"
-    if "-cln" in pod:
+    if "cln" in pod.metadata.labels["app.kubernetes.io/name"]:
         pubkey_key = "id"
     return json.loads(info)[pubkey_key]
 
@@ -68,9 +69,10 @@ def host(
     print(_host(pod))
 
 
-def _host(pod):
-    info = _rpc(pod, "getinfo")
-    if "-cln" in pod:
+def _host(pod_name: str):
+    info = _rpc(pod_name, "getinfo")
+    pod = get_pod(pod_name)
+    if "cln" in pod.metadata.labels["app.kubernetes.io/name"]:
         return json.loads(info)["alias"]
     else:
         uris = json.loads(info)["uris"]

test/ln_basic_test.py

@@ -16,12 +16,12 @@ def __init__(self):
         self.network_dir = Path(os.path.dirname(__file__)) / "data" / "ln"
         self.scen_dir = Path(os.path.dirname(__file__)).parent / "resources" / "scenarios"
         self.lns = [
-            "tank-0000-lnd",
-            "tank-0001-lnd",
-            "tank-0002-lnd",
-            "tank-0003-lnd",
-            "tank-0004-lnd",
-            "tank-0005-lnd",
+            "tank-0000-ln",
+            "tank-0001-ln",
+            "tank-0002-ln",
+            "tank-0003-ln",
+            "tank-0004-ln",
+            "tank-0005-ln",
         ]
 
     def run_test(self):
@@ -30,13 +30,13 @@ def run_test(self):
             self.setup_network()
 
             # Send a payment across channels opened automatically by ln_init
-            self.pay_invoice(sender="tank-0005-lnd", recipient="tank-0003-lnd")
+            self.pay_invoice(sender="tank-0005-ln", recipient="tank-0003-ln")
 
             # Manually open two more channels between first three nodes
             # and send a payment using warnet RPC
             self.manual_open_channels()
             self.wait_for_gossip_sync(self.lns[:3], 2 + 2)
-            self.pay_invoice(sender="tank-0000-lnd", recipient="tank-0002-lnd")
+            self.pay_invoice(sender="tank-0000-ln", recipient="tank-0002-ln")
 
         finally:
             self.cleanup()
@@ -63,27 +63,27 @@ def wait_for_two_txs(self):
 
     def manual_open_channels(self):
         # 0 -> 1 -> 2
-        pk1 = self.warnet("ln pubkey tank-0001-lnd")
-        pk2 = self.warnet("ln pubkey tank-0002-lnd")
+        pk1 = self.warnet("ln pubkey tank-0001-ln")
+        pk2 = self.warnet("ln pubkey tank-0002-ln")
 
         host1 = ""
         host2 = ""
 
         while not host1 or not host2:
             if not host1:
-                host1 = self.warnet("ln host tank-0001-lnd")
+                host1 = self.warnet("ln host tank-0001-ln")
             if not host2:
-                host2 = self.warnet("ln host tank-0002-lnd")
+                host2 = self.warnet("ln host tank-0002-ln")
             sleep(1)
 
         print(
             self.warnet(
-                f"ln rpc tank-0000-lnd openchannel --node_key {pk1} --local_amt 100000 --connect {host1}"
+                f"ln rpc tank-0000-ln openchannel --node_key {pk1} --local_amt 100000 --connect {host1}"
             )
         )
         print(
             self.warnet(
-                f"ln rpc tank-0001-lnd openchannel --node_key {pk2} --local_amt 100000 --connect {host2}"
+                f"ln rpc tank-0001-ln openchannel --node_key {pk2} --local_amt 100000 --connect {host2}"
             )
         )
 

test/ln_mixed_test.py

@@ -17,11 +17,11 @@ def __init__(self):
         self.network_dir = Path(os.path.dirname(__file__)) / "data" / "ln_mixed"
         self.scen_dir = Path(os.path.dirname(__file__)).parent / "resources" / "scenarios"
         self.lns = [
-            CLN("tank-0001-ln"),
-            CLN("tank-0002-ln"),
-            LND("tank-0003-ln"),
-            LND("tank-0004-ln"),
-            LND("tank-0005-ln"),
+            CLN("tank-0001-ln", self.log),
+            CLN("tank-0002-ln", self.log),
+            LND("tank-0003-ln", self.log),
+            LND("tank-0004-ln", self.log),
+            LND("tank-0005-ln", self.log),
         ]
 
     def node(self, name: str) -> LNNode: