chore: siwe to siwx migration

.changeset/sour-timers-crash.md

@@ -0,0 +1,24 @@
+---
+'@reown/appkit-adapter-solana': minor
+'@reown/appkit-scaffold-ui': minor
+'@apps/laboratory': minor
+'@reown/appkit': minor
+'@reown/appkit-core': minor
+'@reown/appkit-siwe': minor
+'@reown/appkit-siwx': minor
+'@apps/demo': minor
+'@apps/gallery': minor
+'@reown/appkit-adapter-ethers': minor
+'@reown/appkit-adapter-ethers5': minor
+'@reown/appkit-adapter-polkadot': minor
+'@reown/appkit-adapter-wagmi': minor
+'@reown/appkit-utils': minor
+'@reown/appkit-cdn': minor
+'@reown/appkit-common': minor
+'@reown/appkit-experimental': minor
+'@reown/appkit-polyfills': minor
+'@reown/appkit-ui': minor
+'@reown/appkit-wallet': minor
+---
+
+Replace SIWE with new SIWX

apps/laboratory/tests/multichain/multichain-ethers-solana-email-siwe.spec.ts

@@ -59,7 +59,7 @@ test('it should switch to different namespace', async () => {
   const chainName = 'Solana'
 
   await page.switchNetwork(chainName)
-  await page.openNetworks()
+  await validator.expectUnauthenticated()
   await validator.expectSwitchedNetwork(chainName)
   await page.closeModal()
 

apps/laboratory/tests/multichain/multichain-ethers-solana-siwe.spec.ts

@@ -28,6 +28,9 @@ test.beforeAll(async ({ browser }) => {
   await modalPage.load()
   await modalPage.qrCodeFlow(modalPage, walletPage)
   await modalValidator.expectConnected()
+  await modalPage.promptSiwe()
+  await walletPage.handleRequest({ accept: true })
+  await modalValidator.expectAuthenticated()
 })
 
 test.afterAll(async () => {
@@ -53,5 +56,5 @@ test('it should switch networks and sign siwe', async () => {
 test('it should switch to Solana and validate chain title', async () => {
   const chainName = 'Solana'
   await modalPage.switchNetwork(chainName)
-  await modalValidator.expectSwitchChainView(chainName.toLocaleLowerCase())
+  await modalValidator.expectSwitchedNetworkOnNetworksView(chainName)
 })

apps/laboratory/tests/multichain/multichain-ethers5-solana-email-siwe.spec.ts

@@ -59,7 +59,7 @@ test('it should switch to different namespace', async () => {
   const chainName = 'Solana'
 
   await page.switchNetwork(chainName)
-  await page.openNetworks()
+  await validator.expectUnauthenticated()
   await validator.expectSwitchedNetwork(chainName)
   await page.closeModal()
 

apps/laboratory/tests/multichain/multichain-ethers5-solana-siwe.spec.ts

@@ -28,6 +28,9 @@ test.beforeAll(async ({ browser }) => {
   await modalPage.load()
   await modalPage.qrCodeFlow(modalPage, walletPage)
   await modalValidator.expectConnected()
+  await modalPage.promptSiwe()
+  await walletPage.handleRequest({ accept: true })
+  await modalValidator.expectAuthenticated()
 })
 
 test.afterAll(async () => {
@@ -52,5 +55,5 @@ test('it should switch networks and sign siwe', async () => {
 test('it should switch to Solana and validate chain title', async () => {
   const chainName = 'Solana'
   await modalPage.switchNetwork(chainName)
-  await modalValidator.expectSwitchChainView(chainName.toLocaleLowerCase())
+  await modalValidator.expectSwitchedNetworkOnNetworksView(chainName)
 })

apps/laboratory/tests/multichain/multichain-wagmi-solana-email-siwe.spec.ts

@@ -60,9 +60,6 @@ test('it should switch to different namespace', async () => {
 
   await page.switchNetwork(chainName)
   await validator.expectUnauthenticated()
-  await page.closeModal()
-  await page.openAccount()
-  await page.openNetworks()
   await validator.expectSwitchedNetwork(chainName)
   await page.closeModal()
 

apps/laboratory/tests/multichain/multichain-wagmi-solana-siwe.spec.ts

@@ -28,6 +28,9 @@ test.beforeAll(async ({ browser }) => {
   await modalPage.load()
   await modalPage.qrCodeFlow(modalPage, walletPage)
   await modalValidator.expectConnected()
+  await modalPage.promptSiwe()
+  await walletPage.handleRequest({ accept: true })
+  await modalValidator.expectAuthenticated()
 })
 
 test.afterAll(async () => {
@@ -53,5 +56,5 @@ test('it should switch networks and sign siwe', async () => {
 test('it should switch to Solana and validate chain title', async () => {
   const chainName = 'Solana'
   await modalPage.switchNetwork(chainName)
-  await modalValidator.expectSwitchChainView(chainName.toLocaleLowerCase())
+  await modalValidator.expectSwitchedNetworkOnNetworksView(chainName)
 })

packages/adapters/solana/src/client.ts

@@ -32,6 +32,7 @@ import type { WalletStandardProvider } from './providers/WalletStandardProvider.
 import { handleMobileWalletRedirection } from './utils/handleMobileWalletRedirection.js'
 import type { BaseWalletAdapter } from '@solana/wallet-adapter-base'
 import { WalletConnectProvider } from './providers/WalletConnectProvider.js'
+import bs58 from 'bs58'
 
 export interface AdapterOptions {
   connectionSettings?: Commitment | ConnectionConfig
@@ -187,7 +188,7 @@ export class SolanaAdapter extends AdapterBlueprint {
     )
 
     return {
-      signature: new TextDecoder().decode(signature)
+      signature: bs58.encode(signature)
     }
   }
 

packages/appkit/src/client.ts

@@ -19,7 +19,8 @@ import {
   type SendTransactionArgs,
   type EstimateGasTransactionArgs,
   type AccountControllerState,
-  type AdapterNetworkState
+  type AdapterNetworkState,
+  SIWXUtil
 } from '@reown/appkit-core'
 import {
   AccountController,
@@ -649,8 +650,16 @@ export class AppKit {
     // Set the SIWE client for EVM chains
     if (evmAdapter) {
       if (options.siweConfig) {
-        const { SIWEController } = await import('@reown/appkit-siwe')
-        SIWEController.setSIWEClient(options.siweConfig)
+        if (options.siwx) {
+          throw new Error('Cannot set both `siweConfig` and `siwx` options')
+        }
+
+        const siwe = await import('@reown/appkit-siwe')
+        if (typeof siwe.mapToSIWX !== 'function') {
+          throw new Error('Please update the `@reown/appkit-siwe` package to the latest version')
+        }
+
+        OptionsController.setSIWX(siwe.mapToSIWX(options.siweConfig))
       }
     }
   }
@@ -699,78 +708,24 @@ export class AppKit {
           onUri(uri)
         })
 
-        if (this.options.siweConfig) {
-          const siweParams = await this.options.siweConfig?.getMessageParams?.()
-          const isSiweEnabled = this.options.siweConfig?.options?.enabled
-          const isProviderSupported = typeof this.universalProvider?.authenticate === 'function'
-          const isSiweParamsValid = siweParams && Object.keys(siweParams || {}).length > 0
-          const clientId = await this.universalProvider?.client?.core?.crypto?.getClientId()
-          if (clientId) {
-            this.setClientId(clientId)
-            if (
-              this.options.siweConfig &&
-              isSiweEnabled &&
-              siweParams &&
-              isProviderSupported &&
-              isSiweParamsValid &&
-              ChainController.state.activeChain === ConstantsUtil.CHAIN.EVM
-            ) {
-              const { SIWEController, getDidChainId, getDidAddress } = await import(
-                '@reown/appkit-siwe'
-              )
-
-              const chains = this.caipNetworks
-                ?.filter(network => network.chainNamespace === ConstantsUtil.CHAIN.EVM)
-                .map(chain => chain.caipNetworkId) as string[]
-
-              siweParams.chains = this.caipNetworks
-                ?.filter(network => network.chainNamespace === ConstantsUtil.CHAIN.EVM)
-                .map(chain => chain.id) as number[]
-
-              const result = await this.universalProvider?.authenticate({
-                nonce: await this.options.siweConfig?.getNonce?.(),
-                methods: [...OPTIONAL_METHODS],
-                ...siweParams,
-                chains
-              })
-              // Auths is an array of signed CACAO objects https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-74.md
-              const signedCacao = result?.auths?.[0]
-
-              if (signedCacao) {
-                const { p, s } = signedCacao
-                const cacaoChainId = getDidChainId(p.iss)
-                const address = getDidAddress(p.iss)
-                if (address && cacaoChainId) {
-                  SIWEController.setSession({
-                    address,
-                    chainId: parseInt(cacaoChainId, 10)
-                  })
-                }
-
-                try {
-                  // Kicks off verifyMessage and populates external states
-                  const message = this.universalProvider?.client.formatAuthMessage({
-                    request: p,
-                    iss: p.iss
-                  })
-
-                  await SIWEController.verifyMessage({
-                    message: message as string,
-                    signature: s.s,
-                    cacao: signedCacao
-                  })
-                } catch (error) {
-                  // eslint-disable-next-line no-console
-                  console.error('Error verifying message', error)
-                  // eslint-disable-next-line no-console
-                  await this.universalProvider?.disconnect().catch(console.error)
-                  // eslint-disable-next-line no-console
-                  await SIWEController.signOut().catch(console.error)
-                  throw error
-                }
-              }
-            }
-          }
+        this.setClientId(
+          (await this.universalProvider?.client?.core?.crypto?.getClientId()) || null
+        )
+
+        let isAuthenticated = false
+
+        if (this.universalProvider) {
+          const chains = this.caipNetworks?.map(network => network.caipNetworkId) || []
+
+          isAuthenticated = await SIWXUtil.universalProviderAuthenticate({
+            universalProvider: this.universalProvider,
+            chains,
+            methods: OPTIONAL_METHODS
+          })
+        }
+
+        if (isAuthenticated) {
+          this.close()
         } else {
           await adapter?.connectWalletConnect(onUri, this.getCaipNetwork()?.id)
         }
@@ -824,11 +779,6 @@ export class AppKit {
           ChainController.state.activeChain as ChainNamespace
         )
 
-        if (this.options.siweConfig?.options?.signOutOnDisconnect) {
-          const { SIWEController } = await import('@reown/appkit-siwe')
-          await SIWEController.signOut()
-        }
-
         const providerType =
           ProviderUtil.state.providerIds[ChainController.state.activeChain as ChainNamespace]
 

packages/appkit/src/universal-adapter/client.ts

@@ -1,6 +1,9 @@
 import type UniversalProvider from '@walletconnect/universal-provider'
 import { AdapterBlueprint } from '../adapters/ChainAdapterBlueprint.js'
 import { WcHelpersUtil } from '../utils/index.js'
+import { ChainController } from '@reown/appkit-core'
+import bs58 from 'bs58'
+import { ConstantsUtil } from '@reown/appkit-common'
 
 export class UniversalAdapter extends AdapterBlueprint {
   public async connectWalletConnect(onUri: (uri: string) => void) {
@@ -60,12 +63,32 @@ export class UniversalAdapter extends AdapterBlueprint {
       throw new Error('UniversalAdapter:signMessage - provider is undefined')
     }
 
-    const signature = await provider.request({
-      method: 'personal_sign',
-      params: [message, address]
-    })
+    let signature = ''
+
+    if (ChainController.state.activeCaipNetwork?.chainNamespace === ConstantsUtil.CHAIN.SOLANA) {
+      const response = await provider.request(
+        {
+          method: 'solana_signMessage',
+          params: {
+            message: bs58.encode(new TextEncoder().encode(message)),
+            pubkey: address
+          }
+        },
+        ChainController.state.activeCaipNetwork?.caipNetworkId
+      )
+
+      signature = (response as { signature: string }).signature
+    } else {
+      signature = await provider.request(
+        {
+          method: 'personal_sign',
+          params: [message, address]
+        },
+        ChainController.state.activeCaipNetwork?.caipNetworkId
+      )
+    }
 
-    return { signature: signature as `0x${string}` }
+    return { signature }
   }
 
   // -- Transaction methods ---------------------------------------------------

packages/core/exports/index.ts

@@ -74,6 +74,7 @@ export { CoreHelperUtil } from '../src/utils/CoreHelperUtil.js'
 export { StorageUtil } from '../src/utils/StorageUtil.js'
 export { RouterUtil } from '../src/utils/RouterUtil.js'
 export { OptionsUtil } from '../src/utils/OptionsUtil.js'
+export { SIWXUtil } from '../src/utils/SIWXUtil.js'
 
 export type * from '../src/utils/TypeUtil.js'
 export type * from '../src/utils/SIWXUtil.js'

packages/core/src/controllers/AccountController.ts

@@ -40,7 +40,6 @@ export interface AccountControllerState {
   farcasterUrl?: string
   provider?: UniversalProvider | Provider | CombinedProvider
   status?: 'reconnecting' | 'connected' | 'disconnected' | 'connecting'
-  siweStatus?: 'uninitialized' | 'ready' | 'loading' | 'success' | 'rejected' | 'error'
   lastRetry?: number
 }
 
@@ -262,9 +261,5 @@ export const AccountController = {
 
   resetAccount(chain: ChainNamespace) {
     ChainController.resetAccount(chain)
-  },
-
-  setSiweStatus(status: AccountControllerState['siweStatus']) {
-    ChainController.setAccountProp('siweStatus', status, ChainController.state.activeChain)
   }
 }

packages/core/src/controllers/ConnectionController.ts

@@ -266,66 +266,5 @@ export const ConnectionController = {
     } catch (error) {
       throw new Error('Failed to disconnect')
     }
-  },
-
-  /**
-   * @experimental - This is an experimental feature and may be subject to change.
-   * Initializes SIWX if available.
-   * This is not yet considering One Click Auth.
-   */
-  async initializeSWIXIfAvailable() {
-    const siwx = OptionsController.state.siwx
-    const address = CoreHelperUtil.getPlainAddress(ChainController.getActiveCaipAddress())
-    const network = ChainController.getActiveCaipNetwork()
-
-    if (!(siwx && address && network)) {
-      return
-    }
-
-    if (OptionsController.state.isSiweEnabled) {
-      console.warn('SIWE is enabled skipping experimental SIWX initialization')
-
-      return
-    }
-
-    const client = this._getClient()
-
-    try {
-      const sessions = await siwx.getSessions(network.caipNetworkId, address)
-      if (sessions.length) {
-        return
-      }
-
-      await ModalController.open({
-        view:
-          StorageUtil.getConnectedConnector() === 'ID_AUTH'
-            ? 'ApproveTransaction'
-            : 'SIWXSignMessage'
-      })
-
-      const siwxMessage = await siwx.createMessage({
-        chainId: network.caipNetworkId,
-        accountAddress: address
-      })
-
-      const message = siwxMessage.toString()
-
-      const signature = await client?.signMessage(message)
-
-      await siwx.addSession({
-        data: siwxMessage,
-        message,
-        signature: signature as `0x${string}`
-      })
-
-      ModalController.close()
-    } catch (error: unknown) {
-      // eslint-disable-next-line no-console
-      console.error('Failed to initialize SIWX', error)
-      ModalController.setLoading(true)
-      await client?.disconnect().finally(() => {
-        ModalController.setLoading(false)
-      })
-    }
   }
 }