Skip to main content

​
Overview

Goldsky is the modern back-end for crypto-enabled products; the infrastructure layer between your application and the blockchain. We handle the complex, undifferentiated work of building on crypto rails: streaming real-time data, maintaining reliable chain connectivity, and executing onchain logic. Teams use Goldsky to ship faster and stay focused on their core product.

​
Partnership

Goldsky has partnered with to make our product available to the ecosystem and provide dedicated support for . Below in the overview of each product, the “Partner Sponsored” tag indicates that usage of that product is fully covered by the chain, if approved by the team. Where this perk is available, please reach out to the developer relations team for an access code to the private signup form.

​
Getting started

To use Goldsky, you’ll need to create an account, install the CLI, and log in. If you want to use Turbo or Compose, you’ll also need to install their respective CLI extensions.
  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
If you already have the Goldsky CLI installed, install the Turbo extension by running:
goldsky turbo
This will automatically install the Turbo extension. Verify the installation:
goldsky turbo list
Make sure to update the CLI to the latest version before running Turbo commands: curl https://goldsky.com | sh
For a complete reference of all Turbo CLI commands, see the CLI Reference guide.
Compose is currently in private beta and access is invite-only. The following commands will not work unless you have been explicitly whitelisted by the Goldsky team. Enterprise customers can contact their Account Manager for expedited early access.
If you already have the Goldsky CLI installed, install the Compose extension by running:
goldsky compose install
To update to the latest version:
goldsky compose update
For more details, see the Compose quickstart guide.

​
Subgraphs

MAINNET SUPPORTEDTESTNET SUPPORTEDPARTNER SPONSOREDLumia subgraphs can be deployed on Goldsky 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 locally (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 <name>/<version> --path . For more, read the step-by-step guide.
  • Via 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-abi flag in the command above instead of --path. For more, read the low-code subgraphs guide.

​
Mirror

NOT YET AVAILABLEMirror pipelines let you replicate blockchain data into your own infrastructure in real-time. Learn more about what you can build with Mirror in the Mirror documentation. Mirror is not currently enabled for Lumia, but we'd love to change that.From the Lumia team? Book a call to explore enabling Mirror for your ecosystem.
Building on Lumia? Contact us about dedicated infrastructure options.

​
Turbo

NOT YET AVAILABLETurbo provides high-performance streaming data pipelines with sub-second latency for real-time blockchain data. Learn more about what you can build with Turbo in the Turbo documentation. Turbo is not currently enabled for Lumia, but we'd love to change that.From the Lumia team? Book a call to explore enabling Turbo for your ecosystem.
Building on Lumia? Contact us about dedicated infrastructure options.

​
RPC Edge

NOT YET AVAILABLERPC Edge provides reliable, high-performance RPC access with low latency via multi-region CDN, intelligent caching, automatic failover, and built-in observability—optimized for both indexing backends and frontend applications. Learn more in the RPC Edge documentation.RPC Edge is not currently enabled for Lumia, but we'd love to change that.From the Lumia team? Book a call to explore enabling RPC Edge for your ecosystem.
Building on Lumia? Contact us about dedicated infrastructure options.

​
Compose

NOT YET AVAILABLECompose lets you build offchain-to-onchain systems that durably move data and execute logic between your application and the blockchain. Learn more about what you can build with Compose in the Compose documentation. Compose is not currently enabled for Lumia, but we'd love to change that. From the Lumia team? Book a call to explore enabling Compose for your ecosystem.
Building on Lumia? Contact us about dedicated infrastructure options.

​
Getting support

Can’t find what you’re looking for? Reach out to us at support@goldsky.com for help.