@covalenthq/client-sdk 1.0.1 → 2.0.0

package/dist/es/services/PricingService.d.ts

@@ -1,103 +0,0 @@
-import { Chain, ChainID, Quote, Source } from "./CovalentClient";
-import { Chains } from "../util/Chains";
-declare class TokenPricesResponse {
-    /** * 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;
-    update_at: Date;
-    /** * The requested quote currency eg: `USD`. */
-    quote_currency: string;
-    /** * The contract logo URLs. */
-    logo_urls: LogoUrls;
-    /** * List of response items. */
-    prices: Price[];
-    /** * List of response items. */
-    items: Price[];
-    constructor(data: TokenPricesResponse);
-}
-declare class LogoUrls {
-    /** * The token logo URL. */
-    token_logo_url: string;
-    /** * The protocol logo URL. */
-    protocol_logo_url: string;
-    /** * The chain logo URL. */
-    chain_logo_url: string;
-    constructor(data: LogoUrls);
-}
-declare class Price {
-    contract_metadata: ContractMetadata;
-    /** * The date of the price capture. */
-    date: Date;
-    /** * The price in the requested `quote-currency`. */
-    price: number;
-    /** * A prettier version of the price for rendering purposes. */
-    pretty_price: string;
-    constructor(data: Price);
-}
-declare class 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;
-    constructor(data: ContractMetadata);
-}
-export interface GetTokenPricesQueryParamOpts {
-    /** * The start day of the historical price range (YYYY-MM-DD). */
-    from?: string;
-    /** * The end day of the historical price range (YYYY-MM-DD). */
-    to?: string;
-    /** * Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order. */
-    pricesAtAsc?: boolean;
-}
-/**
- * Pricing APIs
- *
- */
-export declare class Response<T> {
-    data: Array<T>;
-    error: boolean;
-    error_code: number;
-    error_message: string;
-}
-export declare class PricingService {
-    private apiKey;
-    private debug;
-    private threadCount;
-    private is_key_valid;
-    private enableRetry;
-    private source;
-    private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry: boolean, source: Source);
-    /**
-     *
-     * Commonly used to get historic prices of a token between date ranges. Supports native tokens.
-     *
-     * @param {string} chainName - The chain name eg: `eth-mainnet`.
-     * @param {string} quoteCurrency - The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
-     * @param {string} contractAddress - Contract address for the token. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. Supports multiple contract addresses separated by commas.
-     * @param {GetTokenPricesQueryParamOpts} queryParamOpts
-     *   - `from`: The start day of the historical price range (YYYY-MM-DD).
-     *   - `to`: The end day of the historical price range (YYYY-MM-DD).
-     *   - `pricesAtAsc`: Sort the prices in chronological ascending order. By default, it's set to `false` and returns prices in chronological descending order.
-     *
-     */
-    getTokenPrices(chainName: Chain | Chains | ChainID, quoteCurrency: Quote, contractAddress: string, queryParamOpts?: GetTokenPricesQueryParamOpts): Promise<Response<TokenPricesResponse>>;
-}
-export {};

package/dist/es/services/SecurityService.d.ts

@@ -1,162 +0,0 @@
-import { Chain, Response, ChainID, Source } from "./CovalentClient";
-import { Chains } from "../util/Chains";
-declare class ApprovalsResponse {
-    /** * 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: TokensApprovalItem[];
-    constructor(data: ApprovalsResponse);
-}
-declare class TokensApprovalItem {
-    /** * The address for the token that has approvals. */
-    token_address: string;
-    /** * The name for the token that has approvals. */
-    token_address_label: string;
-    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
-    ticker_symbol: string;
-    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
-    contract_decimals: number;
-    /** * The contract logo URL. */
-    logo_url: string;
-    /** * The exchange rate for the requested quote currency. */
-    quote_rate: number;
-    /** * Wallet balance of the token. */
-    balance: bigint | null;
-    /** * Value of the wallet balance of the token. */
-    balance_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_balance_quote: string;
-    /** * Total amount at risk across all spenders. */
-    value_at_risk: string;
-    /** * Value of total amount at risk across all spenders. */
-    value_at_risk_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_value_at_risk_quote: string;
-    /** * Contracts with non-zero approvals for this token. */
-    spenders: TokenSpenderItem[];
-    constructor(data: TokensApprovalItem);
-}
-declare class TokenSpenderItem {
-    /** * 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 block signed timestamp in UTC. */
-    block_signed_at: Date;
-    /** * Most recent transaction that updated approval amounts for the token. */
-    tx_hash: string;
-    /** * Address of the contract with approval for the token. */
-    spender_address: string;
-    /** * Name of the contract with approval for the token. */
-    spender_address_label: string;
-    /** * Remaining number of tokens granted to the spender by the approval. */
-    allowance: string;
-    /** * Value of the remaining allowance specified by the approval. */
-    allowance_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_allowance_quote: string;
-    /** * Amount at risk for spender. */
-    value_at_risk: string;
-    /** * Value of amount at risk for spender. */
-    value_at_risk_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_value_at_risk_quote: string;
-    risk_factor: string;
-    constructor(data: TokenSpenderItem);
-}
-declare class NftApprovalsResponse {
-    /** * 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;
-    /** * The requested address. */
-    address: string;
-    /** * List of response items. */
-    items: NftApprovalsItem[];
-    constructor(data: NftApprovalsResponse);
-}
-declare class NftApprovalsItem {
-    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
-    contract_address: string;
-    /** * The label of the contract address. */
-    contract_address_label: string;
-    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
-    contract_ticker_symbol: string;
-    /** * List of asset balances held by the user. */
-    token_balances: NftApprovalBalance[];
-    /** * Contracts with non-zero approvals for this token. */
-    spenders: NftApprovalSpender[];
-    constructor(data: NftApprovalsItem);
-}
-declare class NftApprovalBalance {
-    /** * The token's id. */
-    token_id: bigint | null;
-    /** * The NFT's token balance. */
-    token_balance: bigint | null;
-    constructor(data: NftApprovalBalance);
-}
-declare class NftApprovalSpender {
-    /** * 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 block signed timestamp in UTC. */
-    block_signed_at: Date;
-    /** * Most recent transaction that updated approval amounts for the token. */
-    tx_hash: string;
-    /** * Address of the contract with approval for the token. */
-    spender_address: string;
-    /** * Name of the contract with approval for the token. */
-    spender_address_label: string;
-    /** * The token ids approved. */
-    token_ids_approved: string;
-    /** * Remaining number of tokens granted to the spender by the approval. */
-    allowance: string;
-    constructor(data: NftApprovalSpender);
-}
-/**
- * Approvals API
- *
- */
-export declare class SecurityService {
-    private apiKey;
-    private debug;
-    private threadCount;
-    private is_key_valid;
-    private enableRetry;
-    private source;
-    private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry: boolean, source: Source);
-    /**
-     *
-     * Commonly used to get a list of approvals across all token contracts categorized by spenders for a wallet’s assets.
-     *
-     * @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.
-     *
-     */
-    getApprovals(chainName: Chain | Chains | ChainID, walletAddress: string): Promise<Response<ApprovalsResponse>>;
-    /**
-     *
-     * @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.
-     
-     *
-     */
-    getNftApprovals(chainName: Chain | Chains | ChainID, walletAddress: string): Promise<Response<NftApprovalsResponse>>;
-}
-export {};