Merge pull request #18 from graphprotocol/mde/update-readme

chore: update README to latest changes
graphprotocol · Apr 22, 2024 · 25c9ae7 · 25c9ae7
2 parents 97459ba + 2901901
commit 25c9ae7
Showing 1 changed file with 62 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -3,49 +3,95 @@ The Subgraph Oracle verifies the availability of the subgraph files and does oth
 
 ```
 USAGE:
-    availability-oracle [FLAGS] [OPTIONS] --rewards-manager-contract <rewards-manager-contract> \
-        --url <url> --ipfs <ipfs> --signing-key <signing-key> --subgraph <subgraph>
+    availability-oracle [FLAGS] [OPTIONS] --ipfs <ipfs> --signing-key <signing-key> --subgraph <subgraph> --url <url>
 
 FLAGS:
         --dry-run    log the results but not send a transaction to the rewards manager
     -h, --help       Prints help information
     -V, --version    Prints version information
 
 OPTIONS:
-        --rewards-manager-contract <rewards-manager-contract>
-            Address of the Graph Protocol RewardsManager contract [env: REWARDS_MANAGER_CONTRACT=]
-        --url <url>
-            RPC URL for EVM-compatible netwrok, must be a valid URL [env: RPC_URL=]
         --grace-period <grace-period>
-            Grace period, in seconds from subgraph creation, for which subgraphs will not be checked [env:
-            ORACLE_GRACE_PERIOD=]  [default: 0]
+            Grace period, in seconds from subgraph creation, for which subgraphs will not be checked [env: ORACLE_GRACE_PERIOD=]  [default: 0]
+        
         --ipfs <ipfs>
             IPFS endpoint with access to the subgraph files [env: ORACLE_IPFS=]
 
         --ipfs-concurrency <ipfs-concurrency>
             Maximum concurrent calls to IPFS [env: ORACLE_IPFS_CONCURRENCY=]  [default: 100]
 
         --ipfs-timeout <ipfs-timeout>
-            IPFS timeout after which a file will be considered unavailable [env: ORACLE_IPFS_TIMEOUT_SECS=]  [default:
-            30]
-        --metrics-port <metrics-port>                    [env: ORACLE_METRICS_PORT=]  [default: 8090]
+            IPFS timeout after which a file will be considered unavailable [env: ORACLE_IPFS_TIMEOUT_SECS=]  [default: 30]
+        
+        --metrics-port <metrics-port>
+             [env: ORACLE_METRICS_PORT=]  [default: 8090]
+
         --min-signal <min-signal>
             Minimum signal for a subgraph to be checked [env: ORACLE_MIN_SIGNAL=]  [default: 100]
 
+        --oracle-index <oracle-index>
+            Assigned index for the oracle, to be used when voting on SubgraphAvailabilityManager [env: ORACLE_INDEX=]
+
         --period <period>
-            How often the oracle should check the subgraphs. With the default value of 0, the oracle will run once and
-            terminate [env: ORACLE_PERIOD_SECS=]  [default: 0]
+            How often the oracle should check the subgraphs. With the default value of 0, the oracle will run once and terminate [env: ORACLE_PERIOD_SECS=]  [default: 0]
+        
+        --rewards-manager-contract <rewards-manager-contract>
+            The address of the rewards manager contract [env: REWARDS_MANAGER_CONTRACT=]
+
         --signing-key <signing-key>
             The secret key of the oracle for signing transactions [env: ORACLE_SIGNING_KEY=]
 
-        --subgraph <subgraph>                           Graphql endpoint to the network subgraph [env: ORACLE_SUBGRAPH=]
+        --subgraph <subgraph>
+            Graphql endpoint to the network subgraph [env: ORACLE_SUBGRAPH=]
+
+        --subgraph-availability-manager-contract <subgraph-availability-manager-contract>
+            The address of the subgraph availability manager contract [env: SUBGRAPH_AVAILABILITY_MANAGER_CONTRACT=]
+
+        --supported-data-source-kinds <supported-data-source-kinds>...
+            a comma separated list of the supported data source kinds [env: SUPPORTED_DATA_SOURCE_KINDS=]  [default: ethereum,ethereum/contract,file/ipfs,substreams,file/arweave]
+    
     -s, --supported-networks <supported-networks>...
             a comma separated list of the supported network ids [env: SUPPORTED_NETWORKS=]  [default: mainnet]
 
+        --url <url>
+            RPC url for the network [env: RPC_URL=]
+
 ```
 
-Example command to testing with a dry run:
+## Examples
+
+### Example command to testing with a dry run:
 
 ```
-cargo run -p availability-oracle --  --ipfs https://api.thegraph.com/ipfs  --subgraph https://gateway.thegraph.com/network --dry-run --min-signal 10000
+cargo run -p availability-oracle -- \
+    --ipfs https://api.thegraph.com/ipfs \
+    --subgraph <network-subgraph-url> \
+    --min-signal 10000 \
+    --url <url> \
+    --dry-run
+```
+
+### Example command to run `SubgraphAvailabilityManager` configuration:
+
+```
+cargo run -p availability-oracle -- \
+    --ipfs https://api.thegraph.com/ipfs \
+    --subgraph <network-subgraph-url> \
+    --min-signal 10000 \
+    --url <url> \
+    --subgraph-availability-manager-contract <address> \
+    --oracle-index <index> \
+    --signing-key <signing-key>
+```
+
+### Example command to run `RewardsManager` configuration:
+
 ```
+cargo run -p availability-oracle -- \
+    --ipfs https://api.thegraph.com/ipfs \
+    --subgraph <network-subgraph-url> \
+    --min-signal 10000 \
+    --url <url> \
+    --rewards-manager-contract <address> \
+    --signing-key <signing-key>
+```