Class Client

RPC Client

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

Index

Constructors

Properties

address addressPrefix blockchain broadcast chainId database options rc

Methods

Constructors

constructor

new Client(address: string, options?: ClientOptions): Client
Parameters
- address: string
  The address to the Steem RPC server, e.g. https://api.steemit.com.
- options: ClientOptions = {}
  Client options.
Returns Client
- Defined in client.ts:214

Properties

`Readonly`address

address: string

Address to Steem RPC server, read-only.

`Readonly`addressPrefix

addressPrefix: string

Address prefix for current network.

`Readonly`blockchain

blockchain: Blockchain

Blockchain helper.

`Readonly`broadcast

broadcast: BroadcastAPI

Broadcast API helper.

`Readonly`chainId

chainId: Buffer

Chain ID for current network.

`Readonly`database

database: DatabaseAPI

Database API helper.

`Readonly`options

options: ClientOptions

Client options, read-only.

`Readonly`rc

RC API helper.

Methods

call

call(api: string, method: string, params?: any): Promise<any>
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>
- Defined in client.ts:239

`Static`testnet

testnet(options?: ClientOptions): Client
Create a new client instance configured for the testnet.
Parameters
- Optionaloptions: ClientOptions
Returns Client
- Defined in client.ts:155