Skip to main content

​
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.
  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

​
Mirror

​
Turbo

​
Deploying MegaETH pipelines with Turbo

Here’s the workflow for deploying a Turbo pipeline:
  1. Create a pipeline configuration file - Define your sources, transforms, and sinks in a YAML file
  2. Validate your configuration - Run goldsky turbo validate megaeth-pipeline.yaml to check for errors
  3. Deploy the pipeline - Run goldsky turbo apply megaeth-pipeline.yaml to deploy
  4. Monitor your pipeline - Use goldsky turbo logs megaeth-pipeline.yaml to view logs and goldsky turbo inspect megaeth-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 Turbo pipeline configuration

Here’s an example configuration that streams ERC-20 transfer events from MegaETH to a Postgres database:
megaeth-erc20-transfers.yaml
name: megaeth-erc20-transfers
resource_size: s

sources:
 megaeth_erc20_transfers:
    type: dataset
    dataset_name: megaeth.erc20_transfers
    version: 1.0.0
    start_at: latest

transforms:
  decoded_transfers:
    type: sql
    primary_key: id
    sql: |
      SELECT
        id,
        sender,
        recipient,
        amount,
        to_timestamp(block_timestamp) as block_time
      FROM megaeth_erc20_transfers

sinks:
  postgres_output:
    type: postgres
    from: decoded_transfers
    schema: public
    table: megaeth_erc20_transfers
    secret_name: YOUR_POSTGRES_SECRET
    primary_key: id
This pipeline:
  1. Sources - Pulls all ERC-20 Transfer events from MegaETH mainnet using the evm.logs source type with a filter for the Transfer event signature
  2. Transforms - Uses SQL to select and rename the relevant fields from the raw log data, including block info, transaction hash, token address, and transfer details
  3. Sinks - Writes the decoded transfer data to a Postgres table called megaeth_erc20_transfers
Deploy the pipeline by running: 
goldsky turbo apply megaeth-erc20-transfers.yaml

​
Edge RPC

​
Compose

​
Getting support

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