Class Client

RPC Client

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

Hierarchy

  • Client

Constructors

constructor

Properties

address addressPrefix backoff blockchain broadcast chainId consoleOnFailover currentAddress database failoverThreshold hivemind keys options rc timeout transaction

Methods

call updateOperations testnet

Constructors

constructor

  • 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

Properties

Readonly address

address: string | string[]

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

Readonly addressPrefix

addressPrefix: string

Address prefix for current network.

Private Readonly backoff

backoff: ((tries: number) => number)

Type declaration

    • (tries: number): number

    • Default backoff function. min(tries*10^2, 10 seconds)

      Parameters

      • tries: number

      Returns number

Readonly blockchain

blockchain: Blockchain

Blockchain helper.

Readonly broadcast

broadcast: BroadcastAPI

Broadcast API helper.

Readonly chainId

chainId: Buffer

Chain ID for current network.

Private Readonly consoleOnFailover

consoleOnFailover: boolean

currentAddress

currentAddress: string

Readonly database

database: DatabaseAPI

Database API helper.

Private Readonly failoverThreshold

failoverThreshold: number

Readonly hivemind

hivemind: HivemindAPI

Hivemind helper.

Readonly keys

keys: AccountByKeyAPI

Accounts by key API helper.

Readonly options

options: ClientOptions

Client options, read-only.

Readonly rc

rc: RCAPI

RC API helper.

Private Readonly timeout

timeout: number

Readonly transaction

transaction: TransactionStatusAPI

Transaction status API helper.

Methods

call

  • Make a RPC call to the server.

    Type Parameters

    Type Parameters

    • T = any

    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<T>

updateOperations

  • Parameters

    • _rebrandedApi: boolean

    Returns void

Static testnet

Settings

Member Visibility

Theme

Generated using TypeDoc