chore: replace subject type in all project with an enum (#7525)

Co-authored-by: Begoña Álvarez de la Cruz <balvarez@boxfish.studio>

packages/shared/components/SubjectBox.svelte

@@ -1,16 +1,16 @@
 <script lang="ts">
     import { localize } from '@core/i18n'
-    import { Subject } from '@core/wallet'
+    import { Subject, SubjectType } from '@core/wallet'
     import { Box, AddressBox, Text, AccountLabel, TextType, FontWeight } from 'shared/components'
 
     export let subject: Subject | null = null
 </script>
 
-{#if subject?.type === 'account'}
+{#if subject?.type === SubjectType.Account}
     <Box row clearBackground clearPadding classes="justify-center">
         <AccountLabel account={subject?.account} />
     </Box>
-{:else if subject?.type === 'address'}
+{:else if subject?.type === SubjectType.Address}
     <AddressBox clearBackground clearPadding isCopyable address={subject?.address} />
 {:else}
     <Box row clearBackground clearPadding classes="justify-center">

packages/shared/lib/auxiliary/deep-link/handlers/wallet/operations/handleDeepLinkSendConfirmationOperation.ts

@@ -4,6 +4,7 @@ import {
     NewTransactionDetails,
     NewTransactionType,
     Subject,
+    SubjectType,
     getAssetById,
     getUnitFromTokenMetadata,
     selectedAccountAssets,
@@ -58,7 +59,7 @@ function parseSendConfirmationOperation(searchParams: URLSearchParams): NewTrans
         throw new InvalidAddressError()
     }
 
-    const recipient: Subject = { type: 'address', address }
+    const recipient: Subject = { type: SubjectType.Address, address }
 
     const assetId = searchParams.get(SendOperationParameter.AssetId)
     assetId && validateAssetId(assetId)

packages/shared/lib/auxiliary/deep-link/handlers/wallet/operations/handleDeepLinkSendFormOperation.ts

@@ -6,6 +6,7 @@ import {
     getAssetById,
     NewTransactionType,
     getUnitFromTokenMetadata,
+    SubjectType,
 } from '@core/wallet'
 import { openPopup, PopupId } from '@auxiliary/popup'
 import { get } from 'svelte/store'
@@ -51,7 +52,7 @@ function parseSendFormOperation(searchParams: URLSearchParams): NewTransactionDe
     const rawAmount = getRawAmountFromSearchParam(searchParams)
     const metadata = searchParams.get(SendOperationParameter.Metadata)
     const tag = searchParams.get(SendOperationParameter.Tag)
-    const recipient: Subject = address ? { type: 'address', address } : undefined
+    const recipient: Subject = address ? { type: SubjectType.Address, address } : undefined
 
     return {
         type: NewTransactionType.TokenTransfer,

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

@@ -6,6 +6,7 @@ import {
     setNewTransactionDetails,
     NewTransactionType,
     NewTokenTransactionDetails,
+    SubjectType,
 } from '@core/wallet'
 import { logAndNotifyError } from '@core/error/actions'
 
@@ -66,7 +67,7 @@ async function claimShimmerRewardsForShimmerClaimingAccount(
 
     const newTransactionDetails: NewTokenTransactionDetails = {
         recipient: {
-            type: 'address',
+            type: SubjectType.Address,
             address: recipientAddress,
         },
         type: NewTransactionType.TokenTransfer,

packages/shared/lib/core/wallet/enums/index.ts

@@ -11,3 +11,4 @@ export * from './verified-status.enum'
 export * from './return-strategy.enum'
 export * from './inclusion-state.enum'
 export * from './irc27-version.enum'
+export * from './subject.enum'

packages/shared/lib/core/wallet/enums/subject.enum.ts

@@ -0,0 +1,4 @@
+export enum SubjectType {
+    Account = 'account',
+    Address = 'address',
+}

packages/shared/lib/core/wallet/interfaces/account-subject.interface.ts

@@ -1,6 +1,7 @@
 import { IAccountState } from '@core/account'
+import { SubjectType } from '../enums'
 
 export interface IAccountSubject {
-    type: 'account'
+    type: SubjectType.Account
     account: IAccountState
 }

packages/shared/lib/core/wallet/interfaces/address-subject.interface.ts

@@ -1,4 +1,6 @@
+import { SubjectType } from '../enums'
+
 export interface IAddressSubject {
-    type: 'address'
+    type: SubjectType.Address
     address: string
 }

packages/shared/lib/core/wallet/stores/selected-account-activities.store.ts

@@ -3,7 +3,7 @@ import { isValidIrc30Token } from '@core/token'
 
 import { selectedAccount } from '../../account/stores/selected-account.store'
 import { Activity } from '../types/activity.type'
-import { ActivityType } from '../enums'
+import { ActivityType, SubjectType } from '../enums'
 import { ActivityFilter } from '../interfaces/activity-filter.interface'
 import { getAssetFromPersistedAssets, getFormattedAmountFromActivity } from '../utils'
 import { isVisibleActivity } from '../utils/isVisibleActivity'
@@ -78,9 +78,9 @@ function getFieldsToSearchFromActivity(activity: Activity): string[] {
         fieldsToSearch.push(getFormattedAmountFromActivity(activity, false)?.toLowerCase())
     }
 
-    if (activity.subject?.type === 'account') {
+    if (activity.subject?.type === SubjectType.Account) {
         fieldsToSearch.push(activity.subject?.account?.name)
-    } else if (activity.subject?.type === 'address') {
+    } else if (activity.subject?.type === SubjectType.Address) {
         fieldsToSearch.push(activity.subject?.address)
     }
 

packages/shared/lib/core/wallet/utils/generateActivity/helper/getLayer2ActivityInformation.ts

@@ -1,6 +1,7 @@
 import { parseLayer2Metadata, getDestinationNetworkFromAddress } from '@core/layer-2/utils'
 import { Layer2Metadata } from '@core/layer-2/types'
 import { SenderInfo } from '../../../types'
+import { SubjectType } from '@core/wallet/enums'
 
 export function getLayer2ActivityInformation(
     metadata: string,
@@ -14,7 +15,7 @@ export function getLayer2ActivityInformation(
     try {
         parsedLayer2Metadata = parseLayer2Metadata(metadata)
         destinationNetwork = getDestinationNetworkFromAddress(
-            sendingInfo.subject?.type === 'address' ? sendingInfo.subject.address : undefined
+            sendingInfo.subject?.type === SubjectType.Address ? sendingInfo.subject.address : undefined
         )
     } catch (_err) {
         parsedLayer2Metadata = null

packages/shared/lib/core/wallet/utils/generateActivity/helper/getSubjectFromActivity.ts

@@ -1,18 +1,18 @@
 import { localize } from '@core/i18n'
 import { getLayer2NetworkFromAddress } from '@core/layer-2/utils'
 import { truncateString } from '@core/utils'
-import { ActivityType } from '@core/wallet/enums'
+import { ActivityType, SubjectType } from '@core/wallet/enums'
 import type { Activity, Subject } from '@core/wallet/types'
 
 export function getSubjectFromActivity(activity: Activity): Subject {
     if (activity.parsedLayer2Metadata) {
         return {
             ...activity.subject,
-            ...(activity.subject?.type === 'address' && {
+            ...(activity.subject?.type === SubjectType.Address && {
                 address: activity.parsedLayer2Metadata?.ethereumAddress,
             }),
         }
-    } else if (activity.subject?.type === 'address') {
+    } else if (activity.subject?.type === SubjectType.Address) {
         const network = getLayer2NetworkFromAddress(activity.subject.address)
         return { ...activity.subject, address: network ?? activity.subject.address }
     } else {
@@ -27,9 +27,9 @@ export function getSubjectLocaleFromActivity(activity: Activity): string {
         return localize('general.shimmerGenesis')
     } else if (activity.type === ActivityType.Vesting) {
         return localize('general.stardustGenesis')
-    } else if (subject?.type === 'account') {
+    } else if (subject?.type === SubjectType.Account) {
         return truncateString(subject?.account?.name, 13, 0)
-    } else if (subject?.type === 'address') {
+    } else if (subject?.type === SubjectType.Address) {
         const address = activity?.parsedLayer2Metadata?.ethereumAddress ?? subject?.address
         const network = getLayer2NetworkFromAddress(address)
 

packages/shared/lib/core/wallet/utils/getSubjectFromAddress.ts

@@ -1,11 +1,12 @@
 import { findActiveAccountWithAddress } from '@core/profile'
 import { Subject } from '../types'
+import { SubjectType } from '../enums'
 
 export function getSubjectFromAddress(address: string): Subject {
     const account = findActiveAccountWithAddress(address)
     if (account) {
-        return { type: 'account', account: account }
+        return { type: SubjectType.Account, account: account }
     } else {
-        return { type: 'address', address }
+        return { type: SubjectType.Address, address }
     }
 }

packages/shared/lib/core/wallet/utils/isSubjectInternal.ts

@@ -1,5 +1,6 @@
+import { SubjectType } from '../enums'
 import { Subject } from '../types'
 
 export function isSubjectInternal(subject: Subject | undefined): boolean {
-    return subject?.type === 'account'
+    return subject?.type === SubjectType.Account
 }

packages/shared/lib/core/wallet/utils/transactions/getSenderFromTransaction.ts

@@ -1,6 +1,7 @@
 import { Subject } from '@core/wallet/types'
 import { CommonOutput } from '@iota/sdk/out/types'
 import { getSenderFromOutput } from '../outputs/getSenderFromOutput'
+import { SubjectType } from '@core/wallet/enums'
 
 export function getSenderFromTransaction(
     isIncoming: boolean,
@@ -10,6 +11,6 @@ export function getSenderFromTransaction(
     if (isIncoming) {
         return getSenderFromOutput(output)
     } else {
-        return { type: 'address', address: accountAddress }
+        return { type: SubjectType.Address, address: accountAddress }
     }
 }