mirror of https://github.com/waku-org/js-waku.git
JavaScript implementation of Waku v2
https://js.waku.org
8deab11890
* chore: restructure @waku/sdk * chore: introduce `BaseProtocolCore` and `BaseProtocolSDK` * chore: introduce `LightPushCore` and `LightPushSDK` * chore: update `relay` for new types * chore(sdk): update structure * chore(filter): add `numPeersToUse` * chore: update tests * update: size-limit * chore: update more tests * attach issue link to TODOs |
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| ci | ||
| packages | ||
| .cspell.json | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .release-please-manifest.json | ||
| .size-limit.cjs | ||
| CONTRIBUTING.md | ||
| LICENSE-APACHE-v2 | ||
| LICENSE-MIT | ||
| README.md | ||
| bors.toml | ||
| karma.conf.cjs | ||
| package-lock.json | ||
| package.json | ||
| release-please-config.json | ||
| tsconfig.dev.json | ||
| tsconfig.json | ||
| typedoc.base.json | ||
| typedoc.cjs | ||
README.md
js-waku
A TypeScript implementation of the Waku v2 protocol.
Documentation
API Documentation can also be generated locally:
git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to open an issue.
For general discussion, get help or latest news, join us on Vac Discord or the Waku Telegram Group.
Roadmap
You can track progress on the project board.
Contributing
See CONTRIBUTING.md.
License
Licensed and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- Apache License, Version 2.0, (LICENSE-APACHE-v2 or http://www.apache.org/licenses/LICENSE-2.0)
at your option. These files may not be copied, modified, or distributed except according to those terms.