@beblurt/dblurt

Appearance

Choose your path ​

dblurt has several helper families because Blurt applications do several different jobs. Start from your goal, then choose the API surface.

If you need exact method signatures, go to the API reference. This page helps you decide where to start.

I want to make my first read-only call ​

Use Client plus client.condenser.

ts
import { Client } from '@beblurt/dblurt';

const client = new Client(rpcList);
const props = await client.condenser.getDynamicGlobalProperties();

console.log(props.head_block_number);

Next: Getting started.

I want account, content, witness or block data ​

Use Layer 1 helpers.

GoalStart withWhy
Account state, balances, authoritiesclient.condenser.getAccounts()common Layer 1 account read
Content by author/permlinkclient.condenser.getContent()canonical chain content object
Active votesclient.condenser.getActiveVotes()Layer 1 vote data
Witness detailsclient.condenser.getWitnessByAccount()witness data is Layer 1
Block ranges or operation streamsclient.blockchainhigher-level iteration helpers
Appbase database methodsclient.databasedirect database API wrappers
Account or virtual operation historyclient.accountHistoryobject-param history helpers

Concept: Blurt mental model. Task guide: Read chain data.

I want ranked feeds, communities, profiles or notifications ​

Use client.nexus.

Nexus is the right starting point for social/indexed views:

  • trending/hot/created post lists;
  • account post lists;
  • communities;
  • profiles;
  • discussions;
  • notifications;
  • referrals.
ts
const posts = await client.nexus.getRankedPosts({
    sort: 'trending',
    limit: 10,
    tag: 'blurt',
    observer: null
});

Concept: Layer 1 and Nexus Layer 2. Task guide: Use Nexus social data.

I want application-ready summaries ​

Use client.read when you want structured read models rather than raw RPC objects.

Read models compose lower-level helpers into data structures for common application needs such as account summaries, stake, social graph summaries, witness summaries and vote-value estimates.

Read models are still SDK data models. They are not natural-language summaries, UI components or app policy.

Task guide: Read models.

I want to build an operation without broadcasting ​

Use operation builders.

Examples include content builders and social custom_json builders. They return operation payloads that applications can preview, test, confirm, externally sign or broadcast later.

ts
import { buildPostOperation } from '@beblurt/dblurt';

const operation = buildPostOperation({
    author: 'alice',
    title: 'Hello Blurt',
    body: 'Body text',
    tags: ['blurt', 'sdk']
});

Task guides: Publish content and Social actions.

I want to sign or broadcast a transaction ​

Use client.broadcast, but only after you understand authorities and side effects.

Broadcasting requires a private key satisfying the operation's authority. Once a transaction is accepted by the chain, it has real effects.

Learn first:

  1. Accounts and authorities
  2. Read-only vs broadcast
  3. Broadcast safely

I want to use a raw RPC method ​

Use client.call(api, method, params) when a JSON-RPC method is not wrapped by a helper.

ts
const result = await client.call('database_api', 'get_dynamic_global_properties', []);

Use this when you know the backing API method and want direct access without waiting for a helper wrapper.

I want browser or TypeScript guidance ​

Use these paths:

API symbol shortcuts ​

Common API reference entry points:

I want exact API details ​

Use API reference.

Concept pages explain choices and workflows. The API reference owns exact classes, methods, parameters, return types, overloads and deprecation annotations.