Class ESpaceScanner

Main scanner class that provides access to all Conflux eSpace API modules. Extends the base API class with specific module implementations.

ESpaceScanner

Hierarchy (View Summary)

Constructors

constructor

Properties

baseUrl apiKey? logger account block contract nft statistics token transaction utils deprecated

Methods

fetchApi

Constructors

constructor

  • new ESpaceScanner(config?: ApiConfig): ESpaceScanner

    Creates an instance of ESpaceScanner with all available modules.

    Parameters

    • config: ApiConfig = ...

      Configuration object for the scanner

      API configuration options. Contains settings for connecting to the Conflux eSpace Scanner API.

      • target: ConfluxTarget

        Target network environment

      • OptionalapiKey?: string

        API key for authentication

      • Optionalhost?: string

        Custom API host URL

    Returns ESpaceScanner

Properties

ProtectedbaseUrl

baseUrl: string

Base URL for the API endpoints

Protected OptionalapiKey

apiKey?: string

Optional API key for authenticated requests

Protectedlogger

logger: Logger<never> = ...

Logger instance for the scanner

Readonlyaccount

account: AccountModule

Module for account-related operations

Readonlyblock

block: BlockModule

Module for block-related operations

Readonlycontract

contract: ContractModule

Module for smart contract operations

Readonlynft

nft: NFTModule

Module for NFT-related operations

Readonlystatistics

statistics: StatisticsModule

Module for statistics and metrics

Readonlytoken

token: TokenModule

Module for token-related operations

Readonlytransaction

transaction: TransactionModule

Module for transaction operations

Readonlyutils

utils: UtilsModule

Module for utility functions

Readonlydeprecated

deprecated: DeprecatedModule

Module containing deprecated functionality

Methods

ProtectedfetchApi

  • fetchApi<T>(
        endpoint: string,
        params?: Record<string, undefined | null | string | number | boolean>,
    ): Promise<ApiResponse<T>>
    Protected

    Makes an API request with the given parameters. Handles parameter sanitization, API key inclusion, and error handling.

    Type Parameters

    • T

      Type of the expected response data

    Parameters

    • endpoint: string

      API endpoint to call

    • params: Record<string, undefined | null | string | number | boolean> = {}

      Query parameters

    Returns Promise<ApiResponse<T>>

    Promise resolving to the API response

    Throws

    When the API request fails or returns an error status

Settings

Member Visibility

On This Page

Constructors
Properties
Methods