Merge pull request #2684 from SatoshiPortal/fix/swap-route-unavailable-message

fix(swap): name the networks when the exchange rejects a swap

Author: ethicnology

lib/core/primitives/payment_network.dart

@@ -0,0 +1,4 @@
+/// The network a payment moves through: on-chain Bitcoin, Lightning, or
+/// Liquid. Shared across features (e.g. `swap`, `dca`) that need to name a
+/// network without depending on each other's internal types.
+enum PaymentNetwork { bitcoin, lightning, liquid }

lib/core/primitives/payment_network_l10n.dart

@@ -0,0 +1,12 @@
+import 'package:bb_mobile/core/primitives/payment_network.dart';
+import 'package:bb_mobile/core/utils/build_context_x.dart';
+import 'package:flutter/widgets.dart';
+
+/// Kept in its own file so [PaymentNetwork] itself stays Flutter-free.
+extension PaymentNetworkL10n on PaymentNetwork {
+  String toTranslated(BuildContext context) => switch (this) {
+    PaymentNetwork.bitcoin => context.loc.transactionNetworkBitcoin,
+    PaymentNetwork.lightning => context.loc.transactionNetworkLightning,
+    PaymentNetwork.liquid => context.loc.transactionNetworkLiquid,
+  };
+}

lib/features/receive/domain/receive_failure.dart

@@ -1,4 +1,5 @@
 import 'package:bb_mobile/core/failures/failure.dart';
+import 'package:bb_mobile/core/primitives/payment_network.dart';
 
 sealed class ReceiveFailure extends Failure {
   const ReceiveFailure([super.logMessage]);
@@ -23,6 +24,17 @@ final class ReceiveSwapUnavailableFailure extends ReceiveFailure {
   const ReceiveSwapUnavailableFailure([super.logMessage]);
 }
 
+final class ReceiveSwapRouteUnavailableFailure extends ReceiveFailure {
+  final PaymentNetwork? inNetwork;
+  final PaymentNetwork? outNetwork;
+
+  const ReceiveSwapRouteUnavailableFailure({
+    this.inNetwork,
+    this.outNetwork,
+    String? logMessage,
+  }) : super(logMessage);
+}
+
 final class ReceiveNetworkFailure extends ReceiveFailure {
   const ReceiveNetworkFailure([super.logMessage]);
 }

lib/features/receive/domain/usecases/create_receive_order_swap_usecase.dart

@@ -143,7 +143,12 @@ class CreateReceiveOrderSwapUsecase {
         isMinimum: isMinimum,
         logMessage: logMessage,
       ),
-    SwapNoPaymentOptionFailure() ||
+    SwapNoPaymentOptionFailure(:final inNetwork, :final outNetwork) =>
+      ReceiveSwapRouteUnavailableFailure(
+        inNetwork: inNetwork,
+        outNetwork: outNetwork,
+        logMessage: failure.logMessage,
+      ),
     SwapValidationFailure() ||
     SwapProviderFailure() => ReceiveSwapUnavailableFailure(failure.logMessage),
     SwapRateLimitedFailure(:final retryAfter) => ReceiveRateLimitedFailure(

lib/features/receive/presentation/receive_failure_l10n.dart

@@ -1,3 +1,4 @@
+import 'package:bb_mobile/core/primitives/payment_network_l10n.dart';
 import 'package:bb_mobile/core/utils/build_context_x.dart';
 import 'package:bb_mobile/features/receive/domain/receive_failure.dart';
 import 'package:flutter/widgets.dart';
@@ -18,6 +19,13 @@ extension ReceiveFailureL10n on ReceiveFailure {
     ReceiveInvalidInvoiceFailure() ||
     ReceiveSwapUnavailableFailure() ||
     ReceiveUnexpectedFailure() => context.loc.oopsSomethingWentWrong,
+    ReceiveSwapRouteUnavailableFailure(:final inNetwork?, :final outNetwork?) =>
+      context.loc.swapErrorRouteUnavailable(
+        inNetwork.toTranslated(context),
+        outNetwork.toTranslated(context),
+      ),
+    ReceiveSwapRouteUnavailableFailure() =>
+      context.loc.swapErrorRouteUnavailableGeneric,
     ReceiveRateLimitedFailure(:final retryAfter) =>
       context.loc.swapErrorRateLimited(retryAfter?.inSeconds ?? 30),
     ReceiveNetworkFailure() => context.loc.payNetworkError,

lib/features/send/domain/send_failure.dart

@@ -1,4 +1,5 @@
 import 'package:bb_mobile/core/failures/failure.dart';
+import 'package:bb_mobile/core/primitives/payment_network.dart';
 
 sealed class SendFailure extends Failure {
   const SendFailure([super.logMessage]);
@@ -46,6 +47,17 @@ final class SendSwapCreationFailure extends SendFailure {
   const SendSwapCreationFailure([super.logMessage]);
 }
 
+final class SendSwapRouteUnavailableFailure extends SendFailure {
+  final PaymentNetwork? inNetwork;
+  final PaymentNetwork? outNetwork;
+
+  const SendSwapRouteUnavailableFailure({
+    this.inNetwork,
+    this.outNetwork,
+    String? logMessage,
+  }) : super(logMessage);
+}
+
 final class SendRateLimitedFailure extends SendFailure {
   final Duration? retryAfter;
 

lib/features/send/domain/swap_failure_to_send_failure.dart

@@ -12,7 +12,12 @@ SendFailure mapSwapFailureToSendFailure(SwapFailure failure) =>
       SwapValidationFailure() => SendInvalidPaymentRequestFailure(
         logMessage: failure.logMessage,
       ),
-      SwapNoPaymentOptionFailure() ||
+      SwapNoPaymentOptionFailure(:final inNetwork, :final outNetwork) =>
+        SendSwapRouteUnavailableFailure(
+          inNetwork: inNetwork,
+          outNetwork: outNetwork,
+          logMessage: failure.logMessage,
+        ),
       SwapOrderExpiredFailure() ||
       SwapCreationUnknownFailure() ||
       SwapOrderMismatchFailure() ||

lib/features/send/presentation/send_failure_l10n.dart

@@ -1,3 +1,4 @@
+import 'package:bb_mobile/core/primitives/payment_network_l10n.dart';
 import 'package:bb_mobile/core/utils/build_context_x.dart';
 import 'package:bb_mobile/features/send/domain/send_failure.dart';
 import 'package:flutter/widgets.dart';
@@ -22,6 +23,13 @@ extension SendFailureL10n on SendFailure {
     SendAmountOutOfBoundsFailure() =>
       context.loc.sendErrorAmountBelowSwapLimits,
     SendSwapCreationFailure() => context.loc.sendErrorSwapCreationFailed,
+    SendSwapRouteUnavailableFailure(:final inNetwork?, :final outNetwork?) =>
+      context.loc.swapErrorRouteUnavailable(
+        inNetwork.toTranslated(context),
+        outNetwork.toTranslated(context),
+      ),
+    SendSwapRouteUnavailableFailure() =>
+      context.loc.swapErrorRouteUnavailableGeneric,
     SendRateLimitedFailure(:final retryAfter) =>
       context.loc.swapErrorRateLimited(retryAfter?.inSeconds ?? 30),
     SendTransactionBuildFailure() => context.loc.sendErrorBuildFailed,

lib/features/swap/data/order_swap_repository_impl.dart

@@ -68,7 +68,11 @@ class OrderSwapRepositoryImpl implements OrderSwapRepository {
       );
       return Ok(model.toEntity(inNetwork: inNetwork, outNetwork: outNetwork));
     } catch (error) {
-      final failure = _mapFailure(error);
+      final failure = _mapFailure(
+        error,
+        inNetwork: inNetwork,
+        outNetwork: outNetwork,
+      );
       log.warning(
         '[OrderSwap] quote failed environment=${environment.name} '
         'route=${inNetwork.name}->${outNetwork.name} '
@@ -175,7 +179,13 @@ class OrderSwapRepositoryImpl implements OrderSwapRepository {
           } catch (error) {
             if (error is ArgumentError) {
               await _saveRecordLocked(matching.markFailed());
-              return Err(_mapFailure(error));
+              return Err(
+                _mapFailure(
+                  error,
+                  inNetwork: inNetwork,
+                  outNetwork: outNetwork,
+                ),
+              );
             }
             return const Err(
               SwapCreationUnknownFailure(
@@ -280,7 +290,9 @@ class OrderSwapRepositoryImpl implements OrderSwapRepository {
           return Err(SwapStorageFailure(storageError.toString()));
         }
       }
-      return Err(_mapFailure(error));
+      return Err(
+        _mapFailure(error, inNetwork: inNetwork, outNetwork: outNetwork),
+      );
     }
   }
 
@@ -654,7 +666,11 @@ class OrderSwapRepositoryImpl implements OrderSwapRepository {
     return current;
   }
 
-  SwapFailure _mapFailure(Object error) {
+  SwapFailure _mapFailure(
+    Object error, {
+    OrderSwapNetwork? inNetwork,
+    OrderSwapNetwork? outNetwork,
+  }) {
     if (error is ArgumentError) {
       return SwapOrderMismatchFailure(error.message.toString());
     }
@@ -680,7 +696,11 @@ class OrderSwapRepositoryImpl implements OrderSwapRepository {
     }
     if (error is ExchangeRpcException) {
       return switch (error.apiCode) {
-        'ERR_ORD_PO404' => SwapNoPaymentOptionFailure(error.logMessage),
+        'ERR_ORD_PO404' => SwapNoPaymentOptionFailure(
+          inNetwork: inNetwork?.toPaymentNetwork,
+          outNetwork: outNetwork?.toPaymentNetwork,
+          logMessage: error.logMessage,
+        ),
         'ERR_ORD_LMT001' => SwapAmountOutOfBoundsFailure(
           limitAmountSat: error.limit == null
               ? null

lib/features/swap/domain/entities/order_swap_network.dart

@@ -1,7 +1,15 @@
+import 'package:bb_mobile/core/primitives/payment_network.dart';
+
 enum OrderSwapNetwork {
   bitcoin,
   liquid,
   lightning;
 
   String get apiName => name;
+
+  PaymentNetwork get toPaymentNetwork => switch (this) {
+    OrderSwapNetwork.bitcoin => PaymentNetwork.bitcoin,
+    OrderSwapNetwork.liquid => PaymentNetwork.liquid,
+    OrderSwapNetwork.lightning => PaymentNetwork.lightning,
+  };
 }