watcher-ts/packages/cli/README.md

# 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 pubsub on request

* The process starts reading from `stdin` and outputs messages from others peers over the `/chat/1.0.0` protocol to `stdout`.

## compare-gql

A basic CLI to to fetch and compare watcher GQL response.

* Create a `config.yaml` file in the following format in `packages/cli`:

  ```yaml
  # Watcher URL
  url: ""

  # Boolean to specify if it is a subgraph watcher
  isSubgraph: false

  # File path for saving GQL result
  gqlResultFilepath: "./result.json"

  # Optional parameter to override default GQL query
  graphqlQuery: ""
  ```

* Run the following command to fetch and save first GQL response:

  ```
  yarn compare-gql --config config.yaml
  ```

  * On running CLI for the first time

    ```
      vulcanize:compare-gql Fetching response for the first time, re run CLI to compare with latest GQL response
    ```

* Re run CLI after some time (average time taken for new block in Ethereum: `~12 seconds`)

  ```
  yarn compare-gql --config config.yaml
  ```

* The diff for latest and previous GQL responses is shown

## proxy

Runs a proxy server pointed to the given upstream endpoint

* Install dependencies and build:

  ```bash
  # In repo root
  yarn

  # In packages/cli
  yarn build
  ```

* Run the proxy server:

  ```bash
  yarn proxy --upstream <UPSTREAM_ENDPOINT> --origin-header [ORIGN_HEADER] --port [PROXY_SERVER_PORT]

  # For details, run: yarn proxy --help
  ```