@reown/appkit-core-react-native 0.0.0-canary-20240912195440

package/src/utils/TypeUtil.ts

@@ -0,0 +1,342 @@
+export type CaipAddress = `${string}:${string}:${string}`;
+
+export type CaipNetworkId = `${string}:${string}`;
+
+export interface CaipNetwork {
+  id: CaipNetworkId;
+  name?: string;
+  imageId?: string;
+  imageUrl?: string;
+}
+
+export type ConnectedWalletInfo =
+  | {
+      name?: string;
+      icon?: string;
+      [key: string]: unknown;
+    }
+  | undefined;
+
+export interface LinkingRecord {
+  redirect: string;
+  href: string;
+}
+
+export type ProjectId = string;
+
+export type Platform = 'mobile' | 'web' | 'qrcode' | 'email' | 'unsupported';
+
+export type ConnectorType = 'WALLET_CONNECT' | 'COINBASE' | 'AUTH' | 'EXTERNAL';
+
+export type Connector = {
+  id: string;
+  type: ConnectorType;
+  name?: string;
+  imageId?: string;
+  explorerId?: string;
+  imageUrl?: string;
+  info?: { rdns?: string };
+  provider?: unknown;
+  installed?: boolean;
+};
+
+export type CaipNamespaces = Record<
+  string,
+  {
+    chains: CaipNetworkId[];
+    methods: string[];
+    events: string[];
+  }
+>;
+
+export type SdkVersion =
+  | `react-native-wagmi-${string}`
+  | `react-native-ethers5-${string}`
+  | `react-native-ethers-${string}`;
+
+// -- ApiController Types -------------------------------------------------------
+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;
+}
+
+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 ThemeMode = 'dark' | 'light';
+
+export interface ThemeVariables {
+  accent?: string;
+}
+
+// -- BlockchainApiController Types ---------------------------------------------
+export interface BlockchainApiIdentityRequest {
+  address: string;
+}
+
+export interface BlockchainApiIdentityResponse {
+  avatar: string;
+  name: string;
+}
+
+// -- OptionsController Types ---------------------------------------------------
+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 type CustomWallet = Pick<
+  WcWallet,
+  | 'id'
+  | 'name'
+  | 'homepage'
+  | 'image_url'
+  | 'mobile_link'
+  | 'desktop_link'
+  | 'webapp_link'
+  | 'link_mode'
+  | 'app_store'
+  | 'play_store'
+>;
+
+// -- EventsController Types ----------------------------------------------------
+
+export type Event =
+  | {
+      type: 'track';
+      event: 'MODAL_CREATED';
+    }
+  | {
+      type: 'track';
+      event: 'MODAL_LOADED';
+    }
+  | {
+      type: 'track';
+      event: 'MODAL_OPEN';
+      properties: {
+        connected: 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: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SELECT_WALLET';
+      properties: {
+        name: string;
+        platform?: Platform;
+        explorer_id?: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CONNECT_SUCCESS';
+      properties: {
+        name: string;
+        method: Platform;
+        explorer_id?: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'CONNECT_ERROR';
+      properties: {
+        message: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'DISCONNECT_SUCCESS';
+    }
+  | {
+      type: 'track';
+      event: 'DISCONNECT_ERROR';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_WALLET_HELP';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_NETWORK_HELP';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_GET_WALLET';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_LOGIN_SELECTED';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_SUBMITTED';
+    }
+  | {
+      type: 'track';
+      event: 'DEVICE_REGISTERED_FOR_EMAIL';
+    }
+  | {
+      type: 'track';
+      event: 'EMAIL_VERIFICATION_CODE_SENT';
+    }
+  | {
+      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';
+      event: 'CLICK_SIGN_SIWE_MESSAGE';
+    }
+  | {
+      type: 'track';
+      event: 'CLICK_CANCEL_SIWE';
+    }
+  | {
+      type: 'track';
+      event: 'SIWE_AUTH_SUCCESS';
+    }
+  | {
+      type: 'track';
+      event: 'SIWE_AUTH_ERROR';
+    };
+
+// -- Email Types ------------------------------------------------
+/**
+ * Matches type defined for packages/email/src/AppKitFrameProvider.ts
+ * It's duplicated in order to decouple scaffold from email package
+ */
+export interface AppKitFrameProvider {
+  readonly id: string;
+  readonly name: string;
+  getSecureSiteURL(): string;
+  getSecureSiteDashboardURL(): string;
+  getSecureSiteIconURL(): string;
+  getSecureSiteHeaders(): Record<string, string>;
+  getLoginEmailUsed(): Promise<boolean>;
+  getEmail(): string | undefined;
+  rejectRpcRequest(): void;
+  connectEmail(payload: { email: string }): Promise<{
+    action: 'VERIFY_DEVICE' | 'VERIFY_OTP';
+  }>;
+  connectDevice(): Promise<unknown>;
+  connectOtp(payload: { otp: string }): Promise<unknown>;
+  isConnected(): Promise<{
+    isConnected: boolean;
+  }>;
+  getChainId(): Promise<{
+    chainId: number;
+  }>;
+  updateEmail(payload: { email: string }): Promise<{
+    action: 'VERIFY_PRIMARY_OTP' | 'VERIFY_SECONDARY_OTP';
+  }>;
+  updateEmailPrimaryOtp(payload: { otp: string }): Promise<unknown>;
+  updateEmailSecondaryOtp(payload: { otp: string }): Promise<{
+    newEmail: string;
+  }>;
+  syncTheme(payload: {
+    themeMode: ThemeMode | undefined;
+    themeVariables: Record<string, string | number> | undefined;
+  }): Promise<unknown>;
+  syncDappData(payload: {
+    projectId: string;
+    sdkVersion: SdkVersion;
+    metadata?: Metadata;
+  }): Promise<unknown>;
+  connect(payload?: { chainId: number | undefined }): Promise<{
+    chainId: number;
+    email: string;
+    address: string;
+  }>;
+  switchNetwork(chainId: number): Promise<{
+    chainId: number;
+  }>;
+  disconnect(): Promise<unknown>;
+  request(req: any): Promise<any>;
+  AuthView: () => JSX.Element | null;
+}