-
Notifications
You must be signed in to change notification settings - Fork 155
Adding 1 pager #492
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Adding 1 pager #492
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f4aaa76
Adding 1 pager
MichaelMacaulay a5e0ffb
Change Prettier config extension to `.js` to fix weird VS Code issue
benface c49f22d
Update website/pages/en/chain-integration-overview.mdx
MichaelMacaulay dedc3ad
Update chain-integration-overview.mdx
MichaelMacaulay File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
/** @type {import('prettier').Options} */ | ||
module.exports = { | ||
singleQuote: true, | ||
semi: false, | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
title: Chain Integration Process Overview | ||
--- | ||
|
||
A transparent and governance-based integration process was designed for blockchain teams seeking integration with The Graph protocol. It is a 3-phase process, as summarised below. | ||
|
||
## Stage 1. Technical Integration | ||
|
||
- Teams work on a Graph Node integration. [Here's how](/new-chain-integration/). | ||
- 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. | ||
|
||
## Stage 2. Integration Validation | ||
|
||
- 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. | ||
- Graph Indexers test the integration on The Graph's testnet. | ||
- Core developers and Indexers monitor stability, performance, and data determinism. | ||
|
||
## Stage 3. Mainnet Integration | ||
|
||
- Teams propose mainnet integration by submitting a Graph Improvement Proposal (GIP) and initiating a pull request (PR) on the [feature support matrix](https://github.com/graphprotocol/indexer/blob/main/docs/feature-support-matrix.md) (more details on the link). | ||
- The Graph Council reviews the request and approves mainnet support, providing a successful Stage 2 and positive community feedback. | ||
|
||
--- | ||
|
||
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 [[email protected]](mailto:[email protected]) or through Discord (either Pedro, The Graph Foundation member, IndexerDAO, or other core developers). | ||
|
||
--- | ||
|
||
## Frequently Asked Questions | ||
|
||
**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)?** | ||
|
||
This process is related to the Subgraph Data Service, applicable only to new Subgraph `Data Sources`. | ||
|
||
**2. What happens if Firehose & Substreams support comes after the network is supported on mainnet?** | ||
|
||
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. | ||
|
||
**3. How much time will this process take?** | ||
|
||
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. | ||
|
||
**4. How will priorities be handled?** | ||
|
||
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MichaelMacaulay – I know you merged this already, but I feel like these should be headings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch - we still need to add a link to the GIP when that gets merged into the GIP repo so I'll add this when I create that PR. Thank you 🙏