Skip to content

Read models

Read models are higher-level SDK data models built from lower-level Layer 1 and Nexus helpers.

Use client.read when your application wants structured summaries without turning raw RPC objects into UI-specific presentation text.

What read models are for

NeedStart with
account, stake and reward summaryclient.read.getAccountSummary()
outgoing delegation summaryclient.read.getOutgoingDelegationSummary()
social graph counts and samplesclient.read.getSocialGraphSummary()
witness summaryclient.read.getWitnessSummary()
current vote-value estimateclient.read.estimateVoteValue()

Read models are still data models. They do not own UI copy, translations, fiat formatting, ranking policy or application-specific recommendations.

Account summary

ts
const summary = await client.read.getAccountSummary('beblurt');

console.log({
    account: summary.name,
    balance: summary.balance,
    mana: summary.mana_percent
});

Use this when an application needs a practical account overview and does not want to assemble every field manually from raw RPC responses.

Vote value estimate

ts
const vote = await client.read.estimateVoteValue('beblurt', 100);

console.log(vote.vote_value_blurt);

Vote value depends on current mana and chain economics. Treat it as a snapshot, not a permanent value.

Why not put this in Nexus?

Nexus is an indexed/social Layer 2 surface. Read models can compose Layer 1 helpers, Nexus helpers and local calculations depending on the model.

The distinction is:

  • client.nexus gives indexed social views;
  • client.condenser, client.database, client.blockchain give Layer 1 data;
  • client.read gives SDK-owned data models composed from existing primitives.

What read models do not do

They do not:

  • broadcast operations;
  • sign transactions;
  • mutate chain state;
  • produce natural-language summaries;
  • hide source-layer distinctions;
  • replace the API reference for exact return types.

Validated example

API details