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
| Level | Meaning | Where it appears |
|---|---|---|
read-only | Calls public RPC APIs and does not sign or broadcast. | First-run examples, account reads, Nexus reads, read models. |
static | Runs locally without network calls. | Operation builders, error classification examples. |
side-effectful | Signs or broadcasts a transaction. | Isolated safety-focused recipes only. |
The default learning path is read-only first. Side-effectful recipes must link back to Accounts and authorities and Read-only vs broadcast.
Recommended first recipes
| Recipe | Safety | Validated source |
|---|---|---|
| Read account summary | read-only | examples/node/read-account-summary.cjs |
| List account posts | read-only | examples/node/read-nexus-ranked-posts.cjs and Nexus helpers |
| Estimate vote value | read-only | examples/node/estimate-vote-value.cjs |
| Handle retryable errors | static | examples/node/classify-retryable-error.cjs |
| Build post operation | static | examples/node/build-post-operation.cjs |
| Sign and broadcast vote | side-effectful | intentionally 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 read-only/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.