@covalenthq/client-sdk 2.0.1 → 2.0.2

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

@@ -1,273 +0,0 @@
-import { type ChainID, type ChainName, type LogEvent, type NftData, type Pagination } from "./Generic.types";
-export interface ChainCollectionResponse {
-    /** * 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 interface ChainCollectionItem {
-    /** * 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;
-}
-export interface NftAddressBalanceNftResponse {
-    /** * The requested address. */
-    address: string;
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftTokenContractBalanceItem[];
-}
-export interface NftTokenContractBalanceItem {
-    /** * 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;
-    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string[];
-    /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
-    is_spam: boolean;
-    last_transfered_at: Date;
-    /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
-    balance: bigint;
-    balance_24h: bigint;
-    type: string;
-    /** * The current floor price converted to fiat in `quote-currency`. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on. */
-    floor_price_quote: number;
-    /** * A prettier version of the floor price quote for rendering purposes. */
-    pretty_floor_price_quote: string;
-    /** * The current floor price in native currency. The floor price is determined by the last minimum sale price within the last 30 days across all the supported markets where the collection is sold on. */
-    floor_price_native_quote: number;
-    nft_data: NftData[];
-}
-export interface NftMetadataResponse {
-    /** * 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 interface NftTokenContract {
-    /** * 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 interface NftTransactionsResponse {
-    /** * 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 interface NftTransaction {
-    /** * 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 interface NftTransactionItem {
-    /** * 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 interface NftCollectionTraitsResponse {
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftTrait[];
-}
-export interface NftTrait {
-    name: string;
-}
-export interface NftCollectionAttributesForTraitResponse {
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftSummaryAttribute[];
-}
-export interface NftSummaryAttribute {
-    trait_type: string;
-    values: NftAttribute[];
-    unique_values: number;
-}
-export interface NftAttribute {
-    value: string;
-    count: number;
-}
-export interface NftCollectionTraitsSummaryResponse {
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * List of response items. */
-    items: NftTraitSummary[];
-}
-export interface NftTraitSummary {
-    /** * 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 interface NftTraitNumeric {
-    min: number;
-    max: number;
-}
-export interface NftTraitString {
-    /** * 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 interface NftOwnershipForCollectionResponse {
-    /** * The timestamp when the response was generated. Useful to show data staleness to users. */
-    updated_at: Date;
-    /** * The requested address. */
-    address: string;
-    /** * The requested collection. */
-    collection: string;
-    /** * Denotes whether the token is suspected spam. Supports `eth-mainnet` and `matic-mainnet`. */
-    is_spam: boolean;
-    /** * List of response items. */
-    items: NftOwnershipForCollectionItem[];
-}
-export interface NftOwnershipForCollectionItem {
-    /** * 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;
-    /** * The token's id. */
-    token_id: bigint;
-    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string[];
-    last_transfered_at: Date;
-    /** * Nft balance. */
-    balance: bigint;
-    balance_24h: bigint;
-    type: string;
-    nft_data: NftData;
-}
-export interface GetChainCollectionsQueryParamOpts {
-    /** * 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 interface GetNftsForAddressQueryParamOpts {
-    /** * 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 interface GetTokenIdsForContractWithMetadataQueryParamOpts {
-    /** * 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 interface GetNftMetadataForGivenTokenIdForContractQueryParamOpts {
-    /** * 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 interface GetNftTransactionsForContractTokenIdQueryParamOpts {
-    /** * If `true`, the suspected spam tokens are removed. Supports `eth-mainnet` and `matic-mainnet`. */
-    noSpam?: boolean;
-}
-export interface CheckOwnershipInNftQueryParamOpts {
-    /** * 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. */
-    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. Must be used with "traits-filter", is case-sensitive, and requires proper URL encoding. */
-    valuesFilter?: string;
-}

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

@@ -1,39 +0,0 @@
-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;
-    /** * 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;
-    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
-    supports_erc: string[];
-    /** * The contract logo URL. */
-    logo_url: string;
-    update_at: Date;
-    /** * The requested quote currency eg: `USD`. */
-    quote_currency: string;
-    /** * The contract logo URLs. */
-    logo_urls: LogoUrls;
-    /** * List of response items. */
-    items: Price[];
-}
-export interface Price {
-    contract_metadata: ContractMetadata;
-    /** * The date of the price capture. */
-    date: Date;
-    /** * The price in the requested `quote-currency`. */
-    price: number;
-    /** * 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/es/src/utils/types/SecurityService.types.d.ts

@@ -1,122 +0,0 @@
-import { type ChainID, type ChainName } from "./Generic.types";
-export interface ApprovalsResponse {
-    /** * 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;
-    /** * List of response items. */
-    items: TokensApprovalItem[];
-}
-export interface TokensApprovalItem {
-    /** * The address for the token that has approvals. */
-    token_address: string;
-    /** * The name for the token that has approvals. */
-    token_address_label: string;
-    /** * The ticker symbol for this contract. This field is set by a developer and non-unique across a network. */
-    ticker_symbol: string;
-    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
-    contract_decimals: number;
-    /** * The contract logo URL. */
-    logo_url: string;
-    /** * The exchange rate for the requested quote currency. */
-    quote_rate: number;
-    /** * Wallet balance of the token. */
-    balance: bigint;
-    /** * Value of the wallet balance of the token. */
-    balance_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_balance_quote: string;
-    /** * Total amount at risk across all spenders. */
-    value_at_risk: string;
-    /** * Value of total amount at risk across all spenders. */
-    value_at_risk_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_value_at_risk_quote: string;
-    /** * Contracts with non-zero approvals for this token. */
-    spenders: TokenSpenderItem[];
-}
-export interface TokenSpenderItem {
-    /** * 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;
-    /** * Remaining number of tokens granted to the spender by the approval. */
-    allowance: string;
-    /** * Value of the remaining allowance specified by the approval. */
-    allowance_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_allowance_quote: string;
-    /** * Amount at risk for spender. */
-    value_at_risk: string;
-    /** * Value of amount at risk for spender. */
-    value_at_risk_quote: number;
-    /** * A prettier version of the quote for rendering purposes. */
-    pretty_value_at_risk_quote: string;
-    risk_factor: string;
-}
-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: ChainID;
-    /** * The requested chain name eg: `eth-mainnet`. */
-    chain_name: ChainName;
-    /** * The requested address. */
-    address: string;
-    /** * List of response items. */
-    items: NftApprovalsItem[];
-}
-export interface NftApprovalsItem {
-    /** * 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;
-    /** * List of asset balances held by the user. */
-    token_balances: NftApprovalBalance[];
-    /** * Contracts with non-zero approvals for this token. */
-    spenders: NftApprovalSpender[];
-}
-export interface NftApprovalBalance {
-    /** * The token's id. */
-    token_id: bigint;
-    /** * The NFT's token balance. */
-    token_balance: bigint;
-}
-export interface NftApprovalSpender {
-    /** * 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;
-}