From 3532789c35f077ead7b67ec5c20e73b72ec58818 Mon Sep 17 00:00:00 2001
From: d11n <mail@dennisreimann.de>
Date: Fri, 9 Sep 2022 16:01:20 +0200
Subject: [PATCH] Improve Lightning Node setup examples (#4033)

* Catch connection string ToString errors

LNDhub connection string error fixed in btcpayserver/BTCPayServer.Lightning#92.

* Add Eclair bitcoin-host example

* Document LNDhub integration
---
 .../UIStoresController.LightningLike.cs       | 11 +++++-
 .../Views/UIStores/SetupLightningNode.cshtml  | 38 +++++++++++++++++--
 2 files changed, 45 insertions(+), 4 deletions(-)

diff --git a/BTCPayServer/Controllers/UIStoresController.LightningLike.cs b/BTCPayServer/Controllers/UIStoresController.LightningLike.cs
index dbfd787ce..2f715b229 100644
--- a/BTCPayServer/Controllers/UIStoresController.LightningLike.cs
+++ b/BTCPayServer/Controllers/UIStoresController.LightningLike.cs
@@ -160,7 +160,16 @@ namespace BTCPayServer.Controllers
                 {
                     CryptoCode = paymentMethodId.CryptoCode
                 };
-                paymentMethod.SetLightningUrl(connectionString);
+
+                try
+                {
+                    paymentMethod.SetLightningUrl(connectionString);
+                }
+                catch (Exception ex)
+                {
+                    ModelState.AddModelError(nameof(vm.ConnectionString), ex.Message);
+                    return View(vm);
+                }
             }
 
             switch (command)
diff --git a/BTCPayServer/Views/UIStores/SetupLightningNode.cshtml b/BTCPayServer/Views/UIStores/SetupLightningNode.cshtml
index 09ce7a7c7..6a5540af6 100644
--- a/BTCPayServer/Views/UIStores/SetupLightningNode.cshtml
+++ b/BTCPayServer/Views/UIStores/SetupLightningNode.cshtml
@@ -122,11 +122,19 @@
                     </h2>
                     <div id="CustomNodeEclairContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeEclairHeader" data-bs-parent="#CustomNodeSupport">
                         <div class="accordion-body">
-                            <ul class="mb-0">
+                            <ul class="pb-3">
                                 <li>
                                     <code><b>type=</b>eclair;<b>server=</b>https://eclair:8080/;<b>password=</b>eclairpassword...</code>
                                 </li>
                             </ul>
+                            <p class="mt-2">
+                                Note that <code>bitcoin-host</code> and <code>bitcoin-auth</code> are optional, only useful if you want to use <code>GetDepositAddress</code> on Eclair:
+                            </p>
+                            <ul class="mb-0">
+                                <li>
+                                    <code><b>type=</b>eclair;<b>server=</b>https://eclair:8080/;<b>password=</b>eclairpassword;<b>bitcoin-host=</b>bitcoin.host;<b>bitcoin-auth=</b>btcpass</code>
+                                </li>
+                            </ul>
                         </div>
                     </div>
                 </div>
@@ -139,7 +147,7 @@
                     </h2>
                     <div id="CustomNodeLNDContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeLNDHeader" data-bs-parent="#CustomNodeSupport">
                         <div class="accordion-body">
-                            <ul class="pb-3">
+                            <ul class="pb-2">
                                 <li>
                                     <code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...</code>
                                 </li>
@@ -147,7 +155,7 @@
                                     <code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...;<b>certthumbprint=</b>abef263adfe...</code>
                                 </li>
                             </ul>
-                            <p class="mt-2">
+                            <p>
                                 For the macaroon options you need to provide the <code>admin.macaroon</code>.<br/>
                                 The path to the LND data directory may vary, the following examples assume <code>/root/.lnd</code>.
                             </p>
@@ -162,6 +170,30 @@
                         </div>
                     </div>
                 </div>
+                <div class="accordion-item">
+                    <h2 class="accordion-header" id="CustomNodeLNDhubHeader">
+                        <button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeLNDhubContent" aria-controls="CustomNodeLNDhubContent" aria-expanded="false">
+                            <span><strong>LNDhub</strong> via the REST API</span>
+                            <vc:icon symbol="caret-down"/>
+                        </button>
+                    </h2>
+                    <div id="CustomNodeLNDhubContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeLNDhubHeader" data-bs-parent="#CustomNodeSupport">
+                        <div class="accordion-body">
+                            <ul class="pb-2">
+                                <li>
+                                    <code><b>type=</b>lndhub;<b>server=</b>https://login:password@lndhub.io</code>
+                                </li>
+                            </ul>
+                            <p class="my-2">The credentials and server address are shown as a <code>lndhub://</code> URL on the "Export/Backup" screen in BlueWallet.</p>
+                            <p>You can also use this LNDhub-URL as the connection string and BTCPay Server converts it into the expected <code>type=lndhub</code> connection string format:</p>
+                            <ul class="mb-0">
+                                <li>
+                                    <code>lndhub://<b>login</b>:<b>password</b>@@<b>https://lndhub.io</b></code>
+                                </li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
             </div>
         </div>
         <vc:ui-extension-point location="ln-payment-method-setup-tab" model="@Model"/>