mirror of https://github.com/waku-org/js-waku.git
JavaScript implementation of Waku v2
https://js.waku.org
d80042fc47
* move dockerode into a separate class * rename `nwaku` to `WakuNode` to generalise - nwaku and go-waku were running through `nwaku.ts` * move wakunode and docker into one subdir * rename node to `NimGoNode` and update imports in tests * update docker to host all containers in a specific network * update the peer exchange test * assign static IPs to containers * enable relay on px interop * fix px compliance tests * fix import |
||
---|---|---|
.github | ||
.husky | ||
.vscode | ||
ci | ||
nwaku@03f0de365c | ||
packages | ||
.cspell.json | ||
.editorconfig | ||
.eslintrc.json | ||
.gitignore | ||
.gitmodules | ||
.prettierignore | ||
.release-please-manifest.json | ||
.size-limit.cjs | ||
CONTRIBUTING.md | ||
LICENSE-APACHE-v2 | ||
LICENSE-MIT | ||
README.md | ||
bors.toml | ||
package-lock.json | ||
package.json | ||
release-please-config.json | ||
tsconfig.dev.json | ||
tsconfig.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.