@hiveio/dhive
    Preparing search index...

    Class Client

    Can be used in both node.js and the browser. Also see ClientOptions.

    Index
    constructor
    address addressPrefix block blockchain broadcast chainId currentAddress database healthTracker hivemind keys options rc transaction
    call updateOperations mirrornet testnet

    • Parameters

      • address: string | string[]

        The address to the Hive RPC server, e.g. https://api.hive.blog. or [https://api.hive.blog, https://another.api.com]

      • options: ClientOptions = {}

        Client options.

      Returns Client

    address: string | string[]

    Address to Hive RPC server. String or String[] read-only

    addressPrefix: string

    Address prefix for current network.

    block: BlockAPI

    Block API helper, returning blocks in the block_api format.

    blockchain: Blockchain

    Blockchain helper.

    broadcast: BroadcastAPI

    Broadcast API helper.

    chainId: Buffer

    Chain ID for current network.

    currentAddress: string
    database: DatabaseAPI

    Chain state helper. It calls condenser_api, not database_api; call database_api methods with client.call('database_api', method, params).

    healthTracker: NodeHealthTracker

    Node health tracker for smart failover. Tracks per-node, per-API health and head block freshness.

    hivemind: HivemindAPI

    Hivemind helper.

    keys: AccountByKeyAPI

    Accounts by key API helper.

    options: ClientOptions

    Client options, read-only.

    rc: RCAPI

    RC API helper.

    transaction: TransactionStatusAPI

    Transaction status API helper.

    • Make a RPC call to the server.

      Parameters

      • api: string

        The API to call, e.g. database_api.

      • method: string

        The API method, e.g. get_dynamic_global_properties.

      • params: any = []

        Array of parameters to pass to the method, optional.

      Returns Promise<any>

    • Parameters

      • rebrandedApi: any

      Returns void

    • Create a new client instance configured for the Hive mirrornet, which mirrors mainnet data under a separate chain id.

      Parameters

      Returns Client

    Settings
    Member Visibility

    On This Page
    RPC Client
    Constructors
    Properties
    Methods