/_/ /_/
Usage
dipdup [OPTIONS] COMMAND [ARGS]...
dipdup config [OPTIONS] COMMAND [ARGS]...
dipdup config env [OPTIONS]
dipdup config export [OPTIONS]
dipdup hasura [OPTIONS] COMMAND [ARGS]...
dipdup hasura configure [OPTIONS]
dipdup init [OPTIONS] PATH
dipdup mcp [OPTIONS] COMMAND [ARGS]...
dipdup mcp run [OPTIONS]
dipdup migrate [OPTIONS]
dipdup new [OPTIONS]
dipdup package [OPTIONS] COMMAND [ARGS]...
dipdup package tree [OPTIONS]
dipdup package verify [OPTIONS]
dipdup report [OPTIONS] COMMAND [ARGS]...
dipdup report ls [OPTIONS]
dipdup report rm [OPTIONS] [ID]
dipdup report show [OPTIONS] ID
dipdup run [OPTIONS]
dipdup schema [OPTIONS] COMMAND [ARGS]...
dipdup schema approve [OPTIONS]
dipdup schema export [OPTIONS]
dipdup schema init [OPTIONS]
dipdup schema wipe [OPTIONS]
dipdup self [OPTIONS] COMMAND [ARGS]...
dipdup self install [OPTIONS]
dipdup self uninstall [OPTIONS]
dipdup self update [OPTIONS]
DipDup project configuration file
This section allows users to tune some system-wide options, either experimental or unsuitable for generic configurations.
Management API config
Coinbase datasource config
EVM contract config
EVM node datasource config
Etherscan datasource config
Subsquid event handler
Subsquid datasource config
Subsquid datasource config
Subsquid transaction handler
Index that uses Subsquid Network as a datasource for transactions
Base class for index handlers
Config for the Hasura integration.
Hook config
Advanced configuration of HTTP client
Generic HTTP datasource config
Index template config
IPFS datasource config
Job schedule config
Postgres database connection config
Config for Prometheus integration.
Advanced configuration of HTTP client
Runtime config
Config for Sentry integration.
SQLite connection config
Hook config
Tezos contract config.
TzKT index config
Big map handler config
Big map index config
Event handler config
Event index config
Unknown event handler config
Head block handler config
Head block index config
Operation handler config
Origination handler pattern config
Operation handler pattern config
Operation handler pattern config
Transaction handler pattern config
Operation index config
Base class for pattern config items.
Contains methods for import and method signature generation during handler callbacks codegen.
Handler of unfiltered operation index
Operation index config
TzKT datasource config
Token balance handler config
Token balance index config
Token transfer handler config
Token transfer index config
Starknet contract config
Subsquid event handler
Starknet events index config
Starknet node datasource config
Subsquid datasource config
Substrate runtime config
Subsquid event handler
Subsquid datasource config
Subsquid datasource config
Subscan datasource config
DipDup Metadata datasource config
Sourcify datasource config
Whether to skip indexing big map history and use only current state
Substrate node datasource config
Config for MCP server
Action that should be performed on reindexing
Config for the watchdog
Blockvision datasource config
Reason that caused reindexing
Common execution context for handler and hook callbacks.
Execution context of handler callbacks.
Execution context of hook callbacks.
Execution context of MCP tools, resources and prompts.
Adds contract to the inventory.
Adds a new index from template.
Executes SQL script(s) with given name.
If the name path is a directory, all .sql scripts within it will be executed in alphabetical order.
Executes SQL query with given name included with the project
Fire hook with given name and arguments.
Drops the entire database and starts the indexing process from scratch.
Restart process and continue indexing.
Rollback index to a given level reverting all changes made since that level.
Inserts or updates corresponding rows in the internal dipdup_contract_metadata table to provide a generic metadata interface (see docs).
Inserts or updates corresponding rows in the internal dipdup_token_metadata table to provide a generic metadata interface (see docs).
kwargs (Any)
@@ -26,7 +26,7 @@ description: "Models reference" ## dipdup.models.Model -class dipdup.models.Model(**kwargs) +class dipdup.models.Model(**kwargs)Base class for DipDup project models
kwargs (Any)
@@ -56,7 +56,7 @@ description: "Models reference" ## dipdup.models.Head -class dipdup.models.Head(**kwargs) +class dipdup.models.Head(**kwargs)kwargs (Any)
@@ -68,7 +68,7 @@ description: "Models reference" ## dipdup.models.TokenMetadata -class dipdup.models.TokenMetadata(**kwargs) +class dipdup.models.TokenMetadata(**kwargs)kwargs (Any)
@@ -80,7 +80,7 @@ description: "Models reference" ## dipdup.models.Contract -class dipdup.models.Contract(**kwargs) +class dipdup.models.Contract(**kwargs)kwargs (Any)
@@ -92,7 +92,7 @@ description: "Models reference" ## dipdup.models.ContractKind -class dipdup.models.ContractKind(*values) +class dipdup.models.ContractKind(*values)Mapping for contract kind in
kwargs (Any)
@@ -112,14 +112,14 @@ description: "Models reference" ## dipdup.models.IndexStatus -class dipdup.models.IndexStatus(*values) +class dipdup.models.IndexStatus(*values)Kind of the index
kwargs (Any)
@@ -139,7 +139,7 @@ description: "Models reference" ## dipdup.models.Meta -class dipdup.models.Meta(**kwargs) +class dipdup.models.Meta(**kwargs)kwargs (Any)
@@ -151,7 +151,7 @@ description: "Models reference" ## dipdup.models.ModelUpdate -class dipdup.models.ModelUpdate(**kwargs) +class dipdup.models.ModelUpdate(**kwargs)Model update created within versioned transactions
Mapping for actions in model update
Mapping for action in TzKT response
Basic structure for big map diffs from TzKT response
Wrapper for matched big map diff with typed data passed to the handler
Updated structure for blocks received from TzKT REST API (1.16, Seoulnet)
Basic structure for events received from TzKT REST API
Head block received from TzKT SignalR API (1.16, Seoulnet)
Basic structure for operations from TzKT response
Type of blockchain operation
Wrapper for matched origination with typed data passed to the handler
Basic structure for quotes received from TzKT REST API
Wrapper for matched smart rollup cement to the handler