Skip to content

Commit e87d78a

Browse files
MichaelMacaulayPedro Diogo
and
Pedro Diogo
authored
Editing chain integration (#495)
* Making questions headings * updated FAQ to match the one from the GIP + small tweaks based on feedback * fixed formatting on the chain integration docs page * Fixing errors * Adding link to GIP --------- Co-authored-by: Pedro Diogo <pdiogo@Pedros-Air-2.lan>
1 parent 5c06dda commit e87d78a

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

website/pages/en/chain-integration-overview.mdx

+12-8
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ A transparent and governance-based integration process was designed for blockcha
66

77
## Stage 1. Technical Integration
88

9-
- Teams work on a Graph Node integration. [Here's how](/new-chain-integration/).
9+
- Teams work on a Graph Node integration and Firehose for non-EVM based chains. [Here's how](/new-chain-integration/).
1010
- Teams initiate the protocol integration process by creating a Forum thread [here](https://forum.thegraph.com/c/governance-gips/new-chain-support/71) (New Data Sources sub-category under Governance & GIPs). Using the default Forum template is mandatory.
1111

1212
## Stage 2. Integration Validation
1313

14-
- Teams collaborate with the Graph Foundation and operators of GUIs and network gateways, such as [Subgraph Studio](https://thegraph.com/studio/), to ensure a smooth integration process. This involves providing the necessary backend infrastructure, such as the integrating chain's JSON RPC or Firehose endpoints. Teams wanting to avoid self-hosting such infrastructure can leverage The Graph's community of node operators (Indexers) to do so, which the Foundation can help with.
14+
- Teams collaborate with core developers, Graph Foundation and operators of GUIs and network gateways, such as [Subgraph Studio](https://thegraph.com/studio/), to ensure a smooth integration process. This involves providing the necessary backend infrastructure, such as the integrating chain's JSON RPC or Firehose endpoints. Teams wanting to avoid self-hosting such infrastructure can leverage The Graph's community of node operators (Indexers) to do so, which the Foundation can help with.
1515
- Graph Indexers test the integration on The Graph's testnet.
1616
- Core developers and Indexers monitor stability, performance, and data determinism.
1717

@@ -24,22 +24,26 @@ A transparent and governance-based integration process was designed for blockcha
2424

2525
If the process looks daunting, don't worry! The Graph Foundation is committed to supporting integrators by fostering collaboration, offering essential information, and guiding them through various stages, including navigating governance processes such as Graph Improvement Proposals (GIPs) and pull requests. If you have questions, please reach out to [info@thegraph.foundation](mailto:info@thegraph.foundation) or through Discord (either Pedro, The Graph Foundation member, IndexerDAO, or other core developers).
2626

27+
Ready to shape the future of The Graph Network? [Start your proposal](https://github.com/graphprotocol/graph-improvement-proposals/blob/main/gips/0057-chain-integration-process.md) now and be a part of the web3 revolution!
28+
2729
---
2830

2931
## Frequently Asked Questions
3032

31-
**1. How does this relate to the [World of Data Services GIP](https://forum.thegraph.com/t/gip-0042-a-world-of-data-services/3761)?**
33+
### 1. How does this relate to the [World of Data Services GIP](https://forum.thegraph.com/t/gip-0042-a-world-of-data-services/3761)?
3234

3335
This process is related to the Subgraph Data Service, applicable only to new Subgraph `Data Sources`.
3436

35-
**2. What happens if Firehose & Substreams support comes after the network is supported on mainnet?**
37+
### 2. What happens if Firehose & Substreams support comes after the network is supported on mainnet?
3638

3739
This would only impact protocol support for indexing rewards on Substreams-powered subgraphs. The new Firehose implementation would need testing on testnet, following the methodology outlined for Stage 2 in this GIP. Similarly, assuming the implementation is performant and reliable, a PR on the [Feature Support Matrix](https://github.com/graphprotocol/indexer/blob/main/docs/feature-support-matrix.md) would be required (`Substreams data sources` Subgraph Feature), as well as a new GIP for protocol support for indexing rewards. Anyone can create the PR and GIP; the Foundation would help with Council approval.
3840

39-
**3. How much time will this process take?**
41+
### 3. How much time will this process take?
42+
43+
The time to mainnet is expected to be several weeks, varying based on the time of integration development, whether additional research is required, testing and bug fixes, and, as always, the timing of the governance process that requires community feedback.
4044

41-
It depends. Protocol support for indexing rewards depends on the involved stakeholders' bandwidth to proceed with testing, feedback gathering, and handling contributions to core codebase, if applicable. All of this is directly tied to the integration's maturity and how responsive the integration team is (who may or may not be the team behind the RPC/Firehose implementation). The Foundation will oversee the whole process, unblocking participants as much as possible.
45+
Protocol support for indexing rewards depends on the stakeholders' bandwidth to proceed with testing, feedback gathering, and handling contributions to the core codebase, if applicable. This is directly tied to the integration's maturity and how responsive the integration team is (who may or may not be the team behind the RPC/Firehose implementation). The Foundation is here to help support throughout the whole process.
4246

43-
**4. How will priorities be handled?**
47+
### 4. How will priorities be handled?
4448

45-
Similar to #3, it will depend on overall readiness and involved stakeholders' bandwidth. For example, a new chain with a brand new Firehose implementation may get a different amount of allocated resources and effort than others whose integration process may or may not already be in progress. This is especially true for chains previously supported on the [Hosted Service](https://thegraph.com/hosted-service) or those relying on already tested stacks like the OP Stack.
49+
Similar to #3, it will depend on overall readiness and involved stakeholders' bandwidth. For example, a new chain with a brand new Firehose implementation may take longer than integrations that have already been battle-tested or are farther along in the governance process. This is especially true for chains previously supported on the [Hosted Service](https://thegraph.com/hosted-service) or those relying on already tested stacks.

website/pages/en/new-chain-integration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For Graph Node to be able to ingest data from an EVM chain, the RPC node must ex
5252
> Do not change the env var name itself. It must remain `ethereum` even if the network name is different.
5353
3. Run an IPFS node or use the one used by The Graph: https://api.thegraph.com/ipfs/
5454

55-
\*Test the integration by locally deploying a subgraph\*\*
55+
**Test the integration by locally deploying a subgraph**
5656

5757
1. Install [graph-cli](https://github.com/graphprotocol/graph-cli)
5858
2. Create a simple example subgraph. Some options are below:

0 commit comments

Comments
 (0)