From e8da9a64f0976a56d1437cba795383f6441fc410 Mon Sep 17 00:00:00 2001 From: Razvan Gabriel Date: Mon, 4 Mar 2024 11:42:14 +0200 Subject: [PATCH] fix: subgraph endpoints, add blast --- docs/api/subgraphs/01-endpoints.mdx | 123 +++++++++++++++++----------- 1 file changed, 75 insertions(+), 48 deletions(-) diff --git a/docs/api/subgraphs/01-endpoints.mdx b/docs/api/subgraphs/01-endpoints.mdx index fc0bce11..0f39ee9f 100644 --- a/docs/api/subgraphs/01-endpoints.mdx +++ b/docs/api/subgraphs/01-endpoints.mdx @@ -13,20 +13,23 @@ It deals with core protocol actions like creating, withdrawing or transferring s ### Endpoints -| Chain | Explorer | Hosted Network | Decentralized Explorer[^1] | -| ---------------- | ------------------------------------------ | ----------------------------------------------------------- | ----------------------------------- | -| Ethereum | [Playground][v2-explorer-ethereum] | [sablier-v2][v2-endpoint-ethereum] | [Studio](v2-decentralized-ethereum) | -| Arbitrum | [Playground][v2-explorer-arbitrum] | [sablier-v2-arbitrum][v2-endpoint-arbitrum] | [Studio](v2-decentralized-arbitrum) | -| Arbitrum Sepolia | [Playground][v2-explorer-arbitrum-sepolia] | [sablier-v2-arbitrum-sepolia][v2-endpoint-arbitrum-sepolia] | N/A | -| Avalanche | [Playground][v2-explorer-avalanche] | [sablier-v2-avalanche][v2-endpoint-avalanche] | N/A | -| Base | [Playground][v2-explorer-base] | [sablier-v2-avalanche][v2-endpoint-base] | N/A | -| BNB Smart Chain | [Playground][v2-explorer-bsc] | [sablier-v2-bsc][v2-endpoint-bsc] | N/A | -| Gnosis | [Playground][v2-explorer-gnosis] | [sablier-v2-gnosis][v2-endpoint-gnosis] | N/A | -| Lightlink | [Playground\*][v2-explorer-lightlink] | [sablier-v2-lightlink\*][v2-endpoint-lightlink] | Node hosted by Lightlink\* | -| Optimism | [Playground][v2-explorer-optimism] | [sablier-v2-optimism][v2-endpoint-optimism] | N/A | -| Polygon | [Playground][v2-explorer-polygon] | [sablier-v2-matic][v2-endpoint-polygon] | [Studio](v2-decentralized-polygon) | -| Scroll | [Playground][v2-explorer-scroll] | [sablier-v2-scroll][v2-endpoint-scroll] | N/A | -| Sepolia | [Playground][v2-explorer-sepolia] | [sablier-v2-sepolia][v2-endpoint-sepolia] | N/A | +| Chain | Explorer | Hosted Endpoints | Other Endpoints[^1] | +| ---------------- | ------------------------------------------ | ----------------------------------------------------------- | -------------------------------------------------- | +| Ethereum | [Playground][v2-explorer-ethereum] | [sablier-v2][v2-endpoint-ethereum] | [Decentralized Network](v2-decentralized-ethereum) | +| Arbitrum | [Playground][v2-explorer-arbitrum] | [sablier-v2-arbitrum][v2-endpoint-arbitrum] | [Decentralized Network](v2-decentralized-arbitrum) | +| Arbitrum Sepolia | [Playground][v2-explorer-arbitrum-sepolia] | [sablier-v2-arbitrum-sepolia][v2-endpoint-arbitrum-sepolia] | N/A | +| Avalanche | [Playground][v2-explorer-avalanche] | [sablier-v2-avalanche][v2-endpoint-avalanche] | N/A | +| Base | [Playground][v2-endpoint-base] | N/A | [Subgraph Studio][v2-endpoint-base] | +| Blast | [Playground][v2-endpoint-blast] | N/A | [Subgraph Studio][v2-endpoint-blast] | +| BNB Smart Chain | [Playground][v2-explorer-bsc] | [sablier-v2-bsc][v2-endpoint-bsc] | N/A | +| Gnosis | [Playground][v2-explorer-gnosis] | [sablier-v2-gnosis][v2-endpoint-gnosis] | N/A | +| Lightlink | [Playground\*][v2-explorer-lightlink] | N/A | [Lightlink Node\*][v2-endpoint-lightlink] | +| Optimism | [Playground][v2-explorer-optimism] | [sablier-v2-optimism][v2-endpoint-optimism] | N/A | +| Polygon | [Playground][v2-explorer-polygon] | [sablier-v2-matic][v2-endpoint-polygon] | [Decentralized Network](v2-decentralized-polygon) | +| Scroll | [Playground][v2-endpoint-scroll] | N/A | [Subgraph Studio][v2-endpoint-scroll] | +| Sepolia | [Playground][v2-explorer-sepolia] | [sablier-v2-sepolia][v2-endpoint-sepolia] | N/A | + +{/* Decentralized Endpoints */} [v2-decentralized-ethereum]: https://thegraph.com/explorer/subgraphs/EuZZnhFtdCGqN2Zt7EMGYDqQKNrVuhJL63KAfwvF35bL?view=Overview&chain=arbitrum-one @@ -34,29 +37,40 @@ It deals with core protocol actions like creating, withdrawing or transferring s https://thegraph.com/explorer/subgraphs/8BnGPBojHycDxVo83LP468pUo4xDyCQbtTpHGZXR6SiB?view=Overview&chain=arbitrum-one [v2-decentralized-polygon]: https://thegraph.com/explorer/subgraphs/CsDNYv9XPUMP8vufuwDVKQrVhsxhzzRHezjLFFKZZbrx?view=Overview&chain=arbitrum-one + +{/* Hosted Network Endpoints */} + [v2-endpoint-arbitrum]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-arbitrum [v2-endpoint-arbitrum-sepolia]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-arbitrum-sepolia [v2-endpoint-avalanche]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-avalanche -[v2-endpoint-base]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-base [v2-endpoint-bsc]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-bsc [v2-endpoint-ethereum]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2 [v2-endpoint-optimism]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-optimism [v2-endpoint-polygon]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-polygon [v2-endpoint-gnosis]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-gnosis [v2-endpoint-sepolia]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-sepolia -[v2-endpoint-scroll]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-scroll + +{/* Studio Endpoints */} + +[v2-endpoint-base]: https://api.studio.thegraph.com/query/57079/sablier-v2-base/version/latest +[v2-endpoint-blast]: https://api.studio.thegraph.com/query/57079/sablier-v2-blast/version/latest +[v2-endpoint-scroll]: https://api.studio.thegraph.com/query/57079/sablier-v2-scroll/version/latest + +{/* Special Endpoints */} + [v2-endpoint-lightlink]: https://graph.phoenix.lightlink.io/query/subgraphs/name/lightlink/sablier-v2-lightlink + +{/* Explorers */} + [v2-explorer-arbitrum]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-arbitrum [v2-explorer-arbitrum-sepolia]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-arbitrum-sepolia [v2-explorer-avalanche]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-avalanche -[v2-explorer-base]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-base [v2-explorer-bsc]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-bsc [v2-explorer-ethereum]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2 [v2-explorer-optimism]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-optimism [v2-explorer-polygon]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-polygon [v2-explorer-gnosis]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-gnosis [v2-explorer-sepolia]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-sepolia -[v2-explorer-scroll]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-scroll [v2-explorer-lightlink]: https://graph.phoenix.lightlink.io/query/subgraphs/name/lightlink/sablier-v2-lightlink/graphql ### Code @@ -76,33 +90,46 @@ contracts, specifically the specific actions like the factory creating a campaign, admin clawbacks or users claiming streams as defined in the attached Merkle tree. -| Chain | Explorer | Hosted Network | Decentralized Explorer [^1] | -| ---------------- | ---------------------------------------- | ----------------------------------------------------------- | --------------------------- | -| Ethereum | [Playground][v2-explorer-ms-ethereum] | [sablier-v2-ms][v2-endpoint-ms-ethereum] | N/A | -| Arbitrum | [Playground][v2-explorer-ms-arbitrum] | [sablier-v2-ms-arbitrum][v2-endpoint-ms-arbitrum] | N/A | -| Arbitrum Sepolia | [Playground][v2-explorer-ms-arbitrum-s] | [sablier-v2-ms-arbitrum-sepolia][v2-endpoint-ms-arbitrum-s] | N/A | -| Avalanche | [Playground][v2-explorer-ms-avalanche] | [sablier-v2-ms-avalanche][v2-endpoint-ms-avalanche] | N/A | -| Base | [Playground][v2-explorer-ms-base] | [sablier-v2-ms-avalanche][v2-endpoint-ms-base] | N/A | -| BNB Smart Chain | [Playground][v2-explorer-ms-bsc] | [sablier-v2-ms-bsc][v2-endpoint-ms-bsc] | N/A | -| Gnosis | [Playground][v2-explorer-ms-gnosis] | [sablier-v2-ms-gnosis][v2-endpoint-ms-gnosis] | N/A | -| Lightlink | [Playground\*][v2-explorer-ms-lightlink] | [sablier-v2-ms-lightlink\*][v2-endpoint-ms-lightlink] | Node hosted by Lightlink\* | -| Optimism | [Playground][v2-explorer-ms-optimism] | [sablier-v2-ms-optimism][v2-endpoint-ms-optimism] | N/A | -| Polygon | [Playground][v2-explorer-ms-polygon] | [sablier-v2-ms-matic][v2-endpoint-ms-polygon] | N/A | -| Scroll | [Playground][v2-explorer-ms-scroll] | [sablier-v2-ms-scroll][v2-endpoint-ms-scroll] | N/A | -| Sepolia | [Playground][v2-explorer-ms-sepolia] | [sablier-v2-ms-sepolia][v2-endpoint-ms-sepolia] | N/A | +| Chain | Explorer | Hosted Endpoints | Other Endpoints [^1] | +| ---------------- | ---------------------------------------- | ----------------------------------------------------------- | -------------------------------------------- | +| Ethereum | [Playground][v2-explorer-ms-ethereum] | [sablier-v2-ms][v2-endpoint-ms-ethereum] | N/A | +| Arbitrum | [Playground][v2-explorer-ms-arbitrum] | [sablier-v2-ms-arbitrum][v2-endpoint-ms-arbitrum] | N/A | +| Arbitrum Sepolia | [Playground][v2-explorer-ms-arbitrum-s] | [sablier-v2-ms-arbitrum-sepolia][v2-endpoint-ms-arbitrum-s] | N/A | +| Avalanche | [Playground][v2-explorer-ms-avalanche] | [sablier-v2-ms-avalanche][v2-endpoint-ms-avalanche] | N/A | +| Base | [Playground][v2-endpoint-ms-base] | N/A | [Subgraph Studio][v2-endpoint-ms-base] | +| Blast | [Playground][v2-endpoint-ms-blast] | N/A | [Subgraph Studio][v2-endpoint-ms-blast] | +| BNB Smart Chain | [Playground][v2-explorer-ms-bsc] | [sablier-v2-ms-bsc][v2-endpoint-ms-bsc] | N/A | +| Gnosis | [Playground][v2-explorer-ms-gnosis] | [sablier-v2-ms-gnosis][v2-endpoint-ms-gnosis] | N/A | +| Lightlink | [Playground\*][v2-explorer-ms-lightlink] | N/A | [Lightlink Node\*][v2-endpoint-ms-lightlink] | +| Optimism | [Playground][v2-explorer-ms-optimism] | [sablier-v2-ms-optimism][v2-endpoint-ms-optimism] | N/A | +| Polygon | [Playground][v2-explorer-ms-polygon] | [sablier-v2-ms-matic][v2-endpoint-ms-polygon] | N/A | +| Scroll | [Playground][v2-explorer-ms-scroll] | N/A | [Subgraph Studio][v2-endpoint-ms-scroll] | +| Sepolia | [Playground][v2-explorer-ms-sepolia] | [sablier-v2-ms-sepolia][v2-endpoint-ms-sepolia] | N/A | + +{/* Hosted Network Endpoints */} [v2-endpoint-ms-arbitrum]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-arbitrum [v2-endpoint-ms-arbitrum-s]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-arbitrum-sepolia [v2-endpoint-ms-avalanche]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-avalanche -[v2-endpoint-ms-base]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-base [v2-endpoint-ms-bsc]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-bsc [v2-endpoint-ms-ethereum]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms [v2-endpoint-ms-optimism]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-optimism [v2-endpoint-ms-polygon]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-polygon [v2-endpoint-ms-gnosis]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-gnosis [v2-endpoint-ms-sepolia]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-sepolia -[v2-endpoint-ms-scroll]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-v2-ms-scroll + +{/* Studio Endpoints */} + +[v2-endpoint-ms-base]: https://api.studio.thegraph.com/query/57079/sablier-v2-ms-base/version/latest +[v2-endpoint-ms-blast]: https://api.studio.thegraph.com/query/57079/sablier-v2-ms-blast/version/latest +[v2-endpoint-ms-scroll]: https://api.studio.thegraph.com/query/57079/sablier-v2-ms-scroll/version/latest + +{/* Special Endpoints */} + [v2-endpoint-ms-lightlink]: https://graph.phoenix.lightlink.io/query/subgraphs/name/lightlink/sablier-v2-ms-lightlink + +{/* Explorers */} + [v2-explorer-ms-arbitrum]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-ms-arbitrum [v2-explorer-ms-arbitrum-s]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-ms-arbitrum-sepolia [v2-explorer-ms-avalanche]: https://thegraph.com/hosted-service/subgraph/sablier-labs/sablier-v2-ms-avalanche @@ -130,14 +157,14 @@ attached Merkle tree. ### Endpoints -| Chain | Explorer | Hosted Network | Decentralized Explorer [^1] | -| --------------- | --------------------------------- | ------------------------------------------ | ----------------------------------- | -| Ethereum | [Playground][v1-hosted-ethereum] | [sablier][v1-endpoint-ethereum] | [Studio][v1-decentralized-ethereum] | -| Arbitrum | [Playground][v1-hosted-arbitrum] | [sablier-arbitrum][v1-endpoint-arbitrum] | N/A | -| Optimism | [Playground][v1-hosted-optimism] | [sablier-optimism][v1-endpoint-optimism] | N/A | -| Polygon | [Playground][v1-hosted-polygon] | [sablier-matic][v1-endpoint-polygon] | N/A | -| Avalanche | [Playground][v1-hosted-avalanche] | [sablier-avalanche][v1-endpoint-avalanche] | N/A | -| BNB Smart Chain | [Playground][v1-hosted-bsc] | [sablier-bsc][v1-endpoint-bsc] | N/A | +| Chain | Explorer | Hosted Endpoints | Other Endpoints [^1] | +| --------------- | --------------------------------- | ------------------------------------------ | -------------------------------------------------- | +| Ethereum | [Playground][v1-hosted-ethereum] | [sablier][v1-endpoint-ethereum] | [Decentralized Network][v1-decentralized-ethereum] | +| Arbitrum | [Playground][v1-hosted-arbitrum] | [sablier-arbitrum][v1-endpoint-arbitrum] | N/A | +| Optimism | [Playground][v1-hosted-optimism] | [sablier-optimism][v1-endpoint-optimism] | N/A | +| Polygon | [Playground][v1-hosted-polygon] | [sablier-matic][v1-endpoint-polygon] | N/A | +| Avalanche | [Playground][v1-hosted-avalanche] | [sablier-avalanche][v1-endpoint-avalanche] | N/A | +| BNB Smart Chain | [Playground][v1-hosted-bsc] | [sablier-bsc][v1-endpoint-bsc] | N/A | [v1-decentralized-ethereum]: https://thegraph.com/explorer/subgraph?id=A5XzhYZ4muyRegVTYmwWbCbKWvD4LTWqac43CEGTEGdK [v1-endpoint-arbitrum]: https://api.thegraph.com/subgraphs/name/sablier-labs/sablier-arbitrum @@ -163,9 +190,9 @@ attached Merkle tree. /> [^1]: - -Because the "Decentralized service" subgraph flavors (e.g. V1 Ethereum) operate on The Graph Network, you will need to -substitute the `YOUR_API_KEY` placeholder in the -[Query URL](https://thegraph.com/docs/en/deploying/subgraph-studio-faqs/#6-how-do-i-find-query-urls-for-subgraphs-if-im-not-the-developer-of-the-subgraph-i-want-to-use) -with your own API key. If you require assistance with managing your API keys and configuring indexer preferences, -[this article](https://thegraph.com/docs/en/studio/managing-api-keys/) serves as an excellent guide. + Other endpoints could include: The Graph's Decentralized Network (paid), The Graph's Subgraph Studio (rate-limited) + or Custom Nodes (e.g. Lightlink). Because the "Decentralized service" subgraph flavors (e.g. V1 Ethereum) operate on + The Graph Network, you will need to substitute the `YOUR_API_KEY` placeholder in the + [Query URL](https://thegraph.com/docs/en/deploying/subgraph-studio-faqs/#6-how-do-i-find-query-urls-for-subgraphs-if-im-not-the-developer-of-the-subgraph-i-want-to-use) + with your own API key. If you require assistance with managing your API keys and configuring indexer preferences, + [this article](https://thegraph.com/docs/en/studio/managing-api-keys/) serves as an excellent guide.