chore: tests for all getDelegatedKeys methods

Author: peter-sanderson

suite-common/redux-utils/src/extraDependenciesType.ts

@@ -6,7 +6,7 @@ import {
 
 import { MetadataAddPayload } from '@suite-common/metadata-types';
 import { SecureStorage } from '@suite-common/secure-storage';
-import { SuiteSync } from '@suite-common/suite-sync-storage';
+import { SuiteSync } from '@suite-common/suite-sync';
 import {
     ReportSecurityCheckProps,
     Route,

suite-common/suite-sync-storage/src/SuiteSync.ts

@@ -1,3 +1,5 @@
+import { SuiteSyncOwner } from '@suite-common/suite-types/';
+
 import { AccountLabelsStore } from './labeling/AccountLabelsStore';
 import { AddressLabelsStore } from './labeling/AddressLabelsStore';
 import { OutputLabelsStore } from './labeling/OutputLabelsStore';
@@ -17,3 +19,19 @@ export type SuiteSyncStorage = {
     updateRelayUrl(url: string): Promise<void>;
     dispose(): Promise<void>;
 };
+
+type SuiteStorageCreatorParams = {
+    suiteSyncOwner: SuiteSyncOwner;
+    relayUrl: string;
+};
+
+/**
+ * This is a service responsible for creating the SuiteSyncStorage. Every Owner
+ * has its own Storage. Currently only Evolu storage is implemented, but in theory,
+ * you can have different one as well.
+ */
+export type CreateSuiteStorage = (params: SuiteStorageCreatorParams) => SuiteSyncStorage;
+
+export type CreateSuiteStorageDep = {
+    createSuiteStorage: CreateSuiteStorage;
+};

suite-common/suite-sync-storage/src/SuiteSyncStorage.ts

@@ -1,20 +1,11 @@
 export type {
-    SuiteSyncStorageRepository,
-    CreateSuiteSyncStorageRepository,
+    SuiteSyncStorage,
     CreateSuiteStorage,
     CreateSuiteStorageDep,
-} from './SuiteSyncStorageRepository';
-export { createSuiteSyncStorageRepositoryFactory } from './SuiteSyncStorageRepository';
-export type { SuiteSyncStorage } from './SuiteSyncStorage';
+} from './SuiteSyncStorage';
+
 export type { CreateSuiteSyncOwner, CreateSuiteSyncOwnerDep } from './Owner';
 export { CreateSuiteSyncOwnerError } from './Owner';
-export type {
-    SuiteSync,
-    ChangeRelayUrl,
-    SubscribeSuiteSyncStorage,
-    TurnOfSuiteSync,
-    UnsubscribeSuiteSyncStorage,
-} from './SuiteSync';
 
 // Labeling
 export type { AddressLabelsStore, AddressLabel } from './labeling/AddressLabelsStore';

suite-common/suite-sync-storage/src/index.ts

@@ -0,0 +1,14 @@
+import { CreateSuiteSyncOwnerDep } from '@suite-common/suite-sync-storage';
+
+import { SuiteSyncStorageRepositoryDep } from './SuiteSyncStorageRepository';
+import { ChangeRelayUrlDep } from './relay/changeRelayUrl';
+import { TurnOffSuiteSyncForWalletDep } from './storage/turnOffSuiteSyncForWallet';
+import { TurnOnSuiteSyncForWalletDep } from './storage/turnOnSuiteSyncForWallet';
+import { TurnOffSuiteSyncDep } from './turnOffSuiteSync';
+
+export type SuiteSync = ChangeRelayUrlDep &
+    SuiteSyncStorageRepositoryDep &
+    CreateSuiteSyncOwnerDep &
+    TurnOffSuiteSyncDep &
+    TurnOnSuiteSyncForWalletDep &
+    TurnOffSuiteSyncForWalletDep;

suite-common/suite-sync/src/SuiteSync.ts

@@ -1,23 +1,6 @@
+import { CreateSuiteStorageDep, SuiteSyncStorage } from '@suite-common/suite-sync-storage';
 import { SuiteSyncOwner, SuiteSyncOwnerId } from '@suite-common/suite-types';
 
-import { SuiteSyncStorage } from './SuiteSyncStorage';
-
-type SuiteStorageCreatorParams = {
-    suiteSyncOwner: SuiteSyncOwner;
-    relayUrl: string;
-};
-
-/**
- * This is a service responsible for creating the SuiteSyncStorage. Every Owner
- * has its own Storage. Currently only Evolu storage is implemented, but in theory,
- * you can have different one as well.
- */
-export type CreateSuiteStorage = (params: SuiteStorageCreatorParams) => SuiteSyncStorage;
-
-export type CreateSuiteStorageDep = {
-    createSuiteStorage: CreateSuiteStorage;
-};
-
 export type CreateSuiteSyncStorageRepositoryFactoryDeps = CreateSuiteStorageDep & {
     defaultRelayUrl: string;
     getRelayUrl: () => string | null;
@@ -30,6 +13,10 @@ export type SuiteSyncStorageRepository = {
 
 export type CreateSuiteSyncStorageRepository = () => SuiteSyncStorageRepository;
 
+export type SuiteSyncStorageRepositoryDep = {
+    suiteSyncStorageRepository: SuiteSyncStorageRepository;
+};
+
 /**
  * Every Wallet has its own SuiteSyncStorage with Owner derived
  * from its secret (Seed+Passphrase) .

suite-common/suite-sync-storage/src/SuiteSyncStorageRepository.ts renamed to suite-common/suite-sync/src/SuiteSyncStorageRepository.ts

@@ -1,20 +1,21 @@
 import { Dispatch } from '@reduxjs/toolkit';
 
 import { SecureStorageDep } from '@suite-common/secure-storage';
+import { CreateSuiteStorageDep, CreateSuiteSyncOwnerDep } from '@suite-common/suite-sync-storage';
+// Circular issue, see: https://github.com/trezor/trezor-suite/issues/21553
+import { selectThp } from '@suite-common/thp/src/thpSelectors';
 import {
-    CreateSuiteStorageDep,
-    CreateSuiteSyncOwnerDep,
-    SuiteSync,
-    createSuiteSyncStorageRepositoryFactory,
-} from '@suite-common/suite-sync-storage';
-import {
+    RetrieveDelegatedIdentityKeyFromDeviceDeps,
     createEnsureDelegatedIdentityKey,
     createLoadDelegatedIdentityKeyFromState,
+    createRetrieveDelegatedIdentityKeyFromDevice,
     createSaveDelegatedIdentityKey,
     selectAllDeviceOwners,
     selectDeviceDelegatedIdentityKey,
 } from '@suite-common/wallet-core';
 
+import { SuiteSync } from './SuiteSync';
+import { createSuiteSyncStorageRepositoryFactory } from './SuiteSyncStorageRepository';
 import {
     EnsureSuiteSyncOwnerDeps,
     createEnsureSuiteSyncOwnerKeys,
@@ -23,16 +24,17 @@ import { createSubscribeLabeling } from './labeling/createSubscribeLabeling';
 import { createRefreshSuiteSyncKeys } from './refreshSuiteSyncKeys';
 import { createChangeRelayUrl } from './relay/changeRelayUrl';
 import { DEFAULT_SUITE_SYNC_RELAY_URL } from './relay/relayUrl';
-import { createSubscribeSuiteSyncStorage } from './storage/subscribeSuiteSyncStorage';
 import { createSubscriptionStorage } from './storage/subscriptionStorage';
-import { createUnsubscribeSuiteSyncStorage } from './storage/unsubscribeSuiteSync';
+import { createTurnOffSuiteSyncForWallet } from './storage/turnOffSuiteSyncForWallet';
+import { createTurnOnSuiteSyncForWallet } from './storage/turnOnSuiteSyncForWallet';
 import { selectSuiteSyncRelayUrl } from './suiteSyncSelectors';
 import { createTurnOffSuiteSync } from './turnOffSuiteSync';
 
 type CreateSuiteSyncCompositionRootDeps = {
     getState: () => any;
     dispatch: Dispatch;
-    trezorConnect: EnsureSuiteSyncOwnerDeps['trezorConnect'];
+    trezorConnect: EnsureSuiteSyncOwnerDeps['trezorConnect'] &
+        RetrieveDelegatedIdentityKeyFromDeviceDeps['trezorConnect'];
 } & CreateSuiteStorageDep &
     CreateSuiteSyncOwnerDep &
     SecureStorageDep;
@@ -67,11 +69,14 @@ export const createSuiteSyncCompositionRoot = (
             getDeviceDelegatedIdentityKey: deviceId =>
                 selectDeviceDelegatedIdentityKey(deps.getState(), deviceId),
         }),
+        retrieveDelegatedIdentityKeyFromDevice: createRetrieveDelegatedIdentityKeyFromDevice({
+            trezorConnect: deps.trezorConnect,
+        }),
         saveDelegatedIdentityKey: createSaveDelegatedIdentityKey({
             dispatch: deps.dispatch,
             secureStorage: deps.secureStorage,
         }),
-        getState: deps.getState,
+        getThpStaticKey: () => selectThp(deps.getState()).staticKey,
     });
     // Todo: ------------------------------------------------------------
 
@@ -82,14 +87,14 @@ export const createSuiteSyncCompositionRoot = (
         ensureSuiteSyncOwnerKeys,
     });
 
-    const subscribeSuiteSyncStorage = createSubscribeSuiteSyncStorage({
+    const turnOnSuiteSyncForWallet = createTurnOnSuiteSyncForWallet({
         dispatch: deps.dispatch,
         getState: deps.getState,
         subscribeLabeling,
         refreshSuiteSyncKeys,
     });
 
-    const unsubscribeSuiteSyncStorage = createUnsubscribeSuiteSyncStorage({
+    const turnOffSuiteSyncForWallet = createTurnOffSuiteSyncForWallet({
         suiteSyncStorageRepository,
         subscriptionStorage,
     });
@@ -102,11 +107,11 @@ export const createSuiteSyncCompositionRoot = (
         }),
         suiteSyncStorageRepository,
         createSuiteSyncOwner: deps.createSuiteSyncOwner,
-        subscribeSuiteSyncStorage,
-        unsubscribeSuiteSyncStorage,
+        turnOnSuiteSyncForWallet,
+        turnOffSuiteSyncForWallet,
         turnOffSuiteSync: createTurnOffSuiteSync({
             getState: deps.getState,
-            unsubscribeSuiteSyncStorage,
+            turnOffSuiteSyncForWallet,
         }),
     };
 };

suite-common/suite-sync/src/createSuiteSyncCompositionRoot.ts

@@ -14,6 +14,12 @@ export { prepareSuiteSyncReducer, initialSuiteSyncState } from './suiteSyncReduc
 export type { SuiteSyncState, SuiteSyncSettings } from './suiteSyncReducer';
 export { suiteSyncActions } from './suiteSyncActions';
 export { DEFAULT_SUITE_SYNC_RELAY_URL } from './relay/relayUrl';
+export type { SuiteSync } from './SuiteSync';
+export type {
+    SuiteSyncStorageRepository,
+    CreateSuiteSyncStorageRepository,
+} from './SuiteSyncStorageRepository';
+export { createSuiteSyncStorageRepositoryFactory } from './SuiteSyncStorageRepository';
 
 // Labeling
 // Todo: refactor to services, so they can be isolated & tested!

suite-common/suite-sync/src/index.ts

@@ -1,11 +1,11 @@
 import { Dispatch } from '@reduxjs/toolkit';
 
-import { SuiteSyncStorageRepository } from '@suite-common/suite-sync-storage';
 import { SuiteSyncOwner } from '@suite-common/suite-types';
 import { WalletDescriptor } from '@suite-common/wallet-types';
 
 import { clearAllLabels, labelingActions } from './labelingActions';
-import { SubscriptionStorage } from '../storage/subscriptionStorage';
+import { SuiteSyncStorageRepositoryDep } from '../SuiteSyncStorageRepository';
+import { SubscriptionStorageDep } from '../storage/subscriptionStorage';
 
 type SubscribeLabelingParams = {
     owner: SuiteSyncOwner;
@@ -14,11 +14,10 @@ type SubscribeLabelingParams = {
 
 export type SubscribeLabeling = (params: SubscribeLabelingParams) => void;
 
-export type CreateSubscribeLabelingDeps = {
-    suiteSyncStorageRepository: SuiteSyncStorageRepository;
-    subscriptionStorage: SubscriptionStorage;
-    dispatch: Dispatch;
-};
+export type CreateSubscribeLabelingDeps = SuiteSyncStorageRepositoryDep &
+    SubscriptionStorageDep & {
+        dispatch: Dispatch;
+    };
 
 export const createSubscribeLabeling =
     (deps: CreateSubscribeLabelingDeps): SubscribeLabeling =>

suite-common/suite-sync/src/labeling/createSubscribeLabeling.ts

@@ -1,15 +1,20 @@
 import { Dispatch } from '@reduxjs/toolkit';
 
-import { ChangeRelayUrl, SuiteSyncStorageRepository } from '@suite-common/suite-sync-storage';
 import { SuiteSyncOwner } from '@suite-common/suite-types';
 
 import { setSuiteSyncRelayUrl } from '../suiteSyncActions';
 import { DEFAULT_SUITE_SYNC_RELAY_URL } from './relayUrl';
+import { SuiteSyncStorageRepositoryDep } from '../SuiteSyncStorageRepository';
 
 export type ChangeRelayUrlDeps = {
     getAllDevicesOwners: () => SuiteSyncOwner[];
     dispatch: Dispatch;
-    suiteSyncStorageRepository: SuiteSyncStorageRepository;
+} & SuiteSyncStorageRepositoryDep;
+
+export type ChangeRelayUrl = (params: { relayUrl: string | null }) => Promise<void>;
+
+export type ChangeRelayUrlDep = {
+    changeRelayUrl: ChangeRelayUrl;
 };
 
 export const createChangeRelayUrl =