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

package/src/types/blockchain/adapter.ts

@@ -0,0 +1,52 @@
+import type { ChainNamespace, CaipAddress, AdapterType } from '../common';
+import type { WalletConnector } from '../wallet';
+import type { BalanceChangedEvent } from './balance';
+
+export interface BlockchainAdapterConfig {
+  supportedNamespace: ChainNamespace;
+  adapterType: AdapterType;
+}
+
+export interface BlockchainAdapterInitParams {
+  connector: WalletConnector;
+}
+
+export interface AdapterEvents {
+  accountsChanged: (event: AccountsChangedEvent) => void;
+  chainChanged: (event: ChainChangedEvent) => void;
+  disconnect: (event: DisconnectEvent) => void;
+  balanceChanged: (event: BalanceChangedEvent) => void;
+}
+
+export type AccountsChangedEvent = {
+  accounts: CaipAddress[];
+};
+
+export type ChainChangedEvent = {
+  chainId: string;
+};
+
+export type DisconnectEvent = undefined;
+
+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;
+}
+
+export interface ConnectionResponse {
+  accounts: string[];
+  chainId: string;
+  [key: string]: any;
+}

package/src/types/blockchain/balance.ts

@@ -0,0 +1,31 @@
+import type { CaipAddress } from '../common';
+import type { Tokens } from '../wallet';
+import type { AppKitNetwork } from './network';
+
+export interface Balance {
+  name?: string;
+  amount: string;
+  symbol: 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;
+}
+
+export interface GetBalanceParams {
+  network: AppKitNetwork;
+  address?: CaipAddress;
+  tokens?: Tokens;
+}
+
+export type GetBalanceResponse = Balance;
+
+export type BalanceChangedEvent = {
+  address: CaipAddress;
+  balance: Balance;
+};

package/src/types/blockchain/index.ts

@@ -0,0 +1,5 @@
+// Blockchain types barrel export
+export * from './adapter';
+export * from './balance';
+export * from './network';
+export * from './transaction';

package/src/types/blockchain/network.ts

@@ -0,0 +1,39 @@
+import type { ChainNamespace, CaipNetworkId } from '../common';
+
+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
+  imageUrl?: string;
+};
+
+export type AppKitNetwork = Network & {
+  chainNamespace: ChainNamespace; // mandatory for AppKitNetwork
+  caipNetworkId: CaipNetworkId; // mandatory for AppKitNetwork
+};
+
+export interface CaipNetwork {
+  id: CaipNetworkId;
+  name?: string;
+  imageId?: string;
+  imageUrl?: string;
+}
+
+export interface AppKitOpenOptions {
+  view: 'Account' | 'Connect' | 'Networks' | 'Swap' | 'OnRamp';
+}

package/src/types/blockchain/transaction.ts

@@ -0,0 +1,71 @@
+export type TransactionStatus = 'confirmed' | 'failed' | 'pending';
+export type TransactionDirection = 'in' | 'out' | 'self';
+export type TransactionImage = {
+  type: 'FUNGIBLE' | 'NFT' | undefined;
+  url: string | undefined;
+};
+
+export interface Transaction {
+  id: string;
+  metadata: TransactionMetadata;
+  transfers: TransactionTransfer[];
+}
+
+export interface TransactionMetadata {
+  application: {
+    iconUrl: string | null;
+    name: string | null;
+  };
+  operationType: string;
+  hash: string;
+  minedAt: string;
+  sentFrom: string;
+  sentTo: string;
+  status: TransactionStatus;
+  nonce: number;
+  chain?: string;
+}
+
+export interface TransactionTransfer {
+  fungible_info?: {
+    name?: string;
+    symbol?: string;
+    icon?: {
+      url: string;
+    };
+  };
+  nft_info?: TransactionNftInfo;
+  direction: TransactionDirection;
+  quantity: TransactionQuantity;
+  value?: number;
+  price?: number;
+}
+
+export interface TransactionNftInfo {
+  name?: string;
+  content?: TransactionContent;
+  flags: TransactionNftInfoFlags;
+}
+
+export interface TransactionNftInfoFlags {
+  is_spam: boolean;
+}
+
+export interface TransactionContent {
+  preview?: TransactionPreview;
+  detail?: TransactionDetail;
+}
+
+export interface TransactionPreview {
+  url: string;
+  content_type?: null;
+}
+
+export interface TransactionDetail {
+  url: string;
+  content_type?: null;
+}
+
+export interface TransactionQuantity {
+  numeric: string;
+}

package/src/types/common.ts

@@ -0,0 +1,56 @@
+// Common types used across the AppKit ecosystem
+
+export type CaipAddress = `${string}:${string}:${string}`;
+
+export type CaipNetworkId = `${string}:${string}`;
+
+export type ChainNamespace = 'eip155' | 'solana' | 'polkadot' | 'bip122';
+
+export type AdapterType = 'solana' | 'wagmi' | 'ethers' | 'universal' | 'bip122';
+
+export type AccountType = 'eoa' | 'smartAccount';
+
+export type SocialProvider =
+  | 'google'
+  | 'facebook'
+  | 'github'
+  | 'apple'
+  | 'x'
+  | 'discord'
+  | 'email'
+  | 'farcaster';
+
+export type ThemeMode = 'dark' | 'light';
+
+export interface ThemeVariables {
+  accent?: string;
+}
+
+export interface BaseError {
+  message?: string;
+}
+
+export type ProjectId = string;
+
+export type Platform = 'mobile' | 'web' | 'qrcode' | 'email' | 'unsupported';
+
+export type SdkType = 'appkit';
+
+export type SdkVersion = `react-native-${string}-${string}`;
+
+export type RequestCache =
+  | 'default'
+  | 'force-cache'
+  | 'no-cache'
+  | 'no-store'
+  | 'only-if-cached'
+  | 'reload';
+
+export type CaipNamespaces = Record<
+  string,
+  {
+    chains: CaipNetworkId[];
+    methods: string[];
+    events: string[];
+  }
+>;

package/src/types/index.ts

@@ -0,0 +1,28 @@
+// Main types barrel export - re-exports all types from all domains
+
+// Common types
+export * from './common';
+
+// Blockchain types
+export * from './blockchain';
+
+// Wallet types
+export * from './wallet';
+
+// API types
+export * from './api';
+
+// Swap types
+export * from './swap';
+
+// OnRamp types
+export * from './onramp';
+
+// SIWE types
+export * from './siwe';
+
+// Storage types
+export * from './storage';
+
+// UI types
+export * from './ui';

package/src/types/onramp/countries.ts

@@ -0,0 +1,11 @@
+export type OnRampCountry = {
+  countryCode: string;
+  flagImageUrl: string;
+  name: string;
+};
+
+export type OnRampCountryDefaults = {
+  countryCode: string;
+  defaultCurrencyCode: string;
+  defaultPaymentMethods: string[];
+};

package/src/types/onramp/currencies.ts

@@ -0,0 +1,32 @@
+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 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;
+};

package/src/types/onramp/errors.ts

@@ -0,0 +1,22 @@
+export const OnRampErrorType = {
+  AMOUNT_TOO_LOW: 'INVALID_AMOUNT_TOO_LOW',
+  AMOUNT_TOO_HIGH: 'INVALID_AMOUNT_TOO_HIGH',
+  INVALID_AMOUNT: 'INVALID_AMOUNT',
+  INCOMPATIBLE_REQUEST: 'INCOMPATIBLE_REQUEST',
+  BAD_REQUEST: 'BAD_REQUEST',
+  NO_VALID_QUOTES: 'NO_VALID_QUOTES',
+  FAILED_TO_LOAD: 'FAILED_TO_LOAD',
+  FAILED_TO_LOAD_COUNTRIES: 'FAILED_TO_LOAD_COUNTRIES',
+  FAILED_TO_LOAD_PROVIDERS: 'FAILED_TO_LOAD_PROVIDERS',
+  FAILED_TO_LOAD_METHODS: 'FAILED_TO_LOAD_METHODS',
+  FAILED_TO_LOAD_CURRENCIES: 'FAILED_TO_LOAD_CURRENCIES',
+  FAILED_TO_LOAD_LIMITS: 'FAILED_TO_LOAD_LIMITS',
+  UNKNOWN: 'UNKNOWN_ERROR'
+} as const;
+
+export type OnRampErrorTypeValues = (typeof OnRampErrorType)[keyof typeof OnRampErrorType];
+
+export interface OnRampError {
+  type: OnRampErrorTypeValues;
+  message: string;
+}

package/src/types/onramp/index.ts

@@ -0,0 +1,5 @@
+// OnRamp types barrel export
+export * from './countries';
+export * from './currencies';
+export * from './quotes';
+export * from './errors';

package/src/types/onramp/quotes.ts

@@ -0,0 +1,46 @@
+export type OnRampPaymentMethod = {
+  logos: {
+    dark: string;
+    light: string;
+  };
+  name: string;
+  paymentMethod: string;
+  paymentType: 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;
+};

package/src/types/siwe/config.ts

@@ -0,0 +1,44 @@
+import type {
+  SIWESession,
+  SIWECreateMessageArgs,
+  SIWEMessageArgs,
+  SIWEVerifyMessageArgs
+} from './message';
+
+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;
+  };
+}

package/src/types/siwe/index.ts

@@ -0,0 +1,3 @@
+// SIWE types barrel export
+export * from './config';
+export * from './message';

package/src/types/siwe/message.ts

@@ -0,0 +1,62 @@
+import type { CaipAddress, CaipNetworkId } from '../common';
+
+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'>;
+
+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;
+}

package/src/types/storage.ts

@@ -0,0 +1,30 @@
+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>;
+}

package/src/types/swap/index.ts

@@ -0,0 +1,2 @@
+// Swap types barrel export
+export * from './tokens';

package/src/types/swap/tokens.ts

@@ -0,0 +1,21 @@
+import type { CaipAddress } from '../common';
+
+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';

package/src/types/ui.ts

@@ -0,0 +1,26 @@
+import type { SocialProvider } from './common';
+
+type EnabledSocials = SocialProvider;
+
+export type Features = {
+  /**
+   * @description Enable or disable the swaps feature. Enabled by default.
+   * @type {boolean}
+   */
+  swaps?: boolean;
+  /**
+   * @description Enable or disable the onramp feature. Enabled by default.
+   * @type {boolean}
+   */
+  onramp?: boolean;
+  /**
+   * @description Show or hide the regular wallet options when socials are enabled. Enabled by default.
+   * @type {boolean}
+   */
+  showWallets?: boolean;
+  /**
+   * @description Enable or disable the socials feature. Enabled by default.
+   * @type {EnabledSocials[]}
+   */
+  socials?: EnabledSocials[] | false;
+};

package/src/types/wallet/connection.ts

@@ -0,0 +1,33 @@
+import type { CaipAddress, CaipNetworkId, SocialProvider, AccountType } from '../common';
+import type { Balance } from '../blockchain/balance';
+import type { WalletInfo, Identity } from './wallet-info';
+import type { BlockchainAdapter } from '../../adapters/BlockchainAdapter';
+
+export interface Connection {
+  accounts: CaipAddress[];
+  balances: Map<CaipAddress, Balance[]>;
+  adapter: BlockchainAdapter;
+  caipNetwork: CaipNetworkId;
+  wallet?: WalletInfo;
+  properties?: ConnectionProperties;
+  type?: AccountType;
+  identities?: Map<CaipAddress, Identity>;
+}
+
+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;
+}