@covalenthq/client-sdk 1.0.2 → 2.0.1

package/dist/es/src/services/TransactionService.d.ts

@@ -0,0 +1,128 @@
+import { type Execution } from "../utils/functions/execution";
+import { type Chain, type GoldRushResponse } from "../utils/types/Generic.types";
+import { type GetAllTransactionsForAddressQueryParamOpts, type GetTimeBucketTransactionsForAddressQueryParamOpts, type GetTransactionQueryParamOpts, type GetTransactionSummaryQueryParamOpts, type GetTransactionsForAddressV3QueryParamOpts, type GetTransactionsForBlockHashByPageQueryParamOpts, type GetTransactionsForBlockHashQueryParamOpts, type GetTransactionsForBlockQueryParamOpts, type RecentTransactionsResponse, type TransactionResponse, type TransactionsBlockPageResponse, type TransactionsBlockResponse, type TransactionsResponse, type TransactionsSummaryResponse, type TransactionsTimeBucketResponse } from "../utils/types/TransactionService.types";
+export declare class TransactionService {
+    private execution;
+    constructor(execution: Execution);
+    /**
+     *
+     * Commonly used to fetch and render a single transaction including its decoded log events. Additionally return semantically decoded information for DEX trades, lending and NFT sales.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} txHash - The transaction hash.
+     * @param {GetTransactionQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `withDex`: Decoded DEX details including protocol (e.g. Uniswap), event (e.g 'add_liquidity') and tokens involved with historical prices. Additional 0.05 credits charged if data available.
+     *   - `withNftSales`: Decoded NFT sales details including marketplace (e.g. Opensea) and cached media links. Additional 0.05 credits charged if data available.
+     *   - `withLending`: Decoded lending details including protocol (e.g. Aave), event (e.g. 'deposit') and tokens involved with prices. Additional 0.05 credits charged if data available.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getTransaction(chainName: Chain, txHash: string, queryParamOpts?: GetTransactionQueryParamOpts): Promise<GoldRushResponse<TransactionResponse>>;
+    /**
+     *
+     * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetAllTransactionsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `blockSignedAtAsc`: Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getAllTransactionsForAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): AsyncIterable<GoldRushResponse<RecentTransactionsResponse>>;
+    /**
+     *
+     * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetAllTransactionsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `blockSignedAtAsc`: Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getAllTransactionsForAddressByPage(chainName: Chain, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<RecentTransactionsResponse>>;
+    /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {number} blockHeight - The requested block height.
+     * @param {GetTransactionsForBlockQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getTransactionsForBlock(chainName: Chain, blockHeight: number | string, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockResponse>>;
+    /**
+     *
+     * Commonly used to fetch the earliest and latest transactions, and the transaction count for a wallet. Calculate the age of the wallet and the time it has been idle and quickly gain insights into their engagement with web3.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {GetTransactionSummaryQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `withGas`: Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions.
+     *
+     */
+    getTransactionSummary(chainName: Chain, walletAddress: string, queryParamOpts?: GetTransactionSummaryQueryParamOpts): Promise<GoldRushResponse<TransactionsSummaryResponse>>;
+    /**
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {number} page - The requested page, 0-indexed.
+     * @param {GetTransactionsForAddressV3QueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `blockSignedAtAsc`: Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getTransactionsForAddressV3(chainName: Chain, walletAddress: string, page: number, queryParamOpts?: GetTransactionsForAddressV3QueryParamOpts): Promise<GoldRushResponse<TransactionsResponse>>;
+    /**
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
+     * @param {number} timeBucket - The 0-indexed 15-minute time bucket. E.g. 27 Feb 2023 05:23 GMT = 1677475383 (Unix time). 1677475383/900=1863861 timeBucket.
+     * @param {GetTimeBucketTransactionsForAddressQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getTimeBucketTransactionsForAddress(chainName: Chain, walletAddress: string, timeBucket: number, queryParamOpts?: GetTimeBucketTransactionsForAddressQueryParamOpts): Promise<GoldRushResponse<TransactionsTimeBucketResponse>>;
+    /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} blockHash - The requested block hash.
+     * @param {number} page - The requested 0-indexed page number.
+     * @param {GetTransactionsForBlockHashByPageQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getTransactionsForBlockHashByPage(chainName: Chain, blockHash: string, page: number, queryParamOpts?: GetTransactionsForBlockHashByPageQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockPageResponse>>;
+    /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+     *
+     * @param {Chain} chainName - The chain name eg: `eth-mainnet` or 1.
+     * @param {string} blockHash - The requested block hash.
+     * @param {GetTransactionsForBlockHashQueryParamOpts} queryParamOpts
+     *   - `quoteCurrency`: The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`.
+     *   - `noLogs`: Omit log events.
+     *   - `withSafe`: Include safe details.
+     *
+     */
+    getTransactionsForBlockHash(chainName: Chain, blockHash: string, queryParamOpts?: GetTransactionsForBlockHashQueryParamOpts): Promise<GoldRushResponse<TransactionsBlockResponse>>;
+}

package/dist/es/src/utils/functions/bigIntParser.d.ts

@@ -0,0 +1 @@
+export declare const bigIntParser: (val: null | undefined | string | number | bigint) => bigint | null;

package/dist/es/src/utils/functions/debugOutput.d.ts

@@ -0,0 +1,2 @@
+import { type GoldRushClientSettings } from "../types/Generic.types";
+export declare function debugOutput(settings: GoldRushClientSettings, ...content: unknown[]): Promise<void>;

package/dist/es/src/utils/functions/endpointGenerator.d.ts

@@ -0,0 +1,4 @@
+export declare const endpointGenerator: (extension?: string, params?: {
+    key: string;
+    value: boolean | null | string | number | undefined;
+}[]) => URL;

package/dist/es/src/utils/functions/execution.d.ts

@@ -0,0 +1,11 @@
+import { type GoldRushClientSettings, type GoldRushResponse } from "../types/Generic.types";
+export declare class Execution {
+    private settings;
+    private headers;
+    private maxRetries;
+    private retryDelay;
+    private enableRetry;
+    private processes;
+    constructor(settings: GoldRushClientSettings, headers: Record<string, string>);
+    execute<T>(endpoint: URL, parseData: (data: GoldRushResponse<T>) => GoldRushResponse<T>): Promise<GoldRushResponse<T>>;
+}

package/dist/es/src/utils/functions/isValidApiKey.d.ts

@@ -0,0 +1 @@
+export declare const isValidApiKey: (apiKey: string) => boolean;

package/dist/es/src/utils/functions/paginateEndpoint.d.ts

@@ -0,0 +1,7 @@
+import { type GoldRushResponse, type Pagination, type PaginationLinks } from "../types/Generic.types";
+import { type Execution } from "./execution";
+export declare function paginateEndpoint<T extends {
+    pagination: Pagination;
+} | {
+    links: PaginationLinks;
+}>(endpoint: URL, execution: Execution, parseData: (data: GoldRushResponse<T>) => GoldRushResponse<T>, implementation: "pagination" | "links"): AsyncIterable<GoldRushResponse<T>>;

package/dist/es/src/utils/functions/prettifyCurrency.d.ts

@@ -0,0 +1,2 @@
+import { type Quote } from "../types/Generic.types";
+export declare const prettifyCurrency: (value: number | bigint | string, decimals?: number, currency?: Quote, ignoreSmallValue?: boolean, ignoreMinus?: boolean, ignoreZero?: boolean) => string;

package/dist/{cjs/util/types/BalanceServiceTypes.d.ts → es/src/utils/types/BalanceService.types.d.ts}

@@ -1,11 +1,11 @@
-import { Pagination, Explorer, ContractMetadata, LogoUrls, NftCollectionAttribute } from "./GenericTypes";
+import { type ChainID, type ChainName, type ContractMetadata, type Explorer, type LogoUrls, type NftCollectionAttribute, type Pagination, type Quote } from "./Generic.types";
 export interface BalancesResponse {
     /** * The requested address. */
     address: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -39,9 +39,9 @@ export interface BalanceItem {
     /** * 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;
+    balance: bigint;
     /** * The 24h asset balance. Use `contract_decimals` to scale this balance for display purposes. */
-    balance_24h: bigint | null;
+    balance_24h: bigint;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * The 24h exchange rate for the requested quote currency. */
@@ -65,15 +65,15 @@ export interface ProtocolMetadata {
 }
 export interface BalanceNftData {
     /** * The token's id. */
-    token_id: bigint | null;
+    token_id: bigint;
     /** * The count of the number of NFTs with this ID. */
-    token_balance: bigint | null;
+    token_balance: bigint;
     /** * External URL for additional metadata. */
     token_url: string;
     /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
     supports_erc: string[];
     /** * The latest price value on chain of the token ID. */
-    token_price_wei: bigint | null;
+    token_price_wei: bigint;
     /** * The latest quote_rate of the token ID denominated in unscaled ETH. */
     token_quote_rate_eth: string;
     /** * The address of the original owner of this NFT. */
@@ -106,9 +106,9 @@ export interface PortfolioResponse {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: PortfolioItem[];
 }
@@ -136,7 +136,7 @@ export interface HoldingItem {
 }
 export interface OhlcItem {
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
-    balance: bigint | null;
+    balance: bigint;
     /** * The current balance converted to fiat in `quote-currency`. */
     quote: number;
     /** * A prettier version of the quote for rendering purposes. */
@@ -150,9 +150,9 @@ export interface Erc20TransfersResponse {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: BlockTransactionWithContractTransfers[];
     /** * Pagination metadata. */
@@ -182,7 +182,7 @@ export interface BlockTransactionWithContractTransfers {
     /** * The label of `to` address. */
     to_address_label: string;
     /** * The value attached to this tx. */
-    value: bigint | null;
+    value: bigint;
     /** * The value attached in `quote-currency` to this tx. */
     value_quote: number;
     /** * A prettier version of the quote for rendering purposes. */
@@ -195,7 +195,7 @@ export interface BlockTransactionWithContractTransfers {
     /** * 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;
+    fees_paid: bigint;
     /** * The gas spent in `quote-currency` denomination. */
     gas_quote: number;
     /** * A prettier version of the quote for rendering purposes. */
@@ -230,9 +230,9 @@ export interface TokenTransferItem {
     /** * 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;
+    delta: bigint;
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
-    balance: bigint | null;
+    balance: bigint;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * The current delta converted to fiat in `quote-currency`. */
@@ -255,9 +255,9 @@ 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: TokenHolder[];
     /** * Pagination metadata. */
@@ -279,9 +279,9 @@ export interface TokenHolder {
     /** * The requested address. */
     address: string;
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
-    balance: bigint | null;
+    balance: bigint;
     /** * Total supply of this token. */
-    total_supply: bigint | null;
+    total_supply: bigint;
     /** * The height of the block. */
     block_height: number;
 }
@@ -293,9 +293,9 @@ export interface HistoricalBalancesResponse {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: HistoricalBalanceItem[];
 }
@@ -326,7 +326,7 @@ export interface HistoricalBalanceItem {
     /** * 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;
+    balance: bigint;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * The current balance converted to fiat in `quote-currency`. */
@@ -346,9 +346,9 @@ export interface TokenBalanceNativeResponse {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: NativeBalanceItem[];
 }
@@ -368,7 +368,7 @@ export interface NativeBalanceItem {
     /** * The height of the block. */
     block_height: number;
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
-    balance: bigint | null;
+    balance: bigint;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * The current balance converted to fiat in `quote-currency`. */
@@ -376,3 +376,67 @@ export interface NativeBalanceItem {
     /** * A prettier version of the quote for rendering purposes. */
     pretty_quote: string;
 }
+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?: 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. */
+    noNftFetch?: boolean;
+    /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
+    noSpam?: boolean;
+    /** * 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. */
+    noNftAssetMetadata?: boolean;
+}
+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?: 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?: 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`. */
+    startingBlock?: number;
+    /** * The block height to end at, defaults to current block height. */
+    endingBlock?: number;
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetTokenHoldersV2ForTokenAddressQueryParamOpts {
+    /** * Ending block to define a block range. Omitting this parameter defaults to the latest block height. */
+    blockHeight?: number | string;
+    /** * Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date. */
+    date?: string;
+    /** * Number of items per page. Note: Currently, only values of `100` and `1000` are supported. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+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?: 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. */
+    noNftFetch?: boolean;
+    /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
+    noSpam?: boolean;
+    /** * 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. */
+    noNftAssetMetadata?: boolean;
+    /** * Ending block to define a block range. Omitting this parameter defaults to the latest block height. */
+    blockHeight?: number | string;
+    /** * Ending date to define a block range (YYYY-MM-DD). Omitting this parameter defaults to the current date. */
+    date?: string;
+}
+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 | string;
+}

package/dist/{esm/util/types/BaseServiceTypes.d.ts → es/src/utils/types/BaseService.types.d.ts}

@@ -1,11 +1,11 @@
-import { DecodedItem, LogEvent, Pagination } from "./GenericTypes";
+import { type ChainID, type ChainName, type DecodedItem, type LogEvent, type Pagination, type Quote } from "./Generic.types";
 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: Block[];
 }
@@ -35,9 +35,9 @@ 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: ResolvedAddressItem[];
 }
@@ -50,9 +50,9 @@ 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: BlockHeights[];
     /** * Pagination metadata. */
@@ -84,9 +84,9 @@ 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: GetLogsEvent[];
 }
@@ -130,9 +130,9 @@ 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: LogEvent[];
     /** * Pagination metadata. */
@@ -142,9 +142,9 @@ 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: LogEvent[];
     /** * Pagination metadata. */
@@ -160,7 +160,7 @@ export interface ChainItem {
     /** * The chain name eg: `eth-mainnet`. */
     name: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: string;
+    chain_id: ChainID;
     /** * True if the chain is a testnet. */
     is_testnet: boolean;
     /** * Schema name to use for direct SQL. */
@@ -206,7 +206,7 @@ export interface ChainStatusItem {
     /** * The chain name eg: `eth-mainnet`. */
     name: string;
     /** * The requested chain ID eg: `1`. */
-    chain_id: string;
+    chain_id: ChainID;
     /** * True if the chain is a testnet. */
     is_testnet: boolean;
     /** * A svg logo url for the chain. */
@@ -238,9 +238,9 @@ export interface ChainActivityEvent extends ChainItem {
 }
 export interface GasPricesResponse {
     /** * The requested chain ID eg: `1`. */
-    chain_id: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -250,7 +250,7 @@ export interface GasPricesResponse {
     /** * The exchange rate for the requested quote currency. */
     gas_quote_rate: number;
     /** * The lowest gas fee for the latest block height. */
-    base_fee: bigint | null;
+    base_fee: bigint;
     /** * List of response items. */
     items: PriceItem[];
 }
@@ -274,3 +274,53 @@ export interface OtherFees {
     /** * The calculated L1 gas spent, when applicable, in quote-currency, for the specified time interval. */
     l1_gas_quote: number;
 }
+export interface GetBlockHeightsQueryParamOpts {
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetLogsQueryParamOpts {
+    /** * The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`. */
+    startingBlock?: number;
+    /** * The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`. */
+    endingBlock?: string;
+    /** * The address of the log events sender contract. */
+    address?: string;
+    /** * The topic hash(es) to retrieve logs with. */
+    topics?: string;
+    /** * The block hash to retrieve logs for. */
+    blockHash?: string;
+    /** * Omit decoded log events. */
+    skipDecode?: boolean;
+}
+export interface GetLogEventsByAddressQueryParamOpts {
+    /** * The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`. */
+    startingBlock?: string | number;
+    /** * The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`. */
+    endingBlock?: string | number;
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetLogEventsByTopicHashQueryParamOpts {
+    /** * The first block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`. */
+    startingBlock?: string | number;
+    /** * The last block to retrieve log events with. Accepts decimals, hexadecimals, or the strings `earliest` and `latest`. */
+    endingBlock?: string | number;
+    /** * Additional topic hash(es) to filter on - padded & unpadded address fields are supported. Separate multiple topics with a comma. */
+    secondaryTopics?: string;
+    /** * Number of items per page. Omitting this parameter defaults to 100. */
+    pageSize?: number;
+    /** * 0-indexed page number to begin pagination. */
+    pageNumber?: number;
+}
+export interface GetAddressActivityQueryParamOpts {
+    /** * Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity. */
+    testnets?: boolean;
+}
+export interface GetGasPricesQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+}