Sui

Overview

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.

Install Goldsky CLI and log in

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.
Log into your Project by running:
goldsky login
This opens your browser to sign in (Google, GitHub, SSO, or email). Once you authenticate, the CLI is logged in automatically — there’s no API key to copy or paste.
On a headless or remote machine (or in CI), create an API key on your Project Settings page and pass it directly with goldsky login --token <API_KEY>. Use goldsky login --no-browser to print the login URL instead of opening a browser.
Now that you are logged in, run goldsky to get started:
goldsky

Install Turbo CLI extension

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.

Install Compose CLI extension

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

Mirror

Turbo

Working with Sui datasets

Goldsky provides real-time streaming of Sui datasets, including all historical data. The following dataset is currently available:

Dataset	Description
Raw Events (`sui.raw_events_v5`)	Move contract events emitted on Sui, including event type, module, package, transaction context, and payload.

This dataset can be used as a source in your Turbo pipelines to stream Sui data to any of the supported sinks.

Deploying Sui pipelines

Turbo pipelines are defined using YAML configuration files and deployed via the Goldsky CLI. Here’s the workflow:

Create a pipeline configuration file - Define your sources, transforms, and sinks in a YAML file
Validate your configuration - Run goldsky turbo validate sui-pipeline.yaml to check for errors
Deploy the pipeline - Run goldsky turbo apply sui-pipeline.yaml to deploy
Monitor your pipeline - Use goldsky turbo logs sui-pipeline.yaml to view logs and goldsky turbo inspect sui-pipeline.yaml to see live data

For a complete walkthrough, see the Turbo Pipelines Quickstart.

Remember to first create a Secret in order for Turbo Pipelines to be able to write the data into the database of your choice.

Example pipeline configuration

Here’s an example configuration file for streaming Sui raw events:

sui-events.yaml

name: sui-events
resource_size: s

sources:
  sui_events:
    type: dataset
    dataset_name: sui.raw_events_v5
    version: 1.0.0
    start_at: latest               # or 'earliest' to process all historical data
    filter: checkpoint >= 1000000  # Optional: only include events at or after this checkpoint

sinks:
  postgres_sui_events:
    type: postgres
    from: sui_events
    schema: public
    table: sui_events
    secret_name: <YOUR_SECRET_NAME>
    primary_key: id

Choosing where to start:

start_at: latest streams data from when the pipeline is deployed. Use start_at: earliest instead to process all historical data.
filter: checkpoint >= <checkpoint_number> limits the source to events at or after a specific Sui checkpoint. Sui does not support a numeric start_block; use this checkpoint filter for historical processing from a specific point in time.

Add your corresponding secret name and run goldsky turbo apply sui-events.yaml to deploy the pipeline.

Edge

Compose

Getting support

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

Chains

Partners

Other networks

Overview

Partnership

Getting started

Subgraphs

Mirror

Turbo

Working with Sui datasets

Deploying Sui pipelines

Example pipeline configuration

Edge

Compose

Getting support

​Overview

​Partnership

​Getting started

​Subgraphs

​Mirror

​Turbo

​Working with Sui datasets

​Deploying Sui pipelines

​Example pipeline configuration

​Edge

​Compose

​Getting support

Overview

Partnership

Getting started

Subgraphs

Mirror

Turbo

Working with Sui datasets

Deploying Sui pipelines

Example pipeline configuration

Edge

Compose

Getting support