watcher-ts/packages/cli
2023-01-10 20:32:05 +05:30
..
src Implement peer package to send messages between peers (#279) 2023-01-10 20:10:27 +05:30
.eslintignore Refactor watch-contract CLI to cli package (#245) 2022-11-21 11:47:23 +04:00
.eslintrc.json Refactor watch-contract CLI to cli package (#245) 2022-11-21 11:47:23 +04:00
.npmignore Refactor watch-contract CLI to cli package (#245) 2022-11-21 11:47:23 +04:00
package.json Update version to 0.2.20 (#291) 2023-01-10 20:32:05 +05:30
README.md Implement peer package to send messages between peers (#279) 2023-01-10 20:10:27 +05:30
tsconfig.json Implement peer package to send messages between peers (#279) 2023-01-10 20:10:27 +05:30

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) Run a local signalling server:

    # In packages/peer
    yarn signal-server
    
  • (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)
  • (Optional) Run a local relay node:

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

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