Advanced docs for js-waku

[fryorcraken]

Planned start date:
Due date:

Summary

Complement the current basic js-waku docs.

Acceptance Criteria

The following guides are published:

• Use @waku/react
• Use symmetric encryption/decryption
• Use ECIES encryption/decryption
• Use noise for device pairing
• Instructions to debug your web app when using js-waku
• js-waku in NodeJS
• Instructions to run a nwaku node for local js-waku browser development

Tasks

• different auth/encryption protocols available #26

RAID (Risks, Assumptions, Issues and Dependencies)

• js-waku's API needs to be stable and reliable
• js-waku devs need to provide support and fix any raised bug

[LordGhostX]

Weekly Update

• next: create guide on @waku/react and debugging js-waku web apps

[fryorcraken]

Also explain js-waku in NodeJS.
Current recommendations for NodeJS
And that it doesn't make sense to use BE/FE model like NestJS or express.

[fryorcraken]

Also explain local development setup. Running nwaku docker with ws (not wss), serving website locally and the fact that secure context protection from the browser (no ws in https) doesn't apply when the website is served locally (127.0.0.1 url)

[LordGhostX]

Weekly Update

• next: document notes/recommendations for NodeJS, begin docs on js-waku encryption

[LordGhostX]

Weekly Update

• achieved: added guide for js-waku debugging and running in NodeJS
• next: js-waku encryption guides

[LordGhostX]

Weekly Update

• achieved: added guide for local development with nwaku

[fryorcraken]

Manage filter subscription to be added here cc @danisharora099

[danisharora099]

@LordGhostX we want to add a new section perhaps titled Manage your Filter subscription where:

• if they wish to maintain their Filter subscription (to account for unwarranted disconnections with the node), they should keep a recurring ping open on Filter to check for active subscriptions.
• If the ping fails with the error message includes peer has no subscriptions (happy to provide a better way to handle this case if required)
• if it's a deliberate disconnection/unsubscribe for the Filter subscription, pings can be stopped.

Added a test to js-waku that can be used as a reference for this section: waku-org/js-waku#1656 (perhaps a permalink to this can be used for the prod docs when the PR is merged and the entire ping.node.spec.ts file can be used a reference for Filter.ping())

Please let me know if you would prefer any change of API/improvements :)
Also, I'm happy to make a PR to the docs if you'd prefer :)

[danisharora099]

Also part of waku-org/js-waku#914, we would like to add docs around consumers being able to gauge connection/disconnection with nodes for peers: waku-org/js-waku#1412 (comment) sums up how we can do that

[LordGhostX]

Weekly Update

• achieved: added createSubscription() docs in update docs #128
• next: tackle @waku/sdk deprecated namespace feat: add docs for deprecated namespace pubsub topic  #131, create filter management docs

[LordGhostX]

Weekly Update

• achieved: filter management docs
• next: deprecated namespace docs feat: add docs for deprecated namespace pubsub topic  #131

[LordGhostX]

Weekly Update

• achieved: published manage filter guide, finished react docs
• next: ECIES and symmetric encryption/decryption

[fryorcraken]

@LordGhostX I think we can close this issue and track encryption with #125