Skip to main content
Version: Firesquid

Quickstart

This section goes through deploying a squid to Aquarium -- a cloud API service provided by Subsquid. The deployment is managed by the file squid.yaml in the root folder of the squid and defines:

  • the squid name and version
  • what services should be deployed for the squid (e.g. postgres, processor, api)
  • how the squid should be scaled up if it grows bigger

See the Deploy Manifest page for a full reference. The scaling option is available only to the Aquairum Premium users. To apply for a Premium account, fill this form.

0. Setup and install Squid CLI

If Squid CLI is not installed, see the Squid CLI doc

info

The manifest-based deployment flow below was introduced in @subsquid/cli version 2.x. Follow the migration guide to upgrade from older versions of @subsquid/cli.

1. Inspect and deploy using the manifest

Navigate to the squid folder and make sure squid.yaml is present in the root. See the Deploy Manifest page for a full reference.

To deploy a new version or update the existing one (define in the manifest), run

sqd deploy .

For a full list of available deploy options, inspect sqd deploy help.

2. Monitor Squid logs

Once the squid is deployed, the GraphQL endpoint is available straight away. Normally one should wait until the squid has processed all historical blocks and is fully in sync.

To inspect the squid logs run

sqd logs my-new-squid@v0 -f 

or navigate to the squid page in Aquarium. See the logging page for more details on how to inspect logs.

What's next?

  • Learn how to scale the squid by requesting more resources
  • See how to update and kill the deployed squid versions
  • See Secrets and Env variables to add secrets and environment variables to a squid deployment.
  • See the supported options for squid logs such as filtering and log following.