@reown/appkit-core-react-native 1.2.6 → 1.3.0

package/src/utils/TypeUtil.ts

@@ -6,6 +6,7 @@ import type {
   Transaction,
   ConnectorType
 } from '@reown/appkit-common-react-native';
+import { OnRampErrorType } from './ConstantsUtil';
 
 export interface BaseError {
   message?: string;
@@ -83,6 +84,11 @@ export type Features = {
    * @type {boolean}
    */
   swaps?: boolean;
+  /**
+   * @description Enable or disable the onramp feature. Enabled by default.
+   * @type {boolean}
+   */
+  onramp?: boolean;
   /**
    * @description Enable or disable the email feature. Enabled by default.
    * @type {boolean}
@@ -311,10 +317,44 @@ export interface BlockchainApiSwapTokensRequest {
   chainId?: string;
 }
 
+export interface BlockchainApiOnRampQuotesRequest {
+  countryCode: string;
+  paymentMethodType?: string;
+  destinationCurrencyCode: string;
+  sourceAmount: number;
+  sourceCurrencyCode: string;
+  walletAddress: string;
+  excludeProviders?: string[];
+}
+
 export interface BlockchainApiSwapTokensResponse {
   tokens: SwapToken[];
 }
 
+export interface BlockchainApiOnRampWidgetRequest {
+  countryCode: string;
+  destinationCurrencyCode: string;
+  paymentMethodType: string;
+  serviceProvider: string;
+  sourceAmount: number;
+  sourceCurrencyCode: string;
+  walletAddress: string;
+  redirectUrl?: string;
+}
+
+export type BlockchainApiOnRampWidgetResponse = {
+  widgetUrl: string;
+};
+
+export class BlockchainOnRampError extends Error {
+  code: string;
+  constructor(code: string, message: string) {
+    super(message);
+    this.code = code;
+    this.message = message;
+  }
+}
+
 // -- OptionsController Types ---------------------------------------------------
 export interface Token {
   address: string;
@@ -699,6 +739,63 @@ export type Event =
         accountType: AppKitFrameAccountType;
         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;
+      };
     };
 
 // -- Send Controller Types -------------------------------------
@@ -749,6 +846,106 @@ export type SwapTokenWithBalance = SwapToken & {
 
 export type SwapInputTarget = 'sourceToken' | 'toToken';
 
+// -- OnRamp Controller Types ------------------------------------------------
+export type OnRampErrorTypeValues = (typeof OnRampErrorType)[keyof typeof OnRampErrorType];
+
+export interface OnRampError {
+  type: OnRampErrorTypeValues;
+  message: string;
+}
+
+export type OnRampPaymentMethod = {
+  logos: {
+    dark: string;
+    light: string;
+  };
+  name: string;
+  paymentMethod: string;
+  paymentType: string;
+};
+
+export type OnRampCountry = {
+  countryCode: string;
+  flagImageUrl: string;
+  name: string;
+};
+
+export type OnRampCountryDefaults = {
+  countryCode: string;
+  defaultCurrencyCode: string;
+  defaultPaymentMethods: string[];
+};
+
+export type OnRampFiatCurrency = {
+  currencyCode: string;
+  name: string;
+  symbolImageUrl: string;
+};
+
+export type OnRampCryptoCurrency = {
+  currencyCode: string;
+  name: string;
+  chainCode: string;
+  chainName: string;
+  chainId: string;
+  contractAddress: string | null;
+  symbolImageUrl: string;
+};
+
+export type OnRampQuote = {
+  countryCode: string;
+  customerScore: number;
+  destinationAmount: number;
+  destinationAmountWithoutFees: number;
+  destinationCurrencyCode: string;
+  exchangeRate: number;
+  fiatAmountWithoutFees: number;
+  lowKyc: boolean;
+  networkFee: number;
+  paymentMethodType: string;
+  serviceProvider: string;
+  sourceAmount: number;
+  sourceAmountWithoutFees: number;
+  sourceCurrencyCode: string;
+  totalFee: number;
+  transactionFee: number;
+  transactionType: string;
+};
+
+export type OnRampServiceProvider = {
+  categories: string[];
+  categoryStatuses: {
+    additionalProp: string;
+  };
+  logos: {
+    dark: string;
+    darkShort: string;
+    light: string;
+    lightShort: string;
+  };
+  name: string;
+  serviceProvider: string;
+  status: string;
+  websiteUrl: string;
+};
+
+export type OnRampFiatLimit = {
+  currencyCode: string;
+  defaultAmount: number | null;
+  minimumAmount: number;
+  maximumAmount: number;
+};
+
+export type OnRampTransactionResult = {
+  purchaseCurrency: string | null;
+  purchaseAmount: string | null;
+  purchaseImageUrl: string | null;
+  paymentCurrency: string | null;
+  paymentAmount: string | null;
+  status: string | null;
+  network: string | null;
+};
+
 // -- Email Types ------------------------------------------------
 /**
  * Matches type defined for packages/wallet/src/AppKitFrameProvider.ts
@@ -811,7 +1008,10 @@ export interface AppKitFrameProvider {
     sdkType: SdkType;
     metadata?: Metadata;
   }): Promise<unknown>;
-  connect(payload?: { chainId: number | undefined }): Promise<{
+  connect(payload?: {
+    chainId: number | undefined;
+    preferredAccountType?: AppKitFrameAccountType;
+  }): Promise<{
     chainId: number;
     email?: string | null;
     address: string;