feat: ZHTLC support

.gitmodules

@@ -1,7 +1,7 @@
 [submodule "sdk"]
 	path = sdk
 	url = https://github.com/KomodoPlatform/komodo-defi-sdk-flutter.git
-	branch = dev
+	branch = bugfix/zhltc-activation-fixes
 	update = checkout
 	fetchRecurseSubmodules = on-demand
 	ignore = dirty

assets/translations/en.json

@@ -360,7 +360,6 @@
   "backupSeedPhrase": "Backup seed phrase",
   "seedOr": "OR",
   "seedDownload": "Download seed phrase",
-  "seedSaveAndRemember": "Save and remember",
   "seedIntroWarning": "This phrase is the main access to your\nassets, save and never share this phrase",
   "seedSettings": "Seed phrase",
   "errorDescription": "Error description",
@@ -460,6 +459,7 @@
   "withdrawAmountTooLowError": "{} {} too low, you need > {} {} to send",
   "withdrawNoSuchCoinError": "Invalid selection, {} does not exist",
   "withdrawPreview": "Preview Withdrawal",
+  "withdrawPreviewZhtlcNote": "ZHTLC transactions can take a while to generate.\nPlease stay on this page until the preview is ready, otherwise you will need to start over.",
   "withdrawPreviewError": "Error occurred while fetching withdrawal preview",
   "txHistoryFetchError": "Error fetching tx history from the endpoint. Unsupported type: {}",
   "txHistoryNoTransactions": "Transactions are not available",
@@ -764,5 +764,27 @@
   "fetchingPrivateKeysTitle": "Fetching Private Keys...",
   "fetchingPrivateKeysMessage": "Please wait while we securely fetch your private keys...",
   "pubkeyType": "Type",
-  "securitySettings": "Security Settings"
+  "securitySettings": "Security Settings",
+  "zhtlcConfigureTitle": "Configure {}",
+  "zhtlcZcashParamsPathLabel": "Zcash parameters path",
+  "zhtlcPathAutomaticallyDetected": "Path automatically detected",
+  "zhtlcSaplingParamsFolder": "Folder containing sapling params",
+  "zhtlcBlocksPerIterationLabel": "Blocks per iteration",
+  "zhtlcScanIntervalLabel": "Scan interval (ms)",
+  "zhtlcStartSyncFromLabel": "Start sync from:",
+  "zhtlcEarliestSaplingOption": "Earliest (sapling)",
+  "zhtlcBlockHeightOption": "Block height",
+  "zhtlcDateTimeOption": "Date & Time",
+  "zhtlcSelectDateTimeLabel": "Select date & time",
+  "zhtlcZcashParamsRequired": "Zcash params path is required",
+  "zhtlcInvalidBlockHeight": "Enter a valid block height",
+  "zhtlcSelectDateTimeRequired": "Please select a date and time",
+  "zhtlcDownloadingZcashParams": "Downloading Zcash Parameters",
+  "zhtlcPreparingDownload": "Preparing download...",
+  "zhtlcErrorSettingUpZcash": "Error setting up Zcash parameters: {}",
+  "zhtlcDateSyncHint": "Selecting a date further in the past can significantly increase the activation time. \nActivation can take a little while the first time to download block cache data.\n\nTransactions and balance prior to the sync date may be missing.\nOften this can be restored by sending in and out new transactions",
+  "activatingZhtlcCoins": {
+    "one": "Activating ZHTLC coin: {}. Please do not close the app or tab until complete.",
+    "other": "Activating ZHTLC coins: {}. Please do not close the app or tab until complete."
+  }
 }

lib/app_config/app_config.dart

@@ -107,15 +107,8 @@ const Set<String> excludedAssetList = {
   'FENIX',
   'AWR',
   'BOT',
-  // Pirate activation params are not yet implemented, so we need to
-  // exclude it from the list of coins for now.
-  'ARRR',
-  'ZOMBIE',
   'SMTF-v2',
   'SFUSD',
-  'VOTE2023',
-  'RICK',
-  'MORTY',
 
   // NFT v2 coins: https://github.com/KomodoPlatform/coins/pull/1061 will be
   // used in the background, so users do not need to see them.

lib/bloc/app_bloc_root.dart

@@ -171,7 +171,7 @@ class AppBlocRoot extends StatelessWidget {
             dexRepository: dexRepository,
           ),
         ),
-        RepositoryProvider(create: (_) => OrderbookBloc(api: mm2Api)),
+        RepositoryProvider(create: (_) => OrderbookBloc(sdk: komodoDefiSdk)),
         RepositoryProvider(create: (_) => myOrdersService),
         RepositoryProvider(
           create: (_) => KmdRewardsBloc(coinsRepository, mm2Api),

lib/bloc/assets_overview/bloc/asset_overview_bloc.dart

@@ -9,6 +9,7 @@ import 'package:web_dex/bloc/cex_market_data/profit_loss/models/fiat_value.dart'
 import 'package:web_dex/bloc/cex_market_data/profit_loss/models/profit_loss.dart';
 import 'package:web_dex/bloc/cex_market_data/profit_loss/profit_loss_repository.dart';
 import 'package:web_dex/bloc/cex_market_data/sdk_auth_activation_extension.dart';
+import 'package:web_dex/bloc/coins_bloc/asset_coin_extension.dart';
 import 'package:web_dex/model/coin.dart';
 
 part 'asset_overview_event.dart';
@@ -95,7 +96,12 @@ class AssetOverviewBloc extends Bloc<AssetOverviewEvent, AssetOverviewState> {
 
       await _sdk.waitForEnabledCoinsToPassThreshold(event.coins);
 
-      final profitLossesFutures = event.coins.map((coin) async {
+      final activeCoins = await event.coins.removeInactiveCoins(_sdk);
+      if (activeCoins.isEmpty) {
+        return;
+      }
+
+      final profitLossesFutures = activeCoins.map((coin) async {
         // Catch errors that occur for single coins and exclude them from the
         // total so that transaction fetching errors for a single coin do not
         // affect the total investment calculation.
@@ -114,7 +120,7 @@ class AssetOverviewBloc extends Bloc<AssetOverviewEvent, AssetOverviewState> {
       final profitLosses = await Future.wait(profitLossesFutures);
 
       final totalInvestment = await _investmentRepository
-          .calculateTotalInvestment(event.walletId, event.coins);
+          .calculateTotalInvestment(event.walletId, activeCoins);
 
       final profitAmount = profitLosses.fold(0.0, (sum, item) {
         return sum + (item.lastOrNull?.profitLoss ?? 0.0);

lib/bloc/cex_market_data/portfolio_growth/portfolio_growth_bloc.dart

@@ -10,6 +10,7 @@ import 'package:rational/rational.dart';
 import 'package:web_dex/bloc/cex_market_data/charts.dart';
 import 'package:web_dex/bloc/cex_market_data/portfolio_growth/portfolio_growth_repository.dart';
 import 'package:web_dex/bloc/cex_market_data/sdk_auth_activation_extension.dart';
+import 'package:web_dex/bloc/coins_bloc/asset_coin_extension.dart';
 import 'package:web_dex/mm2/mm2_api/rpc/base.dart';
 import 'package:web_dex/model/coin.dart';
 import 'package:web_dex/model/text_error.dart';
@@ -55,8 +56,13 @@ class PortfolioGrowthBloc
     PortfolioGrowthPeriodChanged event,
     Emitter<PortfolioGrowthState> emit,
   ) {
-    final (int totalCoins, int coinsWithKnownBalance, int coinsWithKnownBalanceAndFiat) =
-        _calculateCoinProgressCounters(event.coins);
+    final (
+      int totalCoins,
+      int coinsWithKnownBalance,
+      int coinsWithKnownBalanceAndFiat,
+    ) = _calculateCoinProgressCounters(
+      event.coins,
+    );
     final currentState = state;
     if (currentState is PortfolioGrowthChartLoadSuccess) {
       emit(
@@ -120,7 +126,9 @@ class PortfolioGrowthBloc
           int totalCoins,
           int coinsWithKnownBalance,
           int coinsWithKnownBalanceAndFiat,
-        ) = _calculateCoinProgressCounters(event.coins);
+        ) = _calculateCoinProgressCounters(
+          event.coins,
+        );
         return emit(
           PortfolioGrowthChartUnsupported(
             selectedPeriod: event.selectedPeriod,
@@ -131,8 +139,9 @@ class PortfolioGrowthBloc
         );
       }
 
+      final initialActiveCoins = await coins.removeInactiveCoins(_sdk);
       await _loadChart(
-        coins,
+        initialActiveCoins,
         event,
         useCache: true,
       ).then(emit.call).catchError((Object error, StackTrace stackTrace) {
@@ -149,7 +158,7 @@ class PortfolioGrowthBloc
 
       // Only remove inactivate/activating coins after an attempt to load the
       // cached chart, as the cached chart may contain inactive coins.
-      final activeCoins = await _removeInactiveCoins(coins);
+      final activeCoins = await coins.removeInactiveCoins(_sdk);
       if (activeCoins.isNotEmpty) {
         await _loadChart(
           activeCoins,
@@ -190,7 +199,9 @@ class PortfolioGrowthBloc
           int totalCoins,
           int coinsWithKnownBalance,
           int coinsWithKnownBalanceAndFiat,
-        ) = _calculateCoinProgressCounters(event.coins);
+        ) = _calculateCoinProgressCounters(
+          event.coins,
+        );
         emit(
           GrowthChartLoadFailure(
             error: TextError(error: 'Failed to load portfolio growth'),
@@ -238,8 +249,13 @@ class PortfolioGrowthBloc
     final totalChange24h = await _calculateTotalChange24h(coins);
     final percentageChange24h = await _calculatePercentageChange24h(coins);
 
-    final (int totalCoins, int coinsWithKnownBalance, int coinsWithKnownBalanceAndFiat) =
-        _calculateCoinProgressCounters(event.coins);
+    final (
+      int totalCoins,
+      int coinsWithKnownBalance,
+      int coinsWithKnownBalanceAndFiat,
+    ) = _calculateCoinProgressCounters(
+      event.coins,
+    );
 
     return PortfolioGrowthChartLoadSuccess(
       portfolioGrowth: chart,
@@ -261,7 +277,7 @@ class PortfolioGrowthBloc
     // Do not let transaction loading exceptions stop the periodic updates
     try {
       final supportedCoins = await _removeUnsupportedCoins(event);
-      final coins = await _removeInactiveCoins(supportedCoins);
+      final coins = await supportedCoins.removeInactiveCoins(_sdk);
       return await _portfolioGrowthRepository.getPortfolioGrowthChart(
         coins,
         fiatCoinId: event.fiatCoinId,
@@ -274,18 +290,6 @@ class PortfolioGrowthBloc
     }
   }
 
-  Future<List<Coin>> _removeInactiveCoins(List<Coin> coins) async {
-    final coinsCopy = List<Coin>.of(coins);
-    final activeCoins = await _sdk.assets.getActivatedAssets();
-    final activeCoinsMap = activeCoins.map((e) => e.id).toSet();
-    for (final coin in coins) {
-      if (!activeCoinsMap.contains(coin.id)) {
-        coinsCopy.remove(coin);
-      }
-    }
-    return coinsCopy;
-  }
-
   Future<PortfolioGrowthState> _handlePortfolioGrowthUpdate(
     ChartData growthChart,
     Duration selectedPeriod,
@@ -300,8 +304,13 @@ class PortfolioGrowthBloc
     final totalChange24h = await _calculateTotalChange24h(coins);
     final percentageChange24h = await _calculatePercentageChange24h(coins);
 
-    final (int totalCoins, int coinsWithKnownBalance, int coinsWithKnownBalanceAndFiat) =
-        _calculateCoinProgressCounters(coins);
+    final (
+      int totalCoins,
+      int coinsWithKnownBalance,
+      int coinsWithKnownBalanceAndFiat,
+    ) = _calculateCoinProgressCounters(
+      coins,
+    );
 
     return PortfolioGrowthChartLoadSuccess(
       portfolioGrowth: growthChart,

lib/bloc/cex_market_data/profit_loss/profit_loss_bloc.dart

@@ -9,6 +9,7 @@ import 'package:logging/logging.dart';
 import 'package:web_dex/bloc/cex_market_data/charts.dart';
 import 'package:web_dex/bloc/cex_market_data/profit_loss/profit_loss_repository.dart';
 import 'package:web_dex/bloc/cex_market_data/sdk_auth_activation_extension.dart';
+import 'package:web_dex/bloc/coins_bloc/asset_coin_extension.dart';
 import 'package:web_dex/mm2/mm2_api/rpc/base.dart';
 import 'package:web_dex/model/coin.dart';
 import 'package:web_dex/model/text_error.dart';
@@ -51,6 +52,7 @@ class ProfitLossBloc extends Bloc<ProfitLossEvent, ProfitLossState> {
         event.coins,
         event.fiatCoinId,
       );
+      final initialActiveCoins = await supportedCoins.removeInactiveCoins(_sdk);
       // Charts for individual coins (coin details) are parsed here as well,
       // and should be hidden if not supported.
       if (supportedCoins.isEmpty && event.coins.length <= 1) {
@@ -63,7 +65,7 @@ class ProfitLossBloc extends Bloc<ProfitLossEvent, ProfitLossState> {
 
       await _getProfitLossChart(
         event,
-        supportedCoins,
+        initialActiveCoins,
         useCache: true,
       ).then(emit.call).catchError((Object error, StackTrace stackTrace) {
         const errorMessage = 'Failed to load CACHED portfolio profit/loss';
@@ -74,7 +76,7 @@ class ProfitLossBloc extends Bloc<ProfitLossEvent, ProfitLossState> {
 
       // Fetch the un-cached version of the chart to update the cache.
       await _sdk.waitForEnabledCoinsToPassThreshold(supportedCoins);
-      final activeCoins = await _removeInactiveCoins(supportedCoins);
+      final activeCoins = await supportedCoins.removeInactiveCoins(_sdk);
       if (activeCoins.isNotEmpty) {
         await _getProfitLossChart(
           event,
@@ -232,16 +234,4 @@ class ProfitLossBloc extends Bloc<ProfitLossEvent, ProfitLossState> {
     chartsList.removeWhere((element) => element.isEmpty);
     return Charts.merge(chartsList)..sort((a, b) => a.x.compareTo(b.x));
   }
-
-  Future<List<Coin>> _removeInactiveCoins(List<Coin> coins) async {
-    final coinsCopy = List<Coin>.of(coins);
-    final activeCoins = await _sdk.assets.getActivatedAssets();
-    final activeCoinsMap = activeCoins.map((e) => e.id).toSet();
-    for (final coin in coins) {
-      if (!activeCoinsMap.contains(coin.id)) {
-        coinsCopy.remove(coin);
-      }
-    }
-    return coinsCopy;
-  }
 }

lib/bloc/coins_bloc/asset_coin_extension.dart

@@ -5,6 +5,7 @@ import 'package:komodo_defi_types/komodo_defi_types.dart';
 import 'package:web_dex/app_config/app_config.dart';
 import 'package:web_dex/model/coin.dart';
 import 'package:web_dex/model/coin_type.dart';
+import 'package:web_dex/shared/utils/extensions/collection_extensions.dart';
 
 extension AssetCoinExtension on Asset {
   Coin toCoin() {
@@ -15,7 +16,7 @@ extension AssetCoinExtension on Asset {
     final logoImageUrl = config.valueOrNull<String>('logo_image_url');
     final isCustomToken =
         (config.valueOrNull<bool>('is_custom_token') ?? false) ||
-            logoImageUrl != null;
+        logoImageUrl != null;
 
     final ProtocolData protocolData = ProtocolData(
       platform: id.parentId?.id ?? platform ?? '',
@@ -38,8 +39,9 @@ extension AssetCoinExtension on Asset {
       isTestCoin: protocol.isTestnet,
       coingeckoId: id.symbol.coinGeckoId,
       swapContractAddress: config.valueOrNull<String>('swap_contract_address'),
-      fallbackSwapContract:
-          config.valueOrNull<String>('fallback_swap_contract'),
+      fallbackSwapContract: config.valueOrNull<String>(
+        'fallback_swap_contract',
+      ),
       priority: priorityCoinsAbbrMap[id.id] ?? 0,
       state: CoinState.inactive,
       walletOnly: config.valueOrNull<bool>('wallet_only') ?? false,
@@ -49,8 +51,11 @@ extension AssetCoinExtension on Asset {
     );
   }
 
-  String? get contractAddress => protocol.config
-      .valueOrNull('protocol', 'protocol_data', 'contract_address');
+  String? get contractAddress => protocol.config.valueOrNull(
+    'protocol',
+    'protocol_data',
+    'contract_address',
+  );
   String? get platform =>
       protocol.config.valueOrNull('protocol', 'protocol_data', 'platform');
 }
@@ -96,6 +101,8 @@ extension CoinTypeExtension on CoinSubClass {
         return CoinType.erc20;
       case CoinSubClass.krc20:
         return CoinType.krc20;
+      case CoinSubClass.zhtlc:
+        return CoinType.zhtlc;
       default:
         return CoinType.utxo;
     }
@@ -166,6 +173,8 @@ extension CoinSubClassExtension on CoinType {
         return CoinSubClass.erc20;
       case CoinType.krc20:
         return CoinSubClass.krc20;
+      case CoinType.zhtlc:
+        return CoinSubClass.zhtlc;
     }
   }
 }
@@ -201,10 +210,7 @@ extension AssetBalanceExtension on Coin {
     KomodoDefiSdk sdk, {
     bool activateIfNeeded = true,
   }) {
-    return sdk.balances.watchBalance(
-      id,
-      activateIfNeeded: activateIfNeeded,
-    );
+    return sdk.balances.watchBalance(id, activateIfNeeded: activateIfNeeded);
   }
 
   /// Get the last-known balance for this coin.
@@ -227,3 +233,14 @@ extension AssetBalanceExtension on Coin {
     return (balance * price).spendable.toDouble();
   }
 }
+
+extension CoinListOps on List<Coin> {
+  Future<List<Coin>> removeInactiveCoins(KomodoDefiSdk sdk) async {
+    final activeCoins = await sdk.assets.getActivatedAssets();
+    final activeCoinsMap = activeCoins.map((e) => e.id).toSet();
+
+    return where(
+      (coin) => activeCoinsMap.contains(coin.id),
+    ).unmodifiable().toList();
+  }
+}