Merge commit '4df8cd079490e937f0d7ee8a20d6cd4f95e6b6d9' into blip18_inbound_fees

Author: rorp

.github/workflows/latest-bitcoind.yml

@@ -38,15 +38,15 @@ jobs:
         with:
           path: eclair
 
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v3
         with:
-          java-version: 11
+          java-version: 21
           distribution: 'adopt'
 
       - name: Configure OS settings
         run: echo "fs.file-max = 1024000" | sudo tee -a /etc/sysctl.conf
 
       - name: Run eclair tests
-        run: BITCOIND_DIR=$GITHUB_WORKSPACE/bitcoin/build/src mvn test
+        run: BITCOIND_DIR=$GITHUB_WORKSPACE/bitcoin/build/src ./mvnw test
         working-directory: ./eclair

.github/workflows/main.yml

@@ -13,12 +13,12 @@ jobs:
     timeout-minutes: 30
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
-    - name: Set up JDK 11
-      uses: actions/setup-java@v3
+    - name: Set up JDK 21
+      uses: actions/setup-java@v4
       with:
-        java-version: 11
+        java-version: 21
         distribution: 'adopt'
 
     - name: Cache Maven dependencies
@@ -34,7 +34,7 @@ jobs:
     # NB: we exclude external API tests from the CI, because we don't want our build to fail because a dependency is failing.
     # This means we won't automatically catch changes in external APIs, but developers should regularly run the test suite locally so in practice it shouldn't be a problem.
     - name: Build with Maven
-      run: mvn test-compile && mvn scoverage:report -DtagsToExclude=external-api
+      run: ./mvnw test-compile && ./mvnw scoverage:report -DtagsToExclude=external-api
 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3

.mvn/wrapper/maven-wrapper.jar

@@ -0,0 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+wrapperVersion=3.3.2
+distributionType=script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip
+distributionSha256Sum=4ec3f26fb1a692473aea0235c300bd20f0f9fe741947c82c1234cefd76ac3a3c
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar
+wrapperSha256Sum=3d8f20ce6103913be8b52aef6d994e0c54705fb527324ceb9b835b338739c7a8

.mvn/wrapper/maven-wrapper.properties

@@ -2,73 +2,72 @@
 
 ## Requirements
 
-- [OpenJDK 11](https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot).
-- [Maven](https://maven.apache.org/download.cgi) 3.6.0 or newer
+- [OpenJDK 21](https://adoptium.net/temurin/releases/?package=jdk&version=21).
 
 ## Build
 
 Eclair is packaged as a compressed archive with a launcher script. The archives are built deterministically
 so it's possible to reproduce the build and verify its equality byte-by-byte. To build the exact same artifacts
-that we release, you must use the build environment (OS, JDK, maven...) that we specify in our release notes.
+that we release, you must use the build environment (OS, JDK...) that we specify in our release notes.
 
 To build the project and run the tests, simply run:
 
 ```shell
-mvn package
+./mvnw package
 ```
 
 Notes:
 
 - This command will build all modules (core, node, gui).
-- If the build fails, you may need to clean previously built artifacts with the `mvn clean` command.
+- If the build fails, you may need to clean previously built artifacts with the `./mvnw clean` command.
 - Archives can be found in the `target` folder for each module.
 
 ### Skip tests
 
 Running tests takes time. If you want to skip them, use `-DskipTests`:
 
 ```shell
-mvn package -DskipTests
+./mvnw package -DskipTests
 ```
 
 ### Run tests
 
 To only run the tests, run:
 
 ```shell
-mvn test
+./mvnw test
 ```
 
 To run tests for a specific class, run:
 
 ```shell
-mvn test -Dsuites=*<TestClassName>
+./mvnw test -Dsuites=*<TestClassName>
 ```
 
 To run tests using a specific number of threads, run:
 
 ```shell
-mvn -T <thread_count> test
+./mvnw -T <thread_count> test
 ```
 
 To run tests with a specific version of `bitcoind`, run:
 
 ```shell
-BITCOIND_DIR=<absolute/path/to/directory> mvn test
+BITCOIND_DIR=<absolute/path/to/directory> ./mvnw test
 ```
 
 ### Build specific module
 
 To only build the `eclair-node` module, run:
 
 ```shell
-mvn package -pl eclair-node -am -Dmaven.test.skip=true
+./mvnw package -pl eclair-node -am -Dmaven.test.skip=true
 ```
 
 To install `eclair-core` into your local maven repository and use it in another project, run:
 
 ```shell
-mvn clean install -pl eclair-core -am -Dmaven.test.skip=true
+./mvnw clean install -pl eclair-core -am -Dmaven.test.skip=true
 ```
 
 ## Build the API documentation
@@ -84,3 +83,17 @@ The API doc is generated via slate and hosted on github pages. To make a change
 5. Push your commit to remote.
 6. Run `./deploy.sh`
 7. Wait a few minutes and the doc should be updated at [https://acinq.github.io/eclair](https://acinq.github.io/eclair)
+
+## Updating Eclair dependencies checksums
+
+Eclair dependencies (including maven plugins and their dependencies) are verified against a list of trusted checksums (located in `.mvn/checksums/checksums-central.sha256`).
+Please note that dependencies are verified only if they are actually used in the build phase that is running, so you may be able to modify the checksum of a dependency 
+and still run a successful build phase that does not use them (for example you can modify the checksum of a `maven-deploy-plugin` dependency and still run `./mvnw test` successfully).
+To make local development and testing easier, SNAPSHOT dependencies are not verified.
+
+To re-create the trusted checksums file, run:
+
+```shell
+$ rm ~/.m2/wrapper ~/.sbt -rf
+$ ./mvnw clean install scoverage:report -DskipTests -Daether.artifactResolver.postProcessor.trustedChecksums.record
+```

BUILD.md

@@ -1,52 +1,33 @@
-FROM adoptopenjdk/openjdk11:jdk-11.0.3_7-alpine as BUILD
-
-# Setup maven, we don't use https://hub.docker.com/_/maven/ as it declare .m2 as volume, we loose all mvn cache
-# We can alternatively do as proposed by https://github.com/carlossg/docker-maven#packaging-a-local-repository-with-the-image
-# this was meant to make the image smaller, but we use multi-stage build so we don't care
-RUN apk add --no-cache curl tar bash
-
-ARG MAVEN_VERSION=3.9.2
-ARG USER_HOME_DIR="/root"
-ARG SHA=900bdeeeae550d2d2b3920fe0e00e41b0069f32c019d566465015bdd1b3866395cbe016e22d95d25d51d3a5e614af2c83ec9b282d73309f644859bbad08b63db
-ARG BASE_URL=https://archive.apache.org/dist/maven/maven-3/${MAVEN_VERSION}/binaries
-
-RUN mkdir -p /usr/share/maven /usr/share/maven/ref \
-  && curl -fsSL -o /tmp/apache-maven.tar.gz ${BASE_URL}/apache-maven-${MAVEN_VERSION}-bin.tar.gz \
-  && echo "${SHA}  /tmp/apache-maven.tar.gz" | sha512sum -c - \
-  && tar -xzf /tmp/apache-maven.tar.gz -C /usr/share/maven --strip-components=1 \
-  && rm -f /tmp/apache-maven.tar.gz \
-  && ln -s /usr/share/maven/bin/mvn /usr/bin/mvn
-
-ENV MAVEN_HOME /usr/share/maven
-ENV MAVEN_CONFIG "$USER_HOME_DIR/.m2"
+FROM eclipse-temurin:21-jdk-alpine as BUILD
 
 # Let's fetch eclair dependencies, so that Docker can cache them
 # This way we won't have to fetch dependencies again if only the source code changes
 # The easiest way to reliably get dependencies is to build the project with no sources
 WORKDIR /usr/src
+COPY mvnw mvnw
+COPY .mvn .mvn
 COPY pom.xml pom.xml
 COPY eclair-core/pom.xml eclair-core/pom.xml
 COPY eclair-front/pom.xml eclair-front/pom.xml
 COPY eclair-node/pom.xml eclair-node/pom.xml
 COPY eclair-node/modules/assembly.xml eclair-node/modules/assembly.xml
 RUN mkdir -p eclair-core/src/main/scala && touch eclair-core/src/main/scala/empty.scala
 # Blank build. We only care about eclair-node, and we use install because eclair-node depends on eclair-core
-RUN mvn install -pl eclair-node -am
-RUN mvn clean
+RUN ./mvnw install -pl eclair-node -am
+RUN ./mvnw clean
 
 # Only then do we copy the sources
 COPY . .
 
 # And this time we can build in offline mode, specifying 'notag' instead of git commit
-RUN mvn package -pl eclair-node -am -DskipTests -Dgit.commit.id=notag -Dgit.commit.id.abbrev=notag -o
+RUN ./mvnw package -pl eclair-node -am -DskipTests -Dgit.commit.id=notag -Dgit.commit.id.abbrev=notag -o
 # It might be good idea to run the tests here, so that the docker build fail if the code is bugged
 
-# We currently use a debian image for runtime because of some jni-related issue with sqlite
-FROM openjdk:11.0.4-jre-slim
+FROM eclipse-temurin:21-jre-alpine
 WORKDIR /app
 
 # install jq for eclair-cli
-RUN apt-get update && apt-get install -y bash jq curl unzip
+RUN apk add bash jq curl unzip
 
 # copy and install eclair-cli executable
 COPY --from=BUILD /usr/src/eclair-core/eclair-cli .

Dockerfile

@@ -62,7 +62,7 @@ This means that instead of re-implementing them, Eclair benefits from the verifi
 
 * Eclair needs a _synchronized_, _segwit-ready_, **_zeromq-enabled_**, _wallet-enabled_, _non-pruning_, _tx-indexing_ [Bitcoin Core](https://github.com/bitcoin/bitcoin) node.
 * You must configure your Bitcoin node to use `bech32` or `bech32m` (segwit) addresses. If your wallet has "non-segwit UTXOs" (outputs that are neither `p2sh-segwit`, `bech32` or `bech32m`), you must send them to a `bech32` or `bech32m` address before running Eclair.
-* Eclair requires Bitcoin Core 27.2 or higher. If you are upgrading an existing wallet, you may need to create a new address and send all your funds to that address.
+* Eclair requires Bitcoin Core 28.1 or higher. If you are upgrading an existing wallet, you may need to create a new address and send all your funds to that address.
 
 Run bitcoind with the following minimal `bitcoin.conf`:
 
@@ -94,7 +94,7 @@ rpcclienttimeout=30
 
 Eclair is developed in [Scala](https://www.scala-lang.org/), a powerful functional language that runs on the JVM, and is packaged as a ZIP archive.
 
-To run Eclair, you first need to install Java, we recommend that you use [OpenJDK 11](https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot). Other runtimes also work, but we don't recommend using them.
+To run Eclair, you first need to install Java. Eclair targets Java 21 and will run on any compatible Java runtime, we recommend that you use [OpenJDK 21](https://adoptium.net/temurin/releases/?package=jdk&version=21).
 
 Then download our latest [release](https://github.com/ACINQ/eclair/releases), unzip the archive and run the following command:
 
@@ -321,10 +321,8 @@ zmqpubrawtx=tcp://127.0.0.1:29001
 ## Tools
 
 * [Demo Shop](https://starblocks.acinq.co/) - an example testnet Lightning web shop.
-* [Network Explorer](https://explorer.acinq.co/) - a Lightning network visualization tool.
 
 ## Resources
 
 * [1] [The Bitcoin Lightning Network: Scalable Off-Chain Instant Payments](https://lightning.network/lightning-network-paper.pdf) by Joseph Poon and Thaddeus Dryja
 * [2] [Reaching The Ground With Lightning](https://github.com/ElementsProject/lightning/raw/master/doc/deployable-lightning.pdf) by Rusty Russell
-* [3] [Lightning Network Explorer](https://explorer.acinq.co) - Explore testnet LN nodes you can connect to

README.md

@@ -146,7 +146,7 @@ $ git clone git@github.com:ACINQ/eclair.git
 $ vi eclair-core/src/main/reference.conf # set akka.remote.artery.transport = "tls-tcp"
 $ cp akka-cluster-tls.jks eclair-front/modules/awseb/ # copy the file you generated
 $ vi eclair-front/modules/awseb.xml # uncomment the relevant parts
-$ mvn package -DskipTests
+$ ./mvnw package -DskipTests
 ```
 Alternatively, you can also edit the existing bundle and manually add the `akka-cluster-tls.jks` file to the root of the zip archive. You will also need to set `akka.remote.artery.transport=tls-tcp` at runtime. 
 

contrib/arm64v8.Dockerfile

@@ -7,7 +7,6 @@ This section contains how-to guides for more advanced scenarios:
 * [Manage Bitcoin Core's private keys](./ManagingBitcoinCoreKeys.md)
 * [Use Tor with Eclair](./Tor.md)
 * [Multipart Payments](./MultipartPayments.md)
-* [Trampoline Payments](./TrampolinePayments.md)
 * [Monitoring Eclair](./Monitoring.md)
 * [PostgreSQL Configuration](./PostgreSQL.md)
 * [Perform Circular Rebalancing](./CircularRebalancing.md)