JavaScript implementation of Waku v2 https://js.waku.org

Go to file

Danish Arora 199f6ab2ff feat: local discovery (#1811 ) * initialise the new package * feat: implement LocalStorageDiscovery * add: Startable to cspell * add compliance test * add: discovery tests * rm: browser tests script * address comments * add type safety to getting peers from local * only dispatch peer if it does not exist * move ws ma extraction to utils * chore: update package name to local-discovery * fix: add compliance test with no external deps on service node * use peer:identify instead of peer:update * add: unit tests & remove sdk dependency * move tests to self package * update cspell + remove unrequired deps * add types * maintain in-memory peers for localstorage * address comments * chore: rename * use name from options * fix: saving peers * rm: only		2024-02-16 20:06:27 +05:30
.github	fix(tests): append `p2p` with the multiaddrs from ENR (#1817 )	2024-02-07 01:57:41 +05:30
.husky	Add git hook to format & lint file	2022-02-25 14:18:46 +11:00
.vscode	chore: use updated flag for eslint (#1831 )	2024-02-08 12:25:00 +05:30
ci	feat: add ability to pre release (#1664 )	2023-11-01 16:15:24 +01:00
packages	feat: local discovery (#1811 )	2024-02-16 20:06:27 +05:30
.cspell.json	feat: local discovery (#1811 )	2024-02-16 20:06:27 +05:30
.editorconfig	Initial commit	2021-03-05 09:34:01 +11:00
.eslintrc.json	chore!: change all instances of `PubSubTopic` to `PubsubTopic` (#1703 )	2023-11-14 18:52:52 +03:00
.gitignore	feat: local discovery (#1811 )	2024-02-16 20:06:27 +05:30
.prettierignore	chore: use root .prettierignore (#1285 )	2023-04-03 23:39:59 +02:00
.release-please-manifest.json	chore: release master (#1721 )	2024-01-10 23:27:39 +01:00
.size-limit.cjs	chore!: remove filter v1 (#1433 )	2023-07-26 11:30:48 +05:30
CONTRIBUTING.md	chore: make pre-release manual (#1702 )	2023-11-06 10:39:06 +01:00
LICENSE-APACHE-v2	Apply MIT or Apache V2.0 License	2021-04-28 21:27:26 +10:00
LICENSE-MIT	Apply MIT or Apache V2.0 License	2021-04-28 21:27:26 +10:00
README.md	chore: README.md: fix quick start link (#1607 )	2023-09-22 17:32:34 +02:00
bors.toml	chore: must always build first now	2022-11-02 14:16:31 +11:00
karma.conf.cjs	remove webkit from running (#1621 )	2023-09-27 15:15:07 +05:30
package-lock.json	feat: local discovery (#1811 )	2024-02-16 20:06:27 +05:30
package.json	feat: local discovery (#1811 )	2024-02-16 20:06:27 +05:30
release-please-config.json	chore: remove forced release version of sdk (#1406 )	2023-06-17 01:46:29 +02:00
tsconfig.dev.json	chore: update typescript (#1528 )	2023-09-21 10:57:37 +02:00
tsconfig.json	chore: update typescript (#1528 )	2023-09-21 10:57:37 +02:00
typedoc.base.json	chore: update typescript (#1528 )	2023-09-21 10:57:37 +02:00
typedoc.cjs	chore: update typescript (#1528 )	2023-09-21 10:57:37 +02:00

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

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.