From 10d6e44a38b142bd3d0cdb970b91e041f6212b43 Mon Sep 17 00:00:00 2001
From: Dennis Reimann <mail@dennisreimann.de>
Date: Tue, 11 Aug 2020 14:25:12 +0200
Subject: [PATCH] Docker: Add Lightning channel setup/teardown scripts (#1835)

An alternative for establishing the customer-merchant channel connection.
---
 BTCPayServer.Tests/README.md                  |  3 +
 .../docker-lightning-channel-setup.sh         | 69 +++++++++++++++++++
 .../docker-lightning-channel-teardown.sh      | 12 ++++
 3 files changed, 84 insertions(+)
 create mode 100755 BTCPayServer.Tests/docker-lightning-channel-setup.sh
 create mode 100755 BTCPayServer.Tests/docker-lightning-channel-teardown.sh

diff --git a/BTCPayServer.Tests/README.md b/BTCPayServer.Tests/README.md
index 16e31a81b..978327c49 100644
--- a/BTCPayServer.Tests/README.md
+++ b/BTCPayServer.Tests/README.md
@@ -52,6 +52,9 @@ If you get this message:
 
 Please, run the test `CanSetLightningServer`, this will establish a channel between the customer and the merchant, then, retry.
 
+Alternatively you can run the `./docker-lightning-channel-setup.sh` script to establish the channel connection.
+The `./docker-lightning-channel-teardown.sh` script closes any existing lightning channels.
+
 ## FAQ
 
 `docker-compose up dev` failed or tests are not passing, what should I do?
diff --git a/BTCPayServer.Tests/docker-lightning-channel-setup.sh b/BTCPayServer.Tests/docker-lightning-channel-setup.sh
new file mode 100755
index 000000000..562953d03
--- /dev/null
+++ b/BTCPayServer.Tests/docker-lightning-channel-setup.sh
@@ -0,0 +1,69 @@
+#!/bin/bash
+
+# Commands
+BCMD=./docker-bitcoin-cli.sh
+GCMD=./docker-bitcoin-generate.sh
+CCMD=./docker-customer-lightning-cli.sh
+MCMD=./docker-merchant-lightning-cli.sh
+
+function channel_count () {
+  local cmd=$1; local id=$2;
+  local count=$($cmd listchannels | jq -r ".channels | map(select(.destination == \"$id\")) | length | tonumber") 2>/dev/null
+  return $count
+}
+
+function create_channel () {
+  local cmd=$1; local id=$2;
+  local btcaddr=$($cmd newaddr | jq -r '.address')
+  $BCMD sendtoaddress $btcaddr 0.15 >/dev/null
+  $GCMD 10 >/dev/null
+  local fundres=$($cmd fundchannel $id 14500000 5000 | jq -r '.channel_id')
+  $GCMD 20 >/dev/null
+  sleep 2
+  channel_count $cmd $id
+  local count=$?
+  return $count
+}
+
+# General information
+cinfo=$($CCMD getinfo | jq '.' 2>/dev/null)
+minfo=$($MCMD getinfo | jq '.' 2>/dev/null)
+cid=$(echo $cinfo | jq -r '.id')
+mid=$(echo $minfo | jq -r '.id')
+caddr=$(echo $cinfo | jq -r '.address[] | "\(.address):\(.port)"')
+maddr=$(echo $minfo | jq -r '.address[] | "\(.address):\(.port)"')
+
+printf "Customer ID: %s@%s\n\r" $cid $caddr
+printf "Merchant ID: %s@%s\n\r" $mid $maddr
+
+# Connections
+printf "\n\rConnecting both parties …\n\r"
+
+cconnid=$($CCMD connect "$mid@$maddr" | jq -r '.id' 2>/dev/null)
+mconnid=$($MCMD connect "$cid@$caddr" | jq -r '.id' 2>/dev/null)
+
+printf "Customer to merchant %s\n\r" $([[ $cconnid == $mid ]] && echo "succeeded" || echo "failed")
+printf "Merchant to customer %s\n\r" $([[ $mconnid == $cid ]] && echo "succeeded" || echo "failed")
+
+# Channels
+printf "\n\rChecking channels …\n\r"
+channel_count $CCMD $mid
+cchanscount=$?
+channel_count $MCMD $cid
+mchanscount=$?
+
+printf "Customer channel count to merchant: %d\n\r" $cchanscount
+printf "Merchant channel count to customer: %d\n\r" $mchanscount
+
+# Open channels if there are none, details: https://github.com/ElementsProject/lightning#opening-a-channel
+if [[ $cchanscount -eq 0 ]]; then
+  create_channel $CCMD $mid
+  cchanres=$?
+  printf "Establishing channel from customer to merchant %s\n\r" $([[ $cchanres -gt 0 ]] && echo "succeeded" || echo "failed")
+fi
+
+if [[ $mchanscount -eq 0 ]]; then
+  create_channel $MCMD $cid
+  mchanres=$?
+  printf "Establishing channel from merchant to customer %s\n\r" $([[ $mchanres -gt 0 ]] && echo "succeeded" || echo "failed")
+fi
diff --git a/BTCPayServer.Tests/docker-lightning-channel-teardown.sh b/BTCPayServer.Tests/docker-lightning-channel-teardown.sh
new file mode 100755
index 000000000..c67281a55
--- /dev/null
+++ b/BTCPayServer.Tests/docker-lightning-channel-teardown.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e
+
+channels=$(./docker-merchant-lightning-cli.sh listchannels | jq -cr '.channels | map(.short_channel_id) | unique')
+printf "Channels: %s\n\r" $channels
+
+for chanid in $(echo "${channels}" | jq -cr '.[]')
+do
+    printf "Closing channel ID: %s\n\r" $chanid
+    ./docker-merchant-lightning-cli.sh close $chanid
+    ./docker-bitcoin-generate.sh 20 > /dev/null
+done