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

API: Add Lightning Payment info endpoint (#3557)

Browse Source 
* Upgrade Lightning lib

* API: Add Lightning Payment info endpoint
This commit is contained in:
d11n
2022-04-12 11:01:58 +02:00
committed by GitHub
parent 7ec978fcdb
commit 8981414705
12 changed files with 249 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
BTCPayServer.Client/BTCPayServer.Client.csproj
View File

@@ -29,7 +29,7 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="NBitcoin" Version="7.0.1" />
<PackageReference Include="BTCPayServer.Lightning.Common" Version="1.3.1" />
<PackageReference Include="BTCPayServer.Lightning.Common" Version="1.3.2" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
</ItemGroup>
<ItemGroup>

11
BTCPayServer.Client/BTCPayServerClient.Lightning.Internal.cs
View File

@@ -65,6 +65,17 @@ namespace BTCPayServer.Client
return await HandleResponse<LightningPaymentData>(response);
}
public virtual async Task<LightningPaymentData> GetLightningPayment(string cryptoCode,
string paymentHash, CancellationToken token = default)
{
if (paymentHash == null)
throw new ArgumentNullException(nameof(paymentHash));
var response = await _httpClient.SendAsync(
CreateHttpRequest($"api/v1/server/lightning/{cryptoCode}/payments/{paymentHash}",
method: HttpMethod.Get), token);
return await HandleResponse<LightningPaymentData>(response);
}
public virtual async Task<LightningInvoiceData> GetLightningInvoice(string cryptoCode,
string invoiceId, CancellationToken token = default)
{

11
BTCPayServer.Client/BTCPayServerClient.Lightning.Store.cs
View File

@@ -67,6 +67,17 @@ namespace BTCPayServer.Client
await HandleResponse(response);
}
public virtual async Task<LightningPaymentData> GetLightningPayment(string storeId, string cryptoCode,
string paymentHash, CancellationToken token = default)
{
if (paymentHash == null)
throw new ArgumentNullException(nameof(paymentHash));
var response = await _httpClient.SendAsync(
CreateHttpRequest($"api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash}",
method: HttpMethod.Get), token);
return await HandleResponse<LightningPaymentData>(response);
}
public virtual async Task<LightningInvoiceData> GetLightningInvoice(string storeId, string cryptoCode,
string invoiceId, CancellationToken token = default)
{

17
BTCPayServer.Client/Models/LightningPaymentData.cs
View File

@@ -1,11 +1,28 @@
using System;
using BTCPayServer.Client.JsonConverters;
using BTCPayServer.Lightning;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace BTCPayServer.Client.Models
{
public class LightningPaymentData
{
public string Id { get; set; }
public string PaymentHash { get; set; }
[JsonConverter(typeof(StringEnumConverter))]
public LightningPaymentStatus Status { get; set; }
[JsonProperty("BOLT11")]
public string BOLT11 { get; set; }
public string Preimage { get; set; }
[JsonConverter(typeof(NBitcoin.JsonConverters.DateTimeToUnixTimeConverter))]
public DateTimeOffset? CreatedAt { get; set; }
[JsonConverter(typeof(LightMoneyJsonConverter))]
public LightMoney TotalAmount { get; set; }

2
BTCPayServer.Tests/GreenfieldAPITests.cs
View File

@@ -1547,7 +1547,7 @@ namespace BTCPayServer.Tests
Assert.Single(info.NodeURIs);
Assert.NotEqual(0, info.BlockHeight);
await AssertAPIError("ligthning-node-unavailable", () => client.GetLightningNodeChannels("BTC"));
await AssertAPIError("lightning-node-unavailable", () => client.GetLightningNodeChannels("BTC"));
// Not permission for the store!
await AssertAPIError("missing-permission", () => client.GetLightningNodeChannels(user.StoreId, "BTC"));
var invoiceData = await client.CreateLightningInvoice("BTC", new CreateLightningInvoiceRequest()

2
BTCPayServer/BTCPayServer.csproj
View File

@@ -48,7 +48,7 @@
<ItemGroup>
<PackageReference Include="BIP78.Sender" Version="0.2.2" />
<PackageReference Include="BTCPayServer.Hwi" Version="2.0.2" />
<PackageReference Include="BTCPayServer.Lightning.All" Version="1.3.3" />
<PackageReference Include="BTCPayServer.Lightning.All" Version="1.3.4" />
<PackageReference Include="BuildBundlerMinifier" Version="3.2.449" />
<PackageReference Include="BundlerMinifier.Core" Version="3.2.435" />
<PackageReference Include="BundlerMinifier.TagHelpers" Version="3.2.435" />

8
BTCPayServer/Controllers/GreenField/GreenfieldLightningNodeApiController.Internal.cs
View File

@@ -77,6 +77,14 @@ namespace BTCPayServer.Controllers.Greenfield
return base.GetDepositAddress(cryptoCode);
}
[Authorize(Policy = Policies.CanUseInternalLightningNode,
AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
[HttpGet("~/api/v1/server/lightning/{cryptoCode}/payments/{paymentHash}")]
public override Task<IActionResult> GetPayment(string cryptoCode, string paymentHash)
{
return base.GetPayment(cryptoCode, paymentHash);
}
[Authorize(Policy = Policies.CanUseInternalLightningNode,
AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
[HttpGet("~/api/v1/server/lightning/{cryptoCode}/invoices/{id}")]

8
BTCPayServer/Controllers/GreenField/GreenfieldLightningNodeApiController.Store.cs
View File

@@ -78,6 +78,14 @@ namespace BTCPayServer.Controllers.Greenfield
return base.GetDepositAddress(cryptoCode);
}
[Authorize(Policy = Policies.CanUseLightningNodeInStore,
AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
[HttpGet("~/api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash}")]
public override Task<IActionResult> GetPayment(string cryptoCode, string paymentHash)
{
return base.GetPayment(cryptoCode, paymentHash);
}
[Authorize(Policy = Policies.CanUseLightningNodeInStore,
AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
[HttpPost("~/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/pay")]

24
BTCPayServer/Controllers/GreenField/GreenfieldLightningNodeApiController.cs
View File

@@ -21,7 +21,7 @@ namespace BTCPayServer.Controllers.Greenfield
{
public void OnException(ExceptionContext context)
{
context.Result = new ObjectResult(new GreenfieldAPIError("ligthning-node-unavailable", $"The lightning node is unavailable ({context.Exception.GetType().Name}: {context.Exception.Message})")) { StatusCode = 503 };
context.Result = new ObjectResult(new GreenfieldAPIError("lightning-node-unavailable", $"The lightning node is unavailable ({context.Exception.GetType().Name}: {context.Exception.Message})")) { StatusCode = 503 };
// Do not mark handled, it is possible filters above have better errors
}
}
@@ -164,6 +164,13 @@ namespace BTCPayServer.Controllers.Greenfield
return Ok(new JValue((await lightningClient.GetDepositAddress()).ToString()));
}
public virtual async Task<IActionResult> GetPayment(string cryptoCode, string paymentHash)
{
var lightningClient = await GetLightningClient(cryptoCode, false);
var payment = await lightningClient.GetPayment(paymentHash);
return payment == null ? this.CreateAPIError(404, "payment-not-found", "Impossible to find a lightning payment with this payment hash") : Ok(ToModel(payment));
}
public virtual async Task<IActionResult> PayInvoice(string cryptoCode, PayLightningInvoiceRequest lightningInvoice)
{
var lightningClient = await GetLightningClient(cryptoCode, true);
@@ -274,6 +281,21 @@ namespace BTCPayServer.Controllers.Greenfield
};
}
private LightningPaymentData ToModel(LightningPayment payment)
{
return new LightningPaymentData
{
TotalAmount = payment.AmountSent,
FeeAmount = payment.Amount != null && payment.AmountSent != null ? payment.AmountSent - payment.Amount : null,
Id = payment.Id,
Status = payment.Status,
CreatedAt = payment.CreatedAt,
BOLT11 = payment.BOLT11,
PaymentHash = payment.PaymentHash,
Preimage = payment.Preimage
};
}
protected async Task<bool> CanUseInternalLightning(bool doingAdminThings)
{

42
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.common.json
View File

@@ -80,6 +80,32 @@
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "The payment's ID"
},
"status": {
"$ref": "#/components/schemas/LightningPaymentStatus"
},
"BOLT11": {
"type": "string",
"description": "The BOLT11 representation of the payment",
"nullable": false
},
"paymentHash": {
"type": "string",
"description": "The payment hash",
"nullable": false
},
"preimage": {
"type": "string",
"description": "The payment preimage (available when status is complete)"
},
"createdAt": {
"description": "The unix timestamp when the payment got created",
"nullable": true,
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
},
"totalAmount": {
"type": "string",
"description": "The total amount (including fees) in millisatoshi"
@@ -139,6 +165,22 @@
"Expired"
]
},
"LightningPaymentStatus": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Pending",
"Complete",
"Failed"
],
"enum": [
"Unknown",
"Pending",
"Complete",
"Failed"
]
},
"LightningNodeInformationData": {
"type": "object",
"properties": {

59
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json
View File

@@ -283,6 +283,65 @@
}
},
"/api/v1/server/lightning/{cryptoCode}/payments/{paymentHash}": {
"get": {
"tags": [
"Lightning (Internal Node)"
],
"summary": "Get payment",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
},
{
"name": "paymentHash",
"in": "path",
"required": true,
"description": "The payment hash of the lightning payment.",
"schema": {
"type": "string"
}
}
],
"description": "View information about the requested lightning payment",
"operationId": "InternalLightningNodeApi_GetPayment",
"responses": {
"200": {
"description": "Lightning payment data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LightningPaymentData"
}
}
}
},
"503": {
"description": "Unable to access the lightning node"
},
"404": {
"description": "The lightning node configuration or the specified invoice was not found "
}
},
"security": [
{
"API_Key": [
"btcpay.server.canuseinternallightningnode"
],
"Basic": []
}
]
}
},
"/api/v1/server/lightning/{cryptoCode}/invoices/{id}": {
"get": {
"tags": [

67
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json
View File

@@ -331,6 +331,73 @@
}
},
"/api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash}": {
"get": {
"tags": [
"Lightning (Store)"
],
"summary": "Get payment",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
},
{
"name": "paymentHash",
"in": "path",
"required": true,
"description": "The payment hash of the lightning payment.",
"schema": {
"type": "string"
}
}
],
"description": "View information about the requested lightning payment",
"operationId": "StoreLightningNodeApi_GetPayment",
"responses": {
"200": {
"description": "Lightning payment data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LightningPaymentData"
}
}
}
},
"503": {
"description": "Unable to access the lightning node"
},
"404": {
"description": "The lightning node configuration or the specified invoice was not found "
}
},
"security": [
{
"API_Key": [
"btcpay.store.canuselightningnode"
],
"Basic": []
}
]
}
},
"/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/{id}": {
"get": {
"tags": [