@covalenthq/client-sdk 0.7.5 → 0.7.6

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

@@ -484,8 +484,9 @@ export declare class BalanceService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * Commonly used to fetch the native, fungible (ERC20), and non-fungible (ERC721 & ERC1155) tokens held by an address. Response includes spot prices and other metadata.

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

@@ -364,8 +364,9 @@ export declare class BaseService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * Commonly used to fetch and render a single block for a block explorer.

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

@@ -7,11 +7,11 @@ import { TransactionService } from "./TransactionService";
 import { XykService } from "./XykService";
 export type Chain = "btc-mainnet" | "eth-mainnet" | "matic-mainnet" | "bsc-mainnet" | "avalanche-mainnet" | "optimism-mainnet" | "fantom-mainnet" | "moonbeam-mainnet" | "moonbeam-moonriver" | "rsk-mainnet" | "arbitrum-mainnet" | "palm-mainnet" | "klaytn-mainnet" | "heco-mainnet" | "nervos-godwoken-mainnet" | "axie-mainnet" | "evmos-mainnet" | "astar-mainnet" | "iotex-mainnet" | "harmony-mainnet" | "cronos-mainnet" | "aurora-mainnet" | "emerald-paratime-mainnet" | "boba-mainnet" | "eth-goerli" | "matic-mumbai" | "avalanche-testnet" | "bsc-testnet" | "moonbeam-moonbase-alpha" | "rsk-testnet" | "arbitrum-goerli" | "fantom-testnet" | "palm-testnet" | "heco-testnet" | "nervos-godwoken-testnet" | "evmos-testnet" | "astar-shiden" | "iotex-testnet" | "harmony-testnet" | "aurora-testnet" | "scroll-l2-testnet" | "scroll-sepolia-testnet" | "covalent-internal-network-v1" | "defi-kingdoms-mainnet" | "swimmer-mainnet" | "boba-avalanche-mainnet" | "boba-bobabeam-mainnet" | "boba-bnb-mainnet" | "boba-rinkeby-testnet" | "boba-bobabase-testnet" | "boba-bnb-testnet" | "boba-avalanche-testnet" | "klaytn-testnet" | "gather-mainnet" | "gather-testnet" | "skale-calypso" | "skale-mainnet" | "skale-razor" | "avalanche-dexalot-mainnet" | "skale-omnus" | "avalanche-dexalot-testnet" | "astar-shibuya" | "cronos-testnet" | "defi-kingdoms-testnet" | "metis-mainnet" | "metis-stardust" | "milkomeda-a1-mainnet" | "milkomeda-a1-devnet" | "milkomeda-c1-mainnet" | "milkomeda-c1-devnet" | "swimmer-testnet" | "solana-mainnet" | "skale-europa" | "meter-mainnet" | "meter-testnet" | "skale-exorde" | "boba-goerli" | "neon-testnet" | "skale-staging-uum" | "skale-staging-lcc" | "arbitrum-nova-mainnet" | "canto-mainnet" | "bittorrent-mainnet" | "bittorrent-testnet" | "flarenetworks-flare-mainnet" | "flarenetworks-flare-testnet" | "flarenetworks-canary-mainnet" | "flarenetworks-canary-testnet" | "kcc-mainnet" | "kcc-testnet" | "polygon-zkevm-testnet" | "linea-testnet" | "base-testnet" | "mantle-testnet" | "scroll-alpha-testnet" | "oasys-mainnet" | "oasys-testnet" | "findora-mainnet" | "findora-forge-testnet" | "sx-mainnet" | "oasis-sapphire-mainnet" | "oasis-sapphire-testnet" | "optimism-goerli" | "polygon-zkevm-mainnet" | "horizen-yuma-testnet" | "clv-parachain" | "energi-mainnet" | "energi-testnet" | "horizen-gobi-testnet" | "eth-sepolia" | "skale-nebula" | "skale-battleground" | "avalanche-meld-testnet" | "gunzilla-testnet" | "ultron-mainnet" | "ultron-testnet" | "zora-mainnet" | "zora-testnet" | "neon-mainnet" | "avalanche-shrapnel-mainnet" | "base-mainnet" | "mantle-mainnet" | "avalanche-loco-legends-mainnet" | "linea-mainnet" | "horizen-eon-mainnet" | "avalanche-numbers" | "avalanche-dos" | "avalanche-step-network" | "avalanche-xplus" | "avalanche-xanachain" | "avalanche-meld-mainnet" | "opside-public-zkevm" | "opside-law-chain" | "avalanche-shrapnel-testnet" | "avalanche-loco-legends-testnet" | "opside-cb-zkevm" | "opside-pre-alpha-testnet" | "opside-era7" | "opside-xthrill" | "zksync-mainnet" | "metis-testnet" | "zksync-testnet" | "avalanche-blitz-testnet" | "avalanche-d-chain-testnet" | "avalanche-green-dot-testnet" | "avalanche-mintara-testnet" | "avalanche-beam-testnet" | "bnb-meta-apes-mainnet" | "bnb-antimatter-mainnet" | "bnb-antimatter-testnet" | "bnb-opbnb-testnet" | "opside-debox" | "opside-jackbot" | "opside-odx-zkevm-testnet" | "opside-readon-content-testnet" | "opside-relation" | "opside-soquest-zkevm" | "opside-vip3" | "opside-zkmeta" | "avalanche-pulsar-testnet" | "avalanche-uptn" | "bnb-fncy-mainnet" | "zetachain-testnet" | "kinto-testnet" | "mode-testnet" | "loot-mainnet" | "bnb-fncy-testnet" | "manta-testnet" | "pgn-mainnet" | "pgn-testnet" | "gnosis-mainnet" | "gnosis-testnet" | "rollux-mainnet" | "rollux-testnet" | "taiko-jolnir-testnet" | "optimism-sepolia" | "bnb-opbnb-mainnet" | "telos-mainnet" | "telos-testnet" | "avalanche-hubble-exchange-testnet" | "avalanche-miho-testnet" | "avalanche-bulletin-testnet" | "avalanche-kiwi-testnet" | "avalanche-hero-testnet" | "avalanche-avacloud-testnet" | "avalanche-thirdweb-testnet" | "avalanche-mondrian-testnet" | "avalanche-conduit-testnet" | "avalanche-nmac-testnet" | "avalanche-orderly-testnet" | "avalanche-amplify-testnet" | "avalanche-mirai-testnet" | "avalanche-wagmi-testnet" | "avalanche-playa3ull-testnet" | "avalanche-beam-mainnet" | "scroll-mainnet" | "eth-holesky";
 export type Quote = "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.7.5";
+export declare const userAgent = "com.covalenthq.sdk.typescript/0.7.6";
 export declare class Response<T> {
     data: T;
     error: boolean;
-    error_code: number;
+    error_code: number | string;
     error_message: string;
 }
 export interface CovalentClientSettings {
@@ -19,6 +19,8 @@ export interface CovalentClientSettings {
     debug?: boolean;
     /** * The number of concurrent requests allowed. */
     threadCount?: number;
+    /** Toggle to turn on and off retry logic */
+    enableRetry?: boolean;
 }
 /**
  * CovalentClient Class

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

@@ -484,8 +484,9 @@ export declare class NftService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * Commonly used to fetch the list of NFT collections with downloaded and cached off chain data like token metadata and asset files.

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

@@ -70,8 +70,9 @@ export declare class PricingService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * Commonly used to get historic prices of a token between date ranges. Supports native tokens.

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

@@ -137,8 +137,9 @@ export declare class SecurityService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * Commonly used to get a list of approvals across all token contracts categorized by spenders for a wallet’s assets.

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

@@ -339,6 +339,7 @@ declare class RecentTransactionsResponse {
     private _apiKey;
     private _threadCount;
     private _urlParams;
+    private _enableRetry;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -354,7 +355,7 @@ declare class RecentTransactionsResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: RecentTransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams);
+    constructor(data: RecentTransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean);
     prev(): Promise<Response<RecentTransactionsResponse>>;
     next(): Promise<Response<RecentTransactionsResponse>>;
 }
@@ -412,6 +413,7 @@ declare class TransactionsResponse {
     private _apiKey;
     private _threadCount;
     private _urlParams;
+    private _enableRetry;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -427,7 +429,7 @@ declare class TransactionsResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: TransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams);
+    constructor(data: TransactionsResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean);
     prev(): Promise<Response<TransactionsResponse>>;
     next(): Promise<Response<TransactionsResponse>>;
 }
@@ -436,6 +438,7 @@ declare class TransactionsTimeBucketResponse {
     private _apiKey;
     private _threadCount;
     private _urlParams;
+    private _enableRetry;
     /** * The requested address. */
     address: string;
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
@@ -452,7 +455,7 @@ declare class TransactionsTimeBucketResponse {
     links: PaginationLinks;
     /** * List of response items. */
     items: Transaction[];
-    constructor(data: TransactionsTimeBucketResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams);
+    constructor(data: TransactionsTimeBucketResponse, _debug: boolean, _apiKey: string, _threadCount: number, _urlParams: URLSearchParams, _enableRetry: boolean);
     prev(): Promise<Response<TransactionsTimeBucketResponse>>;
     next(): Promise<Response<TransactionsTimeBucketResponse>>;
 }
@@ -511,8 +514,9 @@ export declare class TransactionService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * 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.

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

@@ -256,6 +256,8 @@ declare class PoolsDexDataItem {
     volume_7d_quote: number;
     /** * The fee 24h converted to fiat in `quote-currency`. */
     fee_24h_quote: number;
+    /** * The annual fee percentage. */
+    annualized_fee: number;
     /** * A prettier version of the volume 24h quote for rendering purposes. */
     pretty_volume_24h_quote: string;
     /** * A prettier version of the volume 7d quote for rendering purposes. */
@@ -316,6 +318,8 @@ declare class UniswapLikeToken {
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
     balance: bigint | null;
     quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     constructor(data: UniswapLikeToken);
@@ -332,6 +336,8 @@ declare class UniswapLikeTokenWithSupply {
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
     balance: bigint | null;
     quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * Total supply of this pool token. */
@@ -444,12 +450,51 @@ declare class ExchangeTransaction {
     total_quote: number;
     /** * A prettier version of the total quote for rendering purposes. */
     pretty_total_quote: 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;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+    /** * The amount of gas supplied for this tx. */
+    gas_offered: string;
+    /** * The gas spent for this tx. */
+    gas_spent: string;
+    /** * The gas price at the time of this tx. */
+    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;
+    /** * The native gas exchange rate for the requested `quote-currency`. */
+    gas_quote_rate: number;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
     token_0: PoolToken;
     token_1: PoolToken;
     token_0_quote_rate: number;
     token_1_quote_rate: number;
     constructor(data: ExchangeTransaction);
 }
+declare class 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;
+    constructor(data: ContractMetadata);
+}
 declare class PoolToken {
     /** * Use contract decimals to format the token balance for display purposes - divide the balance by `10^{contract_decimals}`. */
     contract_decimals: number;
@@ -512,13 +557,17 @@ declare class UniswapLikeEcosystemCharts {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     gas_token_price_quote: number;
-    total_swaps24h: number;
-    total_active_pairs7d: number;
-    total_fees24h: number;
-    volume_chart7d: VolumeEcosystemChart[];
-    volume_chart30d: VolumeEcosystemChart[];
-    liquidity_chart7d: LiquidityEcosystemChart[];
-    liquidity_chart30d: LiquidityEcosystemChart[];
+    total_swaps_24h: number;
+    total_active_pairs_7d: number;
+    total_fees_24h: number;
+    /** * A prettier version of the gas quote for rendering purposes. */
+    pretty_gas_token_price_quote: string;
+    /** * A prettier version of the 24h total fees for rendering purposes. */
+    pretty_total_fees_24h: string;
+    volume_chart_7d: VolumeEcosystemChart[];
+    volume_chart_30d: VolumeEcosystemChart[];
+    liquidity_chart_7d: LiquidityEcosystemChart[];
+    liquidity_chart_30d: LiquidityEcosystemChart[];
     constructor(data: UniswapLikeEcosystemCharts);
 }
 declare class VolumeEcosystemChart {
@@ -530,6 +579,8 @@ declare class VolumeEcosystemChart {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     volume_quote: number;
+    /** * A prettier version of the volume quote for rendering purposes. */
+    pretty_volume_quote: string;
     swap_count_24: number;
     constructor(data: VolumeEcosystemChart);
 }
@@ -542,6 +593,8 @@ declare class LiquidityEcosystemChart {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     liquidity_quote: number;
+    /** * A prettier version of the liquidity quote for rendering purposes. */
+    pretty_liquidity_quote: string;
     constructor(data: LiquidityEcosystemChart);
 }
 declare class HealthDataResponse {
@@ -587,8 +640,9 @@ export declare class XykService {
     private debug;
     private threadCount;
     private is_key_valid;
+    private enableRetry;
     private LIMIT;
-    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean);
+    constructor(apiKey: string, debug: boolean, threadCount: number, is_key_valid: boolean, enableRetry?: boolean);
     /**
      *
      * Commonly used to get all the pools of a particular DEX. Supports most common DEXs (Uniswap, SushiSwap, etc), and returns detailed trading data (volume, liquidity, swap counts, fees, LP token prices).

package/dist/cjs/util/ApiHelpers.d.ts

@@ -1,5 +1,5 @@
 export declare function checkAndModifyResponse(jsonObj: any): void;
 export declare function debugOutput(url: string, responseStatus: number, startTime: number | [number, number] | undefined): Promise<void>;
 type Constructor<T> = new (...args: any[]) => T;
-export declare function paginateEndpoint<T1, T2>(url: string, apiKey: string, urlsParams: URLSearchParams, dataClassConstructor: Constructor<T1>, debug: boolean, threadCount: number): AsyncIterable<T1>;
+export declare function paginateEndpoint<T1, T2>(url: string, apiKey: string, urlsParams: URLSearchParams, dataClassConstructor: Constructor<T1>, debug: boolean, threadCount: number, enableRetry: boolean): AsyncIterable<T1>;
 export {};

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

@@ -1,4 +1,4 @@
-import { Pagination } from "./GenericTypes";
+import { Pagination, ContractMetadata } from "./GenericTypes";
 export interface PoolResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */
     updated_at: Date;
@@ -232,6 +232,8 @@ export interface PoolsDexDataItem {
     volume_7d_quote: number;
     /** * The fee 24h converted to fiat in `quote-currency`. */
     fee_24h_quote: number;
+    /** * The annual fee percentage. */
+    annualized_fee: number;
     /** * A prettier version of the volume 24h quote for rendering purposes. */
     pretty_volume_24h_quote: string;
     /** * A prettier version of the volume 7d quote for rendering purposes. */
@@ -288,6 +290,8 @@ export interface UniswapLikeToken {
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
     balance: bigint | null;
     quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
 }
@@ -303,6 +307,8 @@ export interface UniswapLikeTokenWithSupply {
     /** * The asset balance. Use `contract_decimals` to scale this balance for display purposes. */
     balance: bigint | null;
     quote: number;
+    /** * A prettier version of the quote for rendering purposes. */
+    pretty_quote: string;
     /** * The exchange rate for the requested quote currency. */
     quote_rate: number;
     /** * Total supply of this pool token. */
@@ -409,6 +415,30 @@ export interface ExchangeTransaction {
     total_quote: number;
     /** * A prettier version of the total quote for rendering purposes. */
     pretty_total_quote: 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;
+    /** * The requested chain native gas token metadata. */
+    gas_metadata: ContractMetadata;
+    /** * The amount of gas supplied for this tx. */
+    gas_offered: string;
+    /** * The gas spent for this tx. */
+    gas_spent: string;
+    /** * The gas price at the time of this tx. */
+    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;
+    /** * The native gas exchange rate for the requested `quote-currency`. */
+    gas_quote_rate: number;
+    /** * The requested quote currency eg: `USD`. */
+    quote_currency: string;
     token_0: PoolToken;
     token_1: PoolToken;
     token_0_quote_rate: number;
@@ -472,13 +502,17 @@ export interface UniswapLikeEcosystemCharts {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     gas_token_price_quote: number;
-    total_swaps24h: number;
-    total_active_pairs7d: number;
-    total_fees24h: number;
-    volume_chart7d: VolumeEcosystemChart[];
-    volume_chart30d: VolumeEcosystemChart[];
-    liquidity_chart7d: LiquidityEcosystemChart[];
-    liquidity_chart30d: LiquidityEcosystemChart[];
+    total_swaps_24h: number;
+    total_active_pairs_7d: number;
+    total_fees_24h: number;
+    /** * A prettier version of the gas quote for rendering purposes. */
+    pretty_gas_token_price_quote: string;
+    /** * A prettier version of the 24h total fees for rendering purposes. */
+    pretty_total_fees_24h: string;
+    volume_chart_7d: VolumeEcosystemChart[];
+    volume_chart_30d: VolumeEcosystemChart[];
+    liquidity_chart_7d: LiquidityEcosystemChart[];
+    liquidity_chart_30d: LiquidityEcosystemChart[];
 }
 export interface VolumeEcosystemChart {
     /** * The name of the DEX, eg: `uniswap_v2`. */
@@ -489,6 +523,8 @@ export interface VolumeEcosystemChart {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     volume_quote: number;
+    /** * A prettier version of the volume quote for rendering purposes. */
+    pretty_volume_quote: string;
     swap_count_24: number;
 }
 export interface LiquidityEcosystemChart {
@@ -500,6 +536,8 @@ export interface LiquidityEcosystemChart {
     /** * The requested quote currency eg: `USD`. */
     quote_currency: string;
     liquidity_quote: number;
+    /** * A prettier version of the liquidity quote for rendering purposes. */
+    pretty_liquidity_quote: string;
 }
 export interface HealthDataResponse {
     /** * The timestamp when the response was generated. Useful to show data staleness to users. */