Skip to main content

Migrate to the Cloud portal

For users on EVM and Substrate networks

info

SQD Network portals are currently in beta. Please report any bugs or suggestions to the SQD Portal Beta chat or to Squid Devs.

This guide walks you through replacing a gateway of the open private version of SQD Network with a portal of the permissionless SQD Network as the primary source of data for your Cloud squids.

SQD team operates two independent portals that serve the needs of Cloud users:

  • The dedicated Cloud Portal is only visible from within the Cloud, ensuring stable performance for squids deployed there.
  • The Public Portal can be accessed from anywhere for easy experimentation and local development.
info

We're currently experimenting with tightening the data request complexity limits. If you see an HTTP 400 error with a message like this:

Couldn't parse query: query contains X item requests, but only 50 is allowed

where X is some number above 50, or any other HTTP 400 response, please let us know.

Here are the steps to migrate:

Step 1: update to @latest packages

A. Enter your squid's folder.

B. Remove both your lock file and the node_modules folder:

rm -r node_modules package-lock.json

C. Upgrade all SQD packages to the @latest major version:

npx --yes npm-check-updates --filter "@subsquid/*" --upgrade

D. Install the dependencies:

npm install

Step 2: tell your code to use the Portal

Follow the network-specific instructions from the Cloud:

  • navigate to the Portal's page
  • click on the tile of your network to see the instructions

Once you're done, your squid will use the Cloud Portal when deployed and the public portal for local runs.

If you just want to update your squid code to use the Portal-enabled SDK version you can simply redeploy your squid here and be done. No need to re-sync.

However, for the duration of this beta we strongly recommend that you re-sync your squid. This will allow you to make sure everything is working as it should and evaluate the improved data source performance. Follow the zero-downtime update procedure:

  1. Deploy your squid into a new slot.

  2. Wait for it to sync, observing the improved data fetching.

  3. Assign your production tag to the new deployment to redirect the GraphQL requests there.

See this section for details.

What's next?

Stay hyped for news on the introduction of real time data to EVM and Substate - it is coming soon.