chore: add getDisabledCaipNetworks to appkit (#5098)

Author: magiziz

.changeset/moody-wolves-jog.md

@@ -0,0 +1,29 @@
+---
+'@reown/appkit-controllers': patch
+'@reown/appkit-scaffold-ui': patch
+'@reown/appkit': patch
+'pay-test-exchange': patch
+'@reown/appkit-adapter-bitcoin': patch
+'@reown/appkit-adapter-ethers': patch
+'@reown/appkit-adapter-ethers5': patch
+'@reown/appkit-adapter-solana': patch
+'@reown/appkit-adapter-wagmi': patch
+'@reown/appkit-utils': patch
+'@reown/appkit-cdn': patch
+'@reown/appkit-cli': patch
+'@reown/appkit-codemod': patch
+'@reown/appkit-common': patch
+'@reown/appkit-core': patch
+'@reown/appkit-experimental': patch
+'@reown/appkit-pay': patch
+'@reown/appkit-polyfills': patch
+'@reown/appkit-siwe': patch
+'@reown/appkit-siwx': patch
+'@reown/appkit-testing': patch
+'@reown/appkit-ui': patch
+'@reown/appkit-universal-connector': patch
+'@reown/appkit-wallet': patch
+'@reown/appkit-wallet-button': patch
+---
+
+Added `getDisabledCaipNetworks` to AppKit to get disabled caip networks

packages/appkit/src/client/appkit-base-client.ts

@@ -1909,6 +1909,18 @@ export abstract class AppKitBaseClient {
     return this.universalProvider
   }
 
+  public getDisabledCaipNetworks() {
+    const approvedCaipNetworkIds = ChainController.getAllApprovedCaipNetworkIds()
+    const requestedCaipNetworks = ChainController.getAllRequestedCaipNetworks()
+
+    const sortedNetworks = CoreHelperUtil.sortRequestedNetworks(
+      approvedCaipNetworkIds,
+      requestedCaipNetworks
+    )
+
+    return sortedNetworks.filter(network => ChainController.isCaipNetworkDisabled(network))
+  }
+
   // - Utils -------------------------------------------------------------------
   protected handleAlertError(error: Error) {
     const matchedUniversalProviderError = Object.entries(ErrorUtil.UniversalProviderErrors).find(

packages/appkit/tests/client/appkit-base-client.test.ts

@@ -2,7 +2,7 @@ import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest'
 import type { MockInstance } from 'vitest'
 
 import { ConstantsUtil } from '@reown/appkit-common'
-import type { CaipNetwork, ChainNamespace } from '@reown/appkit-common'
+import type { CaipNetwork, CaipNetworkId, ChainNamespace } from '@reown/appkit-common'
 import {
   AlertController,
   ApiController,
@@ -484,3 +484,48 @@ describe('AppKitBaseClient.open', () => {
     )
   })
 })
+
+describe('AppKitBaseClient.getDisabledCaipNetworks', () => {
+  let baseClient: AppKitBaseClient
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+
+    baseClient = new (class extends AppKitBaseClient {
+      constructor() {
+        super({
+          projectId: 'test-project-id',
+          networks: [mainnet],
+          adapters: [],
+          sdkVersion: 'html-wagmi-1'
+        })
+      }
+
+      async injectModalUi() {}
+      async syncIdentity() {}
+    })()
+  })
+
+  it('should return only disabled requested caipNetworks', () => {
+    const approvedIds = ['eip155:1', 'solana:101'] as CaipNetworkId[]
+    const requestedNetworks = [
+      { id: 1, chainNamespace: 'eip155', caipNetworkId: 'eip155:1' },
+      { id: 101, chainNamespace: 'solana', caipNetworkId: 'solana:101' },
+      { id: 56, chainNamespace: 'eip155', caipNetworkId: 'eip155:56' }
+    ] as unknown as CaipNetwork[]
+
+    vi.spyOn(ChainController, 'getAllApprovedCaipNetworkIds').mockReturnValue(approvedIds)
+    vi.spyOn(ChainController, 'getAllRequestedCaipNetworks').mockReturnValue(requestedNetworks)
+    vi.spyOn(CoreHelperUtil, 'sortRequestedNetworks').mockReturnValue(requestedNetworks)
+
+    const isDisabledMock = vi
+      .spyOn(ChainController, 'isCaipNetworkDisabled')
+      .mockImplementation(network => network.caipNetworkId === 'eip155:56')
+
+    const result = baseClient.getDisabledCaipNetworks()
+
+    expect(isDisabledMock).toHaveBeenCalled()
+    expect(result).toHaveLength(1)
+    expect(result[0]?.caipNetworkId).toBe('eip155:56')
+  })
+})

packages/controllers/src/controllers/ChainController.ts

@@ -879,6 +879,26 @@ const controller = {
     }
 
     return []
+  },
+
+  isCaipNetworkDisabled(network: CaipNetwork) {
+    const networkNamespace = network.chainNamespace
+    const isNextNamespaceConnected = Boolean(
+      ChainController.getAccountData(networkNamespace)?.caipAddress
+    )
+    const approvedCaipNetworkIds = ChainController.getAllApprovedCaipNetworkIds()
+    const shouldSupportAllNetworks =
+      ChainController.getNetworkProp('supportsAllNetworks', networkNamespace) !== false
+    const connectorId = ConnectorController.getConnectorId(networkNamespace)
+    const authConnector = ConnectorController.getAuthConnector()
+    const isConnectedWithAuth =
+      connectorId === CommonConstantsUtil.CONNECTOR_ID.AUTH && authConnector
+
+    if (!isNextNamespaceConnected || shouldSupportAllNetworks || isConnectedWithAuth) {
+      return false
+    }
+
+    return !approvedCaipNetworkIds?.includes(network.caipNetworkId)
   }
 }
 

packages/scaffold-ui/src/views/w3m-networks-view/index.ts

@@ -2,12 +2,11 @@ import { LitElement, html } from 'lit'
 import { state } from 'lit/decorators.js'
 import { ifDefined } from 'lit/directives/if-defined.js'
 
-import { type CaipNetwork, ConstantsUtil } from '@reown/appkit-common'
+import { type CaipNetwork } from '@reown/appkit-common'
 import {
   AssetController,
   AssetUtil,
   ChainController,
-  ConnectorController,
   CoreHelperUtil,
   NetworkUtil
 } from '@reown/appkit-controllers'
@@ -113,32 +112,13 @@ export class W3mNetworksView extends LitElement {
           type="network"
           name=${network.name ?? network.id}
           @click=${() => this.onSwitchNetwork(network)}
-          .disabled=${this.getNetworkDisabled(network)}
+          .disabled=${ChainController.isCaipNetworkDisabled(network)}
           data-testid=${`w3m-network-switch-${network.name ?? network.id}`}
         ></wui-list-network>
       `
     )
   }
 
-  private getNetworkDisabled(network: CaipNetwork) {
-    const networkNamespace = network.chainNamespace
-    const isNextNamespaceConnected = Boolean(
-      ChainController.getAccountData(networkNamespace)?.caipAddress
-    )
-    const approvedCaipNetworkIds = ChainController.getAllApprovedCaipNetworkIds()
-    const shouldSupportAllNetworks =
-      ChainController.getNetworkProp('supportsAllNetworks', networkNamespace) !== false
-    const connectorId = ConnectorController.getConnectorId(networkNamespace)
-    const authConnector = ConnectorController.getAuthConnector()
-    const isConnectedWithAuth = connectorId === ConstantsUtil.CONNECTOR_ID.AUTH && authConnector
-
-    if (!isNextNamespaceConnected || shouldSupportAllNetworks || isConnectedWithAuth) {
-      return false
-    }
-
-    return !approvedCaipNetworkIds?.includes(network.caipNetworkId)
-  }
-
   private onSwitchNetwork(network: CaipNetwork) {
     NetworkUtil.onSwitchNetwork({ network })
   }