@reown/appkit-core-react-native 0.0.0-feat-coinbase-20250722202925 → 0.0.0-feat-onramp-20250722205908

package/src/utils/TypeUtil.ts

@@ -1,12 +1,28 @@
-import type { AccountType, CaipAddress, CaipNetworkId } from '@reown/appkit-common-react-native';
-import type { SocialProvider, Transaction } from '@reown/appkit-common-react-native';
-
+import { type EventEmitter } from 'events';
+import type {
+  Balance,
+  SocialProvider,
+  ThemeMode,
+  Transaction,
+  ConnectorType
+} from '@reown/appkit-common-react-native';
 import { OnRampErrorType } from './ConstantsUtil';
 
 export interface BaseError {
   message?: string;
 }
 
+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;
@@ -32,6 +48,18 @@ export type ProjectId = string;
 
 export type Platform = 'mobile' | 'web' | 'qrcode' | 'email' | 'unsupported';
 
+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,
   {
@@ -43,9 +71,12 @@ export type CaipNamespaces = Record<
 
 export type SdkType = 'appkit';
 
-export type SdkVersion = `react-native-${string}-${string}`;
+export type SdkVersion =
+  | `react-native-wagmi-${string}`
+  | `react-native-ethers5-${string}`
+  | `react-native-ethers-${string}`;
 
-type EnabledSocials = SocialProvider;
+type EnabledSocials = Exclude<SocialProvider, 'farcaster'>;
 
 export type Features = {
   /**
@@ -59,10 +90,15 @@ export type Features = {
    */
   onramp?: boolean;
   /**
-   * @description Show or hide the regular wallet options when socials are enabled. Enabled by default.
+   * @description Enable or disable the email feature. Enabled by default.
+   * @type {boolean}
+   */
+  email?: boolean;
+  /**
+   * @description Show or hide the regular wallet options when email is enabled. Enabled by default.
    * @type {boolean}
    */
-  showWallets?: boolean;
+  emailShowWallets?: boolean;
   /**
    * @description Enable or disable the socials feature. Enabled by default.
    * @type {EnabledSocials[]}
@@ -124,7 +160,7 @@ export type RequestCache =
 
 // -- BlockchainApiController Types ---------------------------------------------
 export interface BlockchainApiIdentityRequest {
-  address: `0x${string}`;
+  address: string;
 }
 
 export interface BlockchainApiIdentityResponse {
@@ -132,22 +168,8 @@ export interface BlockchainApiIdentityResponse {
   name: string;
 }
 
-export interface BlockchainApiBalance {
-  name: string;
-  symbol: string;
-  chainId: string;
-  address?: CaipAddress;
-  value?: number;
-  price: number;
-  quantity: {
-    decimals: string;
-    numeric: string;
-  };
-  iconUrl: string;
-}
-
 export interface BlockchainApiBalanceResponse {
-  balances: BlockchainApiBalance[];
+  balances: Balance[];
 }
 
 export interface BlockchainApiTransactionsRequest {
@@ -157,7 +179,6 @@ export interface BlockchainApiTransactionsRequest {
   onramp?: 'coinbase';
   signal?: AbortSignal;
   cache?: RequestCache;
-  chainId: CaipNetworkId;
 }
 
 export interface BlockchainApiTransactionsResponse {
@@ -171,9 +192,9 @@ export interface BlockchainApiSwapAllowanceResponse {
 
 export interface BlockchainApiGenerateSwapCalldataRequest {
   projectId: string;
-  userAddress: CaipAddress;
-  from: CaipAddress;
-  to: CaipAddress;
+  userAddress: string;
+  from: string;
+  to: string;
   amount: string;
   eip155?: {
     slippage: string;
@@ -196,9 +217,9 @@ export interface BlockchainApiGenerateSwapCalldataResponse {
 
 export interface BlockchainApiGenerateApproveCalldataRequest {
   projectId: string;
-  userAddress: CaipAddress;
-  from: CaipAddress;
-  to: CaipAddress;
+  userAddress: string;
+  from: string;
+  to: string;
   amount?: number;
 }
 
@@ -218,7 +239,7 @@ export interface BlockchainApiGenerateApproveCalldataResponse {
 export interface BlockchainApiTokenPriceRequest {
   projectId: string;
   currency?: 'usd' | 'eur' | 'gbp' | 'aud' | 'cad' | 'inr' | 'jpy' | 'btc' | 'eth';
-  addresses: CaipAddress[];
+  addresses: string[];
 }
 
 export interface BlockchainApiTokenPriceResponse {
@@ -232,13 +253,13 @@ export interface BlockchainApiTokenPriceResponse {
 
 export interface BlockchainApiSwapAllowanceRequest {
   projectId: string;
-  tokenAddress: CaipAddress;
-  userAddress: CaipAddress;
+  tokenAddress: string;
+  userAddress: string;
 }
 
 export interface BlockchainApiGasPriceRequest {
   projectId: string;
-  chainId: CaipNetworkId;
+  chainId: string;
 }
 
 export interface BlockchainApiGasPriceResponse {
@@ -273,11 +294,11 @@ export interface BlockchainApiLookupEnsName {
 
 export interface BlockchainApiSwapQuoteRequest {
   projectId: string;
-  chainId?: CaipNetworkId;
+  chainId?: string;
   amount: string;
-  userAddress: CaipAddress;
-  from: CaipAddress;
-  to: CaipAddress;
+  userAddress: string;
+  from: string;
+  to: string;
   gasPrice: string;
 }
 
@@ -293,16 +314,17 @@ export interface BlockchainApiSwapQuoteResponse {
 
 export interface BlockchainApiSwapTokensRequest {
   projectId: string;
-  chainId: CaipNetworkId;
+  chainId?: string;
 }
 
 export interface BlockchainApiOnRampQuotesRequest {
   countryCode: string;
-  paymentMethodType: string;
+  paymentMethodType?: string;
   destinationCurrencyCode: string;
   sourceAmount: number;
   sourceCurrencyCode: string;
   walletAddress: string;
+  excludeProviders?: string[];
 }
 
 export interface BlockchainApiSwapTokensResponse {
@@ -325,13 +347,31 @@ export type BlockchainApiOnRampWidgetResponse = {
 };
 
 // -- 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'
-  | 'image_id'
   | 'mobile_link'
   | 'desktop_link'
   | 'webapp_link'
@@ -357,6 +397,9 @@ export type EventName =
   | 'CLICK_NETWORK_HELP'
   | 'CLICK_GET_WALLET'
   | 'EMAIL_LOGIN_SELECTED'
+  | 'EMAIL_SUBMITTED'
+  | 'DEVICE_REGISTERED_FOR_EMAIL'
+  | 'EMAIL_VERIFICATION_CODE_SENT'
   | 'EMAIL_VERIFICATION_CODE_PASS'
   | 'EMAIL_VERIFICATION_CODE_FAIL'
   | 'EMAIL_EDIT'
@@ -419,7 +462,7 @@ export type Event =
       type: 'track';
       event: 'SWITCH_NETWORK';
       properties: {
-        network: number | string;
+        network: string;
       };
     }
   | {
@@ -471,6 +514,18 @@ export type Event =
       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';
@@ -672,7 +727,7 @@ export type Event =
       type: 'track';
       event: 'SET_PREFERRED_ACCOUNT_TYPE';
       properties: {
-        accountType: AccountType;
+        accountType: AppKitFrameAccountType;
         network: string;
       };
     }
@@ -806,6 +861,12 @@ export type OnRampCountry = {
   name: string;
 };
 
+export type OnRampCountryDefaults = {
+  countryCode: string;
+  defaultCurrencyCode: string;
+  defaultPaymentMethods: string[];
+};
+
 export type OnRampFiatCurrency = {
   currencyCode: string;
   name: string;
@@ -875,3 +936,92 @@ export type OnRampTransactionResult = {
   status: string | null;
   network: string | null;
 };
+
+// -- Email Types ------------------------------------------------
+/**
+ * Matches type defined for packages/wallet/src/AppKitFrameProvider.ts
+ * It's duplicated in order to decouple scaffold from email package
+ */
+
+export type AppKitFrameAccountType = 'eoa' | 'smartAccount';
+
+export interface AppKitFrameProvider {
+  readonly id: string;
+  readonly name: string;
+  getEventEmitter(): EventEmitter;
+  getSecureSiteURL(): string;
+  getSecureSiteDashboardURL(): string;
+  getSecureSiteIconURL(): string;
+  getEmail(): string | undefined;
+  getUsername(): string | undefined;
+  getLastUsedChainId(): Promise<number | undefined>;
+  rejectRpcRequest(): void;
+  connectEmail(payload: { email: string }): Promise<{
+    action: 'VERIFY_DEVICE' | 'VERIFY_OTP';
+  }>;
+  connectDevice(): Promise<unknown>;
+  connectSocial(uri: string): Promise<{
+    chainId: string | number;
+    email: string;
+    address: string;
+    accounts?: {
+      type: AppKitFrameAccountType;
+      address: string;
+    }[];
+    userName?: string;
+  }>;
+  getSocialRedirectUri(payload: { provider: SocialProvider }): Promise<{
+    uri: string;
+  }>;
+  connectOtp(payload: { otp: string }): Promise<unknown>;
+  connectFarcaster: () => Promise<{ userName: string }>;
+  getFarcasterUri(): Promise<{ url: string }>;
+  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;
+    sdkType: SdkType;
+    metadata?: Metadata;
+  }): Promise<unknown>;
+  connect(payload?: { chainId: number | undefined }): Promise<{
+    chainId: number;
+    email?: string | null;
+    address: string;
+    smartAccountDeployed: boolean;
+    preferredAccountType: AppKitFrameAccountType;
+  }>;
+  switchNetwork(chainId: number): Promise<{
+    chainId: number;
+  }>;
+  setPreferredAccount(type: AppKitFrameAccountType): Promise<{
+    type: AppKitFrameAccountType;
+    address: string;
+  }>;
+  setOnTimeout(callback: () => void): void;
+  getSmartAccountEnabledNetworks(): Promise<{
+    smartAccountEnabledNetworks: number[];
+  }>;
+  disconnect(): Promise<unknown>;
+  request(req: any): Promise<any>;
+  AuthView: () => React.JSX.Element | null;
+  Webview: () => React.JSX.Element | null;
+  onSetPreferredAccount: (
+    callback: (values: { type: AppKitFrameAccountType; address: string }) => void
+  ) => void;
+}