@covalenthq/client-sdk 0.1.1 → 0.1.3

package/dist/services/BaseService.d.ts

@@ -0,0 +1,303 @@
+import { Chains } from "./Client";
+declare class BlockResponse {
+    /** * 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: Block[];
+    constructor(data: BlockResponse);
+}
+declare class Block {
+    /** * The block signed timestamp in UTC. */
+    signed_at: string;
+    /** * The block height. */
+    height: number;
+    constructor(data: Block);
+}
+declare class ResolvedAddress {
+    /** * 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: ResolvedAddressItem[];
+    constructor(data: ResolvedAddress);
+}
+declare class ResolvedAddressItem {
+    address: string;
+    name: string;
+    constructor(data: ResolvedAddressItem);
+}
+declare class BlockHeightsResponse {
+    /** * 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: Block[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: BlockHeightsResponse);
+}
+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 GetLogsResponse {
+    /** * 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: GetLogsEvent[];
+    constructor(data: GetLogsResponse);
+}
+declare class GetLogsEvent {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: string;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The hash of the block. */
+    block_hash: string;
+    /** * The offset is the position of the tx in the block. */
+    tx_offset: number;
+    log_offset: number;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    raw_log_topics: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    sender_contract_decimals: number;
+    sender_name: string;
+    /** * The ticker symbol for the sender. This field is set by a developer and non-unique across a network. */
+    sender_contract_ticker_symbol: string;
+    sender_address: string;
+    sender_address_label: string;
+    /** * The contract logo URL. */
+    sender_logo_url: string;
+    raw_log_data: string;
+    decoded: DecodedItem;
+    constructor(data: GetLogsEvent);
+}
+declare class DecodedItem {
+    name: string;
+    signature: string;
+    params: Param[];
+    constructor(data: DecodedItem);
+}
+declare class Param {
+    name: string;
+    type: string;
+    indexed: boolean;
+    decoded: boolean;
+    value: string;
+    constructor(data: Param);
+}
+declare class LogEventsByAddressResponse {
+    /** * 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: LogEvent[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: LogEventsByAddressResponse);
+}
+declare class LogEvent {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: string;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The offset is the position of the tx in the block. */
+    tx_offset: number;
+    log_offset: number;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    raw_log_topics: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    sender_contract_decimals: number;
+    sender_name: string;
+    sender_contract_ticker_symbol: string;
+    sender_address: string;
+    sender_address_label: string;
+    /** * The contract logo URL. */
+    sender_logo_url: string;
+    raw_log_data: string;
+    decoded: DecodedItem;
+    constructor(data: LogEvent);
+}
+declare class LogEventsByTopicHashResponse {
+    /** * 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: LogEvent[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+    constructor(data: LogEventsByTopicHashResponse);
+}
+declare class AllChainsResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * List of response items. */
+    items: ChainItem[];
+    constructor(data: AllChainsResponse);
+}
+declare class ChainItem {
+    /** * The chain name eg: `eth-mainnet`. */
+    name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * True if the chain is a testnet. */
+    is_testnet: boolean;
+    /** * Schema name to use for direct SQL. */
+    db_schema_name: string;
+    /** * The chains label eg: `Ethereum Mainnet`. */
+    label: string;
+    /** * The category label eg: `Ethereum`. */
+    category_label: string;
+    /** * A svg logo url for the chain. */
+    logo_url: string;
+    /** * A black png logo url for the chain. */
+    black_logo_url: string;
+    /** * A white png logo url for the chain. */
+    white_logo_url: string;
+    /** * True if the chain is an AppChain. */
+    is_appchain: boolean;
+    /** * The ChainItem the appchain is a part of. */
+    appchain_of: ChainItem;
+    constructor(data: ChainItem);
+}
+declare class AllChainsStatusResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: string;
+    /** * List of response items. */
+    items: ChainStatusItem[];
+    constructor(data: AllChainsStatusResponse);
+}
+declare class ChainStatusItem {
+    /** * The chain name eg: `eth-mainnet`. */
+    name: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: string;
+    /** * True if the chain is a testnet. */
+    is_testnet: boolean;
+    /** * A svg logo url for the chain. */
+    logo_url: boolean;
+    /** * A black png logo url for the chain. */
+    black_logo_url: string;
+    /** * A white png logo url for the chain. */
+    white_logo_url: string;
+    /** * True if the chain is an AppChain. */
+    is_appchain: boolean;
+    /** * The height of the lastest block available. */
+    synced_block_height: number;
+    /** * The signed timestamp of lastest block available. */
+    synced_blocked_signed_at: string;
+    /** * True if the chain has data and ready for querying. */
+    has_data: boolean;
+    constructor(data: ChainStatusItem);
+}
+/**
+ * Class A - Base
+ *
+ */
+export declare class Response<T> {
+    data: T;
+    error: boolean;
+    error_code: number;
+    error_message: string;
+}
+export declare class BaseService {
+    private apiKey;
+    constructor(apiKey: string);
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} blockHeight - The block height or `latest` for the latest block available.
+     *
+     */
+    getBlock(chainName: Chains, blockHeight: string): Promise<Response<BlockResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *
+     */
+    getResolvedAddress(chainName: Chains, walletAddress: string): Promise<Response<ResolvedAddress>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} startDate - The start date in YYYY-MM-DD format.
+     * @param {string} endDate - The end date in YYYY-MM-DD format.
+     *
+     */
+    getBlockHeights(chainName: Chains, startDate: string, endDate: string): Promise<Response<BlockHeightsResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {number} startingBlock - The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     * @param {string} endingBlock - The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     * @param {string} address - The address of the log events sender contract.
+     * @param {string} topics - The topic hash(es) to retrieve logs with.
+     * @param {string} blockHash - The block hash to retrieve logs for.
+     * @param {boolean} skipDecode - Omit decoded log events.
+     *
+     */
+    getLogs(chainName: Chains, startingBlock?: number, endingBlock?: string, address?: string, topics?: string, blockHash?: string, skipDecode?: boolean): Promise<Response<GetLogsResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} contractAddress - The endpoint will return event logs emitted from this contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {number} startingBlock - The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     * @param {string} endingBlock - The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     *
+     */
+    getLogEventsByAddress(chainName: Chains, contractAddress: string, startingBlock?: number, endingBlock?: string): Promise<Response<LogEventsByAddressResponse>>;
+    /**
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @param {string} topicHash - The endpoint will return event logs that contain this topic hash.
+     * @param {number} startingBlock - The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     * @param {string} endingBlock - The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`.
+     * @param {string} secondaryTopics - Additional topic hash(es) to filter on - padded & unpadded address fields are supported.
+     *
+     */
+    getLogEventsByTopicHash(chainName: Chains, topicHash: string, startingBlock?: number, endingBlock?: string, secondaryTopics?: string): Promise<Response<LogEventsByTopicHashResponse>>;
+    /**
+     *
+     
+     *
+     */
+    getAllChains(): Promise<Response<AllChainsResponse>>;
+    /**
+     *
+     
+     *
+     */
+    getAllChainStatus(): Promise<Response<AllChainsStatusResponse>>;
+}
+export {};