@reown/appkit-common-react-native 2.0.0-alpha.1 → 2.0.0-alpha.2

package/src/utils/TypeUtil.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+import type { BlockchainAdapter } from '../adapters/BlockchainAdapter';
 
 export type CaipAddress = `${string}:${string}:${string}`;
 
@@ -6,6 +7,8 @@ export type CaipNetworkId = `${string}:${string}`;
 
 export type ChainNamespace = 'eip155' | 'solana' | 'polkadot' | 'bip122';
 
+export type AdapterType = 'solana' | 'wagmi' | 'ethers' | 'universal' | 'bip122';
+
 export type Network = {
   // Core viem/chain properties
   id: number | string;
@@ -34,6 +37,15 @@ export type AppKitNetwork = Network & {
   deprecatedCaipNetworkId?: CaipNetworkId; // for Solana deprecated id
 };
 
+export interface AppKitOpenOptions {
+  view: 'Account' | 'Connect' | 'Networks' | 'Swap' | 'OnRamp';
+}
+
+export type AppKitConnectOptions = Pick<
+  ConnectOptions,
+  'namespaces' | 'defaultChain' | 'universalLink'
+>;
+
 export interface CaipNetwork {
   id: CaipNetworkId;
   name?: string;
@@ -42,21 +54,20 @@ export interface CaipNetwork {
 }
 
 export interface Balance {
-  name: string;
+  name?: string;
+  amount: string;
   symbol: string;
-  chainId: string;
-  address?: CaipAddress;
-  value?: number;
-  price: number;
-  quantity: BalanceQuantity;
-  iconUrl: string;
+  quantity?: {
+    decimals: string;
+    numeric: string;
+  };
+  chainId?: string;
+  address?: CaipAddress; // contract address
+  value?: number; //total value of the amount in currency
+  price?: number; //price of the token in currency
+  iconUrl?: string;
 }
 
-type BalanceQuantity = {
-  decimals: string;
-  numeric: string;
-};
-
 export type TransactionStatus = 'confirmed' | 'failed' | 'pending';
 export type TransactionDirection = 'in' | 'out' | 'self';
 export type TransactionImage = {
@@ -129,7 +140,15 @@ export interface TransactionQuantity {
   numeric: string;
 }
 
-export type SocialProvider = 'apple' | 'x' | 'discord' | 'farcaster';
+export type SocialProvider =
+  | 'google'
+  | 'facebook'
+  | 'github'
+  | 'apple'
+  | 'x'
+  | 'discord'
+  | 'email'
+  | 'farcaster';
 
 export type ThemeMode = 'dark' | 'light';
 
@@ -144,8 +163,6 @@ export interface Token {
 
 export type Tokens = Record<CaipNetworkId, Token>;
 
-export type ConnectorType = 'WALLET_CONNECT' | 'COINBASE' | 'AUTH' | 'EXTERNAL';
-
 export type Metadata = {
   name: string;
   description: string;
@@ -158,6 +175,28 @@ export type Metadata = {
   };
 };
 
+export interface Identity {
+  name: string;
+  avatar?: string;
+}
+
+export interface Connection {
+  accounts: CaipAddress[];
+  balances: Map<CaipAddress, Balance[]>;
+  adapter: BlockchainAdapter;
+  caipNetwork: CaipNetworkId;
+  wallet?: WalletInfo;
+  properties?: ConnectionProperties;
+  type?: AccountType;
+  identities?: Map<CaipAddress, Identity>;
+}
+
+export type BlockchainAdapterConfig = {
+  projectId: string;
+  supportedNamespace: ChainNamespace;
+  adapterType: AdapterType;
+};
+
 //********** Adapter Event Payloads **********//
 export type AccountsChangedEvent = {
   accounts: string[];
@@ -171,11 +210,7 @@ export type DisconnectEvent = {};
 
 export type BalanceChangedEvent = {
   address: CaipAddress;
-  balance: {
-    amount: string;
-    symbol: string;
-    contractAddress?: ContractAddress;
-  };
+  balance: Balance;
 };
 
 //********** Adapter Event Map **********//
@@ -187,18 +222,12 @@ export interface AdapterEvents {
 }
 
 export interface GetBalanceParams {
+  network: AppKitNetwork;
   address?: CaipAddress;
-  network?: AppKitNetwork;
   tokens?: Tokens;
 }
 
-type ContractAddress = CaipAddress;
-
-export interface GetBalanceResponse {
-  amount: string;
-  symbol: string;
-  contractAddress?: ContractAddress;
-}
+export type GetBalanceResponse = Balance;
 
 //********** Connector Types **********//
 interface BaseNamespace {
@@ -222,6 +251,7 @@ export type ConnectOptions = {
   namespaces?: ProposalNamespaces;
   defaultChain?: CaipNetworkId;
   universalLink?: string;
+  siweConfig?: AppKitSIWEClient;
 };
 
 export type ConnectorInitOptions = {
@@ -230,14 +260,15 @@ export type ConnectorInitOptions = {
 };
 
 export abstract class WalletConnector extends EventEmitter {
-  public type: New_ConnectorType;
+  public type: ConnectorType;
   protected provider?: Provider;
   protected namespaces?: Namespaces;
   protected wallet?: WalletInfo;
   protected storage?: Storage;
   protected metadata?: Metadata;
+  protected properties?: ConnectionProperties;
 
-  constructor({ type }: { type: New_ConnectorType }) {
+  constructor({ type }: { type: ConnectorType }) {
     super();
     this.type = type;
   }
@@ -251,15 +282,25 @@ export abstract class WalletConnector extends EventEmitter {
     this.provider = provider;
   }
 
+  public async disconnect() {
+    await this.provider?.disconnect();
+    this.namespaces = undefined;
+    this.wallet = undefined;
+    this.properties = undefined;
+  }
+
   abstract connect(opts: ConnectOptions): Promise<Namespaces | undefined>;
-  abstract disconnect(): Promise<void>;
   abstract getProvider(): Provider;
   abstract getNamespaces(): Namespaces;
   abstract getChainId(namespace: ChainNamespace): CaipNetworkId | undefined;
   abstract getWalletInfo(): WalletInfo | undefined;
+  abstract getProperties(): ConnectionProperties | undefined;
   abstract switchNetwork(network: AppKitNetwork): Promise<void>;
+  abstract restoreSession(): Promise<boolean>;
 }
 
+export type ConnectorType = 'walletconnect' | 'coinbase' | 'auth' | 'phantom';
+
 //********** Provider Types **********//
 
 export interface Provider {
@@ -279,9 +320,6 @@ export interface RequestArguments {
   params?: unknown[] | Record<string, unknown> | object | undefined;
 }
 
-//TODO: rename this and remove the old one ConnectorType
-export type New_ConnectorType = 'walletconnect' | 'coinbase' | 'auth' | 'phantom';
-
 //********** Others **********//
 
 export interface ConnectionResponse {
@@ -304,6 +342,26 @@ export interface WalletInfo {
   [key: string]: unknown;
 }
 
+export interface ConnectionProperties {
+  email?: string;
+  username?: string;
+  smartAccounts?: CaipAddress[];
+  provider?: SocialProvider;
+  sessionTopic?: string;
+}
+
+export interface LinkingRecord {
+  redirect: string;
+  href: string;
+}
+
+export interface WalletDeepLink {
+  href: string;
+  name: string;
+}
+
+export type AccountType = 'eoa' | 'smartAccount';
+
 export interface Storage {
   /**
    * Returns all keys in storage.
@@ -334,3 +392,102 @@ export interface Storage {
    */
   removeItem(key: string): Promise<void>;
 }
+
+//********** SIWE Types **********//
+export interface SIWESession {
+  address: string;
+  chainId: number;
+}
+
+interface CacaoHeader {
+  t: 'caip122';
+}
+
+export interface SIWECreateMessageArgs {
+  domain: string;
+  nonce: string;
+  uri: string;
+  address: CaipAddress;
+  version: '1';
+  type?: CacaoHeader['t'];
+  nbf?: string;
+  exp?: string;
+  statement?: string;
+  requestId?: string;
+  resources?: string[];
+  expiry?: number;
+  iat?: string;
+}
+export type SIWEMessageArgs = {
+  chains: CaipNetworkId[];
+  methods?: string[];
+} & Omit<SIWECreateMessageArgs, 'address' | 'nonce' | 'version'>;
+// Signed Cacao (CAIP-74)
+interface CacaoPayload {
+  domain: string;
+  aud: string;
+  nonce: string;
+  iss: string;
+  version?: string;
+  iat?: string;
+  nbf?: string;
+  exp?: string;
+  statement?: string;
+  requestId?: string;
+  resources?: string[];
+  type?: string;
+}
+
+interface Cacao {
+  h: CacaoHeader;
+  p: CacaoPayload;
+  s: {
+    t: 'eip191' | 'eip1271';
+    s: string;
+    m?: string;
+  };
+}
+
+export interface SIWEVerifyMessageArgs {
+  message: string;
+  signature: string;
+  cacao?: Cacao;
+}
+
+export interface SIWEClientMethods {
+  getNonce: (address?: string) => Promise<string>;
+  createMessage: (args: SIWECreateMessageArgs) => string;
+  verifyMessage: (args: SIWEVerifyMessageArgs) => Promise<boolean>;
+  getSession: () => Promise<SIWESession | null>;
+  signOut: () => Promise<boolean>;
+  getMessageParams?: () => Promise<SIWEMessageArgs>;
+  onSignIn?: (session?: SIWESession) => void;
+  onSignOut?: () => void;
+}
+
+export interface SIWEConfig extends SIWEClientMethods {
+  // Defaults to true
+  enabled?: boolean;
+  // In milliseconds, defaults to 5 minutes
+  nonceRefetchIntervalMs?: number;
+  // In milliseconds, defaults to 5 minutes
+  sessionRefetchIntervalMs?: number;
+  // Defaults to true
+  signOutOnDisconnect?: boolean;
+  // Defaults to true
+  signOutOnAccountChange?: boolean;
+  // Defaults to true
+  signOutOnNetworkChange?: boolean;
+}
+
+export interface AppKitSIWEClient extends SIWEClientMethods {
+  signIn: () => Promise<SIWESession | undefined>;
+  options: {
+    enabled: boolean;
+    nonceRefetchIntervalMs: number;
+    sessionRefetchIntervalMs: number;
+    signOutOnDisconnect: boolean;
+    signOutOnAccountChange: boolean;
+    signOutOnNetworkChange: boolean;
+  };
+}