btcpayserver/BTCPayServer/Views/UIStores/SetupLightningNode.cshtml
d11n 3532789c35
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
2022-09-09 23:01:20 +09:00

210 lines
13 KiB
Plaintext

@model LightningNodeViewModel
@{
Layout = "_LayoutWalletSetup.cshtml";
ViewData.SetActivePage(StoreNavPages.LightningSettings, "Connect to a Lightning node", Context.GetStoreData().Id);
}
<header class="text-center">
<h1>@ViewData["Title"]</h1>
<div class="d-flex mt-4 mb-5">
<vc:icon symbol="warning"/>
<p class="text-secondary text-start mb-0">
Please understand that the Lightning Network is still under active development and considered experimental.
Before you proceed, take time to familiarize yourself with the risks.
<a href="https://docs.btcpayserver.org/LightningNetwork/" target="_blank" rel="noreferrer noopener">More information</a>
</p>
</div>
</header>
@section PageHeadContent {
<style>
header .icon-warning {
flex: 0 0 24px;
height: 24px;
align-self: center;
margin-right: 2rem;
color: var(--btcpay-warning);
}
#save { min-width: 7rem; }
#LightningNodeTypeTabs ul {
list-style: none;
padding-left: 0;
}
#LightningNodeTypeTabs ul li code,
#LightningNodeTypeTabs pre {
display: block;
color: var(--btcpay-code-text);
background: var(--btcpay-bg-tile);
margin: .25rem 0;
padding: .75rem 1rem;
border-radius: 4px;
}
</style>
}
<form method="post" class="mt-n2 text-center">
<div id="LightningNodeTypeTablist" class="nav btcpay-pills align-items-center justify-content-center mb-3" role="tablist">
<input asp-for="LightningNodeType" value="@LightningNodeType.Internal" type="radio" id="LightningNodeType-@LightningNodeType.Internal" data-bs-toggle="pill" data-bs-target="#InternalSetup" role="tab" aria-controls="InternalSetup" aria-selected="@(Model.LightningNodeType == LightningNodeType.Internal ? "true" : "false")" disabled="@(!Model.CanUseInternalNode)">
<label asp-for="LightningNodeType" for="@($"LightningNodeType-{LightningNodeType.Internal}")">Use internal node</label>
<input asp-for="LightningNodeType" value="@LightningNodeType.Custom" type="radio" id="LightningNodeType-@LightningNodeType.Custom" data-bs-toggle="pill" data-bs-target="#CustomSetup" role="tab" aria-controls="CustomSetup" aria-selected="@(Model.LightningNodeType == LightningNodeType.Custom ? "true" : "false")">
<label asp-for="LightningNodeType" for="@($"LightningNodeType-{LightningNodeType.Custom}")">Use custom node</label>
<vc:ui-extension-point location="ln-payment-method-setup-tabhead" model="@Model"/>
</div>
<div id="LightningNodeTypeTabs" class="tab-content text-start">
<div id="InternalSetup" class="pt-3 tab-pane fade @(Model.LightningNodeType == LightningNodeType.Internal ? "show active" : "")" role="tabpanel" aria-labelledby="LightningNodeType-@LightningNodeType.Internal">
@if (Model.CanUseInternalNode)
{
<p class="mb-4">Using the BTCPay Server internal node for this store requires no further configuration. Click the save button below to start accepting Bitcoin through the Lightning Network.</p>
}
else
{
<p class="mb-4">Your instance administrator has disabled the use of the Internal node for non-admin users.</p>
}
</div>
<div id="CustomSetup" class="pt-3 tab-pane fade @(Model.LightningNodeType == LightningNodeType.Custom ? "show active" : "")" role="tabpanel" aria-labelledby="LightningNodeType-@LightningNodeType.Custom">
<div class="form-group">
<label asp-for="ConnectionString" class="form-label">Connection configuration for your custom Lightning node:</label>
<div class="d-sm-flex">
<input asp-for="ConnectionString" class="form-control mb-2 me-2" placeholder="type=…;server=…;" value="@(Model.LightningNodeType == LightningNodeType.Internal ? "" : Model.ConnectionString)"/>
<button id="test" name="command" type="submit" value="test" class="btn btn-secondary text-nowrap mb-2">Test connection</button>
</div>
<span asp-validation-for="ConnectionString" class="text-danger"></span>
</div>
<vc:ui-extension-point location="ln-payment-method-setup-custom" model="@Model"/>
<p class="mt-4 mb-2">BTCPay Server currently supports:</p>
<div class="accordion" id="CustomNodeSupport">
<div class="accordion-item">
<h2 class="accordion-header" id="CustomNodeCLightningHeader">
<button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeCLightningContent" aria-controls="CustomNodeCLightningContent" aria-expanded="false">
<span><strong>c-lightning</strong> via TCP or unix domain socket connection</span>
<vc:icon symbol="caret-down"/>
</button>
</h2>
<div id="CustomNodeCLightningContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeCLightningHeader" data-bs-parent="#CustomNodeSupport">
<div class="accordion-body">
<ul class="mb-0">
<li>
<code><b>type=</b>clightning;<b>server=</b>unix://root/.lightning/lightning-rpc</code>
</li>
<li>
<code><b>type=</b>clightning;<b>server=</b>tcp://1.1.1.1:27743/</code>
</li>
</ul>
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="CustomNodeChargeHeader">
<button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeChargeContent" aria-controls="CustomNodeChargeContent" aria-expanded="false">
<span><strong>Lightning Charge</strong> via HTTPS</span>
<vc:icon symbol="caret-down"/>
</button>
</h2>
<div id="CustomNodeChargeContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeChargeHeader" data-bs-parent="#CustomNodeSupport">
<div class="accordion-body">
<ul class="mb-0">
<li>
<code><b>type=</b>charge;<b>server=</b>https://charge:8080/;<b>api-token=</b>myapitoken...</code>
</li>
</ul>
</div>
</div>
</div>
<div class="accordion-item">
<h2 class="accordion-header" id="CustomNodeEclairHeader">
<button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeEclairContent" aria-controls="CustomNodeEclairContent" aria-expanded="false">
<span><strong>Eclair</strong> via HTTPS</span>
<vc:icon symbol="caret-down"/>
</button>
</h2>
<div id="CustomNodeEclairContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeEclairHeader" data-bs-parent="#CustomNodeSupport">
<div class="accordion-body">
<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>
<div class="accordion-item">
<h2 class="accordion-header" id="CustomNodeLNDHeader">
<button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeLNDContent" aria-controls="CustomNodeLNDContent" aria-expanded="false">
<span><strong>LND</strong> via the REST proxy</span>
<vc:icon symbol="caret-down"/>
</button>
</h2>
<div id="CustomNodeLNDContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeLNDHeader" data-bs-parent="#CustomNodeSupport">
<div class="accordion-body">
<ul class="pb-2">
<li>
<code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...</code>
</li>
<li>
<code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...;<b>certthumbprint=</b>abef263adfe...</code>
</li>
</ul>
<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>
<p class="mb-2">The <code>macaroon</code> parameter expects the HEX value, it can be obtained using this command:</p>
<pre class="mb-4">xxd -p -c 256 /root/.lnd/data/chain/bitcoin/mainnet/admin.macaroon | tr -d '\n'</pre>
<p class="mb-2">
You can omit <code>certthumbprint</code> if the certificate is trusted by your machine.<br/>
The <code>certthumbprint</code> can be obtained using this command:
</p>
<pre class="mb-4">openssl x509 -noout -fingerprint -sha256 -in /root/.lnd/tls.cert | sed -e 's/.*=//;s/://g'</pre>
<p class="mb-0">If your LND REST server is using HTTP or HTTPS with an untrusted certificate, you can set <code>allowinsecure=true</code> as a fallback.</p>
</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"/>
</div>
<div class="text-start mt-4">
<button id="save" name="command" type="submit" value="save" class="btn btn-primary me-2">Save</button>
</div>
</form>
@section PageFootContent {
<partial name="_ValidationScriptsPartial"/>
}