From 7d664a7107835b3e135197c1bff6126ffddf1650 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Wed, 14 May 2025 20:06:44 -0700 Subject: [PATCH 1/8] Adding two docs --- website/src/pages/en/subgraphs/_meta.js | 2 + .../pages/en/subgraphs/fair-use-policy.mdx | 84 +++++++++++++++++++ .../pages/en/subgraphs/upgrade-indexer.mdx | 24 ++++++ 3 files changed, 110 insertions(+) create mode 100644 website/src/pages/en/subgraphs/fair-use-policy.mdx create mode 100644 website/src/pages/en/subgraphs/upgrade-indexer.mdx diff --git a/website/src/pages/en/subgraphs/_meta.js b/website/src/pages/en/subgraphs/_meta.js index ed3e5db7a6f0..b0ae9b53db48 100644 --- a/website/src/pages/en/subgraphs/_meta.js +++ b/website/src/pages/en/subgraphs/_meta.js @@ -8,4 +8,6 @@ export default { billing: '', guides: titles.guides, 'best-practices': titles['best-practices'], + 'fair-use-policy': '', + 'upgrade-indexer': 'Upgrade Indexer', } diff --git a/website/src/pages/en/subgraphs/fair-use-policy.mdx b/website/src/pages/en/subgraphs/fair-use-policy.mdx new file mode 100644 index 000000000000..e377a0955c38 --- /dev/null +++ b/website/src/pages/en/subgraphs/fair-use-policy.mdx @@ -0,0 +1,84 @@ +--- +title: Fair Use Policy +--- + +> Effective Date: May 15, 2025 + +## Overview + +This outlines storage limits for Subgraphs that rely solely on [Edge & Node's Upgrade Indexer](/subgraphs/upgrade-indexer/). This policy is designed to ensure fair and optimized use of queries across the community. + +To maintain performance and reliability across its infrastructure, Edge & Node is updating its Upgrade Indexer Subgraph storage policy. Free usage tiers remain available, but users who exceed specified limits will need to upgrade to a paid plan. Storage allocations and thresholds vary by feature. + +### 1. Scope + +This policy applies to all individual users, teams, chains, and dapps using Edge & Node's Upgrade Indexer in Subgraph Studio for storage and queries. + +### 2. Fair Use Storage Limits + +**Free Storage: Up to 10 GB** + +Beyond that, pricing is variable and adjusts based on usage patterns, network conditions, infrastructure requirements, and specific use-cases. + +Reach out to Edge & Node at [info@edgeandnode.com](mailto:info@edgeandnode.com) to discuss options that meet your technical needs. + +You can monitor your usage via [Subgraph Studio](https://thegraph.com/studio/). + +### 3. Fair Use Limits + +To preserve the stability of Edge & Node's Subgraph Studio and preserve the reliability of The Graph Network, the Edge & Node Support Team will monitor storage usage and take corresponding action with Subgraphs that have: + +- Abnormally high or sustained bandwidth or storage usage beyond posted limits +- Circumvention of storage thresholds (e.g., use of multiple free-tier accounts) + +The Edge & Node Support Team reserves the right to revise storage limits or impose temporary constraints for operational integrity. + +If you exceed your included storage: + +- Try [pruning Subgraph data](/subgraphs/best-practices/pruning/) to remove unused entities and help stay within storage limits +- [Add signal to the Subgraph](/subgraphs/developing/publishing/publishing-a-subgraph/#adding-signal-to-your-subgraph) to encourage other Indexers on the network to serve it +- You will receive multiple notifications and email alerts +- A grace period of 14 days will be provided to upgrade or reduce storage + +Edge & Node's team is committed to helping users avoid unnecessary interruptions and will continue to support all web3 builders. + +### 4. Subgraph Data Retention + +Subgraphs inactive for over 14 days or Subgraphs that exceed free-tier storage limits will be subject to automatic data archival or deletion. Edge & Node's team will notify you before any such actions are taken. + +### 5. Support + +If you believe your usage is incorrectly flagged or have unique use cases (e.g. approved special request pending new Subgraph upgrade plan), reach out the Edge & Node team at info@edgeandnode.com. 31 changes: 31 additions & 0 deletions31 +website/src/pages/en/subgraphs/subgraph-studio-faq.mdx Original file line number Original file line Diff line number Diff line change @@ -0,0 +1,31 @@ + +--- + +## title: Subgraph Studio FAQs + +## 1. What is Subgraph Studio? + +[Subgraph Studio](https://thegraph.com/studio/) is a dapp for creating, managing, and publishing Subgraphs and API keys. + +## 2. How do I create an API Key? + +To create an API, navigate to Subgraph Studio and connect your wallet. You will be able to click the API keys tab at the top. There, you will be able to create an API key. + +## 3. Can I create multiple API Keys? + +Yes! You can create multiple API Keys to use in different projects. Check out the link [here](https://thegraph.com/studio/apikeys/). + +## 4. How do I restrict a domain for an API Key? + +After creating an API Key, in the Security section, you can define the domains that can query a specific API Key. + +## 5. Can I transfer my Subgraph to another owner? + +Yes, Subgraphs that have been published to Arbitrum One can be transferred to a new wallet or a Multisig. You can do so by clicking the three dots next to the 'Publish' button on the Subgraph's details page and selecting 'Transfer ownership'. + +Note that you will no longer be able to see or edit the Subgraph in Studio once it has been transferred. + +## 6. How do I find query URLs for Subgraphs if I’m not the developer of the Subgraph I want to use? + +You can find the query URL of each Subgraph in the Subgraph Details section of Graph Explorer. When you click on the “Query” button, you will be directed to a pane wherein you can view the query URL of the Subgraph you’re interested in. You can then replace the `` placeholder with the API key you wish to leverage in Subgraph Studio. + +Remember that you can create an API key and query any Subgraph published to the network, even if you build a Subgraph yourself. These queries via the new API key, are paid queries as any other on the network. diff --git a/website/src/pages/en/subgraphs/upgrade-indexer.mdx b/website/src/pages/en/subgraphs/upgrade-indexer.mdx new file mode 100644 index 000000000000..3e9521e58b83 --- /dev/null +++ b/website/src/pages/en/subgraphs/upgrade-indexer.mdx @@ -0,0 +1,24 @@ +--- +title: Edge and Node Upgrade Indexer +--- + +## Overview + +The Upgrade Indexer is a specialized Indexer operated by Edge & Node. It supports newly integrated chains within The Graph ecosystem and ensures new Subgraphs are immediately available for querying, eliminating potential downtime. + +Originally designed as a transitional support, its primary purpose was to facilitate the migration of Subgraphs from the hosted service to the decentralized network. Currently, it supports newly deployed Subgraphs before the full Chain Integration Process (CIP) Indexing rewards are activated. + +### What it does: + +- Provides immediate query support for all newly deployed subgraphs. +- Functions as the sole supporting Indexer for each chain until indexing rewards are activated. + +### What it does **not** do: + +- Does not permanently index subgraphs. Subgraph owners should curate subgraphs to use independent Indexers long term. +- Does not compete for rewards. The Upgrade Indexer's participation on the Graph Network does not dilute rewards for other Indexers. +- Doesn't support Time Travel Queries (TTQ). All Subgraphs on the Upgrade Indexer are auto-pruned. If TTQs are needed on a Subgraph, [curation signal can be added](/subgraphs/developing/publishing/publishing-a-subgraph/#adding-signal-to-your-subgraph) to attract Indexers that will support this feature. + +### Conclusion + +The Edge & Node Upgrade Indexer is foundational in supporting chain integrations and mitigating data latency risks. It plays a critical role in scaling The Graph's decentralized infrastructure by ensuring immediate query support and fostering community-driven indexing. From 089a48c31aa2f0b99f329001b36e4d7b5f343f14 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Wed, 14 May 2025 20:10:12 -0700 Subject: [PATCH 2/8] fixing --- .../pages/en/subgraphs/fair-use-policy.mdx | 35 +------------------ 1 file changed, 1 insertion(+), 34 deletions(-) diff --git a/website/src/pages/en/subgraphs/fair-use-policy.mdx b/website/src/pages/en/subgraphs/fair-use-policy.mdx index e377a0955c38..137e2c5e5573 100644 --- a/website/src/pages/en/subgraphs/fair-use-policy.mdx +++ b/website/src/pages/en/subgraphs/fair-use-policy.mdx @@ -48,37 +48,4 @@ Subgraphs inactive for over 14 days or Subgraphs that exceed free-tier storage l ### 5. Support -If you believe your usage is incorrectly flagged or have unique use cases (e.g. approved special request pending new Subgraph upgrade plan), reach out the Edge & Node team at info@edgeandnode.com. 31 changes: 31 additions & 0 deletions31 -website/src/pages/en/subgraphs/subgraph-studio-faq.mdx Original file line number Original file line Diff line number Diff line change @@ -0,0 +1,31 @@ - ---- - -## title: Subgraph Studio FAQs - -## 1. What is Subgraph Studio? - -[Subgraph Studio](https://thegraph.com/studio/) is a dapp for creating, managing, and publishing Subgraphs and API keys. - -## 2. How do I create an API Key? - -To create an API, navigate to Subgraph Studio and connect your wallet. You will be able to click the API keys tab at the top. There, you will be able to create an API key. - -## 3. Can I create multiple API Keys? - -Yes! You can create multiple API Keys to use in different projects. Check out the link [here](https://thegraph.com/studio/apikeys/). - -## 4. How do I restrict a domain for an API Key? - -After creating an API Key, in the Security section, you can define the domains that can query a specific API Key. - -## 5. Can I transfer my Subgraph to another owner? - -Yes, Subgraphs that have been published to Arbitrum One can be transferred to a new wallet or a Multisig. You can do so by clicking the three dots next to the 'Publish' button on the Subgraph's details page and selecting 'Transfer ownership'. - -Note that you will no longer be able to see or edit the Subgraph in Studio once it has been transferred. - -## 6. How do I find query URLs for Subgraphs if I’m not the developer of the Subgraph I want to use? - -You can find the query URL of each Subgraph in the Subgraph Details section of Graph Explorer. When you click on the “Query” button, you will be directed to a pane wherein you can view the query URL of the Subgraph you’re interested in. You can then replace the `` placeholder with the API key you wish to leverage in Subgraph Studio. - -Remember that you can create an API key and query any Subgraph published to the network, even if you build a Subgraph yourself. These queries via the new API key, are paid queries as any other on the network. +If you believe your usage is incorrectly flagged or have unique use cases (e.g. approved special request pending new Subgraph upgrade plan), reach out the Edge & Node team at info@edgeandnode.com. From 4fe972d069811fe8eca06d5d28036111cbb47f15 Mon Sep 17 00:00:00 2001 From: Idalith Bustos Date: Wed, 14 May 2025 20:19:00 -0700 Subject: [PATCH 3/8] fixing lint (again) --- website/src/pages/en/subgraphs/upgrade-indexer.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/src/pages/en/subgraphs/upgrade-indexer.mdx b/website/src/pages/en/subgraphs/upgrade-indexer.mdx index 3e9521e58b83..ed62b5811e32 100644 --- a/website/src/pages/en/subgraphs/upgrade-indexer.mdx +++ b/website/src/pages/en/subgraphs/upgrade-indexer.mdx @@ -8,12 +8,12 @@ The Upgrade Indexer is a specialized Indexer operated by Edge & Node. It support Originally designed as a transitional support, its primary purpose was to facilitate the migration of Subgraphs from the hosted service to the decentralized network. Currently, it supports newly deployed Subgraphs before the full Chain Integration Process (CIP) Indexing rewards are activated. -### What it does: +### What it does - Provides immediate query support for all newly deployed subgraphs. - Functions as the sole supporting Indexer for each chain until indexing rewards are activated. -### What it does **not** do: +### What it does **not** do - Does not permanently index subgraphs. Subgraph owners should curate subgraphs to use independent Indexers long term. - Does not compete for rewards. The Upgrade Indexer's participation on the Graph Network does not dilute rewards for other Indexers. From 9f6d2a94525a1f6e6fa9807404908305db211031 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Thu, 15 May 2025 07:56:32 -0700 Subject: [PATCH 4/8] Update website/src/pages/en/subgraphs/_meta.js MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/src/pages/en/subgraphs/_meta.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/pages/en/subgraphs/_meta.js b/website/src/pages/en/subgraphs/_meta.js index b0ae9b53db48..33bf9a8af9b3 100644 --- a/website/src/pages/en/subgraphs/_meta.js +++ b/website/src/pages/en/subgraphs/_meta.js @@ -9,5 +9,5 @@ export default { guides: titles.guides, 'best-practices': titles['best-practices'], 'fair-use-policy': '', - 'upgrade-indexer': 'Upgrade Indexer', + 'upgrade-indexer': '', } From 961f8557b054fe2e8adc10a282eb40c345f338d4 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Thu, 15 May 2025 07:56:52 -0700 Subject: [PATCH 5/8] Update website/src/pages/en/subgraphs/upgrade-indexer.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/src/pages/en/subgraphs/upgrade-indexer.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/website/src/pages/en/subgraphs/upgrade-indexer.mdx b/website/src/pages/en/subgraphs/upgrade-indexer.mdx index ed62b5811e32..ca4675473591 100644 --- a/website/src/pages/en/subgraphs/upgrade-indexer.mdx +++ b/website/src/pages/en/subgraphs/upgrade-indexer.mdx @@ -1,5 +1,6 @@ --- title: Edge and Node Upgrade Indexer +sidebarTitle: Upgrade Indexer --- ## Overview From aeafe6fa042d624756f4dd0f50f50e1d7a828382 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Thu, 15 May 2025 07:57:21 -0700 Subject: [PATCH 6/8] Update website/src/pages/en/subgraphs/fair-use-policy.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Benoît Rouleau --- website/src/pages/en/subgraphs/fair-use-policy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/pages/en/subgraphs/fair-use-policy.mdx b/website/src/pages/en/subgraphs/fair-use-policy.mdx index 137e2c5e5573..23b436805c68 100644 --- a/website/src/pages/en/subgraphs/fair-use-policy.mdx +++ b/website/src/pages/en/subgraphs/fair-use-policy.mdx @@ -48,4 +48,4 @@ Subgraphs inactive for over 14 days or Subgraphs that exceed free-tier storage l ### 5. Support -If you believe your usage is incorrectly flagged or have unique use cases (e.g. approved special request pending new Subgraph upgrade plan), reach out the Edge & Node team at info@edgeandnode.com. +If you believe your usage is incorrectly flagged or have unique use cases (e.g. approved special request pending new Subgraph upgrade plan), reach out the Edge & Node team at [info@edgeandnode.com](mailto:info@edgeandnode.com). From 940c30ff759220afeda69d7e001e35528379a8cd Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Thu, 15 May 2025 07:58:52 -0700 Subject: [PATCH 7/8] Update website/src/pages/en/subgraphs/fair-use-policy.mdx --- website/src/pages/en/subgraphs/fair-use-policy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/pages/en/subgraphs/fair-use-policy.mdx b/website/src/pages/en/subgraphs/fair-use-policy.mdx index 23b436805c68..8a27a7ea2887 100644 --- a/website/src/pages/en/subgraphs/fair-use-policy.mdx +++ b/website/src/pages/en/subgraphs/fair-use-policy.mdx @@ -18,7 +18,7 @@ This policy applies to all individual users, teams, chains, and dapps using Edge **Free Storage: Up to 10 GB** -Beyond that, pricing is variable and adjusts based on usage patterns, network conditions, infrastructure requirements, and specific use-cases. +Beyond that, pricing is variable and adjusts based on usage patterns, network conditions, infrastructure requirements, and specific use cases. Reach out to Edge & Node at [info@edgeandnode.com](mailto:info@edgeandnode.com) to discuss options that meet your technical needs. From b45f09a357cd12ea48301ed9694deafd94cea8c4 Mon Sep 17 00:00:00 2001 From: Idalith <126833353+idalithb@users.noreply.github.com> Date: Thu, 15 May 2025 07:59:29 -0700 Subject: [PATCH 8/8] Update website/src/pages/en/subgraphs/upgrade-indexer.mdx --- website/src/pages/en/subgraphs/upgrade-indexer.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/pages/en/subgraphs/upgrade-indexer.mdx b/website/src/pages/en/subgraphs/upgrade-indexer.mdx index ca4675473591..c314c8a3a1f3 100644 --- a/website/src/pages/en/subgraphs/upgrade-indexer.mdx +++ b/website/src/pages/en/subgraphs/upgrade-indexer.mdx @@ -1,5 +1,5 @@ --- -title: Edge and Node Upgrade Indexer +title: Edge & Node Upgrade Indexer sidebarTitle: Upgrade Indexer ---