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

feat: HTTP REST API: Filter #1851

Closed
3 tasks
Tracked by #1076
jm-clius opened this issue Jul 13, 2023 · 0 comments · Fixed by #1864
Closed
3 tasks
Tracked by #1076

feat: HTTP REST API: Filter #1851

jm-clius opened this issue Jul 13, 2023 · 0 comments · Fixed by #1864
Assignees
Labels
good first issue Good for newcomers release-notes Issue/PR needs to be evaluated for inclusion in release notes highlights or upgrade instructions

Comments

@jm-clius
Copy link
Contributor

Background

This forms a subtask of #1076.
Nwaku nodes operating as 12/WAKU2-FILTER clients can use the filter protocol to subscribe to service nodes to receive messages adhering to a set of subscription criteria.
Currently these filter operations can only be triggered in clients in an internal Nim API call.
Although there exists an external filter client JSON-RPC API, this was designed for a deprecated version of the filter protocol. There is therefore no external API for filter client calls.
The JSON-RPC API is clunky to use and call signatures outdated. As such, we've started migrating to an HTTP REST API.

Suggested solution

Create and expose a Filter Client HTTP REST API functionality. It should use the existing REST APIs as inspiration and follow the same patterns and structure. Although, the JSON-RPC API can be referred to, the new API method should follow the new filter API specifications to construct the calls.

Acceptance criteria

  • working HTTP Filter Client REST API to perform filter client operations on remote service nodes
  • sufficient unit tests for basic functionality
  • integration of Filter Client API into the wakunode2 app
@NagyZoltanPeter NagyZoltanPeter self-assigned this Jul 18, 2023
NagyZoltanPeter pushed a commit that referenced this issue Jul 28, 2023
NagyZoltanPeter pushed a commit that referenced this issue Jul 28, 2023
… for it still not functional due peer connection issue.
@NagyZoltanPeter NagyZoltanPeter linked a pull request Jul 28, 2023 that will close this issue
2 tasks
@vpavlin vpavlin added this to the Release 0.19.0 milestone Aug 1, 2023
NagyZoltanPeter added a commit that referenced this issue Aug 4, 2023
* Added Rest API interface for legacy (v1) filter service with tests.
@vpavlin vpavlin added the release-notes Issue/PR needs to be evaluated for inclusion in release notes highlights or upgrade instructions label Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers release-notes Issue/PR needs to be evaluated for inclusion in release notes highlights or upgrade instructions
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants