Docs
Search⌘ K
  • Home
  • About The Graph
  • Supported Networks
  • Protocol Contracts
  • Subgraphs
    • Substreams
      • Token API
        • AI Suite
          • Indexing
            • Resources
              Substreams

              Publishing a Substreams Package

              Learn how to publish a Substreams package to the Substreams Registry⁠.

              Overview

              What is a package?

              A Substreams package is a precompiled binary file that defines the specific data you want to extract from the blockchain, similar to the mapping.ts file in traditional Subgraphs.

              Publish a Package

              Prerequisites

              • You must have the Substreams CLI installed.
              • You must have a Substreams package (.spkg) that you want to publish.

              Step 1: Run the substreams publish Command

              1. In a command-line terminal, run substreams publish <YOUR-PACKAGE>.spkg.

              2. If you do not have a token set in your computer, navigate to https://substreams.dev/me.

              get token

              Step 2: Get a Token in the Substreams Registry

              1. In the Substreams Registry, log in with your GitHub account.

              2. Create a new token and copy it in a safe location.

              new token

              Step 3: Authenticate in the Substreams CLI

              1. Back in the Substreams CLI, paste the previously generated token.
              paste token
              1. Lastly, confirm that you want to publish the package.
              confirm

              That’s it! You have successfully published a package in the Substreams registry.

              success

              Additional Resources

              Visit Substreams⁠ to explore a growing collection of ready-to-use Substreams packages across various blockchain networks.

              ⁠Edit on GitHub⁠

              Sink your SubstreamsQuick Start
              On this page
              • Overview
              • What is a package?
              • Publish a Package
              • Prerequisites
              • Step 1: Run the substreams publish Command
              • Step 2: Get a Token in the Substreams Registry
              • Step 3: Authenticate in the Substreams CLI
              • Additional Resources
              The GraphStatusTestnetBrand AssetsForumSecurityPrivacy PolicyTerms of Service