chore: add docs for @opchan forum library
#257
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
fryorcraken
reviewed
Nov 15, 2025
| "node": ">=16.14" | ||
| } | ||
| }, | ||
| "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" |
Contributor
There was a problem hiding this comment.
Not convinced this belongs here.
| "build/javascript/manage-filter", | ||
| "build/javascript/faq", | ||
| ======= | ||
| "guides/js-waku/light-send-receive", |
| @@ -0,0 +1,537 @@ | |||
| --- | |||
| title: Build Forum UIs with @opchan/react | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Build Forum UIs with @opchan/react | |
| title: Build a Forum |
| description: Ship decentralized forum experiences over Waku using the OpChan React SDK. | ||
| --- | ||
|
|
||
| `@opchan/react` adds a forum-focused state layer on top of `@opchan/core`, Wagmi, and the Waku network. |
Contributor
There was a problem hiding this comment.
Can we do a raw non react example too?
fryorcraken
reviewed
Nov 15, 2025
Contributor
fryorcraken
left a comment
fryorcraken
left a comment
There was a problem hiding this comment.
Did you feed that in an LLM see if they can build with it? IT would be the easiest way to test.
| @@ -0,0 +1,537 @@ | |||
| --- | |||
| title: Build Forum UIs with @opchan/react | |||
| sidebar_label: Build Forum UIs with OpChan | |||
Contributor
There was a problem hiding this comment.
Suggested change
| sidebar_label: Build Forum UIs with OpChan | |
| sidebar_label: Build a Forum |
|
|
||
| ## Why OpChan on Waku? | ||
|
|
||
| - **Forum-first primitives** – cells, posts, comments, votes, bookmarks, and moderation helpers. |
Contributor
There was a problem hiding this comment.
The relevance score should be top of the list
|
|
||
| ## 1. Bootstrap the provider | ||
|
|
||
| Add the Buffer polyfill (still required by many crypto libraries) and wrap your tree with `OpChanProvider`. The provider internally wires Wagmi, React Query, and the OpChan client to the Waku relay layer. Configure it with the content topic you want to publish under plus the reliable channel id you use for the [Waku Reliable Message Channel](https://specs.vac.dev/specs/waku/waku-reliable-message-delivery/). |
Contributor
There was a problem hiding this comment.
Suggested change
| Add the Buffer polyfill (still required by many crypto libraries) and wrap your tree with `OpChanProvider`. The provider internally wires Wagmi, React Query, and the OpChan client to the Waku relay layer. Configure it with the content topic you want to publish under plus the reliable channel id you use for the [Waku Reliable Message Channel](https://specs.vac.dev/specs/waku/waku-reliable-message-delivery/). | |
| Add the Buffer polyfill (still required by many crypto libraries) and wrap your tree with `OpChanProvider`. The provider internally wires Wagmi, React Query, and the OpChan client to the Waku relay layer. Configure it with the content topic you want to publish under plus the reliable channel id you use for the [Reliable Channel](/build/javascript/reliable-channels). |
Point to reliable channel docs which are simpler, instead of specs.
Comment on lines
+76
to
+77
| contentTopic: '/opchan/1/messages/proto', | ||
| reliableChannelId: 'opchan-messages', |
Contributor
There was a problem hiding this comment.
Maybe add a comment that by using this value, they will get the data from the deployed https://opchan.app/ instance; they should change both values if they want different their own data silo.
| contentTopic: '/opchan/1/messages/proto', | ||
| reliableChannelId: 'opchan-messages', | ||
| }, | ||
| reownProjectId: import.meta.env.VITE_REOWN_PROJECT_ID, |
Contributor
There was a problem hiding this comment.
is it clarified how this value is passed later?
Comment on lines
+105
to
+113
| | Hook | Purpose | Typical actions | | ||
| | --- | --- | --- | | ||
| | `useAuth()` | Manage sessions, ENS verification, call signs, and delegation | `connect()`, `startAnonymous()`, `delegate('7days')`, `updateProfile()` | | ||
| | `useContent()` | Read/write cells, posts, comments, votes, bookmarks | `createPost()`, `vote()`, `moderate.post()`, `pending.isPending(id)` | | ||
| | `usePermissions()` | Query derived capabilities and friendly denial reasons | `canCreateCell`, `canModerate(cellId)`, `check('canPost')` | | ||
| | `useNetwork()` | Reflect Waku connection status and hydration lifecycle | `isConnected`, `statusMessage`, `refresh()` | | ||
| | `useUserDisplay(address)` | Resolve ENS + call-sign metadata for any address | `displayName`, `ensAvatar`, `verificationStatus` | | ||
| | `useUIState(key, defaultValue, category?)` | Persist UI state to IndexedDB | `[value, setValue]` pair scoped by key | | ||
| | `useEthereumWallet()` / `useClient()` | Advanced access to Wagmi connectors or the raw `OpChanClient` | `signMessage()`, direct database interactions | |
Contributor
There was a problem hiding this comment.
Can you format the table in MD so it's easier to review?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.