mirror of https://github.com/waku-org/js-waku.git
bf42c8f53a
* refactor the Store protocol into Core and SDK, simplify `queryGenerator()` * update imports & types * chore: `@noble/hashes` moves to `sdk` * chore: update tests * chore: update size-limit import path * fix: cursor tests, use `Cursor` type from `proto.Index` instead of redefining * export wakuStore from sdk * fix: imports * chore: use specific version for package * chore: handle error for peer access * use type instead of interface * rm: comment * add TODO * chore!: remove deprecated function definition * chore: improve logging |
||
---|---|---|
.. | ||
src | ||
.eslintrc.cjs | ||
.mocha.reporters.json | ||
.mocharc.cjs | ||
CHANGELOG.md | ||
README.md | ||
karma.conf.cjs | ||
package.json | ||
rollup.config.js | ||
tsconfig.dev.json | ||
tsconfig.json | ||
typedoc.json |
README.md
@waku/core
Core components of 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
Changelog
Release changelog can be found in CHANGELOG.md.
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 #js-waku 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.