Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(js-waku)!: update API for NetworkConfig #193

Merged
merged 8 commits into from
Oct 1, 2024

Conversation

LordGhostX
Copy link
Contributor

@LordGhostX LordGhostX commented May 13, 2024

Copy link

vercel bot commented May 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-waku-org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 1, 2024 6:52am

const shardInfo = { clusterId: 3, shard: 1 };

// Create Filter subscription with custom shard info
const subscription = await node.filter.createSubscription(shardInfo);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a heads up that it will change soon as the current API seems to be too hard to understand. Maybe we can delay this PR or we can follow up on it. I think we will have it updated in a week or so

Copy link
Contributor

@hackyguru hackyguru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added some comments about making the code snippets look less chat focussed

docs/guides/js-waku/light-send-receive.md Outdated Show resolved Hide resolved
@@ -24,6 +24,19 @@ await node.start();
When the `defaultBootstrap` parameter is set to `true`, your node will be bootstrapped using the [default bootstrap method](/guides/js-waku/configure-discovery#default-bootstrap-method). Have a look at the [Bootstrap Nodes and Discover Peers](/guides/js-waku/configure-discovery) guide to learn more methods to bootstrap nodes.
:::

A node needs to know how to route messages. In order to do that you can use standard pubsub topic (`/waku/2/default-waku/proto`). If your project uses a different shared pubsub topic, you can configure this using the `ShardInfo` parameter or by using a set of `contentTopics` that your node will be using:
Copy link
Contributor

@danisharora099 danisharora099 Jun 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nothing to be done right now: heads up that we will soon change the default pubusb topic to the The Waku Network, pending RLN as a Service for Light Clients is merged on nwaku side

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update: nwaku has merged this feature and will be released this week. js-waku will followup

cc @weboko

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the new pubusb topic?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's going to be The Waku Network by default -- we are yet to start a PR for it though.

@fryorcraken
Copy link
Contributor

@waku-org/js-waku can we merge this?

@danisharora099
Copy link
Contributor

@waku-org/js-waku can we merge this?

The API is updated again from the time this PR was opened -- the new API are here: https://github.com/waku-org/docs.waku.org/pull/213/files

Will open a PR against this branch to update the docs here

@danisharora099
Copy link
Contributor

danisharora099 commented Sep 30, 2024

Opened a PR here: #221

@fryorcraken
Copy link
Contributor

@danisharora099 should the present PR be closed then?

@danisharora099 danisharora099 force-pushed the shard-info-js-waku branch 3 times, most recently from 1328218 to 91292db Compare October 1, 2024 06:34
@danisharora099
Copy link
Contributor

@danisharora099 should the present PR be closed then?

Merged that PR here, looks good to merge now

@danisharora099 danisharora099 changed the title update shard info config for js-waku chore(js-waku)!: update API for NetworkConfig Oct 1, 2024
@danisharora099 danisharora099 merged commit 7e81fdc into develop Oct 1, 2024
3 checks passed
@danisharora099 danisharora099 deleted the shard-info-js-waku branch October 1, 2024 06:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

feat: add docs for deprecated namespace pubsub topic
5 participants