@reown/appkit-common-react-native 0.0.0-chore-canary-20250722145858 → 0.0.0-chore-bump-builder-20250728194329

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/PresetsUtil.ts

@@ -1,17 +1,9 @@
-import type { ConnectorType } from './TypeUtil';
-import { ConstantsUtil } from './ConstantsUtil';
-
 export const PresetsUtil = {
-  ConnectorExplorerIds: {
-    [ConstantsUtil.COINBASE_CONNECTOR_ID]:
-      'fd20dc426fb37566d803205b19bbc1d4096b248ac04548e3cfb6b3a38bd033aa'
-  } as Record<string, string>,
-
-  EIP155NetworkImageIds: {
+  NetworkImageIds: {
     // Ethereum
     1: 'ba0ba0cd-17c6-4806-ad93-f9d174f17900',
     // Arbitrum
-    42161: '600a9a04-c1b9-42ca-6785-9b4b6ff85200',
+    42161: '3bff954d-5cb0-47a0-9a23-d20192e74600',
     // Avalanche
     43114: '30c46e53-e989-45fb-4549-be3bd4eb3b00',
     // Binance Smart Chain
@@ -22,6 +14,20 @@ export const PresetsUtil = {
     10: 'ab9c186a-c52f-464b-2906-ca59d760a400',
     // Polygon
     137: '41d04d42-da3b-4453-8506-668cc0727900',
+    // Mantle
+    5000: 'e86fae9b-b770-4eea-e520-150e12c81100',
+    // Hedera Mainnet
+    295: '6a97d510-cac8-4e58-c7ce-e8681b044c00',
+    // Sepolia
+    11_155_111: 'e909ea0a-f92a-4512-c8fc-748044ea6800',
+    // Base Sepolia
+    84532: 'a18a7ecd-e307-4360-4746-283182228e00',
+    // Unichain Sepolia
+    1301: '4eeea7ef-0014-4649-5d1d-07271a80f600',
+    // Unichain Mainnet
+    130: '2257980a-3463-48c6-cbac-a42d2a956e00',
+    // Monad Testnet
+    10_143: '0a728e83-bacb-46db-7844-948f05434900',
     // Gnosis
     100: '02b53f6a-e3d4-479e-1cb4-21178987d100',
     // EVMos
@@ -45,26 +51,28 @@ export const PresetsUtil = {
     // Base
     8453: '7289c336-3981-4081-c5f4-efc26ac64a00',
     // Aurora
-    1313161554: '3ff73439-a619-4894-9262-4470c773a100'
-  } as Record<string, string>,
+    1313161554: '3ff73439-a619-4894-9262-4470c773a100',
+    // Ronin Mainnet
+    2020: 'b8101fc0-9c19-4b6f-ec65-f6dfff106e00',
+    // Saigon Testnet (a.k.a. Ronin)
+    2021: 'b8101fc0-9c19-4b6f-ec65-f6dfff106e00',
+    // Berachain Mainnet
+    80094: 'e329c2c9-59b0-4a02-83e4-212ff3779900',
+    // Abstract Mainnet
+    2741: 'fc2427d1-5af9-4a9c-8da5-6f94627cd900',
 
-  ConnectorNamesMap: {
-    [ConstantsUtil.WALLET_CONNECT_CONNECTOR_ID]: 'WalletConnect',
-    [ConstantsUtil.COINBASE_CONNECTOR_ID]: 'Coinbase Wallet',
-    [ConstantsUtil.AUTH_CONNECTOR_ID]: 'AppKit Universal Wallet'
-  } as Record<string, string>,
+    // Solana networks
+    /// Mainnet
+    '5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp': 'a1b58899-f671-4276-6a5e-56ca5bd59700',
+    /// Testnet
+    '4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z': 'a1b58899-f671-4276-6a5e-56ca5bd59700',
 
-  ConnectorImageIds: {
-    [ConstantsUtil.COINBASE_CONNECTOR_ID]: '0c2840c3-5b04-4c44-9661-fbd4b49e1800',
-    [ConstantsUtil.WALLET_CONNECT_CONNECTOR_ID]: 'ef1a1fcf-7fe8-4d69-bd6d-fda1345b4400'
+    // Bitcoin
+    '000000000019d6689c085ae165831e93': '0b4838db-0161-4ffe-022d-532bf03dba00',
+    // Bitcoin Testnet
+    '000000000933ea01ad0ee984209779ba': '39354064-d79b-420b-065d-f980c4b78200'
   } as Record<string, string>,
 
-  ConnectorTypesMap: {
-    [ConstantsUtil.WALLET_CONNECT_CONNECTOR_ID]: 'WALLET_CONNECT',
-    [ConstantsUtil.COINBASE_CONNECTOR_ID]: 'COINBASE',
-    [ConstantsUtil.AUTH_CONNECTOR_ID]: 'AUTH'
-  } as Record<string, ConnectorType>,
-
   RpcChainIds: [
     // Ethereum
     1,

package/src/utils/StringUtil.ts

@@ -5,5 +5,12 @@ export const StringUtil = {
     }
 
     return value.charAt(0).toUpperCase() + value.slice(1).toLowerCase();
+  },
+  hexToString(hexValue: string) {
+    // Remove 0x prefix if present
+    const cleanHex = hexValue.startsWith('0x') ? hexValue.slice(2) : hexValue;
+    // Convert hex to decimal number, then to string
+
+    return parseInt(cleanHex, 16).toString();
   }
 };

package/src/utils/TypeUtil.ts

@@ -1,19 +1,73 @@
-export interface Balance {
+import { EventEmitter } from 'events';
+import type { BlockchainAdapter } from '../adapters/BlockchainAdapter';
+
+export type CaipAddress = `${string}:${string}:${string}`;
+
+export type CaipNetworkId = `${string}:${string}`;
+
+export type ChainNamespace = 'eip155' | 'solana' | 'polkadot' | 'bip122';
+
+export type AdapterType = 'solana' | 'wagmi' | 'ethers' | 'universal' | 'bip122';
+
+export type Network = {
+  // Core viem/chain properties
+  id: number | string;
   name: string;
-  symbol: string;
-  chainId: string;
-  address?: string;
-  value?: number;
-  price: number;
-  quantity: BalanceQuantity;
-  iconUrl: string;
-}
+  nativeCurrency: { name: string; symbol: string; decimals: number };
+  rpcUrls: {
+    default: { http: readonly string[] };
+    [key: string]: { http: readonly string[] } | undefined;
+  };
+  blockExplorers?: {
+    default: { name: string; url: string };
+    [key: string]: { name: string; url: string } | undefined;
+  };
 
-type BalanceQuantity = {
-  decimals: string;
-  numeric: string;
+  // AppKit specific / CAIP properties (Optional in type, but needed in practice)
+  chainNamespace?: ChainNamespace; // e.g., 'eip155'
+  caipNetworkId?: CaipNetworkId; // e.g., 'eip155:1'
+  testnet?: boolean;
+  deprecatedCaipNetworkId?: CaipNetworkId; // for Solana deprecated id
+};
+
+export type AppKitNetwork = Network & {
+  chainNamespace: ChainNamespace; // e.g., 'eip155'
+  caipNetworkId: CaipNetworkId; // e.g., 'eip155:1'
+  testnet?: boolean;
+  deprecatedCaipNetworkId?: CaipNetworkId; // for Solana deprecated id
 };
 
+export interface AppKitOpenOptions {
+  view: 'Account' | 'Connect' | 'Networks' | 'Swap' | 'OnRamp';
+}
+
+export type AppKitConnectOptions = Pick<
+  ConnectOptions,
+  'namespaces' | 'defaultChain' | 'universalLink'
+>;
+
+export interface CaipNetwork {
+  id: CaipNetworkId;
+  name?: string;
+  imageId?: string;
+  imageUrl?: string;
+}
+
+export interface Balance {
+  name?: string;
+  amount: string;
+  symbol: string;
+  quantity?: {
+    decimals: string;
+    numeric: string;
+  };
+  chainId?: string;
+  address?: CaipAddress; // contract address
+  value?: number; //total value of the amount in currency
+  price?: number; //price of the token in currency
+  iconUrl?: string;
+}
+
 export type TransactionStatus = 'confirmed' | 'failed' | 'pending';
 export type TransactionDirection = 'in' | 'out' | 'self';
 export type TransactionImage = {
@@ -86,7 +140,15 @@ export interface TransactionQuantity {
   numeric: string;
 }
 
-export type SocialProvider = 'apple' | 'x' | 'discord' | 'farcaster';
+export type SocialProvider =
+  | 'google'
+  | 'facebook'
+  | 'github'
+  | 'apple'
+  | 'x'
+  | 'discord'
+  | 'email'
+  | 'farcaster';
 
 export type ThemeMode = 'dark' | 'light';
 
@@ -94,4 +156,338 @@ export interface ThemeVariables {
   accent?: string;
 }
 
-export type ConnectorType = 'WALLET_CONNECT' | 'COINBASE' | 'AUTH' | 'EXTERNAL';
+export interface Token {
+  address: string;
+  image?: string;
+}
+
+export type Tokens = Record<CaipNetworkId, Token>;
+
+export type Metadata = {
+  name: string;
+  description: string;
+  url: string;
+  icons: string[];
+  redirect?: {
+    native?: string;
+    universal?: string;
+    linkMode?: boolean;
+  };
+};
+
+export interface Identity {
+  name: string;
+  avatar?: string;
+}
+
+export interface Connection {
+  accounts: CaipAddress[];
+  balances: Map<CaipAddress, Balance[]>;
+  adapter: BlockchainAdapter;
+  caipNetwork: CaipNetworkId;
+  wallet?: WalletInfo;
+  properties?: ConnectionProperties;
+  type?: AccountType;
+  identities?: Map<CaipAddress, Identity>;
+}
+
+export type BlockchainAdapterConfig = {
+  projectId: string;
+  supportedNamespace: ChainNamespace;
+  adapterType: AdapterType;
+};
+
+//********** Adapter Event Payloads **********//
+export type AccountsChangedEvent = {
+  accounts: string[];
+};
+
+export type ChainChangedEvent = {
+  chainId: string;
+};
+
+export type DisconnectEvent = {};
+
+export type BalanceChangedEvent = {
+  address: CaipAddress;
+  balance: Balance;
+};
+
+//********** Adapter Event Map **********//
+export interface AdapterEvents {
+  accountsChanged: (event: AccountsChangedEvent) => void;
+  chainChanged: (event: ChainChangedEvent) => void;
+  disconnect: (event: DisconnectEvent) => void;
+  balanceChanged: (event: BalanceChangedEvent) => void;
+}
+
+export interface GetBalanceParams {
+  network: AppKitNetwork;
+  address?: CaipAddress;
+  tokens?: Tokens;
+}
+
+export type GetBalanceResponse = Balance;
+
+//********** Connector Types **********//
+interface BaseNamespace {
+  chains?: CaipNetworkId[];
+  accounts: CaipAddress[];
+  methods: string[];
+  events: string[];
+}
+
+type Namespace = BaseNamespace;
+
+export type Namespaces = Record<string, Namespace>;
+
+export type ProposalNamespaces = Record<
+  string,
+  Omit<Namespace, 'accounts'> &
+    Required<Pick<Namespace, 'chains'>> & { rpcMap: Record<string, string> }
+>;
+
+export type ConnectOptions = {
+  namespaces?: ProposalNamespaces;
+  defaultChain?: CaipNetworkId;
+  universalLink?: string;
+  siweConfig?: AppKitSIWEClient;
+};
+
+export type ConnectorInitOptions = {
+  storage: Storage;
+  metadata: Metadata;
+};
+
+export abstract class WalletConnector extends EventEmitter {
+  public type: ConnectorType;
+  protected provider?: Provider;
+  protected namespaces?: Namespaces;
+  protected wallet?: WalletInfo;
+  protected storage?: Storage;
+  protected metadata?: Metadata;
+  protected properties?: ConnectionProperties;
+
+  constructor({ type }: { type: 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;
+  }
+
+  public async disconnect() {
+    await this.provider?.disconnect();
+    this.namespaces = undefined;
+    this.wallet = undefined;
+    this.properties = undefined;
+  }
+
+  abstract connect(opts: ConnectOptions): Promise<Namespaces | undefined>;
+  abstract getProvider(): Provider;
+  abstract getNamespaces(): Namespaces;
+  abstract getChainId(namespace: ChainNamespace): CaipNetworkId | undefined;
+  abstract getWalletInfo(): WalletInfo | undefined;
+  abstract getProperties(): ConnectionProperties | undefined;
+  abstract switchNetwork(network: AppKitNetwork): Promise<void>;
+  abstract restoreSession(): Promise<boolean>;
+}
+
+export type ConnectorType = 'walletconnect' | 'coinbase' | 'auth' | 'phantom';
+
+//********** Provider Types **********//
+
+export interface Provider {
+  connect<T>(params?: any): Promise<T>;
+  disconnect(): Promise<void>;
+  request<T = unknown>(
+    args: RequestArguments,
+    chain?: string | undefined,
+    expiry?: number | undefined
+  ): Promise<T>;
+  on(event: string, listener: (args?: any) => void): any;
+  off(event: string, listener: (args?: any) => void): any;
+}
+
+export interface RequestArguments {
+  method: string;
+  params?: unknown[] | Record<string, unknown> | object | undefined;
+}
+
+//********** Others **********//
+
+export interface ConnectionResponse {
+  accounts: string[];
+  chainId: string;
+  [key: string]: any;
+}
+
+export interface WalletInfo {
+  name?: string;
+  icon?: string;
+  description?: string;
+  url?: string;
+  icons?: string[];
+  redirect?: {
+    native?: string;
+    universal?: string;
+    linkMode?: boolean;
+  };
+  [key: string]: unknown;
+}
+
+export interface ConnectionProperties {
+  email?: string;
+  username?: string;
+  smartAccounts?: CaipAddress[];
+  provider?: SocialProvider;
+  sessionTopic?: string;
+}
+
+export interface LinkingRecord {
+  redirect: string;
+  href: string;
+}
+
+export interface WalletDeepLink {
+  href: string;
+  name: string;
+}
+
+export type AccountType = 'eoa' | 'smartAccount';
+
+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>;
+}
+
+//********** SIWE Types **********//
+export interface SIWESession {
+  address: string;
+  chainId: number;
+}
+
+interface CacaoHeader {
+  t: 'caip122';
+}
+
+export interface SIWECreateMessageArgs {
+  domain: string;
+  nonce: string;
+  uri: string;
+  address: CaipAddress;
+  version: '1';
+  type?: CacaoHeader['t'];
+  nbf?: string;
+  exp?: string;
+  statement?: string;
+  requestId?: string;
+  resources?: string[];
+  expiry?: number;
+  iat?: string;
+}
+export type SIWEMessageArgs = {
+  chains: CaipNetworkId[];
+  methods?: string[];
+} & Omit<SIWECreateMessageArgs, 'address' | 'nonce' | 'version'>;
+// Signed Cacao (CAIP-74)
+interface CacaoPayload {
+  domain: string;
+  aud: string;
+  nonce: string;
+  iss: string;
+  version?: string;
+  iat?: string;
+  nbf?: string;
+  exp?: string;
+  statement?: string;
+  requestId?: string;
+  resources?: string[];
+  type?: string;
+}
+
+interface Cacao {
+  h: CacaoHeader;
+  p: CacaoPayload;
+  s: {
+    t: 'eip191' | 'eip1271';
+    s: string;
+    m?: string;
+  };
+}
+
+export interface SIWEVerifyMessageArgs {
+  message: string;
+  signature: string;
+  cacao?: Cacao;
+}
+
+export interface SIWEClientMethods {
+  getNonce: (address?: string) => Promise<string>;
+  createMessage: (args: SIWECreateMessageArgs) => string;
+  verifyMessage: (args: SIWEVerifyMessageArgs) => Promise<boolean>;
+  getSession: () => Promise<SIWESession | null>;
+  signOut: () => Promise<boolean>;
+  getMessageParams?: () => Promise<SIWEMessageArgs>;
+  onSignIn?: (session?: SIWESession) => void;
+  onSignOut?: () => void;
+}
+
+export interface SIWEConfig extends SIWEClientMethods {
+  // Defaults to true
+  enabled?: boolean;
+  // In milliseconds, defaults to 5 minutes
+  nonceRefetchIntervalMs?: number;
+  // In milliseconds, defaults to 5 minutes
+  sessionRefetchIntervalMs?: number;
+  // Defaults to true
+  signOutOnDisconnect?: boolean;
+  // Defaults to true
+  signOutOnAccountChange?: boolean;
+  // Defaults to true
+  signOutOnNetworkChange?: boolean;
+}
+
+export interface AppKitSIWEClient extends SIWEClientMethods {
+  signIn: () => Promise<SIWESession | undefined>;
+  options: {
+    enabled: boolean;
+    nonceRefetchIntervalMs: number;
+    sessionRefetchIntervalMs: number;
+    signOutOnDisconnect: boolean;
+    signOutOnAccountChange: boolean;
+    signOutOnNetworkChange: boolean;
+  };
+}