feat: enable custom SIWXSigner (#5238)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: tomiir

.changeset/slow-symbols-own.md

@@ -0,0 +1,8 @@
+---
+'@reown/appkit-controllers': patch
+'@reown/appkit-scaffold-ui': patch
+'@reown/appkit': patch
+'@reown/appkit-siwx': patch
+---
+
+Adds ability to configure custom SIWX signing behaviors by implementing a custom `SIWXSigner`

packages/controllers/exports/features.ts

@@ -1 +1 @@
-export * from '../src/features/reown-authentication/index.js'
+export * from '../src/features/siwx/reown-authentication/index.js'

packages/controllers/src/features/siwx/DefaultSigner.ts

@@ -8,11 +8,11 @@ import {
   SafeLocalStorageKeys
 } from '@reown/appkit-common'
 
-import { ApiController } from '../../controllers/ApiController.js'
-import { BlockchainApiController } from '../../controllers/BlockchainApiController.js'
-import { ChainController } from '../../controllers/ChainController.js'
-import { getActiveCaipNetwork } from '../../utils/ChainControllerUtil.js'
-import type { SIWXConfig, SIWXMessage, SIWXSession } from '../../utils/SIWXUtil.js'
+import { ApiController } from '../../../controllers/ApiController.js'
+import { BlockchainApiController } from '../../../controllers/BlockchainApiController.js'
+import { ChainController } from '../../../controllers/ChainController.js'
+import { getActiveCaipNetwork } from '../../../utils/ChainControllerUtil.js'
+import type { SIWXConfig, SIWXMessage, SIWXSession } from '../../../utils/SIWXUtil.js'
 import { ReownAuthenticationMessenger } from './ReownAuthenticationMessenger.js'
 
 /**
@@ -23,7 +23,6 @@ export class ReownAuthentication implements SIWXConfig {
   private readonly localAuthStorageKey: keyof SafeLocalStorageItems
   private readonly localNonceStorageKey: keyof SafeLocalStorageItems
   private readonly messenger: ReownAuthenticationMessenger
-
   private required: boolean
   private otpUuid: string | null = null
 

…wn-authentication/ReownAuthentication.ts …wn-authentication/ReownAuthentication.tspackages/controllers/src/features/reown-authentication/ReownAuthentication.ts renamed to packages/controllers/src/features/siwx/reown-authentication/ReownAuthentication.ts packages/controllers/src/features/reown-authentication/ReownAuthentication.ts renamed to packages/controllers/src/features/siwx/reown-authentication/ReownAuthentication.ts

@@ -1,7 +1,7 @@
 import { type CaipNetworkId, NetworkUtil } from '@reown/appkit-common'
 
-import { ChainController } from '../../controllers/ChainController.js'
-import type { SIWXMessage } from '../../utils/SIWXUtil.js'
+import { ChainController } from '../../../controllers/ChainController.js'
+import type { SIWXMessage } from '../../../utils/SIWXUtil.js'
 
 export class ReownAuthenticationMessenger {
   public resources?: SIWXMessage['resources']

…tication/ReownAuthenticationMessenger.ts …tication/ReownAuthenticationMessenger.tspackages/controllers/src/features/reown-authentication/ReownAuthenticationMessenger.ts renamed to packages/controllers/src/features/siwx/reown-authentication/ReownAuthenticationMessenger.ts packages/controllers/src/features/reown-authentication/ReownAuthenticationMessenger.ts renamed to packages/controllers/src/features/siwx/reown-authentication/ReownAuthenticationMessenger.ts

@@ -102,7 +102,6 @@ export const SIWXUtil = {
     const siwx = OptionsController.state.siwx
     const address = CoreHelperUtil.getPlainAddress(ChainController.getActiveCaipAddress())
     const network = getActiveCaipNetwork()
-    const client = ConnectionController._getClient()
 
     if (!siwx) {
       throw new Error('SIWX is not enabled')
@@ -116,25 +115,29 @@ export const SIWXUtil = {
       throw new Error('No ActiveCaipNetwork or client found')
     }
 
-    if (!client) {
-      throw new Error('No ConnectionController client found')
-    }
-
     try {
       const siwxMessage = await siwx.createMessage({
         chainId: network.caipNetworkId,
         accountAddress: address
       })
 
       const message = siwxMessage.toString()
-      const connectorId = ConnectorController.getConnectorId(network.chainNamespace)
 
-      if (connectorId === CommonConstantsUtil.CONNECTOR_ID.AUTH) {
-        RouterController.pushTransactionStack({})
+      let signature = ''
+      if (siwx.signMessage) {
+        signature = await siwx.signMessage({
+          message,
+          chainId: network.caipNetworkId,
+          accountAddress: address
+        })
+      } else {
+        const connectorId = ConnectorController.getConnectorId(network.chainNamespace)
+        if (connectorId === CommonConstantsUtil.CONNECTOR_ID.AUTH) {
+          RouterController.pushTransactionStack({})
+        }
+        signature = (await ConnectionController.signMessage(message)) || ''
       }
 
-      const signature = await client.signMessage(message)
-
       await siwx.addSession({
         data: siwxMessage,
         message,
@@ -523,6 +526,28 @@ export interface SIWXConfig {
    */
   createMessage: (input: SIWXMessage.Input) => Promise<SIWXMessage>
 
+  /**
+   * This method will be called to sign a message with the wallet using the signer handler.
+   * This behavior can be overriden by passing in a `signer` parameter to the `SIWXConfig` constructor.
+   * Constraints:
+   * - This method MUST forward the message to the wallet for a signature request.
+   * - If the signature process fails or is cancelled it MUST throw an error.
+   *
+   * @param message string
+   * @param chainId CaipNetworkId
+   * @param accountAddress string
+   * @returns string
+   */
+  signMessage?: ({
+    message,
+    chainId,
+    accountAddress
+  }: {
+    message: string
+    chainId: string
+    accountAddress: string
+  }) => Promise<string>
+
   /**
    * This method will be called to store a new single session.
    *

…c/features/reown-authentication/index.ts …tures/siwx/reown-authentication/index.tspackages/controllers/src/features/reown-authentication/index.ts renamed to packages/controllers/src/features/siwx/reown-authentication/index.ts packages/controllers/src/features/reown-authentication/index.ts renamed to packages/controllers/src/features/siwx/reown-authentication/index.ts

@@ -1,5 +1,6 @@
 import { SIWXConfig } from '../core/SIWXConfig.js'
 import { InformalMessenger } from '../messengers/index.js'
+import DefaultSigner from '../signers/DefaultSigner.js'
 import { LocalStorage } from '../storages/index.js'
 import { BIP122Verifier } from '../verifiers/BIP122Verifier.js'
 import { EIP155Verifier, SolanaVerifier } from '../verifiers/index.js'
@@ -19,7 +20,9 @@ const DEFAULTS = {
 
   getDefaultVerifiers: () => [new EIP155Verifier(), new SolanaVerifier(), new BIP122Verifier()],
 
-  getDefaultStorage: () => new LocalStorage({ key: '@appkit/siwx' })
+  getDefaultStorage: () => new LocalStorage({ key: '@appkit/siwx' }),
+
+  getDefaultSigner: () => new DefaultSigner()
 }
 
 /**
@@ -35,7 +38,8 @@ export class DefaultSIWX extends SIWXConfig {
       messenger: params.messenger || DEFAULTS.getDefaultMessenger(),
       verifiers: params.verifiers || DEFAULTS.getDefaultVerifiers(),
       storage: params.storage || DEFAULTS.getDefaultStorage(),
-      required: params.required
+      required: params.required,
+      signer: params.signer || DEFAULTS.getDefaultSigner()
     })
   }
 }

packages/controllers/src/features/siwx/types.ts

@@ -5,7 +5,9 @@ import type {
   SIWXSession
 } from '@reown/appkit-controllers'
 
+import DefaultSigner from '../signers/DefaultSigner.js'
 import type { SIWXMessenger } from './SIWXMessenger.js'
+import type { SIWXSigner } from './SIWXSigner.js'
 import type { SIWXStorage } from './SIWXStorage.js'
 import type { SIWXVerifier } from './SIWXVerifier.js'
 
@@ -17,6 +19,7 @@ export abstract class SIWXConfig implements SIWXConfigInterface {
   private messenger: SIWXMessenger
   private verifiers: SIWXVerifier[]
   private storage: SIWXStorage
+  public signer: SIWXSigner
 
   public required: boolean
 
@@ -25,6 +28,7 @@ export abstract class SIWXConfig implements SIWXConfigInterface {
     this.verifiers = params.verifiers
     this.storage = params.storage
     this.required = params.required ?? true
+    this.signer = params.signer || new DefaultSigner()
   }
 
   /**
@@ -133,6 +137,16 @@ export abstract class SIWXConfig implements SIWXConfigInterface {
   getRequired() {
     return this.required
   }
+
+  public signMessage({
+    message
+  }: {
+    message: string
+    chainId: string
+    accountAddress: string
+  }): Promise<string> {
+    return this.signer.signMessage(message)
+  }
 }
 
 export namespace SIWXConfig {
@@ -157,5 +171,10 @@ export namespace SIWXConfig {
      * @default true
      */
     required?: boolean
+
+    /**
+     * The signer handler to sign the message. If not provided, a signature request will be made to the wallet.
+     */
+    signer?: SIWXSigner
   }
 }