feat(app): the recovery phrase's words typed back are suggested from BIP-39's list (ADR 0017)

Each of the three fields suggests the words of BIP-39's whole English
list beginning with what is typed, never the phrase's own, and refuses a
word not on it as its field is left, so that a typo is caught before the
words are compared.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>

packages/halkyon_app/lib/l10n/halkyon_app_de.arb

@@ -141,6 +141,7 @@
   "passwordPhraseCheckIntro": "Tippe die gefragten Wörter aus deiner Notiz ein.",
   "passwordPhraseWord": "Wort {number}",
   "passwordPhraseWrong": "Das sind nicht die Wörter. Sieh noch einmal in deine Notiz.",
+  "passwordPhraseNotAWord": "Kein Wort, aus dem eine Wiederherstellungsphrase besteht",
   "passwordPhraseShowAgain": "Phrase noch einmal zeigen",
   "passwordCreateTitle": "Konto erstellen",
   "passwordCreateIntro": "Auf {instance}, mit deiner E-Mail-Adresse, einem Passwort und einer Authenticator-App für den Code, den jede Anmeldung braucht.",

packages/halkyon_app/lib/l10n/halkyon_app_en.arb

@@ -435,6 +435,7 @@
     }
   },
   "passwordPhraseWrong": "These aren't the words. Look again at what you wrote down.",
+  "passwordPhraseNotAWord": "Not a word a recovery phrase is made of",
   "passwordPhraseShowAgain": "Show the phrase again",
   "passwordCreateTitle": "Create an account",
   "passwordCreateIntro": "On {instance}, with your email address, a password, and an authenticator app for the code every sign-in takes.",

packages/halkyon_app/lib/l10n/halkyon_app_localizations.dart

@@ -949,6 +949,12 @@ abstract class HalkyonAppLocalizations {
   /// **'These aren\'t the words. Look again at what you wrote down.'**
   String get passwordPhraseWrong;
 
+  /// No description provided for @passwordPhraseNotAWord.
+  ///
+  /// In en, this message translates to:
+  /// **'Not a word a recovery phrase is made of'**
+  String get passwordPhraseNotAWord;
+
   /// No description provided for @passwordPhraseShowAgain.
   ///
   /// In en, this message translates to:

packages/halkyon_app/lib/l10n/halkyon_app_localizations_de.dart

@@ -539,6 +539,10 @@ class HalkyonAppLocalizationsDe extends HalkyonAppLocalizations {
   String get passwordPhraseWrong =>
       'Das sind nicht die Wörter. Sieh noch einmal in deine Notiz.';
 
+  @override
+  String get passwordPhraseNotAWord =>
+      'Kein Wort, aus dem eine Wiederherstellungsphrase besteht';
+
   @override
   String get passwordPhraseShowAgain => 'Phrase noch einmal zeigen';
 

packages/halkyon_app/lib/l10n/halkyon_app_localizations_en.dart

@@ -529,6 +529,10 @@ class HalkyonAppLocalizationsEn extends HalkyonAppLocalizations {
   String get passwordPhraseWrong =>
       'These aren\'t the words. Look again at what you wrote down.';
 
+  @override
+  String get passwordPhraseNotAWord =>
+      'Not a word a recovery phrase is made of';
+
   @override
   String get passwordPhraseShowAgain => 'Show the phrase again';
 

packages/halkyon_app/lib/src/password/model/phrase_check.dart

@@ -1,5 +1,7 @@
 import 'dart:math';
 
+import 'package:halkyon_core/halkyon_core.dart' show bip39English;
+
 /// Which words of a recovery phrase of [length] words the person types back
 /// (ADR 0017: three, chosen at random, so it was written down rather than
 /// glanced at), in order, by their positions from 0.
@@ -12,6 +14,29 @@ List<int> wordsToCheck(int length, {Random? random, int count = 3}) {
   return chosen.toList()..sort();
 }
 
+final _phraseWords = bip39English.toSet();
+
+/// Whether [word] is one a recovery phrase is made of (BIP-39's English
+/// list), whatever its case and the spaces around it: a word typed back
+/// that isn't is a typo, caught before the words are compared.
+bool isPhraseWord(String word) =>
+    _phraseWords.contains(word.trim().toLowerCase());
+
+/// The words of BIP-39's English list beginning with what [typed] begins,
+/// at most [limit], in the list's order; none where [typed] is empty or
+/// a whole word no other begins with.
+List<String> phraseWordsBeginning(String typed, {int limit = 5}) {
+  final start = typed.trim().toLowerCase();
+  if (start.isEmpty) {
+    return const [];
+  }
+  final words = bip39English
+      .where((word) => word.startsWith(start))
+      .take(limit)
+      .toList();
+  return words.length == 1 && words.single == start ? const [] : words;
+}
+
 /// The words of [phrase], in order.
 List<String> wordsOf(String phrase) =>
     phrase.trim().split(RegExp(r'\s+')).where((w) => w.isNotEmpty).toList();

packages/halkyon_app/lib/src/password/widget/password_widgets.dart

@@ -468,6 +468,12 @@ class const PhraseField({
 }
 
 /// Fields for the words of a recovery phrase at [positions] (from 0).
+///
+/// Each field suggests the words of BIP-39's English list beginning with
+/// what is typed (`phraseWordsBeginning`), never the phrase's own, a word
+/// picked moving on to the next field; a word not on the list is refused
+/// as its field is left (`isPhraseWord`), and [onDone] waits until every
+/// field holds one.
 class const PhraseCheckFields({
   required final List<int> positions,
   required final List<TextEditingController> controllers,
@@ -475,39 +481,122 @@ class const PhraseCheckFields({
   final String? errorText,
   final VoidCallback? onDone,
   super.key,
-}) extends StatelessWidget {
+}) extends StatefulWidget {
+  @override
+  State<PhraseCheckFields> createState() => _PhraseCheckFieldsState();
+}
+
+class _PhraseCheckFieldsState() extends State<PhraseCheckFields> {
+  late final List<FocusNode> _focus = [
+    for (var i = 0; i < widget.positions.length; i++)
+      FocusNode()..addListener(() => _left(i)),
+  ];
+
+  /// The fields left or submitted at least once: their words are judged.
+  final _judged = <int>{};
+
+  int get _last => widget.positions.length - 1;
+
+  @override
+  void dispose() {
+    for (final node in _focus) {
+      node.dispose();
+    }
+    super.dispose();
+  }
+
+  void _left(int i) {
+    if (!_focus[i].hasFocus && mounted && _judged.add(i)) {
+      setState(() {});
+    }
+  }
+
+  bool _known(int i) => isPhraseWord(widget.controllers[i].text);
+
+  /// After field [i] was submitted: kept there with a word not on the
+  /// list, else on to the next, or done once every word is on it.
+  void _submitted(int i) {
+    setState(() => _judged.add(i));
+    if (!_known(i)) {
+      _focus[i].requestFocus();
+      return;
+    }
+    if (i < _last) {
+      _focus[i + 1].requestFocus();
+      return;
+    }
+    final unknown = [
+      for (var j = 0; j <= _last; j++)
+        if (!_known(j)) j,
+    ];
+    if (unknown.isEmpty) {
+      widget.onDone?.call();
+    } else {
+      setState(() => _judged.addAll(unknown));
+      _focus[unknown.first].requestFocus();
+    }
+  }
+
   @override
   Widget build(BuildContext context) {
     final l10n = HalkyonAppLocalizations.of(context);
+    final positions = widget.positions;
     // Words of the phrase: kept out of screenshots and recent apps too.
     return SecretScreen(
       child: Column(
         crossAxisAlignment: CrossAxisAlignment.stretch,
         children: [
           for (var i = 0; i < positions.length; i++) ...[
-            _PasteOnly(
-              child: TextField(
-                controller: controllers[i],
-                enabled: enabled,
-                autofocus: i == 0,
-                autocorrect: false,
-                enableSuggestions: false,
-                // Nothing typed here is the keyboard's to learn.
-                enableIMEPersonalizedLearning: false,
-                contextMenuBuilder: _PasteOnly.menu,
-                textInputAction: i == positions.length - 1
-                    ? TextInputAction.done
-                    : TextInputAction.next,
-                onSubmitted: i == positions.length - 1
-                    ? (_) => onDone?.call()
-                    : null,
-                maxLength: TextLimits.name,
-                buildCounter: nearLimitCounter,
-                decoration: InputDecoration(
-                  labelText: l10n.passwordPhraseWord(positions[i] + 1),
-                  errorText: i == positions.length - 1 ? errorText : null,
-                ),
-              ),
+            Autocomplete<String>(
+              textEditingController: widget.controllers[i],
+              focusNode: _focus[i],
+              optionsBuilder: (value) => phraseWordsBeginning(value.text),
+              onSelected: (_) {
+                setState(() => _judged.add(i));
+                if (i < _last) {
+                  _focus[i + 1].requestFocus();
+                }
+              },
+              fieldViewBuilder: (context, controller, focusNode, submit) =>
+                  _PasteOnly(
+                    child: ListenableBuilder(
+                      listenable: controller,
+                      builder: (context, _) => TextField(
+                        controller: controller,
+                        focusNode: focusNode,
+                        enabled: widget.enabled,
+                        autofocus: i == 0,
+                        autocorrect: false,
+                        enableSuggestions: false,
+                        // Nothing typed here is the keyboard's to learn.
+                        enableIMEPersonalizedLearning: false,
+                        contextMenuBuilder: _PasteOnly.menu,
+                        textInputAction: i == _last
+                            ? TextInputAction.done
+                            : TextInputAction.next,
+                        // Focus moves as [_submitted] decides.
+                        onEditingComplete: () {},
+                        onSubmitted: (_) {
+                          // A suggestion highlighted is taken first.
+                          submit();
+                          _submitted(i);
+                        },
+                        maxLength: TextLimits.name,
+                        buildCounter: nearLimitCounter,
+                        decoration: InputDecoration(
+                          labelText: l10n.passwordPhraseWord(positions[i] + 1),
+                          errorText:
+                              _judged.contains(i) &&
+                                  controller.text.trim().isNotEmpty &&
+                                  !_known(i)
+                              ? l10n.passwordPhraseNotAWord
+                              : i == _last
+                              ? widget.errorText
+                              : null,
+                        ),
+                      ),
+                    ),
+                  ),
             ),
             const SizedBox(height: 8),
           ],

packages/halkyon_app/test/password/widget/phrase_check_fields_test.dart

@@ -0,0 +1,111 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:halkyon_app/halkyon_app.dart';
+import 'package:halkyon_app/testing.dart';
+import 'package:material_ui/material_ui.dart';
+
+/// The recovery phrase's words typed back (ADR 0017): each field suggests
+/// words of BIP-39's whole English list as they are typed, never the
+/// phrase's own, and takes no word that isn't on it, so a typo is caught
+/// before the words are compared.
+void main() {
+  late List<TextEditingController> controllers;
+  late int done;
+
+  setUp(() {
+    controllers = [for (var i = 0; i < 3; i++) TextEditingController()];
+    done = 0;
+  });
+
+  tearDown(() {
+    for (final controller in controllers) {
+      controller.dispose();
+    }
+  });
+
+  Future<void> pump(WidgetTester tester) => tester.pumpWidget(
+    MaterialApp(
+      localizationsDelegates: testLocalizationsDelegates,
+      supportedLocales: HalkyonAppLocalizations.supportedLocales,
+      locale: const Locale('en'),
+      home: Scaffold(
+        body: SingleChildScrollView(
+          child: PhraseCheckFields(
+            positions: const [2, 7, 19],
+            controllers: controllers,
+            onDone: () => done++,
+          ),
+        ),
+      ),
+    ),
+  );
+
+  Finder field(int i) => find.byType(TextField).at(i);
+
+  testWidgets("the list's words are suggested as they are typed, and one "
+      'picked fills the field and moves on', (tester) async {
+    await pump(tester);
+    await tester.enterText(field(0), 'zo');
+    await tester.pump();
+
+    expect(find.text('zone'), findsOneWidget);
+    expect(find.text('zoo'), findsOneWidget);
+
+    await tester.tap(find.text('zoo'));
+    await tester.pump();
+    expect(controllers[0].text, 'zoo');
+    expect(
+      tester.widget<TextField>(field(1)).focusNode!.hasFocus,
+      isTrue,
+    );
+  });
+
+  testWidgets('a word typed whole suggests nothing more, unless a longer '
+      'one begins with it', (tester) async {
+    await pump(tester);
+    await tester.enterText(field(0), 'zoo');
+    await tester.pump();
+    // The field's own text alone, no option below it.
+    expect(find.text('zoo'), findsOneWidget);
+
+    await tester.enterText(field(0), 'act');
+    await tester.pump();
+    expect(find.text('action'), findsOneWidget);
+  });
+
+  testWidgets("a word that isn't on the list is refused as the field is "
+      'left, and the words are not handed on', (tester) async {
+    await pump(tester);
+    await tester.enterText(field(0), 'abandom');
+    await tester.testTextInput.receiveAction(TextInputAction.next);
+    await tester.pump();
+
+    expect(find.text('Not a word a recovery phrase is made of'), findsOne);
+    expect(
+      tester.widget<TextField>(field(0)).focusNode!.hasFocus,
+      isTrue,
+    );
+
+    await tester.enterText(field(0), 'abandon');
+    await tester.enterText(field(1), 'Zoo ');
+    await tester.enterText(field(2), 'qwerty');
+    await tester.testTextInput.receiveAction(TextInputAction.done);
+    await tester.pump();
+    expect(done, 0);
+    expect(find.text('Not a word a recovery phrase is made of'), findsOne);
+
+    await tester.enterText(field(2), 'ability');
+    await tester.pump();
+    await tester.testTextInput.receiveAction(TextInputAction.done);
+    await tester.pump();
+    expect(done, 1);
+    expect(find.text('Not a word a recovery phrase is made of'), findsNothing);
+  });
+
+  test("a phrase's word is one of BIP-39's English list, whatever its case "
+      'and the spaces around it', () {
+    expect(isPhraseWord(' Abandon '), isTrue);
+    expect(isPhraseWord('zoo'), isTrue);
+    expect(isPhraseWord('abandom'), isFalse);
+    expect(isPhraseWord(''), isFalse);
+  });
+}