@reown/appkit-common-react-native 0.0.0-feat-onramp-20250626195202 → 0.0.0-feat-multi-social-20250630195637

package/src/utils/TypeUtil.ts

@@ -1,8 +1,56 @@
+import { EventEmitter } from 'events';
+
+export type CaipAddress = `${string}:${string}:${string}`;
+
+export type CaipNetworkId = `${string}:${string}`;
+
+export type ChainNamespace = 'eip155' | 'solana' | 'polkadot' | 'bip122';
+
+export type Network = {
+  // Core viem/chain properties
+  id: number | string;
+  name: string;
+  nativeCurrency: { name: string; symbol: string; decimals: number };
+  rpcUrls: {
+    default: { http: readonly string[] };
+    [key: string]: { http: readonly string[] } | undefined;
+  };
+  blockExplorers?: {
+    default: { name: string; url: string };
+    [key: string]: { name: string; url: string } | undefined;
+  };
+
+  // AppKit specific / CAIP properties (Optional in type, but needed in practice)
+  chainNamespace?: ChainNamespace; // e.g., 'eip155'
+  caipNetworkId?: CaipNetworkId; // e.g., 'eip155:1'
+  testnet?: boolean;
+  deprecatedCaipNetworkId?: CaipNetworkId; // for Solana deprecated id
+};
+
+export type AppKitNetwork = Network & {
+  chainNamespace: ChainNamespace; // e.g., 'eip155'
+  caipNetworkId: CaipNetworkId; // e.g., 'eip155:1'
+  testnet?: boolean;
+  deprecatedCaipNetworkId?: CaipNetworkId; // for Solana deprecated id
+};
+
+export type AppKitConnectOptions = Pick<
+  ConnectOptions,
+  'namespaces' | 'defaultChain' | 'universalLink'
+>;
+
+export interface CaipNetwork {
+  id: CaipNetworkId;
+  name?: string;
+  imageId?: string;
+  imageUrl?: string;
+}
+
 export interface Balance {
   name: string;
   symbol: string;
   chainId: string;
-  address?: string;
+  address?: CaipAddress;
   value?: number;
   price: number;
   quantity: BalanceQuantity;
@@ -86,7 +134,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';
 
@@ -94,4 +150,301 @@ export interface ThemeVariables {
   accent?: string;
 }
 
+export interface Token {
+  address: string;
+  image?: string;
+}
+
+export type Tokens = Record<CaipNetworkId, Token>;
+
 export type ConnectorType = 'WALLET_CONNECT' | 'COINBASE' | 'AUTH' | 'EXTERNAL';
+
+export type Metadata = {
+  name: string;
+  description: string;
+  url: string;
+  icons: string[];
+  redirect?: {
+    native?: string;
+    universal?: string;
+    linkMode?: boolean;
+  };
+};
+
+//********** Adapter Event Payloads **********//
+export type AccountsChangedEvent = {
+  accounts: string[];
+};
+
+export type ChainChangedEvent = {
+  chainId: string;
+};
+
+export type DisconnectEvent = {};
+
+export type BalanceChangedEvent = {
+  address: CaipAddress;
+  balance: {
+    amount: string;
+    symbol: string;
+    contractAddress?: ContractAddress;
+  };
+};
+
+//********** Adapter Event Map **********//
+export interface AdapterEvents {
+  accountsChanged: (event: AccountsChangedEvent) => void;
+  chainChanged: (event: ChainChangedEvent) => void;
+  disconnect: (event: DisconnectEvent) => void;
+  balanceChanged: (event: BalanceChangedEvent) => void;
+}
+
+export interface GetBalanceParams {
+  address?: CaipAddress;
+  network?: AppKitNetwork;
+  tokens?: Tokens;
+}
+
+type ContractAddress = CaipAddress;
+
+export interface GetBalanceResponse {
+  amount: string;
+  symbol: string;
+  contractAddress?: ContractAddress;
+}
+
+//********** Connector Types **********//
+interface BaseNamespace {
+  chains?: CaipNetworkId[];
+  accounts: CaipAddress[];
+  methods: string[];
+  events: string[];
+}
+
+type Namespace = BaseNamespace;
+
+export type Namespaces = Record<string, Namespace>;
+
+export type ProposalNamespaces = Record<
+  string,
+  Omit<Namespace, 'accounts'> &
+    Required<Pick<Namespace, 'chains'>> & { rpcMap: Record<string, string> }
+>;
+
+export type ConnectOptions = {
+  namespaces?: ProposalNamespaces;
+  defaultChain?: CaipNetworkId;
+  universalLink?: string;
+  siweConfig?: AppKitSIWEClient;
+};
+
+export type ConnectorInitOptions = {
+  storage: Storage;
+  metadata: Metadata;
+};
+
+export abstract class WalletConnector extends EventEmitter {
+  public type: New_ConnectorType;
+  protected provider?: Provider;
+  protected namespaces?: Namespaces;
+  protected wallet?: WalletInfo;
+  protected storage?: Storage;
+  protected metadata?: Metadata;
+
+  constructor({ type }: { type: New_ConnectorType }) {
+    super();
+    this.type = type;
+  }
+
+  public async init(ops: ConnectorInitOptions) {
+    this.storage = ops.storage;
+    this.metadata = ops.metadata;
+  }
+
+  public setProvider(provider: Provider) {
+    this.provider = provider;
+  }
+
+  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 switchNetwork(network: AppKitNetwork): Promise<void>;
+}
+
+//********** Provider Types **********//
+
+export interface Provider {
+  connect<T>(params?: any): Promise<T>;
+  disconnect(): Promise<void>;
+  request<T = unknown>(
+    args: RequestArguments,
+    chain?: string | undefined,
+    expiry?: number | undefined
+  ): Promise<T>;
+  on(event: string, listener: (args?: any) => void): any;
+  off(event: string, listener: (args?: any) => void): any;
+}
+
+export interface RequestArguments {
+  method: string;
+  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 {
+  accounts: string[];
+  chainId: string;
+  [key: string]: any;
+}
+
+export interface WalletInfo {
+  name?: string;
+  icon?: string;
+  description?: string;
+  url?: string;
+  icons?: string[];
+  redirect?: {
+    native?: string;
+    universal?: string;
+    linkMode?: boolean;
+  };
+  [key: string]: unknown;
+}
+
+export interface Storage {
+  /**
+   * Returns all keys in storage.
+   */
+  getKeys(): Promise<string[]>;
+
+  /**
+   * Returns all key-value entries in storage.
+   */
+  getEntries<T = any>(): Promise<[string, T][]>;
+
+  /**
+   * Get an item from storage for a given key.
+   * @param key The key to retrieve.
+   */
+  getItem<T = any>(key: string): Promise<T | undefined>;
+
+  /**
+   * Set an item in storage for a given key.
+   * @param key The key to set.
+   * @param value The value to set.
+   */
+  setItem<T = any>(key: string, value: T): Promise<void>;
+
+  /**
+   * Remove an item from storage for a given key.
+   * @param key The key to remove.
+   */
+  removeItem(key: string): Promise<void>;
+}
+
+//********** SIWE Types **********//
+export interface SIWESession {
+  address: string;
+  chainId: number;
+}
+
+interface CacaoHeader {
+  t: 'caip122';
+}
+
+export interface SIWECreateMessageArgs {
+  chainId: number;
+  domain: string;
+  nonce: string;
+  uri: string;
+  address: string;
+  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' | 'chainId' | '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;
+  };
+}