hash-wallet/integration_test/flows/onboarding_flows.dart

import "dart:io";

import "package:hash_wallet/entities/seed_type.dart";
import "package:hash_wallet/reactions/wallet_utils.dart";
import "package:cw_core/wallet_type.dart";
import "package:flutter_test/flutter_test.dart";

import "../core/test_config.dart";
import "../core/test_wallets.dart";
import "../robots/create_pin_welcome_page_robot.dart";
import "../robots/lightning_username_page_robot.dart";
import "../robots/new_wallet_page_robot.dart";
import "../robots/new_wallet_type_page_robot.dart";
import "../robots/pre_seed_page_robot.dart";
import "../robots/restore_from_seed_or_key_robot.dart";
import "../robots/restore_options_page_robot.dart";
import "../robots/seed_verification_page_robot.dart";
import "../robots/setup_pin_code_robot.dart";
import "../robots/wallet_group_description_page_robot.dart";
import "../robots/wallet_group_existing_seed_page_robot.dart";
import "../robots/wallet_groups_display_page_robot.dart";
import "../robots/wallet_list_page_robot.dart";
import "../robots/wallet_seed_page_robot.dart";
import "../robots/welcome_page_robot.dart";

class OnboardingFlows {
  OnboardingFlows(this.tester)
      : _welcomePageRobot = WelcomePageRobot(tester),
        _preSeedPageRobot = PreSeedPageRobot(tester),
        _setupPinCodeRobot = SetupPinCodeRobot(tester),
        _newWalletPageRobot = NewWalletPageRobot(tester),
        _walletSeedPageRobot = WalletSeedPageRobot(tester),
        _walletListPageRobot = WalletListPageRobot(tester),
        _newWalletTypePageRobot = NewWalletTypePageRobot(tester),
        _seedVerificationPageRobot = SeedVerificationPageRobot(tester),
        _createPinWelcomePageRobot = CreatePinWelcomePageRobot(tester),
        _restoreOptionsPageRobot = RestoreOptionsPageRobot(tester),
        _restoreFromSeedOrKeysPageRobot = RestoreFromSeedOrKeysPageRobot(tester),
        _lightningUsernamePageRobot = LightningUsernamePageRobot(tester),
        _walletGroupDescriptionPageRobot = WalletGroupDescriptionPageRobot(tester),
        _walletGroupsDisplayPageRobot = WalletGroupsDisplayPageRobot(tester),
        _walletGroupExistingSeedPageRobot = WalletGroupExistingSeedPageRobot(tester);

  final WidgetTester tester;

  final WelcomePageRobot _welcomePageRobot;
  final PreSeedPageRobot _preSeedPageRobot;
  final SetupPinCodeRobot _setupPinCodeRobot;
  final NewWalletPageRobot _newWalletPageRobot;
  final WalletSeedPageRobot _walletSeedPageRobot;
  final WalletListPageRobot _walletListPageRobot;
  final NewWalletTypePageRobot _newWalletTypePageRobot;
  final SeedVerificationPageRobot _seedVerificationPageRobot;
  final CreatePinWelcomePageRobot _createPinWelcomePageRobot;
  final RestoreOptionsPageRobot _restoreOptionsPageRobot;
  final RestoreFromSeedOrKeysPageRobot _restoreFromSeedOrKeysPageRobot;
  final LightningUsernamePageRobot _lightningUsernamePageRobot;
  final WalletGroupDescriptionPageRobot _walletGroupDescriptionPageRobot;
  final WalletGroupsDisplayPageRobot _walletGroupsDisplayPageRobot;
  final WalletGroupExistingSeedPageRobot _walletGroupExistingSeedPageRobot;

  Future<void> createFirstWallet(WalletType type, {List<int>? pin}) async {
    await _createPinWelcomePageRobot.tapSetAPinButton();

    await setupPinCode(pin ?? TestConfig.pin);

    await _welcomePageRobot.navigateToCreateNewWalletPage();

    await _selectWalletType(type);

    if (_welcomePageRobot.hasNewSingleSeedButton()) {
      await _welcomePageRobot.tapNewSingleSeed();
    }

    await _completeWalletCreationSteps(type);
  }

  Future<void> createAdditionalWalletFromWalletList(WalletType type) async {
    tester.printToConsole("Creating ${type.name} wallet");

    await startCreatingWalletFromWalletList(type);

    await _completeWalletCreationSteps(type);
  }

  Future<void> createWalletInGroupOf(WalletType type, String existingWalletName) async {
    tester.printToConsole("Adding a ${type.name} wallet to the seed of $existingWalletName");

    await _walletListPageRobot.navigateToCreateNewWalletPage();

    await _selectWalletType(type);

    await _walletGroupDescriptionPageRobot.isDisplayed();
    await _walletGroupDescriptionPageRobot.navigateToChooseWalletGroup();

    await _walletGroupsDisplayPageRobot.isDisplayed();
    await _walletGroupsDisplayPageRobot.selectWallet(existingWalletName);
    await _walletGroupsDisplayPageRobot.continueWithSelectedSeed();

    await _newWalletPageRobot.isDisplayed();
    await _newWalletPageRobot.generateWalletName();
    await _newWalletPageRobot.onNextButtonPressed();

    await _walletGroupExistingSeedPageRobot.isDisplayed();
    await _walletGroupExistingSeedPageRobot.openWallet();
  }

  Future<void> startCreatingWalletFromWalletList(WalletType type) async {
    await _walletListPageRobot.navigateToCreateNewWalletPage();

    await _selectWalletType(type);

    if (isBIP39Wallet(type)) {
      await _walletGroupDescriptionPageRobot.isDisplayed();
      await _walletGroupDescriptionPageRobot.navigateToCreateNewSeedPage();
    }

    await _newWalletPageRobot.isDisplayed();
  }

  Future<void> restoreFirstWalletFromSeed(
    WalletType type, {
    String? seed,
    String passphrase = "",
    List<int>? pin,
  }) async {
    await startRestoringFirstWallet(type, pin: pin);

    await _restoreFromSeed(type, seed ?? TestWallets.seedFor(type), passphrase);
  }

  Future<void> startRestoringFirstWallet(WalletType type, {List<int>? pin}) async {
    await _createPinWelcomePageRobot.tapSetAPinButton();

    await setupPinCode(pin ?? TestConfig.pin);

    await _welcomePageRobot.navigateToRestoreWalletPage();

    // Desktop skips the restore options page and goes straight to the type list.
    if (!Platform.isLinux) {
      await _restoreOptionsPageRobot.navigateToRestoreFromSeedsOrKeysPage();
    }

    await _selectWalletType(type);

    await _restoreFromSeedOrKeysPageRobot.isDisplayed();
  }

  Future<void> restoreAdditionalWalletFromWalletList(
    WalletType type, {
    String? seed,
    String passphrase = "",
  }) async {
    tester.printToConsole("Restoring ${type.name} wallet");

    await _walletListPageRobot.navigateToRestoreWalletOptionsPage();

    if (!Platform.isLinux) {
      await _restoreOptionsPageRobot.navigateToRestoreFromSeedsOrKeysPage();
    }

    await _selectWalletType(type);

    await _restoreFromSeed(type, seed ?? TestWallets.seedFor(type), passphrase);
  }

  Future<void> _restoreFromSeed(WalletType type, String seed, String passphrase) async {
    await _restoreFromSeedOrKeysPageRobot.selectWalletNameFromAvailableOptions();
    await _restoreFromSeedOrKeysPageRobot.enterSeedPhraseForWalletRestore(seed);

    if (passphrase.isNotEmpty) {
      await _restoreFromSeedOrKeysPageRobot.enablePassphrase();
    }

    // 25 word monero seeds are legacy seeds and need their restore block height entered.
    if (seed.split(" ").length == 25 && type == WalletType.monero) {
      await _restoreFromSeedOrKeysPageRobot
          .chooseSeedTypeForMoneroOrWowneroWallets(MoneroSeedType.legacy);
      await _restoreFromSeedOrKeysPageRobot
          .enterBlockHeightForWalletRestore(TestWallets.moneroRestoreBlockHeight);
    }

    if (type == WalletType.zcash && TestWallets.zcashRestoreHeight.isNotEmpty) {
      await _restoreFromSeedOrKeysPageRobot
          .enterBlockHeightForWalletRestore(TestWallets.zcashRestoreHeight);
    }

    if (Platform.isLinux) {
      final password = TestConfig.pin.join("");
      await _restoreFromSeedOrKeysPageRobot.enterPasswordForWalletRestore(password);
      await _restoreFromSeedOrKeysPageRobot.enterPasswordRepeatForWalletRestore(password);
    }

    await _restoreFromSeedOrKeysPageRobot.onRestoreWalletButtonPressed();

    if (passphrase.isNotEmpty) {
      await _restoreFromSeedOrKeysPageRobot.enterPassphrase(passphrase);
    }
  }

  Future<void> setupPinCode(List<int> pin) async {
    // Desktop builds take a wallet password on the new wallet form instead of a pin.
    if (Platform.isLinux) {
      return;
    }

    await _setupPinCodeRobot.isDisplayed();

    await _setupPinCodeRobot.enterPinCode(pin);
    await _setupPinCodeRobot.enterPinCode(pin);
    await _setupPinCodeRobot.tapSuccessButton();
  }

  Future<void> _selectWalletType(WalletType type) async {
    await _newWalletTypePageRobot.isDisplayed();

    await _newWalletTypePageRobot.findParticularWalletTypeInScrollableList(type);
    await _newWalletTypePageRobot.selectWalletType(type);
  }

  Future<void> _completeWalletCreationSteps(WalletType type) async {
    await _generateNewWalletDetails();

    await _preSeedPageRobot.isDisplayed();
    await _preSeedPageRobot.onConfirmButtonPressed();

    await _confirmWalletSeedDetails();

    await _verifyWalletSeed();

    if (type == WalletType.bitcoin) {
      await _lightningUsernamePageRobot.isDisplayed();
      await _lightningUsernamePageRobot.tapSkip();
    }
  }

  Future<void> _generateNewWalletDetails() async {
    await _newWalletPageRobot.isDisplayed();

    await _newWalletPageRobot.generateWalletName();

    if (Platform.isLinux) {
      final password = TestConfig.pin.join("");
      await _restoreFromSeedOrKeysPageRobot.enterPasswordForWalletRestore(password);
      await _restoreFromSeedOrKeysPageRobot.enterPasswordRepeatForWalletRestore(password);
    }

    await _newWalletPageRobot.onNextButtonPressed();
  }

  Future<void> _confirmWalletSeedDetails() async {
    await _walletSeedPageRobot.isDisplayed();

    _walletSeedPageRobot.confirmWalletDetailsDisplayCorrectly();
    _walletSeedPageRobot.confirmWalletSeedReminderDisplays();

    await _walletSeedPageRobot.onVerifySeedButtonPressed();
  }

  Future<void> _verifyWalletSeed() async {
    await _seedVerificationPageRobot.isDisplayed();

    _seedVerificationPageRobot.hasTitle();

    await _seedVerificationPageRobot.verifyWalletSeeds();
  }
}