@covalenthq/client-sdk 1.0.2 → 2.0.1

package/dist/cjs/{util/types/PricingServiceTypes.d.ts → src/utils/types/PricingService.types.d.ts}

@@ -1,4 +1,4 @@
-import { ContractMetadata, LogoUrls } from "./GenericTypes";
+import { type ContractMetadata, type LogoUrls } from "./Generic.types";
 export interface TokenPricesResponse {
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     contract_decimals: number;
@@ -18,8 +18,6 @@ export interface TokenPricesResponse {
     /** * The contract logo URLs. */
     logo_urls: LogoUrls;
     /** * List of response items. */
-    prices: Price[];
-    /** * List of response items. */
     items: Price[];
 }
 export interface Price {
@@ -31,3 +29,11 @@ export interface Price {
     /** * A prettier version of the price for rendering purposes. */
     pretty_price: string;
 }
+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;
+}

package/dist/{esm/util/types/SecurityServiceTypes.d.ts → cjs/src/utils/types/SecurityService.types.d.ts}

@@ -1,3 +1,4 @@
+import { type ChainID, type ChainName } from "./Generic.types";
 export interface ApprovalsResponse {
     /** * The requested address. */
     address: string;
@@ -6,9 +7,9 @@ export interface ApprovalsResponse {
     /** * 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: TokensApprovalItem[];
 }
@@ -26,7 +27,7 @@ export interface TokensApprovalItem {
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * Wallet balance of the token. */
-    balance: bigint | null;
+    balance: bigint;
     /** * Value of the wallet balance of the token. */
     balance_quote: number;
     /** * A prettier version of the quote for rendering purposes. */
@@ -73,9 +74,9 @@ export interface 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;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * The requested address. */
     address: string;
     /** * List of response items. */
@@ -95,9 +96,9 @@ export interface NftApprovalsItem {
 }
 export interface NftApprovalBalance {
     /** * The token's id. */
-    token_id: bigint | null;
+    token_id: bigint;
     /** * The NFT's token balance. */
-    token_balance: bigint | null;
+    token_balance: bigint;
 }
 export interface NftApprovalSpender {
     /** * The height of the block. */

package/dist/{esm/util/types/TransactionServiceTypes.d.ts → cjs/src/utils/types/TransactionService.types.d.ts}

@@ -1,11 +1,11 @@
-import { ContractMetadata, LogEvent, Explorer } from "./GenericTypes";
+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: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: Transaction[];
 }
@@ -33,7 +33,7 @@ export interface Transaction {
     /** * 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. */
@@ -46,7 +46,7 @@ export interface Transaction {
     /** * 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 | null;
+    fees_paid: bigint;
     /** * The gas spent in `quote-currency` denomination. */
     gas_quote: number;
     /** * A prettier version of the quote for rendering purposes. */
@@ -269,21 +269,20 @@ export interface RecentTransactionsResponse {
     /** * 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;
     /** * 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 PaginationLinks {
-    /** * URL link to the next page. */
-    prev: string;
-    /** * URL link to the previous page. */
-    next: string;
-}
 export interface TransactionsTimeBucketResponse {
     /** * The requested address. */
     address: string;
@@ -292,13 +291,18 @@ export interface TransactionsTimeBucketResponse {
     /** * 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;
     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[];
 }
@@ -306,9 +310,9 @@ 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: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    chain_name: ChainName;
     /** * List of response items. */
     items: Transaction[];
 }
@@ -318,9 +322,9 @@ export interface TransactionsSummaryResponse {
     /** * 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;
     /** * List of response items. */
     items: TransactionsSummary[];
 }
@@ -350,12 +354,17 @@ export interface TransactionsResponse {
     /** * 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;
     /** * 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[];
 }
@@ -363,10 +372,15 @@ 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: number;
+    chain_id: ChainID;
     /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: string;
+    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[];
 }
@@ -374,7 +388,7 @@ 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 | null;
+    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. */
@@ -386,3 +400,75 @@ export interface GasSummary {
     /** * 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/es/index.d.ts

@@ -1,20 +1,17 @@
-export { CovalentClient, Client, Chain, Quote, CovalentClientSettings, ChainID, Response } from "./services/CovalentClient";
-export { Response as PriceResponse } from "./services/PricingService";
-export * from "./services/BalanceService";
-export * from "./services/BaseService";
-export * from "./services/NftService";
-export * from "./services/PricingService";
-export * from "./services/SecurityService";
-export * from "./services/XykService";
-export * from "./services/TransactionService";
-export * from "./util/types/BalanceServiceTypes";
-export * from "./util/types/BaseServiceTypes";
-export * from "./util/types/NftServiceTypes";
-export * from "./util/types/PricingServiceTypes";
-export * from "./util/types/SecurityServiceTypes";
-export * from "./util/types/XykServiceTypes";
-export * from "./util/types/GenericTypes";
-export * from "./util/types/TransactionServiceTypes";
-export { calculatePrettyBalance } from "./util/CalculatePrettyBalance";
-export { prettifyCurrency } from "./util/prettifyCurrency";
-export { Chains } from "./util/Chains";
+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";