@tomo-inc/wallet-connect-protocol 0.0.4 → 0.0.6

package/dist/vanilla-2_OWCFEZ.d.cts

@@ -0,0 +1,705 @@
+/**
+ * WalletConnect configuration type definition
+ */
+interface WalletConnectConfig {
+    /** WalletConnect Project ID (get from https://cloud.walletconnect.com) */
+    projectId: string;
+    /** application metadata */
+    metadata: {
+        /** application name */
+        name: string;
+        /** application description */
+        description: string;
+        /** application website address */
+        url: string;
+        /** application icon URL */
+        icons: string[];
+    };
+    /** optional configuration */
+    relayUrl?: string;
+    /** authentication options */
+    auth?: AuthOptions;
+}
+/**
+ * session information
+ */
+interface SessionInfo {
+    /** session topic/ID */
+    topic: string;
+    /** peer information */
+    peer: {
+        metadata: {
+            name: string;
+            description: string;
+            url: string;
+            icons: string[];
+        };
+    };
+    /** namespace configuration */
+    namespaces: Record<string, any>;
+    /** expiry timestamp */
+    expiry: number;
+}
+/**
+ * connection request parameters
+ */
+interface ConnectParams {
+    /** optional pairing topic */
+    pairingTopic?: string;
+    /** required namespaces */
+    requiredNamespaces?: Record<string, NamespaceConfig>;
+    /** optional namespaces */
+    optionalNamespaces?: Record<string, NamespaceConfig>;
+}
+/**
+ * namespace configuration
+ */
+interface NamespaceConfig {
+    /** chain ID list */
+    chains: string[];
+    /** supported methods */
+    methods: string[];
+    /** subscribed events */
+    events: string[];
+}
+/**
+ * supported blockchain types
+ */
+declare enum ChainType {
+    /** Ethereum and EVM compatible chains */
+    EIP155 = "eip155",
+    /** Solana */
+    SOLANA = "solana",
+    /** Aptos */
+    APTOS = "aptos",
+    /** Cosmos */
+    COSMOS = "cosmos",
+    /** Polkadot */
+    POLKADOT = "polkadot",
+    /** Near */
+    NEAR = "near"
+}
+/**
+ * QR code options
+ */
+interface QRCodeOptions {
+    /** QR code width (pixels) */
+    width?: number;
+    /** QR code height (pixels) */
+    height?: number;
+    /** error correction level */
+    errorCorrectionLevel?: "L" | "M" | "Q" | "H";
+    /** margin */
+    margin?: number;
+    /** color configuration */
+    color?: {
+        dark?: string;
+        light?: string;
+    };
+}
+/**
+ * event types
+ */
+type WalletConnectEvent = "session_proposal" | "session_update" | "session_delete" | "session_request" | "display_uri";
+/**
+ * event handler type
+ */
+type EventHandler<T = any> = (data: T) => void | Promise<void>;
+/**
+ * Authentication method
+ */
+declare enum AuthMethod {
+    /** Standard WalletConnect connection */
+    STANDARD = "standard",
+    /** Sign-In with Ethereum (SIWE) */
+    SIWE = "siwe"
+}
+/**
+ * Authentication options
+ */
+interface AuthOptions {
+    /** Authentication method */
+    method?: AuthMethod;
+    /** SIWE specific options */
+    siwe?: {
+        /** Domain requesting the signing */
+        domain: string;
+        /** Statement to present to user */
+        statement?: string;
+        /** URI of the application */
+        uri: string;
+        /** Resources the user wishes to access */
+        resources?: string[];
+    };
+}
+
+/**
+ * WalletConnect client class
+ * wraps the core functionality of WalletConnect
+ */
+declare class WalletConnectClient {
+    private signClient;
+    private config;
+    private eventHandlers;
+    private initialized;
+    constructor(config: WalletConnectConfig);
+    /**
+     * initialize WalletConnect client
+     */
+    initialize(): Promise<void>;
+    /**
+     * set event listeners
+     */
+    private setupEventListeners;
+    /**
+     * create pairing connection and generate URI
+     * @param params connection parameters
+     * @returns WalletConnect URI
+     */
+    connect(params?: ConnectParams): Promise<string>;
+    /**
+     * generate QR code (Base64 format)
+     * @param uri WalletConnect URI
+     * @param options QR code options
+     * @returns Base64 formatted QR code image
+     */
+    generateQRCode(uri: string, options?: QRCodeOptions): Promise<string>;
+    /**
+     * generate QR code (Canvas format)
+     * @param canvas Canvas element
+     * @param uri WalletConnect URI
+     * @param options QR code options
+     */
+    generateQRCodeToCanvas(canvas: HTMLCanvasElement, uri: string, options?: QRCodeOptions): Promise<void>;
+    /**
+     * get all active sessions
+     * @returns session information array
+     */
+    getActiveSessions(): SessionInfo[];
+    /**
+     * disconnect specified session
+     * @param topic session topic/ID
+     */
+    disconnectSession(topic: string): Promise<void>;
+    /**
+     * listen to events
+     * @param event event name
+     * @param handler event handler
+     */
+    on<T = any>(event: WalletConnectEvent, handler: EventHandler<T>): void;
+    /**
+     * remove event listener
+     * @param event event name
+     * @param handler event handler
+     */
+    off<T = any>(event: WalletConnectEvent, handler: EventHandler<T>): void;
+    /**
+     * trigger event
+     * @param event event name
+     * @param data event data
+     */
+    private emit;
+    /**
+     * send JSON-RPC request to wallet
+     * @param params request parameters
+     * @returns request result
+     */
+    sendRequest(params: {
+        topic: string;
+        chainId: string;
+        request: {
+            method: string;
+            params: any[];
+        };
+    }): Promise<any>;
+    /**
+     * destroy client
+     */
+    destroy(): Promise<void>;
+    /**
+     * get if client is initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * get configuration information
+     */
+    getConfig(): WalletConnectConfig;
+}
+
+/**
+ * Sign-In with Ethereum (SIWE) Support
+ * Implementation of EIP-4361: Sign-In with Ethereum
+ */
+/**
+ * SIWE configuration options
+ */
+interface SiweConfig {
+    /** Domain requesting the signing */
+    domain: string;
+    /** Statement to present to user (optional) */
+    statement?: string;
+    /** URI of the application */
+    uri: string;
+    /** Version of the SIWE message (default: "1") */
+    version?: string;
+    /** Chain ID */
+    chainId: number;
+    /** Nonce for preventing replay attacks */
+    nonce?: string;
+    /** ISO 8601 datetime string of current time */
+    issuedAt?: string;
+    /** ISO 8601 datetime string when message expires */
+    expirationTime?: string;
+    /** ISO 8601 datetime string when message becomes valid */
+    notBefore?: string;
+    /** Request ID */
+    requestId?: string;
+    /** Resources the user wishes to access */
+    resources?: string[];
+}
+/**
+ * SIWE message and signature result
+ */
+interface SiweResult {
+    /** The SIWE message that was signed */
+    message: string;
+    /** The signature */
+    signature: string;
+    /** The address that signed */
+    address: string;
+    /** Parsed SIWE message object */
+    siweMessage: any;
+}
+/**
+ * Create a SIWE message
+ */
+declare function createSiweMessage(config: SiweConfig, address: string): Promise<string>;
+/**
+ * Parse a SIWE message
+ */
+declare function parseSiweMessage(message: string): Promise<any>;
+/**
+ * Verify a SIWE signature
+ */
+declare function verifySiweSignature(params: {
+    message: string;
+    signature: string;
+    nonce?: string;
+    domain?: string;
+    time?: string;
+}): Promise<{
+    success: boolean;
+    data?: any;
+    error?: string;
+}>;
+/**
+ * Generate a random nonce for SIWE
+ */
+declare function generateNonce(length?: number): string;
+/**
+ * Extract chain ID from account string
+ */
+declare function extractChainIdNumber(account: string): number;
+/**
+ * Create SIWE configuration from session
+ */
+declare function createSiweConfigFromSession(params: {
+    domain: string;
+    uri: string;
+    chainId: number;
+    statement?: string;
+    resources?: string[];
+}): SiweConfig;
+/**
+ * SIWE authentication flow helper
+ */
+declare class SiweAuth {
+    private config;
+    constructor(config: Omit<SiweConfig, "nonce" | "issuedAt">);
+    /**
+     * Create the message to sign
+     */
+    createMessage(address: string): Promise<string>;
+    /**
+     * Verify the signature
+     */
+    verify(message: string, signature: string): Promise<{
+        success: boolean;
+        data?: any;
+        error?: string;
+    }>;
+    /**
+     * Get the nonce
+     */
+    getNonce(): string;
+    /**
+     * Refresh nonce (for new sign-in attempts)
+     */
+    refreshNonce(): void;
+}
+
+/**
+ * utility functions
+ */
+/**
+ * validate WalletConnect URI format
+ * @param uri WalletConnect URI
+ * @returns whether valid
+ */
+declare function isValidWalletConnectUri(uri: string): boolean;
+/**
+ * parse WalletConnect URI
+ * @param uri WalletConnect URI
+ * @returns parsed object
+ */
+declare function parseWalletConnectUri(uri: string): {
+    topic: string;
+    version: string;
+    symKey?: string;
+    relay?: {
+        protocol: string;
+        data?: string;
+    };
+} | null;
+/**
+ * format address (shorten display)
+ * @param address full address
+ * @param startLength start length
+ * @param endLength end length
+ * @returns formatted address
+ */
+declare function formatAddress(address: string, startLength?: number, endLength?: number): string;
+/**
+ * extract address from account string
+ * @param account account string (format: chainId:address)
+ * @returns address
+ */
+declare function extractAddressFromAccount(account: string): string;
+/**
+ * extract chain ID from account string
+ * @param account account string (format: namespace:chainId:address)
+ * @returns chain ID
+ */
+declare function extractChainIdFromAccount(account: string): string;
+/**
+ * check if session is expired
+ * @param expiry expiry timestamp (seconds)
+ * @returns whether expired
+ */
+declare function isSessionExpired(expiry: number): boolean;
+/**
+ * get session remaining time
+ * @param expiry expiry timestamp (seconds)
+ * @returns remaining seconds
+ */
+declare function getSessionTimeRemaining(expiry: number): number;
+/**
+ * format timestamp to readable format
+ * @param timestamp timestamp (seconds)
+ * @returns formatted timestamp string
+ */
+declare function formatTimestamp(timestamp: number): string;
+/**
+ * check if is mobile device
+ * @returns whether is mobile device
+ */
+declare function isMobile(): boolean;
+/**
+ * generate deep link
+ * @param uri WalletConnect URI
+ * @param walletName wallet name (optional)
+ * @returns deep link
+ */
+declare function generateDeepLink(uri: string, walletName?: string): string;
+/**
+ * copy text to clipboard
+ * @param text text to copy
+ * @returns whether successful
+ */
+declare function copyToClipboard(text: string): Promise<boolean>;
+/**
+ * format error message
+ * @param error error object
+ * @returns formatted error message
+ */
+declare function formatError(error: any): string;
+/**
+ * validate chain ID format
+ * @param chainId chain ID
+ * @returns whether valid
+ */
+declare function isValidChainId(chainId: string): boolean;
+/**
+ * parse chain ID
+ * @param chainId chain ID (format: namespace:reference)
+ * @returns parsed result
+ */
+declare function parseChainId(chainId: string): {
+    namespace: string;
+    reference: string;
+} | null;
+
+/**
+ * multi-chain support configuration
+ */
+
+/**
+ * Ethereum (EVM compatible chains) namespace configuration
+ */
+declare const EIP155_NAMESPACE: NamespaceConfig;
+/**
+ * Solana namespace configuration
+ */
+declare const SOLANA_NAMESPACE: NamespaceConfig;
+/**
+ * Aptos namespace configuration
+ */
+declare const APTOS_NAMESPACE: NamespaceConfig;
+/**
+ * Cosmos namespace configuration
+ */
+declare const COSMOS_NAMESPACE: NamespaceConfig;
+/**
+ * Polkadot namespace configuration
+ */
+declare const POLKADOT_NAMESPACE: NamespaceConfig;
+/**
+ * Near namespace configuration
+ */
+declare const NEAR_NAMESPACE: NamespaceConfig;
+/**
+ * commonly used EVM chains configuration
+ */
+declare const EVM_CHAINS: {
+    ETHEREUM_MAINNET: string;
+    ETHEREUM_GOERLI: string;
+    ETHEREUM_SEPOLIA: string;
+    POLYGON: string;
+    POLYGON_MUMBAI: string;
+    ARBITRUM: string;
+    ARBITRUM_GOERLI: string;
+    OPTIMISM: string;
+    OPTIMISM_GOERLI: string;
+    BSC: string;
+    BSC_TESTNET: string;
+    AVALANCHE: string;
+    AVALANCHE_FUJI: string;
+    FANTOM: string;
+    CRONOS: string;
+    GNOSIS: string;
+    BASE: string;
+    ZKSYNC: string;
+    LINEA: string;
+    SCROLL: string;
+};
+/**
+ * Solana chains configuration
+ */
+declare const SOLANA_CHAINS: {
+    MAINNET: string;
+    DEVNET: string;
+    TESTNET: string;
+};
+/**
+ * Aptos chains configuration
+ */
+declare const APTOS_CHAINS: {
+    MAINNET: string;
+    TESTNET: string;
+    DEVNET: string;
+};
+/**
+ * get chain name
+ */
+declare function getChainName(chainId: string): string;
+/**
+ * create multi-chain namespaces configuration
+ */
+declare function createMultiChainNamespaces(chains: string[]): Record<string, NamespaceConfig>;
+/**
+ * check chain type
+ */
+declare function getChainType(chainId: string): string;
+
+/**
+ * WalletConnect Wallet List API
+ *
+ * Fetch all supported wallets using WalletConnect Cloud Explorer API
+ * API Documentation: https://explorer-api.walletconnect.com/docs
+ */
+interface WalletImage {
+    id: string;
+    image_id: string;
+    image_url: string;
+}
+interface WalletMetadata {
+    shortName: string;
+    colors: {
+        primary?: string;
+        secondary?: string;
+    };
+}
+interface WalletPlatform {
+    native?: string;
+    universal?: string;
+}
+interface WalletApp {
+    browser?: string;
+    ios?: string;
+    android?: string;
+    mac?: string;
+    windows?: string;
+    linux?: string;
+    chrome?: string;
+    firefox?: string;
+    safari?: string;
+    edge?: string;
+    opera?: string;
+}
+interface Wallet {
+    id: string;
+    name: string;
+    homepage: string;
+    image_id: string;
+    image_url?: WalletImage;
+    order?: number;
+    mobile_link?: string;
+    desktop_link?: string;
+    webapp_link?: string;
+    app_type?: string;
+    rdns?: string;
+    metadata?: WalletMetadata;
+    app?: WalletApp;
+    injected?: Array<{
+        namespace: string;
+        injected_id: string;
+    }>;
+    mobile?: WalletPlatform;
+    desktop?: WalletPlatform;
+}
+interface WalletListResponse {
+    count: number;
+    data: Wallet[];
+}
+interface WalletListOptions {
+    /** Project ID (obtain from WalletConnect Cloud) */
+    projectId?: string;
+    /** Number of entries per page (default 100) */
+    entries?: number;
+    /** Page number (default 1) */
+    page?: number;
+    /** Search keyword */
+    search?: string;
+    /** Filter by chain */
+    chains?: string;
+    /** Include image URLs */
+    include?: string;
+    /** Exclude specific wallets */
+    exclude?: string;
+    /** Recommended wallet IDs */
+    recommendedIds?: string;
+}
+/**
+ * Get all WalletConnect supported wallets
+ *
+ * @param options Query options
+ * @returns Wallet list
+ *
+ * @example
+ * ```typescript
+ * // Get all wallets
+ * const wallets = await getWalletConnectWallets({ projectId: 'your-project-id' });
+ *
+ * // Search wallets
+ * const results = await getWalletConnectWallets({
+ *   projectId: 'your-project-id',
+ *   search: 'metamask'
+ * });
+ *
+ * // Filter by chain
+ * const ethWallets = await getWalletConnectWallets({
+ *   projectId: 'your-project-id',
+ *   chains: 'eip155:1'
+ * });
+ * ```
+ */
+declare function getWalletConnectWallets(options?: WalletListOptions): Promise<WalletListResponse>;
+/**
+ * Get all wallets (automatically handles pagination)
+ *
+ * @param options Query options
+ * @returns Complete list of all wallets
+ */
+declare function getAllWallets(options?: WalletListOptions): Promise<Wallet[]>;
+/**
+ * Get specific wallet by ID
+ *
+ * @param walletId Wallet ID
+ * @param projectId Project ID
+ * @returns Wallet information
+ */
+declare function getWalletById(walletId: string, projectId?: string): Promise<Wallet | null>;
+/**
+ * Search wallets
+ *
+ * @param query Search keyword
+ * @param options Additional options
+ * @returns Matching wallet list
+ */
+declare function searchWallets(query: string, options?: Omit<WalletListOptions, "search">): Promise<Wallet[]>;
+/**
+ * Get wallets that support a specific chain
+ *
+ * @param chainId Chain ID (CAIP-2 format, e.g. 'eip155:1')
+ * @param options Additional options
+ * @returns Wallets that support the chain
+ */
+declare function getWalletsByChain(chainId: string, options?: Omit<WalletListOptions, "chains">): Promise<Wallet[]>;
+/**
+ * Get recommended wallet list
+ *
+ * @param walletIds List of recommended wallet IDs
+ * @param options Additional options
+ * @returns Recommended wallet list
+ */
+declare function getRecommendedWallets(walletIds: string[], options?: Omit<WalletListOptions, "recommendedIds">): Promise<Wallet[]>;
+/**
+ * Get mobile wallet list
+ *
+ * @param options Query options
+ * @returns Mobile wallet list
+ */
+declare function getMobileWallets(options?: WalletListOptions): Promise<Wallet[]>;
+/**
+ * Get desktop wallet list
+ *
+ * @param options Query options
+ * @returns Desktop wallet list
+ */
+declare function getDesktopWallets(options?: WalletListOptions): Promise<Wallet[]>;
+/**
+ * Get browser extension wallet list
+ *
+ * @param options Query options
+ * @returns Browser extension wallet list
+ */
+declare function getBrowserWallets(options?: WalletListOptions): Promise<Wallet[]>;
+/**
+ * Popular wallet ID list
+ */
+declare const POPULAR_WALLET_IDS: {
+    readonly METAMASK: "c57ca95b47569778a828d19178114f4db188b89b763c899ba0be274e97267d96";
+    readonly TRUST: "4622a2b2d6af1c9844944291e5e7351a6aa24cd7b23099efac1b2fd875da31a0";
+    readonly RAINBOW: "1ae92b26df02f0abca6304df07debccd18262fdf5fe82daa81593582dac9a369";
+    readonly COINBASE: "fd20dc426fb37566d803205b19bbc1d4096b248ac04548e3cfb6b3a38bd033aa";
+    readonly SAFE: "225affb176778569276e484e1b92637ad061b01e13a048b35a9d280c3b58970f";
+    readonly ARGENT: "bc949c5d968ae81310268bf9193f9c9fb7bb4e1283e1284af8f2bd4992535fd6";
+    readonly ZERION: "ecc4036f814562b41a5268adc86270fba1365471402006302e70169465b7ac18";
+    readonly IMTOKEN: "ef333840daf915aafdc4a004525502d6d49d77bd9c65e0642dbaefb3c2893bef";
+    readonly OKX: "971e689d0a5be527bac79629b4ee9b925e82208e5168b733496a09c0faed0709";
+    readonly PHANTOM: "a797aa35c0fadbfc1a53e7f675162ed5226968b44a19ee3d24385c64d1d3c393";
+    readonly TOKENPOCKET: "20459438007b75f4f4acb98bf29aa3b800550309646d375da5fd4aac6c2a2c66";
+    readonly BITGET: "7674bb4e353bf52886768a3ddc2a4562ce2f4191c80831291218ebd90f5f5e26";
+};
+
+export { createMultiChainNamespaces as $, type AuthOptions as A, isSessionExpired as B, type ConnectParams as C, getSessionTimeRemaining as D, type EventHandler as E, formatTimestamp as F, isMobile as G, generateDeepLink as H, copyToClipboard as I, formatError as J, isValidChainId as K, parseChainId as L, EIP155_NAMESPACE as M, type NamespaceConfig as N, SOLANA_NAMESPACE as O, POPULAR_WALLET_IDS as P, type QRCodeOptions as Q, APTOS_NAMESPACE as R, type SessionInfo as S, COSMOS_NAMESPACE as T, POLKADOT_NAMESPACE as U, NEAR_NAMESPACE as V, WalletConnectClient as W, EVM_CHAINS as X, SOLANA_CHAINS as Y, APTOS_CHAINS as Z, getChainName as _, type WalletConnectConfig as a, getChainType as a0, type SiweResult as a1, createSiweMessage as a2, parseSiweMessage as a3, verifySiweSignature as a4, generateNonce as a5, extractChainIdNumber as a6, createSiweConfigFromSession as a7, SiweAuth as a8, type SiweConfig as b, getBrowserWallets as c, getDesktopWallets as d, getMobileWallets as e, getRecommendedWallets as f, getAllWallets as g, getWalletById as h, getWalletConnectWallets as i, getWalletsByChain as j, type Wallet as k, type WalletApp as l, type WalletImage as m, type WalletListOptions as n, type WalletListResponse as o, type WalletMetadata as p, type WalletPlatform as q, type WalletConnectEvent as r, searchWallets as s, AuthMethod as t, ChainType as u, isValidWalletConnectUri as v, parseWalletConnectUri as w, formatAddress as x, extractAddressFromAccount as y, extractChainIdFromAccount as z };