mirror of
https://github.com/cerc-io/watcher-ts
synced 2024-10-03 14:42:37 +00:00
c46d5c3f33
* Refactor discovery handler * Broadcast peer info over floodsub on requests * Broadcast peer info from relay nodes * Make debug reponse handler optional * Register debug info request handler on peer init * Move debug info types to types dir * Return method to unsubscribe from the debug topic * Make debug info flag optional for relay nodes * Restructure peer connection info data * Refactor getting peer info to be used in react app * Refactor duplicate code to utils * Rename peer methods --------- Co-authored-by: nabarun <nabarun@deepstacksoft.com>
57 lines
1.8 KiB
Markdown
57 lines
1.8 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) 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) (default: logs to console)
|
|
|
|
* (Optional) Run a local relay node:
|
|
|
|
```bash
|
|
# In packages/peer
|
|
yarn relay-node --host [LISTEN_HOST] --port [LISTEN_PORT] --announce [ANNOUNCE_DOMAIN] --peer-id-file [PEER_ID_FILE_PATH] --relay-peers [RELAY_PEERS_FILE_PATH]
|
|
```
|
|
|
|
* `host (h)`: host to bind to (default: `127.0.0.1`)
|
|
* `port (p)`: port to start listening on (default: `9090`)
|
|
* `announce (a)`: domain name to be used in the announce address
|
|
* `peer-id-file (f)`: file path for peer id to be used (json)
|
|
* `relay-peers (r)`: file path for relay peer multiaddr(s) to dial on startup (json)
|
|
|
|
* Start the node:
|
|
|
|
```bash
|
|
# In packages/cli
|
|
yarn chat --relay-multiaddr <RELAY_MULTIADDR> --max-connections [MAX_CONNECTIONS] --dial-timeout [DIAL_TIMEOUT] --max-relay-connections [MAX_RELAY_CONNECTIONS] --peer-id-file [PEER_ID_FILE_PATH] --enable-debug-info [ENABLE_DEBUG_INFO]
|
|
```
|
|
|
|
* `relay-multiaddr (r)`: multiaddr of a primary hop enabled relay node
|
|
* `max-connections`: max number of connections for this peer
|
|
* `dial-timeout`: timeout for dial to peers (ms)
|
|
* `max-relay-connections`: max number of relay node connections for this peer
|
|
* `peer-id-file (f)`: file path for peer id to be used (json)
|
|
* `enable-debug-info`: Whether to broadcast node's info over floodsub on request
|
|
|
|
* The process starts reading from `stdin` and outputs messages from others peers over the `/chat/1.0.0` protocol to `stdout`.
|