Pluginize Webhooks and support Payouts (#5421)

Co-authored-by: d11n <mail@dennisreimann.de>
2025-12-18 14:34:23 +01:00 · 2023-12-01 10:50:05 +01:00
parent 605741182d
commit a97172cea6
47 changed files with 1265 additions and 706 deletions
--- a/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookProvider.cs
+++ b/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookProvider.cs
@@ -0,0 +1,120 @@
+using System;
+using System.Collections.Generic;
+using BTCPayServer.Client.Models;
+using BTCPayServer.Controllers.Greenfield;
+using BTCPayServer.Data;
+using BTCPayServer.Events;
+using BTCPayServer.Services.Invoices;
+using Microsoft.Extensions.Logging;
+using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData;
+
+namespace BTCPayServer.HostedServices.Webhooks;
+
+public class InvoiceWebhookProvider : WebhookProvider<InvoiceEvent>
+{
+    public InvoiceWebhookProvider(WebhookSender webhookSender, EventAggregator eventAggregator,
+        ILogger<InvoiceWebhookProvider> logger) : base(
+        eventAggregator, logger, webhookSender)
+    {
+    }
+
+    public override Dictionary<string, string> GetSupportedWebhookTypes()
+    {
+        return new Dictionary<string, string>
+        {
+            {WebhookEventType.InvoiceCreated, "A new invoice has been created"},
+            {WebhookEventType.InvoiceReceivedPayment, "A new payment has been received"},
+            {WebhookEventType.InvoicePaymentSettled, "A payment has been settled"},
+            {WebhookEventType.InvoiceProcessing, "An invoice is processing"},
+            {WebhookEventType.InvoiceExpired, "An invoice has expired"},
+            {WebhookEventType.InvoiceSettled, "An invoice has been settled"},
+            {WebhookEventType.InvoiceInvalid, "An invoice became invalid"},
+        };
+    }
+
+    protected override WebhookSender.WebhookDeliveryRequest CreateDeliveryRequest(InvoiceEvent invoiceEvent,
+        WebhookData webhook)
+    {
+        var webhookEvent = GetWebhookEvent(invoiceEvent)!;
+        var webhookBlob = webhook?.GetBlob();
+        webhookEvent.InvoiceId = invoiceEvent.InvoiceId;
+        webhookEvent.StoreId = invoiceEvent.Invoice.StoreId;
+        webhookEvent.Metadata = invoiceEvent.Invoice.Metadata.ToJObject();
+        webhookEvent.WebhookId = webhook?.Id;
+        webhookEvent.IsRedelivery = false;
+        WebhookDeliveryData delivery = webhook is null? null: WebhookExtensions.NewWebhookDelivery(webhook.Id);
+        if (delivery is not null)
+        {
+            webhookEvent.DeliveryId = delivery.Id;
+            webhookEvent.OriginalDeliveryId = delivery.Id;
+            webhookEvent.Timestamp = delivery.Timestamp;
+        }
+        return new InvoiceWebhookDeliveryRequest(invoiceEvent.Invoice, webhook?.Id, webhookEvent,
+            delivery, webhookBlob);
+    }
+
+    public override WebhookEvent CreateTestEvent(string type, params object[] args)
+    {
+        var storeId = args[0].ToString();
+        return new WebhookInvoiceEvent(type, storeId)
+        {
+            InvoiceId = "__test__" + Guid.NewGuid() + "__test__"
+        };
+    }
+
+    protected override WebhookInvoiceEvent GetWebhookEvent(InvoiceEvent invoiceEvent)
+    {
+        var eventCode = invoiceEvent.EventCode;
+        var storeId = invoiceEvent.Invoice.StoreId;
+        switch (eventCode)
+        {
+            case InvoiceEventCode.Confirmed:
+            case InvoiceEventCode.MarkedCompleted:
+                return new WebhookInvoiceSettledEvent(storeId)
+                {
+                    ManuallyMarked = eventCode == InvoiceEventCode.MarkedCompleted
+                };
+            case InvoiceEventCode.Created:
+                return new WebhookInvoiceEvent(WebhookEventType.InvoiceCreated, storeId);
+            case InvoiceEventCode.Expired:
+                return new WebhookInvoiceExpiredEvent(storeId)
+                {
+                    PartiallyPaid = invoiceEvent.PaidPartial
+                };
+            case InvoiceEventCode.FailedToConfirm:
+            case InvoiceEventCode.MarkedInvalid:
+                return new WebhookInvoiceInvalidEvent(storeId)
+                {
+                    ManuallyMarked = eventCode == InvoiceEventCode.MarkedInvalid
+                };
+            case InvoiceEventCode.PaidInFull:
+                return new WebhookInvoiceProcessingEvent(storeId)
+                {
+                    OverPaid = invoiceEvent.Invoice.ExceptionStatus == InvoiceExceptionStatus.PaidOver
+                };
+            case InvoiceEventCode.ReceivedPayment:
+                return new WebhookInvoiceReceivedPaymentEvent(WebhookEventType.InvoiceReceivedPayment, storeId)
+                {
+                    AfterExpiration =
+                        invoiceEvent.Invoice.Status.ToModernStatus() == InvoiceStatus.Expired ||
+                        invoiceEvent.Invoice.Status.ToModernStatus() == InvoiceStatus.Invalid,
+                    PaymentMethod = invoiceEvent.Payment.GetPaymentMethodId().ToStringNormalized(),
+                    Payment = GreenfieldInvoiceController.ToPaymentModel(invoiceEvent.Invoice, invoiceEvent.Payment),
+                    StoreId = invoiceEvent.Invoice.StoreId
+                };
+            case InvoiceEventCode.PaymentSettled:
+                return new WebhookInvoiceReceivedPaymentEvent(WebhookEventType.InvoicePaymentSettled, storeId)
+                {
+                    AfterExpiration =
+                        invoiceEvent.Invoice.Status.ToModernStatus() == InvoiceStatus.Expired ||
+                        invoiceEvent.Invoice.Status.ToModernStatus() == InvoiceStatus.Invalid,
+                    PaymentMethod = invoiceEvent.Payment.GetPaymentMethodId().ToStringNormalized(),
+                    Payment = GreenfieldInvoiceController.ToPaymentModel(invoiceEvent.Invoice, invoiceEvent.Payment),
+                    OverPaid = invoiceEvent.Invoice.ExceptionStatus == InvoiceExceptionStatus.PaidOver,
+                    StoreId = invoiceEvent.Invoice.StoreId
+                };
+            default:
+                return null;
+        }
+    }
+}