From 2e114d7c29d583e3fb29e2063be863f356fd7f19 Mon Sep 17 00:00:00 2001 From: Nicolas Dorier Date: Fri, 4 Oct 2024 16:58:31 +0900 Subject: [PATCH] Remove references to cryptoCode in SyncStatus (#6275) --- .../Contracts/ISyncSummaryProvider.cs | 2 +- BTCPayServer.Client/Models/ServerInfoData.cs | 2 +- BTCPayServer.Tests/GreenfieldAPITests.cs | 2 +- .../Altcoins/Monero/Services/MoneroSyncSummaryProvider.cs | 8 +++++++- .../Altcoins/Zcash/Services/ZcashSyncSummaryProvider.cs | 8 +++++++- BTCPayServer/Services/NBXSyncSummaryProvider.cs | 3 ++- .../wwwroot/swagger/v1/swagger.template.serverinfo.json | 6 ++---- 7 files changed, 21 insertions(+), 10 deletions(-) diff --git a/BTCPayServer.Abstractions/Contracts/ISyncSummaryProvider.cs b/BTCPayServer.Abstractions/Contracts/ISyncSummaryProvider.cs index 8af42fdf8..c6f8fd015 100644 --- a/BTCPayServer.Abstractions/Contracts/ISyncSummaryProvider.cs +++ b/BTCPayServer.Abstractions/Contracts/ISyncSummaryProvider.cs @@ -12,7 +12,7 @@ namespace BTCPayServer.Abstractions.Contracts public interface ISyncStatus { - public string CryptoCode { get; set; } + public string PaymentMethodId { get; set; } public bool Available { get; } } } diff --git a/BTCPayServer.Client/Models/ServerInfoData.cs b/BTCPayServer.Client/Models/ServerInfoData.cs index b799ff482..8d3be09f0 100644 --- a/BTCPayServer.Client/Models/ServerInfoData.cs +++ b/BTCPayServer.Client/Models/ServerInfoData.cs @@ -32,7 +32,7 @@ namespace BTCPayServer.Client.Models public class SyncStatus { - public string CryptoCode { get; set; } + public string PaymentMethodId { get; set; } public virtual bool Available { get; set; } } diff --git a/BTCPayServer.Tests/GreenfieldAPITests.cs b/BTCPayServer.Tests/GreenfieldAPITests.cs index 3d306d4ca..14c361983 100644 --- a/BTCPayServer.Tests/GreenfieldAPITests.cs +++ b/BTCPayServer.Tests/GreenfieldAPITests.cs @@ -1979,7 +1979,7 @@ namespace BTCPayServer.Tests Assert.Contains("BTC-CHAIN", serverInfoData.SupportedPaymentMethods); Assert.Contains("BTC-LN", serverInfoData.SupportedPaymentMethods); Assert.NotNull(serverInfoData.SyncStatus); - Assert.Single(serverInfoData.SyncStatus.Select(s => s.CryptoCode == "BTC")); + Assert.Single(serverInfoData.SyncStatus.Select(s => s.PaymentMethodId == "BTC-CHAIN")); } [Fact(Timeout = TestTimeout)] diff --git a/BTCPayServer/Services/Altcoins/Monero/Services/MoneroSyncSummaryProvider.cs b/BTCPayServer/Services/Altcoins/Monero/Services/MoneroSyncSummaryProvider.cs index 7a5f88892..3f0c4944a 100644 --- a/BTCPayServer/Services/Altcoins/Monero/Services/MoneroSyncSummaryProvider.cs +++ b/BTCPayServer/Services/Altcoins/Monero/Services/MoneroSyncSummaryProvider.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; using System.Linq; using BTCPayServer.Abstractions.Contracts; using BTCPayServer.Client.Models; +using BTCPayServer.Payments; namespace BTCPayServer.Services.Altcoins.Monero.Services { @@ -24,13 +25,18 @@ namespace BTCPayServer.Services.Altcoins.Monero.Services { return _moneroRpcProvider.Summaries.Select(pair => new MoneroSyncStatus() { - Summary = pair.Value, CryptoCode = pair.Key + Summary = pair.Value, PaymentMethodId = PaymentMethodId.Parse(pair.Key) }); } } public class MoneroSyncStatus: SyncStatus, ISyncStatus { + public new PaymentMethodId PaymentMethodId + { + get => PaymentMethodId.Parse(base.PaymentMethodId); + set => base.PaymentMethodId = value.ToString(); + } public override bool Available { get diff --git a/BTCPayServer/Services/Altcoins/Zcash/Services/ZcashSyncSummaryProvider.cs b/BTCPayServer/Services/Altcoins/Zcash/Services/ZcashSyncSummaryProvider.cs index c943bbfe9..8561ed1ef 100644 --- a/BTCPayServer/Services/Altcoins/Zcash/Services/ZcashSyncSummaryProvider.cs +++ b/BTCPayServer/Services/Altcoins/Zcash/Services/ZcashSyncSummaryProvider.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; using System.Linq; using BTCPayServer.Abstractions.Contracts; using BTCPayServer.Client.Models; +using BTCPayServer.Payments; namespace BTCPayServer.Services.Altcoins.Zcash.Services { @@ -24,13 +25,18 @@ namespace BTCPayServer.Services.Altcoins.Zcash.Services { return _ZcashRpcProvider.Summaries.Select(pair => new ZcashSyncStatus() { - Summary = pair.Value, CryptoCode = pair.Key + Summary = pair.Value, PaymentMethodId = PaymentMethodId.Parse(pair.Key) }); } } public class ZcashSyncStatus: SyncStatus, ISyncStatus { + public new PaymentMethodId PaymentMethodId + { + get => PaymentMethodId.Parse(base.PaymentMethodId); + set => base.PaymentMethodId = value.ToString(); + } public override bool Available { get diff --git a/BTCPayServer/Services/NBXSyncSummaryProvider.cs b/BTCPayServer/Services/NBXSyncSummaryProvider.cs index e40da41e6..40a792f42 100644 --- a/BTCPayServer/Services/NBXSyncSummaryProvider.cs +++ b/BTCPayServer/Services/NBXSyncSummaryProvider.cs @@ -3,6 +3,7 @@ using System.Linq; using BTCPayServer.Abstractions.Contracts; using BTCPayServer.Client.Models; using BTCPayServer.HostedServices; +using BTCPayServer.Payments; using NBXplorer.Models; namespace BTCPayServer.Services @@ -28,7 +29,7 @@ namespace BTCPayServer.Services .Where(summary => summary.Network.ShowSyncSummary) .Select(summary => new ServerInfoSyncStatusData2 { - CryptoCode = summary.Network.CryptoCode, + PaymentMethodId = PaymentTypes.CHAIN.GetPaymentMethodId(summary.Network.CryptoCode).ToString(), NodeInformation = summary.Status.BitcoinStatus is BitcoinStatus s ? new ServerInfoNodeData() { Headers = s.Headers, diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json index 115e19b4c..1b626da7d 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json @@ -143,10 +143,8 @@ "type": "object", "description": "Detailed sync status", "properties": { - "cryptoCode": { - "type": "string", - "description": "The CryptoCode of the crypto currency (eg. BTC)", - "example": "BTC" + "paymentMethodId": { + "$ref": "#/components/schemas/PaymentMethodId" }, "nodeInformation": { "$ref": "#/components/schemas/ApplicationServerInfoNodeStatusData"