@unifold/core 0.1.11

package/dist/index.d.ts

@@ -0,0 +1,384 @@
+declare function setApiConfig(config: {
+    baseUrl?: string;
+    publishableKey?: string;
+    defaultConfig?: {
+        destinationChainId?: string;
+        destinationTokenAddress?: string;
+        recipientAddress?: string;
+    };
+}): void;
+declare function getApiBaseUrl(): string;
+/**
+ * Build an icon URL using the API base URL
+ * Converts relative paths like "/icons/networks/ethereum.svg" to full URLs
+ * like "https://api.unifold.io/api/public/icons/networks/ethereum.svg"
+ */
+declare function getIconUrl(iconPath: string): string;
+/**
+ * Build an icon URL using a custom CDN base URL
+ * Converts relative paths like "/icons/networks/ethereum.svg" to full CDN URLs
+ * Falls back to getIconUrl if no CDN URL is provided
+ */
+declare function getIconUrlWithCdn(iconPath: string, assetCdnUrl?: string): string;
+interface Wallet {
+    id: string;
+    chain_type: "ethereum" | "solana" | "bitcoin";
+    address_type: string | null;
+    address: string;
+    destination_chain_type: string;
+    destination_chain_id: string;
+    destination_token_address: string;
+    recipient_address: string;
+    is_primary: boolean;
+}
+interface DepositAddressResponse {
+    data: Wallet[];
+}
+interface CreateDepositAddressRequest {
+    external_user_id: string;
+    destination_chain_type: string;
+    destination_chain_id: string;
+    destination_token_address: string;
+    recipient_address: string;
+    client_metadata?: Record<string, unknown>;
+}
+/**
+ * Create deposit addresses for a user
+ * @param overrides - Override default configuration (external_user_id, recipient_address, etc.)
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function createDepositAddress(overrides?: Partial<CreateDepositAddressRequest>, publishableKey?: string): Promise<DepositAddressResponse>;
+/**
+ * Get wallet address for a specific chain type
+ */
+declare function getWalletByChainType(wallets: Wallet[], chainType: "ethereum" | "solana" | "bitcoin"): Wallet | undefined;
+interface AutoSwapRequest {
+    wallet_id: string;
+    origin_currency: string;
+}
+declare enum ExecutionStatus {
+    DELAYED = "delayed",
+    FAILED = "failed",
+    PENDING = "pending",
+    REFUNDED = "refunded",
+    SUCCEEDED = "succeeded",
+    WAITING = "waiting"
+}
+interface IconUrl {
+    url: string;
+    format: "svg" | "png";
+}
+interface AutoSwapResponse {
+    id: string;
+    project_id: string;
+    user_id: string;
+    deposit_wallet_id: string;
+    owner_type?: string;
+    owner_id?: string;
+    transaction_hash: string;
+    recipient_address: string;
+    provider: string;
+    provider_id: string;
+    source_chain_type: string;
+    source_chain_id: string;
+    source_token_address: string;
+    destination_chain_type: string;
+    destination_chain_id: string;
+    destination_token_address: string;
+    source_amount_base_unit: string;
+    source_amount_usd?: string;
+    destination_amount_base_unit: string;
+    provider_metadata: unknown;
+    created_at?: string;
+    updated_at?: string;
+    explorer_url: string;
+    destination_explorer_url: string | null;
+    destination_transaction_hashes: string[];
+    status: ExecutionStatus;
+    source_token_metadata?: {
+        icon_url: string;
+        icon_urls?: IconUrl[];
+    };
+    destination_token_metadata?: {
+        icon_url: string;
+        icon_urls?: IconUrl[];
+    };
+    deposit_wallet?: {
+        id: string;
+        chain_type: string;
+        address_type: string | null;
+        address: string;
+        is_primary: boolean;
+        created_at: string;
+        updated_at: string;
+        last_used_at: string | null;
+    };
+    source_currency?: string;
+    destination_currency?: string;
+}
+declare const SOLANA_USDC_ADDRESS = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v";
+interface QueryExecutionsRequest {
+    external_user_id: string;
+}
+interface QueryExecutionsResponse {
+    data: AutoSwapResponse[];
+}
+/**
+ * Query all direct executions for a user
+ * Returns ALL executions - filter client-side for new ones
+ * @param externalUserId - External user ID
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function queryExecutions(externalUserId: string, publishableKey?: string): Promise<QueryExecutionsResponse>;
+interface SupportedChain {
+    chain_id: string;
+    chain_name: string;
+    chain_type: string;
+    icon_url: string;
+    token_address: string;
+    estimated_price_impact_percent: number;
+    max_slippage_percent: number;
+    estimated_processing_time: number | null;
+    minimum_deposit_amount_usd: number;
+}
+interface SupportedToken {
+    symbol: string;
+    name: string;
+    icon_url: string;
+    is_newly_added: boolean;
+    chains: SupportedChain[];
+}
+interface SupportedDepositTokensResponse {
+    data: SupportedToken[];
+}
+/**
+ * Get supported deposit tokens
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function getSupportedDepositTokens(publishableKey?: string): Promise<SupportedDepositTokensResponse>;
+interface MeldQuote {
+    transaction_type: string;
+    payment_method_type: string;
+    source_amount: number;
+    source_amount_without_fees: number;
+    fiat_amount_without_fees: number;
+    destination_amount_without_fees: number | null;
+    source_currency_code: string;
+    country_code: string;
+    total_fee: number;
+    network_fee: number;
+    transaction_fee: number;
+    destination_amount: number;
+    destination_currency_code: string;
+    exchange_rate: number;
+    customer_score: number;
+    service_provider: string;
+    service_provider_display_name: string;
+    institution_name: string | null;
+    low_kyc: boolean | null;
+    partner_fee: number | null;
+    icon_url: string;
+}
+interface MeldQuotesRequest {
+    country_code: string;
+    destination_currency_code: string;
+    source_amount: string;
+    source_currency_code: string;
+}
+interface MeldQuotesResponse {
+    data: MeldQuote[];
+}
+/**
+ * Get Meld onramp quotes
+ * @param request - Meld quotes request
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function getMeldQuotes(request: MeldQuotesRequest, publishableKey?: string): Promise<MeldQuotesResponse>;
+interface MeldSessionRequest {
+    service_provider: string;
+    country_code: string;
+    destination_currency_code: string;
+    source_currency_code: string;
+    wallet_address: string;
+    source_amount: string;
+}
+interface MeldSessionResponse {
+    id: string;
+    external_session_id: string | null;
+    external_customer_id: string | null;
+    customer_id: string;
+    widget_url: string;
+    service_provider_widget_url: string;
+    token: string;
+}
+/**
+ * Create a Meld onramp session
+ * @param request - Meld session request
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function createMeldSession(request: MeldSessionRequest, publishableKey?: string): Promise<MeldSessionResponse>;
+/**
+ * Get the preferred icon URL from an array of icon URLs
+ * @param iconUrls - Array of icon URLs with format information
+ * @param preferredFormat - Preferred format ("svg" or "png"), defaults to "svg"
+ * @returns The URL string for the preferred format, or first available if preferred not found
+ */
+declare function getPreferredIconUrl(iconUrls: IconUrl[] | undefined, preferredFormat?: "svg" | "png"): string | undefined;
+interface FiatCurrency {
+    currency_code: string;
+    name: string;
+    icon_url: string;
+    icon_urls?: IconUrl[];
+}
+interface FiatCurrenciesResponse {
+    data: FiatCurrency[];
+    preferred: string[];
+}
+/**
+ * Get supported fiat currencies
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function getFiatCurrencies(publishableKey?: string): Promise<FiatCurrenciesResponse>;
+interface TokenChainIconUrl {
+    url: string;
+    format: string;
+}
+interface TokenChain {
+    chain_id: string;
+    chain_name: string;
+    chain_type: string;
+    icon_url: string;
+    icon_urls: TokenChainIconUrl[];
+}
+interface TokenChainsResponse {
+    data: TokenChain[];
+}
+/**
+ * Get all supported token chains
+ * This is a public endpoint that doesn't require authentication
+ */
+declare function getTokenChains(): Promise<TokenChainsResponse>;
+/**
+ * Find a chain name by chain_id or chain_type
+ * @param chains - Array of TokenChain objects
+ * @param chainType - The chain type (e.g., "ethereum", "solana")
+ * @param chainId - The chain ID (e.g., "1", "137")
+ * @returns The chain name or a fallback value
+ */
+declare function getChainName(chains: TokenChain[], chainType: string, chainId: string): string;
+interface FeaturedToken {
+    name: string;
+    position: number;
+    icon_urls: IconUrl[];
+}
+interface PaymentNetwork {
+    name: string;
+    icon_urls: IconUrl[];
+}
+interface ProjectConfigResponse {
+    asset_cdn_url: string;
+    transfer_crypto: {
+        networks: FeaturedToken[];
+    };
+    payment_networks: {
+        networks: PaymentNetwork[];
+    };
+}
+/**
+ * Get project configuration
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function getProjectConfig(publishableKey?: string): Promise<ProjectConfigResponse>;
+
+/**
+ * User IP information interface
+ */
+interface UserIpInfo {
+    alpha2: string;
+    state?: string;
+}
+/**
+ * Hook to fetch user's IP-based location information
+ *
+ * Uses ipapi.co to detect the user's country and state.
+ *
+ * The result is cached in-memory using React Query:
+ * - Data persists for the entire browser session
+ * - Shared across all components using this hook
+ * - Reduces API calls and protects against rate limiting
+ *
+ * @returns User IP information including country code
+ */
+declare function useUserIp(): {
+    userIpInfo: UserIpInfo | undefined;
+    isLoading: boolean;
+    error: Error | null;
+};
+
+declare const i18n: {
+    transferCrypto: {
+        priceImpact: {
+            label: string;
+            tooltip: string;
+            finalCost: string;
+        };
+        slippage: {
+            label: string;
+            auto: string;
+            tooltip: string;
+            finalCost: string;
+        };
+        processingTime: {
+            label: string;
+            lessThanMinutes: string;
+            lessThanHours: string;
+        };
+        minDeposit: {
+            label: string;
+            tooltip: string;
+        };
+        help: {
+            needHelp: string;
+            contactSupport: string;
+        };
+        terms: {
+            termsApply: string;
+        };
+        supportedToken: string;
+        supportedChain: string;
+        depositAddress: {
+            label: string;
+            tooltip: string;
+        };
+        copyAddress: string;
+        copied: string;
+        loading: string;
+        loadingQRCode: string;
+        noAddressAvailable: string;
+        noChainsAvailable: string;
+    };
+    depositModal: {
+        transferCrypto: {
+            title: string;
+            subtitle: string;
+        };
+        depositWithCard: {
+            title: string;
+            subtitle: string;
+        };
+        quotes: string;
+    };
+    buyWithCard: {
+        onramp: {
+            completeTransaction: string;
+            canCloseModal: string;
+            youUse: string;
+            youBuy: string;
+            youReceive: string;
+            intentAddressNote: string;
+        };
+    };
+};
+type I18nStrings = typeof i18n;
+
+export { type AutoSwapRequest, type AutoSwapResponse, type CreateDepositAddressRequest, type DepositAddressResponse, ExecutionStatus, type FeaturedToken, type FiatCurrenciesResponse, type FiatCurrency, type I18nStrings, type IconUrl, type MeldQuote, type MeldQuotesRequest, type MeldQuotesResponse, type MeldSessionRequest, type MeldSessionResponse, type PaymentNetwork, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, SOLANA_USDC_ADDRESS, type SupportedChain, type SupportedDepositTokensResponse, type SupportedToken, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type UserIpInfo, type Wallet, createDepositAddress, createMeldSession, getApiBaseUrl, getChainName, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getMeldQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, setApiConfig, useUserIp };