cerc-io/watcher-ts
15
1
Fork 0
mirror of https://github.com/cerc-io/watcher-ts synced 2024-10-02 22:22:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
f2bc054c19
watcher-ts/packages/cli
History
Nabarun Gogoi f2bc054c19
Rename nitro-client to nitro-node (#402) 
* Rename nitro-client to nitro-node

* Upgrade package versions to 0.2.53

---------

Co-authored-by: neeraj <neeraj.rtly@gmail.com>
2023-08-16 17:57:15 +05:30
..
src Implement rpc-eth-client for Ethereum compatible JSON-RPC endpoint (#398) 2023-08-08 18:48:55 +05:30
.eslintignore Refactor watch-contract CLI to cli package (#245) 2022-11-21 11:47:23 +04:00
.eslintrc.json Upgrade dependency versions to remove vulnerabilities from dependabot (#343) 2023-03-28 13:17:53 +05:30
.npmignore Refactor watch-contract CLI to cli package (#245) 2022-11-21 11:47:23 +04:00
package.json Rename nitro-client to nitro-node (#402) 2023-08-16 17:57:15 +05:30
README.md Broadcast peer info over floodsub when requested (#332) 2023-03-06 10:20:51 +05:30
tsconfig.json Implement peer package to send messages between peers (#279) 2023-01-10 20:10:27 +05:30

README.md

cli

chat

A basic CLI to pass messages between peers using stdin/stdout

  • Install dependencies:

    yarn install

  • Build the peer package:

    cd packages/peer
yarn build

  • (Optional) Create and export a peer id for the relay node:

    # 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:

    # 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:

    # 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.