aljaz/btcpayserver
1
0
Fork 0
mirror of https://github.com/aljazceru/btcpayserver.git synced 2025-12-18 14:34:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Provide extension points for Lightning setup

Browse Source
This commit is contained in:
Dennis Reimann
2021-11-24 10:54:43 +01:00
committed by Andrew Camilleri
parent fa83304697
commit 285a30f67a
2 changed files with 155 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
BTCPayServer.Tests/SeleniumTester.cs
View File

@@ -242,7 +242,7 @@ namespace BTCPayServer.Tests
else else
{ {
Driver.FindElement(By.CssSelector("label[for=\"LightningNodeType-Custom\"]")).Click(); Driver.FindElement(By.CssSelector("label[for=\"LightningNodeType-Custom\"]")).Click();
Driver.FindElement(By.Id("ConnectionString")).Clear(); Driver.WaitForElement(By.Id("ConnectionString")).Clear();
Driver.FindElement(By.Id("ConnectionString")).SendKeys(connectionString); Driver.FindElement(By.Id("ConnectionString")).SendKeys(connectionString);
if (test) if (test)
{ {

300
BTCPayServer/Views/Stores/SetupLightningNode.cshtml
View File

@@ -18,167 +18,175 @@
@section PageHeadContent { @section PageHeadContent {
<style> <style>
header .icon-warning { header .icon-warning {
flex: 0 0 24px; flex: 0 0 24px;
height: 24px; height: 24px;
align-self: center; align-self: center;
margin-right: 2rem; margin-right: 2rem;
color: var(--btcpay-warning); color: var(--btcpay-warning);
} }
#save { min-width: 7rem; } #save { min-width: 7rem; }
#InternalSetup, #CustomSetup, #LightningNodeType-Internal, #LightningNodeType-Custom { display: none; } #LightningNodeTypeTablist input { display: none; }
#LightningNodeType-Internal:checked + * + * + * + #InternalSetup, #LightningNodeTypeTablist input:checked + label {
#LightningNodeType-Custom:checked + * + *+ #CustomSetup { display: block; } color: var(--btcpay-white);
#LightningNodeType-Internal:checked + label, #LightningNodeType-Custom:checked + label { background: var(--btcpay-primary);
color: var(--btcpay-white); }
background: var(--btcpay-primary); #LightningNodeTypeTablist label {
} display: inline-block;
label[for="LightningNodeType-Internal"], label[for="LightningNodeType-Custom"] { padding: .75rem 2rem;
display: inline-block; color: var(--btcpay-primary);
padding: .75rem 2rem; font-weight: var(--btcpay-font-weight-semibold);
color: var(--btcpay-primary); border-radius: 1.5rem;
font-weight: var(--btcpay-font-weight-semibold); cursor: pointer;
border-radius: 1.5rem; }
cursor: pointer; #LightningNodeTypeTablist input[disabled]:checked + label {
} background: var(--btcpay-secondary);
#LightningNodeType-Internal[disabled]:checked + label[for="LightningNodeType-Internal"] { color: var(--btcpay-white);
background: var(--btcpay-secondary); opacity: .5;
color: var(--btcpay-white); }
opacity: .5; #LightningNodeTypeTablist input[disabled] + label {
} color: var(--btcpay-secondary);
#LightningNodeType-Internal[disabled] + label[for="LightningNodeType-Internal"] { opacity: .5;
color: var(--btcpay-secondary); }
opacity: .5; #LightningNodeTypeTabs ul {
} list-style: none;
#CustomSetup ul { padding-left: 0;
list-style: none; }
padding-left: 0; #LightningNodeTypeTabs ul li code,
} #LightningNodeTypeTabs pre {
#CustomSetup ul li code, display: block;
#CustomSetup pre { color: var(--btcpay-code-text);
display: block; background: var(--btcpay-bg-tile);
color: var(--btcpay-code-text); margin: .25rem 0;
background: var(--btcpay-bg-tile); padding: .75rem 1rem;
margin: .25rem 0; border-radius: 4px;
padding: .75rem 1rem; }
border-radius: 4px; </style>
}
</style>
} }
<form method="post" class="mt-n2 text-center"> <form method="post" class="mt-n2 text-center">
<input asp-for="LightningNodeType" value="@LightningNodeType.Internal" type="radio" id="LightningNodeType-@LightningNodeType.Internal" disabled="@(!Model.CanUseInternalNode)"> <div id="LightningNodeTypeTablist" class="nav nav-pills align-items-center justify-content-center mb-3" role="tablist">
<label asp-for="LightningNodeType" for="@($"LightningNodeType-{LightningNodeType.Internal}")">Use internal node</label> <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)">
<input asp-for="LightningNodeType" value="@LightningNodeType.Custom" type="radio" id="LightningNodeType-@LightningNodeType.Custom"> <label asp-for="LightningNodeType" for="@($"LightningNodeType-{LightningNodeType.Internal}")">Use internal node</label>
<label asp-for="LightningNodeType" for="@($"LightningNodeType-{LightningNodeType.Custom}")">Use custom node</label>
<div id="InternalSetup" class="text-start"> <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")">
@if (Model.CanUseInternalNode) <label asp-for="LightningNodeType" for="@($"LightningNodeType-{LightningNodeType.Custom}")">Use custom node</label>
{
<p class="my-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> <vc:ui-extension-point location="ln-payment-method-setup-tabhead" model="@Model"/>
}
else
{
<p class="my-4">Your instance administrator has disabled the use of the Internal node for non-admin users.</p>
}
</div> </div>
<vc:ui-extension-point location="ln-payment-method-setup" model="@Model" />
<div id="CustomSetup" class="text-start"> <div id="LightningNodeTypeTabs" class="tab-content text-start">
<label asp-for="ConnectionString" class="form-label mt-4">Connection configuration for your custom Lightning node:</label> <div id="InternalSetup" class="pt-3 tab-pane fade @(Model.LightningNodeType == LightningNodeType.Internal ? "show active" : "")" role="tabpanel" aria-labelledby="LightningNodeType-@LightningNodeType.Internal">
<div class="d-sm-flex"> @if (Model.CanUseInternalNode)
<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> <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>
<span asp-validation-for="ConnectionString" class="text-danger"></span> <div id="CustomSetup" class="pt-3 tab-pane fade @(Model.LightningNodeType == LightningNodeType.Custom ? "show active" : "")" role="tabpanel" aria-labelledby="LightningNodeType-@LightningNodeType.Custom">
<vc:ui-extension-point location="ln-payment-method-setup-custom" model="@Model" /> <div class="form-group">
<p class="mt-4 mb-2">BTCPay Server currently supports:</p> <label asp-for="ConnectionString" class="form-label">Connection configuration for your custom Lightning node:</label>
<div class="accordion" id="CustomNodeSupport"> <div class="d-sm-flex">
<div class="accordion-item"> <input asp-for="ConnectionString" class="form-control mb-2 me-2" placeholder="type=…;server=…;" value="@(Model.LightningNodeType == LightningNodeType.Internal ? "" : Model.ConnectionString)"/>
<h2 class="accordion-header" id="CustomNodeCLightningHeader"> <button id="test" name="command" type="submit" value="test" class="btn btn-secondary text-nowrap mb-2">Test connection</button>
<button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeCLightningContent" aria-controls="CustomNodeCLightningContent" aria-expanded="false"> </div>
<span><strong>c-lightning</strong> via TCP or unix domain socket connection</span> <span asp-validation-for="ConnectionString" class="text-danger"></span>
<vc:icon symbol="caret-down"/> </div>
</button> <vc:ui-extension-point location="ln-payment-method-setup-custom" model="@Model"/>
</h2> <p class="mt-4 mb-2">BTCPay Server currently supports:</p>
<div id="CustomNodeCLightningContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeCLightningHeader" data-bs-parent="#CustomNodeSupport"> <div class="accordion" id="CustomNodeSupport">
<div class="accordion-body"> <div class="accordion-item">
<ul class="mb-0"> <h2 class="accordion-header" id="CustomNodeCLightningHeader">
<li> <button type="button" class="accordion-button collapsed" data-bs-toggle="collapse" data-bs-target="#CustomNodeCLightningContent" aria-controls="CustomNodeCLightningContent" aria-expanded="false">
<code><b>type=</b>clightning;<b>server=</b>unix://root/.lightning/lightning-rpc</code> <span><strong>c-lightning</strong> via TCP or unix domain socket connection</span>
</li> <vc:icon symbol="caret-down"/>
<li> </button>
<code><b>type=</b>clightning;<b>server=</b>tcp://1.1.1.1:27743/</code> </h2>
</li> <div id="CustomNodeCLightningContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeCLightningHeader" data-bs-parent="#CustomNodeSupport">
</ul> <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> </div>
</div> <div class="accordion-item">
<div class="accordion-item"> <h2 class="accordion-header" id="CustomNodeChargeHeader">
<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">
<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>
<span><strong>Lightning Charge</strong> via HTTPS</span> <vc:icon symbol="caret-down"/>
<vc:icon symbol="caret-down"/> </button>
</button> </h2>
</h2> <div id="CustomNodeChargeContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeChargeHeader" data-bs-parent="#CustomNodeSupport">
<div id="CustomNodeChargeContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeChargeHeader" data-bs-parent="#CustomNodeSupport"> <div class="accordion-body">
<div class="accordion-body"> <ul class="mb-0">
<ul class="mb-0"> <li>
<li> <code><b>type=</b>charge;<b>server=</b>https://charge:8080/;<b>api-token=</b>myapitoken...</code>
<code><b>type=</b>charge;<b>server=</b>https://charge:8080/;<b>api-token=</b>myapitoken...</code> </li>
</li> </ul>
</ul> </div>
</div> </div>
</div> </div>
</div> <div class="accordion-item">
<div class="accordion-item"> <h2 class="accordion-header" id="CustomNodeEclairHeader">
<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">
<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>
<span><strong>Eclair</strong> via HTTPS</span> <vc:icon symbol="caret-down"/>
<vc:icon symbol="caret-down"/> </button>
</button> </h2>
</h2> <div id="CustomNodeEclairContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeEclairHeader" data-bs-parent="#CustomNodeSupport">
<div id="CustomNodeEclairContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeEclairHeader" data-bs-parent="#CustomNodeSupport"> <div class="accordion-body">
<div class="accordion-body"> <ul class="mb-0">
<ul class="mb-0"> <li>
<li> <code><b>type=</b>eclair;<b>server=</b>https://eclair:8080/;<b>password=</b>eclairpassword...</code>
<code><b>type=</b>eclair;<b>server=</b>https://eclair:8080/;<b>password=</b>eclairpassword...</code> </li>
</li> </ul>
</ul> </div>
</div> </div>
</div> </div>
</div> <div class="accordion-item">
<div class="accordion-item"> <h2 class="accordion-header" id="CustomNodeLNDHeader">
<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">
<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>
<span><strong>LND</strong> via the REST proxy</span> <vc:icon symbol="caret-down"/>
<vc:icon symbol="caret-down"/> </button>
</button> </h2>
</h2> <div id="CustomNodeLNDContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeLNDHeader" data-bs-parent="#CustomNodeSupport">
<div id="CustomNodeLNDContent" class="accordion-collapse collapse" aria-labelledby="CustomNodeLNDHeader" data-bs-parent="#CustomNodeSupport"> <div class="accordion-body">
<div class="accordion-body"> <ul class="pb-3">
<ul class="pb-3"> <li>
<li> <code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...</code>
<code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...</code> </li>
</li> <li>
<li> <code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...;<b>certthumbprint=</b>abef263adfe...</code>
<code><b>type=</b>lnd-rest;<b>server=</b>https://mylnd:8080/;<b>macaroon=</b>abef263adfe...;<b>certthumbprint=</b>abef263adfe...</code> </li>
</li> </ul>
</ul> <p class="mt-2">
<p class="mt-2"> For the macaroon options you need to provide the <code>admin.macaroon</code>.<br/>
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>.
The path to the LND data directory may vary, the following examples assume <code>/root/.lnd</code>. </p>
</p> <p class="mb-2">The <code>macaroon</code> parameter expects the HEX value, it can be obtained using this command:</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 -plain /root/.lnd/data/chain/bitcoin/mainnet/admin.macaroon | tr -d '\n'</pre>
<pre class="mb-4">xxd -plain /root/.lnd/data/chain/bitcoin/mainnet/admin.macaroon | tr -d '\n'</pre> <p class="mb-2">
<p class="mb-2"> You can omit <code>certthumbprint</code> if the certificate is trusted by your machine.<br/>
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:
The <code>certthumbprint</code> can be obtained using this command: </p>
</p> <pre class="mb-4">openssl x509 -noout -fingerprint -sha256 -in /root/.lnd/tls.cert | sed -e 's/.*=//;s/://g'</pre>
<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>
<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> </div>
</div> </div>
</div> </div>
<vc:ui-extension-point location="ln-payment-method-setup-tab" model="@Model"/>
</div> </div>
<div class="text-start mt-4"> <div class="text-start mt-4">