Merge branch 'master' into patch-1

lightningd · Feb 7, 2024 · f763076 · f763076
2 parents f87f550 + b000c70
commit f763076
Show file tree

Hide file tree

Showing 110 changed files with 371 additions and 246 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -12,41 +12,41 @@ on:
 
 jobs:
   build-and-test:
-    name: Test PY=${{ matrix.python-version }}, DEV=${{ matrix.developer }}, EXP=${{ matrix.experimental }}, DEP=${{ matrix.deprecated }}
+    name: Test PY=${{ matrix.python-version }}, BCD=${{ matrix.bitcoind-version }}, CLN=${{ matrix.cln-version }}, EXP=${{ matrix.experimental }}, DEP=${{ matrix.deprecated }}
     runs-on: ubuntu-latest
     timeout-minutes: 60
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9]
-        developer: [0,1]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        bitcoind-version: ["26.0"]
+        cln-version: ["master", "v23.11"]
         experimental: [1]
         deprecated: [0]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
-    - name: Checkout c-lightning@master
-      uses: actions/checkout@v3
+    - name: Checkout c-lightning@${{ matrix.cln-version }}
+      uses: actions/checkout@v4
       with:
         repository: 'ElementsProject/lightning'
         path: 'lightning'
-        ref: 'master'
+        ref: ${{ matrix.cln-version }}
         submodules: 'recursive'
         fetch-depth: 0  # Required for pyln versions to be recognized
 
     - name: Download runtime dependencies
       run: |
-        export BITCOIND_VERSION="0.20.1"
-        wget https://storage.googleapis.com/c-lightning-tests/bitcoin-${BITCOIND_VERSION}-x86_64-linux-gnu.tar.bz2
-        tar -xjf bitcoin-${BITCOIND_VERSION}-x86_64-linux-gnu.tar.bz2
+        export BITCOIND_VERSION=${{ matrix.bitcoind-version }}
+        wget https://bitcoincore.org/bin/bitcoin-core-${BITCOIND_VERSION}/bitcoin-${BITCOIND_VERSION}-x86_64-linux-gnu.tar.gz
+        tar -xzf bitcoin-${BITCOIND_VERSION}-x86_64-linux-gnu.tar.gz
         sudo mv bitcoin-${BITCOIND_VERSION}/bin/* /usr/local/bin
         rm -rf bitcoin-${BITCOIND_VERSION}-x86_64-linux-gnu.tar.gz bitcoin-${BITCOIND_VERSION}
 
     - name: Compile & install c-lightning@master
       run: |
         export EXPERIMENTAL_FEATURES=${{ matrix.experimental }}
-        export DEVELOPER=${{ matrix.developer }}
         export COMPAT=${{ matrix.deprecated }}
         export VALGRIND=0
         sudo apt-get install -y \
@@ -82,19 +82,19 @@ jobs:
         sudo make install
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Test with pytest
       run: |
         export EXPERIMENTAL_FEATURES=${{ matrix.experimental }}
-        export DEVELOPER=${{ matrix.developer }}
         export COMPAT=${{ matrix.deprecated }}
         export SLOW_MACHINE=1
         export TEST_DEBUG=1
         export TRAVIS=1
         export CLN_PATH=${{ github.workspace }}/lightning
+        pip3 install --upgrade pip
         pip3 install --user -U virtualenv pip > /dev/null
         python3 .ci/test.py
 
@@ -103,7 +103,7 @@ jobs:
     # signals successful completion. Used for the PR status to pass
     # before merging.
     name: CI completion
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     needs:
       - build-and-test
     steps:

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-ARG CLN_VERSION="0.11.1"
+ARG CLN_VERSION="23.11.2"
 
 FROM elementsproject/lightningd:v${CLN_VERSION}
 

diff --git a/README.md b/README.md
diff --git a/autopilot/README.md → archived/autopilot/README.md b/autopilot/README.md → archived/autopilot/README.md
diff --git a/autopilot/__init__.py → archived/autopilot/__init__.py b/autopilot/__init__.py → archived/autopilot/__init__.py
diff --git a/autopilot/autopilot.py → archived/autopilot/autopilot.py b/autopilot/autopilot.py → archived/autopilot/autopilot.py
diff --git a/autopilot/bech32.py → archived/autopilot/bech32.py b/autopilot/bech32.py → archived/autopilot/bech32.py
diff --git a/autopilot/c-lightning-autopilot.py → archived/autopilot/c-lightning-autopilot.py b/autopilot/c-lightning-autopilot.py → archived/autopilot/c-lightning-autopilot.py
diff --git a/autopilot/lib_autopilot.py → archived/autopilot/lib_autopilot.py b/autopilot/lib_autopilot.py → archived/autopilot/lib_autopilot.py
diff --git a/autopilot/pyproject.toml → archived/autopilot/pyproject.toml b/autopilot/pyproject.toml → archived/autopilot/pyproject.toml
diff --git a/autopilot/test_autopilot.py → archived/autopilot/test_autopilot.py b/autopilot/test_autopilot.py → archived/autopilot/test_autopilot.py
diff --git a/backup/README.md → archived/backup/README.md b/backup/README.md → archived/backup/README.md
diff --git a/backup/backend.py → archived/backup/backend.py b/backup/backend.py → archived/backup/backend.py
diff --git a/backup/backends.py → archived/backup/backends.py b/backup/backends.py → archived/backup/backends.py
diff --git a/backup/backup-cli → archived/backup/backup-cli b/backup/backup-cli → archived/backup/backup-cli
diff --git a/backup/backup.py → archived/backup/backup.py b/backup/backup.py → archived/backup/backup.py
diff --git a/backup/filebackend.py → archived/backup/filebackend.py b/backup/filebackend.py → archived/backup/filebackend.py
diff --git a/backup/poetry.lock → archived/backup/poetry.lock b/backup/poetry.lock → archived/backup/poetry.lock
diff --git a/backup/protocol.py → archived/backup/protocol.py b/backup/protocol.py → archived/backup/protocol.py
diff --git a/backup/pyproject.toml → archived/backup/pyproject.toml b/backup/pyproject.toml → archived/backup/pyproject.toml
diff --git a/backup/remote.md → archived/backup/remote.md b/backup/remote.md → archived/backup/remote.md
diff --git a/backup/server.py → archived/backup/server.py b/backup/server.py → archived/backup/server.py
diff --git a/backup/socketbackend.py → archived/backup/socketbackend.py b/backup/socketbackend.py → archived/backup/socketbackend.py
diff --git a/backup/test_backup.py → archived/backup/test_backup.py b/backup/test_backup.py → archived/backup/test_backup.py
diff --git a/backup/tests/pre-4090-backup.dbak → archived/backup/tests/pre-4090-backup.dbak b/backup/tests/pre-4090-backup.dbak → archived/backup/tests/pre-4090-backup.dbak
diff --git a/archive/commando/README.md → archived/commando/README.md b/archive/commando/README.md → archived/commando/README.md
@@ -1,5 +1,18 @@
 # Commando plugin
 
+Commando has been **included in Core Lightning as first class C plugin**.
+
+It has been actively developed since and has more cool new features added
+than listed below.
+
+Checkout latest updates on commando at:
+https://docs.corelightning.org/docs/commando &
+https://docs.corelightning.org/reference/lightning-commando
+
+------------------------------------------------------------------------------------------------------
+
+# Archived Commando python plugin
+
 This plugin allows other nodes to send your node commands, and allows you
 to send them to other nodes.  The nodes must be authorized, and must be
 directly connected.

diff --git a/archive/commando/commando.py → archived/commando/commando.py b/archive/commando/commando.py → archived/commando/commando.py
diff --git a/archive/commando/requirements.txt → archived/commando/requirements.txt b/archive/commando/requirements.txt → archived/commando/requirements.txt
diff --git a/archive/commando/test_commando.py → archived/commando/test_commando.py b/archive/commando/test_commando.py → archived/commando/test_commando.py
diff --git a/donations/LICENSE → archived/donations/LICENSE b/donations/LICENSE → archived/donations/LICENSE
diff --git a/donations/README.md → archived/donations/README.md b/donations/README.md → archived/donations/README.md
diff --git a/donations/donations.py → archived/donations/donations.py b/donations/donations.py → archived/donations/donations.py
diff --git a/donations/poetry.lock → archived/donations/poetry.lock b/donations/poetry.lock → archived/donations/poetry.lock
diff --git a/donations/pyproject.toml → archived/donations/pyproject.toml b/donations/pyproject.toml → archived/donations/pyproject.toml
diff --git a/donations/templates/donation.html → archived/donations/templates/donation.html b/donations/templates/donation.html → archived/donations/templates/donation.html
diff --git a/donations/test_donations.py → archived/donations/test_donations.py b/donations/test_donations.py → archived/donations/test_donations.py
diff --git a/drain/README.md → archived/drain/README.md b/drain/README.md → archived/drain/README.md
diff --git a/drain/__init__.py → archived/drain/__init__.py b/drain/__init__.py → archived/drain/__init__.py
diff --git a/drain/clnutils.py → archived/drain/clnutils.py b/drain/clnutils.py → archived/drain/clnutils.py
diff --git a/drain/drain.py → archived/drain/drain.py b/drain/drain.py → archived/drain/drain.py
diff --git a/drain/requirements-dev.txt → archived/drain/requirements-dev.txt b/drain/requirements-dev.txt → archived/drain/requirements-dev.txt
diff --git a/drain/requirements.txt → archived/drain/requirements.txt b/drain/requirements.txt → archived/drain/requirements.txt
diff --git a/drain/test_drain.py → archived/drain/test_drain.py b/drain/test_drain.py → archived/drain/test_drain.py
diff --git a/drain/utils.py → archived/drain/utils.py b/drain/utils.py → archived/drain/utils.py
diff --git a/feeadjuster/README.md → archived/feeadjuster/README.md b/feeadjuster/README.md → archived/feeadjuster/README.md
diff --git a/feeadjuster/clnutils.py → archived/feeadjuster/clnutils.py b/feeadjuster/clnutils.py → archived/feeadjuster/clnutils.py
diff --git a/feeadjuster/feeadjuster.py → archived/feeadjuster/feeadjuster.py b/feeadjuster/feeadjuster.py → archived/feeadjuster/feeadjuster.py
diff --git a/feeadjuster/requirements.txt → archived/feeadjuster/requirements.txt b/feeadjuster/requirements.txt → archived/feeadjuster/requirements.txt
diff --git a/feeadjuster/test_clnutils.py → archived/feeadjuster/test_clnutils.py b/feeadjuster/test_clnutils.py → archived/feeadjuster/test_clnutils.py
diff --git a/feeadjuster/test_feeadjuster.py → archived/feeadjuster/test_feeadjuster.py b/feeadjuster/test_feeadjuster.py → archived/feeadjuster/test_feeadjuster.py
diff --git a/helpme/Makefile → archived/helpme/Makefile b/helpme/Makefile → archived/helpme/Makefile
diff --git a/helpme/README.md → archived/helpme/README.md b/helpme/README.md → archived/helpme/README.md
diff --git a/helpme/helpme.py → archived/helpme/helpme.py b/helpme/helpme.py → archived/helpme/helpme.py
diff --git a/helpme/requirements-dev.txt → archived/helpme/requirements-dev.txt b/helpme/requirements-dev.txt → archived/helpme/requirements-dev.txt
diff --git a/helpme/requirements.txt → archived/helpme/requirements.txt b/helpme/requirements.txt → archived/helpme/requirements.txt
diff --git a/helpme/test_helpme.py → archived/helpme/test_helpme.py b/helpme/test_helpme.py → archived/helpme/test_helpme.py
diff --git a/historian/README.org → archived/historian/README.org b/historian/README.org → archived/historian/README.org
diff --git a/historian/cli/backup.py → archived/historian/cli/backup.py b/historian/cli/backup.py → archived/historian/cli/backup.py
diff --git a/historian/cli/common.py → archived/historian/cli/common.py b/historian/cli/common.py → archived/historian/cli/common.py
diff --git a/historian/cli/db.py → archived/historian/cli/db.py b/historian/cli/db.py → archived/historian/cli/db.py
diff --git a/historian/common.py → archived/historian/common.py b/historian/common.py → archived/historian/common.py
diff --git a/historian/gossipd.py → archived/historian/gossipd.py b/historian/gossipd.py → archived/historian/gossipd.py
diff --git a/historian/historian-cli → archived/historian/historian-cli b/historian/historian-cli → archived/historian/historian-cli
diff --git a/historian/historian.py → archived/historian/historian.py b/historian/historian.py → archived/historian/historian.py
diff --git a/historian/poetry.lock → archived/historian/poetry.lock b/historian/poetry.lock → archived/historian/poetry.lock
diff --git a/historian/pyproject.toml → archived/historian/pyproject.toml b/historian/pyproject.toml → archived/historian/pyproject.toml
diff --git a/historian/test_historian.py → archived/historian/test_historian.py b/historian/test_historian.py → archived/historian/test_historian.py
diff --git a/jitrebalance/jitrebalance.py → archived/jitrebalance/jitrebalance.py b/jitrebalance/jitrebalance.py → archived/jitrebalance/jitrebalance.py
diff --git a/jitrebalance/requirements.txt → archived/jitrebalance/requirements.txt b/jitrebalance/requirements.txt → archived/jitrebalance/requirements.txt
diff --git a/jitrebalance/test_jitrebalance.py → archived/jitrebalance/test_jitrebalance.py b/jitrebalance/test_jitrebalance.py → archived/jitrebalance/test_jitrebalance.py
diff --git a/jitrebalance/tests/hold_htlcs.py → archived/jitrebalance/tests/hold_htlcs.py b/jitrebalance/tests/hold_htlcs.py → archived/jitrebalance/tests/hold_htlcs.py
diff --git a/jitrebalance/tests/refuse_htlcs.py → archived/jitrebalance/tests/refuse_htlcs.py b/jitrebalance/tests/refuse_htlcs.py → archived/jitrebalance/tests/refuse_htlcs.py
diff --git a/noise/README.org → archived/noise/README.org b/noise/README.org → archived/noise/README.org
diff --git a/noise/noise.py → archived/noise/noise.py b/noise/noise.py → archived/noise/noise.py
diff --git a/noise/onion.py → archived/noise/onion.py b/noise/onion.py → archived/noise/onion.py
diff --git a/noise/primitives.py → archived/noise/primitives.py b/noise/primitives.py → archived/noise/primitives.py
diff --git a/noise/requirements-dev.txt → archived/noise/requirements-dev.txt b/noise/requirements-dev.txt → archived/noise/requirements-dev.txt
diff --git a/noise/requirements.txt → archived/noise/requirements.txt b/noise/requirements.txt → archived/noise/requirements.txt
diff --git a/noise/test_chat.py → archived/noise/test_chat.py b/noise/test_chat.py → archived/noise/test_chat.py
diff --git a/noise/zbase32.py → archived/noise/zbase32.py b/noise/zbase32.py → archived/noise/zbase32.py
diff --git a/paytest/README.org → archived/paytest/README.org b/paytest/README.org → archived/paytest/README.org
diff --git a/paytest/paytest.py → archived/paytest/paytest.py b/paytest/paytest.py → archived/paytest/paytest.py
diff --git a/paytest/poetry.lock → archived/paytest/poetry.lock b/paytest/poetry.lock → archived/paytest/poetry.lock
diff --git a/paytest/requirements.txt → archived/paytest/requirements.txt b/paytest/requirements.txt → archived/paytest/requirements.txt
diff --git a/paytest/test_paytest.py → archived/paytest/test_paytest.py b/paytest/test_paytest.py → archived/paytest/test_paytest.py
diff --git a/probe/README.md → archived/probe/README.md b/probe/README.md → archived/probe/README.md
diff --git a/probe/probe.py → archived/probe/probe.py b/probe/probe.py → archived/probe/probe.py
diff --git a/probe/requirements.txt → archived/probe/requirements.txt b/probe/requirements.txt → archived/probe/requirements.txt
diff --git a/probe/test_probe.py → archived/probe/test_probe.py b/probe/test_probe.py → archived/probe/test_probe.py
diff --git a/prometheus/README.md → archived/prometheus/README.md b/prometheus/README.md → archived/prometheus/README.md
diff --git a/prometheus/prometheus.py → archived/prometheus/prometheus.py b/prometheus/prometheus.py → archived/prometheus/prometheus.py
@@ -32,7 +32,10 @@ def collect(self):
             value=blockheight,
         )
 
-        fees_msat = info["msatoshi_fees_collected"]
+        fees_msat = int(info.get(
+            "fees_collected_msat",
+            info.get("msatoshi_fees_collected", None)
+        ))
         yield GaugeMetricFamily(
             'lightning_fees_collected_msat',
             'How much have we been paid to route payments?',
@@ -84,10 +87,19 @@ def collect(self):
             labels=['id'],
         )
 
-        for p in peers:
-            labels = [p['id']]
-            count.add_metric(labels, len(p['channels']))
-            connected.add_metric(labels, int(p['connected']))
+        channels = self.rpc.listpeerchannels()['channels']
+        # Associate each channel with a peer
+        peers = {}
+        conn = {}
+        for c in channels:
+            peer_id = c['peer_id']
+            peers[peer_id] = peers.get(peer_id, 0) + 1
+            conn[peer_id] = conn.get(peer_id, 0) + c['peer_connected']
+
+        for p in peers.keys():
+            labels = [p]
+            count.add_metric(labels, peers[p])
+            connected.add_metric(labels, conn.get(p, 0))
 
         return [count, connected]
 
@@ -159,32 +171,31 @@ def collect(self):
             labels=['id', 'scid', 'alias'],
         )
 
-        peers = self.rpc.listpeers()['peers']
-        for p in peers:
-            for c in p['channels']:
-                # append alias for human readable labels, if no label is found fill with shortid.
-                node = self.rpc.listnodes(p['id'])['nodes']
-                if len(node) != 0 and 'alias' in node[0]:
-                    alias = node[0]['alias']
-                else:
-                    alias = 'unknown'
-
-                labels = [p['id'], c.get('short_channel_id', c.get('channel_id')), alias]
-                balance_gauge.add_metric(labels, c['to_us_msat'].to_satoshi())
-                spendable_gauge.add_metric(labels,
-                                           c['spendable_msat'].to_satoshi())
-                total_gauge.add_metric(labels, c['total_msat'].to_satoshi())
-                htlc_gauge.add_metric(labels, len(c['htlcs']))
-
-                in_payments_offered_gauge.add_metric(labels, c['in_payments_offered'])
-                in_payments_fulfilled_gauge.add_metric(labels, c['in_payments_fulfilled'])
-                in_msatoshi_offered_gauge.add_metric(labels, c['in_msatoshi_offered'])
-                in_msatoshi_fulfilled_gauge.add_metric(labels, c['in_msatoshi_fulfilled'])
-
-                out_payments_offered_gauge.add_metric(labels, c['out_payments_offered'])
-                out_payments_fulfilled_gauge.add_metric(labels, c['out_payments_fulfilled'])
-                out_msatoshi_offered_gauge.add_metric(labels, c['out_msatoshi_offered'])
-                out_msatoshi_fulfilled_gauge.add_metric(labels, c['out_msatoshi_fulfilled'])
+        channels = self.rpc.listpeerchannels()['channels']
+        for c in channels:
+            # append alias for human readable labels, if no label is found fill with shortid.
+            node = self.rpc.listnodes(c['peer_id'])['nodes']
+            if len(node) != 0 and 'alias' in node[0]:
+                alias = node[0]['alias']
+            else:
+                alias = 'unknown'
+
+            labels = [c['peer_id'], c.get('short_channel_id', c.get('channel_id')), alias]
+            balance_gauge.add_metric(labels, c['to_us_msat'].to_satoshi())
+            spendable_gauge.add_metric(labels,
+                                       c['spendable_msat'].to_satoshi())
+            total_gauge.add_metric(labels, c['total_msat'].to_satoshi())
+            htlc_gauge.add_metric(labels, len(c['htlcs']))
+
+            in_payments_offered_gauge.add_metric(labels, c['in_payments_offered'])
+            in_payments_fulfilled_gauge.add_metric(labels, c['in_payments_fulfilled'])
+            in_msatoshi_offered_gauge.add_metric(labels, int(c['in_offered_msat']))
+            in_msatoshi_fulfilled_gauge.add_metric(labels, int(c['in_fulfilled_msat']))
+
+            out_payments_offered_gauge.add_metric(labels, c['out_payments_offered'])
+            out_payments_fulfilled_gauge.add_metric(labels, c['out_payments_fulfilled'])
+            out_msatoshi_offered_gauge.add_metric(labels, int(c['out_offered_msat']))
+            out_msatoshi_fulfilled_gauge.add_metric(labels, int(c['out_fulfilled_msat']))
 
         return [
             htlc_gauge,

diff --git a/prometheus/requirements.txt → archived/prometheus/requirements.txt b/prometheus/requirements.txt → archived/prometheus/requirements.txt
diff --git a/archived/prometheus/test_prometheus.py b/archived/prometheus/test_prometheus.py
@@ -0,0 +1,40 @@
+import os
+from pyln.testing.fixtures import *  # noqa: F401,F403
+import urllib
+from ephemeral_port_reserve import reserve
+
+plugin_path = os.path.join(os.path.dirname(__file__), "prometheus.py")
+
+
+def test_prometheus_starts(node_factory):
+    l1 = node_factory.get_node()
+    # Test dynamically
+    l1.rpc.plugin_start(plugin_path)
+    l1.rpc.plugin_stop(plugin_path)
+    l1.rpc.plugin_start(plugin_path)
+    l1.stop()
+    # Then statically
+    l1.daemon.opts["plugin"] = plugin_path
+    l1.start()
+
+
+def test_prometheus_scrape(node_factory):
+    """Test that we can scrape correctly.
+    """
+    l1 = node_factory.get_node(options={'plugin': plugin_path})
+    scrape = urllib.request.urlopen("http://localhost:9750")
+
+
+
+def test_prometheus_channels(node_factory):
+    port = reserve()
+    l1, l2, l3 = node_factory.line_graph(
+        3,
+        opts=[
+            {},
+            {'plugin': plugin_path, 'prometheus-listen': f'127.0.0.1:{port}'},
+            {}
+        ]
+    )
+    scrape = urllib.request.urlopen(f'http://localhost:{port}')
+    print(scrape)
diff --git a/rebalance/README.md → archived/rebalance/README.md b/rebalance/README.md → archived/rebalance/README.md
diff --git a/rebalance/clnutils.py → archived/rebalance/clnutils.py b/rebalance/clnutils.py → archived/rebalance/clnutils.py
diff --git a/rebalance/rebalance.py → archived/rebalance/rebalance.py b/rebalance/rebalance.py → archived/rebalance/rebalance.py
@@ -910,7 +910,7 @@ def get_avg_forward_fees(intervals):
 
 
 @plugin.method("rebalancereport")
-def rebalancereport(plugin: Plugin):
+def rebalancereport(plugin: Plugin, include_avg_fees: bool = True):
     """Show information about rebalance
     """
     res = {}
@@ -961,10 +961,11 @@ def rebalancereport(plugin: Plugin):
     else:
         res["average_rebalance_fee_ppm"] = 0
 
-    avg_forward_fees = get_avg_forward_fees([1, 7, 30])
-    res['average_forward_fee_ppm_1d'] = avg_forward_fees[0]
-    res['average_forward_fee_ppm_7d'] = avg_forward_fees[1]
-    res['average_forward_fee_ppm_30d'] = avg_forward_fees[2]
+    if include_avg_fees:
+        avg_forward_fees = get_avg_forward_fees([1, 7, 30])
+        res['average_forward_fee_ppm_1d'] = avg_forward_fees[0]
+        res['average_forward_fee_ppm_7d'] = avg_forward_fees[1]
+        res['average_forward_fee_ppm_30d'] = avg_forward_fees[2]
 
     return res
 

diff --git a/rebalance/requirements.txt → archived/rebalance/requirements.txt b/rebalance/requirements.txt → archived/rebalance/requirements.txt
diff --git a/rebalance/test_rebalance.py → archived/rebalance/test_rebalance.py b/rebalance/test_rebalance.py → archived/rebalance/test_rebalance.py
diff --git a/summary/README.md → archived/summary/README.md b/summary/README.md → archived/summary/README.md
diff --git a/summary/__init__.py → archived/summary/__init__.py b/summary/__init__.py → archived/summary/__init__.py
diff --git a/summary/requirements.txt → archived/summary/requirements.txt b/summary/requirements.txt → archived/summary/requirements.txt
diff --git a/summary/summary.py → archived/summary/summary.py b/summary/summary.py → archived/summary/summary.py
diff --git a/summary/summary_avail.py → archived/summary/summary_avail.py b/summary/summary_avail.py → archived/summary/summary_avail.py
diff --git a/summary/test_summary.py → archived/summary/test_summary.py b/summary/test_summary.py → archived/summary/test_summary.py
diff --git a/clearnet/README.md b/clearnet/README.md
@@ -0,0 +1,10 @@
+# clearnet enforcer plugin
+This plugin aims to prefer usage over clearnet connections.
+It does so by disconnecing TOR connections when there are known and usable
+clearnet addresses.
+
+# Options
+
+# Methods
+## clearnet-enforce [peer_id]
+Tries to enforce clearnet on all peer or on a given peer_id
diff --git a/clearnet/clearnet.py b/clearnet/clearnet.py
@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+import socket
+from contextlib import closing
+from pyln.client import Plugin, RpcError
+
+plugin = Plugin()
+
+
+def get_address_type(addrstr: str):
+    """ I know this can be more sophisticated, but works """
+    if ".onion:" in addrstr:
+        return 'tor'
+    if addrstr[0].isdigit():
+        return 'ipv4'
+    if addrstr.startswith("["):
+        return 'ipv6'
+    return 'dns'
+
+
+# taken from:
+# https://stackoverflow.com/questions/19196105/how-to-check-if-a-network-port-is-open
+def check_socket(host: str, port: int, timeout: float = None):
+    """ Checks if a socket can be opened to a host """
+    if host.count('.') == 3:
+        proto = socket.AF_INET
+    if host.count(':') > 1:
+        proto = socket.AF_INET6
+    with closing(socket.socket(proto, socket.SOCK_STREAM)) as sock:
+        if timeout is not None:
+            sock.settimeout(timeout)  # seconds (float)
+        if sock.connect_ex((host, port)) == 0:
+            return True
+        else:
+            return False
+
+
+def clearnet_pid(peer: dict, messages: list):
+    peer_id = peer['id']
+    if not peer['connected']:
+        messages += [f"Peer is not conencted: {peer_id}"]
+        return False
+    if get_address_type(peer['netaddr'][0]) != 'tor':
+        messages += [f"Already connected via clearnet: {peer_id}"]
+        return True
+
+    # lets check what gossip knows about this peer
+    nodes = plugin.rpc.listnodes(peer_id)['nodes']
+    if len(nodes) == 0:
+        messages += [f"Error: No gossip for: {peer_id}"]
+        return
+    addrs = [a for a in nodes[0]['addresses'] if not a['type'].startswith("tor")]
+    if len(addrs) == 0:
+        messages += [f"Error: No clearnet addresses known for: {peer_id}"]
+        return
+
+    # now check addrs for open ports
+    for addr in addrs:
+        if addr['type'] == 'dns':
+            messages += [f"TODO: DNS lookups for: {addr['address']}"]
+            continue
+        if check_socket(addr['address'], addr['port'], 2.0):
+            # disconnect
+            result = plugin.rpc.disconnect(peer_id, True)
+            if len(result) != 0:
+                messages += [f"Error: Can't disconnect: {peer_id} {result}"]
+                continue
+
+            # try clearnet connection
+            try:
+                result = plugin.rpc.connect(peer_id, addr['address'], addr['port'])
+                newtype = result['address']['type']
+                if not newtype.startswith('tor'):
+                    messages += [f"Established clearnet connection for: {peer_id} with {newtype}"]
+                    return True
+            except RpcError:  # we got an connection error, try reconnect
+                messages += [f"Error: Connection failed for: {peer_id} with {addr['type']}"]
+                try:
+                    result = plugin.rpc.connect(peer_id)  # without address
+                    newtype = result['address']['type']
+                    if not newtype.startswith('tor'):
+                        messages += [f"Established clearnet connection for: {peer_id} with {newtype}"]
+                        return True
+                except RpcError:  # we got a reconnection error
+                    messages += [f"Error: Reconnection failed for: {peer_id}"]
+                    continue
+                messages += [f"Reconnected: {peer_id} with {newtype}"]
+                continue
+    return False
+
+
+@plugin.method("clearnet")
+def clearnet(plugin: Plugin, peer_id: str = None):
+    """ Enforce a clearnet connection on all peers or a given `peer_id`."""
+    if peer_id is None:
+        peers = plugin.rpc.listpeers(peer_id)['peers']
+    else:
+        if not isinstance(peer_id, str) or len(peer_id) != 66:
+            return f"Error: Invalid peer_id: {peer_id}"
+        peers = plugin.rpc.listpeers(peer_id)['peers']
+        if len(peers) == 0:
+            return f"Error: peer not found: {peer_id}"
+
+    messages = []
+    for peer in peers:
+        clearnet_pid(peer, messages)
+    return messages
+
+
+@plugin.init()
+def init(options: dict, configuration: dict, plugin: Plugin, **kwargs):
+    plugin.log(f"clearnet enforcer plugin initialized")
+
+
+plugin.run()
diff --git a/clearnet/requirements.txt b/clearnet/requirements.txt
@@ -0,0 +1 @@
+pyln-client>=0.12