@covalenthq/client-sdk 2.3.8 → 3.0.0

package/dist/src/utils/types/NftService.types.d.ts

@@ -1,28 +1,4 @@
-import { type ChainID, type ChainName, type LogEvent, type NftData, type Nullable, type Pagination, type Quote } from "./Generic.types";
-export type ChainCollectionResponse = Nullable<{
-    /** * 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: ChainCollectionItem[];
-    /** * Pagination metadata. */
-    pagination: Pagination;
-}>;
-export type ChainCollectionItem = Nullable<{
-    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
-    contract_address: string;
-    /** * The string returned by the `name()` method. */
-    contract_name: string;
-    /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
-    is_spam: boolean;
-    token_total_supply: number;
-    cached_metadata_count: number;
-    cached_asset_count: number;
-    last_scraped_at: Date;
-}>;
+import { type NftData, type Nullable } from "./Generic.types";
 export type NftAddressBalanceNftResponse = Nullable<{
     /** * The requested address. */
     address: string;
@@ -55,146 +31,6 @@ export type NftTokenContractBalanceItem = Nullable<{
     floor_price_native_quote: number;
     nft_data: NftData[];
 }>;
-export type NftMetadataResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftTokenContract[];
-    /** * Pagination metadata. */
-    pagination: Pagination;
-}>;
-export type NftTokenContract = Nullable<{
-    /** * The string returned by the `name()` method. */
-    contract_name: string;
-    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
-    contract_ticker_symbol: string;
-    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
-    contract_address: string;
-    /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
-    is_spam: boolean;
-    type: string;
-    nft_data: NftData;
-}>;
-export type NftTransactionsResponse = Nullable<{
-    /** * 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: NftTransaction[];
-}>;
-export type NftTransaction = Nullable<{
-    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
-    contract_decimals: number;
-    /** * The string returned by the `name()` method. */
-    contract_name: string;
-    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
-    contract_ticker_symbol: string;
-    /** * The contract logo URL. */
-    logo_url: string;
-    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
-    contract_address: string;
-    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string[];
-    nft_transactions: NftTransactionItem[];
-    /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
-    is_spam: boolean;
-}>;
-export type NftTransactionItem = Nullable<{
-    /** * The block signed timestamp in UTC. */
-    block_signed_at: Date;
-    /** * The height of the block. */
-    block_height: number;
-    /** * The requested transaction hash. */
-    tx_hash: string;
-    /** * The offset is the position of the tx in the block. */
-    tx_offset: number;
-    /** * Whether or not transaction is successful. */
-    successful: boolean;
-    /** * The sender's wallet address. */
-    from_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;
-    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;
-    gas_quote_rate: number;
-    /** * The log events. */
-    log_events: LogEvent[];
-}>;
-export type NftCollectionTraitsResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftTrait[];
-}>;
-export type NftTrait = Nullable<{
-    name: string;
-}>;
-export type NftCollectionAttributesForTraitResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftSummaryAttribute[];
-}>;
-export type NftSummaryAttribute = Nullable<{
-    trait_type: string;
-    values: NftAttribute[];
-    unique_values: number;
-}>;
-export type NftAttribute = Nullable<{
-    value: string;
-    count: number;
-}>;
-export type NftCollectionTraitsSummaryResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftTraitSummary[];
-}>;
-export type NftTraitSummary = Nullable<{
-    /** * Trait name */
-    name: string;
-    /** * Type of the value of the trait. */
-    value_type: string;
-    /** * Populated for `numeric` traits. */
-    value_numeric: NftTraitNumeric;
-    /** * Populated for `string` traits. */
-    value_string: NftTraitString;
-    attributes: NftSummaryAttribute[];
-}>;
-export type NftTraitNumeric = Nullable<{
-    min: number;
-    max: number;
-}>;
-export type NftTraitString = Nullable<{
-    /** * String value */
-    value: string;
-    /** * Number of distinct tokens that have this trait value. */
-    token_count: number;
-    /** * Percentage of tokens in the collection that have this trait. */
-    trait_percentage: number;
-}>;
 export type NftOwnershipForCollectionResponse = Nullable<{
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -225,45 +61,11 @@ export type NftOwnershipForCollectionItem = Nullable<{
     type: string;
     nft_data: NftData;
 }>;
-export type GetChainCollectionsQueryParamOpts = Nullable<{
-    /** * Number of items per page. Omitting this parameter defaults to 100. */
-    pageSize?: number;
-    /** * 0-indexed page number to begin pagination. */
-    pageNumber?: number;
-    /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
-    noSpam?: boolean;
-}>;
 export type GetNftsForAddressQueryParamOpts = Nullable<{
     /** * 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;
-    /** * By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side. */
-    withUncached?: boolean;
-}>;
-export type GetTokenIdsForContractWithMetadataQueryParamOpts = Nullable<{
-    /** * Omit metadata. */
-    noMetadata?: boolean;
-    /** * Number of items per page. Omitting this parameter defaults to 100. */
-    pageSize?: number;
-    /** * 0-indexed page number to begin pagination. */
-    pageNumber?: number;
-    /** * Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding. */
-    traitsFilter?: string;
-    /** * Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. If used with "traits-filter", only NFTs matching both filters will be returned. Accepts comma-separated values, is case-sensitive, and requires proper URL encoding. */
-    valuesFilter?: string;
-    /** * By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side. */
-    withUncached?: boolean;
-}>;
-export type GetNftMetadataForGivenTokenIdForContractQueryParamOpts = Nullable<{
-    /** * Omit metadata. */
-    noMetadata?: boolean;
-    /** * By default, this endpoint only works on chains where we've cached the assets and the metadata. When set to `true`, the API will fetch metadata from upstream servers even if it's not cached - the downside being that the upstream server can block or rate limit the call and therefore resulting in time outs or slow response times on the Covalent side. */
-    withUncached?: boolean;
-}>;
-export type GetNftTransactionsForContractTokenIdQueryParamOpts = Nullable<{
-    /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
-    noSpam?: boolean;
 }>;
 export type CheckOwnershipInNftQueryParamOpts = Nullable<{
     /** * Filters NFTs based on a specific trait. If this filter is used, the API will return all NFTs with the specified trait. Must be used with "values-filter", is case-sensitive, and requires proper URL encoding. */
@@ -271,85 +73,3 @@ export type CheckOwnershipInNftQueryParamOpts = Nullable<{
     /** * Filters NFTs based on a specific trait value. If this filter is used, the API will return all NFTs with the specified trait value. Must be used with "traits-filter", is case-sensitive, and requires proper URL encoding. */
     valuesFilter?: string;
 }>;
-export type GetCollectionMarketDataQueryParamOpts = Nullable<{
-    /** * The requested quote currency eg: `USD`. */
-    quote_currency?: Quote;
-    /** The number of days to return data for. Request up 365 days. Defaults to 30 days. */
-    days?: number;
-}>;
-export type NftCollectionFloorPriceResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** The requested address. */
-    address: string;
-    /** * The requested quote currency eg: `USD`. */
-    quote_currency: Quote;
-    /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: ChainName;
-    /** * The requested chain ID eg: `1`. */
-    chain_id: ChainID;
-    /** * List of response items. */
-    items: NftCollectionFloorPriceItem[];
-}>;
-export type NftCollectionFloorPriceItem = Nullable<{
-    /** * The timestamp of the date of sale. */
-    date: Date;
-    /** * The ticker symbol for the native currency. */
-    native_ticker_symbol: string;
-    /** * The contract name of the native currency. */
-    native_name: string;
-    /** * The current floor price in native currency. */
-    floor_price_native_quote: number;
-    /** * The current floor price converted to fiat in quote-currency. */
-    floor_price_quote: number;
-    /** * A prettier version of the floor price quote for rendering purposes. */
-    pretty_floor_price_quote: string;
-}>;
-export type NftCollectionVolumeResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** The requested address. */
-    address: string;
-    /** * The requested quote currency eg: `USD`. */
-    quote_currency: Quote;
-    /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: ChainName;
-    /** * The requested chain ID eg: `1`. */
-    chain_id: ChainID;
-    /** * List of response items. */
-    items: NftCollectionVolumeItem[];
-}>;
-export type NftCollectionVolumeItem = Nullable<{
-    /** * The timestamp of the date of sale. */
-    date: Date;
-    /** * The ticker symbol for the native currency. */
-    native_ticker_symbol: string;
-    /** * The contract name of the native currency. */
-    native_name: string;
-    /** * The current volume converted to fiat in `quoteCurrency`. */
-    volume_quote: number;
-    /** * The current volume in native currency. */
-    volume_native_quote: number;
-    /** * A prettier version of the volume quote for rendering purposes. */
-    pretty_volume_quote: string;
-}>;
-export type NftCollectionSalesCountResponse = Nullable<{
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** The requested address. */
-    address: string;
-    /** * The requested quote currency eg: `USD`. */
-    quote_currency: Quote;
-    /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: ChainName;
-    /** * The requested chain ID eg: `1`. */
-    chain_id: ChainID;
-    /** * List of response items. */
-    items: NftCollectionSalesCountItem[];
-}>;
-export type NftCollectionSalesCountItem = Nullable<{
-    /** * The timestamp of the date of sale. */
-    date: Date;
-    /** * The total amount of sales for the current day. */
-    sales_count: string;
-}>;

package/dist/src/utils/types/SecurityService.types.d.ts

@@ -70,55 +70,3 @@ export type TokenSpenderItem = Nullable<{
     pretty_value_at_risk_quote: string;
     risk_factor: string;
 }>;
-export type NftApprovalsResponse = Nullable<{
-    /** * 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;
-    /** * The requested address. */
-    address: string;
-    /** * List of response items. */
-    items: NftApprovalsItem[];
-}>;
-export type NftApprovalsItem = Nullable<{
-    /** * Use the relevant `contract_address` to lookup prices, logos, token transfers, etc. */
-    contract_address: string;
-    /** * The label of the contract address. */
-    contract_address_label: string;
-    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
-    contract_ticker_symbol: string;
-    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string[];
-    /** * List of asset balances held by the user. */
-    token_balances: NftApprovalBalance[];
-    /** * Contracts with non-zero approvals for this token. */
-    spenders: NftApprovalSpender[];
-}>;
-export type NftApprovalBalance = Nullable<{
-    /** * The token's id. */
-    token_id: bigint;
-    /** * The NFT's token balance. */
-    token_balance: bigint;
-}>;
-export type NftApprovalSpender = Nullable<{
-    /** * The height of the block. */
-    block_height: number;
-    /** * The offset is the position of the tx in the block. */
-    tx_offset: number;
-    /** * The offset is the position of the log entry within an event log." */
-    log_offset: number;
-    /** * The block signed timestamp in UTC. */
-    block_signed_at: Date;
-    /** * Most recent transaction that updated approval amounts for the token. */
-    tx_hash: string;
-    /** * Address of the contract with approval for the token. */
-    spender_address: string;
-    /** * Name of the contract with approval for the token. */
-    spender_address_label: string;
-    /** * The token ids approved. */
-    token_ids_approved: string;
-    /** * Remaining number of tokens granted to the spender by the approval. */
-    allowance: string;
-}>;

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

@@ -314,6 +314,8 @@ export type GetTransactionSummaryQueryParamOpts = Nullable<{
     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;
+    /** * Represents the total count of ERC-20 token movement events, including `Transfer`, `Deposit` and `Withdraw`. Response times may be impacted for wallets with large number of transactions. Additional charge of 3 credits. */
+    withTransferCount?: boolean;
 }>;
 export type InternalTransfer = Nullable<{
     /** * The contract address sending the native token. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@covalenthq/client-sdk",
-  "version": "2.3.8",
+  "version": "3.0.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -23,20 +23,13 @@
     "@rollup/plugin-commonjs": "^25.0.4",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.1",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/big.js": "^6.2.2",
     "@types/jest": "^29.5.5",
     "@types/node": "^20",
     "@types/ws": "^8.18.1",
-    "@typescript-eslint/eslint-plugin": "^7.7.1",
-    "@typescript-eslint/parser": "^7.7.1",
     "dotenv": "^16.4.5",
-    "eslint": "^8",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.6.1",
     "p-limit": "^3.1.0",
-    "prettier": "^3.3.2",
     "rimraf": "^6.0.1",
     "rollup": "^3.29.1",
     "rollup-plugin-typescript2": "^0.35.0",
@@ -68,8 +61,9 @@
     "clean": "rimraf dist",
     "start": "rollup -c",
     "lint": "eslint .",
-    "pretty": "prettier . --write",
-    "sync-docs": "ts-node --project s/tsconfig.json s/sync-docs/index.ts",
-    "sync-docs:check": "ts-node --project s/tsconfig.json s/sync-docs/index.ts --check"
+    "format": "prettier --ignore-path ../../.prettierignore --write .",
+    "format:check": "prettier --ignore-path ../../.prettierignore --check .",
+    "sync-docs": "ts-node --project ../../s/tsconfig.json ../../s/sync-docs/index.ts",
+    "sync-docs:check": "ts-node --project ../../s/tsconfig.json ../../s/sync-docs/index.ts --check"
   }
 }