[GEN-1766] Swap view fixes and improvements (#436)

RodriFS · web-flow · commit 009cfc511f16 · 2025-10-02T17:13:06.000+02:00
* increased regtest max routing amount for local env

* Letting EstimateRouteFee error pass through so we can display it in the frontend

* Move MaxRoutingFeesPercent to decimal

* added decimal step to _maxMinerFeesPercent

* Moved MaxServiceFees to percentage

* Fix estimation not working when EstimateRouteFee returns null

* misc fixes

* Refactor confirmation modal

* removed console log

* reversed order of null check and function call

* removed unecessary redefinition of ComponentCancellationToken

* Throw if EnvironmentHelpers.GetOrDefault fails to cast

* Better indentation

* Improve Argument null exception with error message

* check also lnd envs to fetch node

* moved repeated html for error handling to a function
diff --git a/docker/loop/docker-compose.yml b/docker/loop/docker-compose.yml
@@ -19,7 +19,7 @@ services:
       - shared_data:/shared
     command:
       - "daemon"
-      - "--maxamt=5000000"
+      - "--maxamt=160000000"
       - "--batcher_cutoff_time=1m"
       - "--lnd.host=alice:10009"
       - "--lnd.macaroonpath=/shared/lnd/alice/admin.macaroon"
diff --git a/src/Data/Repositories/NodeRepository.cs b/src/Data/Repositories/NodeRepository.cs
@@ -152,7 +152,10 @@ public async Task<List<Node>> GetAllLoopdConfigured(string? userId = null)
                 .Include(x => x.ChannelOperationRequestsAsDestination)
                 .Include(x => x.ChannelOperationRequestsAsSource)
                 .Where(node => node.Endpoint != null)
-                .Where(node => !string.IsNullOrEmpty(node.LoopdEndpoint) && !string.IsNullOrEmpty(node.LoopdMacaroon));
+                .Where(node => !string.IsNullOrEmpty(node.LoopdEndpoint) &&
+                    !string.IsNullOrEmpty(node.LoopdMacaroon) &&
+                    !string.IsNullOrEmpty(node.Endpoint) &&
+                    !string.IsNullOrEmpty(node.ChannelAdminMacaroon));
 
             if (!string.IsNullOrEmpty(userId)) {
                 query = query.Where(node => node.Users.Any(user => user.Id == userId));
diff --git a/src/Helpers/CustomExceptions.cs b/src/Helpers/CustomExceptions.cs
@@ -1,3 +1,5 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace NodeGuard.Helpers;
 
 public class NoUTXOsAvailableException: Exception {}
@@ -37,4 +39,16 @@ public NotEnoughBalanceInWalletException(string? message = null): base(message)
 public class BumpingException : Exception
 {
    public BumpingException(string? message = null): base(message) {}
+}
+
+public class CustomArgumentNullException : ArgumentNullException
+{
+   public static void ThrowIfNull([NotNull] object? obj, string paramName, string message, params object[] args)
+   {
+      if (obj == null)
+      {
+         string formattedMessage = string.Format(message, args);
+         throw new ArgumentNullException(paramName, formattedMessage);
+      }
+   }
 }
diff --git a/src/Helpers/EnvironmentHelpers.cs b/src/Helpers/EnvironmentHelpers.cs
@@ -0,0 +1,25 @@
+namespace NodeGuard.Helpers
+{
+    public static class EnvironmentHelpers
+    {
+        /// <summary>
+        /// Gets the value of an environment variable and converts it to the specified type.
+        /// If the environment variable is not set or is empty, returns the provided default value.
+        /// </summary>
+        /// <typeparam name="T">The type to convert the environment variable value to.</typeparam>
+        /// <param name="variableName">The name of the environment variable.</param>
+        /// <param name="defaultValue">The default value to return if the environment variable is not set or is empty.</param>
+        /// <returns>The value of the environment variable converted to type T, or the default value.</returns>
+        /// <exception cref="InvalidCastException">Thrown if the environment variable value cannot be converted to type T.</exception>
+        /// <exception cref="FormatException">Thrown if the environment variable value is not in a format recognized by type T.</exception>
+        /// <exception cref="OverflowException">Thrown if the environment variable value represents a number less than MinValue or greater than MaxValue of type T. (If applicable)</exception>
+        public static T GetOrDefault<T>(string variableName, T defaultValue)
+        {
+            var value = Environment.GetEnvironmentVariable(variableName);
+            if (string.IsNullOrEmpty(value))
+                return defaultValue;
+
+            return (T)Convert.ChangeType(value, typeof(T));
+        }
+    }
+}
diff --git a/src/Services/LightningRouterService.cs b/src/Services/LightningRouterService.cs
@@ -3,6 +3,7 @@
 using Grpc.Net.Client;
 using Microsoft.Extensions.Logging.Abstractions;
 using NodeGuard.Data.Models;
+using NodeGuard.Helpers;
 using Routerrpc;
 
 namespace NodeGuard.Services;
@@ -66,25 +67,17 @@ public Router.RouterClient GetRouterClient(string? endpoint)
 
     public async Task<RouteFeeResponse?> EstimateRouteFee(Node node, RouteFeeRequest routeFeeRequest, Router.RouterClient? client = null)
     {
-        RouteFeeResponse? routeFeeResponse = null;
-        try
-        {
-            client ??= GetRouterClient(node.Endpoint);
-            routeFeeResponse = await client.EstimateRouteFeeAsync(routeFeeRequest,
-                new Metadata
-                {
-                    {
-                        "macaroon", node.ChannelAdminMacaroon
-                    }
-                });
-        }
-        catch (Exception e)
-        {
-            _logger.LogError(e, "Error while estimating route fee for node {NodeId}", node.Id);
-            return null;
-        }
+        CustomArgumentNullException.ThrowIfNull(node.ChannelAdminMacaroon, nameof(node.ChannelAdminMacaroon), "LND Macaroon for {NodeName} is not well configured", node.Name);
+
+        client ??= GetRouterClient(node.Endpoint);
 
-        return routeFeeResponse;
+        return await client.EstimateRouteFeeAsync(routeFeeRequest,
+            new Metadata
+            {
+                {
+                    "macaroon", node.ChannelAdminMacaroon
+                }
+            });
     }
 }
 
diff --git a/src/Services/LoopService.cs b/src/Services/LoopService.cs
@@ -147,20 +147,19 @@ public async Task<SwapResponse> CreateSwapOutAsync(Node node, SwapOutRequest req
             Dest = request.Address,
             MaxMinerFee = request.MaxMinerFees ?? 0,
             MaxPrepayAmt = request.PrepayAmtSat ?? 0,
-            MaxSwapFee = request.MaxServiceFees ?? 0,
-            MaxPrepayRoutingFee = request.MaxRoutingFeesPercent != null  ? calcFee(request.PrepayAmtSat ?? 0, maxRoutingFeeBaseSats, request.MaxRoutingFeesPercent.Value * 10000) : getMaxRoutingFee(request.PrepayAmtSat ?? 0),
-            MaxSwapRoutingFee = request.MaxRoutingFeesPercent != null ? calcFee(request.Amount, maxRoutingFeeBaseSats, request.MaxRoutingFeesPercent.Value * 10000) : getMaxRoutingFee(request.Amount),
+            MaxPrepayRoutingFee = request.MaxRoutingFeesPercent != null  ? calcFee(request.PrepayAmtSat ?? 0, maxRoutingFeeBaseSats, (long)(request.MaxRoutingFeesPercent.Value * 10000)) : getMaxRoutingFee(request.PrepayAmtSat ?? 0),
+            MaxSwapRoutingFee = request.MaxRoutingFeesPercent != null ? calcFee(request.Amount, maxRoutingFeeBaseSats, (long)(request.MaxRoutingFeesPercent.Value * 10000)) : getMaxRoutingFee(request.Amount),
             SweepConfTarget = request.SweepConfTarget,
             HtlcConfirmations = 3,
             SwapPublicationDeadline = (ulong)DateTimeOffset.UtcNow.AddMinutes(request.SwapPublicationDeadlineMinutes).ToUnixTimeSeconds(),
             Label = $"Loop Out {request.Amount} sats on date {DateTime.UtcNow} to {request.Address} via NodeGuard",
             Initiator = "NodeGuard",
         };
 
-        if (request.MaxServiceFees.HasValue)
+        if (request.MaxServiceFeesPercent.HasValue)
         {
-            loopReq.MaxSwapFee = (long)request.MaxServiceFees.Value;
-            _logger.LogDebug("Max fees set to {MaxFees}", request.MaxServiceFees.Value);
+            loopReq.MaxSwapFee = (long)(request.Amount * request.MaxServiceFeesPercent.Value / 100);
+            _logger.LogDebug("Max fees set to {MaxFees}", loopReq.MaxSwapFee);
         }
 
         if (request.ChannelsOut != null && request.ChannelsOut.Length > 0)
diff --git a/src/Services/SwapsService.cs b/src/Services/SwapsService.cs
@@ -7,10 +7,10 @@ public class SwapOutRequest
    {
       public long Amount { get; set; }
       public string? Address { get; set; }
-      public long? MaxServiceFees { get; set; }
+      public decimal? MaxServiceFeesPercent { get; set; }
       public long? MaxMinerFees { get; set; }
       public ulong[]? ChannelsOut { get; set; }
-      public int? MaxRoutingFeesPercent { get; set; }
+      public decimal? MaxRoutingFeesPercent { get; set; }
       public long? PrepayAmtSat { get; set; }
       public int SwapPublicationDeadlineMinutes { get; set; } = 60;
       public int SweepConfTarget { get; set; } = 400;
@@ -100,9 +100,8 @@ private async Task<SwapOutQuoteResponse> GetLoopQuoteAsync(Node node, SwapOutQuo
          };
 
          var lnResponse = await _lightningService.EstimateRouteFee(node.PubKey, request.Amount, null, 30);
-         ArgumentNullException.ThrowIfNull(lnResponse, nameof(lnResponse));
          
-         if (lnResponse.FailureReason != Lnrpc.PaymentFailureReason.FailureReasonNone)
+         if (lnResponse == null || lnResponse.FailureReason != Lnrpc.PaymentFailureReason.FailureReasonNone)
          {
             quote.CouldEstimateRoutingFees = false;
             quote.OffChainFees = 0;
diff --git a/src/Shared/NewSwapModal.razor b/src/Shared/NewSwapModal.razor
@@ -66,10 +66,12 @@
                         </Tooltip>
                     </FieldLabel>
                     <div class="d-flex">
-                        <NumericPicker TValue="int"
+                        <NumericPicker TValue="decimal"
                                     @bind-Value="_maxRoutingFeesPercent"
                                     CurrencySymbolPlacement="CurrencySymbolPlacement.Suffix"
                                     CurrencySymbol="%"
+                                    Decimals="2"
+                                    Step="0.1m"
                                     Min="0"
                                     Max="100">
                         </NumericPicker>
@@ -122,6 +124,8 @@
                                                 @bind-Value="_maxMinerFeesPercent"
                                                 CurrencySymbolPlacement="CurrencySymbolPlacement.Suffix"
                                                 CurrencySymbol="%"
+                                                Decimals="2"
+                                                Step="0.1m"
                                                 Min="0"
                                                 Max="100">
                                     </NumericPicker>
@@ -132,21 +136,26 @@
                                     }
                                     @Math.Round(amount, 8) BTC (~@Math.Round(PriceConversionService.BtcToUsdConversion(amount, _btcPrice), 2) USD)
                                 </FieldHelp>
+                                <FieldHelp Style="color: red !important;">Max miner fee is calculated automatically, only change the value if you want to override the default</FieldHelp>
                             </Field>
                              <Field>
                                 <FieldLabel>Max Service Fees</FieldLabel>
                                 <div class="d-flex">
                                     <NumericPicker TValue="decimal"
-                                                @bind-Value="_maxServiceFeesBtc"
+                                                @bind-Value="_maxServiceFeesPercent"
                                                 CurrencySymbolPlacement="CurrencySymbolPlacement.Suffix"
-                                                CurrencySymbol=" BTC"
-                                                Decimals="8"
-                                                Step="0.00001000m"
-                                                Min="0.00001000m">
+                                                CurrencySymbol="%"
+                                                Decimals="2"
+                                                Step="0.1m"
+                                                Min="0"
+                                                Max="100">
                                     </NumericPicker>
                                 </div>
                                 <FieldHelp>
-                                    $@Math.Round(PriceConversionService.BtcToUsdConversion(_maxServiceFeesBtc, _btcPrice), 2)
+                                    @{
+                                        var amount = _maxServiceFeesPercent * _amountBtc / 100;
+                                    }
+                                    @Math.Round(amount, 8) BTC (~@Math.Round(PriceConversionService.BtcToUsdConversion(amount, _btcPrice), 2) USD)
                                 </FieldHelp>
                             </Field>
                             <Field>
@@ -205,7 +214,7 @@
     private SwapDirection _selectedDirection = SwapDirection.Out;
     private SwapProvider _selectedProvider = SwapProvider.Loop;
     private decimal _amountBtc = 0.0025m;
-    private decimal _maxServiceFeesBtc = 0.00001m;
+    private decimal _maxServiceFeesPercent = 0.1m;
     private List<Wallet> _availableWallets = [];
     private Wallet? _selectedWallet;
     private string? _amountInWalletBtc;
@@ -217,12 +226,9 @@
     private bool _showAdvancedOptions = false;
     private int _swapPublicationDeadlineOffsetMinutes = Constants.IS_DEV_ENVIRONMENT ? 1 : 30;
     private int _maxMinerFeesPercent = 0;
-    private int _maxRoutingFeesPercent = 1;
+    private decimal _maxRoutingFeesPercent = 0.5m;
     private int _sweepConfirmationTarget = Constants.IS_DEV_ENVIRONMENT ? 250 : 400;
 
-    private CancellationTokenSource? _cancellationTokenSource;
-    protected CancellationToken ComponentCancellationToken => (_cancellationTokenSource ??= new()).Token;
-
     private string FormatBtcWithUsd(decimal btcAmount)
     {
         var usdAmount = Math.Round(PriceConversionService.BtcToUsdConversion(btcAmount, _btcPrice), 2);
@@ -264,7 +270,7 @@
             var swapRequest = new SwapOutRequest
             {
                 Amount = amount,
-                MaxServiceFees = NBitcoin.Money.FromUnit(_maxServiceFeesBtc, NBitcoin.MoneyUnit.BTC),
+                MaxServiceFeesPercent = _maxServiceFeesPercent,
                 PrepayAmtSat = _confirmationModal.GetData<long>("PrepayAmtSat"),
                 Address = btcAddress.Address.ToString(),
                 SwapPublicationDeadlineMinutes = _swapPublicationDeadlineOffsetMinutes,
@@ -316,6 +322,7 @@
         }
         catch (RpcException ex)
         {
+            Logger.LogError(ex, "Error creating swap");
             ToastService.ShowError(ex.Status.Detail);
         }
         catch (Exception ex)
@@ -334,8 +341,35 @@
 
     private async Task ShowConfirmationModal()
     {
+        var HTLC_SWEEP_FEE_SAT_ON_QUOTE_ERROR = _amountBtc * EnvironmentHelpers.GetOrDefault("HTLC_SWEEP_FEE_SAT_ON_QUOTE_ERROR", 0.015m);
+        var PREPAY_AMT_SAT_ON_QUOTE_ERROR = _amountBtc * EnvironmentHelpers.GetOrDefault("PREPAY_AMT_SAT_ON_QUOTE_ERROR", 0.005m);
+
+        var middleChunkMessage = $"<strong>- Provider:</strong> {_selectedProvider}<br>" +
+                $"<strong>- Direction:</strong> {_selectedDirection}<br>" +
+                $"<strong>- Amount:</strong> {FormatBtcWithUsd(_amountBtc)}<br>" +
+                $"<strong>- Origin Node:</strong> {_selectedNode?.Name}<br>" +
+                $"<strong>- Destination Wallet:</strong> {_selectedWallet?.Name}<br><br>";
+        
         ArgumentNullException.ThrowIfNull(_selectedWallet, nameof(_selectedWallet));
         ArgumentNullException.ThrowIfNull(_selectedNode, nameof(_selectedNode));
+
+        var showErrorModal = async (string errorMessage) => {
+            _confirmationModalBody = "Quote was not successful because of the following error: <br><br>" +
+                $"<span style='color: red;'>{errorMessage}</span>" + "<br><br>" +
+                "The swap will be created with the following details:<br><br>" +
+                middleChunkMessage +
+                "<span style='color: red'>The fees could not be estimated, the swap might not go through.</span><br><br>" +
+                "<br>Please confirm that you want to proceed.";
+
+            var data = new Dictionary<string, object>
+            {
+                { "HtlcSweepFeeSat", HTLC_SWEEP_FEE_SAT_ON_QUOTE_ERROR },
+                { "PrepayAmtSat", PREPAY_AMT_SAT_ON_QUOTE_ERROR }
+            };
+
+            await _confirmationModal.ShowModal(data);
+        };
+
         try
         {
             var request = new SwapOutQuoteRequest{
@@ -348,24 +382,34 @@
             var offChainFee = new Money(quote.OffChainFees);
             var onChainFee = new Money(quote.OnChainFees);
             var totalFees = new Money(quote.ServiceFees + quote.OffChainFees + quote.OnChainFees);
-            
+
+            var selectedServiceFee = _maxServiceFeesPercent * _amountBtc / 100;
+            var serviceFeeChunkMessage = $"<li><strong>Service Fee:</strong> {FormatBtcWithUsd(serviceFee.ToUnit(MoneyUnit.BTC))}</li>";
+            if (serviceFee.ToUnit(MoneyUnit.BTC) > selectedServiceFee) {
+                serviceFeeChunkMessage += $"<li style='list-style-type: none;'><span style='color: orange;'> (You selected: {FormatBtcWithUsd(selectedServiceFee)}, it might not go through)</span></li>";
+            }
+
+            var selectedRoutingFee = _maxRoutingFeesPercent * _amountBtc / 100;
+            var routingFeeChunkMessage = $"<li><strong>Off-Chain Fee:</strong> {FormatBtcWithUsd(offChainFee.ToUnit(MoneyUnit.BTC))}</li>";
+            if (offChainFee.ToUnit(MoneyUnit.BTC) > selectedRoutingFee) {
+                routingFeeChunkMessage += $"<li style='list-style-type: none;'><span style='color: orange;'> (You selected: {FormatBtcWithUsd(selectedRoutingFee)}, it might not go through)</span></li>";
+            }
+
             _confirmationModalBody = $"You are about to create a new swap with the following details:<br><br>" +
-                $"<strong>- Provider:</strong> {_selectedProvider}<br>" +
-                $"<strong>- Direction:</strong> {_selectedDirection}<br>" +
-                $"<strong>- Amount:</strong> {FormatBtcWithUsd(_amountBtc)}<br>" +
+                middleChunkMessage +
                 $"<strong>- Estimated Fees:</strong><br>" +
-                $"&nbsp;&nbsp;&nbsp;&nbsp;<strong>• Service Fee:</strong> {FormatBtcWithUsd(serviceFee.ToUnit(MoneyUnit.BTC))}<br>" +
-                $"&nbsp;&nbsp;&nbsp;&nbsp;<strong>• Off-Chain Fee:</strong> {FormatBtcWithUsd(offChainFee.ToUnit(MoneyUnit.BTC))}<br>" +
-                $"&nbsp;&nbsp;&nbsp;&nbsp;<strong>• On-Chain Fee:</strong> {FormatBtcWithUsd(onChainFee.ToUnit(MoneyUnit.BTC))}<br>" +
-                $"&nbsp;&nbsp;&nbsp;&nbsp;<strong>• Total:</strong> {FormatBtcWithUsd(totalFees.ToUnit(MoneyUnit.BTC))}<br>" +
-                $"<strong>- Origin Node:</strong> {_selectedNode?.Name}<br>" +
-                $"<strong>- Destination Wallet:</strong> {_selectedWallet?.Name}<br><br>" +
+                "<ul>"+
+                serviceFeeChunkMessage +
+                routingFeeChunkMessage +
+                $"<li><strong>On-Chain Fee:</strong> {FormatBtcWithUsd(onChainFee.ToUnit(MoneyUnit.BTC))}</li>" +
+                $"<li><strong>Total:</strong> {FormatBtcWithUsd(totalFees.ToUnit(MoneyUnit.BTC))}</li>" +
+                "<ul>"+
                 "<br>" +
-                $"<strong>- Estimated total cost:</strong> {FormatBtcWithUsd((Money.FromUnit(_amountBtc, MoneyUnit.BTC) + totalFees).ToUnit(MoneyUnit.BTC))}<br>";
+                $"<strong>- Estimated total cost:</strong> {FormatBtcWithUsd(totalFees.ToUnit(MoneyUnit.BTC))} (Percentage of total swap: {Math.Round(totalFees.ToUnit(MoneyUnit.BTC) / _amountBtc * 100, 2)}%)<br>";
 
             if (!quote.CouldEstimateRoutingFees)
             {
-                _confirmationModalBody += "<br>" + $"<span style='color: orange;'><strong>Warning:</strong> Routing fees could not be estimated. The actual fees might be higher than the estimated ones.</span><br><br>";
+                _confirmationModalBody += "<br>" + $"<span style='color: orange;'><strong>Warning:</strong> Routing fees could not be estimated. The actual fees will be higher than 0.</span><br><br>";
             }
                 
             _confirmationModalBody += $"<br>Please confirm that you want to proceed.";
@@ -379,12 +423,12 @@
         catch (RpcException ex)
         {
             Logger.LogError(ex, "Error getting swap quote");
-            ToastService.ShowError(ex.Status.Detail);
+            await showErrorModal(ex.Status.Detail);
         }
         catch (Exception ex)
         {
             Logger.LogError(ex, "Error getting swap quote");
-            ToastService.ShowError("Failed to get swap quote, please try again later");
+            await showErrorModal(ex.Message);
         }
     }
 
