Skip to content

Conversation

MichaelMacaulay
Copy link
Contributor

  • Related to this task
  • Edited for chain neutrality
  • Many minor edits/rewrites along the way

Outstanding questions:

  1. Ethereum is specifically mentioned on the indexing page.
    • Is this changing or no?
  2. Under network section/developing there’s a message that says There are certain constraints on The Graph Network, in terms of feature and network support. Currently only mainnet Ethereum subgraphs will earn indexing rewards, and subgraphs which fetch data from IPFS are also not eligible.
    • Just wanted to confirm this is true (I believe it is but not 100% sure).
  3. Publishing section/publishing page/publishing a subgraph heading: “Goerli subgraphs can query mainnet & goerli”?
    • Is this true for other chains? (That the testnets can query mainnet data too?)
    • Might be best to say: “Networks can only query data from their respective networks” (just to avoid confusion)
  4. On the Operating a Graph Node page: user needs Ethereum-compliant JSON-RPC to index a network.
    • Is this something that will remain true?

@MichaelMacaulay MichaelMacaulay requested a review from a team as a code owner February 24, 2023 22:45
Copy link
Contributor

@benface benface left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work! 🙌

MichaelMacaulay and others added 11 commits February 27, 2023 10:05
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
Co-authored-by: Benoît Rouleau <benoit.rouleau@icloud.com>
graph-node consistency
work token -> work utility token
@Web3Slimchance
Copy link
Contributor

Thank you so much for working on this - 🔥
I added some comments to your edits.
As for the questions:

  1. I would like to see more "Chain neutral" language here as well. However - with Firehose supported by Graph Node, it is challenging to use concise, yet precise language. I may need to let it sit, but a first stab is:

At the center of an Indexer's infrastructure is the Graph Node which monitors the indexed networks, extracts and loads data per a subgraph definition and serves it as a GraphQL API. The Graph Node needs to be connected to an endpoint exposing data from each indexed network; an IPFS node for sourcing data; a PostgreSQL database for its store; and Indexer components which facilitate its interactions with the network.

PostgreSQL database - The main store for the Graph Node, this is where subgraph data is stored. The Indexer service and agent also use the database to store state channel data, cost models, indexing rules, and allocation actions.

Data Endpoint - For EVM-compatible networks, Graph node needs to be connected to an endpoint that exposes an EVM-compatible JSON-RPC API. This may take the form of a single client or it could be a more complex setup that load balances across multiple. It's important to be aware that certain subgraphs will require particular client capabilities such as archive mode
and/or the parity tracing API.

  1. Ethereum Mainnet, Gnosis, Celo, Avalanche and Arbitrum One are all earning Indexing rewards (Celo, Avalanche and Arbitrum One as of today). We should make this chain-neutral and refer to the supported networks page. Note: The canonical document for supported networks (and rewards) are https://github.com/graphprotocol/indexer/blob/main/docs/networks/mainnet.md#feature-support.

Subgraphs using IPFS are currently not eligible for Indexing Rewards

  1. When a subgraph is published:
  2. The subgraph will be Indexing a network
  3. The subgraph will be published to one of the networks where The Graph's contracts are deployed (Ethereum Mainnet, Ethereum Goerli, Arbitrum One, Arbitrum Goerli)
  • These two networks are completely decoupled. You could publish a subgraph indexing Ethereum Mainnet on Arbitrum Goerli etc.
  • Each subgraph can only index one network.
  1. Answered in 1. With firehose and non-evm networks supported, and also an upcoming feature for the firehose stack, it is a bit complicated.

Copy link
Contributor

@Web3Slimchance Web3Slimchance left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this. See comments

Copy link
Contributor

@Web3Slimchance Web3Slimchance left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you - very much. Left a couple more comments 🙏

Copy link
Contributor

@Web3Slimchance Web3Slimchance left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.
Thank you Michael 🙌

@MichaelMacaulay MichaelMacaulay merged commit ddf2d33 into main Mar 20, 2023
@MichaelMacaulay MichaelMacaulay deleted the multichain-ready branch March 20, 2023 16:39
@github-actions
Copy link

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

Nineteen Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/en/about 8.61 KB 1.39 MB 408.08% (🟡 +0.01%)
/en/cookbook/quick-start 8.75 KB 1.39 MB 408.12% (🟢 -0.01%)
/en/deploying/deploying-a-subgraph-to-hosted 10.77 KB 1.4 MB 408.70% (🟢 -0.01%)
/en/deploying/hosted-service 7.58 KB 1.39 MB 407.79% (🟢 -0.01%)
/en/deploying/subgraph-studio 9.55 KB 1.4 MB 408.35% (🟢 -0.03%)
/en/developing/creating-a-subgraph 26.4 KB 1.41 MB 413.17% (🟢 -0.01%)
/en/developing/developer-faqs 10.94 KB 1.4 MB 408.75% (+/- <0.01%)
/en/developing/supported-networks 7.24 KB 1.39 MB 407.69% (🟡 +0.02%)
/en/managing/deprecating-a-subgraph 6.39 KB 1.39 MB 407.45% (🟡 +0.01%)
/en/network-transition-faq 14.83 KB 1.4 MB 409.86% (🟡 +0.01%)
/en/network/benefits 8.1 KB 1.39 MB 407.94% (+/- <0.01%)
/en/network/developing 8.01 KB 1.39 MB 407.91% (+/- <0.01%)
/en/network/explorer 14.5 KB 1.4 MB 409.76% (+/- <0.01%)
/en/network/indexing 22.33 KB 1.41 MB 412.00% (🟡 +0.01%)
/en/network/overview 6.66 KB 1.39 MB 407.52% (🟢 -0.02%)
/en/operating-graph-node 16.09 KB 1.4 MB 410.22% (+/- <0.01%)
/en/publishing/publishing-a-subgraph 7.25 KB 1.39 MB 407.69% (🟢 -0.01%)
/en/querying/graphql-api 11.58 KB 1.4 MB 408.93% (+/- <0.01%)
/en/tokenomics 10.73 KB 1.4 MB 408.69% (🟡 +0.04%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants