Skip to content

Commit

Permalink
docs: replace hosted service endpoints with api key specific endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
hopeyen committed Jun 17, 2024
1 parent 5370bc3 commit 3fcea9a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@ Indexers running the subgraph radio and listening to that channel will in turn r

Note that it is still at the subgraph developers' discretion to await for the indexers to sync upto chainhead, in which point they can publish the staged version without disrupting API usage.

## Subgraph APIs

Depending on your intended network, please pick the correct configurations and replace `[api-key]` with a valid api key for the decentralized network services.

| Protocol Network | Graphcast Network | Registry Subgraph Endpoint | Network Subgraph Endpoint |
| ---------------- | ----------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| Arbitrum-One | `mainnet` | `https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/5tHgjCNF4XxAzp9ja8dU3j9JrqU7zctXj6DnxWpwAzc6` | `https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/DZz4kDTdmzWLWsV373w2bSmoar3umKKH9y82SUKr5qmp` |
| Arbitrum-Sepolia | `testnet` | `https://gateway-arbitrum.network.thegraph.com/api/{api-key}/subgraphs/id/9bnkkKmSqX3FpoxnBVNFcQfmdSJt2Zc8PrsY1ek64jPr` | `https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/3xQHhMudr1oh69ut36G2mbzpYmYxwqCeU6wwqyCDCnqV` |
| Ethereum Mainnet | `mainnet` | `https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/rcKzonu5NGbKcxCDZoQWmcckRKJw8rnmMNJDV8UeDzJ` | `https://gateway-arbitrum.network.thegraph.com/api/{api-key}/subgraphs/id/GgwLf9BTFBJi6Z5iYHssMAGEE4w5dR3Jox2dMLrBxnCT` |


## 🧪 Testing

To run unit tests for the Radio. We recommend using [nextest](https://nexte.st/) as your test runner. Once you have it installed you can run the tests using the following commands:
Expand Down
6 changes: 2 additions & 4 deletions subgraph-radio/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -278,16 +278,14 @@ pub struct GraphStack {
long,
value_name = "SUBGRAPH",
env = "REGISTRY_SUBGRAPH",
help = "Subgraph endpoint to the Graphcast Registry",
default_value = "https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-mainnet"
help = "Subgraph endpoint to the Graphcast Registry"
)]
pub registry_subgraph: String,
#[clap(
long,
value_name = "SUBGRAPH",
env = "NETWORK_SUBGRAPH",
help = "Subgraph endpoint to The Graph network subgraph",
default_value = "https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-mainnet"
help = "Subgraph endpoint to The Graph network subgraph"
)]
pub network_subgraph: String,
#[clap(
Expand Down
4 changes: 2 additions & 2 deletions template.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[graph_stack]
graph_node_status_endpoint = 'http://localhost:8030/graphql'
indexer_address = '0xgossipssssssssssssssssssssssssssssssssss'
registry_subgraph = 'https://api.thegraph.com/subgraphs/name/hopeyen/graphcast-registry-goerli'
network_subgraph = 'https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-goerli'
registry_subgraph = 'https://gateway-arbitrum.network.thegraph.com/api/{api-key}/subgraphs/id/9bnkkKmSqX3FpoxnBVNFcQfmdSJt2Zc8PrsY1ek64jPr'
network_subgraph = 'https://gateway-arbitrum.network.thegraph.com/api/[api-key]/subgraphs/id/3xQHhMudr1oh69ut36G2mbzpYmYxwqCeU6wwqyCDCnqV'
private_key = 'abcdefghabcdefghabcdefghabcdefghabcdefghabcdefghabcdefghabcdefgh'
indexer_management_server_endpoint = 'http://127.0.0.1:18000'

Expand Down

0 comments on commit 3fcea9a

Please sign in to comment.