feat: Make default runner connection available

There is no reason to keep a generic interface in the
runner and provide the implementation in the core lightning runner
if the only way to establish a connection with the node is through
the pyln.proto package.

This commit moves the CLightningConn inside the runner interface
to allow everyone access to the default implementation.

Signed-off-by: Vincenzo Palazzo <[email protected]>

Author: vincenzopalazzo

lnprototest/__init__.py

@@ -45,6 +45,7 @@
 from .runner import (
     Runner,
     Conn,
+    RunnerConn,
     remote_revocation_basepoint,
     remote_payment_basepoint,
     remote_delayed_payment_basepoint,
@@ -84,75 +85,3 @@
     AddWitnesses,
 )
 from .proposals import dual_fund_csv, channel_type_csv
-
-__all__ = [
-    "EventError",
-    "SpecFileError",
-    "Resolvable",
-    "ResolvableInt",
-    "ResolvableStr",
-    "ResolvableBool",
-    "Event",
-    "Connect",
-    "Disconnect",
-    "DualFundAccept",
-    "CreateDualFunding",
-    "AddInput",
-    "AddOutput",
-    "FinalizeFunding",
-    "AddWitnesses",
-    "Msg",
-    "RawMsg",
-    "ExpectMsg",
-    "Block",
-    "ExpectTx",
-    "FundChannel",
-    "InitRbf",
-    "Invoice",
-    "AddHtlc",
-    "ExpectError",
-    "Sequence",
-    "OneOf",
-    "AnyOrder",
-    "TryAll",
-    "CheckEq",
-    "MustNotMsg",
-    "SigType",
-    "Sig",
-    "DummyRunner",
-    "Runner",
-    "Conn",
-    "KeySet",
-    "peer_message_namespace",
-    "namespace",
-    "assign_namespace",
-    "make_namespace",
-    "bitfield",
-    "has_bit",
-    "bitfield_len",
-    "msat",
-    "negotiated",
-    "remote_revocation_basepoint",
-    "remote_payment_basepoint",
-    "remote_delayed_payment_basepoint",
-    "remote_htlc_basepoint",
-    "remote_per_commitment_point",
-    "remote_per_commitment_secret",
-    "remote_funding_pubkey",
-    "remote_funding_privkey",
-    "Commit",
-    "HTLC",
-    "UpdateCommit",
-    "Side",
-    "AcceptFunding",
-    "CreateFunding",
-    "Funding",
-    "regtest_hash",
-    "privkey_expand",
-    "Wait",
-    "dual_fund_csv",
-    "channel_type_csv",
-    "wait_for",
-    "CloseChannel",
-    "ExpectDisconnect",
-]

lnprototest/clightning/clightning.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # This script exercises the core-lightning implementation
 
 # Released by Rusty Russell under CC0:
@@ -27,6 +26,7 @@
     SpecFileError,
     KeySet,
     Conn,
+    RunnerConn,
     namespace,
     MustNotMsg,
 )
@@ -37,23 +37,6 @@
 LIGHTNING_SRC = os.path.join(os.getcwd(), os.getenv("LIGHTNING_SRC", "../lightning/"))
 
 
-class CLightningConn(lnprototest.Conn):
-    def __init__(self, connprivkey: str, port: int):
-        super().__init__(connprivkey)
-        # FIXME: pyln.proto.wire should just use coincurve PrivateKey!
-        self.connection = pyln.proto.wire.connect(
-            pyln.proto.wire.PrivateKey(bytes.fromhex(self.connprivkey.to_hex())),
-            # FIXME: Ask node for pubkey
-            pyln.proto.wire.PublicKey(
-                bytes.fromhex(
-                    "0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798"
-                )
-            ),
-            "127.0.0.1",
-            port,
-        )
-
-
 class Runner(lnprototest.Runner):
     def __init__(self, config: Any):
         super().__init__(config)
@@ -194,7 +177,7 @@ def stop(self, print_logs: bool = False, also_bitcoind: bool = True) -> None:
         self.shutdown(also_bitcoind=also_bitcoind)
         self.running = False
         for c in self.conns.values():
-            cast(CLightningConn, c).connection.connection.close()
+            c.connection.connection.close()
         if print_logs:
             log_path = f"{self.lightning_dir}/regtest/log"
             with open(log_path) as log:
@@ -216,7 +199,13 @@ def restart(self) -> None:
         self.start(also_bitcoind=False)
 
     def connect(self, _: Event, connprivkey: str) -> None:
-        self.add_conn(CLightningConn(connprivkey, self.lightning_port))
+        self.add_conn(
+            RunnerConn(
+                connprivkey,
+                "0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798",
+                self.lightning_port,
+            )
+        )
 
     def getblockheight(self) -> int:
         return self.bitcoind.rpc.getblockcount()
@@ -232,15 +221,13 @@ def add_blocks(self, event: Event, txs: List[str], n: int) -> None:
 
         wait_for(lambda: self.rpc.getinfo()["blockheight"] == self.getblockheight())
 
-    def recv(self, event: Event, conn: Conn, outbuf: bytes) -> None:
+    def recv(self, event: Event, conn: RunnerConn, outbuf: bytes) -> None:
         try:
-            cast(CLightningConn, conn).connection.send_message(outbuf)
+            conn.connection.send_message(outbuf)
         except BrokenPipeError:
             # This happens when they've sent an error and closed; try
             # reading it to figure out what went wrong.
-            fut = self.executor.submit(
-                cast(CLightningConn, conn).connection.read_message
-            )
+            fut = self.executor.submit(conn.connection.read_message)
             try:
                 msg = fut.result(1)
             except futures.TimeoutError:
@@ -255,7 +242,7 @@ def recv(self, event: Event, conn: Conn, outbuf: bytes) -> None:
     def fundchannel(
         self,
         event: Event,
-        conn: Conn,
+        conn: RunnerConn,
         amount: int,
         feerate: int = 253,
         expect_fail: bool = False,
@@ -279,7 +266,7 @@ def fundchannel(
 
         def _fundchannel(
             runner: Runner,
-            conn: Conn,
+            conn: RunnerConn,
             amount: int,
             feerate: int,
             expect_fail: bool = False,
@@ -352,7 +339,7 @@ def kill_fundchannel(self) -> None:
     def init_rbf(
         self,
         event: Event,
-        conn: Conn,
+        conn: RunnerConn,
         channel_id: str,
         amount: int,
         utxo_txid: str,
@@ -416,7 +403,9 @@ def accept_add_fund(self, event: Event) -> None:
             },
         )
 
-    def addhtlc(self, event: Event, conn: Conn, amount: int, preimage: str) -> None:
+    def addhtlc(
+        self, event: Event, conn: RunnerConn, amount: int, preimage: str
+    ) -> None:
         payhash = hashlib.sha256(bytes.fromhex(preimage)).hexdigest()
         routestep = {
             "msatoshi": amount,
@@ -429,9 +418,9 @@ def addhtlc(self, event: Event, conn: Conn, amount: int, preimage: str) -> None:
         self.rpc.sendpay([routestep], payhash)
 
     def get_output_message(
-        self, conn: Conn, event: Event, timeout: int = TIMEOUT
+        self, conn: RunnerConn, event: Event, timeout: int = TIMEOUT
     ) -> Optional[bytes]:
-        fut = self.executor.submit(cast(CLightningConn, conn).connection.read_message)
+        fut = self.executor.submit(conn.connection.read_message)
         try:
             return fut.result(timeout)
         except futures.TimeoutError as ex:
@@ -441,7 +430,7 @@ def get_output_message(
             logging.error(f"{ex}")
             return None
 
-    def check_error(self, event: Event, conn: Conn) -> Optional[str]:
+    def check_error(self, event: Event, conn: RunnerConn) -> Optional[str]:
         # We get errors in form of err msgs, always.
         super().check_error(event, conn)
         msg = self.get_output_message(conn, event)
@@ -452,13 +441,13 @@ def check_error(self, event: Event, conn: Conn) -> Optional[str]:
     def check_final_error(
         self,
         event: Event,
-        conn: Conn,
+        conn: RunnerConn,
         expected: bool,
         must_not_events: List[MustNotMsg],
     ) -> None:
         if not expected:
             # Inject raw packet to ensure it hangs up *after* processing all previous ones.
-            cast(CLightningConn, conn).connection.connection.send(bytes(18))
+            conn.connection.connection.send(bytes(18))
 
             while True:
                 binmsg = self.get_output_message(conn, event)
@@ -475,7 +464,7 @@ def check_final_error(
                 if msgtype == namespace().get_msgtype("error").number:
                     raise EventError(event, "Got error msg: {}".format(binmsg.hex()))
 
-        cast(CLightningConn, conn).connection.connection.close()
+        conn.connection.connection.close()
 
     def expect_tx(self, event: Event, txid: str) -> None:
         # Ah bitcoin endianness...

lnprototest/runner.py

@@ -1,18 +1,20 @@
-#! /usr/bin/python3
 import logging
 import shutil
 import tempfile
 
 import coincurve
 import functools
 
+import pyln
+
+from abc import ABC, abstractmethod
+from typing import Dict, Optional, List, Union, Any, Callable
+
 from .errors import SpecFileError
 from .structure import Sequence
 from .event import Event, MustNotMsg, ExpectMsg
 from .utils import privkey_expand
 from .keyset import KeySet
-from abc import ABC, abstractmethod
-from typing import Dict, Optional, List, Union, Any, Callable
 
 
 class Conn(object):
@@ -31,6 +33,28 @@ def __str__(self) -> str:
         return self.name
 
 
+class RunnerConn(Conn):
+    """Default Connection implementation for a runner that use the pyln.proto
+    to open a connection over a socket."""
+
+    def __init__(
+        self,
+        connprivkey: str,
+        counterparty_pubkey: str,
+        port: int,
+        host: str = "127.0.0.1",
+    ):
+        super().__init__(connprivkey)
+        # FIXME: pyln.proto.wire should just use coincurve PrivateKey!
+        self.connection = pyln.proto.wire.connect(
+            pyln.proto.wire.PrivateKey(bytes.fromhex(self.connprivkey.to_hex())),
+            # FIXME: Ask node for pubkey
+            pyln.proto.wire.PublicKey(bytes.fromhex(counterparty_pubkey)),
+            host,
+            port,
+        )
+
+
 class Runner(ABC):
     """Abstract base class for runners.
 
@@ -42,8 +66,8 @@ def __init__(self, config: Any):
         self.config = config
         self.directory = tempfile.mkdtemp(prefix="lnpt-cl-")
         # key == connprivkey, value == Conn
-        self.conns: Dict[str, Conn] = {}
-        self.last_conn: Optional[Conn] = None
+        self.conns: Dict[str, RunnerConn] = {}
+        self.last_conn: Optional[RunnerConn] = None
         self.stash: Dict[str, Dict[str, Any]] = {}
         self.logger = logging.getLogger(__name__)
         if self.config.getoption("verbose"):
@@ -55,7 +79,7 @@ def _is_dummy(self) -> bool:
         """The DummyRunner returns True here, as it can't do some things"""
         return False
 
-    def find_conn(self, connprivkey: Optional[str]) -> Optional[Conn]:
+    def find_conn(self, connprivkey: Optional[str]) -> Optional[RunnerConn]:
         # Default is whatever we specified last.
         if connprivkey is None:
             return self.last_conn
@@ -64,17 +88,17 @@ def find_conn(self, connprivkey: Optional[str]) -> Optional[Conn]:
             return self.last_conn
         return None
 
-    def add_conn(self, conn: Conn) -> None:
+    def add_conn(self, conn: RunnerConn) -> None:
         self.conns[conn.name] = conn
         self.last_conn = conn
 
-    def disconnect(self, event: Event, conn: Conn) -> None:
+    def disconnect(self, event: Event, conn: RunnerConn) -> None:
         if conn is None:
             raise SpecFileError(event, "Unknown conn")
         del self.conns[conn.name]
         self.check_final_error(event, conn, conn.expected_error, conn.must_not_events)
 
-    def check_error(self, event: Event, conn: Conn) -> Optional[str]:
+    def check_error(self, event: Event, conn: RunnerConn) -> Optional[str]:
         conn.expected_error = True
         return None
 
@@ -157,11 +181,11 @@ def stop(self, print_logs: bool = False) -> None:
         pass
 
     @abstractmethod
-    def recv(self, event: Event, conn: Conn, outbuf: bytes) -> None:
+    def recv(self, event: Event, conn: RunnerConn, outbuf: bytes) -> None:
         pass
 
     @abstractmethod
-    def get_output_message(self, conn: Conn, event: ExpectMsg) -> Optional[bytes]:
+    def get_output_message(self, conn: RunnerConn, event: ExpectMsg) -> Optional[bytes]:
         pass
 
     @abstractmethod
@@ -192,7 +216,7 @@ def accept_add_fund(self, event: Event) -> None:
     def fundchannel(
         self,
         event: Event,
-        conn: Conn,
+        conn: RunnerConn,
         amount: int,
         feerate: int = 0,
         expect_fail: bool = False,
@@ -203,7 +227,7 @@ def fundchannel(
     def init_rbf(
         self,
         event: Event,
-        conn: Conn,
+        conn: RunnerConn,
         channel_id: str,
         amount: int,
         utxo_txid: str,
@@ -213,7 +237,9 @@ def init_rbf(
         pass
 
     @abstractmethod
-    def addhtlc(self, event: Event, conn: Conn, amount: int, preimage: str) -> None:
+    def addhtlc(
+        self, event: Event, conn: RunnerConn, amount: int, preimage: str
+    ) -> None:
         pass
 
     @abstractmethod