After you've followed the setup instructions in our Getting Started guide you have multiple ways you can deploy your subgraph to Goldsky.
For these examples we'll use the Ethereum contract for POAP.
- From a contract address using The Graph's CLI
- From Source
- From The Graph URL or IPFS hash
- Instant Subgraph Configuration
From a contract address using The Graph's CLI
The contract address for POAP on Ethereum is
Make sure you have The Graph's CLI tool installed, then in your terminal initialize a new subgraph.
There will be some interactive prompts, fill them out as seen below.
graph init poap-subgraph ✔ Product for which to initialize · subgraph-studio ✔ Subgraph slug · poap-subgraph ✔ Directory to create the subgraph in · poap-subgraph ✔ Ethereum network · mainnet ✔ Contract address · 0x22C1f6050E56d2876009903609a2cC3fEf83B415 ✔ Fetching ABI from Etherscan ✖ Failed to fetch Start Block: Failed to fetch contract creation transaction hash
It's pretty common when using this method for the Start Block to not be automatically detected. You can find it yourself by checking the contract on Etherscan or the relevant scanner for the network your subgraph is on.
From the contract page, you can find the transaction that created the contract under
CONTRACT CREATOR, click through to the transaction or txn and the block number should be visible. Copy and paste that into the terminal and you should be good to go.
✔ Start Block · 7844214 ✔ Contract Name · POAP ✔ Index contract events as entities (Y/n) · true Generate subgraph Write subgraph to directory ✔ Create subgraph scaffold ✔ Initialize networks config ✔ Initialize subgraph repository ✔ Install dependencies with yarn ✔ Generate ABI and schema types with yarn codegen Add another contract? (y/n): n Subgraph poap-subgraph created in poap-subgraph
You will now have a directory with the scaffolding for the POAP subgraph.
To deploy this subgraph to Goldsky, make sure you're logged in with your API token, then run the following command.
cd poap-subgraph yarn build goldsky subgraph deploy poap-subgraph/1.0.0 --path .
You can give your subgraph any name and version that you want. Versioning is useful for when you make updates to your subgraph and you want the GraphQL endpoint to remain consistent. We'll show you how to manage that using Tags at the end of this page.
If you've developed your own subgraph, you can deploy it from your system. It's a similar process to deploying a subgraph built from the contract address. In our example we'll be using the open source POAP subgraph.
First we need to clone the Git repo.
git clone https://github.com/poap-xyz/poap-subgraph.git
Now change into that directory. From here, we'll build the subgraph from templates. Open source subgraphs have different instructions to get them to build, so check the
README.md or look at the
package.json for hints as to the correct build commands. Usually it's a two step process, but since POAP is deployed on multiple chains, there's one extra step at the start to generate the correct data from templates.
Newer graph-cli versions
The POAP repo uses an older version of The Graph's graph-cli package, and if you have a more recent version installed and see the error
The current version of graph-cli can't be used with mappings on apiVersion less than '0.0.5' during codegen, edit the
subgraph.template.yaml file and change the apiVersion value from 0.0.4 to 0.0.5
yarn prepare:mainnet yarn codegen yarn build
Then you can deploy the subgraph to Goldsky using the following command.
goldsky subgraph deploy poap-subgraph/1.0.0 --path .
From The Graph URL or IPFS hash
For a more detailed description of how to do this you can follow our guide.
Instant Subgraph Configuration
For a detailed guide on using our Instant Subgraph Configurations, check out this guide.
We mentioned tags earlier, they're used to maintain a consistent GraphQL endpoint. By default, the Goldsky GraphQL endpoints are named after the subgraph name and version, so if you update your subgraph to a new version, you'll need to update your front end to point to the new GraphQL endpoint. Using tags, you can manage your versions and seamlessly upgrade your subgraph version without having the URL change.
In this example, we'll assume you have already deployed a subgraph with the name and version
poap-subgraph/1.0.0. We'll show you how to create a tag and how to move it to another subgraph version.
First, create a tag using the Goldsky CLI and associate it with your subgraph.
goldsky subgraph tag create poap-subgraph/1.0.0 --tag prod
We've now created a new tag called
prod. Now our GraphQL endpoint will use the word
prod instead of the version number. You should see the new GraphQL endpoint listed in your terminal after running the command.
Let's say you've upgraded your
poap-subgraph to verison
2.0.0 and want to start querying it with your
prod GraphQL endpoint. It's as simple as creating the tag again on the new version.
goldsky subgraph tag create poap-subgraph/2.0.0 --tag prod
Like before, you should see the GraphQL endpoint after running this command, and it should be the same as before. Now your queries will be routed to the
2.0.0 version of the subgraph seamlessly