Subsquid squid manifest

Squid manifest for Subsquid Cloud deployments

Type object
File match squid.yaml *.squid.yaml squid.yml *.squid.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/subsquid-squid-manifest/latest.json
Source https://cdn.subsquid.io/schemas/squid_manifest.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

deploy object required
8 nested properties
processor required
cors object
7 nested properties
enabled boolean
Default: true
allow_origin string[]
allow_methods string[]
allow_headers string[]
expose_headers string[]
allow_credentials boolean
max_age integer
exclusiveMin=0
addons object
4 nested properties
postgres object | null
2 nested properties
version const: "14"
Default: "14"
Constant: "14"
config object
neon object
1 nested properties
version const: "16"
Default: "16"
Constant: "16"
hasura object | null
2 nested properties
version string
Default: "latest"
env object
rpc string[]
env object
1 nested properties
/^[a-zA-Z_][a-zA-Z0-9_]*$/ string
init object
2 nested properties
cmd string[] required
minItems=1
env object
1 nested properties
/^[a-zA-Z_][a-zA-Z0-9_]*$/ string
migrate object

[DEPRECATED] Please use "deploy.init" instead

2 nested properties
cmd string[] required
minItems=1
env object
1 nested properties
/^[a-zA-Z_][a-zA-Z0-9_]*$/ string
api object
2 nested properties
cmd string[] required
minItems=1
env object
1 nested properties
/^[a-zA-Z_][a-zA-Z0-9_]*$/ string
secrets string[]

[DEPRECATED] Please use secrets context https://docs.subsquid.io/cloud/resources/env-variables/#secrets

manifest_version const: "subsquid.io/v0.1"
Constant: "subsquid.io/v0.1"
name string
minLength=3maxLength=30pattern=^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
version integer
max=1000000exclusiveMin=0
slot string
minLength=2maxLength=6pattern=^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
tag string
minLength=2maxLength=32pattern=^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$
description string
queries object
build object | null
5 nested properties
dockerfile string
Default: "Dockerfile"
node_version string
Default: "20"
Values: "18" "20" "21"
package_manager string
Default: "auto"
Values: "auto" "npm" "pnpm" "yarn"
install object
1 nested properties
cmd string[] required
minItems=1
cmd string[]
minItems=1
scale object
4 nested properties
dedicated boolean
addons object
4 nested properties
postgres object
4 nested properties
storage string
pattern=^\d+[GT]i?$
autoresize boolean
autoresize_limit string
profile string
Values: "small" "medium" "large" "xlarge" "2xlarge"
hasura object
2 nested properties
replicas integer
max=5exclusiveMin=0
profile string
Values: "small" "medium" "large"
neon object
2 nested properties
autoscaling_limit_min_cu string
Default: "0.25"
Values: "0.25" "0.5" "1" "2" "3" "4" "8"
autoscaling_limit_max_cu string
Default: "0.25"
Values: "0.25" "0.5" "1" "2" "3" "4" "8"
rpc object

[DEPRECATED] Please use billing settings in Cloud UI

2 nested properties
monthly-cap string
pattern=\d+[km]
max-rate string
pattern=\d+rp[sm]
processor object
Default:
{
  "profile": "small"
}
1 nested properties
profile string
Values: "small" "medium" "large"
api object
2 nested properties
replicas integer
max=5exclusiveMin=0
profile string
Values: "small" "medium" "large"
manifestVersion const: "subsquid.io/v0.1"

[DEPRECATED] Please use "manifest_version" instead.

Constant: "subsquid.io/v0.1"

One of

1. variant
2. variant
3. variant
4. variant