@reown/appkit-core-react-native 0.0.0-feat-smart-account-20241017180406 → 0.0.0-feat-swaps-20241129153709

package/src/utils/TypeUtil.ts

@@ -64,6 +64,11 @@ export type SdkVersion =
   | `react-native-ethers-${string}`;
 
 export type Features = {
+  /**
+   * @description Enable or disable the swaps feature. Enabled by default.
+   * @type {boolean}
+   */
+  swaps?: boolean;
   /**
    * @description Enable or disable the email feature. Enabled by default.
    * @type {boolean}
@@ -169,6 +174,56 @@ export interface BlockchainApiTransactionsResponse {
   next: string | null;
 }
 
+export interface BlockchainApiSwapAllowanceResponse {
+  allowance: string;
+}
+
+export interface BlockchainApiGenerateSwapCalldataRequest {
+  projectId: string;
+  userAddress: string;
+  from: string;
+  to: string;
+  amount: string;
+  eip155?: {
+    slippage: string;
+    permit?: string;
+  };
+}
+
+export interface BlockchainApiGenerateSwapCalldataResponse {
+  tx: {
+    from: CaipAddress;
+    to: CaipAddress;
+    data: `0x${string}`;
+    amount: string;
+    eip155: {
+      gas: string;
+      gasPrice: string;
+    };
+  };
+}
+
+export interface BlockchainApiGenerateApproveCalldataRequest {
+  projectId: string;
+  userAddress: string;
+  from: string;
+  to: string;
+  amount?: number;
+}
+
+export interface BlockchainApiGenerateApproveCalldataResponse {
+  tx: {
+    from: CaipAddress;
+    to: CaipAddress;
+    data: `0x${string}`;
+    value: string;
+    eip155: {
+      gas: number;
+      gasPrice: string;
+    };
+  };
+}
+
 export interface BlockchainApiTokenPriceRequest {
   projectId: string;
   currency?: 'usd' | 'eur' | 'gbp' | 'aud' | 'cad' | 'inr' | 'jpy' | 'btc' | 'eth';
@@ -184,6 +239,12 @@ export interface BlockchainApiTokenPriceResponse {
   }[];
 }
 
+export interface BlockchainApiSwapAllowanceRequest {
+  projectId: string;
+  tokenAddress: string;
+  userAddress: string;
+}
+
 export interface BlockchainApiGasPriceRequest {
   projectId: string;
   chainId: string;
@@ -219,6 +280,35 @@ export interface BlockchainApiLookupEnsName {
   }[];
 }
 
+export interface BlockchainApiSwapQuoteRequest {
+  projectId: string;
+  chainId?: string;
+  amount: string;
+  userAddress: string;
+  from: string;
+  to: string;
+  gasPrice: string;
+}
+
+export interface BlockchainApiSwapQuoteResponse {
+  quotes: {
+    id: string | null;
+    fromAmount: string;
+    fromAccount: string;
+    toAmount: string;
+    toAccount: string;
+  }[];
+}
+
+export interface BlockchainApiSwapTokensRequest {
+  projectId: string;
+  chainId?: string;
+}
+
+export interface BlockchainApiSwapTokensResponse {
+  tokens: SwapToken[];
+}
+
 // -- OptionsController Types ---------------------------------------------------
 export interface Token {
   address: string;
@@ -441,6 +531,50 @@ export type Event =
         network: string;
       };
     }
+  | {
+      type: 'track';
+      event: 'OPEN_SWAP';
+      properties: {
+        isSmartAccount: boolean;
+        network: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'INITIATE_SWAP';
+      properties: {
+        isSmartAccount: boolean;
+        network: string;
+        swapFromToken: string;
+        swapToToken: string;
+        swapFromAmount: string;
+        swapToAmount: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SWAP_SUCCESS';
+      properties: {
+        isSmartAccount: boolean;
+        network: string;
+        swapFromToken: string;
+        swapToToken: string;
+        swapFromAmount: string;
+        swapToAmount: string;
+      };
+    }
+  | {
+      type: 'track';
+      event: 'SWAP_ERROR';
+      properties: {
+        isSmartAccount: boolean;
+        network: string;
+        swapFromToken: string;
+        swapToToken: string;
+        swapFromAmount: string;
+        swapToAmount: string;
+      };
+    }
   | {
       type: 'track';
       event: 'SEND_INITIATED';
@@ -502,6 +636,12 @@ export type Event =
     };
 
 // -- Send Controller Types -------------------------------------
+export type EstimateGasTransactionArgs = {
+  chainNamespace?: undefined | 'eip155';
+  address: `0x${string}`;
+  to: `0x${string}`;
+  data: `0x${string}`;
+};
 
 export interface SendTransactionArgs {
   to: `0x${string}`;
@@ -510,6 +650,7 @@ export interface SendTransactionArgs {
   gas?: bigint;
   gasPrice: bigint;
   address: `0x${string}`;
+  chainNamespace?: 'eip155';
 }
 
 export interface WriteContractArgs {
@@ -521,6 +662,27 @@ export interface WriteContractArgs {
   abi: any;
 }
 
+// -- Swap Controller Types -------------------------------------
+export type SwapToken = {
+  name: string;
+  symbol: string;
+  address: CaipAddress;
+  decimals: number;
+  logoUri: string;
+  eip2612?: boolean;
+};
+
+export type SwapTokenWithBalance = SwapToken & {
+  quantity: {
+    decimals: string;
+    numeric: string;
+  };
+  price: number;
+  value: number;
+};
+
+export type SwapInputTarget = 'sourceToken' | 'toToken';
+
 // -- Email Types ------------------------------------------------
 /**
  * Matches type defined for packages/wallet/src/AppKitFrameProvider.ts
@@ -549,13 +711,11 @@ export interface AppKitFrameProvider {
     chainId: string | number;
     email: string;
     address: string;
-    accounts?:
-      | {
-          type: AppKitFrameAccountType;
-          address: string;
-        }[]
-      | undefined;
-    userName?: string | undefined;
+    accounts?: {
+      type: AppKitFrameAccountType;
+      address: string;
+    }[];
+    userName?: string;
   }>;
   getSocialRedirectUri(payload: { provider: SocialProvider }): Promise<{
     uri: string;
@@ -588,7 +748,7 @@ export interface AppKitFrameProvider {
   }): Promise<unknown>;
   connect(payload?: { chainId: number | undefined }): Promise<{
     chainId: number;
-    email?: string | null | undefined;
+    email?: string | null;
     address: string;
     smartAccountDeployed: boolean;
     preferredAccountType: AppKitFrameAccountType;
@@ -600,13 +760,14 @@ export interface AppKitFrameProvider {
     type: AppKitFrameAccountType;
     address: string;
   }>;
+  setOnTimeout(callback: () => void): void;
   getSmartAccountEnabledNetworks(): Promise<{
     smartAccountEnabledNetworks: number[];
   }>;
   disconnect(): Promise<unknown>;
   request(req: any): Promise<any>;
-  AuthView: () => JSX.Element | null;
-  Webview: () => JSX.Element | null;
+  AuthView: () => React.JSX.Element | null;
+  Webview: () => React.JSX.Element | null;
   onSetPreferredAccount: (
     callback: (values: { type: AppKitFrameAccountType; address: string }) => void
   ) => void;