From 2c9a14139ae8441b3191311685ec198e92a70b3b Mon Sep 17 00:00:00 2001 From: Hemanth Soni Date: Tue, 25 Jul 2023 00:15:23 -0400 Subject: [PATCH 1/6] Create subgraphs page in docs --- pages/building-with-pgn/subgraphs.mdx | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 pages/building-with-pgn/subgraphs.mdx diff --git a/pages/building-with-pgn/subgraphs.mdx b/pages/building-with-pgn/subgraphs.mdx new file mode 100644 index 0000000..1b55ff5 --- /dev/null +++ b/pages/building-with-pgn/subgraphs.mdx @@ -0,0 +1,13 @@ +# Subgraphs + +## Overview + +Subgraphs are custom APIs built on top of blockchain data that can be queried using GraphQL. Developers can build and deploy subgraphs to transform raw blockchain data into more useful formats to power their applications. + +PGN subgraphs can be deployed on Goldsky; for more information on getting started, visit [Goldsky's documentation](https://docs.goldsky.com/). + +## How to deploy subgraphs + +PGN subgraphs on Goldsky can be deployed in 2 ways: +- Via CLI from a local subgraph configuration file. If you are familiar with developing subgraphs already, you'll be familiar with this approach; after defining a subgraph lcoally (with a subgraph.yaml file, a schema.graphql file, and the necessary mappings to translate raw event data into the entities defined in the schema), you can deploy subgraphs to Goldsky (once the Goldsky CLI is installed) using `goldsky subgraph deploy / --path`. +- Via [instant subgraphs](https://docs.goldsky.com/indexing/instant-subgraphs), where you can pass through a contract address and the ABI for that contract. This is a quick-start option that automatically generates the underlying subgraph configuration files on your behalf, making it easy to extract blockchain event data and serve it as an API endpoint without complex setup. Use the `--from-ipfs-hash` flag in the command above instead of `--path`. From c786347303d9887828ff717ec8fe4f99f5b1417f Mon Sep 17 00:00:00 2001 From: Hemanth Soni Date: Tue, 25 Jul 2023 00:19:28 -0400 Subject: [PATCH 2/6] Update subgraphs.mdx to use consistent markdown bullet points as other docs pages --- pages/building-with-pgn/subgraphs.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/building-with-pgn/subgraphs.mdx b/pages/building-with-pgn/subgraphs.mdx index 1b55ff5..0836b76 100644 --- a/pages/building-with-pgn/subgraphs.mdx +++ b/pages/building-with-pgn/subgraphs.mdx @@ -9,5 +9,5 @@ PGN subgraphs can be deployed on Goldsky; for more information on getting starte ## How to deploy subgraphs PGN subgraphs on Goldsky can be deployed in 2 ways: -- Via CLI from a local subgraph configuration file. If you are familiar with developing subgraphs already, you'll be familiar with this approach; after defining a subgraph lcoally (with a subgraph.yaml file, a schema.graphql file, and the necessary mappings to translate raw event data into the entities defined in the schema), you can deploy subgraphs to Goldsky (once the Goldsky CLI is installed) using `goldsky subgraph deploy / --path`. -- Via [instant subgraphs](https://docs.goldsky.com/indexing/instant-subgraphs), where you can pass through a contract address and the ABI for that contract. This is a quick-start option that automatically generates the underlying subgraph configuration files on your behalf, making it easy to extract blockchain event data and serve it as an API endpoint without complex setup. Use the `--from-ipfs-hash` flag in the command above instead of `--path`. +* Via CLI from a local subgraph configuration file. If you are familiar with developing subgraphs already, you'll be familiar with this approach; after defining a subgraph lcoally (with a subgraph.yaml file, a schema.graphql file, and the necessary mappings to translate raw event data into the entities defined in the schema), you can deploy subgraphs to Goldsky (once the Goldsky CLI is installed) using `goldsky subgraph deploy / --path`. +* Via [instant subgraphs](https://docs.goldsky.com/indexing/instant-subgraphs), where you can pass through a contract address and the ABI for that contract. This is a quick-start option that automatically generates the underlying subgraph configuration files on your behalf, making it easy to extract blockchain event data and serve it as an API endpoint without complex setup. Use the `--from-ipfs-hash` flag in the command above instead of `--path`. From b8f60185737e4cc0853e6e9c72579a7828601c94 Mon Sep 17 00:00:00 2001 From: Hemanth Soni Date: Tue, 25 Jul 2023 00:19:49 -0400 Subject: [PATCH 3/6] Update _meta.json --- pages/building-with-pgn/_meta.json | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/building-with-pgn/_meta.json b/pages/building-with-pgn/_meta.json index 2975c1d..e05649c 100644 --- a/pages/building-with-pgn/_meta.json +++ b/pages/building-with-pgn/_meta.json @@ -1,5 +1,6 @@ { "deploying-to-pgn": "Deploying to PGN", "ethereum-vs-pgn": "Ethereum vs PGN", + "subgraphs": "Subgraphs", "fees": "Fees" } From b2574cacdb402265dd155acf585cbc9c216cec87 Mon Sep 17 00:00:00 2001 From: Hemanth Soni Date: Tue, 25 Jul 2023 00:21:35 -0400 Subject: [PATCH 4/6] Update building-with-pgn.mdx to reference subgraphs page --- pages/building-with-pgn.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/building-with-pgn.mdx b/pages/building-with-pgn.mdx index bfe4656..aa2115f 100644 --- a/pages/building-with-pgn.mdx +++ b/pages/building-with-pgn.mdx @@ -5,6 +5,7 @@ * [Network and Contract details](/network-and-contract-details) * [Deploying on PGN](/building-with-pgn/deploying-on-pgn) * [Ethereum vs PGN](/building-with-pgn/fees) +* [Subgraphs](/building-with-pgn/subgraphs) * [Fees](/building-with-pgn/ethereum-vs-pgn) From 5677ee4cf3195df2ba1384487b5582eb25257190 Mon Sep 17 00:00:00 2001 From: Hemanth Soni Date: Tue, 25 Jul 2023 00:25:11 -0400 Subject: [PATCH 5/6] Update faq.mdx with Goldsky references --- pages/faq.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/faq.mdx b/pages/faq.mdx index 7c28aed..d724f32 100644 --- a/pages/faq.mdx +++ b/pages/faq.mdx @@ -175,6 +175,7 @@ As of July 25th, 2023, we have had several partners either fully deploy or deplo * [Beamer](https://app.beamerbridge.com/#/) * [Safe](https://safe.global/) * [The Graph](https://thegraph.com/) +* [Goldsky](https://goldsky.com/) ## Deploying contracts @@ -216,7 +217,7 @@ Graph nodes: * Mainnet: [graph-gitcoin-mainnet.hirenodes.io](https://graph-gitcoin-mainnet.hirenodes.io) * Testnet: [graph-gitcoin-testnet.hirenodes.io](https://graph-gitcoin-testnet.hirenodes.io) - +Subgraphs can also be deployed on [Goldsky](https://goldsky.com/), a high-performance hosted subgraph service. ## Blockscout From 6355359ad43dc36f25d1d8cfc7e3f2c546de7290 Mon Sep 17 00:00:00 2001 From: Hemanth Soni Date: Tue, 25 Jul 2023 00:32:18 -0400 Subject: [PATCH 6/6] Update subgraphs page with chain slugs --- pages/building-with-pgn/subgraphs.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pages/building-with-pgn/subgraphs.mdx b/pages/building-with-pgn/subgraphs.mdx index 0836b76..a2a395c 100644 --- a/pages/building-with-pgn/subgraphs.mdx +++ b/pages/building-with-pgn/subgraphs.mdx @@ -11,3 +11,5 @@ PGN subgraphs can be deployed on Goldsky; for more information on getting starte PGN subgraphs on Goldsky can be deployed in 2 ways: * Via CLI from a local subgraph configuration file. If you are familiar with developing subgraphs already, you'll be familiar with this approach; after defining a subgraph lcoally (with a subgraph.yaml file, a schema.graphql file, and the necessary mappings to translate raw event data into the entities defined in the schema), you can deploy subgraphs to Goldsky (once the Goldsky CLI is installed) using `goldsky subgraph deploy / --path`. * Via [instant subgraphs](https://docs.goldsky.com/indexing/instant-subgraphs), where you can pass through a contract address and the ABI for that contract. This is a quick-start option that automatically generates the underlying subgraph configuration files on your behalf, making it easy to extract blockchain event data and serve it as an API endpoint without complex setup. Use the `--from-ipfs-hash` flag in the command above instead of `--path`. + +Both PGN mainnet and testnet are available at the chain slugs `publicgoods` and `publigoods-testnet` respectively.