Class TokenModule

Module for handling ERC20 token-related operations on Conflux eSpace. Provides methods for querying token balances, supplies, and historical data.

TokenModule

Hierarchy (View Summary)

Constructors

constructor

Properties

baseUrl apiKey? logger

Methods

fetchApi getTokenBalance getTokenSupply getTokenSupplyHistory getTokenBalanceHistory

Constructors

constructor

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 token operations

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

getTokenBalance

  • getTokenBalance(params: TokenBalanceParams): Promise<string>

    Get ERC20 token balance for an address. Retrieves the current balance of a specific ERC20 token for a given address.

    Parameters

    • params: TokenBalanceParams

      Parameters for the token balance query

      Parameters for token balance request Gets the current balance of a specific token for an account

      TokenBalanceParams

      • contractaddress: string

        Token contract address

      • address: string

        Account address to check balance for

    Returns Promise<string>

    The token balance

    Throws

    If the address or contract address is invalid

getTokenSupply

  • getTokenSupply(params: TokenSupplyParams): Promise<string>

    Get ERC20 token total supply. Retrieves the current total supply of a specific ERC20 token.

    Parameters

    • params: TokenSupplyParams

      Parameters for the token supply query

      Parameters for token supply request Gets the current total supply of a token

      TokenSupplyParams

      • contractaddress: string

        Token contract address

    Returns Promise<string>

    The token total supply

    Throws

    If the contract address is invalid

getTokenSupplyHistory

  • getTokenSupplyHistory(params: TokenSupplyHistoryParams): Promise<string>

    Get historical ERC20 token total supply at a specific block. Retrieves the total supply of a specific ERC20 token at a given block number.

    Parameters

    • params: TokenSupplyHistoryParams

      Parameters for the historical token supply query

      Parameters for historical token supply data Gets the total supply of a token at a specific block

      TokenSupplyHistoryParams

      • contractaddress: string

        Token contract address

      • address: string

        Account address to check balance for

      • blockno: number

        Block number to query supply at

    Returns Promise<string>

    The historical token supply

    Throws

    If any of the parameters are invalid

getTokenBalanceHistory

  • getTokenBalanceHistory(params: TokenBalanceHistoryParams): Promise<string>

    Get historical ERC20 token balance for an account at a specific block number. Retrieves the balance of a specific ERC20 token for a given address at a specific block.

    Parameters

    • params: TokenBalanceHistoryParams

      Parameters for the historical balance query

      Parameters for token balance history Gets the balance of a token for an account at a specific block

      TokenBalanceHistoryParams

      • contractaddress: string

        Token contract address

      • address: string

        Account address to check balance for

      • blockno: number

        Block number to query balance at

    Returns Promise<string>

    The historical token balance

    Throws

    If any of the parameters are invalid or missing

Settings

Member Visibility

On This Page

Constructors
Properties
Methods