@liberfi.io/types 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,1135 @@
+declare global {
+    interface Window {
+        __LIBERFI_VERSION__?: {
+            [key: string]: string;
+        };
+    }
+}
+declare const _default: "0.1.0";
+
+declare enum Chain {
+    ETHEREUM = "1",
+    UBIQ = "8",
+    OPTIMISM = "10",
+    FLARE = "14",
+    SONGBIRD = "19",
+    ELASTOS = "20",
+    KARDIA = "24",
+    CRONOS = "25",
+    RSK = "30",
+    TELOS = "40",
+    LUKSO = "42",
+    CRAB = "44",
+    DARWINIA = "46",
+    XDC = "50",
+    CSC = "52",
+    ZYX = "55",
+    BINANCE = "56",
+    BINANCE_TESTNET = "97",
+    SYSCOIN = "57",
+    GOCHAIN = "60",
+    ETHEREUMCLASSIC = "61",
+    OKEXCHAIN = "66",
+    HOO = "70",
+    METER = "82",
+    NOVA_NETWORK = "87",
+    TOMOCHAIN = "88",
+    BITKUB = "96",
+    XDAI = "100",
+    VELAS = "106",
+    THUNDERCORE = "108",
+    ENULS = "119",
+    FUSE = "122",
+    HECO = "128",
+    UNICHAIN = "130",
+    POLYGON = "137",
+    SONIC = "146",
+    SHIMMER_EVM = "148",
+    RBN = "151",
+    OMNI = "166",
+    MANTA = "169",
+    HSK = "177",
+    WATER = "181",
+    XLAYER = "196",
+    XDAIARB = "200",
+    OP_BNB = "204",
+    VINUCHAIN = "207",
+    ENERGYWEB = "246",
+    OASYS = "248",
+    FANTOM = "250",
+    FRAXTAL = "252",
+    HPB = "269",
+    BOBA = "288",
+    OMAX = "311",
+    FILECOIN = "314",
+    KUCOIN = "321",
+    ZKSYNC_ERA = "324",
+    SHIDEN = "336",
+    THETA = "361",
+    PULSE = "369",
+    CRONOS_ZKEVM = "388",
+    SX = "416",
+    AREON = "463",
+    WC = "480",
+    CANDLE = "534",
+    ROLLUX = "570",
+    ASTAR = "592",
+    REDSTONE = "690",
+    MATCHAIN = "698",
+    CALLISTO = "820",
+    TARA = "841",
+    WANCHAIN = "888",
+    LYRA_CHAIN = "957",
+    BIFROST = "996",
+    CONFLUX = "1030",
+    METIS = "1088",
+    DYMENSION = "1100",
+    POLYGON_ZKEVM = "1101",
+    CORE = "1116",
+    LISK = "1135",
+    ULTRON = "1231",
+    STEP = "1234",
+    MOONBEAM = "1284",
+    MOONRIVER = "1285",
+    SEI = "1329",
+    LIVING_ASSETS_MAINNET = "1440",
+    STY = "1514",
+    TENET = "1559",
+    GRAVITY = "1625",
+    REYA_NETWORK = "1729",
+    SONEIUM = "1868",
+    SWELLCHAIN = "1923",
+    ONUS = "1975",
+    HUBBLENET = "1992",
+    SANKO = "1996",
+    DOGECHAIN = "2000",
+    MILKOMEDA = "2001",
+    MILKOMEDA_A1 = "2002",
+    KAVA = "2222",
+    SOMA = "2332",
+    KARAK = "2410",
+    ABSTRACT = "2741",
+    ABSTRACT_TESTNET = "11124",
+    MORPH = "2818",
+    CROSSFI = "4158",
+    BEAM = "4337",
+    IOTEX = "4689",
+    MANTLE = "5000",
+    XLC = "5050",
+    NAHMII = "5551",
+    BOUNCEBIT = "6001",
+    TOMBCHAIN = "6969",
+    ZETACHAIN = "7000",
+    PLANQ = "7070",
+    BITROCK = "7171",
+    XSAT = "7200",
+    CYETH = "7560",
+    CANTO = "7700",
+    KLAYTN = "8217",
+    THAT = "8428",
+    BASE = "8453",
+    HELA = "8668",
+    IOTAEVM = "8822",
+    JBC = "8899",
+    EVMOS = "9001",
+    CARBON = "9790",
+    SMARTBCH = "10000",
+    ARTELA = "11820",
+    IMMUTABLE_ZKEVM = "13371",
+    LOOP = "15551",
+    GENESYS = "16507",
+    EOS_EVM = "17777",
+    MAP_PROTOCOL = "22776",
+    SAPPHIRE = "23294",
+    BITGERT = "32520",
+    FUSION = "32659",
+    ZILLIQA = "32769",
+    APECHAIN = "33139",
+    EDU_CHAIN = "41923",
+    ARBITRUM = "42161",
+    ARBITRUM_TESTNET_GOERLI = "421613",
+    ARBITRUM_TESTNET_SEPOLIA = "421614",
+    ARBITRUM_NOVA = "42170",
+    CELO = "42220",
+    OASIS = "42262",
+    ASSETCHAIN = "42420",
+    ETHERLINK = "42793",
+    AVALANCHE = "43114",
+    REI = "47805",
+    ZIRCUIT = "48900",
+    SOPHON = "50104",
+    ETN = "52014",
+    SUPERPOSITION = "55244",
+    REICHAIN = "55555",
+    BOBA_BNB = "56288",
+    INK = "57073",
+    LINEA = "59144",
+    BOB = "60808",
+    GODWOKEN = "71402",
+    BERACHAIN = "80094",
+    BLAST = "81457",
+    CHILIZ = "88888",
+    STRATIS = "105105",
+    REAL = "111188",
+    ODYSSEY = "153153",
+    TAIKO = "167000",
+    BITLAYER = "200901",
+    HYDRATION = "222222",
+    PAREX = "322202",
+    POLIS = "333999",
+    KEKCHAIN = "420420",
+    SCROLL = "534352",
+    ZERO_NETWORK = "543210",
+    ZKLINK_NOVA = "810180",
+    VISION = "888888",
+    SAAKURU = "7225878",
+    ZORA = "7777777",
+    CORN = "21000000",
+    NEON = "245022934",
+    LUMIA = "994873017",
+    AURORA = "1313161554",
+    HARMONY = "1666600000",
+    PALM = "11297108109",
+    ZENIQ = "383414847825",
+    CURIO = "836542336838601",
+    MODE = "34443",
+    SOLANA = "900900900",
+    SOLANA_TESTNET = "901901901",
+    SOLANA_DEVNET = "902902902"
+}
+declare enum ChainNamespace {
+    EVM = "EVM",
+    SOLANA = "SOL"
+}
+
+interface TradeToken {
+    address: string;
+    symbol: string;
+    name?: string;
+    image?: string;
+    amount: string;
+    amountInUsd?: string;
+    priceInUsd?: string;
+}
+interface TradeDex {
+    name?: string;
+    image?: string;
+    protocolFamily?: string;
+    programAddress?: string;
+}
+/**
+ * Trade Activity
+ */
+interface TradeActivity {
+    chain: Chain;
+    walletAddress: string;
+    txHash: string;
+    type: "buy" | "sell";
+    from: TradeToken;
+    to: TradeToken;
+    dex?: TradeDex;
+    poolAddress?: string;
+    status: "pending" | "success" | "failed";
+    time: Date;
+}
+
+interface Token {
+    /**
+     * chain id.
+     */
+    chain: Chain;
+    /**
+     * token name, e.g. "Ethereum", "Solana", etc.
+     */
+    name: string;
+    /**
+     * token symbol, e.g. "ETH", "SOL", etc.
+     */
+    symbol: string;
+    /**
+     * token address.
+     */
+    address: string;
+    /**
+     * token decimals.
+     */
+    decimals: number;
+    /**
+     * token avatar image url.
+     */
+    image?: string;
+    /**
+     * token description.
+     */
+    description?: string;
+    /**
+     * token creators.
+     */
+    creators?: Array<TokenCreator>;
+    /**
+     * token launch info.
+     */
+    launchedFrom?: TokenLaunchedFrom;
+    /**
+     * token migrate progress, range is 0-100.
+     */
+    migrateProgress?: string;
+    /**
+     * token migrate info.
+     */
+    migratedTo?: TokenMigratedTo;
+    /**
+     * token social medias.
+     */
+    socialMedias?: TokenSocialMedias;
+    /**
+     * token stats.
+     */
+    stats?: TokenStats;
+    /**
+     * token market data.
+     */
+    marketData?: TokenMarketData;
+    /**
+     * token liquidity pools
+     */
+    liquidities?: Array<TokenLiquidity>;
+    /**
+     * token security.
+     */
+    security?: TokenSecurity;
+    /**
+     * token tags.
+     */
+    tags?: Array<string>;
+    /**
+     * token create time.
+     */
+    createdAt?: Date;
+}
+interface TokenHistoryPriceObject {
+    time: string;
+    value: number;
+}
+interface TokenCreator {
+    /**
+     * token creator's wallet address.
+     */
+    address?: string;
+    /**
+     * token creator's share percentage, range is 0-100.
+     */
+    share?: number;
+    /**
+     * whether the token creator is verified.
+     */
+    isVerified?: boolean;
+}
+interface TokenLaunchedFrom {
+    /**
+     * token launch program address.
+     */
+    programAddress?: string;
+    /**
+     * token launch protocol family.
+     */
+    protocolFamily?: string;
+}
+interface TokenMigratedTo {
+    /**
+     * token migrate program address.
+     */
+    programAddress?: string;
+    /**
+     * token migrate protocol family.
+     */
+    protocolFamily?: string;
+    /**
+     * token migrate pool address.
+     */
+    poolAddress?: string;
+    /**
+     * token migrate time.
+     */
+    migratedAt?: Date;
+}
+interface TokenSocialMedias {
+    /**
+     * token twitter url.
+     */
+    twitter?: string;
+    /**
+     * token telegram url.
+     */
+    telegram?: string;
+    /**
+     * token website url.
+     */
+    website?: string;
+    /**
+     * token tiktok url.
+     */
+    tiktok?: string;
+    /**
+     * token discord url.
+     */
+    discord?: string;
+    /**
+     * token facebook url.
+     */
+    facebook?: string;
+    /**
+     * token github url.
+     */
+    github?: string;
+    /**
+     * token instagram url.
+     */
+    instagram?: string;
+    /**
+     * token linkedin url.
+     */
+    linkedin?: string;
+    /**
+     * token medium url.
+     */
+    medium?: string;
+    /**
+     * token reddit url.
+     */
+    reddit?: string;
+    /**
+     * token youtube url.
+     */
+    youtube?: string;
+    /**
+     * token bitbucket url.
+     */
+    bitbucket?: string;
+}
+interface TokenStats {
+    /**
+     * token stats by 1m timeframe.
+     */
+    "1m"?: TokenStatsByTimeframe;
+    /**
+     * token stats by 5m timeframe.
+     */
+    "5m"?: TokenStatsByTimeframe;
+    /**
+     * token stats by 15m timeframe.
+     */
+    "15m"?: TokenStatsByTimeframe;
+    /**
+     * token stats by 30m timeframe.
+     */
+    "30m"?: TokenStatsByTimeframe;
+    /**
+     * token stats by 1h timeframe.
+     */
+    "1h"?: TokenStatsByTimeframe;
+    /**
+     * token stats by 4h timeframe.
+     */
+    "4h"?: TokenStatsByTimeframe;
+    /**
+     * token stats by 24h timeframe.
+     */
+    "24h"?: TokenStatsByTimeframe;
+}
+interface TokenStatsByTimeframe {
+    /**
+     * buy txs count
+     */
+    buys?: number;
+    /**
+     * sell txs count
+     */
+    sells?: number;
+    /**
+     * txs count
+     */
+    trades?: number;
+    /**
+     * buy addresses count
+     */
+    buyers?: number;
+    /**
+     * sell addresses count
+     */
+    sellers?: number;
+    /**
+     * trade addresses count
+     */
+    traders?: number;
+    /**
+     * buy volumes in quote token
+     */
+    buyVolumes?: string;
+    /**
+     * sell volumes in quote token
+     */
+    sellVolumes?: string;
+    /**
+     * total volumes in quote token
+     */
+    volumes?: string;
+    /**
+     * buy volumes in usd
+     */
+    buyVolumesInUsd?: string;
+    /**
+     * sell volumes in usd
+     */
+    sellVolumesInUsd?: string;
+    /**
+     * total volumes in usd
+     */
+    volumesInUsd?: string;
+    /**
+     * open price in usd
+     */
+    openPriceInUsd?: string;
+    /**
+     * close price in usd
+     */
+    closePriceInUsd?: string;
+    /**
+     * high price in usd
+     */
+    highPriceInUsd?: string;
+    /**
+     * low price in usd
+     */
+    lowPriceInUsd?: string;
+    /**
+     * price in usd
+     */
+    priceInUsd?: string;
+    /**
+     * price change %
+     */
+    priceChange?: string;
+}
+interface TokenMarketData {
+    /**
+     * total supply
+     */
+    totalSupply?: string;
+    /**
+     * market cap in quote token
+     */
+    marketCap?: string;
+    /**
+     * market cap in usd
+     */
+    marketCapInUsd?: string;
+    /**
+     * price in quote token
+     */
+    price?: string;
+    /**
+     * price in usd
+     */
+    priceInUsd?: string;
+    /**
+     * tvl in quote token
+     */
+    tvl?: string;
+    /**
+     * tvl in usd
+     */
+    tvlInUsd?: string;
+    /**
+     * holders count
+     */
+    holders?: number;
+    /**
+     * creators count
+     */
+    creators?: number;
+    /**
+     * top 10 total holdings
+     */
+    top10Holdings?: string;
+    /**
+     * top 10 holdings ratio
+     */
+    top10Ratio?: string;
+    /**
+     * top 100 total holdings
+     */
+    top100Holdings?: string;
+    /**
+     * top 100 holdings ratio
+     */
+    top100Ratio?: string;
+    /**
+     * creators total holdings
+     */
+    creatorsHoldings?: string;
+    /**
+     * creators holdings ratio
+     */
+    creatorsRatio?: string;
+}
+interface TokenLiquidity {
+    /**
+     * pool avatar image
+     */
+    image?: string;
+    /**
+     * pair token address.
+     */
+    pairAddress?: string;
+    /**
+     * pool address.
+     */
+    poolAddress?: string;
+    /**
+     * program address.
+     */
+    programAddress?: string;
+    /**
+     * protocol name.
+     */
+    protocolName?: string;
+    /**
+     * protocol family.
+     */
+    protocolFamily?: string;
+    /**
+     * tvl in quote token.
+     */
+    tvl?: string;
+    /**
+     * tvl in usd.
+     */
+    tvlInUsd?: string;
+}
+/**
+ * TODO: more security checks
+ */
+interface TokenSecurity {
+    /**
+     * whether the token has transfer fee.
+     */
+    hasTransferFee?: boolean;
+    /**
+     * whether the token transfer fee is upgradable.
+     */
+    isTransferFeeUpgradable?: boolean;
+    /**
+     * whether the token is transferable.
+     */
+    isTransferable?: boolean;
+    /**
+     * whether the token is freezable.
+     */
+    isFreezable?: boolean;
+    /**
+     * whether the token is closable.
+     */
+    isClosable?: boolean;
+}
+type TokenResolution = "1s" | "15s" | "30s" | "1m" | "5m" | "15m" | "30m" | "1h" | "4h" | "12h" | "24h";
+interface TokenCandle {
+    /**
+     * open price in usd
+     */
+    open: string;
+    /**
+     * close price in usd
+     */
+    close: string;
+    /**
+     * high price in usd
+     */
+    high: string;
+    /**
+     * low price in usd
+     */
+    low: string;
+    /**
+     * volume in usd
+     */
+    volume: string;
+    /**
+     * resolution
+     */
+    resolution: TokenResolution;
+    /**
+     * timestamp
+     */
+    timestamp: Date;
+}
+interface TokenHolder {
+    /**
+     * holder wallet address
+     */
+    address: string;
+    /**
+     * holdings amount in token
+     */
+    amount: string;
+    /**
+     * holdings amount in usd
+     */
+    amountInUsd: string;
+    /**
+     * holdings ratio, range is 0-100
+     */
+    ratio: string;
+}
+
+/**
+ * Portfolio PNL
+ */
+interface PortfolioPnl {
+    openTime?: Date;
+    closeTime?: Date;
+    buys?: number;
+    buyVolumes?: string;
+    buyVolumesInUsd?: string;
+    buyAvgPriceInUsd?: string;
+    sells?: number;
+    sellVolumes?: string;
+    sellVolumesInUsd?: string;
+    sellAvgPriceInUsd?: string;
+    unrealizedProfitInUsd?: string;
+    unrealizedProfitRatio?: string;
+    realizedProfitInUsd?: string;
+    realizedProfitRatio?: string;
+    totalProfitInUsd?: string;
+    totalProfitRatio?: string;
+}
+interface Portfolio {
+    chain: Chain;
+    address: string;
+    name: string;
+    symbol: string;
+    image?: string;
+    price: string;
+    priceInUsd: string;
+    priceChangeIn24h?: string;
+    amount: string;
+    amountInUsd: string;
+    pnl?: PortfolioPnl;
+}
+/**
+ * Wallet portfolios
+ */
+interface WalletPortfolios {
+    chain: Chain;
+    address: string;
+    balanceInUsd: string;
+    profitInUsd: string;
+    portfolios: Array<Portfolio>;
+}
+
+declare namespace API {
+    /**
+     * Cursor list result data
+     */
+    interface CursorList<T> {
+        startCursor?: string;
+        endCursor?: string;
+        hasPrev?: boolean;
+        hasNext?: boolean;
+        data: Array<T>;
+    }
+    /**
+     * Cursor list query options
+     */
+    interface CursorListOptions {
+        cursor?: string;
+        limit?: number;
+        direction?: "next" | "prev";
+    }
+    /**
+     * Options for getting token candles
+     */
+    interface GetTokenCandlesOptions {
+        after?: Date;
+        before?: Date;
+        limit?: number;
+    }
+    /**
+     * Token field for filtering
+     */
+    type TokenFieldOption = "price" | "priceChange1m" | "priceChange5m" | "priceChange15m" | "priceChange30m" | "priceChange1h" | "priceChange4h" | "priceChange24h" | "marketCap" | "tvl" | "top10Holdings" | "top10Ratio" | "top100Holdings" | "top100Ratio" | "holders" | "creatorsHoldings" | "creatorsRatio" | "buys1m" | "buys5m" | "buys15m" | "buys30m" | "buys1h" | "buys4h" | "buys24h" | "sells1m" | "sells5m" | "sells15m" | "sells30m" | "sells1h" | "sells4h" | "sells24h" | "trades1m" | "trades5m" | "trades15m" | "trades30m" | "trades1h" | "trades4h" | "trades24h" | "traders1m" | "traders5m" | "traders15m" | "traders30m" | "traders1h" | "traders4h" | "traders24h" | "volumes1m" | "volumes5m" | "volumes15m" | "volumes30m" | "volumes1h" | "volumes4h" | "volumes24h" | "launchedFromProtocolFamily" | "migratedToProtocolFamily" | "tag" | "createdAt" | (string & {});
+    /**
+     * Token filter option
+     */
+    interface TokenFilterOption {
+        field: TokenFieldOption;
+        operator: "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "between" | "in" | "nin" | "contains" | "notContains" | "startsWith" | "endsWith" | "isNotNull" | "isNull";
+        value?: string | number | boolean | Array<string | number | boolean>;
+    }
+    /**
+     * Options for getting token list
+     */
+    interface GetTokenListOptions {
+        sortBy?: TokenFieldOption;
+        sortDirection?: "asc" | "desc";
+        filters?: Array<TokenFilterOption>;
+        keywords?: Array<string>;
+        excludeKeywords?: Array<string>;
+    }
+    /**
+     * Options for searching tokens
+     */
+    interface SearchTokensOptions extends CursorListOptions {
+        chains?: Array<Chain>;
+        keyword?: string;
+        filters?: Array<TokenFilterOption>;
+        sortBy?: TokenFieldOption;
+        sortDirection?: "asc" | "desc";
+    }
+    /**
+     * Search token cursor list
+     */
+    interface SearchTokenCursorList extends CursorList<Token> {
+        total?: number;
+        extra?: any;
+    }
+    enum SwapMode {
+        EXACT_IN = "ExactIn",
+        EXACT_OUT = "ExactOut"
+    }
+    interface SwapParams {
+        chain: Chain;
+        userAddress: string;
+        input: string;
+        output: string;
+        mode: SwapMode;
+        amount: string;
+        slippage?: number;
+        priorityFee?: string;
+        tipFee?: string;
+        isAntiMev?: boolean;
+    }
+    interface SwapRoutePlan {
+        name: string;
+        input: string;
+        inputAmount: string;
+        output: string;
+        outputAmount: string;
+        feeQuote?: string;
+        feeAmount?: string;
+        extra?: any;
+    }
+    interface SwapRoute {
+        serializedTx: string;
+        plans: Array<SwapRoutePlan>;
+        extra?: any;
+    }
+    interface SendTxParams {
+        chain: Chain;
+        serializedTx: string;
+        extra?: any;
+    }
+    interface SendTxResult {
+        txHash: string;
+        extra?: any;
+    }
+    /**
+     * Options for getting trade activities
+     */
+    interface GetTradeActivitiesOptions extends CursorListOptions {
+        before?: Date;
+        after?: Date;
+        beforeBlockHeight?: number;
+        afterBlockHeight?: number;
+        type?: "buy" | "sell";
+        poolAddress?: string;
+    }
+    /**
+     * API client interface
+     */
+    interface IClient {
+        /**
+         * fetch token info
+         * @param chain chain id
+         * @param address token address
+         * @returns token info
+         */
+        getToken(chain: Chain, address: string): Promise<Token>;
+        /**
+         * fetch token infos in batch
+         * @param chain chain id
+         * @param addresses token addresses
+         * @returns token infos
+         */
+        getTokens(chain: Chain, addresses: Array<string>): Promise<Array<Token>>;
+        /**
+         * fetch token candles
+         * @param chain chain id
+         * @param address token address
+         * @param resolution token resolution
+         * @param options optional query options
+         * @returns token candles
+         */
+        getTokenCandles(chain: Chain, address: string, resolution: TokenResolution, options?: GetTokenCandlesOptions): Promise<Array<TokenCandle>>;
+        /**
+         * fetch token security
+         * @param chain chain id
+         * @param address token address
+         * @returns token security
+         */
+        getTokenSecurity(chain: Chain, address: string): Promise<TokenSecurity>;
+        /**
+         * fetch token stats
+         * @param chain chain id
+         * @param address token address
+         * @returns token stats
+         */
+        getTokenStats(chain: Chain, address: string): Promise<TokenStats>;
+        /**
+         * fetch token holders
+         * @param chain chain id
+         * @param address token address
+         * @param options optional query options
+         * @returns token holders
+         */
+        getTokenHolders(chain: Chain, address: string, options?: CursorListOptions): Promise<CursorList<TokenHolder>>;
+        /**
+         * fetch token market data
+         * @param chain chain id
+         * @param address token address
+         * @returns token market data
+         */
+        getTokenMarketData(chain: Chain, address: string): Promise<TokenMarketData>;
+        /**
+         * fetch `New` token list
+         * @param chain chain id
+         * @param options optional query options
+         * @returns `New` token list
+         */
+        getNewTokens(chain: Chain, options?: GetTokenListOptions): Promise<Array<Token>>;
+        /**
+         * fetch `Final Stretch` token list
+         * @param chain chain id
+         * @param options optional query options
+         * @returns `Final Stretch` token list
+         */
+        getFinalStretchTokens(chain: Chain, options?: GetTokenListOptions): Promise<Array<Token>>;
+        /**
+         * fetch `Migrated` token list
+         * @param chain chain id
+         * @param options optional query options
+         * @returns `Migrated` token list
+         */
+        getMigratedTokens(chain: Chain, options?: GetTokenListOptions): Promise<Array<Token>>;
+        /**
+         * fetch `Trending` token list
+         * @param chain chain id
+         * @param timeframe query timeframe, e.g. "1m", "5m", "1h", "4h", "24h"
+         * @param options optional query options
+         * @returns `Trending` token list
+         */
+        getTrendingTokens(chain: Chain, timeframe: "1m" | "5m" | "1h" | "4h" | "24h", options?: GetTokenListOptions): Promise<Array<Token>>;
+        /**
+         * fetch `Stock` token list
+         * @param chain chain id
+         * @param options optional query options
+         * @returns `Stock` token list
+         */
+        getStockTokens(chain: Chain, options?: GetTokenListOptions): Promise<Array<Token>>;
+        /**
+         * search tokens
+         * @param options optional query options
+         * @returns search token cursor list
+         */
+        searchTokens(options?: SearchTokensOptions): Promise<SearchTokenCursorList>;
+        /**
+         * fetch swap route plans
+         * @param params swap params
+         * @returns swap route plans
+         */
+        swapRoute(params: SwapParams): Promise<SwapRoute>;
+        /**
+         * send tx
+         * @param params send tx params
+         * @returns send tx result
+         */
+        sendTx(params: SendTxParams): Promise<SendTxResult>;
+        /**
+         * check if tx is successful
+         * @param chain chain id
+         * @param txHash tx hash
+         * @param timeout timeout in milliseconds
+         * @returns true if tx is successful, false otherwise
+         */
+        checkTxSuccess(chain: Chain, txHash: string, timeout?: number): Promise<boolean>;
+        /**
+         * fetch wallet portfolios
+         * @param chain chain id
+         * @param address wallet address
+         * @returns wallet portfolios
+         */
+        getWalletPortfolios(chain: Chain, address: string): Promise<WalletPortfolios>;
+        /**
+         * fetch wallet's trade activities
+         * @param chain chain id
+         * @param address wallet address
+         * @param options optional query options
+         * @returns wallet's trade activities
+         */
+        getWalletTradeActivities(chain: Chain, address: string, options?: GetTradeActivitiesOptions): Promise<CursorList<TradeActivity>>;
+        /**
+         * fetch token's trade activities
+         * @param chain chain id
+         * @param address token address
+         * @param options optional query options
+         * @returns token's trade activities
+         */
+        getTokenTradeActivities(chain: Chain, address: string, options?: GetTradeActivitiesOptions): Promise<CursorList<TradeActivity>>;
+        /**
+         * get presigned upload url
+         * @returns presigned upload url
+         */
+        getPresignedUploadUrl(): Promise<string>;
+    }
+    interface ISubscription {
+        unsubscribe(): void;
+    }
+    interface TokenSubscribed {
+        chain: Chain;
+        address: string;
+        name?: string;
+        symbol?: string;
+        decimals?: number;
+        image?: string;
+        description?: string;
+        socialMedias?: TokenSocialMedias;
+        launchedFrom?: TokenLaunchedFrom;
+        migratedTo?: TokenMigratedTo;
+        createdAt: Date;
+    }
+    interface WalletPnlSubscribed {
+        chain: Chain;
+        address: string;
+        balanceInUsd?: string;
+        profitInUsd?: string;
+    }
+    interface PortfolioSubscribed {
+        chain: Chain;
+        address: string;
+        amount?: string;
+    }
+    type PortfolioPnlSubscribed = PortfolioPnl & {
+        chain: Chain;
+        address: string;
+    };
+    /**
+     * Subscribe client interface
+     */
+    interface ISubscribeClient {
+        /**
+         * Subscribe token's basic info changes
+         * @param chain chain id
+         * @param address token address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeTokenBasic(chain: Chain, address: string, callback: (tokens: Array<TokenSubscribed>) => void): ISubscription;
+        /**
+         * Subscribe token's market data changes
+         * @param chain chain id
+         * @param address token address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeTokenMarketData(chain: Chain, address: string, callback: (marketDatas: Array<TokenMarketData>) => void): ISubscription;
+        /**
+         * Subscribe token's stats changes
+         * @param chain chain id
+         * @param address token address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeTokenStats(chain: Chain, address: string, callback: (stats: Array<TokenStats>) => void): ISubscription;
+        /**
+         * Subscribe token new candles
+         * @param chain chain id
+         * @param address token address
+         * @param resolution token resolution
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeTokenCandles(chain: Chain, address: string, resolution: TokenResolution, callback: (candles: Array<TokenCandle>) => void): ISubscription;
+        /**
+         * Subscribe wallet's pnl changes
+         * @param chain chain id
+         * @param address wallet address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeWalletPnl(chain: Chain, address: string, callback: (pnls: Array<WalletPnlSubscribed>) => void): ISubscription;
+        /**
+         * Subscribe wallet's portfolio changes
+         * @param chain chain id
+         * @param address wallet address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeWalletPortfolios(chain: Chain, address: string, callback: (portfolios: Array<PortfolioSubscribed>) => void): ISubscription;
+        /**
+         * Subscribe wallet's portfolio pnl changes
+         * @param chain chain id
+         * @param address wallet address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeWalletPortfolioPnls(chain: Chain, address: string, callback: (portfolioPnls: Array<PortfolioPnlSubscribed>) => void): ISubscription;
+        /**
+         * Subscribe wallet's new trade activities
+         * @param chain chain id
+         * @param address wallet address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeWalletTradeActivities(chain: Chain, address: string, callback: (trades: Array<TradeActivity>) => void): ISubscription;
+        /**
+         * Subscribe token's new trade activities
+         * @param chain chain id
+         * @param address token address
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeTokenTradeActivities(chain: Chain, address: string, callback: (trades: Array<TradeActivity>) => void): ISubscription;
+        /**
+         * Subscribe `New` token list changes
+         * @param chain chain id
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeNewTokens(chain: Chain, callback: (tokens: Array<TokenSubscribed>) => void): ISubscription;
+        /**
+         * Subscribe `New` token list's basic info changes
+         * @param chain chain id
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeNewTokensBasic(chain: Chain, callback: (tokens: Array<TokenSubscribed>) => void): ISubscription;
+        /**
+         * Subscribe `New` token list's market data changes
+         * @param chain chain id
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeNewTokensMarketData(chain: Chain, callback: (marketDatas: Array<TokenMarketData>) => void): ISubscription;
+        /**
+         * Subscribe `New` token list's stats changes
+         * @param chain chain id
+         * @param callback callback function
+         * @returns subscription
+         */
+        subscribeNewTokensStats(chain: Chain, callback: (stats: Array<TokenStats>) => void): ISubscription;
+    }
+}
+
+type NetworkId = "testnet" | "mainnet";
+
+export { API, Chain, ChainNamespace, type NetworkId, type Portfolio, type PortfolioPnl, type Token, type TokenCandle, type TokenCreator, type TokenHistoryPriceObject, type TokenHolder, type TokenLaunchedFrom, type TokenLiquidity, type TokenMarketData, type TokenMigratedTo, type TokenResolution, type TokenSecurity, type TokenSocialMedias, type TokenStats, type TokenStatsByTimeframe, type TradeActivity, type TradeDex, type TradeToken, type WalletPortfolios, _default as version };