@reown/appkit-common-react-native 2.0.0-alpha.0 → 2.0.0-alpha.1

package/src/networks/solana.ts

@@ -0,0 +1,44 @@
+import type { AppKitNetwork } from '../utils/TypeUtil';
+
+export const solana: AppKitNetwork = {
+  id: '5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
+  name: 'Solana',
+  nativeCurrency: { name: 'Solana', symbol: 'SOL', decimals: 9 },
+  rpcUrls: {
+    default: {
+      http: ['https://rpc.walletconnect.org/v1']
+    }
+  },
+  blockExplorers: { default: { name: 'Solscan', url: 'https://solscan.io' } },
+  chainNamespace: 'solana',
+  caipNetworkId: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
+  deprecatedCaipNetworkId: 'solana:4sGjMW1sUnHzSxGspuhpqLDx6wiyjNtZ',
+  testnet: false
+};
+
+export const solanaDevnet: AppKitNetwork = {
+  id: 'EtWTRABZaYq6iMfeYKouRu166VU2xqa1',
+  name: 'Solana Devnet',
+  nativeCurrency: { name: 'Solana', symbol: 'SOL', decimals: 9 },
+  rpcUrls: {
+    default: { http: ['https://rpc.walletconnect.org/v1'] }
+  },
+  blockExplorers: { default: { name: 'Solscan', url: 'https://solscan.io' } },
+  chainNamespace: 'solana',
+  caipNetworkId: 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1',
+  deprecatedCaipNetworkId: 'solana:8E9rvCKLFQia2Y35HXjjpWzj8weVo44K',
+  testnet: true
+};
+
+export const solanaTestnet: AppKitNetwork = {
+  id: '4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z',
+  name: 'Solana Testnet',
+  nativeCurrency: { name: 'Solana', symbol: 'SOL', decimals: 9 },
+  rpcUrls: {
+    default: { http: ['https://rpc.walletconnect.org/v1'] }
+  },
+  blockExplorers: { default: { name: 'Solscan', url: 'https://solscan.io' } },
+  chainNamespace: 'solana',
+  caipNetworkId: 'solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z',
+  testnet: true
+};

package/src/utils/ConstantsUtil.ts

@@ -1,5 +1,5 @@
 export const ConstantsUtil = {
-  VERSION: '2.0.0-alpha.0',
+  VERSION: '2.0.0-alpha.1',
 
   EIP155: 'eip155',
   ADD_CHAIN_METHOD: 'wallet_addEthereumChain',

package/src/utils/NumberUtil.ts

@@ -1,6 +1,12 @@
 import * as BigNumber from 'bignumber.js';
 
 export const NumberUtil = {
+  /**
+   * Creates a BigNumber instance from a given value.
+   * If the value is a string, commas are removed before conversion.
+   * @param value - The input value (string, number, or BigNumber) to convert to a BigNumber.
+   * @returns A BigNumber instance.
+   */
   bigNumber(value: BigNumber.BigNumber.Value) {
     if (typeof value === 'string') {
       return new BigNumber.BigNumber(value.replace(/,/g, ''));
@@ -10,10 +16,11 @@ export const NumberUtil = {
   },
 
   /**
-   * Multiply two numbers represented as strings with BigNumber to handle decimals correctly
-   * @param a string
-   * @param b string
-   * @returns
+   * Multiplies two numbers using BigNumber for precision, especially with decimals.
+   * Handles undefined inputs by returning BigNumber(0).
+   * @param a - The first multiplicand (string, number, or BigNumber). Commas are removed if it's a string.
+   * @param b - The second multiplicand (string, number, or BigNumber). Commas are removed if it's a string.
+   * @returns The product as a BigNumber instance, or BigNumber(0) if either input is undefined.
    */
   multiply(a: BigNumber.BigNumber.Value | undefined, b: BigNumber.BigNumber.Value | undefined) {
     if (a === undefined || b === undefined) {
@@ -26,6 +33,13 @@ export const NumberUtil = {
     return aBigNumber.multipliedBy(bBigNumber);
   },
 
+  /**
+   * Rounds a number to a specified number of decimal places if its string representation meets a certain length threshold.
+   * @param number - The number to potentially round.
+   * @param threshold - The minimum string length of the number to trigger rounding.
+   * @param fixed - The number of decimal places to round to.
+   * @returns The rounded number (as a string if rounded, otherwise the original number) or the original number.
+   */
   roundNumber(number: number, threshold: number, fixed: number) {
     const roundedNumber =
       number.toString().length >= threshold ? Number(number).toFixed(fixed) : number;
@@ -33,6 +47,12 @@ export const NumberUtil = {
     return roundedNumber;
   },
 
+  /**
+   * Calculates the next multiple of ten greater than or equal to the given amount.
+   * Defaults to 10 if no amount is provided or if the calculated multiple is less than 10.
+   * @param amount - The number for which to find the next multiple of ten. Optional.
+   * @returns The next multiple of ten, at least 10.
+   */
   nextMultipleOfTen(amount?: number) {
     if (!amount) return 10;
 
@@ -40,10 +60,10 @@ export const NumberUtil = {
   },
 
   /**
-   * Format the given number or string to human readable numbers with the given number of decimals
-   * @param value - The value to format. It could be a number or string. If it's a string, it will be parsed to a float then formatted.
-   * @param decimals - number of decimals after dot
-   * @returns
+   * Formats a number or string to a human-readable string with a specified number of decimal places, using US locale formatting.
+   * @param value - The value to format (string, number, or undefined). If undefined, returns '0.00'.
+   * @param decimals - The number of decimal places to display. Defaults to 2.
+   * @returns A locale-formatted string representation of the number.
    */
   formatNumberToLocalString(value: string | number | undefined, decimals = 2) {
     if (value === undefined) {
@@ -62,10 +82,11 @@ export const NumberUtil = {
       minimumFractionDigits: decimals
     });
   },
+
   /**
-   * Parse a formatted local string back to a number
-   * @param value - The formatted string to parse
-   * @returns
+   * Parses a locale-formatted numeric string (e.g., with commas) back into a number.
+   * @param value - The formatted string to parse. If undefined, returns 0.
+   * @returns The parsed number, or 0 if the input is undefined.
    */
   parseLocalStringToNumber(value: string | undefined) {
     if (value === undefined) {
@@ -74,5 +95,27 @@ export const NumberUtil = {
 
     // Remove any commas used as thousand separators and parse the float
     return parseFloat(value.replace(/,/gu, ''));
+  },
+
+  /**
+   * Converts a numeric value (BigInt, number, or string representation of a number) to a 0x-prefixed hexadecimal string.
+   * This is often required for Ethereum RPC parameters like value, gas, gasPrice.
+   * @param value - The value to convert. Can be BigInt, number, or a string (decimal or hex).
+   * @returns A 0x-prefixed hexadecimal string, or undefined if the input is undefined or null.
+   * @throws Error if the value cannot be converted to BigInt.
+   */
+  convertNumericToHexString: (value: any): string | undefined => {
+    if (value === undefined || value === null) {
+      return undefined;
+    }
+    try {
+      // This handles BigInt, number, or string representation of a number (decimal or hex)
+      const bigIntValue = BigInt(value);
+      // Ethereum RPC spec requires "0x0" for zero, and other values to be 0x-prefixed hex.
+
+      return '0x' + bigIntValue.toString(16);
+    } catch (error) {
+      throw new Error(`NumberUtil: Invalid parameter, cannot convert to hex: ${value}`);
+    }
   }
 };

package/src/utils/TypeUtil.ts

@@ -45,7 +45,7 @@ export interface Balance {
   name: string;
   symbol: string;
   chainId: string;
-  address?: string;
+  address?: CaipAddress;
   value?: number;
   price: number;
   quantity: BalanceQuantity;
@@ -146,23 +146,30 @@ export type Tokens = Record<CaipNetworkId, Token>;
 
 export type ConnectorType = 'WALLET_CONNECT' | 'COINBASE' | 'AUTH' | 'EXTERNAL';
 
+export type Metadata = {
+  name: string;
+  description: string;
+  url: string;
+  icons: string[];
+  redirect?: {
+    native?: string;
+    universal?: string;
+    linkMode?: boolean;
+  };
+};
+
 //********** Adapter Event Payloads **********//
 export type AccountsChangedEvent = {
   accounts: string[];
-  namespace: ChainNamespace;
 };
 
 export type ChainChangedEvent = {
   chainId: string;
-  namespace: ChainNamespace;
 };
 
-export type DisconnectEvent = {
-  namespace: ChainNamespace;
-};
+export type DisconnectEvent = {};
 
 export type BalanceChangedEvent = {
-  namespace: ChainNamespace;
   address: CaipAddress;
   balance: {
     amount: string;
@@ -179,104 +186,6 @@ export interface AdapterEvents {
   balanceChanged: (event: BalanceChangedEvent) => void;
 }
 
-//********** Adapter Types **********//
-export abstract class BlockchainAdapter extends EventEmitter {
-  public projectId: string;
-  public connector?: WalletConnector;
-  public supportedNamespace: ChainNamespace;
-
-  // Typed emit method
-  override emit<K extends keyof AdapterEvents>(
-    event: K,
-    payload: Parameters<AdapterEvents[K]>[0]
-  ): boolean {
-    return super.emit(event, payload);
-  }
-
-  constructor({
-    projectId,
-    supportedNamespace
-  }: {
-    projectId: string;
-    supportedNamespace: ChainNamespace;
-  }) {
-    super();
-    this.projectId = projectId;
-    this.supportedNamespace = supportedNamespace;
-  }
-
-  setConnector(connector: WalletConnector) {
-    this.connector = connector;
-    this.subscribeToEvents();
-  }
-
-  removeConnector() {
-    this.connector = undefined;
-  }
-
-  getProvider(): Provider {
-    if (!this.connector) throw new Error('No active connector');
-
-    return this.connector.getProvider();
-  }
-
-  subscribeToEvents(): void {
-    const provider = this.connector?.getProvider();
-    if (!provider) return;
-
-    provider.on('chainChanged', this.onChainChanged.bind(this));
-    provider.on('accountsChanged', this.onAccountsChanged.bind(this));
-    provider.on('disconnect', this.onDisconnect.bind(this));
-  }
-
-  onChainChanged(chainId: string): void {
-    const _chains = this.getAccounts()?.map(account => account.split(':')[1]);
-    const shouldEmit = _chains?.some(chain => chain === chainId);
-
-    if (shouldEmit) {
-      this.emit('chainChanged', { chainId, namespace: this.getSupportedNamespace() });
-    }
-  }
-
-  onAccountsChanged(accounts: string[]): void {
-    const _accounts = this.getAccounts();
-    const shouldEmit = _accounts?.some(account => {
-      const accountAddress = account.split(':')[2];
-
-      return accountAddress !== undefined && accounts.includes(accountAddress);
-    });
-
-    if (shouldEmit) {
-      this.emit('accountsChanged', { accounts, namespace: this.getSupportedNamespace() });
-    }
-  }
-
-  onDisconnect(): void {
-    this.emit('disconnect', { namespace: this.getSupportedNamespace() });
-
-    const provider = this.connector?.getProvider();
-    if (provider) {
-      provider.off('chainChanged', this.onChainChanged.bind(this));
-      provider.off('accountsChanged', this.onAccountsChanged.bind(this));
-      provider.off('disconnect', this.onDisconnect.bind(this));
-    }
-
-    this.connector = undefined;
-  }
-
-  abstract disconnect(): Promise<void>;
-  abstract getSupportedNamespace(): ChainNamespace;
-  abstract getBalance(params: GetBalanceParams): Promise<GetBalanceResponse>;
-  abstract getAccounts(): CaipAddress[] | undefined;
-  abstract switchNetwork(network: AppKitNetwork): Promise<void>;
-}
-
-export abstract class EVMAdapter extends BlockchainAdapter {
-  // ens logic
-}
-
-export abstract class SolanaBaseAdapter extends BlockchainAdapter {}
-
 export interface GetBalanceParams {
   address?: CaipAddress;
   network?: AppKitNetwork;
@@ -305,25 +214,44 @@ export type Namespaces = Record<string, Namespace>;
 
 export type ProposalNamespaces = Record<
   string,
-  Omit<Namespace, 'accounts'> & Required<Pick<Namespace, 'chains'>>
+  Omit<Namespace, 'accounts'> &
+    Required<Pick<Namespace, 'chains'>> & { rpcMap: Record<string, string> }
 >;
 
+export type ConnectOptions = {
+  namespaces?: ProposalNamespaces;
+  defaultChain?: CaipNetworkId;
+  universalLink?: string;
+};
+
+export type ConnectorInitOptions = {
+  storage: Storage;
+  metadata: Metadata;
+};
+
 export abstract class WalletConnector extends EventEmitter {
   public type: New_ConnectorType;
-  protected provider: Provider;
+  protected provider?: Provider;
   protected namespaces?: Namespaces;
   protected wallet?: WalletInfo;
+  protected storage?: Storage;
+  protected metadata?: Metadata;
 
-  constructor({ type, provider }: { type: New_ConnectorType; provider: Provider }) {
+  constructor({ type }: { type: New_ConnectorType }) {
     super();
     this.type = type;
+  }
+
+  public async init(ops: ConnectorInitOptions) {
+    this.storage = ops.storage;
+    this.metadata = ops.metadata;
+  }
+
+  public setProvider(provider: Provider) {
     this.provider = provider;
   }
 
-  abstract connect(opts: {
-    namespaces?: ProposalNamespaces;
-    defaultChain?: CaipNetworkId;
-  }): Promise<Namespaces | undefined>;
+  abstract connect(opts: ConnectOptions): Promise<Namespaces | undefined>;
   abstract disconnect(): Promise<void>;
   abstract getProvider(): Provider;
   abstract getNamespaces(): Namespaces;
@@ -352,7 +280,7 @@ export interface RequestArguments {
 }
 
 //TODO: rename this and remove the old one ConnectorType
-export type New_ConnectorType = 'walletconnect' | 'coinbase' | 'auth';
+export type New_ConnectorType = 'walletconnect' | 'coinbase' | 'auth' | 'phantom';
 
 //********** Others **********//
 
@@ -375,3 +303,34 @@ export interface WalletInfo {
   };
   [key: string]: unknown;
 }
+
+export interface Storage {
+  /**
+   * Returns all keys in storage.
+   */
+  getKeys(): Promise<string[]>;
+
+  /**
+   * Returns all key-value entries in storage.
+   */
+  getEntries<T = any>(): Promise<[string, T][]>;
+
+  /**
+   * Get an item from storage for a given key.
+   * @param key The key to retrieve.
+   */
+  getItem<T = any>(key: string): Promise<T | undefined>;
+
+  /**
+   * Set an item in storage for a given key.
+   * @param key The key to set.
+   * @param value The value to set.
+   */
+  setItem<T = any>(key: string, value: T): Promise<void>;
+
+  /**
+   * Remove an item from storage for a given key.
+   * @param key The key to remove.
+   */
+  removeItem(key: string): Promise<void>;
+}