2.6 KiB
Nexus Layer 2 guide
Nexus exposes social/indexed views through the bridge API. In dblurt, those helpers live under client.nexus.
For canonical terminology and the Layer 1 / Nexus boundary, see Blockchain model.
Typical use cases
- ranked feeds;
- community discovery;
- post and discussion views;
- profile summaries;
- notifications;
- referral lookups.
Examples
const posts = await client.nexus.getRankedPosts({
sort: 'trending',
limit: 10,
tag: 'blurt',
observer: null
});
The historical positional form remains supported for compatibility:
const posts = await client.nexus.getRankedPosts('trending', null, null, 10, 'blurt');
const community = await client.nexus.getCommunity('blurt', null);
console.log(community.title);
const profile = await client.nexus.getProfile('beblurt', null);
console.log(profile.name);
Typed option objects
Several pagination-heavy helpers accept typed option objects in addition to the original positional signatures. Maintainer policy: positional Nexus signatures are legacy-supported but not deprecated for now; they are stable public API and remain useful for concise simple reads. Prefer option objects for new pagination/filter-heavy code because they make nullable cursor, observer and filter semantics explicit while preserving existing positional compatibility.
Examples include accountNotifications, getAccountPosts, getRankedPosts, listCommunities, postNotifications, unreadNotifications, referralAccounts and referralAccountsCount.
listPopComunities remains available with its historical spelling but is deprecated. New code should use the corrected alias listPopCommunities; both route to the same bridge.list_pop_communities method.
Common helpers
| Helper | Purpose |
|---|---|
getRankedPosts |
ranked post lists: trending, hot, created, promoted, payout, payout_comments, muted |
getPost |
fetch one Nexus post by author/permlink |
getDiscussion |
flattened discussion tree keyed by author/permlink |
getProfile |
profile summary with parsed metadata |
listCommunities |
community discovery and pagination |
getCommunity |
full community object, optionally observer-aware |
listSubscribers |
community subscriber list |
accountNotifications |
account notification feed |
unreadNotifications |
unread notification count |
referralAccounts |
referral account lookup |
What this guide does not cover
This guide documents the public dblurt API surface. It does not document Nexus-Go migration internals.