@reown/appkit-core-react-native 2.0.0-alpha.5 → 2.0.0-alpha.6

package/lib/typescript/utils/FetchUtil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FetchUtil.d.ts","sourceRoot":"","sources":["../../../src/utils/FetchUtil.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAGtE,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5C,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,UAAU,aAAc,SAAQ,gBAAgB;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAGD,qBAAa,SAAS;IACb,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;gBAElB,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,OAAO;IAKpC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,gBAAgB;IAOrD,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa;IAYzD,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa;IAYxD,MAAM,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa;IAY3D,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAgBtE,OAAO,CAAC,SAAS;YAsCH,eAAe;CA2B9B"}
+{"version":3,"file":"FetchUtil.d.ts","sourceRoot":"","sources":["../../../src/utils/FetchUtil.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAGtE,UAAU,OAAO;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAC5C,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,UAAU,aAAc,SAAQ,gBAAgB;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAGD,qBAAa,SAAS;IACb,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;gBAElB,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,OAAO;IAKpC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,gBAAgB;IAOrD,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa;IAYzD,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa;IAYxD,MAAM,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,aAAa;IAY3D,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAgB/D,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,gBAAgB;YAsCrC,eAAe;CA2B9B"}

package/lib/typescript/utils/StorageUtil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageUtil.d.ts","sourceRoot":"","sources":["../../../src/utils/StorageUtil.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,QAAQ,EAEb,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,cAAc,EAEpB,MAAM,mCAAmC,CAAC;AAI3C,eAAO,MAAM,WAAW;6CACmB,cAAc;;;4BAkCzB,QAAQ;8BA0BN,QAAQ,EAAE;wBAWhB,QAAQ,QAAQ,EAAE,CAAC;;cAkBrC,aAAa;oBACP,MAAM,EAAE;;8BAiBU,QAAQ;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;oCAclD,aAAa;uCAaV,aAAa;;6CAyBP,kBAAkB;;kCAyB7B,aAAa,EAAE;;kDAyBC,qBAAqB,EAAE;;gDAsCzB,qBAAqB,EAAE;;oCAuCnC,eAAe,EAAE;;4CAsCT,kBAAkB,EAAE;;mCAsC7B,cAAc;;;CAyCpD,CAAC"}
+{"version":3,"file":"StorageUtil.d.ts","sourceRoot":"","sources":["../../../src/utils/StorageUtil.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,QAAQ,EAEb,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,cAAc,EAEpB,MAAM,mCAAmC,CAAC;AAI3C,eAAO,MAAM,WAAW;6CACmB,cAAc;;;4BAkCzB,QAAQ;8BAuBN,QAAQ,EAAE;wBAQhB,QAAQ,QAAQ,EAAE,CAAC;;cAgBrC,aAAa;oBACP,MAAM,EAAE;;8BAiBU,QAAQ;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;oCAclD,aAAa;uCAaV,aAAa;;6CAyBP,kBAAkB;;kCAyB7B,aAAa,EAAE;;kDAsBC,qBAAqB,EAAE;;gDAsCzB,qBAAqB,EAAE;;oCAuCnC,eAAe,EAAE;;4CAsCT,kBAAkB,EAAE;;mCAsC7B,cAAc;;;CAoCpD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reown/appkit-core-react-native",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.6",
   "main": "lib/commonjs/index.js",
   "types": "lib/typescript/index.d.ts",
   "module": "lib/module/index.js",
@@ -40,10 +40,10 @@
     "provenance": true
   },
   "dependencies": {
-    "@reown/appkit-common-react-native": "2.0.0-alpha.5",
+    "@reown/appkit-common-react-native": "2.0.0-alpha.6",
     "countries-and-timezones": "3.7.2",
     "derive-valtio": "0.2.0",
-    "valtio": "2.1.5"
+    "valtio": "2.1.8"
   },
   "peerDependencies": {
     "@walletconnect/react-native-compat": ">=2.16.1",

package/src/controllers/ConnectionsController.ts

@@ -13,6 +13,7 @@ import {
   type AccountType,
   type Connection,
   SolanaBaseAdapter,
+  BitcoinBaseAdapter,
   type Identity
 } from '@reown/appkit-common-react-native';
 import { StorageUtil } from '../utils/StorageUtil';
@@ -279,8 +280,11 @@ export const ConnectionsController = {
     const existingBalances = connection.balances.get(address) || [];
     // Check if this token already exists by contract address or symbol
     const existingIndex = existingBalances.findIndex(existingBalance => {
-      if (balance.address) {
-        return existingBalance.address === balance.address;
+      if (balance.address && existingBalance.address) {
+        return (
+          CoreHelperUtil.getPlainAddress(existingBalance.address) ===
+          CoreHelperUtil.getPlainAddress(balance.address)
+        );
       }
 
       return existingBalance.symbol === balance.symbol;
@@ -449,7 +453,13 @@ export const ConnectionsController = {
 
     const adapter = baseState.connections.get(baseState.activeNamespace)?.adapter;
 
-    if (adapter instanceof EVMAdapter && plainAddress && chainId) {
+    if (
+      (adapter instanceof EVMAdapter ||
+        adapter instanceof SolanaBaseAdapter ||
+        adapter instanceof BitcoinBaseAdapter) &&
+      plainAddress &&
+      chainId
+    ) {
       return adapter.signMessage(plainAddress, message, chainId);
     }
 

package/src/controllers/OptionsController.ts

@@ -7,7 +7,8 @@ import type {
   Features,
   ProjectId,
   SdkType,
-  SdkVersion
+  SdkVersion,
+  SIWXConfig
 } from '@reown/appkit-common-react-native';
 
 import { ConstantsUtil } from '../utils/ConstantsUtil';
@@ -29,7 +30,7 @@ export interface OptionsControllerState {
   sdkType: SdkType;
   sdkVersion: SdkVersion;
   metadata?: Metadata;
-  isSiweEnabled?: boolean;
+  siwx?: SIWXConfig;
   isOnRampEnabled?: boolean;
   features?: Features;
   debug?: boolean;
@@ -87,10 +88,6 @@ export const OptionsController = {
     state.metadata = metadata;
   },
 
-  setIsSiweEnabled(isSiweEnabled: OptionsControllerState['isSiweEnabled']) {
-    state.isSiweEnabled = isSiweEnabled;
-  },
-
   setFeatures(features: OptionsControllerState['features']) {
     state.features = { ...ConstantsUtil.DEFAULT_FEATURES, ...features };
   },
@@ -117,6 +114,14 @@ export const OptionsController = {
     state.requestedNetworks = requestedNetworks;
   },
 
+  setSiwx(siwx?: OptionsControllerState['siwx']) {
+    if (siwx && (siwx?.signOutOnDisconnect === undefined || siwx?.signOutOnDisconnect === null)) {
+      siwx.signOutOnDisconnect = true;
+    }
+
+    state.siwx = siwx;
+  },
+
   isClipboardAvailable() {
     return !!state.clipboardClient;
   },

package/src/controllers/RouterController.ts

@@ -15,23 +15,23 @@ export interface RouterControllerState {
     | 'Connect'
     | 'ConnectSocials'
     | 'ConnectingExternal'
-    | 'ConnectingSiwe'
     | 'ConnectingSocial'
-    | 'WalletConnect'
     | 'GetWallet'
     | 'Networks'
-    | 'SwitchNetwork'
     | 'OnRamp'
     | 'OnRampCheckout'
     | 'OnRampLoading'
     | 'OnRampSettings'
     | 'OnRampTransaction'
+    | 'SIWXSignMessage'
     | 'Swap'
     | 'SwapPreview'
+    | 'SwitchNetwork'
     | 'Transactions'
     | 'UnsupportedChain'
     | 'UpgradeEmailWallet'
     | 'WalletCompatibleNetworks'
+    | 'WalletConnect'
     | 'WalletReceive'
     | 'WalletSend'
     | 'WalletSendPreview'

package/src/controllers/SendController.ts

@@ -8,6 +8,7 @@ import { EventsController } from './EventsController';
 import { RouterController } from './RouterController';
 import { ConnectionsController } from './ConnectionsController';
 import { SwapController } from './SwapController';
+import { ConstantsUtil as CoreConstantsUtil } from '../utils/ConstantsUtil';
 
 // -- Types --------------------------------------------- //
 export interface TxParams {
@@ -118,13 +119,18 @@ export const SendController = {
       });
       RouterController.reset(isAuth ? 'Account' : 'AccountDefault');
       this.resetState();
-    } catch (error) {
+    } catch (error: any) {
       EventsController.sendEvent({
         type: 'track',
         event: 'SEND_ERROR',
         properties: eventProperties
       });
-      SnackController.showError('Something went wrong');
+
+      if (error?.message && error?.message.includes('user rejected')) {
+        SnackController.showError('Transaction cancelled');
+      } else {
+        SnackController.showError('Something went wrong');
+      }
     } finally {
       this.state.loading = false;
     }
@@ -222,7 +228,21 @@ export const SendController = {
       throw new Error('Invalid address');
     }
 
+    let tokenMint: string | undefined;
+
+    if (
+      SendController.state.token &&
+      SendController.state.token.address !== CoreConstantsUtil.NATIVE_TOKEN_ADDRESS.solana
+    ) {
+      if (CoreHelperUtil.isCaipAddress(SendController.state.token.address)) {
+        tokenMint = CoreHelperUtil.getPlainAddress(SendController.state.token.address);
+      } else {
+        tokenMint = SendController.state.token.address;
+      }
+    }
+
     await ConnectionsController.sendTransaction({
+      tokenMint,
       fromAddress: plainAddress,
       toAddress: this.state.receiverAddress,
       amount: this.state.sendTokenAmount,

package/src/features/reown-authentication/ReownAuthentication.ts

@@ -0,0 +1,470 @@
+import {
+  type CaipNetworkId,
+  type ChainNamespace,
+  type SafeStorageItems,
+  SafeStorageKeys,
+  type SIWXConfig,
+  type SIWXMessage,
+  type SIWXSession
+} from '@reown/appkit-common-react-native';
+
+import { ApiController } from '../../controllers/ApiController';
+import { BlockchainApiController } from '../../controllers/BlockchainApiController';
+
+import { ReownAuthenticationMessenger } from './ReownAuthenticationMessenger';
+import { ConnectionsController } from '../../controllers/ConnectionsController';
+import { CoreHelperUtil } from '../../utils/CoreHelperUtil';
+import { OptionsController } from '../../controllers/OptionsController';
+import { FetchUtil } from '../../utils/FetchUtil';
+
+/**
+ * This is the configuration for using SIWX with Reown Authentication service.
+ * It allows you to authenticate and capture user sessions through the Reown Dashboard.
+ */
+export class ReownAuthentication implements SIWXConfig {
+  private readonly localAuthStorageKey: keyof SafeStorageItems;
+  private readonly localNonceStorageKey: keyof SafeStorageItems;
+  private readonly messenger: ReownAuthenticationMessenger;
+  private readonly fetchUtil = new FetchUtil({ baseUrl: CoreHelperUtil.getApiUrl() });
+  public readonly signOutOnDisconnect: boolean;
+
+  private required: boolean;
+
+  private listeners: ReownAuthentication.EventListeners = {
+    sessionChanged: []
+  };
+
+  constructor(params: ReownAuthentication.ConstructorParams = {}) {
+    this.localAuthStorageKey =
+      (params.localAuthStorageKey as keyof SafeStorageItems) || SafeStorageKeys.SIWX_AUTH_TOKEN;
+    this.localNonceStorageKey =
+      (params.localNonceStorageKey as keyof SafeStorageItems) || SafeStorageKeys.SIWX_NONCE_TOKEN;
+    this.required = params.required ?? true;
+
+    this.messenger = new ReownAuthenticationMessenger({
+      getNonce: this.getNonce.bind(this)
+    });
+
+    this.signOutOnDisconnect = params.signOutOnDisconnect ?? true;
+  }
+
+  async createMessage(input: SIWXMessage.Input): Promise<SIWXMessage> {
+    return this.messenger.createMessage(input);
+  }
+
+  async addSession(session: SIWXSession): Promise<void> {
+    const response = await this.request({
+      method: 'POST',
+      key: 'authenticate',
+      body: {
+        data: session.cacao ? undefined : session.data,
+        message: session.message,
+        signature: session.signature,
+        clientId: this.getClientId(),
+        walletInfo: this.getWalletInfo()
+      },
+      headers: ['nonce']
+    });
+
+    this.setStorageToken(response.token, this.localAuthStorageKey);
+
+    this.emit('sessionChanged', session);
+  }
+
+  async getSessions(chainId: CaipNetworkId, address: string): Promise<SIWXSession[]> {
+    try {
+      const sessions = await this.getStorageToken(this.localAuthStorageKey);
+      if (!sessions) {
+        return [];
+      }
+
+      const account = await this.request({
+        method: 'GET',
+        key: 'me',
+        query: {},
+        headers: ['auth']
+      });
+
+      if (!account) {
+        return [];
+      }
+
+      const isSameAddress = account.address.toLowerCase() === address.toLowerCase();
+      const isSameNetwork = account.caip2Network === chainId;
+
+      if (!isSameAddress || !isSameNetwork) {
+        return [];
+      }
+
+      const session: SIWXSession = {
+        data: {
+          accountAddress: account.address,
+          chainId: account.caip2Network
+        } as SIWXMessage.Data,
+        message: '',
+        signature: ''
+      };
+
+      this.emit('sessionChanged', session);
+
+      return [session];
+    } catch {
+      return [];
+    }
+  }
+
+  async revokeSession(_chainId: CaipNetworkId, _address: string): Promise<void> {
+    return Promise.resolve(this.clearStorageTokens());
+  }
+
+  async setSessions(sessions: SIWXSession[]): Promise<void> {
+    if (sessions.length === 0) {
+      this.clearStorageTokens();
+    } else {
+      const session = (sessions.find(
+        s => s.data.chainId === ConnectionsController.state.activeCaipNetworkId
+      ) || sessions[0]) as SIWXSession;
+
+      await this.addSession(session);
+    }
+  }
+
+  getRequired() {
+    return this.required;
+  }
+
+  async getSessionAccount() {
+    const sessions = await this.getStorageToken(this.localAuthStorageKey);
+    if (!sessions) {
+      throw new Error('Not authenticated');
+    }
+
+    return this.request({
+      method: 'GET',
+      key: 'me',
+      body: undefined,
+      query: {
+        includeAppKitAccount: true
+      },
+      headers: ['auth']
+    });
+  }
+
+  async setSessionAccountMetadata(metadata: object | null = null) {
+    const sessions = await this.getStorageToken(this.localAuthStorageKey);
+    if (!sessions) {
+      throw new Error('Not authenticated');
+    }
+
+    return this.request({
+      method: 'PUT',
+      key: 'account-metadata',
+      body: { metadata },
+      headers: ['auth']
+    });
+  }
+
+  on<Event extends keyof ReownAuthentication.Events>(
+    event: Event,
+    callback: ReownAuthentication.Listener<Event>
+  ) {
+    this.listeners[event].push(callback);
+
+    return () => {
+      this.listeners[event] = this.listeners[event].filter(
+        cb => cb !== callback
+      ) as ReownAuthentication.EventListeners[Event];
+    };
+  }
+
+  removeAllListeners() {
+    const keys = Object.keys(this.listeners) as (keyof ReownAuthentication.Events)[];
+    keys.forEach(key => {
+      this.listeners[key] = [];
+    });
+  }
+
+  private async request<
+    Method extends ReownAuthentication.Methods,
+    Key extends ReownAuthentication.RequestKeys<Method>
+  >({
+    method,
+    key,
+    query,
+    body,
+    headers
+  }: ReownAuthentication.RequestParams<Key, Method>): Promise<
+    ReownAuthentication.RequestResponse<Method, Key>
+  > {
+    const { projectId, st, sv, domain } = this.getSDKProperties();
+
+    const url = this.fetchUtil.createUrl({
+      path: `/auth/v1/${String(key)}`,
+      params: { projectId, st, sv, domain, ...query }
+    });
+
+    const nonceJwt = await this.getStorageToken(this.localNonceStorageKey);
+    const auth = await this.getStorageToken(this.localAuthStorageKey);
+
+    const response = await fetch(url, {
+      method,
+      body: body ? JSON.stringify(body) : undefined,
+      headers: {
+        'Content-Type': 'application/json',
+        ...(Array.isArray(headers)
+          ? headers.reduce((acc, header) => {
+              switch (header) {
+                case 'nonce':
+                  acc['x-nonce-jwt'] = `Bearer ${nonceJwt}`;
+                  break;
+                case 'auth':
+                  acc['Authorization'] = `Bearer ${auth}`;
+                  break;
+                default:
+                  break;
+              }
+
+              return acc;
+            }, {})
+          : {})
+      }
+    });
+
+    if (!response.ok) {
+      throw new Error(await response.text());
+    }
+
+    if (response.headers.get('content-type')?.includes('application/json')) {
+      return response.json();
+    }
+
+    return null as ReownAuthentication.RequestResponse<Method, Key>;
+  }
+
+  private async getStorageToken(key: keyof SafeStorageItems): Promise<string | undefined> {
+    return OptionsController.getStorage().getItem(key);
+  }
+
+  private setStorageToken(token: string, key: keyof SafeStorageItems): void {
+    OptionsController.getStorage().setItem(key, token);
+  }
+
+  private clearStorageTokens(): void {
+    OptionsController.getStorage().removeItem(this.localAuthStorageKey);
+    OptionsController.getStorage().removeItem(this.localNonceStorageKey);
+    this.emit('sessionChanged', undefined);
+  }
+
+  private async getNonce(): Promise<string> {
+    const { nonce, token } = await this.request({
+      method: 'GET',
+      key: 'nonce'
+    });
+
+    this.setStorageToken(token, this.localNonceStorageKey);
+
+    return nonce;
+  }
+
+  private getClientId(): string | null {
+    return BlockchainApiController.state.clientId;
+  }
+
+  private getWalletInfo(): ReownAuthentication.WalletInfo | undefined {
+    const connectedWalletInfo = ConnectionsController.state.walletInfo;
+    const connectionProperties = ConnectionsController.state.connection?.properties;
+
+    if (!connectedWalletInfo || !connectionProperties) {
+      return undefined;
+    }
+
+    if (connectionProperties?.provider) {
+      const social = connectionProperties.provider;
+      const identifier = connectionProperties.email || 'unknown';
+
+      return { type: 'social', social, identifier };
+    }
+
+    let { name, icon, type } = connectedWalletInfo;
+
+    if (!type || type !== 'walletconnect') {
+      type = 'unknown';
+    }
+
+    return {
+      type,
+      name,
+      icon
+    };
+  }
+
+  private getSDKProperties(): { projectId: string; st: string; sv: string; domain: string } {
+    const headers = ApiController._getApiHeaders();
+
+    return {
+      projectId: headers['x-project-id'],
+      st: headers['x-sdk-type'],
+      sv: headers['x-sdk-version'],
+      domain: headers['origin']
+    };
+  }
+
+  private emit<Event extends keyof ReownAuthentication.Events>(
+    event: Event,
+    data: ReownAuthentication.Events[Event]
+  ) {
+    this.listeners[event].forEach(listener => listener(data));
+  }
+}
+
+export namespace ReownAuthentication {
+  export type ConstructorParams = {
+    /**
+     * The key to use for storing the session token in local storage.
+     * @default '@appkit/siwx-auth-token'
+     */
+    localAuthStorageKey?: string;
+    /**
+     * The key to use for storing the nonce token in local storage.
+     * @default '@appkit/siwx-nonce-token'
+     */
+    localNonceStorageKey?: string;
+    /**
+     * If false the wallet stays connected when user denies the signature request.
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * This flag determines whether the session should be cleared when the user disconnects.
+     *
+     * @default true
+     */
+    signOutOnDisconnect?: boolean;
+  };
+
+  export type AvailableRequestHeaders = {
+    nonce: {
+      'x-nonce-jwt': string;
+    };
+    auth: {
+      Authorization: string;
+    };
+    origin: {
+      origin: string;
+    };
+  };
+
+  export type RequestParams<Key extends keyof Requests[Method], Method extends Methods> = {
+    method: Method;
+    key: Key;
+    // @ts-expect-error - This is matching correctly already
+  } & Pick<Requests[Method][Key], 'query' | 'body' | 'headers'>;
+
+  export type RequestResponse<
+    Method extends Methods,
+    Key extends RequestKeys<Method>
+    // @ts-expect-error - This is matching correctly already
+  > = Requests[Method][Key]['response'];
+
+  export type Request<
+    Body,
+    Response,
+    Query extends Record<string, unknown> | undefined = undefined,
+    Headers extends (keyof AvailableRequestHeaders)[] | undefined = undefined
+  > = (Response extends undefined
+    ? {
+        response?: never;
+      }
+    : {
+        response: Response;
+      }) &
+    (Body extends undefined ? { body?: never } : { body: Body }) &
+    (Query extends undefined ? { query?: never } : { query: Query }) &
+    (Headers extends undefined ? { headers?: never } : { headers: Headers });
+
+  export type Requests = {
+    GET: {
+      nonce: Request<undefined, { nonce: string; token: string }>;
+      me: Request<
+        undefined,
+        Omit<SessionAccount, 'appKitAccount'>,
+        { includeAppKitAccount?: boolean },
+        ['auth']
+      >;
+    };
+    POST: {
+      'authenticate': Request<
+        {
+          data?: SIWXMessage.Data;
+          message: string;
+          signature: string;
+          clientId?: string | null;
+          walletInfo?: WalletInfo;
+        },
+        {
+          token: string;
+        },
+        undefined,
+        ['nonce']
+      >;
+      'sign-out': Request<undefined, never, never, ['auth']>;
+    };
+    PUT: {
+      'account-metadata': Request<{ metadata: object | null }, unknown, undefined, ['auth']>;
+    };
+  };
+
+  export type Methods = 'GET' | 'POST' | 'PUT';
+
+  export type RequestKeys<Method extends Methods> = keyof Requests[Method];
+
+  export type WalletInfo =
+    | {
+        type: 'walletconnect' | 'external' | 'unknown';
+        name: string | undefined;
+        icon: string | undefined;
+      }
+    | { type: 'social'; social: string; identifier: string };
+
+  export type Events = {
+    sessionChanged: SIWXSession | undefined;
+  };
+
+  export type Listener<Event extends keyof Events> = (event: Events[Event]) => void;
+
+  export type EventListeners = {
+    [Key in keyof Events]: Listener<Key>[];
+  };
+
+  export type SessionAccount = {
+    aud: string;
+    iss: string;
+    exp: number;
+    projectIdKey: string;
+    sub: string;
+    address: string;
+    chainId: number | string;
+    chainNamespace: ChainNamespace;
+    caip2Network: string;
+    uri: string;
+    domain: string;
+    projectUuid: string;
+    profileUuid: string;
+    nonce: string;
+    email?: string;
+    appKitAccount?: {
+      uuid: string;
+      caip2_chain: string;
+      address: string;
+      profile_uuid: string;
+      created_at: string;
+      is_main_account: boolean;
+      verification_status: null;
+      connection_method: object | null;
+      metadata: object;
+      last_signed_in_at: string;
+      signed_up_at: string;
+      updated_at: string;
+    };
+  };
+}