DipDup (SchemaStore) JSON Schema

Type	object
File match	`/dipdup.yaml` `/dipdup.yml` `*/dipdup..yaml` `*/dipdup..yml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/dipdup/latest.json
Source	https://raw.githubusercontent.com/dipdup-io/dipdup/next/schemas/dipdup-3.0.json

Versions

2.0 3.0

Validate with Lintel

npx @lintel/lintel check

Type: object

DipDup project configuration file

Properties

advanced object

This section allows users to tune some system-wide options, either experimental or unsuitable for generic configurations.

9 nested properties

alt_operation_matcher boolean

Use different algorithm to match Tezos operations (dev only)

Default: false

decimal_precision integer | null

Overwrite precision if it's not guessed correctly based on project models.

Default: null

early_realtime boolean

Establish realtime connection and start collecting messages while sync is in progress (faster, but consumes more RAM).

Default: false

postpone_jobs boolean

Do not start job scheduler until all indexes reach the realtime state.

Default: false

reindex Record<string, string>

Mapping of reindexing reasons and actions DipDup performs.

rollback_depth integer | null

A number of blocks to keep for rollback (affects all datasources)

Default: null

scheduler object | null

apscheduler scheduler config.

Default: null

unsafe_sqlite boolean

Disable journaling and data integrity checks. Use only for testing.

Default: false

watchdog Record<string, object>

Mapping of watchdog triggers and actions DipDup performs.

api ApiConfig | null

Management API config

Default: null

contracts Record<string, EvmContractConfig | TezosContractConfig | StarknetContractConfig>

Mapping of contract aliases and contract configs

custom object

User-defined configuration to use in callbacks

database SqliteDatabaseConfig | PostgresDatabaseConfig

Database config

Mapping of datasource aliases and datasource configs

hasura HasuraConfig | null

Hasura integration config

Default: null

hooks Record<string, object>

Mapping of hook aliases and hook configs

Mapping of index aliases and index configs

jobs Record<string, object>

Mapping of job aliases and job configs

logging object | string | integer

Modify logging verbosity

Default: "INFO"

mcp McpConfig | null

MCP server config

Default: null

package string

Name of indexer's Python package, existing or not

prometheus PrometheusConfig | null

Prometheus integration config

Default: null

runtimes Record<string, object>

Mapping of runtime aliases and runtime configs

sentry SentryConfig | null

Sentry integration config

Default: null

spec_version string | number

Mapping of template aliases and index templates

Definitions

AdvancedConfig object

This section allows users to tune some system-wide options, either experimental or unsuitable for generic configurations.

alt_operation_matcher boolean

Use different algorithm to match Tezos operations (dev only)

Default: false

decimal_precision integer | null

Overwrite precision if it's not guessed correctly based on project models.

Default: null

early_realtime boolean

Establish realtime connection and start collecting messages while sync is in progress (faster, but consumes more RAM).

Default: false

postpone_jobs boolean

Do not start job scheduler until all indexes reach the realtime state.

Default: false

reindex Record<string, string>

Mapping of reindexing reasons and actions DipDup performs.

rollback_depth integer | null

A number of blocks to keep for rollback (affects all datasources)

Default: null

scheduler object | null

apscheduler scheduler config.

Default: null

unsafe_sqlite boolean

Disable journaling and data integrity checks. Use only for testing.

Default: false

watchdog Record<string, object>

Mapping of watchdog triggers and actions DipDup performs.

ApiConfig object

Management API config

host string

Host to bind to

Default: "127.0.0.1"

port integer

Port to bind to

Default: 46339

CoinbaseDatasourceConfig object

Coinbase datasource config

api_key string | null

API key

Default: null

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'coinbase'

Default: "coinbase"

Constant: "coinbase"

passphrase string | null

API passphrase

Default: null

secret_key string | null

API secret key

Default: null

EvmAddress string

EvmBlockvisionDatasourceConfig object

Blockvision datasource config

url string required

api_key string | null

API key

Default: null

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'evm.blockvision'

Default: "evm.blockvision"

Constant: "evm.blockvision"

EvmContractConfig object

EVM contract config

abi integer | string | null

Contract ABI

Default: null

address integer | string | null

Contract address

Default: null

kind string

Always evm

Default: "evm"

Constant: "evm"

typename string | null

Alias for the contract script

Default: null

EvmDatasourceConfigU EvmSubsquidDatasourceConfig | EvmNodeDatasourceConfig | EvmSourcifyDatasourceConfig | EvmBlockvisionDatasourceConfig | EvmEtherscanDatasourceConfig

EvmEtherscanDatasourceConfig object

Etherscan datasource config

url string required

api_key string | null

API key

Default: null

http HttpConfig | null

HTTP client configuration

Default: null

kind string | string

always 'evm.etherscan'

Default: "evm.etherscan"

EvmEventsHandlerConfig object

Subsquid event handler

callback string required

Callback name

contract string | EvmContractConfig required

EVM contract

name string required

Event name

EvmEventsIndexConfig object

Subsquid datasource config

datasources string | EvmDatasourceConfigU[] required

evm datasources to use

handlers EvmEventsHandlerConfig[] required

Event handlers

first_level integer

Level to start indexing from

Default: 0

kind string

Always 'evm.events'

Default: "evm.events"

Constant: "evm.events"

last_level integer

Level to stop indexing and disable this index

Default: 0

EvmNodeDatasourceConfig object

EVM node datasource config

url string required

http HttpConfig | null

HTTP client configuration

Default: null

kind string

Always 'evm.node'

Default: "evm.node"

Constant: "evm.node"

rollback_depth integer

A number of blocks to store in database for rollback

Default: 32

ws_url WsUrl | null

EVM node WebSocket URL

Default: null

EvmSourcifyDatasourceConfig object

Sourcify datasource config

chain_id integer required

Chain ID

api_key string | null

API key

Default: null

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'evm.sourcify'

Default: "evm.sourcify"

Constant: "evm.sourcify"

url string

EvmSubsquidDatasourceConfig object

Subsquid datasource config

url string required

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'evm.subsquid'

Default: "evm.subsquid"

Constant: "evm.subsquid"

EvmTransactionsHandlerConfig object

Subsquid transaction handler

callback string required

Callback name

from string | EvmContractConfig | null

Transaction sender

Default: null

method string | null

Method name

Default: null

signature string | null

Method signature

Default: null

to string | EvmContractConfig | null

Transaction receiver

Default: null

EvmTransactionsIndexConfig object

Index that uses Subsquid Network as a datasource for transactions

datasources string | EvmDatasourceConfigU[] required

evm datasources to use

handlers EvmTransactionsHandlerConfig[] required

Transaction handlers

first_level integer

Level to start indexing from

Default: 0

kind string

always 'evm.transactions'

Default: "evm.transactions"

Constant: "evm.transactions"

last_level integer

Level to stop indexing at

Default: 0

HasuraConfig object

Config for the Hasura integration.

url string required

admin_secret string | null

Admin secret of the Hasura instance.

Default: null

allow_aggregations boolean

Whether to allow aggregations in unauthenticated queries.

Default: true

allow_inconsistent_metadata boolean

Whether to ignore errors when applying Hasura metadata.

Default: false

camel_case boolean

Whether to use camelCase instead of default pascal_case for the field names.

Default: true

create_source boolean

Whether source should be added to Hasura if missing.

Default: false

hide string[]

List of table/view names to make private.

hide_internal boolean

Whether to make internal tables (prefixed with "dipdup") private.

Default: false

http HttpConfig | null

HTTP connection tunables

Default: null

rest boolean

Enable REST API both for autogenerated and custom queries.

Default: true

select_limit integer

Row limit for unauthenticated queries.

Default: 10000

source string

Hasura source for DipDup to configure, others will be left untouched.

Default: "default"

Hex string

HookConfig object

Hook config

callback string required

Callback name

args Record<string, string>

Mapping of argument names and annotations (checked lazily when possible)

atomic boolean

Wrap hook in a single database transaction

Default: false

HttpConfig object

Advanced configuration of HTTP client

alias string | null

Alias for this HTTP client (dev only)

Default: null

batch_size integer | null

Number of items fetched in a single paginated request (when applicable)

Default: null

connection_limit integer | null

Number of simultaneous connections

Default: null

connection_timeout integer | null

Connection timeout in seconds

Default: null

polling_interval number | null

Interval between polling requests in seconds (when applicable)

Default: null

ratelimit_period integer | null

Time period for rate limiting in seconds

Default: null

ratelimit_rate integer | null

Number of requests per period ("drops" in leaky bucket)

Default: null

ratelimit_sleep number | null

Sleep time between requests when rate limit is reached

Default: null

replay boolean | null

Use cached HTTP responses instead of making real requests (dev only)

Default: null

replay_path string | string | null

Use cached HTTP responses instead of making real requests (dev only)

Default: null

request_timeout integer | null

Request timeout in seconds

Default: null

retry_count integer | null

Number of retries after request failed before giving up

Default: null

retry_multiplier number | null

Multiplier for sleep time between retries

Default: null

retry_sleep number | null

Sleep time between retries

Default: null

HttpDatasourceConfig object

Generic HTTP datasource config

url string required

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'http'

Default: "http"

Constant: "http"

IndexTemplateConfig object

Index template config

template string required

Template alias in templates section

values object required

Values to be substituted in template (<key> -> value)

first_level integer

Level to start indexing from

Default: 0

kind string

always 'template'

Default: "template"

Constant: "template"

last_level integer

Level to stop indexing at

Default: 0

IpfsDatasourceConfig object

IPFS datasource config

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'ipfs'

Default: "ipfs"

Constant: "ipfs"

url string

JobConfig object

Job schedule config

hook string | HookConfig required

Name of hook to run

args object

Arguments to pass to the hook

crontab string | null

Schedule with crontab syntax (* * * * *)

Default: null

daemon boolean

Run hook as a daemon (never stops)

Default: false

interval integer | null

Schedule with interval in seconds

Default: null

McpConfig object

Config for MCP server

api_url Url | null

URL of the management API

Default: null

compatibility boolean

Whether to expose resources as tools for clients that don't support MCP resources

Default: true

host string

Host to bind to

Default: "127.0.0.1"

port integer

Port to bind to

Default: 9999

PostgresDatabaseConfig object

Postgres database connection config

host string required

Host

connection_timeout integer

Connection timeout

Default: 60

database string

Database name

Default: "postgres"

immune_tables string[]

List of tables to preserve during reindexing

uniqueItems=true

kind string

always 'postgres'

Default: "postgres"

Constant: "postgres"

password string

Password

Default: ""

port integer

Port

Default: 5432

schema_name string

Schema name

Default: "public"

user string

User

Default: "postgres"

PrometheusConfig object

Config for Prometheus integration.

host string

Host to bind to

Default: "127.0.0.1"

port integer

Port to bind to

Default: 8000

update_interval number

Interval to update some metrics in seconds

Default: 1.0

ReindexingAction string

Action that should be performed on reindexing

:param exception: Raise ReindexingRequiredError exception. :param wipe: Wipe the database and reindex from scratch. (WARNING: This action is irreversible! All indexed data will be lost!) :param ignore: Ignore the reindexing cause and continue.

ReindexingReason string

Reason that caused reindexing

:param manual: Manual reindexing. :param migration: Migration of the database schema. :param rollback: Rollback that couldn't be handled automatically. :param config_modified: Index config was modified. :param schema_modified: Project models or database schema were modified.

SentryConfig object

Config for Sentry integration.

debug boolean

Catch warning messages, increase verbosity.

Default: false

dsn string | null

DSN of the Sentry instance

Default: null

environment string | null

Environment; if not set, guessed from docker/ci/gha/local.

Default: null

release string | null

Release version; defaults to DipDup package version.

Default: null

server_name string | null

Server name; defaults to obfuscated hostname.

Default: null

user_id string | null

User ID; defaults to obfuscated package/environment.

Default: null

SkipHistory string

Whether to skip indexing big map history and use only current state

:param never: Always index big map historical updates. :param once: Skip history once after reindexing; process updates as usual on the next resync. :param always: Always skip big map history.

SqliteDatabaseConfig object

SQLite connection config

immune_tables string[]

List of tables to preserve during reindexing

uniqueItems=true

kind string

always 'sqlite'

Default: "sqlite"

Constant: "sqlite"

path string

Path to .sqlite file, leave default for in-memory database (:memory:)

Default: ":memory:"

StarknetAddress string

StarknetContractConfig object

Starknet contract config

abi integer | string | null

Contract ABI

Default: null

address integer | string | null

Contract address

Default: null

kind string

Always starknet

Default: "starknet"

Constant: "starknet"

typename string | null

Alias for the contract script

Default: null

StarknetDatasourceConfigU StarknetSubsquidDatasourceConfig | StarknetNodeDatasourceConfig

StarknetEventsHandlerConfig object

Subsquid event handler

callback string required

Callback name

contract string | StarknetContractConfig required

Starknet contract

name string required

Event name

StarknetEventsIndexConfig object

Starknet events index config

datasources string | StarknetDatasourceConfigU[] required

Aliases of index datasources in datasources section

handlers StarknetEventsHandlerConfig[] required

Event handlers

first_level integer

Level to start indexing from

Default: 0

kind string

Always 'starknet.events'

Default: "starknet.events"

Constant: "starknet.events"

last_level integer

Level to stop indexing at

Default: 0

StarknetNodeDatasourceConfig object

Starknet node datasource config

url string required

fetch_block_headers boolean

Flag signalling that this datasource can be used for block headers fetching

Default: false

http HttpConfig | null

HTTP client configuration

Default: null

kind string

Always 'starknet.node'

Default: "starknet.node"

Constant: "starknet.node"

rollback_depth integer

A number of blocks to store in database for rollback

Default: 32

ws_url WsUrl | null

Starknet node WebSocket URL

Default: null

StarknetSubsquidDatasourceConfig object

Subsquid datasource config

url string required

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'starknet.subsquid'

Default: "starknet.subsquid"

Constant: "starknet.subsquid"

SubstrateDatasourceConfigU SubstrateSubsquidDatasourceConfig | SubstrateSubscanDatasourceConfig | SubstrateNodeDatasourceConfig

SubstrateEventsHandlerConfig object

Subsquid event handler

callback string required

Callback name

name string required

Event name (pallet.event)

SubstrateEventsIndexConfig object

Subsquid datasource config

datasources string | SubstrateDatasourceConfigU[] required

substrate datasources to use

handlers SubstrateEventsHandlerConfig[] required

Event handlers

runtime string | SubstrateRuntimeConfig required

Substrate runtime

first_level integer

Level to start indexing from

Default: 0

kind string

Always 'substrate.events'

Default: "substrate.events"

Constant: "substrate.events"

last_level integer

Level to stop indexing and disable this index

Default: 0

SubstrateNodeDatasourceConfig object

Substrate node datasource config

url string required

http HttpConfig | null

HTTP client configuration

Default: null

kind string

Always 'substrate.node'

Default: "substrate.node"

Constant: "substrate.node"

ws_url WsUrl | null

Substrate node WebSocket URL

Default: null

SubstrateRuntimeConfig object

Substrate runtime config

kind string

Always 'substrate'

Default: "substrate"

Constant: "substrate"

type_registry string | null

Path to type registry or its alias

Default: null

SubstrateSubscanDatasourceConfig object

Subscan datasource config

url string required

api_key string | null

API key

Default: null

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'substrate.subscan'

Default: "substrate.subscan"

Constant: "substrate.subscan"

SubstrateSubsquidDatasourceConfig object

Subsquid datasource config

url string required

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'substrate.subsquid'

Default: "substrate.subsquid"

Constant: "substrate.subsquid"

TezosAddress string

TezosBigMapsHandlerConfig object

Big map handler config

callback string required

Callback name

contract string | TezosContractConfig required

Contract to fetch big map from

path string required

Path to big map (alphanumeric string with dots)

TezosBigMapsIndexConfig object

Big map index config

datasources string | TezosTzktDatasourceConfig[] required

Tezos datasources to use

handlers TezosBigMapsHandlerConfig[] required

Mapping of big map diff handlers

first_level integer

Level to start indexing from

Default: 0

kind string

always 'tezos.big_maps'

Default: "tezos.big_maps"

Constant: "tezos.big_maps"

last_level integer

Level to stop indexing at

Default: 0

skip_history string

Whether to skip indexing big map history and use only current state

:param never: Always index big map historical updates. :param once: Skip history once after reindexing; process updates as usual on the next resync. :param always: Always skip big map history.

Values: "never" "once" "always"

TezosContractConfig object

Tezos contract config.

address TezosAddress | null

Contract address

Default: null

code_hash integer | TezosAddress | null

Contract code hash or address to fetch it from

Default: null

kind string

Always tezos

Default: "tezos"

Constant: "tezos"

typename string | null

Alias for the contract script

Default: null

TezosEventsHandlerConfig object

Event handler config

callback string required

Callback name

contract string | TezosContractConfig required

Contract which emits event

tag string required

Event tag

TezosEventsIndexConfig object

Event index config

datasources string | TezosTzktDatasourceConfig[] required

evm datasources to use

handlers TezosEventsHandlerConfig | TezosEventsUnknownEventHandlerConfig[] required

Event handlers

first_level integer

First block level to index

Default: 0

kind string

always 'tezos.events'

Default: "tezos.events"

Constant: "tezos.events"

last_level integer

Last block level to index

Default: 0

TezosEventsUnknownEventHandlerConfig object

Unknown event handler config

callback string required

Callback name

contract string | TezosContractConfig required

Contract which emits event

TezosHeadIndexConfig object

Head block index config

callback string required

Callback name

datasources string | TezosTzktDatasourceConfig[] required

tezos datasources to use

kind string

always 'tezos.head'

Default: "tezos.head"

Constant: "tezos.head"

TezosOperationType string

Type of blockchain operation

:param transaction: transaction :param origination: origination :param migration: migration :param sr_execute: sr_execute :param sr_cement: sr_cement

TezosOperationsHandlerConfig object

Operation handler config

callback string required

Callback name

pattern TezosOperationsHandlerTransactionPatternConfig | TezosOperationsHandlerOriginationPatternConfig | TezosOperationsHandlerSmartRollupCementPatternConfig | TezosOperationsHandlerSmartRollupExecutePatternConfig[] required

Filters to match operation groups

TezosOperationsHandlerOriginationPatternConfig object

Origination handler pattern config

alias string | null

Alias for operation (helps to avoid duplicates)

Default: null

optional boolean

Whether can operation be missing in operation group

Default: false

originated_contract string | TezosContractConfig | null

Match origination of exact contract

Default: null

source string | TezosContractConfig | null

Match operations by source contract alias

Default: null

strict boolean

Match operations by storage only or by the whole code

Default: false

type string

always 'origination'

Default: "origination"

Constant: "origination"

TezosOperationsHandlerSmartRollupCementPatternConfig object

Operation handler pattern config

alias string | null

Alias for operation (helps to avoid duplicates)

Default: null

destination string | TezosContractConfig | null

Match operations by destination contract alias

Default: null

optional boolean

Whether can operation be missing in operation group

Default: false

source string | TezosContractConfig | null

Match operations by source contract alias

Default: null

type string

always 'sr_cement'

Default: "sr_cement"

Constant: "sr_cement"

TezosOperationsHandlerSmartRollupExecutePatternConfig object

Operation handler pattern config

alias string | null

Alias for operation (helps to avoid duplicates)

Default: null

destination string | TezosContractConfig | null

Match operations by destination contract alias

Default: null

optional boolean

Whether can operation be missing in operation group

Default: false

source string | TezosContractConfig | null

Match operations by source contract alias

Default: null

type string

always 'sr_execute'

Default: "sr_execute"

Constant: "sr_execute"

TezosOperationsHandlerTransactionPatternConfig object

Transaction handler pattern config

alias string | null

Alias for operation (helps to avoid duplicates)

Default: null

destination string | TezosContractConfig | null

Match operations by destination contract alias

Default: null

entrypoint string | null

Match operations by contract entrypoint

Default: null

optional boolean

Whether can operation be missing in operation group

Default: false

source string | TezosContractConfig | null

Match operations by source contract alias

Default: null

type string

always 'transaction'

Default: "transaction"

Constant: "transaction"

TezosOperationsIndexConfig object

Operation index config

datasources string | TezosTzktDatasourceConfig[] required

tezos datasources to use

handlers TezosOperationsHandlerConfig[] required

List of indexer handlers

contracts string | TezosContractConfig[]

Aliases of contracts being indexed in contracts section

first_level integer

Level to start indexing from

Default: 0

kind string

always 'tezos.operations'

Default: "tezos.operations"

Constant: "tezos.operations"

last_level integer

Level to stop indexing at

Default: 0

types TezosOperationType[]

Types of transaction to fetch

Default:

[
  "transaction"
]

TezosOperationsUnfilteredIndexConfig object

Operation index config

callback string required

Callback name

datasources string | TezosTzktDatasourceConfig[] required

tezos datasources to use

first_level integer

Level to start indexing from

Default: 0

kind string

always 'tezos.operations_unfiltered'

Default: "tezos.operations_unfiltered"

Constant: "tezos.operations_unfiltered"

last_level integer

Level to stop indexing at

Default: 0

types TezosOperationType[]

Types of transaction to fetch

Default:

[
  "transaction"
]

TezosTokenBalancesHandlerConfig object

Token balance handler config

callback string required

Callback name

contract string | TezosContractConfig | null

Filter by contract

Default: null

token_id integer | null

Filter by token ID

Default: null

TezosTokenBalancesIndexConfig object

Token balance index config

datasources string | TezosTzktDatasourceConfig[] required

tezos datasources to use

handlers TezosTokenBalancesHandlerConfig[] required

Mapping of token transfer handlers

first_level integer

Level to start indexing from

Default: 0

kind string

always 'tezos.token_balances'

Default: "tezos.token_balances"

Constant: "tezos.token_balances"

last_level integer

Level to stop indexing at

Default: 0

TezosTokenTransfersHandlerConfig object

Token transfer handler config

callback string required

Callback name

contract string | TezosContractConfig | null

Filter by contract

Default: null

from string | TezosContractConfig | null

Filter by sender

Default: null

to string | TezosContractConfig | null

Filter by recipient

Default: null

token_id integer | null

Filter by token ID

Default: null

TezosTokenTransfersIndexConfig object

Token transfer index config

datasources string | TezosTzktDatasourceConfig[] required

tezos datasources to use

handlers TezosTokenTransfersHandlerConfig[] required

Mapping of token transfer handlers

first_level integer

Level to start indexing from

Default: 0

kind string

always 'tezos.token_transfers'

Default: "tezos.token_transfers"

Constant: "tezos.token_transfers"

last_level integer

Level to stop indexing at

Default: 0

TezosTzktDatasourceConfig object

TzKT datasource config

buffer_size integer

Number of levels to keep in FIFO buffer before processing

Default: 0

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'tezos.tzkt'

Default: "tezos.tzkt"

Constant: "tezos.tzkt"

merge_subscriptions boolean

Whether to merge realtime subscriptions

Default: false

rollback_depth integer

Number of blocks to keep in the database to handle reorgs

Default: 2

url string

ToStr string | number

TzipMetadataDatasourceConfig object

DipDup Metadata datasource config

network string required

Network name, e.g. mainnet, ghostnet, etc.

http HttpConfig | null

HTTP client configuration

Default: null

kind string

always 'tzip_metadata'

Default: "tzip_metadata"

Constant: "tzip_metadata"

url string

Url string

WatchdogAction string

WatchdogConfig object

Config for the watchdog

action WatchdogAction | null

Action to perform when watchdog timeout is reached

Default: null

timeout integer | null

Watchdog timeout in seconds

Default: null

WatchdogTrigger string

WsUrl string