From 077583e97da25939ff736b44e4ff17b974162467 Mon Sep 17 00:00:00 2001 From: Miguel de Elias Date: Fri, 19 Apr 2024 12:30:32 -0300 Subject: [PATCH 1/2] chore: update README to latest changes --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 62 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a0f9c27..b149394 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ The Subgraph Oracle verifies the availability of the subgraph files and does oth ``` USAGE: - availability-oracle [FLAGS] [OPTIONS] --rewards-manager-contract \ - --url --ipfs --signing-key --subgraph + availability-oracle [FLAGS] [OPTIONS] --ipfs --signing-key --subgraph --url FLAGS: --dry-run log the results but not send a transaction to the rewards manager @@ -12,13 +11,9 @@ FLAGS: -V, --version Prints version information OPTIONS: - --rewards-manager-contract - Address of the Graph Protocol RewardsManager contract [env: REWARDS_MANAGER_CONTRACT=] - --url - RPC URL for EVM-compatible netwrok, must be a valid URL [env: RPC_URL=] --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 endpoint with access to the subgraph files [env: ORACLE_IPFS=] @@ -26,26 +21,77 @@ OPTIONS: Maximum concurrent calls to IPFS [env: ORACLE_IPFS_CONCURRENCY=] [default: 100] --ipfs-timeout - IPFS timeout after which a file will be considered unavailable [env: ORACLE_IPFS_TIMEOUT_SECS=] [default: - 30] - --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 + [env: ORACLE_METRICS_PORT=] [default: 8090] + --min-signal Minimum signal for a subgraph to be checked [env: ORACLE_MIN_SIGNAL=] [default: 100] + --oracle-index + Assigned index for the oracle, to be used when voting on SubgraphAvailabilityManager [env: ORACLE_INDEX=] + --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 + The address of the rewards manager contract [env: REWARDS_MANAGER_CONTRACT=] + --signing-key The secret key of the oracle for signing transactions [env: ORACLE_SIGNING_KEY=] - --subgraph Graphql endpoint to the network subgraph [env: ORACLE_SUBGRAPH=] + --subgraph + Graphql endpoint to the network subgraph [env: ORACLE_SUBGRAPH=] + + --subgraph-availability-manager-contract + The address of the subgraph availability manager contract [env: SUBGRAPH_AVAILABILITY_MANAGER_CONTRACT=] + + --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 ... a comma separated list of the supported network ids [env: SUPPORTED_NETWORKS=] [default: mainnet] + --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 https://gateway.thegraph.com/network \ + --min-signal 10000 \ + --url \ + --dry-run +``` + +### Example command to run `SubgraphAvailabilityManager` configuration: + +``` +cargo run -p availability-oracle -- \ + --ipfs https://api.thegraph.com/ipfs \ + --subgraph https://gateway.thegraph.com/network \ + --min-signal 10000 \ + --url \ + --subgraph-availability-manager-contract
\ + --oracle-index \ + --signing-key +``` + +### Example command to run `RewardsManager` configuration: + ``` +cargo run -p availability-oracle -- \ + --ipfs https://api.thegraph.com/ipfs \ + --subgraph https://gateway.thegraph.com/network \ + --min-signal 10000 \ + --url \ + --rewards-manager-contract
\ + --signing-key +``` \ No newline at end of file From 2901901e0a7c9d5059ffd1990970b22e172b19e0 Mon Sep 17 00:00:00 2001 From: Miguel de Elias Date: Mon, 22 Apr 2024 11:11:10 -0300 Subject: [PATCH 2/2] fix: replace network subgraph url with placeholder --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b149394..860ae1e 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ OPTIONS: ``` cargo run -p availability-oracle -- \ --ipfs https://api.thegraph.com/ipfs \ - --subgraph https://gateway.thegraph.com/network \ + --subgraph \ --min-signal 10000 \ --url \ --dry-run @@ -76,7 +76,7 @@ cargo run -p availability-oracle -- \ ``` cargo run -p availability-oracle -- \ --ipfs https://api.thegraph.com/ipfs \ - --subgraph https://gateway.thegraph.com/network \ + --subgraph \ --min-signal 10000 \ --url \ --subgraph-availability-manager-contract
\ @@ -89,7 +89,7 @@ cargo run -p availability-oracle -- \ ``` cargo run -p availability-oracle -- \ --ipfs https://api.thegraph.com/ipfs \ - --subgraph https://gateway.thegraph.com/network \ + --subgraph \ --min-signal 10000 \ --url \ --rewards-manager-contract
\