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

nwaku API: push notifications on Relay and Filter API #938

Closed
1 task
jm-clius opened this issue Apr 5, 2022 · 4 comments
Closed
1 task

nwaku API: push notifications on Relay and Filter API #938

jm-clius opened this issue Apr 5, 2022 · 4 comments
Labels
E:REST API service node See https://github.com/waku-org/pm/issues/82 for details

Comments

@jm-clius
Copy link
Contributor

jm-clius commented Apr 5, 2022

Background

When the JSON-RPC API was implemented for nwaku nodes, one outstanding task was push notifications for new messages on subscribed pubsubTopics and contentTopics on the Filter and Relay APIs. This task was awaiting Nim websocket support, which has since been added.

Note, however, that with the introduction of a secure web server in Nim it is now possible to implement an HTTP REST API, which may be even more useful than the JSON-RPC API.

Acceptance criteria

  • Ability to receive push notifications for new messages over a websocket connection in either the JSON-RPC API, a new HTTP REST API, or both.

cc @sbc64

@oskarth oskarth added this to New in Deprecated: nwaku Apr 5, 2022
@jm-clius jm-clius moved this from New to Icebox in Deprecated: nwaku Apr 11, 2022
@Ivansete-status
Copy link
Collaborator

I think that this can be closed as we have the REST API for relay as it is implemented and Zoltán will implement the filter one. @jm-clius , kindly close this if you agree.

@jm-clius
Copy link
Contributor Author

The new APIs do not necessarily remove the polling requirement on client nodes. This issue can remain open to track work to convert from a polling to "push" model based on websockets.

@fryorcraken fryorcraken added the E:REST API service node See https://github.com/waku-org/pm/issues/82 for details label Sep 5, 2023
@chair28980
Copy link
Contributor

@jm-clius should we keep this issue open, or re-scope this work into 2024 milestones/epics?

@jm-clius
Copy link
Contributor Author

jm-clius commented Jan 2, 2024

The issue of a push vs polling interface has been open but unactioned for quite a long time. As it stands I think the polling API works well enough for us to descope this work (for now). I'd close this issue and reopen when the need arise

@jm-clius jm-clius closed this as not planned Won't fix, can't repro, duplicate, stale Jan 2, 2024
Deprecated: nwaku automation moved this from Icebox to Done Jan 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E:REST API service node See https://github.com/waku-org/pm/issues/82 for details
Projects
Archived in project
Development

No branches or pull requests

4 participants