refactor: cleanup

catalyst_voices/packages/catalyst_voices_blocs/lib/src/session/session_bloc.dart

@@ -48,7 +48,7 @@ final class SessionBloc extends Bloc<SessionEvent, SessionState> {
     VisitorSessionEvent event,
     Emitter<SessionState> emit,
   ) async {
-    await _keychain.remove();
+    await _keychain.clearAndLock();
 
     emit(const VisitorSessionState());
   }
@@ -57,7 +57,7 @@ final class SessionBloc extends Bloc<SessionEvent, SessionState> {
     GuestSessionEvent event,
     Emitter<SessionState> emit,
   ) async {
-    await _keychain.init(
+    await _keychain.setLockAndBeginWith(
       seedPhrase: _dummySeedPhrase,
       unlockFactor: _dummyUnlockFactor,
     );
@@ -69,7 +69,7 @@ final class SessionBloc extends Bloc<SessionEvent, SessionState> {
     ActiveUserSessionEvent event,
     Emitter<SessionState> emit,
   ) async {
-    await _keychain.init(
+    await _keychain.setLockAndBeginWith(
       seedPhrase: _dummySeedPhrase,
       unlockFactor: _dummyUnlockFactor,
     );
@@ -83,7 +83,7 @@ final class SessionBloc extends Bloc<SessionEvent, SessionState> {
     RemoveKeychainSessionEvent event,
     Emitter<SessionState> emit,
   ) async {
-    await _keychain.remove();
+    await _keychain.clearAndLock();
     emit(const VisitorSessionState());
   }
 

catalyst_voices/packages/catalyst_voices_services/lib/src/keychain/keychain.dart

@@ -31,19 +31,22 @@ class Keychain {
   ///
   /// In most cases the [unlockFactor] is going to be
   /// an instance of a [PasswordLockFactor].
-  Future<void> init({
+  Future<void> setLockAndBeginWith({
     required SeedPhrase seedPhrase,
     required LockFactor unlockFactor,
+    bool unlocked = true,
   }) async {
-    _logger.info('init');
-    await _vault.setLock(unlockFactor);
-    await _vault.unlock(unlockFactor);
-    await _writeSeedPhrase(seedPhrase);
+    _logger.info('setLockAndBeginWith, unlocked: $unlocked');
+    await _changeLock(unlockFactor, unlocked: unlocked);
+    await _beginWith(seedPhrase: seedPhrase);
   }
 
-  /// Removes the keychain and all associated data.
-  Future<void> remove() async {
-    _logger.info('remove');
+  /// Clears the keychain and all associated data.
+  ///
+  /// Locks the keychain and removes the lock factor
+  /// from the underlying storage.
+  Future<void> clearAndLock() async {
+    _logger.info('clearAndLock');
     await _ensureUnlocked();
     await _vault.delete(key: _seedPhraseKey);
     await _vault.setLock(const VoidLockFactor());
@@ -53,7 +56,7 @@ class Keychain {
   /// Unlocks the keychain.
   ///
   /// The [unlock] factor must be the same [LockFactor]
-  /// as provided to the [init].
+  /// as provided to the [setLockAndBeginWith].
   ///
   /// In most cases the [unlock] is going to be
   /// an instance of a [PasswordLockFactor].
@@ -92,8 +95,26 @@ class Keychain {
     }
   }
 
+  Future<void> _changeLock(
+    LockFactor lockFactor, {
+    bool unlocked = false,
+  }) async {
+    await _vault.setLock(lockFactor);
+    if (unlocked) {
+      await _vault.unlock(lockFactor);
+    } else {
+      await _vault.lock();
+    }
+  }
+
+  Future<void> _beginWith({
+    required SeedPhrase seedPhrase,
+  }) async {
+    await _writeSeedPhrase(seedPhrase);
+  }
+
   Future<bool> get _hasSeedPhrase async {
-    return _vault.containsString(key: _seedPhraseKey);
+    return _vault.contains(key: _seedPhraseKey);
   }
 
   Future<SeedPhrase?> _readSeedPhrase() async {
@@ -105,6 +126,9 @@ class Keychain {
     }
   }
 
+  // TODO(dtscalac): in the future when key derivation spec is more stable
+  // the seed phrase should not be stored but only the master key that
+  // is derived from the seed phrase
   Future<void> _writeSeedPhrase(SeedPhrase seedPhrase) async {
     await _vault.writeString(seedPhrase.hexEntropy, key: _seedPhraseKey);
   }

catalyst_voices/packages/catalyst_voices_services/lib/src/registration/registration_service.dart

@@ -33,7 +33,7 @@ final class RegistrationService {
     required SeedPhrase seedPhrase,
     required String unlockPassword,
   }) async {
-    await _keychain.init(
+    await _keychain.setLockAndBeginWith(
       seedPhrase: seedPhrase,
       unlockFactor: PasswordLockFactor(unlockPassword),
     );

catalyst_voices/packages/catalyst_voices_services/lib/src/storage/secure_storage.dart

@@ -14,7 +14,7 @@ base class SecureStorage with StorageAsStringMixin implements Storage {
   }) : _secureStorage = secureStorage;
 
   @override
-  Future<bool> containsString({required String key}) async {
+  Future<bool> contains({required String key}) async {
     return await readString(key: key) != null;
   }
 

catalyst_voices/packages/catalyst_voices_services/lib/src/storage/storage.dart

@@ -11,12 +11,12 @@ import 'package:flutter/foundation.dart';
 /// Implementation may use local memory / filesystem or shared preferences or
 /// any other.
 abstract interface class Storage {
-  /// Returns true if a [String] with given [key] exists
+  /// Returns true if given [key] exists
   /// in the storage and has non-null value.
   ///
   /// The method must be always callable,
   /// despite the session being locked, keychain encrypted, etc.
-  Future<bool> containsString({required String key});
+  Future<bool> contains({required String key});
 
   /// Returns the [String] by [key] or null if not set.
   FutureOr<String?> readString({required String key});
@@ -27,13 +27,6 @@ abstract interface class Storage {
     required String key,
   });
 
-  /// Returns true if a [int] with given [key] exists
-  /// in the storage and has non-null value.
-  ///
-  /// The method must be always callable,
-  /// despite the session being locked, keychain encrypted, etc.
-  Future<bool> containsInt({required String key});
-
   /// Returns the [int] by [key] or null if not set.
   FutureOr<int?> readInt({required String key});
 
@@ -43,13 +36,6 @@ abstract interface class Storage {
     required String key,
   });
 
-  /// Returns true if a [bool] with given [key] exists
-  /// in the storage and has non-null value.
-  ///
-  /// The method must be always callable,
-  /// despite the session being locked, keychain encrypted, etc.
-  Future<bool> containsBool({required String key});
-
   /// Returns the [bool] by [key] or null if not set.
   FutureOr<bool?> readBool({required String key});
 
@@ -59,13 +45,6 @@ abstract interface class Storage {
     required String key,
   });
 
-  /// Returns true if [Uint8List] with given [key] exists
-  /// in the storage and has non-null value.
-  ///
-  /// The method must be always callable,
-  /// despite the session being locked, keychain encrypted, etc.
-  Future<bool> containsBytes({required String key});
-
   /// Returns the [Uint8List] by [key] or null if not set.
   FutureOr<Uint8List?> readBytes({required String key});
 

catalyst_voices/packages/catalyst_voices_services/lib/src/storage/storage_string_mixin.dart

@@ -12,11 +12,6 @@ import 'package:flutter/foundation.dart';
 ///
 /// See [SecureStorageVault] as example.
 mixin StorageAsStringMixin implements Storage {
-  @override
-  Future<bool> containsInt({required String key}) {
-    return containsString(key: key);
-  }
-
   @override
   FutureOr<int?> readInt({required String key}) async {
     final value = await readString(key: key);
@@ -31,11 +26,6 @@ mixin StorageAsStringMixin implements Storage {
     return writeString(value?.toString(), key: key);
   }
 
-  @override
-  Future<bool> containsBool({required String key}) {
-    return containsString(key: key);
-  }
-
   @override
   FutureOr<bool?> readBool({required String key}) async {
     final value = await readInt(key: key);
@@ -61,11 +51,6 @@ mixin StorageAsStringMixin implements Storage {
     return writeInt(asInt, key: key);
   }
 
-  @override
-  Future<bool> containsBytes({required String key}) {
-    return containsString(key: key);
-  }
-
   @override
   FutureOr<Uint8List?> readBytes({required String key}) async {
     final base64String = await readString(key: key);

catalyst_voices/packages/catalyst_voices_services/lib/src/storage/vault/secure_storage_vault.dart

@@ -55,7 +55,7 @@ base class SecureStorageVault with StorageAsStringMixin implements Vault {
   }
 
   @override
-  Future<bool> containsString({required String key}) async {
+  Future<bool> contains({required String key}) async {
     return await _guardedRead(key: key, requireUnlocked: false) != null;
   }
 

catalyst_voices/packages/catalyst_voices_services/test/src/keychain/key_derivation_test.dart

@@ -4,11 +4,11 @@ import 'package:test/test.dart';
 
 void main() {
   group(KeyDerivation, () {
-    late KeyDerivation service;
+    late KeyDerivation keyDerivation;
     late SeedPhrase seedPhrase;
 
     setUp(() {
-      service = KeyDerivation();
+      keyDerivation = KeyDerivation();
       seedPhrase = SeedPhrase.fromMnemonic(
         'few loyal swift champion rug peace dinosaur'
         ' erase bacon tone install universe',
@@ -17,7 +17,7 @@ void main() {
 
     test('should generate key pair with different valid paths', () async {
       for (final role in AccountRole.values) {
-        final keyPair = await service.deriveKeyPair(
+        final keyPair = await keyDerivation.deriveKeyPair(
           seedPhrase: seedPhrase,
           path: "m/${role.roleNumber}'/1234'",
         );
@@ -27,7 +27,7 @@ void main() {
 
     test('should generate key pair with different valid roles', () async {
       for (final role in AccountRole.values) {
-        final keyPair = await service.deriveAccountRoleKeyPair(
+        final keyPair = await keyDerivation.deriveAccountRoleKeyPair(
           seedPhrase: seedPhrase,
           role: role,
         );

catalyst_voices/packages/catalyst_voices_services/test/src/storage/storage_string_mixin_test.dart

@@ -146,7 +146,7 @@ class _TestStorage with StorageAsStringMixin implements Storage {
   }
 
   @override
-  Future<bool> containsString({required String key}) async {
+  Future<bool> contains({required String key}) async {
     return _data[key] != null;
   }