js-waku/README.md

# js-waku

A JavaScript implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2).

## This is a Work In Progress

You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).

## Examples

## Chat app

A node chat app is provided as a working example of the library.
It is interoperable with the [nim-waku chat app example](https://github.com/status-im/nim-waku/blob/master/examples/v2/chat2.nim).
To run the chat app:

```shell
npm install
npm run chat:app -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ --listenAddr /ip4/0.0.0.0/tcp/55123
```

The `--listenAddr` parameter is optional, however [NAT passthrough](https://github.com/status-im/js-waku/issues/12) is not yet supported, so you'll need the listening port to be open to receive messages from the fleet. 

## Contributing

To build and test this repository, you need:
  
  - [Node.js & npm](https://nodejs.org/en/)
  - [bufbuild](https://github.com/bufbuild/buf)
  - [protoc](https://grpc.io/docs/protoc-installation/) 

To ensure interoperability with [nim-waku](https://github.com/status-im/nim-waku/), some tests are run against a nim-waku node.
This is why `nim-waku` is present as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), which itself contain several submodules.
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/js-waku/blob/main/package.json)).

To build nim-waku, you also need [Rust](https://www.rust-lang.org/tools/install).
Update readme 2021-03-15 03:35:10 +00:00			`# js-waku`
Initial commit Created with bitjson/typescript-starter@586cdb3029ab2c52e2f0893adafbbb017059e1c9 2021-03-04 22:34:01 +00:00
Update readme 2021-03-15 03:35:10 +00:00			`A JavaScript implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2).`

Update readme to include chat app 2021-04-01 00:09:51 +00:00			`## This is a Work In Progress`

			`You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).`

			`## Examples`

			`## Chat app`

			`A node chat app is provided as a working example of the library.`
			`It is interoperable with the [nim-waku chat app example](https://github.com/status-im/nim-waku/blob/master/examples/v2/chat2.nim).`
			`To run the chat app:`

			```shell
			`npm install`
			`npm run chat:app -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ --listenAddr /ip4/0.0.0.0/tcp/55123`
			```

			The `--listenAddr` parameter is optional, however [NAT passthrough](https://github.com/status-im/js-waku/issues/12) is not yet supported, so you'll need the listening port to be open to receive messages from the fleet.
Make testing in CI possible By adding nim-waku as a submodule and building it as part of the tests. 2021-03-15 05:22:26 +00:00
			`## Contributing`

			`To build and test this repository, you need:`

			`- [Node.js & npm](https://nodejs.org/en/)`
			`- [bufbuild](https://github.com/bufbuild/buf)`
			`- [protoc](https://grpc.io/docs/protoc-installation/)`

			`To ensure interoperability with [nim-waku](https://github.com/status-im/nim-waku/), some tests are run against a nim-waku node.`
			This is why `nim-waku` is present as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), which itself contain several submodules.
			At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/js-waku/blob/main/package.json)).

			`To build nim-waku, you also need [Rust](https://www.rust-lang.org/tools/install).`