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

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

@@ -0,0 +1,80 @@
+import type { SIWXMessage, CaipNetworkId } from '@reown/appkit-common-react-native';
+import { ConnectionsController } from '../../controllers/ConnectionsController';
+import { OptionsController } from '../../controllers/OptionsController';
+import { CoreHelperUtil } from '../../utils/CoreHelperUtil';
+
+export class ReownAuthenticationMessenger {
+  public resources?: SIWXMessage['resources'];
+
+  protected getNonce: (params: SIWXMessage.Input) => Promise<SIWXMessage['nonce']>;
+
+  constructor(params: ReownAuthenticationMessenger.ConstructorParams) {
+    this.getNonce = params.getNonce;
+  }
+
+  async createMessage(input: SIWXMessage.Input): Promise<SIWXMessage> {
+    const metadata = OptionsController.state.metadata;
+    const domain = CoreHelperUtil.getBundleId();
+    const params = {
+      accountAddress: input.accountAddress,
+      chainId: input.chainId,
+      version: '1',
+      domain: domain ?? 'Unknown Domain',
+      uri: metadata?.redirect?.universal ?? metadata?.redirect?.native ?? 'Unknown URI',
+      resources: this.resources,
+      nonce: await this.getNonce(input),
+      issuedAt: this.stringifyDate(new Date()),
+      statement: undefined,
+      expirationTime: undefined,
+      notBefore: undefined
+    };
+
+    const methods = {
+      toString: () => this.stringify(params)
+    } satisfies SIWXMessage.Methods;
+
+    return Object.assign(params, methods);
+  }
+
+  private stringify(params: SIWXMessage.Data): string {
+    const networkName = this.getNetworkName(params.chainId);
+
+    return [
+      `${params.domain} wants you to sign in with your ${networkName} account:`,
+      params.accountAddress,
+      params.statement ? `\n${params.statement}\n` : '',
+      `URI: ${params.uri}`,
+      `Version: ${params.version}`,
+      `Chain ID: ${params.chainId}`,
+      `Nonce: ${params.nonce}`,
+      params.issuedAt && `Issued At: ${params.issuedAt}`,
+      params.expirationTime && `Expiration Time: ${params.expirationTime}`,
+      params.notBefore && `Not Before: ${params.notBefore}`,
+      params.requestId && `Request ID: ${params.requestId}`,
+      params.resources?.length &&
+        params.resources.reduce((acc, resource) => `${acc}\n- ${resource}`, 'Resources:')
+    ]
+      .filter(line => typeof line === 'string')
+      .join('\n')
+      .trim();
+  }
+
+  private getNetworkName(chainId: CaipNetworkId): string | undefined {
+    const requestedNetworks = ConnectionsController.state.networks;
+
+    return (
+      requestedNetworks.find(network => network.caipNetworkId === chainId)?.name ||
+      'Unknown Network'
+    );
+  }
+
+  private stringifyDate(date: Date): string {
+    return date.toISOString();
+  }
+}
+
+export namespace ReownAuthenticationMessenger {
+  export interface ConstructorParams {
+    getNonce: (params: SIWXMessage.Input) => Promise<SIWXMessage['nonce']>;
+  }
+}

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

@@ -0,0 +1,2 @@
+export * from './ReownAuthentication';
+export * from './ReownAuthenticationMessenger';

package/src/index.ts

@@ -55,4 +55,8 @@ export { StorageUtil } from './utils/StorageUtil';
 export { EventUtil } from './utils/EventUtil';
 export { WalletUtil } from './utils/WalletUtil';
 
+// -- Features ----------------------------------------------------------------
+export { ReownAuthentication } from './features/reown-authentication/ReownAuthentication';
+export { ReownAuthenticationMessenger } from './features/reown-authentication/ReownAuthenticationMessenger';
+
 // Types are now exported from @reown/appkit-common-react-native

package/src/utils/CoreHelperUtil.ts

@@ -53,6 +53,20 @@ export const CoreHelperUtil = {
     return Date.now() - lastRetry >= ConstantsUtil.ONE_SEC_MS;
   },
 
+  isCaipAddress(address?: unknown): address is CaipAddress {
+    if (typeof address !== 'string') {
+      return false;
+    }
+
+    const sections = address.split(':');
+    const namespace = sections[0];
+
+    return (
+      sections.filter(Boolean).length === 3 &&
+      (namespace as string) in CommonConstants.CHAIN_NAME_MAP
+    );
+  },
+
   getPairingExpiry() {
     return Date.now() + ConstantsUtil.FOUR_MINUTES_MS;
   },
@@ -61,8 +75,12 @@ export const CoreHelperUtil = {
     return caipAddress?.split(':')[1];
   },
 
-  getPlainAddress(caipAddress: CaipAddress | undefined) {
-    return caipAddress?.split(':')[2];
+  getPlainAddress(address: CaipAddress | string | undefined) {
+    if (this.isCaipAddress(address)) {
+      return address?.split(':')[2];
+    }
+
+    return address;
   },
 
   async wait(milliseconds: number) {

package/src/utils/FetchUtil.ts

@@ -87,7 +87,7 @@ export class FetchUtil {
     }
   }
 
-  private createUrl({ path, params }: RequestArguments) {
+  public createUrl({ path, params }: RequestArguments) {
     let fullUrl: string;
 
     const isAbsoluteUrl = path.startsWith('http://') || path.startsWith('https://');

package/src/utils/StorageUtil.ts

@@ -10,7 +10,7 @@ import {
   type ConnectorType,
   type ChainNamespace,
   type WalletDeepLink,
-  ConstantsUtil
+  SafeStorageKeys
 } from '@reown/appkit-common-react-native';
 import { OptionsController } from '../controllers/OptionsController';
 
@@ -18,7 +18,7 @@ import { OptionsController } from '../controllers/OptionsController';
 export const StorageUtil = {
   setWalletConnectDeepLink({ href, name }: WalletDeepLink) {
     try {
-      OptionsController.getStorage().setItem(ConstantsUtil.STORAGE_KEYS.WC_DEEPLINK, {
+      OptionsController.getStorage().setItem(SafeStorageKeys.WC_DEEPLINK, {
         href,
         name
       });
@@ -30,7 +30,7 @@ export const StorageUtil = {
   async getWalletConnectDeepLink() {
     try {
       const deepLink = await OptionsController.getStorage().getItem<WalletDeepLink>(
-        ConstantsUtil.STORAGE_KEYS.WC_DEEPLINK
+        SafeStorageKeys.WC_DEEPLINK
       );
       if (deepLink) {
         return deepLink;
@@ -44,7 +44,7 @@ export const StorageUtil = {
 
   async removeWalletConnectDeepLink() {
     try {
-      await OptionsController.getStorage().removeItem(ConstantsUtil.STORAGE_KEYS.WC_DEEPLINK);
+      await OptionsController.getStorage().removeItem(SafeStorageKeys.WC_DEEPLINK);
     } catch {
       console.info('Unable to remove WalletConnect deep link');
     }
@@ -63,10 +63,7 @@ export const StorageUtil = {
       if (recentWallets.length > 2) {
         recentWallets.pop();
       }
-      OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.RECENT_WALLET,
-        recentWallets
-      );
+      OptionsController.getStorage().setItem(SafeStorageKeys.RECENT_WALLET, recentWallets);
 
       return recentWallets;
     } catch {
@@ -78,10 +75,7 @@ export const StorageUtil = {
 
   async setRecentWallets(wallets: WcWallet[]) {
     try {
-      await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.RECENT_WALLET,
-        wallets
-      );
+      await OptionsController.getStorage().setItem(SafeStorageKeys.RECENT_WALLET, wallets);
     } catch {
       console.info('Unable to set recent wallets');
     }
@@ -89,9 +83,7 @@ export const StorageUtil = {
 
   async getRecentWallets(): Promise<WcWallet[]> {
     try {
-      const recent = await OptionsController.getStorage().getItem(
-        ConstantsUtil.STORAGE_KEYS.RECENT_WALLET
-      );
+      const recent = await OptionsController.getStorage().getItem(SafeStorageKeys.RECENT_WALLET);
 
       return recent ?? [];
     } catch {
@@ -114,7 +106,7 @@ export const StorageUtil = {
       if (!currentConnectors.some(c => c.type === type)) {
         const updatedConnectors = [...currentConnectors, { type, namespaces }];
         await OptionsController.getStorage().setItem(
-          ConstantsUtil.STORAGE_KEYS.CONNECTED_CONNECTORS,
+          SafeStorageKeys.CONNECTED_CONNECTORS,
           updatedConnectors
         );
       }
@@ -127,7 +119,7 @@ export const StorageUtil = {
     try {
       const connectors = await OptionsController.getStorage().getItem<
         { type: ConnectorType; namespaces: string[] }[]
-      >(ConstantsUtil.STORAGE_KEYS.CONNECTED_CONNECTORS);
+      >(SafeStorageKeys.CONNECTED_CONNECTORS);
 
       return connectors ?? [];
     } catch (err) {
@@ -142,7 +134,7 @@ export const StorageUtil = {
       const currentConnectors = await StorageUtil.getConnectedConnectors();
       const updatedConnectors = currentConnectors.filter(c => c.type !== type);
       await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.CONNECTED_CONNECTORS,
+        SafeStorageKeys.CONNECTED_CONNECTORS,
         updatedConnectors
       );
     } catch {
@@ -153,7 +145,7 @@ export const StorageUtil = {
   async setOnRampPreferredCountry(country: OnRampCountry) {
     try {
       await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_PREFERRED_COUNTRY,
+        SafeStorageKeys.ONRAMP_PREFERRED_COUNTRY,
         country
       );
     } catch {
@@ -164,7 +156,7 @@ export const StorageUtil = {
   async getOnRampPreferredCountry() {
     try {
       const country = await OptionsController.getStorage().getItem<OnRampCountry>(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_PREFERRED_COUNTRY
+        SafeStorageKeys.ONRAMP_PREFERRED_COUNTRY
       );
 
       return country ?? undefined;
@@ -178,7 +170,7 @@ export const StorageUtil = {
   async setOnRampPreferredFiatCurrency(currency: OnRampFiatCurrency) {
     try {
       await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_PREFERRED_FIAT_CURRENCY,
+        SafeStorageKeys.ONRAMP_PREFERRED_FIAT_CURRENCY,
         currency
       );
     } catch {
@@ -189,7 +181,7 @@ export const StorageUtil = {
   async getOnRampPreferredFiatCurrency() {
     try {
       const currency = await OptionsController.getStorage().getItem<OnRampFiatCurrency>(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_PREFERRED_FIAT_CURRENCY
+        SafeStorageKeys.ONRAMP_PREFERRED_FIAT_CURRENCY
       );
 
       return currency ?? undefined;
@@ -202,10 +194,7 @@ export const StorageUtil = {
 
   async setOnRampCountries(countries: OnRampCountry[]) {
     try {
-      await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_COUNTRIES,
-        countries
-      );
+      await OptionsController.getStorage().setItem(SafeStorageKeys.ONRAMP_COUNTRIES, countries);
     } catch {
       console.info('Unable to set OnRamp Countries');
     }
@@ -214,7 +203,7 @@ export const StorageUtil = {
   async getOnRampCountries() {
     try {
       const countries = await OptionsController.getStorage().getItem<OnRampCountry[]>(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_COUNTRIES
+        SafeStorageKeys.ONRAMP_COUNTRIES
       );
 
       return countries ?? [];
@@ -229,10 +218,10 @@ export const StorageUtil = {
     try {
       const timestamp = Date.now();
 
-      await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_COUNTRIES_DEFAULTS,
-        { data: countriesDefaults, timestamp }
-      );
+      await OptionsController.getStorage().setItem(SafeStorageKeys.ONRAMP_COUNTRIES_DEFAULTS, {
+        data: countriesDefaults,
+        timestamp
+      });
     } catch {
       console.info('Unable to set OnRamp Countries Defaults');
     }
@@ -241,7 +230,7 @@ export const StorageUtil = {
   async getOnRampCountriesDefaults() {
     try {
       const result = await OptionsController.getStorage().getItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_COUNTRIES_DEFAULTS
+        SafeStorageKeys.ONRAMP_COUNTRIES_DEFAULTS
       );
 
       if (!result) {
@@ -267,10 +256,10 @@ export const StorageUtil = {
     try {
       const timestamp = Date.now();
 
-      await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_SERVICE_PROVIDERS,
-        { data: serviceProviders, timestamp }
-      );
+      await OptionsController.getStorage().setItem(SafeStorageKeys.ONRAMP_SERVICE_PROVIDERS, {
+        data: serviceProviders,
+        timestamp
+      });
     } catch {
       console.info('Unable to set OnRamp Service Providers');
     }
@@ -279,7 +268,7 @@ export const StorageUtil = {
   async getOnRampServiceProviders() {
     try {
       const result = await OptionsController.getStorage().getItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_SERVICE_PROVIDERS
+        SafeStorageKeys.ONRAMP_SERVICE_PROVIDERS
       );
 
       if (!result) {
@@ -306,7 +295,7 @@ export const StorageUtil = {
     try {
       const timestamp = Date.now();
 
-      await OptionsController.getStorage().setItem(ConstantsUtil.STORAGE_KEYS.ONRAMP_FIAT_LIMITS, {
+      await OptionsController.getStorage().setItem(SafeStorageKeys.ONRAMP_FIAT_LIMITS, {
         data: fiatLimits,
         timestamp
       });
@@ -318,7 +307,7 @@ export const StorageUtil = {
   async getOnRampFiatLimits() {
     try {
       const result = await OptionsController.getStorage().getItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_FIAT_LIMITS
+        SafeStorageKeys.ONRAMP_FIAT_LIMITS
       );
 
       if (!result) {
@@ -344,10 +333,10 @@ export const StorageUtil = {
     try {
       const timestamp = Date.now();
 
-      await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_FIAT_CURRENCIES,
-        { data: fiatCurrencies, timestamp }
-      );
+      await OptionsController.getStorage().setItem(SafeStorageKeys.ONRAMP_FIAT_CURRENCIES, {
+        data: fiatCurrencies,
+        timestamp
+      });
     } catch {
       console.info('Unable to set OnRamp Fiat Currencies');
     }
@@ -356,7 +345,7 @@ export const StorageUtil = {
   async getOnRampFiatCurrencies() {
     try {
       const result = await OptionsController.getStorage().getItem(
-        ConstantsUtil.STORAGE_KEYS.ONRAMP_FIAT_CURRENCIES
+        SafeStorageKeys.ONRAMP_FIAT_CURRENCIES
       );
 
       if (!result) {
@@ -381,17 +370,12 @@ export const StorageUtil = {
   async setActiveNamespace(namespace?: ChainNamespace) {
     try {
       if (!namespace) {
-        await OptionsController.getStorage().removeItem(
-          ConstantsUtil.STORAGE_KEYS.ACTIVE_NAMESPACE
-        );
+        await OptionsController.getStorage().removeItem(SafeStorageKeys.ACTIVE_NAMESPACE);
 
         return;
       }
 
-      await OptionsController.getStorage().setItem(
-        ConstantsUtil.STORAGE_KEYS.ACTIVE_NAMESPACE,
-        namespace
-      );
+      await OptionsController.getStorage().setItem(SafeStorageKeys.ACTIVE_NAMESPACE, namespace);
     } catch {
       console.info('Unable to set Active Namespace');
     }
@@ -400,7 +384,7 @@ export const StorageUtil = {
   async getActiveNamespace() {
     try {
       const namespace = (await OptionsController.getStorage().getItem(
-        ConstantsUtil.STORAGE_KEYS.ACTIVE_NAMESPACE
+        SafeStorageKeys.ACTIVE_NAMESPACE
       )) as ChainNamespace;
 
       return namespace ?? undefined;
@@ -414,7 +398,7 @@ export const StorageUtil = {
 
   async removeActiveNamespace() {
     try {
-      await OptionsController.getStorage().removeItem(ConstantsUtil.STORAGE_KEYS.ACTIVE_NAMESPACE);
+      await OptionsController.getStorage().removeItem(SafeStorageKeys.ACTIVE_NAMESPACE);
     } catch {
       console.info('Unable to remove Active Namespace');
     }