docs: document JungleBus subscription pattern + fix TS/verify leftovers#5
Merged
Merged
Conversation
…overs
The core value of JungleBus is filtering through GorillaPool's pre-indexed node
instead of syncing the whole chain yourself — but the README never explained how
to actually define that filter. Add a "Subscriptions" section covering what a
subscription is (a server-side filter you create once → an ID), what to filter on
(MAP/B protocol addresses, or app/wallet addresses), and how {type,id} maps to an
independent watchdog-monitored stream.
Also clean up two leftovers from the TS migration + AIP-verify removal:
- README architecture diagram referenced .js source files (now .ts)
- examples/social.js still wrote a removed `signer_verified` column / `tx.signerVerified`
field; drop both and renumber the INSERT params (now $1..$10)
Build clean, 11/11 tests green.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
1. Document the subscription pattern — the actual reason to use JungleBus. The README told you to "create a subscription" but never explained what that is or how to define the filter. New Subscriptions section covers:
{ type, id }maps to an independent, watchdog-monitored stream (id= on-chain filter,type= your routing label)2. Fix two leftovers from the TS migration + AIP-verify removal:
.jssource files → now.tsexamples/social.jsstill wrote a removedsigner_verifiedcolumn /tx.signerVerifiedfield → dropped both, renumbered INSERT params ($1..$10)Verification
Build clean (
tsc), 11/11 vitest tests green. Docs + example only — no library API change.