@shapeshiftoss/swap-widget 0.0.2 → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,233 @@
+import { Asset as Asset_2 } from '@shapeshiftoss/types';
+import { AssetId } from '@shapeshiftoss/caip';
+import { ChainId } from '@shapeshiftoss/caip';
+import { JSX } from 'react/jsx-runtime';
+import { UseQueryResult } from '@tanstack/react-query';
+import { WalletClient } from 'viem';
+
+export declare type Asset = {
+    assetId: AssetId;
+    chainId: ChainId;
+    symbol: string;
+    name: string;
+    precision: number;
+    icon?: string;
+    color?: string;
+    networkName?: string;
+    networkIcon?: string;
+    explorer?: string;
+    explorerTxLink?: string;
+    explorerAddressLink?: string;
+    relatedAssetKey?: AssetId | null;
+};
+
+export { AssetId }
+
+declare type AssetQueryResult<TData> = Omit<UseQueryResult<RawAssetData>, 'data'> & {
+    data: TData;
+};
+
+export declare type Chain = {
+    chainId: ChainId;
+    name: string;
+    icon: string;
+    color: string;
+    nativeAssetId: AssetId;
+};
+
+export { ChainId }
+
+declare type ChainInfo = {
+    chainId: ChainId;
+    name: string;
+    icon?: string;
+    color?: string;
+    nativeAsset: Asset;
+};
+
+export declare const COSMOS_CHAIN_IDS: {
+    readonly cosmos: ChainId;
+    readonly thorchain: ChainId;
+    readonly mayachain: ChainId;
+};
+
+export declare const EVM_CHAIN_IDS: {
+    readonly ethereum: ChainId;
+    readonly arbitrum: ChainId;
+    readonly optimism: ChainId;
+    readonly polygon: ChainId;
+    readonly base: ChainId;
+    readonly avalanche: ChainId;
+    readonly bsc: ChainId;
+    readonly gnosis: ChainId;
+    readonly monad: ChainId;
+    readonly hyperEvm: ChainId;
+    readonly plasma: ChainId;
+    readonly worldChain: ChainId;
+    readonly katana: ChainId;
+};
+
+export declare const formatAmount: (amount: string, decimals: number, maxDecimals?: number) => string;
+
+export declare const getBaseAsset: (chainId: ChainId) => Asset_2 | undefined;
+
+export declare const getChainColor: (chainId: ChainId) => string;
+
+export declare const getChainIcon: (chainId: ChainId) => string | undefined;
+
+export declare const getChainName: (chainId: ChainId) => string;
+
+export declare const getChainType: (chainId: string) => 'evm' | 'utxo' | 'cosmos' | 'solana' | 'other';
+
+export declare const getEvmNetworkId: (chainId: string) => number;
+
+export declare const getExplorerTxLink: (chainId: ChainId) => string;
+
+export declare const isEvmChainId: (chainId: string) => boolean;
+
+export declare const OTHER_CHAIN_IDS: {
+    readonly solana: ChainId;
+};
+
+export declare const parseAmount: (amount: string, decimals: number) => string;
+
+declare type RawAssetData = {
+    byId: Record<AssetId, Asset>;
+    ids: AssetId[];
+};
+
+export declare enum SwapperName {
+    Thorchain = "THORChain",
+    Mayachain = "MAYAChain",
+    CowSwap = "CoW Swap",
+    Zrx = "0x",
+    ArbitrumBridge = "Arbitrum Bridge",
+    Portals = "Portals",
+    Chainflip = "Chainflip",
+    Jupiter = "Jupiter",
+    Relay = "Relay",
+    ButterSwap = "ButterSwap",
+    Bebop = "Bebop",
+    NearIntents = "NEAR Intents",
+    Cetus = "Cetus",
+    Sunio = "Sun.io",
+    Avnu = "AVNU"
+}
+
+export declare const SwapWidget: (props: SwapWidgetProps) => JSX.Element;
+
+export declare type SwapWidgetProps = {
+    affiliateAddress?: string;
+    affiliateBps?: string;
+    apiBaseUrl?: string;
+    defaultSellAsset?: Asset;
+    defaultBuyAsset?: Asset;
+    disabledChainIds?: ChainId[];
+    disabledAssetIds?: AssetId[];
+    allowedChainIds?: ChainId[];
+    sellDisabledChainIds?: ChainId[];
+    buyDisabledChainIds?: ChainId[];
+    sellDisabledAssetIds?: AssetId[];
+    buyDisabledAssetIds?: AssetId[];
+    sellAllowedChainIds?: ChainId[];
+    buyAllowedChainIds?: ChainId[];
+    sellAllowedAssetIds?: AssetId[];
+    buyAllowedAssetIds?: AssetId[];
+    allowedSwapperNames?: SwapperName[];
+    walletClient?: WalletClient;
+    onConnectWallet?: () => void;
+    onSwapSuccess?: (txHash: string) => void;
+    onSwapError?: (error: Error) => void;
+    onAssetSelect?: (type: 'sell' | 'buy', asset: Asset) => void;
+    theme?: ThemeMode | ThemeConfig;
+    defaultSlippage?: string;
+    showPoweredBy?: boolean;
+    enableWalletConnection?: boolean;
+    walletConnectProjectId?: string;
+    defaultReceiveAddress?: string;
+    ratesRefetchInterval?: number;
+    isBuyAssetLocked?: boolean;
+};
+
+export declare type ThemeConfig = {
+    mode: ThemeMode;
+    accentColor?: string;
+    backgroundColor?: string;
+    cardColor?: string;
+    textColor?: string;
+    borderRadius?: string;
+    fontFamily?: string;
+    borderColor?: string;
+    secondaryTextColor?: string;
+    mutedTextColor?: string;
+    inputColor?: string;
+    hoverColor?: string;
+    buttonVariant?: 'filled' | 'outline';
+};
+
+export declare type ThemeMode = 'light' | 'dark';
+
+export declare type TradeQuote = {
+    id: string;
+    rate: string;
+    swapperName: SwapperName;
+    steps: TradeQuoteStep[];
+    receiveAddress: string;
+    affiliateBps: string;
+    slippageTolerancePercentageDecimal?: string;
+    isStreaming?: boolean;
+};
+
+declare type TradeQuoteStep = {
+    sellAsset: Asset;
+    buyAsset: Asset;
+    sellAmountCryptoBaseUnit: string;
+    buyAmountCryptoBaseUnit: string;
+    rate: string;
+    source: SwapperName;
+    feeData: {
+        networkFeeCryptoBaseUnit: string;
+        protocolFees?: Record<AssetId, {
+            amountCryptoBaseUnit: string;
+        }>;
+    };
+    allowanceContract?: string;
+    estimatedExecutionTimeMs?: number;
+};
+
+export declare type TradeRate = {
+    swapperName: SwapperName;
+    rate: string;
+    buyAmountCryptoBaseUnit: string;
+    sellAmountCryptoBaseUnit: string;
+    steps: number;
+    estimatedExecutionTimeMs?: number;
+    affiliateBps: string;
+    networkFeeCryptoBaseUnit?: string;
+    error?: {
+        code: string;
+        message: string;
+    };
+    id?: string;
+};
+
+export declare const truncateAddress: (address: string, chars?: number) => string;
+
+export declare const useAssetById: (assetId: AssetId | undefined) => AssetQueryResult<Asset | undefined>;
+
+export declare const useAssets: () => AssetQueryResult<Asset[]>;
+
+export declare const useAssetsByChainId: (chainId: ChainId | undefined) => AssetQueryResult<Asset[]>;
+
+export declare const useAssetSearch: (query: string, chainId?: ChainId) => AssetQueryResult<Asset[]>;
+
+export declare const useChains: () => AssetQueryResult<ChainInfo[]>;
+
+export declare const UTXO_CHAIN_IDS: {
+    readonly bitcoin: ChainId;
+    readonly bitcoinCash: ChainId;
+    readonly dogecoin: ChainId;
+    readonly litecoin: ChainId;
+};
+
+export { }