mirror of
https://github.com/cerc-io/watcher-ts
synced 2025-01-23 11:39:05 +00:00
Nabarun Gogoi
cd29b47ecc
* Initial implementation of class and discoving other peers * Implement peer connection and sending messages between peers * Add react app and use peer package for broadcasting * Maintain stream for each remote peer * Refactor code in peer package * Add serve package for react-app * Add readme for running react app * Add peer package readme * Add logs for events with details * Add a chat CLI using peer package (#280) * Add a flag to instantiate Peer for nodejs * Add a basic chat CLI using peer * Add a signal server arg to chat CLI * Add instructions for chat CLI * Fix typescript and ESM issues after adding peer package (#282) * Fix build issues in util package * Update eslint TS plugins * Scope react app package name * Convert cli package back to CJS and dynamically import ESM * Upgrade ts-node version * Fix tests * Setup a relay node and pubsub based discovery (#284) * Add a script to setup a relay node * Use pubsub based peer discovery * Add peer multiaddr to connection log * Catch relay node dial errors * Increase discovery interval and dial all mutiaddr * Add UI to display self peer ID and multiaddrs * Add UI for displaying live remote connections * Send js objects in peer broadcast messages * Add react-peer package for using peer in react app * Reduce disconnect frequency between peers (#287) * Restrict number of max concurrent dials per peer * Increase hop relay timeout to 1 day * Self review changes * Review changes * Increase pubsub discovery interval and add steps to create a peer id (#290) * Increase pubsub discovery interval * Disable autodial to avoid peer dials without protocol on a reconnect * Add steps to create a peer id and use for relay node * Add back dependency to run signalling server * Avoid bootstrapping and dial to relay node directly Co-authored-by: prathamesh0 <42446521+prathamesh0@users.noreply.github.com> Co-authored-by: prathamesh0 <prathamesh.musale0@gmail.com>
57 lines
1.2 KiB
Markdown
57 lines
1.2 KiB
Markdown
# cli
|
|
|
|
## chat
|
|
|
|
A basic CLI to pass messages between peers using `stdin`/`stdout`
|
|
|
|
* Install dependencies:
|
|
|
|
```bash
|
|
yarn install
|
|
```
|
|
|
|
* Build the `peer` package:
|
|
|
|
```
|
|
cd packages/peer
|
|
yarn build
|
|
```
|
|
|
|
* (Optional) Run a local signalling server:
|
|
|
|
```bash
|
|
# In packages/peer
|
|
yarn signal-server
|
|
```
|
|
|
|
* (Optional) Create and export a peer id for the relay node:
|
|
|
|
```bash
|
|
# In packages/peer
|
|
yarn create-peer --file [PEER_ID_FILE_PATH]
|
|
```
|
|
|
|
* `file (f)`: file path to export the peer id to (json)
|
|
|
|
* (Optional) Run a local relay node:
|
|
|
|
```bash
|
|
# In packages/peer
|
|
yarn relay-node --signal-server [SIGNAL_SERVER_URL] --peer-id-file [PEER_ID_FILE_PATH]
|
|
```
|
|
|
|
* `signal-server`: multiaddr of a signalling server (default: local signalling server multiaddr)
|
|
* `peer-id-file`: file path for peer id to be used (json)
|
|
|
|
* Start the node:
|
|
|
|
```bash
|
|
# In packages/cli
|
|
yarn chat --signal-server [SIGNAL_SERVER_URL] --relay-node [RELAY_NODE_URL]
|
|
```
|
|
|
|
* `signal-server`: multiaddr of a signalling server (default: local signalling server multiaddr)
|
|
* `relay-node`: multiaddr of a hop enabled relay node
|
|
|
|
* The process starts reading from `stdin` and outputs messages from others peers to `stdout`.
|