@reown/appkit-common-react-native 2.0.0 → 2.0.1

package/src/types/api/events.ts

@@ -0,0 +1,462 @@
+import type {
+  Platform,
+  SocialProvider,
+  AccountType,
+  CaipNetworkId,
+  ChainNamespace,
+  ThemeVariables,
+  ThemeMode
+} from '../common';
+import type { Features } from '../ui';
+import type { Metadata } from '../wallet';
+
+export type WalletImpressionItem = {
+  name: string;
+  walletRank: number | undefined;
+  explorerId: string;
+  view: 'Connect' | 'AllWallets';
+  displayIndex?: number;
+  query?: string;
+  certified?: boolean;
+  installed?: boolean;
+};
+
+export type EventName =
+  | 'MODAL_LOADED'
+  | 'MODAL_OPEN'
+  | 'MODAL_CLOSE'
+  | 'INITIALIZE'
+  | 'WALLET_IMPRESSION'
+  | 'CLICK_ALL_WALLETS'
+  | 'CLICK_NETWORKS'
+  | 'SWITCH_NETWORK'
+  | 'SELECT_WALLET'
+  | 'CONNECT_SUCCESS'
+  | 'CONNECT_ERROR'
+  | 'DISCONNECT_SUCCESS'
+  | 'DISCONNECT_ERROR'
+  | 'CLICK_WALLET_HELP'
+  | 'CLICK_NETWORK_HELP'
+  | 'CLICK_GET_WALLET_HELP'
+  | 'GET_WALLET'
+  | 'EMAIL_LOGIN_SELECTED'
+  | 'EMAIL_VERIFICATION_CODE_PASS'
+  | 'EMAIL_VERIFICATION_CODE_FAIL'
+  | 'EMAIL_EDIT'
+  | 'EMAIL_EDIT_COMPLETE'
+  | 'EMAIL_UPGRADE_FROM_MODAL'
+  | 'SIWX_AUTH_SUCCESS'
+  | 'SIWX_AUTH_ERROR'
+  | 'CLICK_SIGN_SIWX_MESSAGE'
+  | 'CLICK_CANCEL_SIWX'
+  | 'CLICK_TRANSACTIONS'
+  | 'ERROR_FETCH_TRANSACTIONS'
+  | 'LOAD_MORE_TRANSACTIONS'
+  | 'OPEN_SEND'
+  | 'OPEN_SWAP'
+  | 'INITIATE_SWAP'
+  | 'SWAP_SUCCESS'
+  | 'SWAP_ERROR'
+  | 'SEND_INITIATED'
+  | 'SEND_SUCCESS'
+  | 'SEND_ERROR'
+  | 'SOCIAL_LOGIN_STARTED'
+  | 'SOCIAL_LOGIN_SUCCESS'
+  | 'SOCIAL_LOGIN_REQUEST_USER_DATA'
+  | 'SOCIAL_LOGIN_CANCELED'
+  | 'SOCIAL_LOGIN_ERROR'
+  | 'SET_PREFERRED_ACCOUNT_TYPE';
+
+export type Event =
+  | {
+      type: 'track';
+      event: 'MODAL_CREATED';
+    }
+  | {
+      type: 'track';
+      event: 'MODAL_LOADED';
+    }
+  | {
+      type: 'track';
+      event: 'MODAL_OPEN';
+      properties: {
+        connected: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'INITIALIZE';
+      properties: {
+        showWallets?: boolean;
+        themeMode?: ThemeMode;
+        themeVariables?: ThemeVariables;
+        networks: CaipNetworkId[];
+        defaultNetwork?: CaipNetworkId;
+        metadata?: Metadata;
+        enableAnalytics?: boolean;
+        features?: Features;
+        adapters?: string[];
+        extraConnectors?: string[];
+        siwx?: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'MODAL_CLOSE';
+      properties: {
+        connected: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_ALL_WALLETS';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_NETWORKS';
+    }
+  | {
+      type: 'track';
+      event: 'SWITCH_NETWORK';
+      properties: {
+        network: CaipNetworkId;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SELECT_WALLET';
+      properties: {
+        name: string;
+        platform?: Platform;
+        explorerId?: string;
+        walletRank?: number;
+        displayIndex?: number;
+        view?: 'Connect' | 'AllWallets';
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CONNECT_SUCCESS';
+      address?: string;
+      properties: {
+        name: string;
+        caipNetworkId?: CaipNetworkId;
+        method?: Platform;
+        explorerId?: string;
+        reconnect?: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CONNECT_ERROR';
+      properties: {
+        message: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'DISCONNECT_SUCCESS';
+      properties: {
+        namespace?: ChainNamespace;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'DISCONNECT_ERROR';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_WALLET_HELP';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_NETWORK_HELP';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_GET_WALLET_HELP';
+    }
+  | {
+      type: 'track';
+      event: 'GET_WALLET';
+      properties: {
+        name: string;
+        explorerId?: string;
+        link?: string;
+        linkType?: 'appstore' | 'playstore';
+        walletRank?: number;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_LOGIN_SELECTED';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_VERIFICATION_CODE_PASS';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_VERIFICATION_CODE_FAIL';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_EDIT';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_EDIT_COMPLETE';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_UPGRADE_FROM_MODAL';
+    }
+  | {
+      type: 'track';
+      address?: string;
+      event: 'CLICK_SIGN_SIWX_MESSAGE';
+      properties: {
+        network?: CaipNetworkId;
+        isSmartAccount: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_CANCEL_SIWX';
+      properties: {
+        network?: CaipNetworkId;
+        isSmartAccount: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SIWX_AUTH_SUCCESS';
+      properties: {
+        network?: CaipNetworkId;
+        isSmartAccount: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SIWX_AUTH_ERROR';
+      properties: {
+        network?: CaipNetworkId;
+        isSmartAccount: boolean;
+        message?: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_TRANSACTIONS';
+      properties: {
+        isSmartAccount: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'ERROR_FETCH_TRANSACTIONS';
+      properties: {
+        address: string;
+        projectId: string;
+        cursor: string | undefined;
+        isSmartAccount: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'LOAD_MORE_TRANSACTIONS';
+      properties: {
+        address: string | undefined;
+        projectId: string;
+        cursor: string | undefined;
+        isSmartAccount: boolean;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'OPEN_SEND';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'OPEN_SWAP';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'INITIATE_SWAP';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+        swapFromToken: string;
+        swapToToken: string;
+        swapFromAmount: string;
+        swapToAmount: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SWAP_SUCCESS';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+        swapFromToken: string;
+        swapToToken: string;
+        swapFromAmount: string;
+        swapToAmount: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SWAP_ERROR';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+        swapFromToken: string;
+        swapToToken: string;
+        swapFromAmount: string;
+        swapToAmount: string;
+        message: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SEND_INITIATED';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+        token: string;
+        amount: number;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SEND_SUCCESS';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+        token: string;
+        amount: number;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SEND_ERROR';
+      properties: {
+        isSmartAccount: boolean;
+        network?: CaipNetworkId;
+        token: string;
+        amount: number;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SOCIAL_LOGIN_STARTED';
+      properties: {
+        provider: SocialProvider;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SOCIAL_LOGIN_SUCCESS';
+      properties: {
+        provider: SocialProvider;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SOCIAL_LOGIN_REQUEST_USER_DATA';
+      properties: {
+        provider: SocialProvider;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SOCIAL_LOGIN_CANCELED';
+      properties: {
+        provider: SocialProvider;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SOCIAL_LOGIN_ERROR';
+      properties: {
+        provider: SocialProvider;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SET_PREFERRED_ACCOUNT_TYPE';
+      properties: {
+        accountType: AccountType;
+        network: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SELECT_BUY_CRYPTO';
+    }
+  | {
+      type: 'track';
+      event: 'SELECT_BUY_ASSET';
+      properties: {
+        asset: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'BUY_SUBMITTED';
+      properties: {
+        asset?: string;
+        network?: string;
+        amount?: string;
+        currency?: string;
+        provider?: string;
+        serviceProvider?: string;
+        paymentMethod?: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'BUY_SUCCESS';
+      properties: {
+        asset?: string | null;
+        network?: string | null;
+        amount?: string | null;
+        currency?: string | null;
+        provider?: string | null;
+        orderId?: string | null;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'BUY_FAIL';
+      properties: {
+        asset?: string;
+        network?: string;
+        amount?: string;
+        currency?: string;
+        provider?: string;
+        serviceProvider?: string;
+        paymentMethod?: string;
+        message?: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'BUY_CANCEL';
+      properties?: {
+        message?: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'WALLET_IMPRESSION';
+      items: Array<WalletImpressionItem>;
+    };

package/src/types/api/index.ts

@@ -0,0 +1,4 @@
+// API types barrel export
+export * from './blockchain-api';
+export * from './wallet-api';
+export * from './events';

package/src/types/api/wallet-api.ts

@@ -0,0 +1,71 @@
+import type { CaipNetworkId } from '../common';
+
+export interface WcWallet {
+  id: string;
+  name: string;
+  homepage?: string;
+  image_id?: string;
+  image_url?: string;
+  order?: number;
+  mobile_link?: string | null;
+  desktop_link?: string | null;
+  webapp_link?: string | null;
+  link_mode?: string | null;
+  app_store?: string | null;
+  play_store?: string | null;
+  chains?: readonly CaipNetworkId[];
+  badge_type?: 'certified' | 'none';
+}
+
+export interface DataWallet {
+  id: string;
+  ios_schema?: string;
+  android_app_id?: string;
+}
+
+export interface ApiGetWalletsRequest {
+  page: number;
+  entries: number;
+  search?: string;
+  include?: string[];
+  exclude?: string[];
+}
+
+export interface ApiGetWalletsResponse {
+  data: WcWallet[];
+  count: number;
+}
+
+export interface ApiGetDataWalletsResponse {
+  data: DataWallet[];
+  count: number;
+}
+
+export interface ApiGetAnalyticsConfigResponse {
+  isAnalyticsEnabled: boolean;
+}
+
+export type CustomWallet = Pick<
+  WcWallet,
+  | 'id'
+  | 'name'
+  | 'homepage'
+  | 'image_url'
+  | 'image_id'
+  | 'mobile_link'
+  | 'desktop_link'
+  | 'webapp_link'
+  | 'link_mode'
+  | 'app_store'
+  | 'play_store'
+> & {
+  android_app_id?: string;
+  ios_schema?: string;
+};
+
+export type UniversalProviderConfigOverride = {
+  methods?: Record<string, string[]>;
+  chains?: Record<string, string[]>;
+  events?: Record<string, string[]>;
+  rpcMap?: Record<string, string>;
+};

package/src/types/blockchain/adapter.ts

@@ -0,0 +1,52 @@
+import type { ChainNamespace, CaipAddress, AdapterType } from '../common';
+import type { WalletConnector } from '../wallet';
+import type { BalanceChangedEvent } from './balance';
+
+export interface BlockchainAdapterConfig {
+  supportedNamespace: ChainNamespace;
+  adapterType: AdapterType;
+}
+
+export interface BlockchainAdapterInitParams {
+  connector: WalletConnector;
+}
+
+export interface AdapterEvents {
+  accountsChanged: (event: AccountsChangedEvent) => void;
+  chainChanged: (event: ChainChangedEvent) => void;
+  disconnect: (event: DisconnectEvent) => void;
+  balanceChanged: (event: BalanceChangedEvent) => void;
+}
+
+export type AccountsChangedEvent = {
+  accounts: CaipAddress[];
+};
+
+export type ChainChangedEvent = {
+  chainId: string;
+};
+
+export type DisconnectEvent = undefined;
+
+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;
+}
+
+export interface ConnectionResponse {
+  accounts: string[];
+  chainId: string;
+  [key: string]: any;
+}

package/src/types/blockchain/balance.ts

@@ -0,0 +1,31 @@
+import type { CaipAddress } from '../common';
+import type { Tokens } from '../wallet';
+import type { AppKitNetwork } from './network';
+
+export interface Balance {
+  name?: string;
+  amount: string;
+  symbol: string;
+  quantity?: {
+    decimals: string;
+    numeric: string;
+  };
+  chainId?: string;
+  address?: CaipAddress | string; // contract address
+  value?: number; //total value of the amount in currency
+  price?: number; //price of the token in currency
+  iconUrl?: string;
+}
+
+export interface GetBalanceParams {
+  network: AppKitNetwork;
+  address?: CaipAddress;
+  tokens?: Tokens;
+}
+
+export type GetBalanceResponse = Balance;
+
+export type BalanceChangedEvent = {
+  address: CaipAddress;
+  balance: Balance;
+};

package/src/types/blockchain/index.ts

@@ -0,0 +1,5 @@
+// Blockchain types barrel export
+export * from './adapter';
+export * from './balance';
+export * from './network';
+export * from './transaction';

package/src/types/blockchain/network.ts

@@ -0,0 +1,39 @@
+import type { ChainNamespace, CaipNetworkId } from '../common';
+
+export type Network = {
+  // Core viem/chain properties
+  id: number | string;
+  name: 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;
+  };
+
+  // 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
+  imageUrl?: string;
+};
+
+export type AppKitNetwork = Network & {
+  chainNamespace: ChainNamespace; // mandatory for AppKitNetwork
+  caipNetworkId: CaipNetworkId; // mandatory for AppKitNetwork
+};
+
+export interface CaipNetwork {
+  id: CaipNetworkId;
+  name?: string;
+  imageId?: string;
+  imageUrl?: string;
+}
+
+export interface AppKitOpenOptions {
+  view: 'Account' | 'Connect' | 'WalletConnect' | 'Networks' | 'Swap' | 'OnRamp';
+}