Deploy a subgraph
There are three primary ways to deploy a subgraph on Goldsky:
- From source code
- Migrating from The Graph or any other subgraph host
- Via instant, no-code subgraphs
For any of the above, you’ll need to have the Goldsky CLI installed and be logged in; you can do this by following the instructions below.
Install Goldsky's CLI and log in
Install Goldsky's CLI and log in
-
Install the Goldsky CLI:
For macOS/Linux:
For Windows:
Windows users need to have Node.js and npm installed first. Download from nodejs.org if not already installed. -
Go to your Project Settings page and create an API key.
-
Back in your Goldsky CLI, log into your Project by running the command
goldsky login
and paste your API key. -
Now that you are logged in, run
goldsky
to get started:
For these examples we’ll use the Ethereum contract for POAP.
From source code
If you’ve developed your own subgraph, you can deploy it from the source. In our example we’ll work off of a clone of the POAP subgraph.
First we need to clone the Git repo.
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.
Then you can deploy the subgraph to Goldsky using the following command.
From The Graph or another host
For a detailed walkthrough, follow our dedicated guide.
Via instant, no-code subgraphs
For a detailed walkthrough, follow our dedicated guide.