@covalenthq/client-sdk 0.2.9 → 0.5.0

package/dist/services/BalanceService.d.ts

@@ -1,4 +1,4 @@
-import { Chains, Quotes, Response } from "./Client";
+import { Chain, Quote, Response } from "./CovalentClient";
 declare class BalancesResponse {
     /** * The requested address. */
     address: string;
@@ -37,12 +37,20 @@ declare class BalanceItem {
     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[];
     constructor(data: BalanceItem);
@@ -123,11 +131,29 @@ declare class HoldingItem {
 declare class 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;
     constructor(data: OhlcItem);
 }
+declare class 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;
+    constructor(data: Erc20TransfersResponse);
+}
 declare class BlockTransactionWithContractTransfers {
     /** * The block signed timestamp in UTC. */
     block_signed_at: Date;
@@ -137,10 +163,15 @@ declare class BlockTransactionWithContractTransfers {
     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;
@@ -149,7 +180,9 @@ declare class BlockTransactionWithContractTransfers {
     /** * 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;
@@ -162,14 +195,29 @@ declare class BlockTransactionWithContractTransfers {
     transfers: TokenTransferItem[];
     constructor(data: BlockTransactionWithContractTransfers);
 }
+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 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;
@@ -181,6 +229,7 @@ declare class TokenTransferItem {
     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;
@@ -188,14 +237,18 @@ declare class TokenTransferItem {
     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[];
     constructor(data: TokenTransferItem);
 }
 declare class MethodCallsForTransfers {
+    /** * The address of the sender. */
     sender_address: string;
     method: string;
     constructor(data: MethodCallsForTransfers);
@@ -275,9 +328,49 @@ declare class HistoricalBalanceItem {
     nft_data: NftData[];
     constructor(data: HistoricalBalanceItem);
 }
+declare class TokenBalanceNativeResponse {
+    /** * 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: NativeBalanceItem[];
+    constructor(data: TokenBalanceNativeResponse);
+}
+declare class NativeBalanceItem {
+    /** * 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 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;
+    constructor(data: NativeBalanceItem);
+}
 export interface GetTokenBalancesForWalletAddressQueryParamOpts {
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
-    quoteCurrency?: Quotes;
+    quoteCurrency?: Quote;
     /** * If `true`, NFTs will be included in the response. */
     nft?: boolean;
     /** * If `true`, only NFTs that have been cached will be included in the response. Helpful for faster response times. */
@@ -289,13 +382,13 @@ export interface GetTokenBalancesForWalletAddressQueryParamOpts {
 }
 export interface GetHistoricalPortfolioForWalletAddressQueryParamOpts {
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
-    quoteCurrency?: Quotes;
+    quoteCurrency?: Quote;
     /** * The number of days to return data for. Defaults to 30 days. */
     days?: number;
 }
 export interface GetErc20TransfersForWalletAddressQueryParamOpts {
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
-    quoteCurrency?: Quotes;
+    quoteCurrency?: Quote;
     /** * The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically. */
     contractAddress?: string;
     /** * The block height to start from, defaults to `0`. */
@@ -317,7 +410,7 @@ export interface GetTokenHoldersV2ForTokenAddressQueryParamOpts {
 }
 export interface GetHistoricalTokenBalancesForWalletAddressQueryParamOpts {
     /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
-    quoteCurrency?: Quotes;
+    quoteCurrency?: Quote;
     /** * If `true`, NFTs will be included in the response. */
     nft?: boolean;
     /** * If `true`, only NFTs that have been cached will be included in the response. Helpful for faster response times. */
@@ -331,14 +424,25 @@ export interface GetHistoricalTokenBalancesForWalletAddressQueryParamOpts {
     /** * Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date. */
     date?: number;
 }
+export interface GetNativeTokenBalanceQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Ending block to define a block range. Omitting this parameter defaults to the latest block height. */
+    blockHeight?: number;
+}
 /**
  * Balances APIs
  *
  */
 export declare class BalanceService {
     private apiKey;
-    constructor(apiKey: string);
+    private debug;
+    private threadCount;
+    private LIMIT;
+    constructor(apiKey: string, debug?: boolean, threadCount?: number);
     /**
+     *
+     * Commonly used to fetch the native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address. Response includes spot prices and other metadata.
      *
      * @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.
@@ -350,8 +454,10 @@ export declare class BalanceService {
      *   - `noNftAssetMetadata`: If `true`, the response shape is limited to a list of collections and token ids, omitting metadata and asset information. Helpful for faster response times and wallets holding a large number of NFTs.
      *
      */
-    getTokenBalancesForWalletAddress(chainName: Chains, walletAddress: string, queryParamOpts?: GetTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<BalancesResponse>>;
+    getTokenBalancesForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<BalancesResponse>>;
     /**
+     *
+     * Commonly used to render a daily portfolio balance for an address broken down by the token. The timeframe is user-configurable, defaults to 30 days.
      *
      * @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.
@@ -360,8 +466,26 @@ export declare class BalanceService {
      *   - `days`: The number of days to return data for. Defaults to 30 days.
      *
      */
-    getHistoricalPortfolioForWalletAddress(chainName: Chains, walletAddress: string, queryParamOpts?: GetHistoricalPortfolioForWalletAddressQueryParamOpts): Promise<Response<PortfolioResponse>>;
+    getHistoricalPortfolioForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetHistoricalPortfolioForWalletAddressQueryParamOpts): Promise<Response<PortfolioResponse>>;
+    /**
+     *
+     * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
+     *
+     * @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.
+     * @param {GetErc20TransfersForWalletAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `contractAddress`: The requested contract address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     *   - `startingBlock`: The block height to start from, defaults to `0`.
+     *   - `endingBlock`: The block height to end at, defaults to current block height.
+     *   - `pageSize`: Number of items per page. Omitting this parameter defaults to 100.
+     *   - `pageNumber`: 0-indexed page number to begin pagination.
+     *
+     */
+    getErc20TransfersForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): AsyncIterable<BlockTransactionWithContractTransfers>;
     /**
+     *
+     * Commonly used to render the transfer-in and transfer-out of a token along with historical prices from an address.
      *
      * @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.
@@ -374,8 +498,10 @@ export declare class BalanceService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getErc20TransfersForWalletAddress(chainName: Chains, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): AsyncIterable<BlockTransactionWithContractTransfers>;
+    getErc20TransfersForWalletAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts?: GetErc20TransfersForWalletAddressQueryParamOpts): Promise<Response<Erc20TransfersResponse>>;
     /**
+     *
+     * Commonly used to get a list of all the token holders for a specified ERC20 or ERC721 token. Returns historic token holders when block-height is set (defaults to `latest`). Useful for building pie charts of token holders.
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
      * @param {string} tokenAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
@@ -385,8 +511,10 @@ export declare class BalanceService {
      *   - `pageNumber`: 0-indexed page number to begin pagination.
      *
      */
-    getTokenHoldersV2ForTokenAddress(chainName: Chains, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): AsyncIterable<TokenHolder>;
+    getTokenHoldersV2ForTokenAddress(chainName: Chain, tokenAddress: string, queryParamOpts?: GetTokenHoldersV2ForTokenAddressQueryParamOpts): AsyncIterable<TokenHolder>;
     /**
+     *
+     * Commonly used to fetch the historical native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address at a given block height or date. Response includes daily prices and other metadata.
      *
      * @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.
@@ -400,6 +528,16 @@ export declare class BalanceService {
      *   - `date`: Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date.
      *
      */
-    getHistoricalTokenBalancesForWalletAddress(chainName: Chains, walletAddress: string, queryParamOpts?: GetHistoricalTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<HistoricalBalancesResponse>>;
+    getHistoricalTokenBalancesForWalletAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetHistoricalTokenBalancesForWalletAddressQueryParamOpts): Promise<Response<HistoricalBalancesResponse>>;
+    /**
+     *
+     * @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.
+     * @param {GetNativeTokenBalanceQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `blockHeight`: Ending block to define a block range. Omitting this parameter defaults to the latest block height.
+     *
+     */
+    getNativeTokenBalance(chainName: Chain, walletAddress: string, queryParamOpts?: GetNativeTokenBalanceQueryParamOpts): Promise<Response<TokenBalanceNativeResponse>>;
 }
 export {};