Table of Contents

Models reference

Base classes

dipdup.models.CachedModel

class dipdup.models.CachedModel(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.Model

class dipdup.models.Model(**kwargs)

Base class for DipDup project models

Parameters:

kwargs (Any)

Internal models

dipdup.models.ContractMetadata

class dipdup.models.ContractMetadata(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.Head

class dipdup.models.Head(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.TokenMetadata

class dipdup.models.TokenMetadata(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.Contract

class dipdup.models.Contract(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.ContractKind

class dipdup.models.ContractKind(*values)

Mapping for contract kind in

dipdup.models.Index

class dipdup.models.Index(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.IndexStatus

class dipdup.models.IndexStatus(*values)

dipdup.models.IndexType

class dipdup.models.IndexType(*values)

Kind of the index

dipdup.models.Schema

class dipdup.models.Schema(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.Meta

class dipdup.models.Meta(**kwargs)

Parameters:

kwargs (Any)

dipdup.models.ModelUpdate

class dipdup.models.ModelUpdate(**kwargs)

Model update created within versioned transactions

Parameters:

kwargs (Any)

dipdup.models.ModelUpdateAction

class dipdup.models.ModelUpdateAction(*values)

Mapping for actions in model update

Datasource models

EVM

dipdup.models.evm.EvmTransaction

class dipdup.models.evm.EvmTransaction(data: dipdup.models.evm.EvmTransactionData, input: InputT)

Parameters:

dipdup.models.evm.EvmTransactionData

class dipdup.models.evm.EvmTransactionData(access_list: tupledictstr, dipdup.fields.Any, ... | None, block_hash: str, chain_id: int | None, contract_address: str | None, cumulative_gas_used: int | None, effective_gas_price: int | None, from_: str, gas: int, gas_price: int | None, gas_used: int | None, hash: str, input: str, level: int, max_fee_per_gas: int | None, max_priority_fee_per_gas: int | None, nonce: int, r: str | None, s: str | None, status: int | None, timestamp: int, to: str | None, transaction_index: int | None, type: int | None, value: int | None, v: int | None, y_parity: bool | None)

Parameters:
  • access_list (tuple[dict[str, Any], ...] | None)
  • block_hash (str)
  • chain_id (int | None)
  • contract_address (str | None)
  • cumulative_gas_used (int | None)
  • effective_gas_price (int | None)
  • from_ (str)
  • gas (int)
  • gas_price (int | None)
  • gas_used (int | None)
  • hash (str)
  • input (str)
  • level (int)
  • max_fee_per_gas (int | None)
  • max_priority_fee_per_gas (int | None)
  • nonce (int)
  • r (str | None)
  • s (str | None)
  • status (int | None)
  • timestamp (int)
  • to (str | None)
  • transaction_index (int | None)
  • type (int | None)
  • value (int | None)
  • v (int | None)
  • y_parity (bool | None)

dipdup.models.evm.EvmEvent

class dipdup.models.evm.EvmEvent(data: dipdup.models.evm.EvmEventData, payload: PayloadT)

Parameters:

dipdup.models.evm.EvmEventData

class dipdup.models.evm.EvmEventData(address: str, block_hash: str, data: str, level: int, log_index: int, removed: bool, timestamp: int, topics: tuplestr, ..., transaction_hash: str, transaction_index: int)

Parameters:
  • address (str)
  • block_hash (str)
  • data (str)
  • level (int)
  • log_index (int)
  • removed (bool)
  • timestamp (int)
  • topics (tuple[str, ...])
  • transaction_hash (str)
  • transaction_index (int)

dipdup.models.evm_node.EvmNodeHeadData

class dipdup.models.evm_node.EvmNodeHeadData(base_fee_per_gas, difficulty, extra_data, gas_limit, gas_used, hash, level, logs_bloom, miner, mix_hash, nonce, number, parent_hash, receipts_root, sha3_uncles, state_root, timestamp, transactions_root, withdrawals_root)

Parameters:
  • base_fee_per_gas (int)
  • difficulty (int)
  • extra_data (str)
  • gas_limit (int)
  • gas_used (int)
  • hash (str)
  • level (int)
  • logs_bloom (str)
  • miner (str)
  • mix_hash (str)
  • nonce (str)
  • number (int)
  • parent_hash (str)
  • receipts_root (str)
  • sha3_uncles (str)
  • state_root (str)
  • timestamp (int)
  • transactions_root (str)
  • withdrawals_root (str | None)

dipdup.models.evm_node.EvmNodeSyncingData

class dipdup.models.evm_node.EvmNodeSyncingData(current_block, highest_block, starting_block)

Parameters:
  • current_block (int)
  • highest_block (int)
  • starting_block (int)

Starknet

dipdup.models.starknet.StarknetEvent

class dipdup.models.starknet.StarknetEvent(data: dipdup.models.starknet.StarknetEventData, payload: PayloadT)

Parameters:

dipdup.models.starknet.StarknetEventData

class dipdup.models.starknet.StarknetEventData(level: int, block_hash: str, transaction_index: int | None, transaction_hash: str, timestamp: int | None, from_address: str, keys: tuplestr, ..., data: tuplestr, ...)

Parameters:
  • level (int)
  • block_hash (str)
  • transaction_index (int | None)
  • transaction_hash (str)
  • timestamp (int | None)
  • from_address (str)
  • keys (tuple[str, ...])
  • data (tuple[str, ...])

dipdup.models.starknet.StarknetTransactionData

class dipdup.models.starknet.StarknetTransactionData(level: int, block_hash: str, transaction_index: int, transaction_hash: str, timestamp: int, contract_address: str | None, entry_point_selector: str | None, calldata: tuplestr, ... | None, max_fee: str | None, version: str, signature: tuplestr, ... | None, nonce: str | None, type: str, sender_address: str | None, class_hash: str | None, compiled_class_hash: str | None, contract_address_salt: str | None, constructor_calldata: tuplestr, ... | None)

Parameters:
  • level (int)
  • block_hash (str)
  • transaction_index (int)
  • transaction_hash (str)
  • timestamp (int)
  • contract_address (str | None)
  • entry_point_selector (str | None)
  • calldata (tuple[str, ...] | None)
  • max_fee (str | None)
  • version (str)
  • signature (tuple[str, ...] | None)
  • nonce (str | None)
  • type (str)
  • sender_address (str | None)
  • class_hash (str | None)
  • compiled_class_hash (str | None)
  • contract_address_salt (str | None)
  • constructor_calldata (tuple[str, ...] | None)

Substrate

dipdup.models.substrate.SubstrateEvent

class dipdup.models.substrate.SubstrateEvent(data: dipdup.models.substrate.SubstrateEventData, runtime: dipdup.abi.substrate.SubstrateRuntime)

Parameters:

dipdup.models.substrate.SubstrateEventData

class dipdup.models.substrate.SubstrateEventData(*, name: str, index: int, extrinsic_index: int, call_address: liststr | None, args: listdipdup.fields.Any | None = None, decoded_args: dictstr, dipdup.fields.Any | listdipdup.fields.Any | None = None, header: dipdup.models.substrate._BlockHeader, header_extra: dipdup.models.substrate._BlockHeaderExtra | None)

Parameters:
  • name (str)
  • index (int)
  • extrinsic_index (int)
  • call_address (list[str] | None)
  • args (list[Any] | None)
  • decoded_args (dict[str, Any] | list[Any] | None)
  • header (_BlockHeader)
  • header_extra (_BlockHeaderExtra | None)

dipdup.models.substrate.SubstrateHeadBlockData

class dipdup.models.substrate.SubstrateHeadBlockData

Tezos

dipdup.models.tezos.TezosBigMapAction

class dipdup.models.tezos.TezosBigMapAction(*values)

Mapping for action in TzKT response

dipdup.models.tezos.TezosBigMapData

class dipdup.models.tezos.TezosBigMapData(*, id, level, operation_id, timestamp, bigmap, contract_address, path, action, active, key, value)

Basic structure for big map diffs from TzKT response

Parameters:
  • id (int)
  • level (int)
  • operation_id (int)
  • timestamp (datetime)
  • bigmap (int)
  • contract_address (str)
  • path (str)
  • action (TezosBigMapAction)
  • active (bool)
  • key (Any | None)
  • value (Any | None)

dipdup.models.tezos.TezosBigMapDiff

class dipdup.models.tezos.TezosBigMapDiff(*, action, data, key, value)

Wrapper for matched big map diff with typed data passed to the handler

Parameters:

dipdup.models.tezos.TezosBlockData

class dipdup.models.tezos.TezosBlockData(*, level, hash, timestamp, proto, payload_round, block_round, validations, deposit, reward_delegated, reward_staked_own, reward_staked_edge, reward_staked_shared, bonus_delegated, bonus_staked_own, bonus_staked_edge, bonus_staked_shared, reward, bonus, fees, nonce_revealed, proposer_address, proposer_alias, producer_address, producer_alias, software_version, software_date, lb_toggle, lb_toggle_ema, ai_toggle_ema, priority, baker_address, baker_alias)

Updated structure for blocks received from TzKT REST API (1.16, Seoulnet)

Parameters:
  • level (int)
  • hash (str)
  • timestamp (datetime)
  • proto (int)
  • payload_round (int | None)
  • block_round (int | None)
  • validations (int)
  • deposit (int)
  • reward_delegated (int | None)
  • reward_staked_own (int | None)
  • reward_staked_edge (int | None)
  • reward_staked_shared (int | None)
  • bonus_delegated (int | None)
  • bonus_staked_own (int | None)
  • bonus_staked_edge (int | None)
  • bonus_staked_shared (int | None)
  • reward (int | None)
  • bonus (int | None)
  • fees (int)
  • nonce_revealed (bool)
  • proposer_address (str | None)
  • proposer_alias (str | None)
  • producer_address (str | None)
  • producer_alias (str | None)
  • software_version (str | None)
  • software_date (str | None)
  • lb_toggle (bool | None)
  • lb_toggle_ema (int | None)
  • ai_toggle_ema (int | None)
  • priority (int | None)
  • baker_address (str | None)
  • baker_alias (str | None)

dipdup.models.tezos.TezosEvent

class dipdup.models.tezos.TezosEvent(*, data, payload)

Parameters:

dipdup.models.tezos.TezosEventData

class dipdup.models.tezos.TezosEventData(*, id, level, timestamp, tag, payload, contract_address, contract_alias, contract_code_hash, transaction_id)

Basic structure for events received from TzKT REST API

Parameters:
  • id (int)
  • level (int)
  • timestamp (datetime)
  • tag (str)
  • payload (Any | None)
  • contract_address (str)
  • contract_alias (str | None)
  • contract_code_hash (int | None)
  • transaction_id (int | None)

dipdup.models.tezos.TezosHeadBlockData

class dipdup.models.tezos.TezosHeadBlockData(*, chain, chain_id, cycle, level, hash, protocol, next_protocol, timestamp, voting_epoch, voting_period, known_level, last_sync, synced, quote_level, quote_btc, quote_eur, quote_usd, quote_cny, quote_jpy, quote_krw, quote_eth, quote_gbp)

Head block received from TzKT SignalR API (1.16, Seoulnet)

Parameters:
  • chain (str)
  • chain_id (str)
  • cycle (int)
  • level (int)
  • hash (str)
  • protocol (str)
  • next_protocol (str)
  • timestamp (datetime)
  • voting_epoch (int)
  • voting_period (int)
  • known_level (int)
  • last_sync (datetime)
  • synced (bool)
  • quote_level (int)
  • quote_btc (Decimal)
  • quote_eur (Decimal)
  • quote_usd (Decimal)
  • quote_cny (Decimal)
  • quote_jpy (Decimal)
  • quote_krw (Decimal)
  • quote_eth (Decimal)
  • quote_gbp (Decimal)

dipdup.models.tezos.TezosOperationData

class dipdup.models.tezos.TezosOperationData(*, type, id, level, timestamp, hash, counter, sender_address, target_address, initiator_address, amount, status, has_internals, storage, diffs=<factory>, block, sender_alias, nonce, target_alias, initiator_alias, entrypoint, parameter_json, originated_contract_address, originated_contract_alias, originated_contract_type_hash, originated_contract_code_hash, originated_contract_tzips, delegate_address, delegate_alias, target_code_hash, sender_code_hash, commitment_json=<factory>)

Basic structure for operations from TzKT response

Parameters:
  • type (str)
  • id (int)
  • level (int)
  • timestamp (datetime)
  • hash (str)
  • counter (int)
  • sender_address (str | None)
  • target_address (str | None)
  • initiator_address (str | None)
  • amount (int | None)
  • status (str)
  • has_internals (bool | None)
  • storage (Any)
  • diffs (tuple[dict[str, Any], ...])
  • block (str | None)
  • sender_alias (str | None)
  • nonce (int | None)
  • target_alias (str | None)
  • initiator_alias (str | None)
  • entrypoint (str | None)
  • parameter_json (Any | None)
  • originated_contract_address (str | None)
  • originated_contract_alias (str | None)
  • originated_contract_type_hash (int | None)
  • originated_contract_code_hash (int | None)
  • originated_contract_tzips (tuple[str, ...] | None)
  • delegate_address (str | None)
  • delegate_alias (str | None)
  • target_code_hash (int | None)
  • sender_code_hash (int | None)
  • commitment_json (dict[str, Any])

dipdup.models.tezos.TezosOperationType

class dipdup.models.tezos.TezosOperationType(*values)

Type of blockchain operation

Parameters:
  • transaction – transaction
  • origination – origination
  • migration – migration
  • sr_execute – sr_execute
  • sr_cement – sr_cement

dipdup.models.tezos.TezosOrigination

class dipdup.models.tezos.TezosOrigination(*, data, storage)

Wrapper for matched origination with typed data passed to the handler

Parameters:

dipdup.models.tezos.TezosQuoteData

class dipdup.models.tezos.TezosQuoteData(*, level, timestamp, btc, eur, usd, cny, jpy, krw, eth, gbp)

Basic structure for quotes received from TzKT REST API

Parameters:
  • level (int)
  • timestamp (datetime)
  • btc (Decimal)
  • eur (Decimal)
  • usd (Decimal)
  • cny (Decimal)
  • jpy (Decimal)
  • krw (Decimal)
  • eth (Decimal)
  • gbp (Decimal)

dipdup.models.tezos.TezosSmartRollupCement

class dipdup.models.tezos.TezosSmartRollupCement(*, data, commitment)

Wrapper for matched smart rollup cement to the handler

Parameters:

dipdup.models.tezos.TezosSmartRollupCommitment

class dipdup.models.tezos.TezosSmartRollupCommitment(*, id, initiator_address, initiator_alias, inbox_level, state, hash, ticks, first_level, first_time)

Parameters:
  • id (int)
  • initiator_address (str)
  • initiator_alias (str | None)
  • inbox_level (int)
  • state (str)
  • hash (str | None)
  • ticks (int)
  • first_level (int)
  • first_time (datetime)

dipdup.models.tezos.TezosSmartRollupExecute

class dipdup.models.tezos.TezosSmartRollupExecute(*, data, commitment)

Wrapper for matched smart rollup execute to the handler

Parameters:

dipdup.models.tezos.TezosTokenBalanceData

class dipdup.models.tezos.TezosTokenBalanceData(*, id, transfers_count, first_level, first_time, last_level, last_time, account_address, account_alias, tzkt_token_id, contract_address, contract_alias, token_id, standard, metadata, balance, balance_value)

Basic structure for token transver received from TzKT SignalR API

Parameters:
  • id (int)
  • transfers_count (int)
  • first_level (int)
  • first_time (datetime)
  • last_level (int)
  • last_time (datetime)
  • account_address (str | None)
  • account_alias (str | None)
  • tzkt_token_id (int | None)
  • contract_address (str | None)
  • contract_alias (str | None)
  • token_id (int | None)
  • standard (TezosTokenStandard | None)
  • metadata (dict[str, Any] | None)
  • balance (str | None)
  • balance_value (float | None)

dipdup.models.tezos.TezosTokenStandard

class dipdup.models.tezos.TezosTokenStandard(*values)

dipdup.models.tezos.TezosTokenTransferData

class dipdup.models.tezos.TezosTokenTransferData(*, id, level, timestamp, tzkt_token_id, contract_address, contract_alias, token_id, standard, metadata, from_alias, from_address, to_alias, to_address, amount, tzkt_transaction_id, tzkt_origination_id, tzkt_migration_id)

Basic structure for token transver received from TzKT SignalR API

Parameters:
  • id (int)
  • level (int)
  • timestamp (datetime)
  • tzkt_token_id (int)
  • contract_address (str | None)
  • contract_alias (str | None)
  • token_id (int | None)
  • standard (TezosTokenStandard | None)
  • metadata (dict[str, Any] | None)
  • from_alias (str | None)
  • from_address (str | None)
  • to_alias (str | None)
  • to_address (str | None)
  • amount (int | None)
  • tzkt_transaction_id (int | None)
  • tzkt_origination_id (int | None)
  • tzkt_migration_id (int | None)

dipdup.models.tezos.TezosTransaction

class dipdup.models.tezos.TezosTransaction(*, data, parameter, storage)

Wrapper for matched transaction with typed data passed to the handler

Parameters:

dipdup.models.tezos.TezosUnknownEvent

class dipdup.models.tezos.TezosUnknownEvent(*, data, payload)

Parameters:

Other

dipdup.models.coinbase.CoinbaseCandleData

class dipdup.models.coinbase.CoinbaseCandleData(timestamp, low, high, open, close, volume)

Parameters:
  • timestamp (datetime)
  • low (Decimal)
  • high (Decimal)
  • open (Decimal)
  • close (Decimal)
  • volume (Decimal)

dipdup.models.coinbase.CoinbaseCandleInterval

class dipdup.models.coinbase.CoinbaseCandleInterval(*values)

Help and tips -> Join our Discord
Ideas or suggestions -> Issue Tracker
GraphQL IDE -> Open Playground
Table of Contents