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

NOT COMPATIBLESubgraphs are designed for EVM-compatible chains and are not available for Sui.Sui uses a different virtual machine architecture. For Sui data indexing, consider using Mirror or Turbo pipelines which support non-EVM chains.

​
Mirror

MAINNET SUPPORTEDTESTNET 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.

​
Working with Sui datasets

Mirror pipelines allow users to replicate data into their own infrastructure (any of the supported sinks) in real time. The supported data sources are the following direct indexing datasets: checkpoints, packages, transactions, epochs and events. For a complete overview of how to deploy Mirror pipelines, including a video walkthrough, check the Create a Pipeline. Below, we will look at a few of the different ways by which you can deploy Mirror pipelines.
Remember to first create a Secret in order for Mirror to be able to write the data into the database of your choice.
Pipelines can be deployed on Goldsky in 3 ways:
  • Using Goldsky Flow in the dashboard:
    • Drop a Data Source card. Select Sui as the chain. Then Enriched Transactions as the onchain dataset to use.
    • Add a Sink card and select your pre-configured sink.
    • Deploy pipeline.
  • Using the interactive CLI:
    • Enter command goldsky pipeline create <pipeline-name>.
    • This will kick off a guided flow with the first step to choose the dataset type. Choose Direct Indexing.
    • Next, select Sui as chain with the enter key, then Raw Transactions as the dataset by pressing space on the selected dataset which you can select using the up and down arrow keys. We will process historical data so select Process all historical data by pressing the enter key. This is the same as the yaml config setting of start_at: earliest. If you prefer to only ingest data starting when your pipeline is deployed, select Process data from the time this pipeline is created instead, this is equivalent to the yaml config setting start_at: latest.
    • When asked to choose another source, choose No by pressing enter.
    • Add your pre-configured sink. In this example case, we chose PostgreSQL and as a next step we selected the database schema.
    • Pipeline will be deployed automatically.
  • Using a pipeline configuration 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.
    • As in the previous steps, we’ll be deploying a pipeline to stream Sui transactions. Unlike the other methods, we have added a transformation to only select specific data attributes from the whole dataset. This is the configuration file:
sui-transactions.yaml
apiVersion: 3
name: sui-raw-transactions
sources:
  sui_transactions:
    dataset_name: sui.transactions
    version: 1.0.0
    type: dataset
transforms:
  subset_transform:
    primary_key: id
    sql: |
      SELECT
        id,
        transaction_digest,
        transaction_kind,
        effects_json,
        transaction_json
        FROM sui_transactions
sinks:
  postgres_sui_transactions:
    type: postgres
    table: sui_transactions
    schema: public
    secret_name: <YOUR_SECRET_NAME>
    description: 'Postgres sink for: sui_transactions'
    from: subset_transform
Add your corresponding secret name and run goldsky pipeline apply sui-transactions.yaml --status ACTIVE to deploy the pipeline.

​
Turbo

MAINNET SUPPORTEDTESTNET SUPPORTEDTurbo pipelines provide high-performance streaming data pipelines with sub-second latency. Deploy a pipeline to start streaming Sui data to your preferred destination.

Quick deploy

Create a new Turbo pipeline using the CLI:
Create pipeline
goldsky turbo deploy my-sui-pipeline --chain sui

Configuration file

For more complex pipelines, use a YAML configuration file:
sui-pipeline.yaml
name: my-sui-pipeline
sources:
  - type: evm
    chain: sui
    start_block: latest

transforms:
  - type: sql
    query: |
      SELECT * FROM blocks

sinks:
  - type: postgres
    secret_name: MY_POSTGRES_SECRET
Deploy with:
Deploy from config
goldsky turbo deploy -f sui-pipeline.yaml

Available chain slugs

Mainnet: sui | Testnet: sui-testnetFor the full configuration reference and available transforms, see the Turbo documentation.

​
Edge

NOT COMPATIBLERPC Edge is designed for EVM-compatible chains and is not available for Sui.Sui uses a different virtual machine architecture. For Sui data access, consider using Mirror or Turbo pipelines which support non-EVM chains.

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