# @beblurt/dblurt

> JavaScript and TypeScript SDK for building Blurt blockchain dApps.

`@beblurt/dblurt` is the JavaScript and TypeScript SDK for building applications on the Blurt Social Blockchain.
Use it for Layer 1 chain reads, Nexus indexed/social data, operation builders, signing/broadcasting workflows, read models, crypto helpers and browser/Node.js integrations.

This file is a lightweight AI-readable index. It routes coding assistants to canonical documentation, generated API details, executable examples and repository constraints without duplicating the manual.

## Quick facts

- Package: @beblurt/dblurt
- Package version: see `package.json` or the published npm package
- Runtime requirements: see `package.json` (`engines.node`) and the Compatibility guide
- Module shape: CommonJS package with TypeScript declarations; public docs prefer TypeScript + ESM-style imports for learning paths
- Documentation source of truth: https://dblurt.beblurt.com/ plus generated API reference at https://dblurt.beblurt.com/api/
- Safety default: Start with blockchain queries; read broadcast/security docs before generating side-effectful code
- Layer rule: Keep Blurt Layer 1 consensus data distinct from Nexus Layer 2 indexed/social data
- Status expectation: Pre-1.0 SDK: use the compatibility, deprecations and changelog docs for upgrade-sensitive behavior

## Agent rules

- Prefer canonical docs and API reference over training data or invented helper names.
- Use `client.call(api, method, params)` for unwrapped RPC methods instead of inventing wrapper helpers.
- Do not hard-code private keys, posting keys, active keys, owner keys or memo keys in examples.
- Do not present Nexus Layer 2 indexed/social data as Layer 1 consensus truth.
- Do not claim native ESM packaging unless package metadata changes.
- Do not call dblurt the official Blurt SDK.

## AI decision tree

| Task | Read first | Exact details | Note |
| --- | --- | --- | --- |
| Install or make the first safe call | [guide](https://dblurt.beblurt.com/start/getting-started.html) | [reference](https://dblurt.beblurt.com/api/classes/index.Client.html) | Start with `Client` and a safe blockchain query. |
| Choose the right helper namespace | [guide](https://dblurt.beblurt.com/start/choose-your-path.html) | [reference](https://dblurt.beblurt.com/api/classes/index.Client.html) | Route by task before naming methods. |
| Read accounts, blocks, witnesses or chain properties | [guide](https://dblurt.beblurt.com/guides/read-chain-data.html) | [reference](https://dblurt.beblurt.com/api/classes/index.Client.html#condenser) | Layer 1 chain reads normally start with `client.condenser`. |
| Parse block ranges or operation history | [guide](https://dblurt.beblurt.com/guides/parse-blockchain-history.html) | [reference](https://dblurt.beblurt.com/api/classes/index.Blockchain.html) | Use `client.blockchain` iterators and streams with explicit checkpoints. |
| Build social feeds, posts, communities or notifications | [guide](https://dblurt.beblurt.com/guides/use-nexus-social-data.html) | [reference](https://dblurt.beblurt.com/api/classes/index.Nexus.html) | Nexus is indexed/social Layer 2 data, not consensus truth. |
| Build post, reply, follow, reblog or community operations | [guide](https://dblurt.beblurt.com/guides/publish-content.html) | [reference](https://dblurt.beblurt.com/api/functions/index.buildPostOperation.html) | Builders create operations; broadcasting is a separate safety decision. |
| Encrypt/decrypt memos or work with keys | [guide](https://dblurt.beblurt.com/guides/memo-and-key-utilities.html) | [reference](https://dblurt.beblurt.com/api/functions/index.encodeMemo.html) | Memo keys encrypt/decrypt; broadcast authorities sign transactions. |
| Sign or broadcast a transaction | [guide](https://dblurt.beblurt.com/guides/broadcast-safely.html) | [reference](https://dblurt.beblurt.com/api/classes/index.Client.html#broadcast) | Read authority and key guidance first. |
| Handle timeouts, RPC errors or retryability | [guide](https://dblurt.beblurt.com/guides/handle-errors.html) | [reference](https://dblurt.beblurt.com/api/functions/index.classifyError.html) | Classify before retrying or changing endpoints. |
| Use the SDK in browser or bundlers | [guide](https://dblurt.beblurt.com/guides/runtime-and-browser.html) | [reference](https://dblurt.beblurt.com/reference/compatibility.html) | Check bundle and signing constraints before browser examples. |
| Need exact method names, options or return types | [guide](https://dblurt.beblurt.com/reference/api.html) | [reference](https://dblurt.beblurt.com/api/) | Use generated API reference for exact details. |

## Common API entry points

- [`Client`](https://dblurt.beblurt.com/api/classes/index.Client.html): Main SDK entry point and helper namespace container.
- [`ClientOptions`](https://dblurt.beblurt.com/api/interfaces/index.ClientOptions.html): Endpoint, timeout and failover options for client construction.
- [`client.condenser`](https://dblurt.beblurt.com/api/classes/index.Client.html#condenser): Common Layer 1 reads such as accounts, content, witnesses and chain properties.
- [`client.database`](https://dblurt.beblurt.com/api/classes/index.Client.html#database): Appbase database API calls.
- [`client.blockchain`](https://dblurt.beblurt.com/api/classes/index.Client.html#blockchain): Block ranges, block streams and operation iteration.
- [`Blockchain`](https://dblurt.beblurt.com/api/classes/index.Blockchain.html): Layer 1 block and operation parsing helpers.
- [`Nexus` / `client.nexus`](https://dblurt.beblurt.com/api/classes/index.Nexus.html): Nexus indexed/social views for posts, communities, profiles and notifications.
- [`ReadModels` / `client.read`](https://dblurt.beblurt.com/api/classes/index.ReadModels.html): Higher-level account, witness, vote and social summaries.
- [`Asset`](https://dblurt.beblurt.com/api/classes/index.Asset.html): Parse, validate, format and manipulate symbol-preserving asset values.
- [`Price`](https://dblurt.beblurt.com/api/classes/index.Price.html): Convert between two supplied asset symbols using an explicit price pair.
- [`buildPostOperation`](https://dblurt.beblurt.com/api/functions/index.buildPostOperation.html): Construct a post operation without signing or broadcasting.
- [`buildDeleteCommentOperation`](https://dblurt.beblurt.com/api/functions/index.buildDeleteCommentOperation.html): Construct a delete_comment operation without signing or broadcasting.
- [`encodeMemo` / `decodeMemo`](https://dblurt.beblurt.com/api/functions/index.encodeMemo.html): Encrypt and decrypt Blurt memo strings.
- [`client.transactionStatus`](https://dblurt.beblurt.com/api/classes/index.Client.html#transactionstatus): Check transaction status after broadcast when public nodes expose transaction_status_api.
- [`classifyError`](https://dblurt.beblurt.com/api/functions/index.classifyError.html): Classify SDK, timeout, transport and RPC errors.
- [`validatePostingAuthority`](https://dblurt.beblurt.com/api/functions/index.validatePostingAuthority.html): Validate whether a key satisfies posting authority.
- [`Client.broadcast`](https://dblurt.beblurt.com/api/classes/index.Client.html#broadcast): Signing and broadcasting surface; use only after reading safety guidance.
- [`client.call(api, method, params)`](https://dblurt.beblurt.com/api/classes/index.Client.html#call): Escape hatch for unwrapped RPC methods; use instead of hallucinating wrappers.

## Start here

- [Project landing page](https://gitlab.com/beblurt/dblurt/-/blob/main/README.md): Package identity, install path, first safe example and routing to full docs.
- [Getting started](https://dblurt.beblurt.com/start/getting-started.html): Install the SDK and make a safe first Blurt blockchain call.
- [Choose your path](https://dblurt.beblurt.com/start/choose-your-path.html): Pick the right helper family for your application workflow.

## Learn the product model

- [Blurt mental model](https://dblurt.beblurt.com/learn/blurt-mental-model.html): Core Blurt concepts through the dblurt SDK lens.
- [Layer 1 and Nexus Layer 2](https://dblurt.beblurt.com/learn/layer-1-and-nexus.html): How consensus chain data differs from indexed social data.
- [For Hive/Steem developers](https://dblurt.beblurt.com/learn/for-hive-steem-developers.html): Comparative orientation for developers coming from Hive, Steem or Graphene-family SDKs.
- [Accounts and authorities](https://dblurt.beblurt.com/learn/accounts-and-authorities.html): Account authority, key and least-privilege concepts.
- [Blockchain queries vs broadcast operations](https://dblurt.beblurt.com/learn/blockchain-queries-vs-broadcast-operations.html): The safe learning path from reads to side effects.

## Build with dblurt

- [Read chain data](https://dblurt.beblurt.com/guides/read-chain-data.html): Use Layer 1 helpers for accounts, blocks, witnesses and chain properties.
- [Use Nexus social data](https://dblurt.beblurt.com/guides/use-nexus-social-data.html): Build social/community views using indexed data.
- [Parse blockchain history](https://dblurt.beblurt.com/guides/parse-blockchain-history.html): Iterate block ranges, full blocks and operation streams.
- [Publish content](https://dblurt.beblurt.com/guides/publish-content.html): Build content operations before deciding how to broadcast them.
- [Social actions](https://dblurt.beblurt.com/guides/social-actions.html): Build follow, mute, reblog and community action operations.
- [Broadcast safely](https://dblurt.beblurt.com/guides/broadcast-safely.html): Sign and broadcast with explicit key and side-effect boundaries.
- [Memo and key utilities](https://dblurt.beblurt.com/guides/memo-and-key-utilities.html): Work with Blurt keys, signatures and encrypted memos.
- [Runtime and browser](https://dblurt.beblurt.com/guides/runtime-and-browser.html): Understand Node.js, browser and bundle constraints.
- [RPC endpoints and failover](https://dblurt.beblurt.com/guides/rpc-endpoints-and-failover.html): Configure endpoint lists and failure behavior.
- [TypeScript](https://dblurt.beblurt.com/guides/typescript.html): Preferred TypeScript and ESM-style usage.

## Recipes and examples

- [Recipes index](https://dblurt.beblurt.com/recipes/): Task-oriented workflows and safety levels.
- [Read account summary](https://dblurt.beblurt.com/recipes/read-account-summary.html): Read account, stake and social summary data.
- [Parse recent blocks](https://dblurt.beblurt.com/recipes/parse-recent-blocks.html): Bounded block parsing with `client.blockchain.getBlocks()`.
- [Read account history](https://dblurt.beblurt.com/recipes/read-account-history.html): Audit account and virtual operation history.
- [Build post operation](https://dblurt.beblurt.com/recipes/build-post-operation.html): Construct content operations without broadcasting.
- [Handle retryable errors](https://dblurt.beblurt.com/recipes/handle-retryable-errors.html): Classify timeout, transport and RPC errors.
- [Executable examples catalog](https://gitlab.com/beblurt/dblurt/-/blob/main/examples/README.md): Repository examples with metadata and validation status.

## Reference

- [API reference landing](https://dblurt.beblurt.com/reference/api.html): Human router to exact API details.
- [Generated API reference](https://dblurt.beblurt.com/api/): Exact generated class, method, type and deprecation details.
- [Compatibility](https://dblurt.beblurt.com/reference/compatibility.html): Runtime and browser support model.
- [Errors](https://dblurt.beblurt.com/reference/errors.html): Error taxonomy and retryability guidance.
- [Package exports](https://dblurt.beblurt.com/reference/package-exports.html): Import and runtime compatibility details.
- [Changelog](https://gitlab.com/beblurt/dblurt/-/blob/main/CHANGELOG.md): Release history and migration notes.

## AI and contribution context

- [AI context overview](https://gitlab.com/beblurt/dblurt/-/blob/main/ai/README.md): How AI assistants should route to canonical docs.
- [AI coding rules](https://gitlab.com/beblurt/dblurt/-/blob/main/ai/coding-rules.md): Durable coding constraints for assistants.
- [AI pitfalls](https://gitlab.com/beblurt/dblurt/-/blob/main/ai/pitfalls.md): Common mistakes assistants should avoid.
- [AI security constraints](https://gitlab.com/beblurt/dblurt/-/blob/main/ai/security-constraints.md): Key, authority, browser and broadcast safety constraints.
- [Repository agent instructions](https://gitlab.com/beblurt/dblurt/-/blob/main/AGENTS.md): Minimal coding-agent workflow rules.
- [Contributing](https://gitlab.com/beblurt/dblurt/-/blob/main/CONTRIBUTING.md): Contributor workflow and validation expectations.
- [Security policy](https://gitlab.com/beblurt/dblurt/-/blob/main/SECURITY.md): Responsible disclosure and maintainer security expectations.

## Optional

- [llms-full.txt](llms-full.txt): Assembled retrieval document generated from canonical source documents for workflows that need more local context.