@covalenthq/client-sdk 0.2.8 → 0.4.2

package/dist/esm/util/backoff.d.ts

@@ -0,0 +1,11 @@
+export declare const DEFAULT_BACKOFF_MAX_RETRIES = 5;
+export declare const BASE_DELAY_MS = 1000;
+export declare class ExponentialBackoff<T> {
+    private maxRetries;
+    retryCount: number;
+    _apiKey: string;
+    _debug: boolean;
+    constructor(apiKey: string, debug: boolean, maxRetries?: number);
+    backOff(url: string): Promise<T>;
+    setNumAttempts(retryCount: number): void;
+}

package/dist/esm/util/types/BalanceServiceTypes.d.ts

@@ -0,0 +1,284 @@
+import { NftData, Pagination } from "./GenericTypes";
+export interface BalancesResponse {
+    /** * The requested address. */
+    address: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * List of response items. */
+    items: BalanceItem[];
+}
+export interface BalanceItem {
+    /** * 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: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The timestamp when the token was transferred. */
+    last_transferred_at: Date;
+    /** * Indicates if a token is the chain's native gas token, eg: ETH on Ethereum. */
+    native_token: boolean;
+    /** * One of `cryptocurrency`, `stablecoin`, `nft` or `dust`. */
+    type: string;
+    /** * Denotes whether the token is suspected spam. */
+    is_spam: boolean;
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    /** * The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance_24h: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * The 24h exchange rate for the requested quote currency. */
+    quote_rate_24h: number;
+    /** * The current balance converted to fiat in `quote-currency`. */
+    quote: number;
+    /** * The 24h balance converted to fiat in `quote-currency`. */
+    quote_24h: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
+    /** * A prettier version of the 24h quote for rendering purposes. */
+    pretty_quote_24h: string;
+    /** * NFT-specific data. */
+    nft_data: NftData[];
+}
+export interface PortfolioResponse {
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: 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: PortfolioItem[];
+}
+export interface PortfolioItem {
+    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
+    contract_address: string;
+    /** * 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;
+    /** * The contract logo URL. */
+    logo_url: string;
+    holdings: HoldingItem[];
+}
+export interface HoldingItem {
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    timestamp: Date;
+    close: OhlcItem;
+    high: OhlcItem;
+    low: OhlcItem;
+    open: OhlcItem;
+}
+export interface OhlcItem {
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    /** * The current balance converted to fiat in `quote-currency`. */
+    quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
+}
+export interface Erc20TransfersResponse {
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: 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: BlockTransactionWithContractTransfers[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+}
+export interface BlockTransactionWithContractTransfers {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    /** * The offset is the position of the tx in the block. */
+    tx_offset: number;
+    /** * Whether or not transaction is successful. */
+    successful: boolean;
+    /** * The sender's wallet address. */
+    from_address: string;
+    /** * The label of `from` address. */
+    from_address_label: string;
+    /** * The receiver's wallet address. */
+    to_address: string;
+    /** * The label of `to` address. */
+    to_address_label: string;
+    /** * The value attached to this tx. */
+    value: bigint | null;
+    /** * The value attached in `quote-currency` to this tx. */
+    value_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_value_quote: string;
+    gas_offered: number;
+    /** * The gas spent for this tx. */
+    gas_spent: number;
+    /** * The gas price at the time of this tx. */
+    gas_price: number;
+    /** * The transaction's gas_price * gas_spent, denoted in wei. */
+    fees_paid: bigint | null;
+    /** * The gas spent in `quote-currency` denomination. */
+    gas_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_gas_quote: string;
+    /** * The native gas exchange rate for the requested `quote-currency`. */
+    gas_quote_rate: number;
+    transfers: TokenTransferItem[];
+}
+export interface TokenTransferItem {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    /** * The sender's wallet address. */
+    from_address: string;
+    /** * The label of `from` address. */
+    from_address_label: string;
+    /** * The receiver's wallet address. */
+    to_address: string;
+    /** * The label of `to` address. */
+    to_address_label: string;
+    /** * 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;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * Categorizes token transactions as either `transfer-in` or `transfer-out`, indicating whether tokens are being received or sent from an account. */
+    transfer_type: string;
+    /** * The delta attached to this transfer. */
+    delta: bigint | null;
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * The current delta converted to fiat in `quote-currency`. */
+    delta_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_delta_quote: string;
+    /** * The current balance converted to fiat in `quote-currency`. */
+    balance_quote: number;
+    /** * Additional details on which transfer events were invoked. Defaults to `true`. */
+    method_calls: MethodCallsForTransfers[];
+}
+export interface MethodCallsForTransfers {
+    /** * The address of the sender. */
+    sender_address: string;
+    method: string;
+}
+export interface TokenHoldersResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * List of response items. */
+    items: TokenHolder[];
+    /** * Pagination metadata. */
+    pagination: Pagination;
+}
+export interface TokenHolder {
+    /** * 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: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The requested address. */
+    address: string;
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    /** * Total supply of this token. */
+    total_supply: bigint | null;
+    /** * The height of the block. */
+    block_height: number;
+}
+export interface HistoricalBalancesResponse {
+    /** * The requested address. */
+    address: string;
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: 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: HistoricalBalanceItem[];
+}
+export interface HistoricalBalanceItem {
+    /** * 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: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The block height when the token was last transferred. */
+    last_transferred_block_height: number;
+    /** * The timestamp when the token was transferred. */
+    last_transferred_at: Date;
+    /** * Indicates if a token is the chain's native gas token, eg: ETH on Ethereum. */
+    native_token: boolean;
+    /** * One of `cryptocurrency`, `stablecoin`, `nft` or `dust`. */
+    type: string;
+    /** * Denotes whether the token is suspected spam. */
+    is_spam: boolean;
+    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
+    balance: bigint | null;
+    /** * The exchange rate for the requested quote currency. */
+    quote_rate: number;
+    /** * The current balance converted to fiat in `quote-currency`. */
+    quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
+    /** * NFT-specific data. */
+    nft_data: NftData[];
+}

package/dist/esm/util/types/BaseServiceTypes.d.ts

@@ -0,0 +1,180 @@
+import { DecodedItem, LogEvent, Pagination } from "./GenericTypes";
+export interface BlockResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * 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[];
+}
+export interface Block {
+    /** * The block signed timestamp in UTC. */
+    signed_at: Date;
+    /** * The block height. */
+    height: number;
+}
+export interface ResolvedAddress {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * 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[];
+}
+export interface ResolvedAddressItem {
+    /** * The requested address. */
+    address: string;
+    name: string;
+}
+export interface BlockHeightsResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * 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;
+}
+export interface GetLogsResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * 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[];
+}
+export interface GetLogsEvent {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * 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;
+    /** * The offset is the position of the log entry within an event log. */
+    log_offset: number;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    /** * The log topics in raw data. */
+    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;
+    /** * The name of the sender. */
+    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;
+    /** * The address of the sender. */
+    sender_address: string;
+    /** * The label of the sender address. */
+    sender_address_label: string;
+    /** * The contract logo URL. */
+    sender_logo_url: string;
+    /** * The log events in raw. */
+    raw_log_data: string;
+    /** * The decoded item. */
+    decoded: DecodedItem;
+}
+export interface LogEventsByAddressResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * 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;
+}
+export interface LogEventsByTopicHashResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * 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;
+}
+export interface AllChainsResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * List of response items. */
+    items: ChainItem[];
+}
+export interface 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;
+}
+export interface AllChainsStatusResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * List of response items. */
+    items: ChainStatusItem[];
+}
+export interface 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: Date;
+    /** * True if the chain has data and ready for querying. */
+    has_data: boolean;
+}
+export interface ChainActivityResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested address. */
+    address: string;
+    /** * List of response items. */
+    items: ChainActivityEvent[];
+}
+export interface ChainActivityEvent extends ChainItem {
+    /** * The timestamp when the address was last seen on the chain. */
+    last_seen_at: Date;
+}

package/dist/esm/util/types/GenericTypes.d.ts

@@ -0,0 +1,96 @@
+export interface 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;
+}
+export interface NftCollectionAttribute {
+    trait_type: string;
+    value: string;
+}
+export interface NftData {
+    /** * The token's id. */
+    token_id: bigint | null;
+    token_url: string;
+    /** * The original minter. */
+    original_owner: string;
+    external_data: NftExternalData;
+    /** * If `true`, the asset data is available from the Covalent CDN. */
+    asset_cached: boolean;
+    /** * If `true`, the image data is available from the Covalent CDN. */
+    image_cached: boolean;
+}
+export interface NftExternalData {
+    name: string;
+    description: string;
+    asset_url: string;
+    asset_file_extension: string;
+    asset_mime_type: string;
+    asset_size_bytes: string;
+    image: string;
+    image_256: string;
+    image_512: string;
+    image_1024: string;
+    animation_url: string;
+    external_url: string;
+    attributes: NftCollectionAttribute[];
+}
+export interface DecodedItem {
+    name: string;
+    signature: string;
+    params: Param[];
+}
+export interface Param {
+    name: string;
+    type: string;
+    indexed: boolean;
+    decoded: boolean;
+    value: string;
+}
+export interface LogEvent {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The offset is the position of the tx in the block. */
+    tx_offset: number;
+    /** * The offset is the position of the log entry within an event log. */
+    log_offset: number;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    /** * The log topics in raw data. */
+    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;
+    /** * The name of the sender. */
+    sender_name: string;
+    sender_contract_ticker_symbol: string;
+    /** * The address of the sender. */
+    sender_address: string;
+    /** * The label of the sender address. */
+    sender_address_label: string;
+    /** * The contract logo URL. */
+    sender_logo_url: string;
+    /** * The log events in raw. */
+    raw_log_data: string;
+    /** * The decoded item. */
+    decoded: DecodedItem;
+}
+export interface ContractMetadata {
+    /** * 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: string;
+    /** * The contract logo URL. */
+    logo_url: string;
+}