Update watcher instructions to run job-runner before server

cerc-io · Nov 25, 2022 · de15f2e · de15f2e
1 parent bb89b2d
commit de15f2e
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 32 deletions.
diff --git a/packages/codegen/src/templates/hooks-template.handlebars b/packages/codegen/src/templates/hooks-template.handlebars
@@ -37,7 +37,7 @@ export async function createInitialState (indexer: Indexer, contractAddress: str
 
 /**
  * Hook function to create state diff.
- * @param indexer Indexer instance that contains methods to fetch the contract varaiable values.
+ * @param indexer Indexer instance that contains methods to fetch the contract variable values.
  * @param blockHash Block hash of the concerned block.
  */
 export async function createStateDiff (indexer: Indexer, blockHash: string): Promise<void> {

diff --git a/packages/codegen/src/templates/readme-template.handlebars b/packages/codegen/src/templates/readme-template.handlebars
@@ -73,13 +73,15 @@ To enable GQL requests caching:
 
 ## Run
 
-* Run the watcher:
+* If the watcher is a `lazy` watcher:
 
-  ```bash
-  yarn server
-  ```
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
 
-GQL console: http://localhost:{{port}}/graphql
+    GQL console: http://localhost:{{port}}/graphql
 
 * If the watcher is an `active` watcher:
 
@@ -89,6 +91,14 @@ GQL console: http://localhost:{{port}}/graphql
     yarn job-runner
     ```
 
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
+
+    GQL console: http://localhost:{{port}}/graphql
+
   * To watch a contract:
 
     ```bash

diff --git a/packages/eden-watcher/README.md b/packages/eden-watcher/README.md
@@ -61,13 +61,15 @@
 
 ## Run
 
-* Run the watcher:
+* If the watcher is a `lazy` watcher:
 
-  ```bash
-  yarn server
-  ```
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
 
-GQL console: http://localhost:3012/graphql
+    GQL console: http://localhost:3012/graphql
 
 * If the watcher is an `active` watcher:
 
@@ -77,6 +79,14 @@ GQL console: http://localhost:3012/graphql
     yarn job-runner
     ```
 
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
+
+    GQL console: http://localhost:3012/graphql
+
   * To watch a contract:
 
     ```bash

diff --git a/packages/erc20-watcher/README.md b/packages/erc20-watcher/README.md
@@ -70,26 +70,28 @@ yarn build
 
 Run the watcher:
 
+Start the job runner:
+
 ```bash
-$ yarn server
+$ yarn job-runner
 
 # For development.
-$ yarn server:dev
+$ yarn job-runner:dev
 
 # For specifying config file.
-$ yarn server -f environments/local.toml
+$ yarn job-runner -f environments/local.toml
 ```
 
-Start the job runner:
+Start the server:
 
 ```bash
-$ yarn job-runner
+$ yarn server
 
 # For development.
-$ yarn job-runner:dev
+$ yarn server:dev
 
 # For specifying config file.
-$ yarn job-runner -f environments/local.toml
+$ yarn server -f environments/local.toml
 ```
 
 GQL console: http://localhost:3001/graphql

diff --git a/packages/erc721-watcher/README.md b/packages/erc721-watcher/README.md
@@ -71,11 +71,15 @@ Follow the steps below or follow the [Demo](./demo.md)
 
 * Run the watcher:
 
-  ```bash
-  yarn server
-  ```
+* If the watcher is a `lazy` watcher:
+
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
 
-GQL console: http://localhost:3006/graphql
+    GQL console: http://localhost:3006/graphql
 
 * If the watcher is an `active` watcher:
 
@@ -85,6 +89,14 @@ GQL console: http://localhost:3006/graphql
     yarn job-runner
     ```
 
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
+
+    GQL console: http://localhost:3012/graphql
+
   * To watch a contract:
 
     ```bash

diff --git a/packages/graph-test-watcher/README.md b/packages/graph-test-watcher/README.md
@@ -63,13 +63,13 @@
 
 ## Run
 
-* Run the watcher:
+  * Run the server:
 
-  ```bash
-  yarn server
-  ```
+    ```bash
+    yarn server
+    ```
 
-GQL console: http://localhost:3008/graphql
+    GQL console: http://localhost:3008/graphql
 
 * If the watcher is an `active` watcher:
 
@@ -79,6 +79,14 @@ GQL console: http://localhost:3008/graphql
     yarn job-runner
     ```
 
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
+
+    GQL console: http://localhost:3008/graphql
+
   * To watch a contract:
 
     ```bash

diff --git a/packages/mobymask-watcher/README.md b/packages/mobymask-watcher/README.md
@@ -63,13 +63,13 @@
 
 Follow the steps below or follow the [Demo](./demo.md)
 
-* Run the watcher:
+  * Run the server:
 
-  ```bash
-  yarn server
-  ```
+    ```bash
+    yarn server
+    ```
 
-GQL console: http://localhost:3010/graphql
+    GQL console: http://localhost:3010/graphql
 
 * If the watcher is an `active` watcher:
 
@@ -79,6 +79,14 @@ GQL console: http://localhost:3010/graphql
     yarn job-runner
     ```
 
+  * Run the server:
+
+    ```bash
+    yarn server
+    ```
+
+    GQL console: http://localhost:3010/graphql
+
   * To watch a contract:
 
     ```bash