@reown/appkit-common-react-native 2.0.0 → 2.0.1

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' | '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';
+
+// SIWX types
+export * from './siwx';
+
+// 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/siwx/config.ts

@@ -0,0 +1,73 @@
+import type { CaipNetworkId } from '../common';
+import type { SIWXSession, SIWXMessage } from './message';
+
+/**
+ * This interface represents the SIWX configuration plugin, which is used to create and manage SIWX messages and sessions.
+ * You may use it to create a custom implementation following your needs, but watch close for the methods requirements.
+ */
+export interface SIWXConfig {
+  /**
+   * This method will be called to create a new message to be signed by the user.
+   *
+   * Constraints:
+   * - The message MUST be unique and contain all the necessary information to verify the user's identity.
+   * - SIWXMessage.toString() method MUST be implemented to return the message string.
+   *
+   * @param input SIWXMessage.Input
+   * @returns SIWXMessage
+   */
+  createMessage: (input: SIWXMessage.Input) => Promise<SIWXMessage>;
+  /**
+   * This method will be called to store a new single session.
+   *
+   * Constraints:
+   * - This method MUST verify if the session is valid and store it in the storage successfully.
+   *
+   * @param session SIWXSession
+   */
+  addSession: (session: SIWXSession) => Promise<void>;
+  /**
+   * This method will be called to revoke all the sessions stored for a specific chain and address.
+   *
+   * Constraints:
+   * - This method MUST delete all the sessions stored for the specific chain and address successfully.
+   *
+   * @param chainId CaipNetworkId
+   * @param address string
+   */
+  revokeSession: (chainId: CaipNetworkId, address: string) => Promise<void>;
+  /**
+   * This method will be called to replace all the sessions in the storage with the new ones.
+   *
+   * Constraints:
+   * - This method MUST verify all the sessions before storing them in the storage;
+   * - This method MUST replace all the sessions in the storage with the new ones succesfully otherwise it MUST throw an error.
+   *
+   * @param sessions SIWXSession[]
+   */
+  setSessions: (sessions: SIWXSession[]) => Promise<void>;
+  /**
+   * This method will be called to get all the sessions stored for a specific chain and address.
+   *
+   * Constraints:
+   * - This method MUST return only sessions that are verified and valid;
+   * - This method MUST NOT return expired sessions.
+   *
+   * @param chainId CaipNetworkId
+   * @param address string
+   * @returns
+   */
+  getSessions: (chainId: CaipNetworkId, address: string) => Promise<SIWXSession[]>;
+  /**
+   * This method determines whether the wallet stays connected when the user denies the signature request.
+   *
+   * @returns {boolean}
+   */
+  getRequired?: () => boolean;
+  /**
+   * This flag determines whether the session should be cleared when the user disconnects.
+   *
+   * @default true
+   */
+  signOutOnDisconnect?: boolean;
+}

package/src/types/siwx/index.ts

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './message';
+export * from './verifier';
+export * from './storage';

package/src/types/siwx/message.ts

@@ -0,0 +1,92 @@
+import type { CaipNetworkId } from '../common';
+
+/**
+ * This interface represents a SIWX session, which is used to store the user's identity information.
+ */
+export interface SIWXSession {
+  data: SIWXMessage.Data;
+  message: string;
+  signature: string;
+  cacao?: Cacao;
+}
+/**
+ * This interface represents a SIWX message, which is used to create a message to be signed by the user.
+ * This must contain the necessary information to verify the user's identity and how to generate the string message.
+ */
+export interface SIWXMessage extends SIWXMessage.Data, SIWXMessage.Methods {}
+export declare namespace SIWXMessage {
+  /**
+   * This interface represents the SIWX message data, which is used to create a message to be signed by the user.
+   */
+  interface Data extends Input, Metadata, Identifier {}
+  /**
+   * This interface represents the SIWX message input.
+   * Here must contain what is different for each user of the application.
+   */
+  interface Input {
+    accountAddress: string;
+    chainId: CaipNetworkId;
+    notBefore?: Timestamp;
+  }
+  /**
+   * This interface represents the SIWX message metadata.
+   * Here must contain the main data related to the app.
+   */
+  interface Metadata {
+    domain: string;
+    uri: string;
+    version: string;
+    nonce: string;
+    statement?: string;
+    resources?: string[];
+  }
+  /**
+   * This interface represents the SIWX message identifier.
+   * Here must contain the request id and the timestamps.
+   */
+  interface Identifier {
+    requestId?: string;
+    issuedAt?: Timestamp;
+    expirationTime?: Timestamp;
+  }
+  /**
+   * This interface represents the SIWX message methods.
+   * Here must contain the method to generate the message string and any other method performed by the SIWX message.
+   */
+  interface Methods {
+    toString: () => string;
+  }
+  /**
+   * The timestamp is a UTC string representing the time in ISO 8601 format.
+   */
+  type Timestamp = string;
+}
+
+interface CacaoHeader {
+  t: 'caip122';
+}
+
+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;
+  };
+}

package/src/types/siwx/storage.ts

@@ -0,0 +1,44 @@
+import type { CaipNetworkId } from '../common';
+import type { SIWXSession } from './message';
+
+/**
+ * This is the interface for a SIWX storage.
+ */
+export interface SIWXStorage {
+  /**
+   * Adds a new session for the storage.
+   * This method should not verify the session, only store it.
+   *
+   * @param session SIWXSession
+   * @returns Promise<void>
+   */
+  add(session: SIWXSession): Promise<void>;
+
+  /**
+   * Deletes a session from the storage.
+   *
+   * @param chainId CaipNetworkId
+   * @param address string
+   * @returns Promise<void>
+   */
+  delete(chainId: CaipNetworkId, address: string): Promise<void>;
+
+  /**
+   * Gets a list of sessions for a given chainId and address.
+   * This method should not verify sessions, only return the sessions that are stored.
+   *
+   * @param chainId CaipNetworkId
+   * @param address string
+   * @returns Promise<SIWXSession[]>
+   */
+  get(chainId: CaipNetworkId, address: string): Promise<SIWXSession[]>;
+
+  /**
+   * Replaces the current sessions with the new list of sessions.
+   * This method should not verify sessions, only store them.
+   *
+   * @param sessions SIWXSession[]
+   * @returns Promise<void>
+   */
+  set(sessions: SIWXSession[]): Promise<void>;
+}

package/src/types/siwx/verifier.ts

@@ -0,0 +1,32 @@
+import type { ChainNamespace } from '../common';
+import type { SIWXSession } from './message';
+
+/**
+ * This is the base class for a SIWX verifier.
+ */
+export abstract class SIWXVerifier {
+  /**
+   * The chain namespace that this verifier should verify.
+   */
+  public abstract readonly chainNamespace: ChainNamespace;
+
+  /**
+   * This method should return true if the verifier should verify the session.
+   * By default it will check by the chain namespace, but you may override it for a specific requirement.
+   *
+   * @param session SIWXSession
+   * @returns boolean
+   */
+  public shouldVerify(session: SIWXSession): boolean {
+    return session.data.chainId.startsWith(this.chainNamespace);
+  }
+
+  /**
+   * This method should verify the session.
+   * You must implement this method with the verification logic.
+   *
+   * @param session SIWXSession
+   * @returns Promise<boolean> - If `true` means the session is valid.
+   */
+  abstract verify(session: SIWXSession): Promise<boolean>;
+}

package/src/types/storage.ts

@@ -0,0 +1,64 @@
+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>;
+}
+
+export interface SafeStorageItems {
+  'WALLETCONNECT_DEEPLINK_CHOICE': string; //dont change this one
+  '@appkit/recent_wallet': string;
+  '@appkit/connected_connectors': string;
+  '@appkit/onramp_preferred_country': string;
+  '@appkit/onramp_countries': string;
+  '@appkit/onramp_service_providers': string;
+  '@appkit/onramp_fiat_limits': string;
+  '@appkit/onramp_fiat_currencies': string;
+  '@appkit/onramp_preferred_fiat_currency': string;
+  '@appkit/onramp_countries_defaults': string;
+  '@appkit/active_namespace': string;
+  '@appkit/coinbase_connector/session': string;
+  '@appkit/siwx-auth-token': string;
+  '@appkit/siwx-nonce-token': string;
+}
+
+export const SafeStorageKeys = {
+  WC_DEEPLINK: 'WALLETCONNECT_DEEPLINK_CHOICE', //dont change this one
+  RECENT_WALLET: '@appkit/recent_wallet',
+  CONNECTED_CONNECTORS: '@appkit/connected_connectors',
+  ONRAMP_PREFERRED_COUNTRY: '@appkit/onramp_preferred_country',
+  ONRAMP_COUNTRIES: '@appkit/onramp_countries',
+  ONRAMP_SERVICE_PROVIDERS: '@appkit/onramp_service_providers',
+  ONRAMP_FIAT_LIMITS: '@appkit/onramp_fiat_limits',
+  ONRAMP_FIAT_CURRENCIES: '@appkit/onramp_fiat_currencies',
+  ONRAMP_PREFERRED_FIAT_CURRENCY: '@appkit/onramp_preferred_fiat_currency',
+  ONRAMP_COUNTRIES_DEFAULTS: '@appkit/onramp_countries_defaults',
+  ACTIVE_NAMESPACE: '@appkit/active_namespace',
+  COINBASE_CONNECTOR_SESSION: '@appkit/coinbase_connector/session',
+  SIWX_AUTH_TOKEN: '@appkit/siwx-auth-token',
+  SIWX_NONCE_TOKEN: '@appkit/siwx-nonce-token'
+} as const;

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,34 @@
+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;
+  canAddEvmChain?: boolean;
+}
+
+export interface LinkingRecord {
+  redirect: string;
+  href: string;
+}
+
+export interface WalletDeepLink {
+  href: string;
+  name: string;
+}