watcher-ts/packages/cli
Nabarun Gogoi 9e53b1a498
Upgrade dependency versions to remove vulnerabilities from dependabot (#343)
* Dependency patch updates

* Minor update @apollo/client 3.3.19 -> 3.7.10

* Minor update @nomiclabs/hardhat-ethers 2.0.2 -> 2.2.2

* Minor update @openzeppelin/contracts 4.3.2 -> 4.8.2

* Minor update @types/chai 4.2.19 -> 4.3.4

* Minor update decimal 10.3.1 -> 10.4.3

* Minor update @graphql-tools/utils 9.1.1 -> 9.2.1

* Minor update @graphql, graphql-ws, graphql-request

* Minor update yargs

* Minor update @types/node

* Minor update graph-ts

* Minor updates graphql-tools, multiaddr

* Update dependencies with minor updates

* Minor updates to eslint and related dependencies

* Update solidity compiler version for erc721-watcher

* Fix ESLint indent rule

---------

Co-authored-by: Dhruv Srivastava <dhruvdhs.ds@gmail.com>
2023-03-28 13:17:53 +05:30
..
src Integrate peer in watcher server and send txs to L2 chain (#344) 2023-03-24 16:49:16 +04:00
.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 Upgrade Typescript and ESLint (#337) (#342) 2023-03-24 10:31:33 +04:00
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

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.