feat: Plugin API

[weboko]

This is a feature request

Problem

At this point js-waku is in a position when it is good to be considered for new projects but still raw to be able to seamlessly plugin into any project. When consumer tries to use @waku/sdk they face either a need to write wrapper or to lear Waku concepts and adopt it as it is.

Our plan to address it is to have dedicated teams for specific uses but it still does not address all demand observed.

Proposed Solutions

To address it I propose to develop Plugin API. This would allow to develop some ecosystem around js-waku and offload implementation of adapters to community.

Possible API can look like:

import waku from "@waku/sdk";
import socketAdapter from "@waku/socket";
...
waku.use(socketAdapter); // extends types on waku node, unlocks 
...
waku.on("event", fn); // now we can do

Plugin API would help to simplify dependency graph of projects that are using js-waku.

In case someone (or core team) develops an adapter it would look like:

graph TD;
A[waku-sdk-v2] -->|import| D[consumer]
C[waku-sdk-v1] -->|import| B
B[waku-socket] -->|import| D

Loading

But with this API it will be simplified to:

graph TD;
A[waku-sdk-1] -->|import| D[consumer]
B[waku-socket] -->|import| D
A -->|use| B

Loading

Objectives

• develop daft of design for Plugin API;
• implement this API for @waku/sdk;
• create template project for plugins;

Notes

Ref - Core plugin concepts in Chai

[fryorcraken]

I assume we should implement #1463 this way? so that one could just use waku.filter.... but the plugin would automatically manage multiple subscriptions?
And the API would not change whether you use the plugin or not?

If so, then maybe this issue could be a good way to put this idea to the test.