@covalenthq/client-sdk 0.1.1 → 0.1.3

package/dist/services/XykService.d.ts

@@ -0,0 +1,529 @@
+import { Chains } from "./Client";
+declare class PoolResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: Pool[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: PoolResponse);
+}
+declare class Pool {
+    exchange: string;
+    swap_count_24h: string;
+    total_liquidity_quote: string;
+    volume_24h_quote: string;
+    fee_24h_quote: string;
+    /** * Total supply of this pool token. */
+    total_supply: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: string;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    volume_7d_quote: string;
+    annualized_fee: string;
+    token_0: Token;
+    token_1: Token;
+    constructor(data: Pool);
+}
+declare class Pagination {
+    /** * True is there is another page. */
+    has_more: boolean;
+    /** * The requested page number. */
+    page_number: number;
+    /** * The requested number of items on the current page. */
+    page_size: number;
+    /** * The total number of items across all pages for this request. */
+    total_count: number;
+    constructor(data: Pagination);
+}
+declare class Token {
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    volume_in_24h: string;
+    volume_out_24h: string;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: string;
+    reserve: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: string;
+    volume_in_7d: string;
+    volume_out_7d: string;
+    constructor(data: Token);
+}
+declare class PoolByAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: PoolWithTimeseries[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: PoolByAddressResponse);
+}
+declare class PoolWithTimeseries {
+    exchange: string;
+    swap_count_24h: string;
+    total_liquidity_quote: string;
+    volume_24h_quote: string;
+    fee_24h_quote: string;
+    /** * Total supply of this pool token. */
+    total_supply: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    volume_7d_quote: string;
+    annualized_fee: string;
+    token_0: Token;
+    token_1: Token;
+    token_0_reserve_quote: string;
+    token_1_reserve_quote: string;
+    volume_timeseries_7d: VolumeTimeseries[];
+    volume_timeseries_30d: VolumeTimeseries[];
+    liquidity_timeseries_7d: LiquidityTimeseries[];
+    liquidity_timeseries_30d: LiquidityTimeseries[];
+    price_timeseries_7d: PriceTimeseries[];
+    price_timeseries_30d: PriceTimeseries[];
+    constructor(data: PoolWithTimeseries);
+}
+declare class VolumeTimeseries {
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: string;
+    exchange: string;
+    sum_amount_0_in: string;
+    sum_amount_0_out: string;
+    sum_amount_1_in: string;
+    sum_amount_1_out: string;
+    volume_quote: string;
+    token_0_quote_rate: string;
+    token_1_quote_rate: string;
+    swap_count_24: string;
+    constructor(data: VolumeTimeseries);
+}
+declare class LiquidityTimeseries {
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: string;
+    exchange: string;
+    r0_c: string;
+    r1_c: string;
+    liquidity_quote: string;
+    token_0_quote_rate: string;
+    token_1_quote_rate: string;
+    constructor(data: LiquidityTimeseries);
+}
+declare class PriceTimeseries {
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: string;
+    exchange: string;
+    price_of_token_0_in_token_1: string;
+    price_of_token_0_in_token_1_description: string;
+    price_of_token_1_in_token_0: string;
+    price_of_token_1_in_token_0_description: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    price_of_token_0_in_quote_currency: string;
+    price_of_token_1_in_quote_currency: string;
+    constructor(data: PriceTimeseries);
+}
+declare class AddressExchangeBalancesResponse {
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: UniswapLikeBalanceItem[];
+    constructor(data: AddressExchangeBalancesResponse);
+}
+declare class UniswapLikeBalanceItem {
+    token_0: UniswapLikeToken;
+    token_1: UniswapLikeToken;
+    pool_token: UniswapLikeTokenWithSupply;
+    constructor(data: UniswapLikeBalanceItem);
+}
+declare class UniswapLikeToken {
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    quote: number;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    constructor(data: UniswapLikeToken);
+}
+declare class UniswapLikeTokenWithSupply {
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    quote: number;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * Total supply of this pool token. */
+    total_supply: bigint | null;
+    constructor(data: UniswapLikeTokenWithSupply);
+}
+declare class NetworkExchangeTokensResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: TokenV2Volume[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: NetworkExchangeTokensResponse);
+}
+declare class TokenV2Volume {
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    total_liquidity: number;
+    total_volume24h: number;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    swap_count_24h: number;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    total_liquidity_quote: number;
+    total_volume_24h_quote: number;
+    constructor(data: TokenV2Volume);
+}
+declare class SupportedDexesResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * List of response items. */
+    items: SupportedDex[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: SupportedDexesResponse);
+}
+declare class SupportedDex {
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    factory_contract_address: string;
+    router_contract_addresses: string;
+    swap_fee: number;
+    constructor(data: SupportedDex);
+}
+declare class SingleNetworkExchangeTokenResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: PoolWithTimeseries[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: SingleNetworkExchangeTokenResponse);
+}
+declare class TransactionsForAccountAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ExchangeTransaction[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TransactionsForAccountAddressResponse);
+}
+declare class ExchangeTransaction {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: string;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    act: string;
+    /** * The requested address. */
+    address: string;
+    amount0: number;
+    amount1: number;
+    amount0_in: number;
+    amount0_out: number;
+    amount1_out: number;
+    to_address: string;
+    from_address: string;
+    sender_address: string;
+    total_quote: number;
+    token_0: PoolToken;
+    token_1: PoolToken;
+    token_0_quote_rate: number;
+    token_1_quote_rate: number;
+    constructor(data: ExchangeTransaction);
+}
+declare class PoolToken {
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    contract_decimals: number;
+    /** * The string returned by the `name()` method. */
+    contract_name: string;
+    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
+    contract_ticker_symbol: string;
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
+    supports_erc: boolean;
+    /** * The contract logo URL. */
+    logo_url: string;
+    constructor(data: PoolToken);
+}
+declare class TransactionsForTokenAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ExchangeTransaction[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TransactionsForTokenAddressResponse);
+}
+declare class TransactionsForExchangeResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: ExchangeTransaction[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: TransactionsForExchangeResponse);
+}
+declare class EcosystemChartDataResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: UniswapLikeEcosystemCharts[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: EcosystemChartDataResponse);
+}
+declare class UniswapLikeEcosystemCharts {
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    gas_token_price_quote: number;
+    total_swaps24h: number;
+    total_active_pairs7d: number;
+    total_fees24h: number;
+    volume_chart7d: VolumeEcosystemChart[];
+    volume_chart30d: VolumeEcosystemChart[];
+    liquidity_chart7d: LiquidityEcosystemChart[];
+    liquidity_chart30d: LiquidityEcosystemChart[];
+    constructor(data: UniswapLikeEcosystemCharts);
+}
+declare class VolumeEcosystemChart {
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    volume_quote: number;
+    swap_count_24: number;
+    constructor(data: VolumeEcosystemChart);
+}
+declare class LiquidityEcosystemChart {
+    /** * The name of the DEX, eg: `uniswap`. */
+    dex_name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    dt: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    liquidity_quote: number;
+    constructor(data: LiquidityEcosystemChart);
+}
+declare class HealthDataResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: HealthData[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: HealthDataResponse);
+}
+declare class HealthData {
+    synced_block_height: number;
+    synced_block_signed_at: string;
+    latest_block_height: number;
+    latest_block_signed_at: string;
+    constructor(data: HealthData);
+}
+/**
+ * XYK APIs
+ *
+ */
+export declare class Response<T> {
+    data: T;
+    error: boolean;
+    error_code: number;
+    error_message: string;
+}
+export declare class XykService {
+    private apiKey;
+    constructor(apiKey: string);
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     *
+     */
+    getPools(chainName: Chains, dexName: string): Promise<Response<PoolResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *
+     */
+    getPoolByAddress(chainName: Chains, dexName: string, poolAddress: string): Promise<Response<PoolByAddressResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap_v2`.
+     * @param {string} accountAddress - The account address.
+     *
+     */
+    getAddressExchangeBalances(chainName: Chains, dexName: string, accountAddress: string): Promise<Response<AddressExchangeBalancesResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     *
+     */
+    getNetworkExchangeTokens(chainName: Chains, dexName: string): Promise<Response<NetworkExchangeTokensResponse>>;
+    /**
+     *
+     
+     *
+     */
+    getSupportedDEXes(): Promise<Response<SupportedDexesResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *
+     */
+    getSingleNetworkExchangeToken(chainName: Chains, dexName: string, tokenAddress: string): Promise<Response<SingleNetworkExchangeTokenResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} accountAddress - The account address. Passing in an `ENS` or `RNS` resolves automatically.
+     *
+     */
+    getTransactionsForAccountAddress(chainName: Chains, dexName: string, accountAddress: string): Promise<Response<TransactionsForAccountAddressResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} tokenAddress - The token contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *
+     */
+    getTransactionsForTokenAddress(chainName: Chains, dexName: string, tokenAddress: string): Promise<Response<TransactionsForTokenAddressResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     * @param {string} poolAddress - The pool contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *
+     */
+    getTransactionsForExchange(chainName: Chains, dexName: string, poolAddress: string): Promise<Response<TransactionsForExchangeResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     *
+     */
+    getEcosystemChartData(chainName: Chains, dexName: string): Promise<Response<EcosystemChartDataResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} dexName - The DEX name eg: `uniswap`.
+     *
+     */
+    getHealthData(chainName: Chains, dexName: string): Promise<Response<HealthDataResponse>>;
+}
+export {};