@covalenthq/client-sdk 0.7.6 → 0.8.1

package/dist/services/TransactionService.d.ts

@@ -1,4 +1,4 @@
-import { Chain, Quote, Response } from "./CovalentClient";
+import { Chain, Quote, Response, ChainID, Source } from "./CovalentClient";
 import { Chains } from "../util/Chains";
 declare class TransactionResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -340,6 +340,7 @@ declare class RecentTransactionsResponse {
     private _threadCount;
     private _urlParams;
     private _enableRetry;
+    private _source;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -355,7 +356,7 @@ declare class RecentTransactionsResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: RecentTransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean);
+    constructor(data: RecentTransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean, _source: Source);
     prev(): Promise<Response<RecentTransactionsResponse>>;
     next(): Promise<Response<RecentTransactionsResponse>>;
 }
@@ -366,6 +367,26 @@ declare class PaginationLinks {
     next: string;
     constructor(data: PaginationLinks);
 }
+declare class TransactionsBlockPageResponse {
+    private _debug;
+    private _apiKey;
+    private _threadCount;
+    private _urlParams;
+    private _enableRetry;
+    private _source;
+    /** * 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;
+    links: PaginationLinks;
+    /** * List of response items. */
+    items: Transaction[];
+    constructor(data: TransactionsBlockPageResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean, _source: Source);
+    prev(): Promise<Response<TransactionsBlockPageResponse>>;
+    next(): Promise<Response<TransactionsBlockPageResponse>>;
+}
 declare class TransactionsBlockResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -414,6 +435,7 @@ declare class TransactionsResponse {
     private _threadCount;
     private _urlParams;
     private _enableRetry;
+    private _source;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -429,7 +451,7 @@ declare class TransactionsResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: TransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean);
+    constructor(data: TransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean, _source: Source);
     prev(): Promise<Response<TransactionsResponse>>;
     next(): Promise<Response<TransactionsResponse>>;
 }
@@ -439,6 +461,7 @@ declare class TransactionsTimeBucketResponse {
     private _threadCount;
     private _urlParams;
     private _enableRetry;
+    private _source;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -455,7 +478,7 @@ declare class TransactionsTimeBucketResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: TransactionsTimeBucketResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean);
+    constructor(data: TransactionsTimeBucketResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean, _source: Source);
     prev(): Promise<Response<TransactionsTimeBucketResponse>>;
     next(): Promise<Response<TransactionsTimeBucketResponse>>;
 }
@@ -509,14 +532,31 @@ export interface GetTimeBucketTransactionsForAddressQueryParamOpts {
     /** * 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 declare class TransactionService {
     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);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry: boolean, source: Source);
     /**
      *
      * 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.
@@ -532,7 +572,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransaction(chainName: Chain | Chains, txHash: string, queryParamOpts?: GetTransactionQueryParamOpts): Promise<Response<TransactionResponse>>;
+    getTransaction(chainName: Chain | Chains | ChainID, txHash: string, queryParamOpts?: GetTransactionQueryParamOpts): Promise<Response<TransactionResponse>>;
     /**
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
@@ -546,7 +586,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getAllTransactionsForAddress(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): AsyncIterable<Transaction>;
+    getAllTransactionsForAddress(chainName: Chain | Chains | ChainID, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): AsyncIterable<Transaction>;
     /**
      *
      * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
@@ -560,7 +600,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getAllTransactionsForAddressByPage(chainName: Chain | Chains, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): Promise<Response<RecentTransactionsResponse>>;
+    getAllTransactionsForAddressByPage(chainName: Chain | Chains | ChainID, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): Promise<Response<RecentTransactionsResponse>>;
     /**
      *
      * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
@@ -573,7 +613,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransactionsForBlock(chainName: Chain | Chains, blockHeight: number, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<Response<TransactionsBlockResponse>>;
+    getTransactionsForBlock(chainName: Chain | Chains | ChainID, blockHeight: number | string, queryParamOpts?: GetTransactionsForBlockQueryParamOpts): Promise<Response<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.
@@ -582,7 +622,7 @@ export declare class TransactionService {
      * @param {string} walletAddress - The requested address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.
      *
      */
-    getTransactionSummary(chainName: Chain | Chains, walletAddress: string): Promise<Response<TransactionsSummaryResponse>>;
+    getTransactionSummary(chainName: Chain | Chains | ChainID, walletAddress: string): Promise<Response<TransactionsSummaryResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -595,7 +635,7 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTransactionsForAddressV3(chainName: Chain | Chains, walletAddress: string, page: number, queryParamOpts?: GetTransactionsForAddressV3QueryParamOpts): Promise<Response<TransactionsResponse>>;
+    getTransactionsForAddressV3(chainName: Chain | Chains | ChainID, walletAddress: string, page: number, queryParamOpts?: GetTransactionsForAddressV3QueryParamOpts): Promise<Response<TransactionsResponse>>;
     /**
      *
      * @param {string} chainName - The chain name eg: `eth-mainnet`.
@@ -607,6 +647,33 @@ export declare class TransactionService {
      *   - `withSafe`: Include safe details.
      *
      */
-    getTimeBucketTransactionsForAddress(chainName: Chain | Chains, walletAddress: string, timeBucket: number, queryParamOpts?: GetTimeBucketTransactionsForAddressQueryParamOpts): Promise<Response<TransactionsTimeBucketResponse>>;
+    getTimeBucketTransactionsForAddress(chainName: Chain | Chains | ChainID, walletAddress: string, timeBucket: number, queryParamOpts?: GetTimeBucketTransactionsForAddressQueryParamOpts): Promise<Response<TransactionsTimeBucketResponse>>;
+    /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @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 | Chains | ChainID, blockHash: string, page: number, queryParamOpts?: GetTransactionsForBlockHashByPageQueryParamOpts): Promise<Response<TransactionsBlockPageResponse>>;
+    /**
+     *
+     * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
+     *
+     * @param {string} chainName - The chain name eg: `eth-mainnet`.
+     * @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<Response<TransactionsBlockResponse>>;
 }
 export {};