chore: improve network id typechecks (#2305)

* rename stardustnetworkId into SupportedStardustNetworkId * rename EvmNetworkId to SupportedEvmNetworkId * use evm and stardust network ID into correct places * move supported networks into constants * PR fixes * fix supported network id * improve network typings * fix circular dependency * chore: use const --------- Co-authored-by: Tuditi <[email protected]> Co-authored-by: Tuditi <[email protected]>
bloomwalletio · Apr 12, 2024 · cd77257 · cd77257
1 parent 8101e6a
commit cd77257
Show file tree

Hide file tree

Showing 117 changed files with 336 additions and 332 deletions.
diff --git a/packages/desktop/components/NetworkCard.svelte b/packages/desktop/components/NetworkCard.svelte
@@ -12,7 +12,7 @@
         Network,
         NetworkHealth,
         NetworkNamespace,
-        chainStatuses,
+        evmNetworkStatuses,
         getDefaultExplorerUrl,
         networkStatus,
         setSelectedChain,
@@ -31,7 +31,7 @@
     let status: NetworkHealth
     const explorer = getDefaultExplorerUrl(network.id, ExplorerEndpoint.Address)
 
-    $: $networkStatus, $chainStatuses, $selectedAccount, setNetworkCardData()
+    $: $networkStatus, $evmNetworkStatuses, $selectedAccount, setNetworkCardData()
 
     function onExplorerClick(): void {
         if (!explorer || !address) {

diff --git a/packages/desktop/components/popup/popups/ImportErc20TokenFormPopup.svelte b/packages/desktop/components/popup/popups/ImportErc20TokenFormPopup.svelte
@@ -3,7 +3,7 @@
     import { NetworkInput } from '@ui'
     import { localize } from '@core/i18n'
     import { getEvmTokenMetadata } from '@core/layer-2/utils'
-    import { NetworkId } from '@core/network'
+    import { EvmNetworkId } from '@core/network'
     import { validateEthereumAddress } from '@core/utils'
     import PopupTemplate from '../PopupTemplate.svelte'
     import { closePopup } from '@desktop/auxiliary/popup'
@@ -13,7 +13,7 @@
 
     let busy = false
 
-    let networkId: NetworkId
+    let networkId: EvmNetworkId
 
     let tokenAddress: string
     let tokenAddressError = ''

diff --git a/packages/desktop/components/popup/popups/ImportErc721TokenFormPopup.svelte b/packages/desktop/components/popup/popups/ImportErc721TokenFormPopup.svelte
@@ -2,7 +2,7 @@
     import { TextInput } from '@bloomwalletio/ui'
     import { NetworkInput } from '@ui'
     import { localize } from '@core/i18n'
-    import { NetworkId } from '@core/network'
+    import { EvmNetworkId } from '@core/network'
     import { validateEthereumAddress } from '@core/utils'
     import PopupTemplate from '../PopupTemplate.svelte'
     import { closePopup } from '@desktop/auxiliary/popup'
@@ -21,7 +21,7 @@
 
     let busy = false
 
-    let networkId: NetworkId
+    let networkId: EvmNetworkId
 
     let tokenAddress: string
 

diff --git a/packages/desktop/components/popup/popups/SiwePopup.svelte b/packages/desktop/components/popup/popups/SiwePopup.svelte
@@ -7,7 +7,7 @@
     import { signMessage } from '@core/wallet/actions'
     import { Table, Tabs, Text } from '@bloomwalletio/ui'
     import { IAccountState } from '@core/account'
-    import { IEvmNetwork, NetworkId, getNameFromNetworkId } from '@core/network'
+    import { IEvmNetwork, EvmNetworkId, getNameFromNetworkId } from '@core/network'
     import { AccountLabel, DappInfo, KeyValue, NetworkLabel } from '@ui'
     import { checkActiveProfileAuth } from '@core/profile/actions'
     import { LedgerAppName } from '@core/ledger'
@@ -39,7 +39,7 @@
 
     let selectedTab = TABS[0]
     let isBusy = false
-    const networkId = `eip155:${siweObject.chainId}` as NetworkId
+    const networkId: EvmNetworkId = `eip155:${siweObject.chainId}`
 
     async function onConfirmClick(): Promise<void> {
         try {

diff --git a/packages/desktop/components/popup/popups/SyncAccountsPopup.svelte b/packages/desktop/components/popup/popups/SyncAccountsPopup.svelte
@@ -15,8 +15,9 @@
     import { closePopup } from '@desktop/auxiliary/popup'
     import { onDestroy } from 'svelte'
     import PopupTemplate from '../PopupTemplate.svelte'
-    import { StardustNetworkId } from '@core/network/enums'
+    import { SupportedStardustNetworkId } from '@core/network/constants'
     import { ledgerRaceConditionProtectionWrapper } from '@core/ledger'
+    import { StardustNetworkId } from '@core/network/types'
 
     const { network, type } = $activeProfile
 
@@ -38,9 +39,9 @@
     $: totalBalance = sumBalanceForAccounts($visibleActiveAccounts)
 
     const networkSearchMethod: { [key in StardustNetworkId]?: () => Promise<void> } = {
-        [StardustNetworkId.Iota]: multiAddressSearch,
-        [StardustNetworkId.Shimmer]: singleAddressSearch,
-        [StardustNetworkId.Testnet]: singleAddressSearch,
+        [SupportedStardustNetworkId.Iota]: multiAddressSearch,
+        [SupportedStardustNetworkId.Shimmer]: singleAddressSearch,
+        [SupportedStardustNetworkId.Testnet]: singleAddressSearch,
     }
 
     async function singleAddressSearch(): Promise<void> {

diff --git a/packages/desktop/views/dashboard/campaigns/views/CampaignDetailsView.svelte b/packages/desktop/views/dashboard/campaigns/views/CampaignDetailsView.svelte
@@ -9,7 +9,7 @@
     import { IAccountState, getAddressFromAccountForNetwork } from '@core/account'
     import { selectedAccount } from '@core/account/stores'
     import { handleError } from '@core/error/handlers'
-    import { NetworkId, NetworkNamespace, getEvmNetwork } from '@core/network'
+    import { EvmNetworkId, NetworkNamespace, getEvmNetwork } from '@core/network'
     import { buildNftFromPersistedErc721Nft } from '@core/nfts'
     import { addNftsToDownloadQueue, updateAllAccountNftsForAccount } from '@core/nfts/actions'
     import { persistErc721Nft } from '@core/nfts/actions/persistErc721Nft'
@@ -26,14 +26,14 @@
     let userAddress: string
     let numberOfTasks: number | undefined
 
-    $: evmNetwork = getEvmNetwork(`${NetworkNamespace.Evm}:${$selectedCampaign.chainId}` as NetworkId)
+    $: evmNetwork = getEvmNetwork(`${NetworkNamespace.Evm}:${$selectedCampaign.chainId}` as EvmNetworkId)
     $: ({ board: leaderboard, userPosition } = $campaignLeaderboards[$selectedCampaign.projectId]?.[
         $selectedCampaign.id
     ] ?? { board: undefined, userPosition: undefined })
     $: fetchAndPersistTideData($selectedAccount, evmNetwork?.id)
     $: userNft = $ownedNfts.find((nft) => nft.id?.startsWith($selectedCampaign.address.toLowerCase()))
 
-    function fetchAndPersistTideData(account: IAccountState, networkId: NetworkId): void {
+    function fetchAndPersistTideData(account: IAccountState, networkId: EvmNetworkId): void {
         if (networkId) {
             userAddress = getAddressFromAccountForNetwork(account, networkId)?.toLowerCase()
             void fetchAndPersistUserPosition(userAddress)

diff --git a/packages/desktop/views/dashboard/collectibles/components/Erc721CollectibleDetails.svelte b/packages/desktop/views/dashboard/collectibles/components/Erc721CollectibleDetails.svelte
@@ -3,7 +3,7 @@
     import { type IItem } from '@bloomwalletio/ui'
     import { localize } from '@core/i18n'
     import { IErc721Nft } from '@core/nfts'
-    import { ExplorerEndpoint, NetworkId, getDefaultExplorerUrl } from '@core/network'
+    import { ExplorerEndpoint, EvmNetworkId, getDefaultExplorerUrl } from '@core/network'
     import CollectibleDetails from './CollectibleDetails.svelte'
     import { buildUrl } from '@core/utils'
 
@@ -13,7 +13,7 @@
     const address = contractMetadata.address
     const explorerEndpoint = getExplorerEndpoint(networkId)
 
-    function getExplorerEndpoint(networkId: NetworkId): string | undefined {
+    function getExplorerEndpoint(networkId: EvmNetworkId): string | undefined {
         const { baseUrl, endpoint } = getDefaultExplorerUrl(networkId, ExplorerEndpoint.Token)
         const url = buildUrl({
             origin: baseUrl,

diff --git a/packages/desktop/views/dashboard/components/DashboardSidebar.svelte b/packages/desktop/views/dashboard/components/DashboardSidebar.svelte
@@ -4,7 +4,7 @@
     import { ProfileActionsMenu, SidebarTab } from '@components'
     import { APP_STAGE, AppStage } from '@core/app'
     import { localize } from '@core/i18n'
-    import { StardustNetworkId } from '@core/network'
+    import { SupportedStardustNetworkId } from '@core/network'
     import { activeProfile, isSoftwareProfile } from '@core/profile/stores'
     import {
         DashboardRoute,
@@ -60,8 +60,8 @@
             : []),
         ...(features?.campaigns?.enabled &&
         profileFeatures?.campaigns &&
-        ($activeProfile?.network?.id === StardustNetworkId.Shimmer ||
-            $activeProfile?.network?.id === StardustNetworkId.Testnet)
+        ($activeProfile?.network?.id === SupportedStardustNetworkId.Shimmer ||
+            $activeProfile?.network?.id === SupportedStardustNetworkId.Testnet)
             ? [
                   {
                       icon: IconName.Trophy,
@@ -78,9 +78,9 @@
                       label: localize('tabs.buySell'),
                       route: DashboardRoute.BuySell,
                       onClick: openBuySell,
-                      disabled: $activeProfile?.network?.id !== StardustNetworkId.Iota,
+                      disabled: $activeProfile?.network?.id !== SupportedStardustNetworkId.Iota,
                       tooltip:
-                          $activeProfile?.network?.id !== StardustNetworkId.Iota
+                          $activeProfile?.network?.id !== SupportedStardustNetworkId.Iota
                               ? localize('tabs.tooltips.buySell')
                               : '',
                   },

diff --git a/...s/desktop/views/dashboard/drawers/network-config/views/components/AddIscpChainForm.svelte b/...s/desktop/views/dashboard/drawers/network-config/views/components/AddIscpChainForm.svelte
@@ -4,11 +4,11 @@
     import {
         MAX_NETWORK_NAME_LENGTH,
         EvmNetworkType,
-        IIscpChainConfiguration,
+        IIscpEvmNetworkConfiguration,
         ETHEREUM_COIN_TYPE,
-        NetworkId,
         EvmNetworkId,
         NetworkNamespace,
+        ChainId,
     } from '@core/network'
     import { activeProfile } from '@core/profile/stores'
     import { getNetworkHrp } from '@core/profile/actions'
@@ -25,11 +25,11 @@
     let explorerUrlError = ''
     $: submitDisabled = !evmNetwork.name || !evmNetwork.aliasAddress || !evmNetwork.rpcEndpoint
 
-    const evmNetwork: IIscpChainConfiguration = {
+    const evmNetwork: IIscpEvmNetworkConfiguration = {
         type: EvmNetworkType.Iscp,
-        id: '' as NetworkId,
+        id: '' as EvmNetworkId,
         namespace: NetworkNamespace.Evm,
-        chainId: '' as EvmNetworkId,
+        chainId: '' as ChainId,
         name: '',
         aliasAddress: '',
         rpcEndpoint: '',

diff --git a/packages/desktop/views/dashboard/send-flow/views/SelectTokenView.svelte b/packages/desktop/views/dashboard/send-flow/views/SelectTokenView.svelte
@@ -41,7 +41,7 @@
     } else if (
         selectedToken &&
         isStardustNetwork(selectedToken.networkId) &&
-        !canAccountMakeStardustTransaction($selectedAccountIndex, selectedToken.networkId, $sendFlowParameters?.type)
+        !canAccountMakeStardustTransaction($selectedAccountIndex, $sendFlowParameters?.type)
     ) {
         tokenError = localize('error.send.insufficientFundsTransaction')
     } else {

diff --git a/...ages/desktop/views/dashboard/send-flow/views/components/StardustTransactionDetails.svelte b/...ages/desktop/views/dashboard/send-flow/views/components/StardustTransactionDetails.svelte
@@ -9,7 +9,7 @@
     import { DateTimePickerMenu } from '.'
     import StorageDepositButton from './StorageDepositButton.svelte'
 
-    export let destinationNetworkId: NetworkId = undefined
+    export let destinationNetworkId: NetworkId | undefined = undefined
     export let storageDeposit: bigint | undefined = undefined
     export let transactionFee: bigint | undefined = undefined
     export let giftStorageDeposit: boolean | undefined = undefined

diff --git a/packages/desktop/views/dashboard/wallet/tab-section/portfolio/components/TokenListRow.svelte b/packages/desktop/views/dashboard/wallet/tab-section/portfolio/components/TokenListRow.svelte
@@ -1,7 +1,7 @@
 <script lang="ts">
     import { formatCurrency } from '@core/i18n'
     import { getFiatValueFromTokenAmount, getMarketPriceForToken } from '@core/market/actions'
-    import { StardustNetworkId, TokenSupply, getActiveNetworkId } from '@core/network'
+    import { SupportedStardustNetworkId, TokenSupply, getActiveNetworkId } from '@core/network'
     import { BASE_TOKEN_ID, ITokenWithBalance, formatTokenAmountBestMatch } from '@core/token'
     import { truncateString } from '@core/utils'
     import { PopupId, openPopup } from '@desktop/auxiliary/popup'
@@ -20,11 +20,11 @@
 
         let tokenSupply: TokenSupply | '0'
         switch (getActiveNetworkId()) {
-            case StardustNetworkId.Iota:
+            case SupportedStardustNetworkId.Iota:
                 tokenSupply = TokenSupply.Iota
                 break
-            case StardustNetworkId.Shimmer:
-            case StardustNetworkId.Testnet:
+            case SupportedStardustNetworkId.Shimmer:
+            case SupportedStardustNetworkId.Testnet:
                 tokenSupply = TokenSupply.Shimmer
                 break
             default:

diff --git a/...ages/desktop/views/onboarding/views/complete-onboarding/views/FinishOnboardingView.svelte b/...ages/desktop/views/onboarding/views/complete-onboarding/views/FinishOnboardingView.svelte
@@ -11,15 +11,16 @@
     import LoggedOutLayout from '@views/components/LoggedOutLayout.svelte'
     import features from '@features/features'
     import { login } from '@core/profile/actions'
-    import { StardustNetworkId } from '@core/network'
+    import { SupportedStardustNetworkId } from '@core/network'
     import { handleError } from '@core/error/handlers'
     import { onMount } from 'svelte'
 
     const LOCALE_KEY = 'views.onboarding.completeOnboarding.finishOnboarding'
 
     let isAppSetup = false
 
-    $: appName = $onboardingProfile?.network?.id === StardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
+    $: appName =
+        $onboardingProfile?.network?.id === SupportedStardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
 
     async function onContinueClick(): Promise<void> {
         try {

diff --git a/packages/desktop/views/onboarding/views/create-from-ledger/views/ConnectLedgerView.svelte b/packages/desktop/views/onboarding/views/create-from-ledger/views/ConnectLedgerView.svelte
@@ -6,13 +6,14 @@
     import { createFromLedgerRouter } from '..'
     import { CreateFromLedgerRoute } from '../create-from-ledger-route.enum'
     import { onboardingProfile } from '@contexts/onboarding'
-    import { StardustNetworkId } from '@core/network'
+    import { SupportedStardustNetworkId } from '@core/network'
 
     $: isDisconnected = $ledgerConnectionState === LedgerConnectionState.Disconnected
     $: isLocked = isDisconnected || $ledgerConnectionState === LedgerConnectionState.Locked
-    $: appName = $onboardingProfile?.network?.id === StardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
+    $: appName =
+        $onboardingProfile?.network?.id === SupportedStardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
     $: isCorrectAppOpen =
-        $onboardingProfile?.network?.id === StardustNetworkId.Iota
+        $onboardingProfile?.network?.id === SupportedStardustNetworkId.Iota
             ? $ledgerConnectionState === LedgerConnectionState.IotaAppOpen
             : $ledgerConnectionState === LedgerConnectionState.ShimmerAppOpen
 

diff --git a/packages/desktop/views/onboarding/views/create-from-ledger/views/InstallLedgerView.svelte b/packages/desktop/views/onboarding/views/create-from-ledger/views/InstallLedgerView.svelte
@@ -6,6 +6,7 @@
     import { onMount } from 'svelte'
     import { createFromLedgerRouter } from '../create-from-ledger-router'
     import { onboardingProfile } from '@contexts/onboarding'
+    import { SupportedStardustNetworkId } from '@core/network/constants'
 
     function onContinueClick(): void {
         $createFromLedgerRouter.next()
@@ -32,7 +33,7 @@
     }}
 >
     <content slot="content">
-        {#if $onboardingProfile?.network?.id === StardustNetworkId.Iota}
+        {#if $onboardingProfile?.network?.id === SupportedStardustNetworkId.Iota}
             <icon-container class="bg-black">
                 <Icon name={IconName.Iota} size="lg" customColor="#ffffff" />
             </icon-container>

diff --git a/...ng/views/create-from-ledger/views/ledger-connection-guide/components/LedgerAppOpen.svelte b/...ng/views/create-from-ledger/views/ledger-connection-guide/components/LedgerAppOpen.svelte
@@ -5,12 +5,14 @@
     import { LedgerAppName } from '@core/ledger'
     import { get } from 'svelte/store'
     import { onboardingProfile } from '@contexts/onboarding'
-    import { StardustNetworkId } from '@core/network'
+    import { SupportedStardustNetworkId } from '@core/network'
 
     const ledgerAppName: LedgerAppName =
-        get(onboardingProfile)?.network?.id === StardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
+        get(onboardingProfile)?.network?.id === SupportedStardustNetworkId.Iota
+            ? LedgerAppName.Iota
+            : LedgerAppName.Shimmer
     const icon: IconName =
-        get(onboardingProfile)?.network?.id === StardustNetworkId.Iota ? IconName.Iota : IconName.Shimmer
+        get(onboardingProfile)?.network?.id === SupportedStardustNetworkId.Iota ? IconName.Iota : IconName.Shimmer
 </script>
 
 <Text type="body2" textColor="secondary" align="center">

diff --git a/packages/desktop/views/onboarding/views/network-setup/views/ChooseNetworkView.svelte b/packages/desktop/views/onboarding/views/network-setup/views/ChooseNetworkView.svelte
@@ -8,8 +8,8 @@
     } from '@contexts/onboarding'
     import { localize } from '@core/i18n'
     import {
-        NetworkId,
         NetworkNamespace,
+        StardustNetworkId,
         StardustNetworkName,
         getDefaultClientOptions,
         getDefaultPersistedNetwork,
@@ -39,7 +39,7 @@
     function onContinueClick(): void {
         if (selectedNetworkType !== OnboardingNetworkType.Custom) {
             const networkName = getNetworkNameFromOnboardingNetworkType(selectedNetworkType)
-            const networkId: NetworkId = `${NetworkNamespace.Stardust}:${networkName}`
+            const networkId: StardustNetworkId = `${NetworkNamespace.Stardust}:${networkName}`
             const network = getDefaultPersistedNetwork(networkId)
             const clientOptions = getDefaultClientOptions(networkId)
             updateOnboardingProfile({ network, clientOptions })

diff --git a/packages/desktop/views/onboarding/views/restore-profile/views/BalanceFinderView.svelte b/packages/desktop/views/onboarding/views/restore-profile/views/BalanceFinderView.svelte
@@ -5,7 +5,8 @@
     import { DEFAULT_SYNC_OPTIONS } from '@core/account/constants'
     import { localize } from '@core/i18n'
     import { LedgerAppName, checkOrConnectLedger, ledgerRaceConditionProtectionWrapper } from '@core/ledger'
-    import { StardustNetworkId } from '@core/network'
+    import { SupportedStardustNetworkId } from '@core/network/constants'
+    import { NetworkId } from '@core/network/types'
     import { ProfileType } from '@core/profile'
     import { RecoverAccountsPayload, createAccount, recoverAccounts } from '@core/profile-manager'
     import { DEFAULT_ACCOUNT_RECOVERY_CONFIGURATION } from '@core/profile/constants'
@@ -34,10 +35,10 @@
 
     let accountsBalances: IAccountBalance[] = []
 
-    const networkSearchMethod: { [key in StardustNetworkId]?: () => Promise<void> } = {
-        [StardustNetworkId.Iota]: multiAddressSearch,
-        [StardustNetworkId.Shimmer]: singleAddressSearch,
-        [StardustNetworkId.Testnet]: singleAddressSearch,
+    const networkSearchMethod: { [key in NetworkId]?: () => Promise<void> } = {
+        [SupportedStardustNetworkId.Iota]: multiAddressSearch,
+        [SupportedStardustNetworkId.Shimmer]: singleAddressSearch,
+        [SupportedStardustNetworkId.Testnet]: singleAddressSearch,
     }
 
     async function singleAddressSearch(): Promise<void> {
@@ -133,7 +134,7 @@
     async function onFindBalancesClick(): Promise<void> {
         if (type === ProfileType.Ledger) {
             await checkOrConnectLedger(
-                network?.id === StardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
+                network?.id === SupportedStardustNetworkId.Iota ? LedgerAppName.Iota : LedgerAppName.Shimmer
             )
         }
         await findBalances()

diff --git a/packages/shared/src/components/activities/evm/info/EvmGenericInformation.svelte b/packages/shared/src/components/activities/evm/info/EvmGenericInformation.svelte
@@ -1,13 +1,13 @@
 <script lang="ts">
     import { Table } from '@bloomwalletio/ui'
     import { getFormattedTimeStamp, localize } from '@core/i18n'
-    import { NetworkId } from '@core/network'
+    import { EvmNetworkId } from '@core/network'
     import { getBaseToken } from '@core/profile/actions'
     import { formatTokenAmountBestMatch } from '@core/token'
     import { NetworkLabel } from '@ui'
 
     export let time: Date
-    export let destinationNetworkId: NetworkId
+    export let destinationNetworkId: EvmNetworkId
     export let maxGasFee: bigint | undefined = undefined
     export let transactionFee: bigint | undefined = undefined