address comments

reduce ln_init changes
start migration of CLN to REST

Author: macgyver13

.github/workflows/test.yml

@@ -41,7 +41,6 @@ jobs:
           - graph_test.py
           - logging_test.py
           - ln_basic_test.py
-          - ln_mixed_test.py
           - ln_test.py
           - rpc_test.py
           - services_test.py

resources/charts/bitcoincore/charts/cln/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 "cln.name" -}}
-{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}-ln
 {{- 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-ln" .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- printf "%s" .Release.Name | trunc 63 | trimSuffix "-" }}-ln
 {{- end }}
 {{- end }}
 

resources/charts/bitcoincore/charts/cln/templates/configmap.yaml

@@ -20,6 +20,8 @@ data:
     bitcoin-retry-timeout=600
     grpc-port={{ .Values.RPCPort }}
     grpc-host=0.0.0.0
+    clnrest-host=0.0.0.0
+    clnrest-port=3010
 ---
 apiVersion: v1
 kind: ConfigMap

resources/charts/bitcoincore/charts/cln/templates/pod.yaml

@@ -34,6 +34,9 @@ spec:
         - name: rpc
           containerPort: {{ .Values.RPCPort }}
           protocol: TCP
+        - name: rest
+          containerPort: {{ .Values.RestPort }}
+          protocol: TCP
       command:
         - /bin/sh
         - -c

resources/charts/bitcoincore/charts/cln/templates/service.yaml

@@ -16,5 +16,9 @@ spec:
       targetPort: rpc
       protocol: TCP
       name: rpc
+    - port: {{ .Values.RestPort }}
+      targetPort: rest
+      protocol: TCP
+      name: rest
   selector:
     {{- include "cln.selectorLabels" . | nindent 4 }}

resources/charts/bitcoincore/charts/cln/values.yaml

@@ -33,6 +33,7 @@ service:
 
 P2PPort: 9735
 RPCPort: 9736
+RestPort: 3010
 
 # This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/
 ingress:

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 "-" }}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}-ln
 {{- 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-ln" .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- printf "%s" .Release.Name | trunc 63 | trimSuffix "-" }}-ln
 {{- end }}
 {{- end }}
 

resources/plugins/simln/charts/simln/values.yaml

@@ -4,8 +4,6 @@ image:
   tag: "0.2.3"
   pullPolicy: IfNotPresent
 
-restartPolicy: Never
-
 workingVolume:
   name: working-volume
   mountPath: /working

resources/scenarios/commander.py

@@ -228,7 +228,6 @@ def setup(self):
             self.tanks[tank["tank"]] = node
 
         for ln in WARNET["lightning"]:
-            ln.setLogger(self.log)
             self.lns[ln.name] = ln
 
         self.num_nodes = len(self.nodes)

resources/scenarios/ln_framework/ln.py

@@ -1,6 +1,7 @@
 import base64
 import http.client
 import json
+import logging
 import os
 import ssl
 from abc import ABC, abstractmethod
@@ -112,12 +113,14 @@ def to_lnd_chanpolicy(self, capacity):
 
 class LNNode(ABC):
     @abstractmethod
-    def __init__(self, pod_name, logger=None):
-        self.log = logger
+    def __init__(self, pod_name):
         self.name = pod_name
-
-    def setLogger(self, logger):
-        self.log = logger
+        self.log = logging.getLogger(pod_name)
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter(f'%(name)-8s - %(levelname)s: %(message)s')
+        handler.setFormatter(formatter)
+        self.log.addHandler(handler)
+        self.log.setLevel(logging.INFO)
 
     @staticmethod
     def param_dict_to_list(params: dict) -> list[str]:
@@ -164,11 +167,78 @@ def update(self, txid_hex: str, policy: dict, capacity: int) -> dict:
 
 
 class CLN(LNNode):
-    def __init__(self, pod_name, logger=None):
-        super().__init__(pod_name, logger)
+    def __init__(self, pod_name):
+        super().__init__(pod_name)
+        self.conn = http.client.HTTPSConnection(
+            host=pod_name, port=8080, timeout=5, context=INSECURE_CONTEXT
+        )
         self.headers = {}
         self.impl = "cln"
 
+    def reset_connection(self):
+        self.conn = http.client.HTTPSConnection(
+            host=self.name, port=3010, timeout=5, context=INSECURE_CONTEXT
+        )
+
+    def setRune(self, rune):
+        self.headers = {
+            "Rune": rune
+        }
+
+    def get(self, uri):
+        attempt = 0
+        while True:
+            try:
+                self.log.warning(f"headers: {self.headers}")
+                self.conn.request(
+                    method="GET",
+                    url=uri,
+                    headers=self.headers,
+                )
+                return self.conn.getresponse().read().decode("utf8")
+            except Exception as e:
+                self.reset_connection()
+                attempt += 1
+                if attempt > 5:
+                    self.log.error(f"Error CLN GET, Abort: {e}")
+                    return None
+                sleep(1)
+
+    def post(self, uri, data={}):
+        body = json.dumps(data)
+        post_header = self.headers
+        post_header["Content-Length"] = str(len(body))
+        post_header["Content-Type"] = "application/json"
+        attempt = 0
+        while True:
+            try:
+                self.conn.request(
+                    method="POST",
+                    url=uri,
+                    body=body,
+                    headers=post_header,
+                )
+                # Stream output, otherwise we get a timeout error
+                res = self.conn.getresponse()
+                stream = ""
+                while True:
+                    try:
+                        data = res.read(1)
+                        if len(data) == 0:
+                            break
+                        else:
+                            stream += data.decode("utf8")
+                    except Exception:
+                        break
+                return stream
+            except Exception as e:
+                self.reset_connection()
+                attempt += 1
+                if attempt > 5:
+                    self.log.error(f"Error CLN POST, Abort: {e}")
+                    return None
+                sleep(1)
+
     def rpc(
         self,
         method: str,
@@ -191,12 +261,26 @@ def rpc(
                 self.log.error(f"CLN rpc error: {e}, wait and retry...")
                 sleep(2)
         return None
+    
+    def createrune(self, max_tries=2):
+        attempt = 0
+        while attempt < max_tries:
+            attempt += 1
+            response = self.rpc("createrune")
+            if not response:
+                sleep(2)
+                continue
+            res = json.loads(response)
+            self.setRune(res["rune"])
+            return
+        raise Exception(f"Unable to fetch rune from {self.name}")
 
     def newaddress(self, max_tries=2):
+        self.createrune()
         attempt = 0
         while attempt < max_tries:
             attempt += 1
-            response = self.rpc("newaddr")
+            response = self.post("/v1/newaddr")
             if not response:
                 sleep(2)
                 continue
@@ -211,7 +295,7 @@ def newaddress(self, max_tries=2):
         return False, ""
 
     def uri(self):
-        res = json.loads(self.rpc("getinfo"))
+        res = json.loads(self.post("/v1/getinfo"))
         if len(res["address"]) < 1:
             return None
         return f"{res['id']}@{res['address'][0]['address']}:{res['address'][0]['port']}"
@@ -220,7 +304,7 @@ def walletbalance(self, max_tries=2) -> int:
         attempt = 0
         while attempt < max_tries:
             attempt += 1
-            response = self.rpc("listfunds")
+            response = self.post("/v1/listfunds")
             if not response:
                 sleep(2)
                 continue
@@ -232,7 +316,7 @@ def channelbalance(self, max_tries=2) -> int:
         attempt = 0
         while attempt < max_tries:
             attempt += 1
-            response = self.rpc("listfunds")
+            response = self.post("/v1/listfunds")
             if not response:
                 sleep(2)
                 continue
@@ -244,7 +328,7 @@ def connect(self, target_uri, max_tries=5) -> dict:
         attempt = 0
         while attempt < max_tries:
             attempt += 1
-            response = self.rpc("connect", [target_uri])
+            response = self.post("/v1/connect", {"id": target_uri})
             if response:
                 res = json.loads(response)
                 if "id" in res:
@@ -269,7 +353,7 @@ def channel(self, pk, capacity, push_amt, fee_rate, max_tries=5) -> dict:
         attempt = 0
         while attempt < max_tries:
             attempt += 1
-            response = self.rpc("fundchannel", self.param_dict_to_list(data))
+            response = self.post("/v1/fundchannel", data)
             if response:
                 res = json.loads(response)
                 if "txid" in res:
@@ -283,14 +367,14 @@ def channel(self, pk, capacity, push_amt, fee_rate, max_tries=5) -> dict:
         return None
 
     def createinvoice(self, sats, label, description="new invoice") -> str:
-        response = self.rpc("invoice", [sats * 1000, label, description])
+        response = self.post("invoice", {"amount_msat": sats * 1000, "label": label, "description": description})
         if response:
             res = json.loads(response)
             return res["bolt11"]
         return None
 
     def payinvoice(self, payment_request) -> str:
-        response = self.rpc("pay", [payment_request])
+        response = self.rpc("pay", {"bolt11": payment_request})
         if response:
             res = json.loads(response)
             if "code" in res:
@@ -303,7 +387,7 @@ def graph(self, max_tries=2) -> dict:
         attempt = 0
         while attempt < max_tries:
             attempt += 1
-            response = self.rpc("listchannels")
+            response = self.post("/v1/listchannels")
             if response:
                 res = json.loads(response)
                 if "channels" in res:
@@ -329,8 +413,8 @@ def update(self, txid_hex: str, policy: dict, capacity: int, max_tries=2) -> dic
 
 
 class LND(LNNode):
-    def __init__(self, pod_name, logger=None):
-        super().__init__(pod_name, logger)
+    def __init__(self, pod_name):
+        super().__init__(pod_name)
         self.conn = http.client.HTTPSConnection(
             host=pod_name, port=8080, timeout=5, context=INSECURE_CONTEXT
         )