Exolix integration: bugfix apiToken on fetchRates (#1120)

* Add Exolix exchange integration

* update tx payload

* remove import

* Improve mapping

* Additional fixes

* fix apiBaseUrl

* Update trade_details_view_model.dart

* Update exolix_exchange_provider.dart

* Fix status URL

* Fix fetch rates API error handling update limits API to use a valid amount and validate on success status code

* bugfix added apiToken for fetchRate

---------

Co-authored-by: Justin Ehrenhofer <justin.ehrenhofer@gmail.com>
Co-authored-by: Omar Hatem <omarh.ismail1@gmail.com>

.github/workflows/pr_test_build.yml

@@ -128,6 +128,7 @@ jobs:
           echo "const payfuraApiKey = '${{ secrets.PAYFURA_API_KEY }}';" >> lib/.secrets.g.dart
           echo "const etherScanApiKey = '${{ secrets.ETHER_SCAN_API_KEY }}';" >> cw_ethereum/lib/.secrets.g.dart
           echo "const chatwootWebsiteToken = '${{ secrets.CHATWOOT_WEBSITE_TOKEN }}';" >> lib/.secrets.g.dart
+          echo "const exolixApiKey = '${{ secrets.EXOLIX_API_KEY }}';" >> lib/.secrets.g.dart
           echo "const robinhoodApplicationId = '${{ secrets.ROBINHOOD_APPLICATION_ID }}';" >> lib/.secrets.g.dart
           echo "const robinhoodCIdApiSecret = '${{ secrets.ROBINHOOD_CID_CLIENT_SECRET }}';" >> lib/.secrets.g.dart
           echo "const walletConnectProjectId = '${{ secrets.WALLET_CONNECT_PROJECT_ID }}';" >> lib/.secrets.g.dart

lib/exchange/exchange_provider_description.dart

@@ -24,7 +24,10 @@ class ExchangeProviderDescription extends EnumerableItem<int> with Serializable<
   static const trocador =
       ExchangeProviderDescription(title: 'Trocador', raw: 5, image: 'assets/images/trocador.png');
 
-  static const all = ExchangeProviderDescription(title: 'All trades', raw: 6, image: '');
+  static const exolix =
+      ExchangeProviderDescription(title: 'Exolix', raw: 6, image: 'assets/images/exolix.png');
+
+  static const all = ExchangeProviderDescription(title: 'All trades', raw: 7, image: '');
 
   static ExchangeProviderDescription deserialize({required int raw}) {
     switch (raw) {
@@ -41,6 +44,8 @@ class ExchangeProviderDescription extends EnumerableItem<int> with Serializable<
       case 5:
         return trocador;
       case 6:
+        return exolix;
+      case 7:
         return all;
       default:
         throw Exception('Unexpected token: $raw for ExchangeProviderDescription deserialize');

lib/exchange/exolix/exolix_exchange_provider.dart

@@ -0,0 +1,295 @@
+import 'dart:convert';
+import 'package:cake_wallet/exchange/trade_not_found_exeption.dart';
+import 'package:http/http.dart';
+import 'package:cake_wallet/.secrets.g.dart' as secrets;
+import 'package:cw_core/crypto_currency.dart';
+import 'package:cake_wallet/exchange/exchange_pair.dart';
+import 'package:cake_wallet/exchange/exchange_provider.dart';
+import 'package:cake_wallet/exchange/limits.dart';
+import 'package:cake_wallet/exchange/trade.dart';
+import 'package:cake_wallet/exchange/trade_request.dart';
+import 'package:cake_wallet/exchange/trade_state.dart';
+import 'package:cake_wallet/exchange/exolix/exolix_request.dart';
+import 'package:cake_wallet/exchange/exchange_provider_description.dart';
+
+class ExolixExchangeProvider extends ExchangeProvider {
+  ExolixExchangeProvider() : super(pairList: _supportedPairs());
+
+  static final apiKey = secrets.exolixApiKey;
+  static const apiBaseUrl = 'exolix.com';
+  static const transactionsPath = '/api/v2/transactions';
+  static const ratePath = '/api/v2/rate';
+
+  static const List<CryptoCurrency> _notSupported = [
+    CryptoCurrency.usdt,
+    CryptoCurrency.xhv,
+    CryptoCurrency.btt,
+    CryptoCurrency.firo,
+    CryptoCurrency.zaddr,
+    CryptoCurrency.xvg,
+    CryptoCurrency.kmd,
+    CryptoCurrency.paxg,
+    CryptoCurrency.rune,
+    CryptoCurrency.scrt,
+    CryptoCurrency.btcln,
+    CryptoCurrency.cro,
+    CryptoCurrency.ftm,
+    CryptoCurrency.frax,
+    CryptoCurrency.gusd,
+    CryptoCurrency.gtc,
+    CryptoCurrency.weth,
+  ];
+
+  static List<ExchangePair> _supportedPairs() {
+    final supportedCurrencies =
+        CryptoCurrency.all.where((element) => !_notSupported.contains(element)).toList();
+
+    return supportedCurrencies
+        .map((i) => supportedCurrencies.map((k) => ExchangePair(from: i, to: k, reverse: true)))
+        .expand((i) => i)
+        .toList();
+  }
+
+  @override
+  String get title => 'Exolix';
+
+  @override
+  bool get isAvailable => true;
+
+  @override
+  bool get isEnabled => true;
+
+  @override
+  bool get supportsFixedRate => true;
+
+  @override
+  ExchangeProviderDescription get description => ExchangeProviderDescription.exolix;
+
+  @override
+  Future<bool> checkIsAvailable() async => true;
+
+  static String getRateType(bool isFixedRate) => isFixedRate ? 'fixed' : 'float';
+
+  @override
+  Future<Limits> fetchLimits(
+      {required CryptoCurrency from,
+      required CryptoCurrency to,
+      required bool isFixedRateMode}) async {
+    final params = <String, String>{
+      'rateType': getRateType(isFixedRateMode),
+      'amount': '1',
+    };
+    if (isFixedRateMode) {
+      params['coinFrom'] = _normalizeCurrency(to);
+      params['coinTo'] = _normalizeCurrency(from);
+      params['networkFrom'] = _networkFor(to);
+      params['networkTo'] = _networkFor(from);
+    } else {
+      params['coinFrom'] = _normalizeCurrency(from);
+      params['coinTo'] = _normalizeCurrency(to);
+      params['networkFrom'] = _networkFor(from);
+      params['networkTo'] = _networkFor(to);
+    }
+    final uri = Uri.https(apiBaseUrl, ratePath, params);
+    final response = await get(uri);
+
+    if (response.statusCode != 200) {
+      throw Exception('Unexpected http status: ${response.statusCode}');
+    }
+
+    final responseJSON = json.decode(response.body) as Map<String, dynamic>;
+    return Limits(min: responseJSON['minAmount'] as double?);
+  }
+
+  @override
+  Future<Trade> createTrade({required TradeRequest request, required bool isFixedRateMode}) async {
+    final _request = request as ExolixRequest;
+
+    final headers = {'Content-Type': 'application/json'};
+    final body = <String, dynamic>{
+      'coinFrom': _normalizeCurrency(_request.from),
+      'coinTo':  _normalizeCurrency(_request.to),
+      'networkFrom': _networkFor(_request.from),
+      'networkTo': _networkFor(_request.to),
+      'withdrawalAddress': _request.address,
+      'refundAddress': _request.refundAddress,
+      'rateType': getRateType(isFixedRateMode),
+      'apiToken': apiKey,
+    };
+
+    if (isFixedRateMode) {
+      body['withdrawalAmount'] = _request.toAmount;
+    } else {
+      body['amount'] = _request.fromAmount;
+    }
+
+    final uri = Uri.https(apiBaseUrl, transactionsPath);
+    final response = await post(uri, headers: headers, body: json.encode(body));
+
+    if (response.statusCode == 400) {
+      final responseJSON = json.decode(response.body) as Map<String, dynamic>;
+      final errors = responseJSON['errors'] as Map<String, String>;
+      final errorMessage = errors.values.join(', ');
+      throw Exception(errorMessage);
+    }
+
+    if (response.statusCode != 200 && response.statusCode != 201) {
+      throw Exception('Unexpected http status: ${response.statusCode}');
+    }
+
+    final responseJSON = json.decode(response.body) as Map<String, dynamic>;
+    final id = responseJSON['id'] as String;
+    final inputAddress = responseJSON['depositAddress'] as String;
+    final refundAddress = responseJSON['refundAddress'] as String?;
+    final extraId = responseJSON['depositExtraId'] as String?;
+    final payoutAddress = responseJSON['withdrawalAddress'] as String;
+    final amount = responseJSON['amount'].toString();
+
+    return Trade(
+        id: id,
+        from: _request.from,
+        to: _request.to,
+        provider: description,
+        inputAddress: inputAddress,
+        refundAddress: refundAddress,
+        extraId: extraId,
+        createdAt: DateTime.now(),
+        amount: amount,
+        state: TradeState.created,
+        payoutAddress: payoutAddress);
+  }
+
+  @override
+  Future<Trade> findTradeById({required String id}) async {
+    final findTradeByIdPath = transactionsPath + '/$id';
+    final uri = Uri.https(apiBaseUrl, findTradeByIdPath);
+    final response = await get(uri);
+
+    if (response.statusCode == 404) {
+      throw TradeNotFoundException(id, provider: description);
+    }
+
+    if (response.statusCode == 400) {
+      final responseJSON = json.decode(response.body) as Map<String, dynamic>;
+      final errors = responseJSON['errors'] as Map<String, String>;
+      final errorMessage = errors.values.join(', ');
+
+      throw TradeNotFoundException(id, provider: description, description: errorMessage);
+    }
+
+    if (response.statusCode != 200) {
+      throw Exception('Unexpected http status: ${response.statusCode}');
+    }
+
+    final responseJSON = json.decode(response.body) as Map<String, dynamic>;
+    final coinFrom = responseJSON['coinFrom']['coinCode'] as String;
+    final from = CryptoCurrency.fromString(coinFrom);
+    final coinTo = responseJSON['coinTo']['coinCode'] as String;
+    final to = CryptoCurrency.fromString(coinTo);
+    final inputAddress = responseJSON['depositAddress'] as String;
+    final amount = responseJSON['amount'].toString();
+    final status = responseJSON['status'] as String;
+    final state = TradeState.deserialize(raw: _prepareStatus(status));
+    final extraId = responseJSON['depositExtraId'] as String?;
+    final outputTransaction = responseJSON['hashOut']['hash'] as String?;
+    final payoutAddress = responseJSON['withdrawalAddress'] as String;
+
+    return Trade(
+        id: id,
+        from: from,
+        to: to,
+        provider: description,
+        inputAddress: inputAddress,
+        amount: amount,
+        state: state,
+        extraId: extraId,
+        outputTransaction: outputTransaction,
+        payoutAddress: payoutAddress);
+  }
+
+  @override
+  Future<double> fetchRate(
+      {required CryptoCurrency from,
+      required CryptoCurrency to,
+      required double amount,
+      required bool isFixedRateMode,
+      required bool isReceiveAmount}) async {
+    try {
+      if (amount == 0) {
+        return 0.0;
+      }
+
+      final params = <String, String>{
+        'coinFrom': _normalizeCurrency(from),
+        'coinTo': _normalizeCurrency(to),
+        'networkFrom': _networkFor(from),
+        'networkTo': _networkFor(to),
+        'rateType': getRateType(isFixedRateMode),
+        'apiToken': apiKey,
+      };
+
+      if (isReceiveAmount) {
+        params['withdrawalAmount'] = amount.toString();
+      } else {
+        params['amount'] = amount.toString();
+      }
+
+      final uri = Uri.https(apiBaseUrl, ratePath, params);
+      final response = await get(uri);
+      final responseJSON = json.decode(response.body) as Map<String, dynamic>;
+
+      if (response.statusCode != 200) {
+        final message = responseJSON['message'] as String?;
+        throw Exception(message);
+      }
+
+      final rate = responseJSON['rate'] as double;
+
+      return rate;
+    } catch (e) {
+      print(e.toString());
+      return 0.0;
+    }
+  }
+
+  String _prepareStatus(String status) {
+    switch (status) {
+      case 'deleted':
+      case 'error':
+        return 'overdue';
+      default:
+        return status;
+    }
+  }
+
+  String _networkFor(CryptoCurrency currency) {
+    switch (currency) {
+      case CryptoCurrency.arb:
+        return 'ARBITRUM';
+      default:
+        return currency.tag != null ? _normalizeTag(currency.tag!) : currency.title;
+    }
+  }
+
+  String _normalizeCurrency(CryptoCurrency currency) {
+    switch (currency) {
+      case CryptoCurrency.nano:
+        return 'XNO';
+      case CryptoCurrency.bttc:
+        return 'BTT';
+      case CryptoCurrency.zec:
+        return 'ZEC';
+      default:
+        return currency.title;
+    }
+  }
+
+  String _normalizeTag(String tag) {
+    switch (tag) {
+      case 'POLY':
+        return 'Polygon';
+      default:
+        return tag;
+    }
+  }
+}

lib/exchange/exolix/exolix_request.dart

@@ -0,0 +1,20 @@
+import 'package:flutter/foundation.dart';
+import 'package:cw_core/crypto_currency.dart';
+import 'package:cake_wallet/exchange/trade_request.dart';
+
+class ExolixRequest extends TradeRequest {
+  ExolixRequest(
+      {required this.from,
+      required this.to,
+      required this.address,
+      required this.fromAmount,
+      required this.toAmount,
+      required this.refundAddress});
+
+  CryptoCurrency from;
+  CryptoCurrency to;
+  String address;
+  String fromAmount;
+  String toAmount;
+  String refundAddress;
+}

lib/exchange/trade_state.dart

@@ -35,6 +35,15 @@ class TradeState extends EnumerableItem<String> with Serializable<String> {
   static const completed = TradeState(raw: 'completed', title: 'Completed');
   static const settling = TradeState(raw: 'settling', title: 'Settlement in progress');
   static const settled = TradeState(raw: 'settled', title: 'Settlement completed');
+  static const wait = TradeState(raw: 'wait', title: 'Waiting');
+  static const overdue = TradeState(raw: 'overdue', title: 'Overdue');
+  static const refund = TradeState(raw: 'refund', title: 'Refund');
+  static const refunded = TradeState(raw: 'refunded', title: 'Refunded');
+  static const confirmation = TradeState(raw: 'confirmation', title: 'Confirmation');
+  static const confirmed = TradeState(raw: 'confirmed', title: 'Confirmed');
+  static const exchanging = TradeState(raw: 'exchanging', title: 'Exchanging');
+  static const sending = TradeState(raw: 'sending', title: 'Sending');
+  static const success = TradeState(raw: 'success', title: 'Success');
   static TradeState deserialize({required String raw}) {
     switch (raw) {
       case 'pending':
@@ -77,6 +86,24 @@ class TradeState extends EnumerableItem<String> with Serializable<String> {
         return failed;
       case 'completed':
         return completed;
+      case 'wait':
+        return wait;
+      case 'overdue':
+        return overdue;
+      case 'refund':
+        return refund;
+      case 'refunded':
+        return refunded;
+      case 'confirmation':
+        return confirmation;
+      case 'confirmed':
+        return confirmed;
+      case 'exchanging':
+        return exchanging;
+      case 'sending':
+        return sending;
+      case 'success':
+        return success;
       default:
         throw Exception('Unexpected token: $raw in TradeState deserialize');
     }

lib/src/screens/dashboard/widgets/trade_row.dart

@@ -94,6 +94,9 @@ class TradeRow extends StatelessWidget {
             borderRadius: BorderRadius.circular(50),
             child: Image.asset('assets/images/trocador.png', width: 36, height: 36));
         break;
+      case ExchangeProviderDescription.exolix:
+        image = Image.asset('assets/images/exolix.png', width: 36, height: 36);
+        break;
       default:
         image = null;
     }

lib/store/dashboard/trade_filter_store.dart

@@ -13,7 +13,8 @@ abstract class TradeFilterStoreBase with Store {
         displaySideShift = true,
         displayMorphToken = true,
         displaySimpleSwap = true,
-        displayTrocador = true;
+        displayTrocador = true,
+        displayExolix = true;
 
   @observable
   bool displayXMRTO;
@@ -33,8 +34,11 @@ abstract class TradeFilterStoreBase with Store {
   @observable
   bool displayTrocador;
 
+  @observable
+  bool displayExolix;
+
   @computed
-  bool get displayAllTrades => displayChangeNow && displaySideShift && displaySimpleSwap && displayTrocador;
+  bool get displayAllTrades => displayChangeNow && displaySideShift && displaySimpleSwap && displayTrocador && displayExolix;
 
   @action
   void toggleDisplayExchange(ExchangeProviderDescription provider) {
@@ -57,6 +61,9 @@ abstract class TradeFilterStoreBase with Store {
       case ExchangeProviderDescription.trocador:
         displayTrocador = !displayTrocador;
         break;
+      case ExchangeProviderDescription.exolix:
+        displayExolix = !displayExolix;
+        break;
       case ExchangeProviderDescription.all:
         if (displayAllTrades) {
           displayChangeNow = false;
@@ -65,6 +72,7 @@ abstract class TradeFilterStoreBase with Store {
           displayMorphToken = false;
           displaySimpleSwap = false;
           displayTrocador = false;
+          displayExolix = false;
         } else {
           displayChangeNow = true;
           displaySideShift = true;
@@ -72,6 +80,7 @@ abstract class TradeFilterStoreBase with Store {
           displayMorphToken = true;
           displaySimpleSwap = true;
           displayTrocador = true;
+          displayExolix = true;
         }
         break;
     }
@@ -98,7 +107,8 @@ abstract class TradeFilterStoreBase with Store {
         ||(displaySimpleSwap &&
             item.trade.provider ==
                 ExchangeProviderDescription.simpleSwap)
-        ||(displayTrocador && item.trade.provider == ExchangeProviderDescription.trocador))
+        ||(displayTrocador && item.trade.provider == ExchangeProviderDescription.trocador)
+        ||(displayExolix && item.trade.provider == ExchangeProviderDescription.exolix))
         .toList()
         : _trades;
   }

lib/view_model/dashboard/dashboard_view_model.dart

@@ -98,6 +98,11 @@ abstract class DashboardViewModelBase with Store {
             caption: ExchangeProviderDescription.trocador.title,
             onChanged: () => tradeFilterStore
                 .toggleDisplayExchange(ExchangeProviderDescription.trocador)),
+        FilterItem(
+            value: () => tradeFilterStore.displayExolix,
+            caption: ExchangeProviderDescription.exolix.title,
+            onChanged: () => tradeFilterStore
+                .toggleDisplayExchange(ExchangeProviderDescription.exolix)),
       ]
     },
     subname = '',

lib/view_model/exchange/exchange_trade_view_model.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'package:cake_wallet/exchange/exolix/exolix_exchange_provider.dart';
 import 'package:cake_wallet/exchange/sideshift/sideshift_exchange_provider.dart';
 import 'package:cake_wallet/exchange/simpleswap/simpleswap_exchange_provider.dart';
 import 'package:cake_wallet/exchange/trocador/trocador_exchange_provider.dart';
@@ -53,6 +54,9 @@ abstract class ExchangeTradeViewModelBase with Store {
       case ExchangeProviderDescription.trocador:
         _provider = TrocadorExchangeProvider();
         break;
+      case ExchangeProviderDescription.exolix:
+        _provider = ExolixExchangeProvider();
+        break;
     }
 
     _updateItems();

lib/view_model/exchange/exchange_view_model.dart

@@ -6,6 +6,8 @@ import 'package:cake_wallet/core/wallet_change_listener_view_model.dart';
 import 'package:cake_wallet/entities/exchange_api_mode.dart';
 import 'package:cake_wallet/entities/preferences_key.dart';
 import 'package:cake_wallet/entities/wallet_contact.dart';
+import 'package:cake_wallet/exchange/exolix/exolix_exchange_provider.dart';
+import 'package:cake_wallet/exchange/exolix/exolix_request.dart';
 import 'package:cake_wallet/exchange/sideshift/sideshift_exchange_provider.dart';
 import 'package:cake_wallet/exchange/sideshift/sideshift_request.dart';
 import 'package:cake_wallet/exchange/simpleswap/simpleswap_exchange_provider.dart';
@@ -150,6 +152,7 @@ abstract class ExchangeViewModelBase extends WalletChangeListenerViewModel with
         SideShiftExchangeProvider(),
         SimpleSwapExchangeProvider(),
         TrocadorExchangeProvider(useTorOnly: _useTorOnly),
+        ExolixExchangeProvider(),
       ];
 
   @observable
@@ -546,6 +549,17 @@ abstract class ExchangeViewModelBase extends WalletChangeListenerViewModel with
           amount = isFixedRateMode ? receiveAmount : depositAmount;
         }
 
+        if (provider is ExolixExchangeProvider) {
+          request = ExolixRequest(
+              from: depositCurrency,
+              to: receiveCurrency,
+              fromAmount: depositAmount.replaceAll(',', '.'),
+              toAmount: receiveAmount.replaceAll(',', '.'),
+              refundAddress: depositAddress,
+              address: receiveAddress);
+          amount = isFixedRateMode ? receiveAmount : depositAmount;
+        }
+
         amount = amount.replaceAll(',', '.');
 
         if (limitsState is LimitsLoadedSuccessfully) {

lib/view_model/support_view_model.dart

@@ -53,6 +53,11 @@ abstract class SupportViewModelBase with Store {
         icon: 'assets/images/simpleSwap.png',
         linkTitle: 'support@simpleswap.io',
         link: 'mailto:support@simpleswap.io'),
+    LinkListItem(
+        title: 'Exolix',
+        icon: 'assets/images/exolix.png',
+        linkTitle: 'support@exolix.com',
+        link: 'mailto:support@exolix.com'),
       if (!isMoneroOnly) ... [    
          LinkListItem(
      title: 'Wyre',

lib/view_model/trade_details_view_model.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 import 'package:cake_wallet/exchange/changenow/changenow_exchange_provider.dart';
 import 'package:cake_wallet/exchange/exchange_provider.dart';
 import 'package:cake_wallet/exchange/exchange_provider_description.dart';
+import 'package:cake_wallet/exchange/exolix/exolix_exchange_provider.dart';
 import 'package:cake_wallet/exchange/morphtoken/morphtoken_exchange_provider.dart';
 import 'package:cake_wallet/exchange/sideshift/sideshift_exchange_provider.dart';
 import 'package:cake_wallet/exchange/simpleswap/simpleswap_exchange_provider.dart';
@@ -54,6 +55,9 @@ abstract class TradeDetailsViewModelBase with Store {
       case ExchangeProviderDescription.trocador:
         _provider = TrocadorExchangeProvider();
         break;
+      case ExchangeProviderDescription.exolix:
+        _provider = ExolixExchangeProvider();
+        break;
     }
 
     _updateItems();
@@ -157,6 +161,12 @@ abstract class TradeDetailsViewModelBase with Store {
         items.add(StandartListItem(
             title: '${trade.providerName} ${S.current.password}', value: trade.password ?? ''));
     }
+
+    if (trade.provider == ExchangeProviderDescription.exolix) {
+      final buildURL = 'https://exolix.com/transaction/${trade.id.toString()}';
+      items.add(
+        TrackTradeListItem(title: 'Track', value: buildURL, onTap: () => _launchUrl(buildURL)));
+    }
   }
 
   void _launchUrl(String url) {

tool/utils/secret_key.dart

@@ -32,6 +32,7 @@ class SecretKey {
     SecretKey('fiatApiKey', () => ''),
     SecretKey('payfuraApiKey', () => ''),
     SecretKey('chatwootWebsiteToken', () => ''),
+    SecretKey('exolixApiKey', () => ''),
     SecretKey('robinhoodApplicationId', () => ''),
     SecretKey('robinhoodCIdApiSecret', () => ''),
     SecretKey('walletConnectProjectId', () => ''),