@covalenthq/client-sdk 0.2.6 → 0.2.8

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

@@ -0,0 +1,75 @@
+export interface Pagination {
+    /** * True is there is another page. */
+    has_more: boolean;
+    /** * The requested page number. */
+    page_number: number;
+    /** * The requested number of items on the current page. */
+    page_size: number;
+    /** * The total number of items across all pages for this request. */
+    total_count: number;
+}
+export interface NftCollectionAttribute {
+    trait_type: string;
+    value: string;
+}
+export interface NftData {
+    /** * The token's id. */
+    token_id: bigint | null;
+    token_url: string;
+    /** * The original minter. */
+    original_owner: string;
+    external_data: NftExternalData;
+    /** * If `true`, the asset data is available from the Covalent CDN. */
+    asset_cached: boolean;
+    /** * If `true`, the image data is available from the Covalent CDN. */
+    image_cached: boolean;
+}
+export interface NftExternalData {
+    name: string;
+    description: string;
+    asset_url: string;
+    asset_file_extension: string;
+    asset_mime_type: string;
+    asset_size_bytes: string;
+    image: string;
+    image_256: string;
+    image_512: string;
+    image_1024: string;
+    animation_url: string;
+    external_url: string;
+    attributes: NftCollectionAttribute[];
+}
+export interface DecodedItem {
+    name: string;
+    signature: string;
+    params: Param[];
+}
+export interface Param {
+    name: string;
+    type: string;
+    indexed: boolean;
+    decoded: boolean;
+    value: string;
+}
+export interface LogEvent {
+    /** * The block signed timestamp in UTC. */
+    block_signed_at: Date;
+    /** * The height of the block. */
+    block_height: number;
+    /** * The offset is the position of the tx in the block. */
+    tx_offset: number;
+    log_offset: number;
+    /** * The requested transaction hash. */
+    tx_hash: string;
+    raw_log_topics: string;
+    /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
+    sender_contract_decimals: number;
+    sender_name: string;
+    sender_contract_ticker_symbol: string;
+    sender_address: string;
+    sender_address_label: string;
+    /** * The contract logo URL. */
+    sender_logo_url: string;
+    raw_log_data: string;
+    decoded: DecodedItem;
+}

package/dist/util/types/GenericTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=GenericTypes.js.map

package/dist/util/types/GenericTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenericTypes.js","sourceRoot":"","sources":["../../../src/util/types/GenericTypes.ts"],"names":[],"mappings":""}

package/dist/util/types/NftServiceTypes.d.ts

@@ -0,0 +1,213 @@
+import { LogEvent, NftData, Pagination } from "./GenericTypes";
+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: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * 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 | null;
+    balance24h: number;
+    type: string;
+    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: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * 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;
+    successful: boolean;
+    from_address: string;
+    from_address_label: string;
+    to_address: string;
+    to_address_label: string;
+    /** * The value attached to this tx. */
+    value: bigint | null;
+    /** * 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: string;
+    gas_spent: string;
+    gas_price: string;
+    /** * The total transaction fees (gas_price * gas_spent) paid for this tx, denoted in wei. */
+    fees_paid: bigint | null;
+    /** * 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;
+    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 NftCollectionTraitSummaryResponse {
+    /** * 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 | null;
+    /** * A list of supported standard ERC interfaces, eg: `ERC20` and `ERC721`. */
+    supports_erc: string;
+    last_transfered_at: Date;
+    /** * Nft balance. */
+    balance: bigint | null;
+    balance24h: number;
+    type: string;
+    nft_data: NftData;
+}

package/dist/util/types/NftServiceTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=NftServiceTypes.js.map

package/dist/util/types/NftServiceTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NftServiceTypes.js","sourceRoot":"","sources":["../../../src/util/types/NftServiceTypes.ts"],"names":[],"mappings":""}

package/dist/util/types/PricingServiceTypes.d.ts

@@ -0,0 +1,44 @@
+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;
+    /** * List of response items. */
+    prices: Price[];
+    /** * 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 ContractMetadata {
+    /** * 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;
+}

package/dist/util/types/PricingServiceTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=PricingServiceTypes.js.map

package/dist/util/types/PricingServiceTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PricingServiceTypes.js","sourceRoot":"","sources":["../../../src/util/types/PricingServiceTypes.ts"],"names":[],"mappings":""}

package/dist/util/types/SecurityServiceTypes.d.ts

@@ -0,0 +1,70 @@
+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: number;
+    /** * The requested chain name eg: `eth-mainnet`. */
+    chain_name: string;
+    /** * 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 | null;
+    /** * 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;
+    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;
+}

package/dist/util/types/SecurityServiceTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SecurityServiceTypes.js.map

package/dist/util/types/SecurityServiceTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecurityServiceTypes.js","sourceRoot":"","sources":["../../../src/util/types/SecurityServiceTypes.ts"],"names":[],"mappings":""}