refactor(wip): refactor profilemanager core module

Author: begonaalvarezd

packages/desktop/components/modals/AccountActionsMenu.svelte

@@ -4,7 +4,7 @@
     import { selectedAccount } from '@core/account/stores'
     import { localize } from '@core/i18n'
     import { activeAccounts, activeProfile, isActiveLedgerProfile, visibleActiveAccounts } from '@core/profile/stores'
-    import { deleteAccount } from '@core/profile-manager/actions'
+    import { deleteWallet } from '@core/profile-manager/actions'
 
     import { Icon } from '@auxiliary/icon/enums'
     import { openPopup, PopupId } from '@auxiliary/popup'
@@ -62,7 +62,7 @@
             id: PopupId.DeleteAccount,
             props: {
                 account: selectedAccount,
-                deleteAccount,
+                deleteWallet,
             },
         })
         modal?.close()

packages/desktop/components/popups/DeleteAccountPopup.svelte

@@ -8,7 +8,7 @@
     import { handleError } from '@core/error/handlers/handleError'
     import { TextHintVariant } from 'shared/components/enums'
 
-    export let deleteAccount: (index: number) => Promise<void> = async () => {}
+    export let deleteWallet: (index: number) => Promise<void> = async () => {}
 
     let password: string
     let error: string
@@ -26,7 +26,7 @@
             if ($isSoftwareProfile) {
                 await setStrongholdPassword(password)
             }
-            await deleteAccount($selectedAccount?.index)
+            await deleteWallet($selectedAccount?.index)
             closePopup()
         } catch (err) {
             error = err.error

packages/desktop/electron/preload.js

@@ -124,6 +124,8 @@ try {
         // TODO(2.0): also remove from file system
         deleteWallet(id) {
             if (id && id in wallets) {
+                const wallet = wallets[id]
+                wallet.destroy()
                 delete wallets[id]
             }
         },
@@ -145,7 +147,11 @@ try {
             return accounts
         },
         clearWalletsFromMemory() {
-            Object.keys(wallets).forEach((id) => delete wallets[id])
+            Object.keys(wallets).forEach((id) => {
+                const wallet = wallets[id]
+                wallet.destroy()
+                delete wallets[id]
+            })
         },
         async migrateStrongholdSnapshotV2ToV3(currentPath, newPath, currentPassword, newPassword) {
             const snapshotSaltV2 = 'wallet.rs'

packages/desktop/views/login/views/SelectProfileView.svelte

@@ -9,7 +9,7 @@
     } from '@core/app'
     import { localize } from '@core/i18n'
     import { ProfileType, loadPersistedProfileIntoActiveProfile, profiles, removeProfileFolder } from '@core/profile'
-    import { destroyProfileManager } from '@core/profile-manager/actions'
+    import { clearProfileFromMemory } from '@core/profile-manager/actions'
     import { loginRouter, routerManager } from '@core/router'
     import features from '@features/features'
     import { Icon, Logo, Profile } from '@ui'
@@ -41,7 +41,7 @@
         // Clean up if user has navigated back to this view from onboarding
         if ($onboardingProfile) {
             if ($onboardingProfile.hasInitialisedProfileManager) {
-                await destroyProfileManager()
+                await clearProfileFromMemory()
                 await removeProfileFolder($onboardingProfile.id)
             }
             $onboardingProfile = undefined

packages/desktop/views/onboarding/views/create-profile/views/ChooseCreateProfileFlowView.svelte

@@ -12,7 +12,7 @@
     import { Animation, OnboardingButton, Text } from '@ui'
     import { onMount } from 'svelte'
     import { createProfileRouter } from '../create-profile-router'
-    import { destroyProfileManager } from '@core/profile-manager/actions'
+    import { clearProfileFromMemory } from '@core/profile-manager/actions'
     import { Icon as IconEnum } from '@auxiliary/icon'
     import { AnimationEnum } from '@auxiliary/animation'
 
@@ -40,7 +40,7 @@
     onMount(async () => {
         // Clean up if user has navigated back to this view
         if ($onboardingProfile.hasInitialisedProfileManager) {
-            await destroyProfileManager()
+            await clearProfileFromMemory()
             await removeProfileFolder($onboardingProfile.id)
         }
         updateOnboardingProfile({ type: undefined, createProfileType: undefined, hasInitialisedProfileManager: false })

packages/desktop/views/onboarding/views/restore-profile/views/ChooseRestoreProfileFlowView.svelte

@@ -13,7 +13,7 @@
     import { Animation, OnboardingButton, Text } from '@ui'
     import { onMount } from 'svelte'
     import { restoreProfileRouter } from '../restore-profile-router'
-    import { destroyProfileManager } from '@core/profile-manager/actions'
+    import { clearProfileFromMemory } from '@core/profile-manager/actions'
     import { Icon as IconEnum } from '@auxiliary/icon'
     import { AnimationEnum } from '@auxiliary/animation'
 
@@ -42,7 +42,7 @@
     onMount(async () => {
         // Clean up if user has navigated back to this view
         if ($onboardingProfile.hasInitialisedProfileManager) {
-            await destroyProfileManager()
+            await clearProfileFromMemory()
             await removeProfileFolder($onboardingProfile.id)
         }
         updateOnboardingProfile({ type: undefined, restoreProfileType: undefined, hasInitialisedProfileManager: false })

packages/desktop/views/update-stronghold/views/ChangePasswordView.svelte

@@ -104,6 +104,7 @@
             const profileManagerOptions = await buildProfileManagerOptionsFromProfileData($activeProfile)
             const { storagePath, coinType, clientOptions, secretManager } = profileManagerOptions
             updateActiveProfile({ clientOptions })
+            // TODO(2.0): Update initialiseProfileManager to new logic
             const manager = await initialiseProfileManager(
                 $activeProfile?.id,
                 storagePath,

packages/shared/lib/contexts/onboarding/actions/cleanupOnboardingProfileManager.ts

@@ -1,6 +1,6 @@
 import { get } from 'svelte/store'
 
-import { destroyProfileManager, profileManager } from '@core/profile-manager'
+import { clearProfileFromMemory, profileManager } from '@core/profile-manager'
 import { removeProfileFolder } from '@core/profile'
 
 export async function cleanupOnboardingProfileManager(): Promise<void> {
@@ -10,6 +10,6 @@ export async function cleanupOnboardingProfileManager(): Promise<void> {
 
     const { id } = get(profileManager)
 
-    await destroyProfileManager()
+    await clearProfileFromMemory()
     await removeProfileFolder(id)
 }

packages/shared/lib/contexts/onboarding/actions/createShimmerClaimingProfileManager.ts

@@ -18,6 +18,7 @@ export async function createShimmerClaimingProfileManager(): Promise<void> {
     const clientOptions = $onboardingProfile?.clientOptions
     const secretManager = getSecretManagerFromProfileType($onboardingProfile?.type, storagePath)
 
+    // TODO(2.0): Fix all shimmer claiming
     const manager = await initialiseProfileManager(
         generateRandomId(),
         storagePath,

packages/shared/lib/contexts/onboarding/actions/deleteOnboardingProfile.ts

@@ -1,4 +1,4 @@
-import { destroyProfileManager } from '@core/profile-manager'
+import { clearProfileFromMemory } from '@core/profile-manager'
 import { get } from 'svelte/store'
 import { onboardingProfile } from '../stores'
 import { removeProfileFolder } from '@core/profile/utils'
@@ -12,7 +12,7 @@ export async function deleteOnboardingProfile(): Promise<void> {
     const profile = get(onboardingProfile)
     if (profile) {
         try {
-            await destroyProfileManager()
+            await clearProfileFromMemory()
             await removeProfileFolder(profile.id)
         } catch (err) {
             console.error(err)

packages/shared/lib/contexts/onboarding/actions/destroyShimmerClaimingProfileManager.ts

@@ -1,6 +1,6 @@
 import { get } from 'svelte/store'
 
-import { destroyProfileManager } from '@core/profile-manager'
+import { clearProfileFromMemory } from '@core/profile-manager'
 import { Platform } from '@core/app'
 
 import { getTemporaryProfileManagerStorageDirectory } from '../helpers'
@@ -11,7 +11,7 @@ export async function destroyShimmerClaimingProfileManager(): Promise<void> {
     if (!_shimmerClaimingProfileManager) {
         return
     }
-    await destroyProfileManager(shimmerClaimingProfileManager)
+    await clearProfileFromMemory(shimmerClaimingProfileManager)
     const profilePath = await getTemporaryProfileManagerStorageDirectory()
     await Platform.removeProfileFolder(profilePath)
 }

packages/shared/lib/contexts/onboarding/actions/initialiseOnboardingFlow.ts

@@ -3,7 +3,7 @@ import { get } from 'svelte/store'
 import { stopPollingLedgerNanoStatus } from '@core/ledger/actions'
 import { isPollingLedgerDeviceStatus } from '@core/ledger/stores'
 import { getDefaultPersistedNetwork } from '@core/network/utils'
-import { destroyProfileManager, unsubscribeFromWalletApiEvents } from '@core/profile-manager/actions'
+import { clearProfileFromMemory, unsubscribeFromWalletApiEvents } from '@core/profile-manager/actions'
 import { resetActiveProfile } from '@core/profile/actions'
 
 import { IOnboardingInitialisationOptions } from '../interfaces'
@@ -20,7 +20,7 @@ export async function initialiseOnboardingFlow(options: IOnboardingInitialisatio
         stopPollingLedgerNanoStatus()
     }
     await unsubscribeFromWalletApiEvents()
-    await destroyProfileManager()
+    await clearProfileFromMemory()
 
     const { isDeveloperProfile, networkId } = options
 

packages/shared/lib/contexts/onboarding/actions/initialiseOnboardingProfile.ts

@@ -1,5 +1,5 @@
 import { stopPollingLedgerNanoStatus } from '@core/ledger'
-import { destroyProfileManager, profileManager } from '@core/profile-manager'
+import { clearProfileFromMemory, profileManager } from '@core/profile-manager'
 import { get } from 'svelte/store'
 import { OnboardingProfileManagerAlreadyInitializedError } from '../errors'
 import { buildInitialOnboardingProfile } from '../helpers'
@@ -17,7 +17,7 @@ export async function initialiseOnboardingProfile(
             if (get(isOnboardingLedgerProfile)) {
                 stopPollingLedgerNanoStatus()
             }
-            await destroyProfileManager()
+            await clearProfileFromMemory()
         } else {
             throw new OnboardingProfileManagerAlreadyInitializedError()
         }

packages/shared/lib/contexts/onboarding/actions/initialiseProfileManagerFromOnboardingProfile.ts

@@ -1,29 +1,32 @@
 import { get } from 'svelte/store'
 
 import {
-    buildProfileManagerOptionsFromProfileData,
-    initialiseProfileManager,
-    profileManager,
+    getSecretManagerFromProfileType
 } from '@core/profile-manager'
+import { onboardingProfileSecretManager } from '../stores'
 
+import { getStorageDirectoryOfProfile, removeProfileFolder } from '@core/profile'
 import { onboardingProfile, updateOnboardingProfile } from '../stores'
-import { removeProfileFolder } from '@core/profile'
-
-export async function initialiseProfileManagerFromOnboardingProfile(checkForExistingManager?: boolean): Promise<void> {
-    const existingManager = get(profileManager)
-    if (existingManager) {
-        if (!checkForExistingManager) {
-            await existingManager.destroy()
-            removeProfileFolder(existingManager.id)
+
+export async function initialiseProfileManagerFromOnboardingProfile(checkForExistingSecretManager?: boolean): Promise<void> {
+    const secretManager = get(onboardingProfileSecretManager)
+    const activeOnboardingProfile = get(onboardingProfile)
+
+    if (!activeOnboardingProfile) {
+        return
+    }
+
+    if (secretManager) {
+        if (!checkForExistingSecretManager) {
+            removeProfileFolder(activeOnboardingProfile.id)
         } else {
             return
         }
     }
 
-    const profileManagerOptions = await buildProfileManagerOptionsFromProfileData(get(onboardingProfile))
-    const { storagePath, coinType, clientOptions, secretManager } = profileManagerOptions
-    const { id } = get(onboardingProfile)
-    const manager = await initialiseProfileManager(id, storagePath, coinType, clientOptions, secretManager)
-    profileManager.set(manager)
-    updateOnboardingProfile({ hasInitialisedProfileManager: true })
+    const storagePath = await getStorageDirectoryOfProfile(activeOnboardingProfile.id)
+
+    const secretManagerOptions = getSecretManagerFromProfileType(activeOnboardingProfile.type, storagePath)
+
+    updateOnboardingProfile({ secretManagerOptions, hasInitialisedProfileManager: true })
 }

packages/shared/lib/contexts/onboarding/actions/migrateStrongholdFromOnboardingProfile.ts

@@ -1,7 +1,7 @@
 import { get } from 'svelte/store'
 
 import { getStorageDirectoryOfProfile } from '@core/profile/utils'
-import { destroyProfileManager } from '@core/profile-manager/actions'
+import { clearProfileFromMemory } from '@core/profile-manager/actions'
 import { api } from '@core/profile-manager/api'
 import { getSecretManagerPath } from '@core/profile-manager/utils'
 import { StrongholdVersion } from '@core/stronghold/enums'
@@ -23,6 +23,6 @@ export async function migrateStrongholdFromOnboardingProfile(password: string):
         updateOnboardingProfile({ strongholdVersion: StrongholdVersion.V3 })
     }
 
-    await destroyProfileManager()
+    await clearProfileFromMemory()
     await initialiseProfileManagerFromOnboardingProfile()
 }

packages/shared/lib/contexts/onboarding/interfaces/onboarding-profile.interface.ts

@@ -1,9 +1,12 @@
-import { IPersistedProfile } from '@core/profile'
+import { IPersistedProfile, ProfileType } from '@core/profile'
 import { CreateProfileType, OnboardingType, RestoreProfileType } from '../enums'
 import { ImportFile, Mnemonic } from '../types'
 import { IShimmerClaimingAccount } from './shimmer-claiming-account.interface'
 
-export interface IOnboardingProfile extends IPersistedProfile {
+export interface IOnboardingProfile extends Omit<Partial<IPersistedProfile>, 'id' | 'type'> {
+    id: string,
+    type: ProfileType
+
     // Onboarding flow indicators
     onboardingType?: OnboardingType
     createProfileType?: CreateProfileType

packages/shared/lib/contexts/onboarding/stores/index.ts

@@ -1,3 +1,4 @@
 export * from './onboarding-profile.store'
+export * from './onboarding-secret-manager.store'
 export * from './shimmer-claiming-profile-manager.store'
 export * from './shimmer-claiming-transactions.store'

packages/shared/lib/contexts/onboarding/stores/onboarding-profile.store.ts

@@ -1,12 +1,13 @@
 import { derived, get, Readable, writable } from 'svelte/store'
 
-import { isLedgerProfile } from '@core/profile'
+import { isLedgerProfile, ProfileType } from '@core/profile'
 
 import { IOnboardingProfile, IShimmerClaimingAccount } from '../interfaces'
 import { IBaseToken } from '@core/wallet/interfaces'
 import { IPersistedNetwork } from '@core/network'
 
-export const onboardingProfile = writable<Partial<IOnboardingProfile>>(null)
+
+export const onboardingProfile = writable<IOnboardingProfile | null>(null)
 
 export const isOnboardingLedgerProfile: Readable<boolean> = derived(onboardingProfile, ($onboardingProfile) =>
     isLedgerProfile($onboardingProfile?.type)

packages/shared/lib/contexts/onboarding/stores/onboarding-secret-manager.store.ts

@@ -0,0 +1,17 @@
+import { onboardingProfile } from '@contexts/onboarding/stores';
+import { api } from '@core/api';
+import { SecretManager } from '@iota/sdk';
+import { Readable, derived } from 'svelte/store';
+
+const onboardingProfileSecretManagerOptions = derived(onboardingProfile, (onboardingProfile) => onboardingProfile.secretManagerOptions);
+
+export const onboardingProfileSecretManager: Readable<SecretManager | null> = derived(onboardingProfileSecretManagerOptions, (onboardingProfileSecretManagerOptions, set) => {
+    if (onboardingProfileSecretManagerOptions) {
+        api.createSecretManager(onboardingProfileSecretManagerOptions)
+            .then((secretManager) => {
+                set(secretManager)
+            })
+    } else {
+        set(null)
+    }
+})

packages/shared/lib/core/account/interfaces/account.interface.ts

@@ -35,8 +35,21 @@ import type {
     ParticipationEventType,
     ParticipationEventId,
     Burn,
+    WalletEventType,
+    IAuth,
 } from '@iota/sdk/out/types'
+import type {
+    IClientOptions,
+    GenerateAddressOptions,
+    LedgerNanoStatus,
+    INodeInfoWrapper,
+    SyncOptions,
+    WalletEvent,
+    WalletEventType,
+} from '@iota/sdk/out/types'
+import { WalletApiEventHandler } from '@core/wallet'
 
+// TODO(2.0): rename to IWallet & check all functions in this interface to make sure they still exist
 export interface IAccount {
     isStrongholdPasswordAvailable(): Promise<boolean>
     getClient(): Promise<Client>
@@ -118,4 +131,19 @@ export interface IAccount {
     transactions(): Promise<Transaction[]>
     unspentOutputs(filterOptions?: FilterOptions): Promise<OutputData[]>
     prepareVote(eventId?: string, answers?: number[]): Promise<PreparedTransaction>
+    listen(eventTypes: WalletEventType[], callback: WalletApiEventHandler): Promise<void>
+    clearListeners(eventTypes: WalletEventType[]): Promise<void>
+    backup(destination: string, password: string): Promise<void>
+    destroy(): Promise<void>
+    emitTestEvent(event: WalletEvent): Promise<void>
+    restoreBackup(
+        source: string,
+        password: string,
+        ignoreIfCoinTypeMismatch: boolean,
+        ignoreIfBech32Mismatch: string
+    ): Promise<void>
+    setClientOptions(options: IClientOptions): Promise<void>
+    startBackgroundSync(options?: SyncOptions, intervalInMilliseconds?: number): Promise<void>
+    stopBackgroundSync(): Promise<void>
+    updateNodeAuth(url: string, auth?: IAuth): Promise<void>
 }

packages/shared/lib/core/api/interfaces/api.interface.ts

@@ -2,6 +2,7 @@ import { IAccount } from '@core/account'
 import { SecretManager } from '@iota/sdk'
 import { AccountId, FoundryId, HexEncodedString, NftId, Output, OutputId, SecretManagerType, TransactionId, WalletOptions, Bech32Address } from '@iota/sdk/out/types'
 
+// TODO(2.0): Every method should return a promise (maybe except Utils, needs research)
 export interface IApi {
     createSecretManager(options: SecretManagerType): Promise<SecretManager>
     createAccount(id: string, payload: WalletOptions): Promise<IAccount>

packages/shared/lib/core/network/interfaces/auth.interface.ts

@@ -1,4 +1,3 @@
-export * from './auth.interface'
 export * from './chain-metadata.interface'
 export * from './connected-chain.interface'
 export * from './client-options.interface'