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.

​
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

NOT YET AVAILABLESubgraphs let you define custom data schemas and indexing logic to serve blockchain data via GraphQL APIs. Learn more about what you can build with Subgraphs in the Subgraphs documentation. Subgraphs are not currently enabled for Settlus, but we'd love to change that.From the Settlus team? Book a call to explore enabling Subgraphs for your ecosystem.
Building on Settlus? Contact us about dedicated infrastructure options.

​
Mirror

MAINNET SUPPORTEDMirror pipelines allow users to replicate data into their own infrastructure (any of the supported sinks) in real time, including both subgraphs as well as chain-level datasets (ie. blocks, logs, transactions, traces). Pipelines can be deployed on Goldsky in 3 ways:
  • Using Goldsky Flow on the dashboard, see walkthrough video here
  • Using the interactive CLI, by entering the command goldsky pipeline create <pipeline-name>. This will kick off a guided flow with the first step to choose the dataset type (project subgraph, community subgraph, or chain-level dataset). You'll then be guided through adding some simple filters to this data and where to persist the results.
  • Using a definition file, by entering the command goldsky pipeline create <pipeline-name> --definition-path <path-to-file>. This makes it easier to set up complex pipelines involving multiple sources, multiple sinks, and more complex, SQL-based transformations. For the full reference documentation on, click here.

​
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 Settlus, but we'd love to change that.From the Settlus team? Book a call to explore enabling Turbo for your ecosystem.
Building on Settlus? 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 Settlus, but we'd love to change that.From the Settlus team? Book a call to explore enabling RPC Edge for your ecosystem.
Building on Settlus? 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 Settlus, but we'd love to change that. From the Settlus team? Book a call to explore enabling Compose for your ecosystem.
Building on Settlus? 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.