Skip to main content

Overview

Goldsky is a high-performance data indexing provider for Telos that makes it easy to extract, transform, and load on-chain data to power both application and analytics use cases. Goldsky offers two primary approaches to indexing and accessing blockchain data: Subgraphs (high-performance subgraphs) and Mirror (real-time data replication pipelines).

Scope

Goldsky has partnered with Telos to make our product available to the ecosystem and provide dedicated support for Telos data indexing. The full scope of our partnership (which products are enabled, what partner-exclusive benefit is available, and who this benefit is available to) is outlined below.
Subgraphs
EnablementYes
Benefit100% discount on Subgraph workers and entities stored
AvailabilityAll developers
Where perks are available to projects specified by the chain ecosystem, please reach out to their developer relations team for an access code and link to private signup form. Where perks are openly available to all developers, please contact sales@goldsky.com to apply the applicable partnership perks to your project.

Getting started

To use Goldsky, you’ll need to create an account, install the CLI, and log in.
  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
    

Subgraphs

Telos 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 no-code subgraphs guide.
Both Telos mainnet and testnet are available at the chain slugs telos and telos-testnet respectively.

Mirror

Support for Goldsky Mirror for Telos is currently in progress. If you’d like to be notified when support is launched publicly, contact us at sales@goldsky.com.

Getting support

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