Class CoreScanner

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

CoreScanner

Hierarchy (View Summary)

Constructors

constructor

Properties

baseUrl apiKey? logger account contract nft statistics utils

Methods

fetchApi

Constructors

constructor

  • new CoreScanner(config?: ApiConfig): CoreScanner

    Creates an instance of CoreScanner with all available modules.

    Parameters

    • config: ApiConfig = ...

      Configuration object for the scanner

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

      • target: ConfluxTarget

        Target network environment

      • OptionalapiKey?: string

        API key for authentication

      • Optionalhost?: string

        Custom API host URL

    Returns CoreScanner

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

Readonlycontract

contract: ContractModule

Module for smart contract operations

Readonlynft

nft: NFTModule

Module for NFT-related operations

Readonlystatistics

statistics: StatisticsModule

Module for statistics and metrics

Readonlyutils

utils: UtilsModule

Module for utility functions

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