Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeneralApi

Hierarchy

  • GeneralApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private api

api: DCoreApi

Methods

getChainId

  • getChainId(): Promise<string>

  • Get the chain ID.

    Returns Promise<string>

    the chain ID identifying blockchain network

getChainProperties

  • Retrieve properties associated with the chain.

    Returns Promise<ChainProperties>

    chain id and immutable chain parameters

getConfig

  • getConfig(): Promise<object>

  • Retrieve compile-time constants.

    Returns Promise<object>

    configured constants

getDynamicGlobalProperties

  • Retrieve the dynamic properties. The returned object contains information that changes every block interval, such as the head block number, the next miner, etc.

    Returns Promise<DynamicGlobalProperties>

    dynamic property object

getGlobalProperties

  • Retrieve global properties. This object contains all of the properties of the blockchain that are fixed or that change only once per maintenance interval such as the current list of miners, block interval, etc.

    Returns Promise<GlobalProperties>

    global property object

getTimeToMaintenance

  • Get remaining time to next maintenance interval from given time.

    Parameters

    • time: Moment

      reference time

    Returns Promise<MinerRewardInput>

    remaining time to next maintenance interval along with some additional data

Generated using TypeDoc