Skip to content

Recipes

Recipes are task-focused pages that show how to accomplish common jobs with dblurt.

They are intentionally different from API reference pages. A recipe should explain the task, safety level and decision points. The API reference remains the source for exact signatures, overloads and return types.

Safety levels

LevelMeaningWhere it appears
blockchain-queryCalls public RPC APIs and does not sign or broadcast.First-run examples, account reads, Nexus reads, read models.
staticRuns locally without network calls.Operation builders, error classification examples.
side-effectfulSigns or broadcasts a transaction.Isolated safety-focused recipes only.

The default learning path is blockchain queries first. Side-effectful recipes must link back to Accounts and authorities and Blockchain queries vs broadcast operations.

RecipeSafetyValidated source
Read account summaryblockchain-queryexamples/node/read-account-summary.cjs
List account postsblockchain-queryexamples/node/read-nexus-ranked-posts.cjs and Nexus helpers
Estimate vote valueblockchain-queryexamples/node/estimate-vote-value.cjs
Parse recent blocksblockchain-queryexamples/node/stream-block-numbers.cjs, examples/node/read-blocks-with-helper.cjs, examples/node/read-operations-with-helper.cjs
Read account historyblockchain-queryexamples/node/read-account-history.cjs
Handle retryable errorsstaticexamples/node/classify-retryable-error.cjs
Build post operationstaticexamples/node/build-post-operation.cjs
Sign and broadcast voteside-effectfulintentionally no copy-paste live example yet

Source examples

The repository keeps executable examples under examples/. Each listed example declares:

  • purpose;
  • runtime;
  • safety level;
  • validation level;
  • required RPC capability;
  • expected output.

npm run docs:check validates example metadata and runs blockchain-query/static Node examples unless live examples are explicitly skipped.

When to use a recipe

Use recipes when you know the task you want to perform. Use Start and Learn pages when you are still building the mental model. Use the API reference when you need exact method details.