[WIP] lnprototest refactoring

Makefile

@@ -5,7 +5,10 @@ POSSIBLE_PYTEST_NAMES=pytest-3 pytest3 pytest
 PYTEST := $(shell for p in $(POSSIBLE_PYTEST_NAMES); do if type $$p > /dev/null; then echo $$p; break; fi done)
 TEST_DIR=tests
 
-default: check-source check check-quotes
+# We disable the default target for the moment because we
+# need to fix pytest
+# default: check-source check check-quotes
+default: fmt check
 
 check-pytest-found:
 	@if [ -z "$(PYTEST)" ]; then echo "Cannot find any pytest: $(POSSIBLE_PYTEST_NAMES)" >&2; exit 1; fi

lnprototest/__init__.py

@@ -45,6 +45,7 @@
 from .runner import (
     Runner,
     Conn,
+    RunnerConn,
     remote_revocation_basepoint,
     remote_payment_basepoint,
     remote_delayed_payment_basepoint,
@@ -54,7 +55,6 @@
     remote_funding_pubkey,
     remote_funding_privkey,
 )
-from .dummyrunner import DummyRunner
 from .namespace import (
     peer_message_namespace,
     namespace,
@@ -84,75 +84,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)
@@ -207,7 +190,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:
@@ -228,8 +211,14 @@ def restart(self) -> None:
         self.bitcoind.restart()
         self.start(also_bitcoind=False)
 
-    def connect(self, _: Event, connprivkey: str) -> None:
-        self.add_conn(CLightningConn(connprivkey, self.lightning_port))
+    def connect(self, _: Event, connprivkey: str) -> RunnerConn:
+        conn = RunnerConn(
+            connprivkey,
+            "0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798",
+            self.lightning_port,
+        )
+        self.add_conn(conn)
+        return conn
 
     def getblockheight(self) -> int:
         return self.bitcoind.rpc.getblockcount()
@@ -245,15 +234,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:
@@ -268,7 +255,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,
@@ -292,7 +279,7 @@ def fundchannel(
 
         def _fundchannel(
             runner: Runner,
-            conn: Conn,
+            conn: RunnerConn,
             amount: int,
             feerate: int,
             expect_fail: bool = False,
@@ -365,7 +352,7 @@ def kill_fundchannel(self) -> None:
     def init_rbf(
         self,
         event: Event,
-        conn: Conn,
+        conn: RunnerConn,
         channel_id: str,
         amount: int,
         utxo_txid: str,
@@ -429,7 +416,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,
@@ -442,9 +431,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:
@@ -454,7 +443,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)
@@ -465,13 +454,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)
@@ -488,7 +477,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...