@covalenthq/client-sdk 2.0.0 → 2.0.1

package/dist/es/src/utils/types/TransactionService.types.d.ts

@@ -0,0 +1,474 @@
+import { type ChainID, type ChainName, type ContractMetadata, type Explorer, type GoldRushResponse, type LogEvent, type PaginationLinks, type Quote } from "./Generic.types";
+export interface TransactionResponse {
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * List of response items. */
+    items: Transaction[];
+}
+export interface Transaction {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The hash of the block. Use it to remove transactions from re-org-ed blocks. */
+    block_hash: string;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    /** * The offset is the position of the tx in the block. */
+    tx_offset: number;
+    /** * Indicates whether a transaction failed or succeeded. */
+    successful: boolean;
+    /** * The sender's wallet address. */
+    from_address: string;
+    /** * The address of the miner. */
+    miner_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;
+    /** * 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;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+    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 total transaction fees (`gas_price` * `gas_spent`) paid for this tx, denoted in wei. */
+    fees_paid: bigint;
+    /** * 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;
+    /** * The explorer links for this transaction. */
+    explorers: Explorer[];
+    /** * The details for the dex transaction. */
+    dex_details: DexReport[];
+    /** * The details for the NFT sale transaction. */
+    nft_sale_details: NftSalesReport[];
+    /** * The details for the lending protocol transaction. */
+    lending_details: LendingReport[];
+    /** * The log events. */
+    log_events: LogEvent[];
+    /** * The details related to the safe transaction. */
+    safe_details: SafeDetails[];
+}
+export interface DexReport {
+    /** * The offset is the position of the log entry within an event log. */
+    log_offset: number;
+    /** * Stores the name of the protocol that facilitated the event. */
+    protocol_name: string;
+    /** * Stores the contract address of the protocol that facilitated the event. */
+    protocol_address: string;
+    /** * The protocol logo URL. */
+    protocol_logo_url: string;
+    /** * Stores the aggregator responsible for the event. */
+    aggregator_name: string;
+    /** * Stores the contract address of the aggregator responsible for the event. */
+    aggregator_address: string;
+    /** * DEXs often have multiple version - e.g Uniswap V1, V2 and V3. The `version` field allows you to look at a specific version of the DEX. */
+    version: number;
+    /** * Similarly to the `version` field, `fork_version` gives you the version of the forked DEX. For example, most DEXs are a fork of Uniswap V2; therefore, `fork` = `aave` & `fork_version` = `2` */
+    fork_version: number;
+    /** * Many DEXs are a fork of an already established DEX. The fork field allows you to see which DEX has been forked. */
+    fork: string;
+    /** * Stores the event taking place - e.g `swap`, `add_liquidity` and `remove_liquidity`. */
+    event: string;
+    /** * Stores the address of the pair that the user interacts with. */
+    pair_address: string;
+    pair_lp_fee_bps: number;
+    lp_token_address: string;
+    lp_token_ticker: string;
+    lp_token_num_decimals: number;
+    lp_token_name: string;
+    lp_token_value: string;
+    exchange_rate_usd: number;
+    /** * Stores the address of token 0 in the specific pair. */
+    token_0_address: string;
+    /** * Stores the ticker symbol of token 0 in the specific pair. */
+    token_0_ticker: string;
+    /** * Stores the number of contract decimals of token 0 in the specific pair. */
+    token_0_num_decimals: number;
+    /** * Stores the contract name of token 0 in the specific pair. */
+    token_0_name: string;
+    /** * Stores the address of token 1 in the specific pair. */
+    token_1_address: string;
+    /** * Stores the ticker symbol of token 1 in the specific pair. */
+    token_1_ticker: string;
+    /** * Stores the number of contract decimals of token 1 in the specific pair. */
+    token_1_num_decimals: number;
+    /** * Stores the contract name of token 1 in the specific pair. */
+    token_1_name: string;
+    /** * Stores the amount of token 0 used in the transaction. For example, 1 ETH, 100 USDC, 30 UNI, etc. */
+    token_0_amount: string;
+    token_0_quote_rate: number;
+    token_0_usd_quote: number;
+    pretty_token_0_usd_quote: string;
+    token_0_logo_url: string;
+    /** * Stores the amount of token 1 used in the transaction. For example, 1 ETH, 100 USDC, 30 UNI, etc. */
+    token_1_amount: string;
+    token_1_quote_rate: number;
+    token_1_usd_quote: number;
+    pretty_token_1_usd_quote: string;
+    token_1_logo_url: string;
+    /** * Stores the wallet address that initiated the transaction (i.e the wallet paying the gas fee). */
+    sender: string;
+    /** * Stores the recipient of the transaction - recipients can be other wallets or smart contracts. For example, if you want to Swap tokens on Uniswap, the Uniswap router would typically be the recipient of the transaction. */
+    recipient: string;
+}
+export interface NftSalesReport {
+    /** * The offset is the position of the log entry within an event log. */
+    log_offset: number;
+    /** * Stores the topic event hash. All events have a unique topic event hash. */
+    topic0: string;
+    /** * Stores the contract address of the protocol that facilitated the event. */
+    protocol_contract_address: string;
+    /** * Stores the name of the protocol that facilitated the event. */
+    protocol_name: string;
+    /** * The protocol logo URL. */
+    protocol_logo_url: string;
+    /** * Stores the address of the transaction recipient. */
+    to: string;
+    /** * Stores the address of the transaction sender. */
+    from: string;
+    /** * Stores the address selling the NFT. */
+    maker: string;
+    /** * Stores the address buying the NFT. */
+    taker: string;
+    /** * Stores the NFTs token ID. All NFTs have a token ID. Within a collection, these token IDs are unique. If the NFT is transferred to another owner, the token id remains the same, as this number is its identifier within a collection. For example, if a collection has 10K NFTs then an NFT in that collection can have a token ID from 1-10K. */
+    token_id: string;
+    /** * Stores the address of the collection. For example, [Bored Ape Yacht Club](https://etherscan.io/token/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d) */
+    collection_address: string;
+    /** * Stores the name of the collection. */
+    collection_name: string;
+    /** * Stores the address of the token used to purchase the NFT. */
+    token_address: string;
+    /** * Stores the name of the token used to purchase the NFT. */
+    token_name: string;
+    /** * Stores the ticker symbol of the token used to purchase the NFT. */
+    ticker_symbol: string;
+    /** * Stores the number decimal of the token used to purchase the NFT. */
+    num_decimals: number;
+    contract_quote_rate: number;
+    /** * The token amount used to purchase the NFT. For example, if the user purchased an NFT for 1 ETH. The `nft_token_price` field will hold `1`. */
+    nft_token_price: number;
+    /** * The USD amount used to purchase the NFT. */
+    nft_token_price_usd: number;
+    pretty_nft_token_price_usd: string;
+    /** * The price of the NFT denominated in the chains native token. Even if a seller sells their NFT for DAI or MANA, this field denominates the price in the native token (e.g. ETH, AVAX, FTM, etc.) */
+    nft_token_price_native: number;
+    pretty_nft_token_price_native: string;
+    /** * Stores the number of NFTs involved in the sale. It's quick routine to see multiple NFTs involved in a single sale. */
+    token_count: number;
+    num_token_ids_sold_per_sale: number;
+    num_token_ids_sold_per_tx: number;
+    num_collections_sold_per_sale: number;
+    num_collections_sold_per_tx: number;
+    trade_type: string;
+    trade_group_type: string;
+}
+export interface LendingReport {
+    /** * The offset is the position of the log entry within an event log. */
+    log_offset: number;
+    /** * Stores the name of the lending protocol that facilitated the event. */
+    protocol_name: string;
+    /** * Stores the contract address of the lending protocol that facilitated the event. */
+    protocol_address: string;
+    /** * The protocol logo URL. */
+    protocol_logo_url: string;
+    /** * Lending protocols often have multiple version (e.g. Aave V1, V2 and V3). The `version` field allows you to look at a specific version of the Lending protocol. */
+    version: string;
+    /** * Many lending protocols are a fork of an already established protocol. The fork column allows you to see which lending protocol has been forked. */
+    fork: string;
+    /** * Similarly to the `version` column, `fork_version` gives you the version of the forked lending protocol. For example, most lending protocols in the space are a fork of Aave V2; therefore, `fork` = `aave` & `fork_version` = `2` */
+    fork_version: string;
+    /** * Stores the event taking place - e.g `borrow`, `deposit`, `liquidation`, 'repay' and 'withdraw'. */
+    event: string;
+    /** * Stores the name of the LP token issued by the lending protocol. LP tokens can be debt or interest bearing tokens. */
+    lp_token_name: string;
+    /** * Stores the number decimal of the LP token. */
+    lp_decimals: number;
+    /** * Stores the ticker symbol of the LP token. */
+    lp_ticker_symbol: string;
+    /** * Stores the token address of the LP token. */
+    lp_token_address: string;
+    /** * Stores the amount of LP token used in the event (e.g. 1 aETH, 100 cUSDC, etc). */
+    lp_token_amount: number;
+    /** * Stores the total USD amount of all the LP Token used in the event. */
+    lp_token_price: number;
+    /** * Stores the exchange rate between the LP and underlying token. */
+    exchange_rate: number;
+    /** * Stores the USD price of the LP Token used in the event. */
+    exchange_rate_usd: number;
+    /** * Stores the name of the token going into the lending protocol (e.g the token getting deposited). */
+    token_name_in: string;
+    /** * Stores the number decimal of the token going into the lending protocol. */
+    token_decimal_in: number;
+    /** * Stores the address of the token going into the lending protocol. */
+    token_address_in: string;
+    /** * Stores the ticker symbol of the token going into the lending protocol. */
+    token_ticker_in: string;
+    /** * Stores the logo URL of the token going into the lending protocol. */
+    token_logo_in: string;
+    /** * Stores the amount of tokens going into the lending protocol (e.g 1 ETH, 100 USDC, etc). */
+    token_amount_in: number;
+    /** * Stores the total USD amount of all tokens going into the lending protocol. */
+    amount_in_usd: number;
+    pretty_amount_in_usd: string;
+    /** * Stores the name of the token going out of the lending protocol (e.g the token getting deposited). */
+    token_name_out: string;
+    /** * Stores the number decimal of the token going out of the lending protocol. */
+    token_decimals_out: number;
+    /** * Stores the address of the token going out of the lending protocol. */
+    token_address_out: string;
+    /** * Stores the ticker symbol of the token going out of the lending protocol. */
+    token_ticker_out: string;
+    /** * Stores the logo URL of the token going out of the lending protocol. */
+    token_logo_out: string;
+    /** * Stores the amount of tokens going out of the lending protocol (e.g 1 ETH, 100 USDC, etc). */
+    token_amount_out: number;
+    /** * Stores the total USD amount of all tokens going out of the lending protocol. */
+    amount_out_usd: number;
+    pretty_amount_out_usd: string;
+    /** * Stores the type of loan the user is taking out. Lending protocols enable you to take out a stable or variable loan. Only relevant to borrow events. */
+    borrow_rate_mode: number;
+    /** * Stores the interest rate of the loan. Only relevant to borrow events. */
+    borrow_rate: number;
+    on_behalf_of: string;
+    /** * Stores the wallet address liquidating the loan. Only relevant to liquidation events. */
+    liquidator: string;
+    /** * Stores the wallet address of the user initiating the event. */
+    user: string;
+}
+export interface SafeDetails {
+    /** * The address that signed the safe transaction. */
+    owner_address: string;
+    /** * The signature of the owner for the safe transaction. */
+    signature: string;
+    /** * The type of safe signature used. */
+    signature_type: string;
+}
+export interface RecentTransactionsResponse {
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * The current page of the response. */
+    current_page: number;
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<RecentTransactionsResponse>>) | null;
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<RecentTransactionsResponse>>) | null;
+    /** * List of response items. */
+    items: Transaction[];
+}
+export interface TransactionsTimeBucketResponse {
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    complete: boolean;
+    /** * The current bucket of the response. */
+    current_bucket: number;
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<TransactionsTimeBucketResponse>>) | null;
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<TransactionsTimeBucketResponse>>) | null;
+    /** * List of response items. */
+    items: Transaction[];
+}
+export interface TransactionsBlockResponse {
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * List of response items. */
+    items: Transaction[];
+}
+export interface TransactionsSummaryResponse {
+    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
+    updated_at: Date;
+    /** * The requested address. */
+    address: string;
+    /** * The requested chain ID eg: `1`. */
+    chain_id: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * List of response items. */
+    items: TransactionsSummary[];
+}
+export interface TransactionsSummary {
+    /** * The total number of transactions. */
+    total_count: number;
+    /** * The earliest transaction detected. */
+    earliest_transaction: TransactionSummary;
+    /** * The latest transaction detected. */
+    latest_transaction: TransactionSummary;
+    /** * The gas summary for the transactions. */
+    gas_summary: GasSummary;
+}
+export interface TransactionSummary {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    /** * The link to the transaction details using the Covalent API. */
+    tx_detail_link: string;
+}
+export interface TransactionsResponse {
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * The current page of the response. */
+    current_page: number;
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<TransactionsResponse>>) | null;
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<TransactionsResponse>>) | null;
+    /** * List of response items. */
+    items: Transaction[];
+}
+export interface TransactionsBlockPageResponse {
+    /** * 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: ChainID;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: ChainName;
+    /** * URL link to the next and prev pages. */
+    links: PaginationLinks;
+    /** * An executable async function for the next page. */
+    next: (() => Promise<GoldRushResponse<TransactionsBlockPageResponse>>) | null;
+    /** * An executable async function for the prev page. */
+    prev: (() => Promise<GoldRushResponse<TransactionsBlockPageResponse>>) | null;
+    /** * List of response items. */
+    items: Transaction[];
+}
+export interface GasSummary {
+    /** * The total number of transactions sent by the address. */
+    total_sent_count: number;
+    /** * The total transaction fees paid by the address, denoted in wei. */
+    total_fees_paid: bigint;
+    /** * The total transaction fees paid by the address, denoted in `quote-currency`. */
+    total_gas_quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_total_gas_quote: string;
+    /** * The average gas quote per transaction. */
+    average_gas_quote_per_tx: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_average_gas_quote_per_tx: string;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+}
+export interface GetTransactionQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * 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. */
+    withDex?: boolean;
+    /** * Decoded NFT sales details including marketplace (e.g. Opensea) and cached media links. Additional 0.05 credits charged if data available. */
+    withNftSales?: boolean;
+    /** * 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. */
+    withLending?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetAllTransactionsForAddressQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order. */
+    blockSignedAtAsc?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetTransactionsForBlockQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetTransactionsForAddressV3QueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * Sort the transactions in ascending chronological order. By default, it's set to `false` and returns transactions in descending chronological order. */
+    blockSignedAtAsc?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetTimeBucketTransactionsForAddressQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetTransactionsForBlockHashByPageQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetTransactionsForBlockHashQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Omit log events. */
+    noLogs?: boolean;
+    /** * Include safe details. */
+    withSafe?: boolean;
+}
+export interface GetTransactionSummaryQueryParamOpts {
+    /** * The currency to convert. Supports `USD`, `CAD`, `EUR`, `SGD`, `INR`, `JPY`, `VND`, `CNY`, `KRW`, `RUB`, `TRY`, `NGN`, `ARS`, `AUD`, `CHF`, and `GBP`. */
+    quoteCurrency?: Quote;
+    /** * Include gas summary details. Additional charge of 1 credit when true. Response times may be impacted for wallets with millions of transactions. */
+    withGas?: boolean;
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,17 @@
+export { 
+/**
+ * @deprecated Please use `GoldRushClient` going forward!
+ * `CovalentClient` will be removed after Aug 30, 2024.
+ */
+GoldRushClient as CovalentClient, GoldRushClient, } from "./src/GoldRushClient";
+export { bigIntParser } from "./src/utils/functions/bigIntParser";
+export { calculatePrettyBalance } from "./src/utils/functions/calculatePrettyBalance";
+export { isValidApiKey } from "./src/utils/functions/isValidApiKey";
+export { prettifyCurrency } from "./src/utils/functions/prettifyCurrency";
+export * from "./src/utils/types/BalanceService.types";
+export * from "./src/utils/types/BaseService.types";
+export * from "./src/utils/types/Generic.types";
+export * from "./src/utils/types/NftService.types";
+export * from "./src/utils/types/PricingService.types";
+export * from "./src/utils/types/SecurityService.types";
+export * from "./src/utils/types/TransactionService.types";