Class Client

Main SDK client for Blurt Layer 1 RPC, Nexus/Bridge social views and helper APIs.

A client owns endpoint failover, timeout/backoff settings and helper namespaces. Use condenser, database, accountHistory and blockchain for Layer 1 reads, nexus for indexed Layer 2 social views, read for composed read models, and broadcast only for explicit signing/broadcast workflows.

Can be used in Node.js >=18 and modern browsers with native fetch and AbortController. Also see ClientOptions.

Constructors

constructor

Properties

accountHistory address addressPrefix blockchain broadcast chainId condenser currentAddress database nexus options read tools

Methods

call

Constructors

constructor

  • new Client(address, options?): Client

  • Parameters

    • address: string | string[]

      The address to the Blurt RPC server, e.g. https://rpc.blurt.world. or [https://rpc.blurt.world, https://another.api.com]

    • options: ClientOptions = {}

      Client options.

    Returns Client

Properties

ReadonlyaccountHistory

accountHistory: AccountHistoryAPI

Account and block operation history helper for Layer 1 history reads.

address

address: string | string[]

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

ReadonlyaddressPrefix

addressPrefix: string

Address prefix for current network.

Readonlyblockchain

blockchain: Blockchain

Higher-level Layer 1 block and operation iteration helper.

Readonlybroadcast

broadcast: BroadcastAPI

Signed Layer 1 broadcast helper. Requires appropriate private keys and has chain side effects.

ReadonlychainId

chainId: Buffer

Chain ID for current network.

Readonlycondenser

condenser: CondenserAPI

Common Layer 1 condenser API reads such as accounts, content, witnesses and properties.

currentAddress

currentAddress: string

Readonlydatabase

database: DatabaseAPI

Appbase database API helper for lower-level Layer 1 database methods.

Readonlynexus

nexus: Nexus

Nexus/Bridge helper for indexed Layer 2 social views.

Readonlyoptions

options: ClientOptions

Client options, read-only.

Readonlyread

read: ReadModels

Composed read-model helper for application-oriented summaries built from public data.

Readonlytools

tools: Tools

Local calculation and conversion helper.

Methods

call

  • call(api, method, params?): 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>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods