Skip to main content
Goldsky has partnered with Alchemy to enable a seamless migration; this page outlines the process with consideration for the end-to-end subgraph developer workflow.

​
Step 1: Create account, install CLI, and authenticate

  1. Install the Goldsky CLI: For macOS/Linux: 
    curl https://goldsky.com | sh
    For Windows: 
    npm install -g @goldskycom/cli
    Windows users need to have Node.js and npm installed first. Download from nodejs.org if not already installed.
  2. Go to your Project Settings page and create an API key.
  3. Back in your Goldsky CLI, log into your Project by running the command goldsky login and paste your API key.
  4. Now that you are logged in, run goldsky to get started: 
    goldsky

​
Step 2: Deploy your subgraph

You have three options for migrating your subgraph:

​
Option A: Managed migration

We may have already migrated your subgraph for you. Check the project switcher in the top left of the Goldsky dashboard to see if your project is already available. An automated migration will be visible as a project with a -alchemy suffix. Note that the count of subgraphs may be different from what you have on Alchemy, as failed subgraphs or very large subgraphs with no queries against them may have been skipped. If you expect to see an automated migration and don’t, or the migrated subgraphs don’t align with your Alchemy interface, please reach out to Goldsky support at support@goldsky.com and we can take a look.

​
Option B: Deploy from source

If you have access to your subgraph source code: 
# Build your subgraph
yarn codegen
yarn build

# Deploy to Goldsky
goldsky subgraph deploy your-subgraph-name/v1.0.0 --path .

​
Option C: Migrate from IPFS hash

If your subgraph is already deployed on Alchemy, you may be able to migrate it directly using the IPFS deployment hash: 
goldsky subgraph deploy your-subgraph-name/v1.0.0 --from-ipfs-hash <IPFS_HASH> --ipfs-gateway https://ipfs.satsuma.xyz
You can find the IPFS hash by querying your Alchemy subgraph endpoint: 
query {
  _meta {
    deployment
  }
}
This method does not always work due to quirks in how IPFS hash lookups are handled. If you are facing difficulties in migrating, please feel free to reach out to Goldsky support at support@goldsky.com and we can help.

​
Step 3: Monitor indexing progress

Track your subgraph’s indexing status: 
goldsky subgraph list
Or navigate to app.goldsky.com to view:
  • Real-time indexing progress
  • Query performance metrics
  • Error logs and alerts
  • Endpoint URLs
If your subgraph was pre-migrated for you, it should already be live and fully synced. Certain subgraphs may be in a Paused state if they were detected as not being actively used in your Alchemy account; this helps minimize resource usage and costs. If you would like to resume indexing, you can unpause them from the web interface or via the CLI, and they will quickly catch up to the tip of the chain.

​
Step 4: Update your application

Once your subgraph is fully synced, update your application code to use the new Goldsky endpoint.

​
Endpoint differences

Replace your Alchemy subgraph endpoint with your Goldsky endpoint: Alchemy: 
https://subgraph.satsuma-prod.com/<query_key>/<project_prefix>/<subgraph_name>/api
Goldsky format: 
https://api.goldsky.com/api/public/<project_id>/subgraphs/<subgraph_name>/<subgraph_version>/gn
You can find your Goldsky endpoint in the Goldsky dashboard or by running: 
goldsky subgraph list

​
Deployment differences

Alchemy uses TheGraph CLI with their custom deployment endpoint. Goldsky provides its own CLI for a streamlined experience: Alchemy deployment: 
graph codegen &&
graph build &&
graph deploy <name> \
  --version-label <version> \
  --deploy-key <key> \
  --ipfs https://ipfs.satsuma.xyz
Goldsky deployment: 
goldsky subgraph deploy <name>/<version> --path .

​
CI/CD differences

For automated deployments, update your CI/CD pipelines to reflect the same changes in deployment flow as outlined above (ie. the switch from graph CLI commands to goldsky CLI commands). For inpsiration, see the Goldsky Deploy Github action.

​
Step 5: Test and verify

Before switching over your production traffic:
  1. Test queries against your new Goldsky endpoint
  2. Verify data consistency between Alchemy and Goldsky
  3. Check query performance and latency
  4. Set up monitoring and alerts in the Goldsky dashboard
Note: If you encounter any issues during the migration, please reach out to the Goldsky team at support@goldsky.com for assistance.

​
Step 6: Switch production traffic

Once verified, update your production environment variables or configuration to point to the Goldsky endpoint. Consider using a gradual rollout or feature flag to minimize risk. For additional support during your migration, reach out to the Goldsky team at support@goldsky.com.