@covalenthq/client-sdk 0.6.2 → 0.6.3

package/dist/cjs/services/BalanceService.d.ts

@@ -212,6 +212,8 @@ declare class BlockTransactionWithContractTransfers {
     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[];
     transfers: TokenTransferItem[];
     constructor(data: BlockTransactionWithContractTransfers);
 }
@@ -226,6 +228,13 @@ declare class Pagination {
     total_count: number;
     constructor(data: Pagination);
 }
+declare class Explorer {
+    /** * The name of the explorer. */
+    label: string;
+    /** * The URL of the explorer. */
+    url: string;
+    constructor(data: Explorer);
+}
 declare class TokenTransferItem {
     /** * The block signed timestamp in UTC. */
     block_signed_at: Date;

package/dist/cjs/services/CovalentClient.d.ts

@@ -21,7 +21,7 @@ export type Chains = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-main
  * CovalentClient Class
  */
 export type Quotes = "USD" | "CAD" | "EUR" | "SGD" | "INR" | "JPY" | "VND" | "CNY" | "KRW" | "RUB" | "TRY" | "NGN" | "ARS" | "AUD" | "CHF" | "GBP";
-export declare const userAgent = "com.covalenthq.sdk.typescript/0.6.2";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.6.3";
 export declare class Response<T> {
     data: T;
     error: boolean;

package/dist/cjs/services/TransactionService.d.ts

@@ -54,6 +54,8 @@ declare class Transaction {
     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. */
@@ -81,6 +83,13 @@ declare class ContractMetadata {
     logo_url: string;
     constructor(data: ContractMetadata);
 }
+declare class Explorer {
+    /** * The name of the explorer. */
+    label: string;
+    /** * The URL of the explorer. */
+    url: string;
+    constructor(data: Explorer);
+}
 declare class DexReport {
     /** * The offset is the position of the log entry within an event log. */
     log_offset: number;
@@ -324,6 +333,30 @@ declare class Param {
     value: string;
     constructor(data: Param);
 }
+declare class RecentTransactionsResponse {
+    private _debug;
+    private _apiKey;
+    private _threadCount;
+    private _urlParams;
+    /** * 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;
+    /** * The current page of the response. */
+    current_page: number;
+    links: PaginationLinks;
+    /** * List of response items. */
+    items: Transaction[];
+    constructor(data: RecentTransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams);
+    prev(): Promise<Response<RecentTransactionsResponse>>;
+    next(): Promise<Response<RecentTransactionsResponse>>;
+}
 declare class PaginationLinks {
     /** * URL link to the next page. */
     prev: string;
@@ -374,6 +407,10 @@ declare class TransactionSummary {
     constructor(data: TransactionSummary);
 }
 declare class TransactionsResponse {
+    private _debug;
+    private _apiKey;
+    private _threadCount;
+    private _urlParams;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -389,7 +426,9 @@ declare class TransactionsResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: TransactionsResponse);
+    constructor(data: TransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams);
+    prev(): Promise<Response<TransactionsResponse>>;
+    next(): Promise<Response<TransactionsResponse>>;
 }
 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`. */
@@ -469,6 +508,20 @@ export declare class TransactionService {
      *
      */
     getAllTransactionsForAddress(chainName: Chain, walletAddress: string, queryParamOpts?: GetAllTransactionsForAddressQueryParamOpts): AsyncIterable<Transaction>;
+    /**
+     *
+     * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
+     *
+     * @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 {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<Response<RecentTransactionsResponse>>;
     /**
      *
      * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.

package/dist/cjs/util/types/BalanceServiceTypes.d.ts

@@ -1,4 +1,4 @@
-import { NftData, Pagination } from "./GenericTypes";
+import { NftData, Pagination, Explorer } from "./GenericTypes";
 export interface BalancesResponse {
     /** * The requested address. */
     address: string;
@@ -169,6 +169,8 @@ export interface BlockTransactionWithContractTransfers {
     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[];
     transfers: TokenTransferItem[];
 }
 export interface TokenTransferItem {

package/dist/cjs/util/types/GenericTypes.d.ts

@@ -94,3 +94,9 @@ export interface ContractMetadata {
     /** * The contract logo URL. */
     logo_url: string;
 }
+export interface Explorer {
+    /** * The name of the explorer. */
+    label: string;
+    /** * The URL of the explorer. */
+    url: string;
+}

package/dist/cjs/util/types/TransactionServiceTypes.d.ts

@@ -1,4 +1,4 @@
-import { ContractMetadata, LogEvent } from "./GenericTypes";
+import { ContractMetadata, LogEvent, Explorer } from "./GenericTypes";
 export interface TransactionResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -53,6 +53,8 @@ export interface Transaction {
     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. */

package/dist/es/index.js

@@ -657,6 +657,7 @@ class BlockTransactionWithContractTransfers {
         this.gas_quote = data.gas_quote;
         this.pretty_gas_quote = data.pretty_gas_quote;
         this.gas_quote_rate = data.gas_quote_rate;
+        this.explorers = data.explorers && data.explorers !== null ? data.explorers.map((itemData) => new Explorer$1(itemData)) : null;
         this.transfers = data.transfers && data.transfers !== null ? data.transfers.map((itemData) => new TokenTransferItem(itemData)) : null;
     }
 }
@@ -668,6 +669,12 @@ let Pagination$3 = class Pagination {
         this.total_count = data.total_count;
     }
 };
+let Explorer$1 = class Explorer {
+    constructor(data) {
+        this.label = data.label;
+        this.url = data.url;
+    }
+};
 class TokenTransferItem {
     constructor(data) {
         this.block_signed_at = data.block_signed_at && data.block_signed_at !== null ? parseISO(data.block_signed_at.toString()) : null;
@@ -3876,6 +3883,7 @@ class Transaction {
         this.pretty_gas_quote = data.pretty_gas_quote;
         this.gas_quote_rate = data.gas_quote_rate;
         this.gas_metadata = data.gas_metadata && data.gas_metadata !== null ? new ContractMetadata(data.gas_metadata) : null;
+        this.explorers = data.explorers && data.explorers !== null ? data.explorers.map((itemData) => new Explorer(itemData)) : null;
         this.dex_details = data.dex_details && data.dex_details !== null ? new DexReport(data.dex_details) : null;
         this.nft_sale_details = data.nft_sale_details && data.nft_sale_details !== null ? new NftSalesReport(data.nft_sale_details) : null;
         this.lending_details = data.lending_details && data.lending_details !== null ? new LendingReport(data.lending_details) : null;
@@ -3893,6 +3901,12 @@ class ContractMetadata {
         this.logo_url = data.logo_url;
     }
 }
+class Explorer {
+    constructor(data) {
+        this.label = data.label;
+        this.url = data.url;
+    }
+}
 class DexReport {
     constructor(data) {
         this.log_offset = data.log_offset;
@@ -4050,6 +4064,154 @@ class Param {
         this.value = data.value;
     }
 }
+class RecentTransactionsResponse {
+    constructor(data, _debug, _apiKey, _threadCount, _urlParams) {
+        this._debug = _debug;
+        this._apiKey = _apiKey;
+        this._threadCount = _threadCount;
+        this._urlParams = _urlParams;
+        this.address = data.address;
+        this.updated_at = data.updated_at && data.updated_at !== null ? parseISO(data.updated_at.toString()) : null;
+        this.quote_currency = data.quote_currency;
+        this.chain_id = data.chain_id;
+        this.chain_name = data.chain_name;
+        this.current_page = data.current_page;
+        this.links = data.links && data.links !== null ? new PaginationLinks(data.links) : null;
+        this.items = data.items && data.items !== null ? data.items.map((itemData) => new Transaction(itemData)) : null;
+    }
+    async prev() {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this._apiKey, this._debug);
+        const LIMIT = pLimit$1(this._threadCount);
+        while (!success) {
+            try {
+                let startTime;
+                if (this._debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                if (this.links.prev === null) {
+                    success = true;
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 400,
+                        error_message: "Invalid URL: URL link cannot be null"
+                    };
+                }
+                response = await LIMIT(() => fetch(`${this.links.prev}?${this._urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this._apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status, startTime);
+                if (response.status === 429) {
+                    try {
+                        data = await LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new RecentTransactionsResponse(data.data, this._debug, this._apiKey, this._threadCount, this._urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
+    async next() {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this._apiKey, this._debug);
+        const LIMIT = pLimit$1(this._threadCount);
+        while (!success) {
+            try {
+                let startTime;
+                if (this._debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                if (this.links.next === null) {
+                    success = true;
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 400,
+                        error_message: "Invalid URL: URL link cannot be null"
+                    };
+                }
+                response = await LIMIT(() => fetch(`${this.links.next}?${this._urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this._apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status, startTime);
+                if (response.status === 429) {
+                    try {
+                        data = await LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new RecentTransactionsResponse(data.data, this._debug, this._apiKey, this._threadCount, this._urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
+}
 class PaginationLinks {
     constructor(data) {
         this.prev = data.prev;
@@ -4088,7 +4250,11 @@ class TransactionSummary {
     }
 }
 class TransactionsResponse {
-    constructor(data) {
+    constructor(data, _debug, _apiKey, _threadCount, _urlParams) {
+        this._debug = _debug;
+        this._apiKey = _apiKey;
+        this._threadCount = _threadCount;
+        this._urlParams = _urlParams;
         this.address = data.address;
         this.updated_at = data.updated_at && data.updated_at !== null ? parseISO(data.updated_at.toString()) : null;
         this.quote_currency = data.quote_currency;
@@ -4098,6 +4264,138 @@ class TransactionsResponse {
         this.links = data.links && data.links !== null ? new PaginationLinks(data.links) : null;
         this.items = data.items && data.items !== null ? data.items.map((itemData) => new Transaction(itemData)) : null;
     }
+    async prev() {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this._apiKey, this._debug);
+        const LIMIT = pLimit$1(this._threadCount);
+        while (!success) {
+            try {
+                let startTime;
+                if (this._debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                if (this.links.prev === null) {
+                    success = true;
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 400,
+                        error_message: "Invalid URL: URL link cannot be null"
+                    };
+                }
+                response = await LIMIT(() => fetch(`${this.links.prev}?${this._urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this._apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status, startTime);
+                if (response.status === 429) {
+                    try {
+                        data = await LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new TransactionsResponse(data.data, this._debug, this._apiKey, this._threadCount, this._urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
+    async next() {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this._apiKey, this._debug);
+        const LIMIT = pLimit$1(this._threadCount);
+        while (!success) {
+            try {
+                let startTime;
+                if (this._debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                if (this.links.next === null) {
+                    success = true;
+                    return {
+                        data: null,
+                        error: true,
+                        error_code: 400,
+                        error_message: "Invalid URL: URL link cannot be null"
+                    };
+                }
+                response = await LIMIT(() => fetch(`${this.links.next}?${this._urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this._apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status, startTime);
+                if (response.status === 429) {
+                    try {
+                        data = await LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new TransactionsResponse(data.data, this._debug, this._apiKey, this._threadCount, this._urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
 }
 /**
  * Transactions APIs
@@ -4298,6 +4596,88 @@ class TransactionService {
             }
         }
     }
+    /**
+     *
+     * Commonly used to fetch and render the most recent transactions involving an address. Frequently seen in wallet applications.
+     *
+     * @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 {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.
+     *
+     */
+    async getAllTransactionsForAddressByPage(chainName, walletAddress, queryParamOpts) {
+        let success = false;
+        let data;
+        let response;
+        const backoff = new ExponentialBackoff(this.apiKey, this.debug);
+        while (!success) {
+            try {
+                const urlParams = new URLSearchParams();
+                if (queryParamOpts?.quoteCurrency !== undefined) {
+                    urlParams.append("quote-currency", queryParamOpts?.quoteCurrency.toString());
+                }
+                if (queryParamOpts?.noLogs !== undefined) {
+                    urlParams.append("no-logs", queryParamOpts?.noLogs.toString());
+                }
+                if (queryParamOpts?.blockSignedAtAsc !== undefined) {
+                    urlParams.append("block-signed-at-asc", queryParamOpts?.blockSignedAtAsc.toString());
+                }
+                if (queryParamOpts?.withSafe !== undefined) {
+                    urlParams.append("with-safe", queryParamOpts?.withSafe.toString());
+                }
+                let startTime;
+                if (this.debug) {
+                    startTime = typeof performance !== 'undefined' ? performance.now() : process.hrtime();
+                }
+                response = await this.LIMIT(() => fetch(`https://api.covalenthq.com/v1/${chainName}/address/${walletAddress}/transactions_v3/?${urlParams}`, {
+                    headers: {
+                        "Authorization": `Bearer ${this.apiKey}`,
+                        "X-Requested-With": userAgent
+                    }
+                }));
+                debugOutput(response.url, response.status, startTime);
+                if (response.status === 429) {
+                    try {
+                        data = await this.LIMIT(() => backoff.backOff(response.url));
+                    }
+                    catch (error) {
+                        success = true;
+                        return {
+                            data: null,
+                            error: true,
+                            error_code: response.status,
+                            error_message: error.message
+                        };
+                    }
+                }
+                else {
+                    data = await response.json();
+                }
+                const dataClass = new RecentTransactionsResponse(data.data, this.debug, this.apiKey, this.threadCount, urlParams);
+                checkAndModifyResponse(dataClass);
+                success = true;
+                return {
+                    data: dataClass,
+                    error: data.error,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+            catch (error) {
+                success = true;
+                return {
+                    data: null,
+                    error: true,
+                    error_code: data ? data.error_code : response.status,
+                    error_message: data ? data.error_message : response.status === 500 ? "Internal server error" : "401 Authorization Required"
+                };
+            }
+        }
+    }
     /**
      *
      * Commonly used to fetch all transactions including their decoded log events in a block and further flag interesting wallets or transactions.
@@ -4501,7 +4881,7 @@ class TransactionService {
                 else {
                     data = await response.json();
                 }
-                const dataClass = new TransactionsResponse(data.data);
+                const dataClass = new TransactionsResponse(data.data, this.debug, this.apiKey, this.threadCount, urlParams);
                 checkAndModifyResponse(dataClass);
                 success = true;
                 return {
@@ -5866,7 +6246,7 @@ class XykService {
     }
 }
 
-const userAgent = "com.covalenthq.sdk.typescript/0.6.2";
+const userAgent = "com.covalenthq.sdk.typescript/0.6.3";
 /**
  * CovalentClient Class
  */