splice: add zero-conf splice support per BOLT #2

.codespellignore

@@ -0,0 +1,3 @@
+connectd
+crate
+mut

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+
+count = true
+ignore-words = .codespellignore

.gitattributes

@@ -17,4 +17,4 @@ statements_gettextgen.po linguist-generated=true
 cln-grpc/proto/node.proto -text -diff linguist-generated=true
 cln-grpc/src/convert.rs -text -diff linguist-generated=true
 cln-rpc/src/model.rs -text -diff linguist-generated=true
-contrib/pyln-testing/pyln/testing/node_pb2.py -text -diff linguist-generated=true
+contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py -text -diff linguist-generated=true

.github/scripts/install-bitcoind.sh

@@ -1,4 +1,6 @@
 #!/bin/sh
+# If an argument is specified, that dir is checked before downloading,
+# and updated after successful install.
 
 set -e
 
@@ -18,13 +20,23 @@ cd /tmp/
 # testing against `bitcoind` but still believe that we ran against
 # `elementsd`.
 if [ "$TEST_NETWORK" = "liquid-regtest" ]; then
-    wget "https://github.com/ElementsProject/elements/releases/download/elements-${ELEMENTS_VERSION}/${EFILENAME}"
+    if [ -f "$1/${EFILENAME}" ]; then
+	cp "$1/${EFILENAME}" .
+    else
+	wget "https://github.com/ElementsProject/elements/releases/download/elements-${ELEMENTS_VERSION}/${EFILENAME}"
+    fi
     tar -xf "${EFILENAME}"
+    [ "$1" = "" ] || cp "${EFILENAME}" "$1"/
     sudo mv "${EDIRNAME}"/bin/* "/usr/local/bin"
     rm -rf "${EFILENAME}" "${EDIRNAME}"
 else
-    wget "https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/${FILENAME}"
+    if [ -f "$1/${FILENAME}" ]; then
+	cp "$1/${FILENAME}" .
+    else
+	wget "https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/${FILENAME}"
+    fi
     tar -xf "${FILENAME}"
+    [ "$1" = "" ] || cp "${FILENAME}" "$1"/
     sudo mv "${DIRNAME}"/bin/* "/usr/local/bin"
     rm -rf "${FILENAME}" "${DIRNAME}"
 fi

.github/scripts/setup.sh

@@ -3,18 +3,26 @@ set -e
 export DEBIAN_FRONTEND=noninteractive
 export RUST_VERSION=stable
 
-sudo useradd -ms /bin/bash tester
-sudo apt-get update -qq
+sudo mkdir -p /var/cache/apt/archives
+mkdir -p ~/ci-cache/apt/
+sudo cp -a ~/ci-cache/apt/. /var/cache/apt/archives/ 2>/dev/null || true
 
-sudo apt-get -qq install --no-install-recommends --allow-unauthenticated -yy \
+sudo apt-get update
+
+# Install eatmydata, then use it for the rest.
+sudo apt-get install --no-install-recommends --allow-unauthenticated -yy \
+     -o APT::Keep-Downloaded-Packages=true \
+     eatmydata
+
+sudo eatmydata apt-get install --no-install-recommends --allow-unauthenticated -yy \
+    -o APT::Keep-Downloaded-Packages=true \
      autoconf \
      automake \
      binfmt-support \
      build-essential \
      clang \
      cppcheck \
      docbook-xml \
-     eatmydata \
      gcc-aarch64-linux-gnu \
      gcc-arm-linux-gnueabihf \
      gcc-arm-none-eabi \
@@ -52,17 +60,19 @@ sudo apt-get -qq install --no-install-recommends --allow-unauthenticated -yy \
      sudo \
      tcl \
      tclsh \
+     tshark \
      unzip \
      valgrind \
      wget \
+     wireshark-common \
      xsltproc \
      systemtap-sdt-dev \
      zlib1g-dev
 
 echo "tester ALL=(root) NOPASSWD:ALL" | sudo tee /etc/sudoers.d/tester
 sudo chmod 0440 /etc/sudoers.d/tester
 
-"$(dirname "$0")"/install-bitcoind.sh
+"$(dirname "$0")"/install-bitcoind.sh ~/ci-cache/
 
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- \
      -y --default-toolchain ${RUST_VERSION}
@@ -90,10 +100,29 @@ uv tool install poetry
 
 PROTOC_VERSION=29.4
 PB_REL="https://github.com/protocolbuffers/protobuf/releases"
-curl -LO $PB_REL/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-x86_64.zip
-sudo unzip protoc-${PROTOC_VERSION}-linux-x86_64.zip -d /usr/local/
+PROTOC_ZIP=protoc-${PROTOC_VERSION}-linux-x86_64.zip
+if [ ! -f ~/ci-cache/$PROTOC_ZIP ]; then
+    curl -LO $PB_REL/download/v${PROTOC_VERSION}/$PROTOC_ZIP
+    # Check it before we commit it to the cache!
+    unzip -t $PROTOC_ZIP
+    cp $PROTOC_ZIP ~/ci-cache/
+fi
+sudo unzip ~/ci-cache/$PROTOC_ZIP -d /usr/local/
 sudo chmod a+x /usr/local/bin/protoc
 export PROTOC=/usr/local/bin/protoc
 export PATH=$PATH:/usr/local/bin
 env
 ls -lha /usr/local/bin
+
+# wireshark-common normally does this, but GH runners are special, so we
+# do it explicitly
+sudo groupadd -f wireshark
+sudo chgrp wireshark /usr/bin/dumpcap
+sudo chmod 750 /usr/bin/dumpcap
+sudo setcap cap_net_raw,cap_net_admin=eip /usr/bin/dumpcap
+
+# Add ourselves to the wireshark group (still need "sg wireshark..." for it to take effect)
+sudo usermod -aG wireshark "$(id -nu)"
+
+# Copy archives back for caching
+cp /var/cache/apt/archives/*.deb ~/ci-cache/apt/ || true

.github/scripts/sync-rpc-cmds.py

@@ -1,13 +1,12 @@
 import os
-from urllib.parse import quote
 from time import sleep
 import requests
 import re
 from enum import Enum
 
 # readme url
 URL = "https://api.readme.com/v2/branches/stable"
-CATEGORY_SLUG = "JSON-RPC API Reference"
+CATEGORY_SLUG = "JSON-RPC"
 
 
 class Action(Enum):
@@ -17,10 +16,12 @@ class Action(Enum):
 
 
 def getListOfRPCDocs(headers):
-    response = requests.get(f"{URL}/categories/reference/{quote(CATEGORY_SLUG)}/pages", headers=headers)
+    response = requests.get(f"{URL}/categories/reference/{CATEGORY_SLUG}/pages", headers=headers)
     if response.status_code == 200:
         return response.json().get('data', [])
     else:
+        print(f"❌ Failed to get pages: {response.status_code}")
+        print(response.text)
         return []
 
 
@@ -34,7 +35,7 @@ def check_renderable(response, action, title):
 
     renderable = data.get("renderable")
     if renderable is None:
-        # Some endpoints don’t include renderable (e.g. DELETE)
+        # Some endpoints don't include renderable (e.g. DELETE)
         return True
 
     if not renderable.get("status", False):
@@ -46,53 +47,53 @@ def check_renderable(response, action, title):
     return True
 
 
-def publishDoc(action, title, body, order, headers):
+def publishDoc(action, title, body, position, headers):
     payload = {
         "title": title,
         "type": "basic",
         "content": {
             "body": body,
         },
         "category": {
-            "uri": f"/branches/1/categories/reference/{CATEGORY_SLUG}"
+            "uri": f"/branches/stable/categories/reference/{CATEGORY_SLUG}"
         },
         "hidden": False,
-        "order": order,
+        "position": position,
     }
 
     if action == Action.ADD:
         payload["slug"] = title
         response = requests.post(URL + "/reference", json=payload, headers=headers)
         if response.status_code != 201:
-            print("❌ HTTP ERROR:", response.status_code)
+            print(f"❌ HTTP ERROR ({response.status_code}):", title)
             print(response.text)
             return
 
         if not check_renderable(response, action, title):
             raise RuntimeError(f"Renderable check failed for {title}")
 
-        print("✅ Created", title)
+        print(f"✅ Created '{title}' at position {position + 1}")
 
     elif action == Action.UPDATE:
         response = requests.patch(f"{URL}/reference/{title}", json=payload, headers=headers)
         if response.status_code != 200:
-            print("❌ HTTP ERROR:", response.status_code)
+            print(f"❌ HTTP ERROR ({response.status_code}):", title)
             print(response.text)
             return
 
         if not check_renderable(response, action, title):
             raise RuntimeError(f"Renderable check failed for {title}")
 
-        print("✅ Updated", title)
+        print(f"✅ Updated '{title}' to position {position + 1}")
 
     elif action == Action.DELETE:
         response = requests.delete(f"{URL}/reference/{title}", headers=headers)
 
         if response.status_code != 204:
-            print("❌ DELETE FAILED:", title)
+            print(f"❌ DELETE FAILED ({response.status_code}):", title)
             print(response.text)
         else:
-            print("🗑️ Deleted", title)
+            print(f"🗑️  Deleted '{title}' from position {position + 1}")
 
     else:
         print("Invalid action")
@@ -120,8 +121,18 @@ def main():
         "Authorization": "Bearer " + os.environ.get("README_API_KEY"),
     }
 
+    # Validate API key exists
+    if not os.environ.get("README_API_KEY"):
+        print("❌ ERROR: README_API_KEY environment variable not set")
+        return
+
     # path to the rst file from where we fetch all the RPC commands
     path_to_rst = "doc/index.rst"
+
+    if not os.path.exists(path_to_rst):
+        print(f"❌ ERROR: File not found: {path_to_rst}")
+        return
+
     with open(path_to_rst, "r") as file:
         rst_content = file.read()
 
@@ -130,23 +141,31 @@ def main():
 
     # Compare local and server commands list to get the list of command to add or delete
     commands_local_title = set(command[0] for command in commands_from_local)
-    commands_readme_title = set(command['title'] for command in commands_from_readme)
+    commands_readme_title = set(command['slug'] for command in commands_from_readme)
     commands_to_delete = commands_readme_title - commands_local_title
     commands_to_add = commands_local_title - commands_readme_title
     for name in commands_to_delete:
         publishDoc(Action.DELETE, name, "", 0, headers)
-        sleep(3)
+        sleep(1)
 
     if commands_from_local:
-        order = 0
+        position = 0
         for name, file in commands_from_local:
-            with open("doc/" + file) as f:
+            file_path = "doc/" + file
+            if not os.path.exists(file_path):
+                print(f"⚠️  WARNING: File not found: {file_path}, skipping {name}")
+                continue
+
+            with open(file_path) as f:
                 body = f.read()
-                publishDoc(Action.ADD if name in commands_to_add else Action.UPDATE, name, body, order, headers)
-            order = order + 1
-            sleep(3)
+                action = Action.ADD if name in commands_to_add else Action.UPDATE
+                publishDoc(action, name, body, position, headers)
+            position += 1
+            sleep(1)
     else:
-        print("No commands found in the Manpages block.")
+        print("⚠️  No commands found in the Manpages block.")
+
+    print("\n✨ Sync complete!")
 
 
 if __name__ == "__main__":