Add eclair node into stack

Author: MrHash

.env

@@ -33,5 +33,9 @@ LIGHTNINGDDAVE_PORT=19765
 LIGHTNINGDEMMA_HOST=lightningdemma
 LIGHTNINGDEMMA_PORT=19775
 
+ECLAIRDFRANK_HOST=eclairdfrank
+ECLAIRDFRANK_PORT=19785
+ECLAIRDFRANK_API_PORT=8100
+
 COMPOSE_FILE=docker-compose.yml
 COMPOSE_PROJECT_NAME=bitcoindevstack

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2019-09-28
+ - Add headless `eclair` implementation on Bitcoin as `eclairdfrank`
+
 ## 2019-09-11
  - Add `lightningd-elements` WIP image build & two c-lightning nodes on Elements
  - Modify Ubuntu base versions in Docker images

README.md

@@ -8,8 +8,13 @@
 L+:  |                      YOUR APPLICATION STACK                        |
      +---------------------------------+-------+--------------------------+
                                        |       |
-                                       /       |
-     +-----------+  +---------+  +-----------+ | +----------+  +----------+
+                    +---------+        |       |
+                    |         |        |       |
+                    |  FRANK  |        |       |
+                    |         |        |       |
+                    +----+----+        |       |
+                         |             /       |
+     +-----------+  +----+----+  +-----------+ | +----------+  +----------+
      |           |  |         |  |           | | |          |  |          |
 L2:  |   ALICE   +--+   BOB   +--+   CAROL   | | |   DAVE   +--+   EMMA   |
      |           |  |         |  |           | | |          |  |          |
@@ -25,19 +30,20 @@ L1:            |     BITCOIND     |            /    |     ELEMENTSD    |
                +------------------+                 +------------------+
 ```
 
-This `docker-compose` template launches `bitcoind`, two `lnd` containers named `lndalice` & `lndbob`, with a `lightningd` container as `lightningdcarol`.
+This `docker-compose` template launches `bitcoind`, two `lnd` containers named `lndalice` & `lndbob`, with a `lightningd` container as `lightningdcarol`, and an `eclair` container as `eclairdfrank`.
 
 Additionally it will launch an `elementsd` side chain (aka Liquid), with prototype `lightningd-elements` implementation containers as `lightningddave` & `lightningdemma`.
 
 Everything is configured to run in **regtest** mode but can be adjusted as required.
 
+## See the [changelog](CHANGELOG.md) before upgrading.
+
 ### Notes & prerequisites
  - `docker` and `docker-compose` installation is required (https://docs.docker.com/install/).
  - `jq` tool is used in examples for parsing json responses.
  - All nodes will sync to chain after the first Bitcoin & Elements regtest blocks are generated.
  - All daemons are compiled from source but it is not recommended to use them in production environments.
  - Ports and other daemon configuration can be changed in the `.env` and `docker-compose.yml` files.
- - See the [changelog](CHANGELOG.md) when upgrading.
 
 ### Coming soon
  - Elements token creation and transaction scripts
@@ -52,6 +58,7 @@ It may take up to 30 minutes to launch the stack if container images are not alr
 $ docker-compose up -d bitcoind
 $ bin/b-cli generate 101
 $ docker-compose up -d lndalice lndbob
+$ docker-compose up -d eclairdfrank
 
 # Elements can be started optionally
 $ docker-compose up -d elementsd
@@ -77,6 +84,7 @@ $ bin/ln-bob getinfo
 $ bin/ld-carol getinfo
 $ bin/ld-dave getinfo
 $ bin/ld-emma getinfo
+$ bin/ed-frank getinfo
 ```
 
 A convenience script is provided to create a channel from `bob` to `alice` with some funding between the two `lnd` containers.
@@ -89,7 +97,7 @@ $ bin/ln-alice listchannels
 $ bin/ln-bob listchannels
 ```
 
-Another convenience script will connect `bob` to `carol` on the `lightningd` implementation of LN on Bitcoin.
+Another convenience script will connect `bob` to `carol` across the `lightningd` implementation of LN on Bitcoin.
 ```
 $ bin/ld-connect
 # once channels are opened a payment can be simulated (note amount in *mSats*)
@@ -98,6 +106,15 @@ $ bin/ln-bob payinvoice $CAROL_INVOICE
 $ bin/ld-carol listfunds
 ```
 
+A third script will connect `bob` to `frank` across the `eclair` implementation of LN on Bitcoin.
+```
+$ bin/ed-connect
+# once channels are opened a payment can be simulated (note amount in *mSats*)
+$ FRANK_INVOICE=$(bin/ed-frank createinvoice --amountMsat=10000000 --description="test" | jq '.serialized' | tr -d '"')
+$ bin/ln-bob payinvoice $FRANK_INVOICE
+$ bin/ed-frank audit
+```
+
 Elements sidechain is available and can be pegged in from regtest Bitcoin chain using the provided convenience script.
 ```
 $ bin/e-pegin 1.337
@@ -114,7 +131,7 @@ $ bin/ld-dave listpays
 $ bin/ld-emma listinvoices
 ```
 
-REST/RPC queries can be executed directly from the host to the daemons as follows:
+REST/RPC queries can be executed directly from your application to each daemon. Use standard RPC adapters to connect to these and have full control over money flow; hook into message queues for notifications B).
 ```
 #bitcoind
 $ curl --data-binary '{"jsonrpc":"1.0","id":"curltext","method":"getwalletinfo","params":[]}' -H 'content-type:text/plain;' http://bitcoin:bitcoin@127.0.0.1:18889/
@@ -127,6 +144,9 @@ $ echo "$(docker-compose exec -T lndbob cat /shared/tls.cert)" > ./bob-tls.cert
 $ curl -XGET --cacert ./alice-tls.cert --header "$ALICE_MACAROON_HEADER" https://127.0.0.1:8080/v1/balance/channels
 $ curl -XGET --cacert ./bob-tls.cert --header "$BOB_MACAROON_HEADER" https://127.0.0.1:8090/v1/balance/channels
 
+#eclair
+$ curl -XPOST -u :password http://127.0.0.1:8100/getinfo
+
 #elementsd
 $ curl --data-binary '{"jsonrpc":"1.0","id":"curltext","method":"getwalletinfo","params":[]}' -H 'content-type:text/plain;' http://elements:elements@127.0.0.1:18886/
 

bin/ed-connect

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+source .env
+
+bin/b-cli sendtoaddress $(bin/ln-bob newaddress np2wkh | jq '.address' | tr -d '"') 1
+bin/b-cli generate 1
+ECLAIRDFRANK_NODEID=$(bin/ed-frank getinfo | jq '.nodeId' | tr -d '"')
+bin/ln-bob connect $ECLAIRDFRANK_NODEID@$ECLAIRDFRANK_HOST:$ECLAIRDFRANK_PORT
+bin/ln-bob openchannel --node_key $ECLAIRDFRANK_NODEID --local_amt=10000000 --push_amt=5000000 --private
+bin/b-cli generate 5

bin/ed-frank

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+source .env
+
+docker-compose exec -T eclairdfrank eclair-cli \
+  -p password \
+  -a eclairdfrank:$ECLAIRDFRANK_API_PORT \
+  "$@"

docker-compose.yml

@@ -12,6 +12,7 @@ volumes:
   lightningdcarol_data:
   lightningddave_data:
   lightningdemma_data:
+  eclairdfrank_data:
 
 services:
   bitcoind:
@@ -220,4 +221,19 @@ services:
       - elementsd
     volumes:
       - lightningdemma_data:/lightningd
-      - elements_shared:/elements
+      - elements_shared:/elements
+
+  eclairdfrank:
+    container_name: ${COMPOSE_PROJECT_NAME}_eclairdfrank
+    image: eclaird:0.3.1
+    build: ./eclaird
+    command: ["java", "-jar", "eclair-node.jar"]
+    environment:
+      - JAVA_TOOL_OPTIONS=-Xmx512m -Declair.chain=regtest -Declair.server.port=${ECLAIRDFRANK_PORT} -Declair.bitcoind.host=${BITCOIN_HOST} -Declair.bitcoind.rpcport=${BITCOIN_RPC_PORT} -Declair.bitcoind.rpcuser=${BITCOIN_RPC_USER} -Declair.bitcoind.rpcpassword=${BITCOIN_RPC_PASSWORD} -Declair.bitcoind.zmqtx=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_TX_PORT} -Declair.bitcoind.zmqblock=tcp://${BITCOIN_HOST}:${BITCOIN_ZMQ_BLOCK_PORT} -Declair.api.enabled=true -Declair.api.port=${ECLAIRDFRANK_API_PORT} -Declair.api.password=password -Declair.api.binding-ip=0.0.0.0
+    ports:
+      - "${ECLAIRDFRANK_API_PORT}:${ECLAIRDFRANK_API_PORT}"
+      - "127.0.0.1:${ECLAIRDFRANK_API_PORT}:${ECLAIRDFRANK_API_PORT}"
+    depends_on:
+      - bitcoind
+    volumes:
+      - eclairdfrank_data:/data

eclaird/Dockerfile

@@ -0,0 +1,46 @@
+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 git
+
+ARG MAVEN_VERSION=3.6.2
+ARG USER_HOME_DIR="/root"
+ARG SHA=3fbc92d1961482d6fbd57fbf3dd6d27a4de70778528ee3fb44aa7d27eb32dfdc
+ARG BASE_URL=https://apache.osuosl.org/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" | sha256sum -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"
+
+# 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
+RUN git clone -n https://github.com/ACINQ/eclair.git . \
+  && git checkout v0.3.1
+RUN mvn package -pl eclair-node -am -DskipTests
+# 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
+WORKDIR /app
+
+# install jq for eclair-cli
+RUN apt-get update && apt-get install -y bash jq curl
+
+# copy and install eclair-cli executable
+COPY --from=BUILD /usr/src/eclair-core/eclair-cli .
+RUN chmod +x eclair-cli && mv eclair-cli /sbin/eclair-cli
+
+# Eclair only needs the eclair-node-*.jar to run
+COPY --from=BUILD /usr/src/eclair-node/target/eclair-node-*.jar eclair-node.jar
+
+ADD ./eclair.conf /data/eclair.conf

eclaird/eclair.conf

@@ -0,0 +1,2 @@
+eclair.printToConsole
+eclair.headless