Commit(s) pushed to ElementsProject/lightning

.clang-format

@@ -0,0 +1,6 @@
+BasedOnStyle: LLVM
+IndentWidth: 8
+UseTab: Always
+BreakBeforeBraces: Linux
+AllowShortIfStatementsOnASingleLine: false
+IndentCaseLabels: false

.dir-locals.el

@@ -0,0 +1,7 @@
+((c-mode . ((c-file-style . "linux")
+            (indent-tabs-mode . t)
+            (show-trailing-whitespace . t)
+            (c-basic-offset . 8)
+            (tab-width . 8)
+            ))
+)

.dockerignore

@@ -0,0 +1,3 @@
+Dockerfile
+contrib/docker/Dockerfile.*
+target

.editorconfig

@@ -0,0 +1,18 @@
+# https://editorconfig.org/#file-format-details
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{**.c,**.h,Makefile}]
+indent_style = tab
+indent_size = 8
+
+[**.py]
+indent_style = space
+indent_size = 4
+

.gitattributes

@@ -0,0 +1,20 @@
+# Declare files that will always have CRLF line endings on checkout.
+*.sh text eol=lf
+*.py text eol=lf
+Makefile text eol=lf
+configure text eol=lf
+.gitmodules text eol=lf
+# The following files are generated and should not be shown in the
+# diffs by default on Github.
+doc/lightning*.7 linguist-generated=true
+db_*_sqlgen.c linguist-generated=true
+statements_gettextgen.po linguist-generated=true
+*_wiregen.? linguist-generated=true
+*_printgen.? linguist-generated=true
+
+# The following are marked as binary and generated since they can be
+# easily overwritten and don't need deep review.
+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

.github/CODEOWNERS

@@ -0,0 +1,19 @@
+# Code owners are automatically requested for review when someone
+# opens a pull request that modifies code that they own. When someone
+# with admin or owner permissions has enabled required reviews, they
+# also can optionally require approval from a code owner before the
+# author can merge a pull request in the repository.
+
+cln-grpc/               @cdecker
+cln-rpc/                @cdecker
+plugins/src/            @cdecker
+plugins/grpc-plugin/    @cdecker
+contrib/reprobuild/     @cdecker
+contrib/msggen/         @cdecker
+contrib/pyln-client/    @cdecker
+contrib/pyln-testing/   @cdecker
+# Needed to ensure hsmd wire compatibility between releases
+hsmd/hsmd_wire.csv      @cdecker @ksedgwic @devrandom
+
+# See https://help.github.com/articles/about-codeowners/ for more
+# information

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,4 @@
+### Issue and Steps to Reproduce
+<!-- Describe your issue and tell us how to reproduce it (include any useful information). -->
+
+### `getinfo` output

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+> [!IMPORTANT]
+>
+> 25.09 FREEZE July 28TH: Non-bugfix PRs not ready by this date will wait for 25.12.
+>
+> RC1 is scheduled on _August 11th_
+>
+> The final release is scheduled for September 1st.
+
+
+## Checklist
+Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked:
+
+- [ ] The changelog has been updated in the relevant commit(s) according to the [guidelines](https://docs.corelightning.org/docs/coding-style-guidelines#changelog-entries-in-commit-messages).
+- [ ] Tests have been added or modified to reflect the changes.
+- [ ] Documentation has been reviewed and updated as needed.
+- [ ] Related issues have been listed and linked, including any that this PR closes.

.github/scripts/install-bitcoind.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+set -e
+
+export BITCOIN_VERSION=27.1
+export ELEMENTS_VERSION=23.2.1
+
+DIRNAME="bitcoin-${BITCOIN_VERSION}"
+EDIRNAME="elements-${ELEMENTS_VERSION}"
+FILENAME="${DIRNAME}-x86_64-linux-gnu.tar.gz"
+EFILENAME="${EDIRNAME}-x86_64-linux-gnu.tar.gz"
+
+cd /tmp/
+
+# Since we inadvertently broke `elementsd` support in the past we only
+# want to download and enable the daemon that is actually going to be
+# used when running in CI. Otherwise we could end up accidentally
+# 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}"
+    tar -xf "${EFILENAME}"
+    sudo mv "${EDIRNAME}"/bin/* "/usr/local/bin"
+    rm -rf "${EFILENAME}" "${EDIRNAME}"
+else
+    wget "https://bitcoincore.org/bin/bitcoin-core-${BITCOIN_VERSION}/${FILENAME}"
+    tar -xf "${FILENAME}"
+    sudo mv "${DIRNAME}"/bin/* "/usr/local/bin"
+    rm -rf "${FILENAME}" "${DIRNAME}"
+fi
+

.github/scripts/setup.sh

@@ -0,0 +1,97 @@
+#!/bin/bash
+set -e
+export DEBIAN_FRONTEND=noninteractive
+export RUST_VERSION=stable
+
+sudo useradd -ms /bin/bash tester
+sudo apt-get update -qq
+
+sudo apt-get -qq install --no-install-recommends --allow-unauthenticated -yy \
+     autoconf \
+     automake \
+     binfmt-support \
+     build-essential \
+     clang \
+     cppcheck \
+     docbook-xml \
+     eatmydata \
+     gcc-aarch64-linux-gnu \
+     gcc-arm-linux-gnueabihf \
+     gcc-arm-none-eabi \
+     gettext \
+     git \
+     gnupg \
+     jq \
+     libc6-dev-arm64-cross \
+     libc6-dev-armhf-cross \
+     libev-dev \
+     libevent-dev \
+     libffi-dev \
+     libicu-dev \
+     libpq-dev \
+     libprotobuf-c-dev \
+     libsqlite3-dev \
+     libssl-dev \
+     libtool \
+     libxml2-utils \
+     locales \
+     net-tools \
+     postgresql \
+     python-pkg-resources \
+     python3 \
+     python3-dev \
+     python3-pip \
+     python3-setuptools \
+     qemu \
+     qemu-system-arm \
+     qemu-user-static \
+     shellcheck \
+     software-properties-common \
+     sudo \
+     tcl \
+     tclsh \
+     unzip \
+     valgrind \
+     wget \
+     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
+
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- \
+     -y --default-toolchain ${RUST_VERSION}
+
+uv sync --all-extras --all-groups
+# required for reckless till poetry to uv migration
+uv tool install poetry
+
+# We also need a relatively recent protobuf-compiler, at least 3.12.0,
+# in order to support the experimental `optional` flag.
+
+# BUT WAIT!  Gentoo wants this to match the version from the Python protobuf,
+# which comes from the same tree.  Makes sense!
+
+# And
+#   grpcio-tools-1.69.0` requires `protobuf = ">=5.26.1,<6.0dev"`
+
+# Now, protoc changed to date-based releases, BUT Python protobuf
+# didn't, so Python protobuf 4.21.12 (in Ubuntu 23.04) corresponds to
+# protoc 21.12 (which, FYI, is packaged in Ubuntu as version 3.21.12).
+
+# In general protobuf version x.y.z corresponds to protoc version y.z
+
+# Honorable mention go to Matt Whitlock for spelunking this horror with me!
+
+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/
+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

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

@@ -0,0 +1,115 @@
+import os
+from time import sleep
+import requests
+import re
+from enum import Enum
+
+# readme url
+URL = "https://dash.readme.com/api/v1"
+# category id for API reference
+CATEGORY_ID = "685ce4df1df887006ff221c5"
+CATEGORY_SLUG = "json-rpc-apis"
+
+
+class Action(Enum):
+    ADD = 'add'
+    UPDATE = 'update'
+    DELETE = 'delete'
+
+
+def getListOfRPCDocs(headers):
+    response = requests.get(f"{URL}/categories/{CATEGORY_SLUG}/docs", headers=headers)
+    if response.status_code == 200:
+        return response.json()
+    else:
+        return []
+
+
+def publishDoc(action, title, body, order, headers):
+    payload = {
+        "title": title,
+        "type": "basic",
+        "body": body,
+        "category": CATEGORY_ID,
+        "hidden": False,
+        "order": order,
+    }
+    # title == slug
+    if action == Action.ADD:
+        # create doc
+        response = requests.post(URL + "/docs", json=payload, headers=headers)
+        if response.status_code != 201:
+            print(response.text)
+        else:
+            print("Created ", title)
+    elif action == Action.UPDATE:
+        # update doc
+        response = requests.put(f"{URL}/docs/{title}", json=payload, headers=headers)
+        if response.status_code != 200:
+            print(response.text)
+        else:
+            print("Updated ", title)
+    elif action == Action.DELETE:
+        # delete doc
+        response = requests.delete(f"{URL}/docs/{title}", headers=headers)
+        if response.status_code != 204:
+            print(response.text)
+        else:
+            print("Deleted ", title)
+    else:
+        print("Invalid action")
+
+
+def extract_rpc_commands(rst_content):
+    manpages_block = re.search(
+        r"\.\. block_start manpages(.*?)" r"\.\. block_end manpages",
+        rst_content,
+        re.DOTALL,
+    )
+    if manpages_block:
+        commands = re.findall(
+            r"\b([a-zA-Z0-9_-]+)" r"\s+<([^>]+)>\n", manpages_block.group(1)
+        )
+        return commands
+    return []
+
+
+def main():
+    # define headers for requests
+    headers = {
+        "accept": "application/json",
+        "content-type": "application/json",
+        "authorization": "Basic " + os.environ.get("README_API_KEY"),
+    }
+
+    # path to the rst file from where we fetch all the RPC commands
+    path_to_rst = "doc/index.rst"
+    with open(path_to_rst, "r") as file:
+        rst_content = file.read()
+
+    commands_from_local = extract_rpc_commands(rst_content)
+    commands_from_readme = getListOfRPCDocs(headers)
+
+    # 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_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)
+
+    if commands_from_local:
+        order = 0
+        for name, file in commands_from_local:
+            with open("doc/" + file) 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)
+    else:
+        print("No commands found in the Manpages block.")
+
+
+if __name__ == "__main__":
+    main()