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
| 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.
|
|
||
| ## 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
| 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
133
| | 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?
danisharora099
force-pushed
the
feat/opchan
branch
from
3440daf to
b487183
Compare
danisharora099
force-pushed
the
feat/opchan
branch
from
caa2624 to
f66659d
Compare
danisharora099
force-pushed
the
feat/opchan
branch
from
e77bde4 to
6c1b0c3
Compare
danisharora099
force-pushed
the
feat/opchan
branch
from
6c1b0c3 to
1f1be7b
Compare
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.