v1.13.0

General notes

• added Oxford support;
• switched to Postgresql 16;
• minor improvements.

To update from v1.12.* to v1.13.0 you should drop the indexer database and restore it from the latest snapshot (in case of non-docker setup you may also need to update your Postgresql, see explanation below), or reindex from scratch. This is due to breaking changes in the consensus, that complicate DB migration.

Postgresql 16

We've switched to PostgreSQL 16 with raised performance, improvements to query parallelism, bulk data loading, and logical replication.

In fact, you don't necessarily have to update your Postgresql, because TzKT can work with older versions, however the DB snapshots we provide are created with pg_dump v16, which is not compatible with pg_restore v15 and older, so if you want to restore your DB from our snapshots, then you will have to use Postgresql of the appropriate version.

Changes in the API endpoints

• [BREAKING] /rewards/delegators/{address}/{cycle} was deprecated, because since Oxford a single account can have multiple delegations at the same time, that can lead to multiple delegator reward entities for a single cycle, so use /rewards/delegators/{address}?cycle={cycle} instead;
• [BREAKING] /rewards/bakers/{address}/{cycle} was deprecated, use /rewards/bakers/{address}?cycle={cycle} instead;
• /operations/staking was added;
• /operations/staking/count was added;
• /operations/autostaking was added;
• /operations/autostaking/count was added;
• /accounts/{address}/operations now also returns operations of new types: staking and autostaking.

Changes in the API models

Delegates:

• fields stakedPseudotokens, unstakedBaker, totalStakedBalance, issuedPseudotokens, stakersCount, limitOfStakingOverBaking, edgeOfBakingOverStaking, stakingOpsCount, autostakingOpsCount, and lostBalance were added;
• [BREAKING] field frozenDeposit was deprecated and replaced with stakedBalance, unstakedBalance, externalStakedBalance, and externalUnstakedBalance.

Users:

• fields stakedBalance, stakedPseudotokens, unstakedBalance, unstakedBaker, stakingOpsCount, and lostBalance were added.

Baker rewards:

• field stakersCount was added;
• [BREAKING] field stakingBalance was deprecated and replaced with ownDelegatedBalance, ownStakedBalance, externalDelegatedBalance, and externalStakedBalance;
• [BREAKING] field delegatedBalance was deprecated and replaced with ownDelegatedBalance and externalDelegatedBalance;
• [BREAKING] field activeStake was deprecated and replaced with bakingPower;
• [BREAKING] field selectedStake was deprecated and replaced with totalBakingPower;
• [BREAKING] field numDelegators was deprecated and replaced with delegatorsCount;
• [BREAKING] field blockRewards was deprecated and replaced with blockRewardsLiquid, blockRewardsStakedOwn, and blockRewardsStakedShared;
• [BREAKING] field endorsementRewards was deprecated and replaced with endorsementRewardsLiquid, endorsementRewardsStakedOwn, and endorsementRewardsStakedShared;
• [BREAKING] field doubleBakingLosses was deprecated and replaced with doubleBakingLostStaked, doubleBakingLostUnstaked, doubleBakingLostExternalStaked, and doubleBakingLostExternalUnstaked;
• [BREAKING] field doubleEndorsingLosses was deprecated and replaced with doubleEndorsingLostStaked, doubleEndorsingLostUnstaked, doubleEndorsingLostExternalStaked, and doubleEndorsingLostExternalUnstaked;
• [BREAKING] field doublePreendorsingLosses was deprecated and replaced with doublePreendorsingLostStaked, doublePreendorsingLostUnstaked, doublePreendorsingLostExternalStaked, and doublePreendorsingLostExternalUnstaked;
• [BREAKING] field revelationRewards was deprecated and replaced with vdfRevelationRewardsLiquid, vdfRevelationRewardsStakedOwn, vdfRevelationRewardsStakedShared, nonceRevelationRewardsLiquid, nonceRevelationRewardsStakedOwn, and nonceRevelationRewardsStakedShared;
• [BREAKING] field revelationLosses was deprecated and replaced with nonceRevelationLosses.

Rewards split:

• same changes as for baker rewards, described above.

Rewards split delegator:

• [BREAKING] field balance was deprecated and replaced with delegatedBalance and stakedBalance;
• [BREAKING] field currentBalance was deprecated and replaced with currentDelegatedBalance and currentStakedBalance.

Delegator rewards:

• [BREAKING] field balance was deprecated and replaced with delegatedBalance and stakedBalance;
• [BREAKING] field stakingBalance was deprecated and replaced with bakerDelegatedBalance, bakerStakedBalance, externalDelegatedBalance, and externalStakedBalance;
• [BREAKING] field activeStake was deprecated and replaced with bakingPower;
• [BREAKING] field selectedStake was deprecated and replaced with totalBakingPower;
• [BREAKING] field blockRewards was deprecated and replaced with blockRewardsLiquid, blockRewardsStakedOwn, and blockRewardsStakedShared;
• [BREAKING] field endorsementRewards was deprecated and replaced with endorsementRewardsLiquid, endorsementRewardsStakedOwn, and endorsementRewardsStakedShared;
• [BREAKING] field doubleBakingLosses was deprecated and replaced with doubleBakingLostStaked, doubleBakingLostUnstaked, doubleBakingLostExternalStaked, and doubleBakingLostExternalUnstaked;
• [BREAKING] field doubleEndorsingLosses was deprecated and replaced with doubleEndorsingLostStaked, doubleEndorsingLostUnstaked, doubleEndorsingLostExternalStaked, and doubleEndorsingLostExternalUnstaked;
• [BREAKING] field doublePreendorsingLosses was deprecated and replaced with doublePreendorsingLostStaked, doublePreendorsingLostUnstaked, doublePreendorsingLostExternalStaked, and doublePreendorsingLostExternalUnstaked;
• [BREAKING] field revelationRewards was deprecated and replaced with vdfRevelationRewardsLiquid, vdfRevelationRewardsStakedOwn, vdfRevelationRewardsStakedShared, nonceRevelationRewardsLiquid, nonceRevelationRewardsStakedOwn, and nonceRevelationRewardsStakedShared;
• [BREAKING] field revelationLosses was deprecated and replaced with nonceRevelationLosses.

Cycles:

• fields blockReward, blockBonusPerSlot, endorsementRewardPerSlot, nonceRevelationReward, vdfRevelationReward, and lbSubsidy were added;
• [BREAKING] field totalStaking was deprecated;
• [BREAKING] field selectedStake was deprecated and replaced with totalBakingPower;
• [BREAKING] field selectedBakers was deprecated and replaced with totalBakers;
• [BREAKING] field totalDelegated was deprecated;
• [BREAKING] field totalDelegators was deprecated.

Blocks:

• fields aiToggle, aiToggleEma, stakingOps, and autostakingOps were added.

Blocks and baking operations:

• [BREAKING] field reward was deprecated and replaced with rewardLiquid, rewardStakedOwn, and rewardStakedShared;
• [BREAKING] field bonus was deprecated and replaced with bonusLiquid, bonusStakedOwn, and bonusStakedShared.

Delegation operations:

• fields unstakedPseudotokens, unstakedBalance, and unstakedRewards were added.

Double baking/endorsing/preendorsing operations:

• field slashedLevel was added;
• [BREAKING] field accuserReward was renamed to reward;
• [BREAKING] field offenderLoss was deprecated and replaced with lostStaked, lostUnstaked, lostExternalStaked, lostExternalUnstaked, and roundingLoss.

Endorsing reward operations:

• [BREAKING] field received was deprecated and replaced with rewardLiquid, rewardStakedOwn, and rewardStakedShared.

Migration operations:

• field kind was extended with the new possible value remove_bigmap_key.

Nonce/vdf revelation operations:

• [BREAKING] field reward was deprecated and replaced with rewardLiquid, rewardStakedOwn, and rewardStakedShared.

Smart rollup originate operations:

• [BREAKING] field originationProof was removed.

Protocol constants:

• fields minimalFrozenStake, maxDelegatedOverFrozenRatio, and maxExternalOverOwnStakeRatio were added;
• [BREAKING] field tokensPerRoll was deprecated and replaced with minimalStake;
• [BREAKING] field revelationReward was deprecated, use adaptive issuance values;
• [BREAKING] field lbSubsidy was deprecated, use adaptive issuance values;
• [BREAKING] field frozenDepositsPercentage was deprecated;
• [BREAKING] field doubleBakingPunishment was deprecated;
• [BREAKING] field doubleEndorsingPunishmentNumerator was deprecated;
• [BREAKING] field doubleEndorsingPunishmentDenominator was deprecated;
• [BREAKING] field txRollupOriginationSize was deprecated;
• [BREAKING] field txRollupCommitmentBond was deprecated.

Statistics:

• field totalLost was added.

Changes in the WebSocket API:

• new operation types are available in the operations subscription.

Changes in the DB schema

Basically, DB schema has almost the same changes as the API models, described above.
For more details check out the full diffs at Tzkt.Data/Models.

Commits

• 49452b7: Add Oxford (#162) (Maksim Strebkov) #162
• 103b188: v1.13.0 (Maksim Strebkov)

v1.12.5

General notes

• bugfixes and improvements.

To update from v1.12.* to v1.12.5 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically.

Commits

• f6ed539: Fix bigmap copying (Maksim Strebkov)
• 2b4e1f0: Expose endpoint to query smart rollup parameter json schema (#156) (Michael Zaikin) #156
• b0bca66: Optimize filters, update ws docs. (#154) (Dmitry Mirgaleev) #154
• 3f36cd2: Add filter by id to /revelation_penalties and /endorsing_rewards endpoints (Maksim Strebkov)
• da14a8d: Optimize token balances filter (Maksim Strebkov)
• fda55d9: Fix manager op id filter type (Maksim Strebkov)
• bb88f5c: Fix typo (Maksim Strebkov)
• ad161a1: Add /bigmaps/updates/count API endpoint (Maksim Strebkov)
• 3c7ee3c: Display zero storage fee instead of null (Maksim Strebkov)
• 82506cc: v1.12.5 (Maksim Strebkov)

v1.12.4

General notes

• bugfixes and improvements.

To update from v1.12.* to v1.12.4 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically.

Commits

• 6e64ed7: Add filter by id for /transfer_ticket (#155) (Dmitry Mirgaleev) #155
• 74bf859: Expand top-level constants in contract's code (Maksim Strebkov)
• 313d111: v1.12.4 (Maksim Strebkov)

v1.12.3

General notes

• tickets support;
• bugfixes and improvements.

To update from v1.12.* to v1.12.3 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically. However, this automatic migration won't result in historical tickets appearing in the DB, so if you need tickets data you will have to index from scratch (or restore the DB from the appropriate snapshot).

Commits

• 2c813d8: Add tickets support (#153) (Dmitry Mirgaleev) #153
• d4e8b7d: v1.12.3 (Maksim Strebkov)
• 1848164: Fix filter for vdf_revelation ops (Maksim Strebkov)

v1.12.2

General notes

• bugfixes and improvements.

To update from v1.12.* to v1.12.2 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically.

Commits

• 40e56b1: Add /bigmaps/keys endpoint (Maksim Strebkov)
• 9607be0: Optimize querying contract's transactions (Maksim Strebkov)
• 0135e8b: Support deep selection in /contracts endpoint (Maksim Strebkov)
• 8130249: Avoid replacing sorting column (Maksim Strebkov)
• 0d56971: Add funded bakers stats (Maksim Strebkov)
• 0588753: Add token balance value (257Byte)
• e5e7d7b: Explicitly specify columns to select from tokens table (257Byte)
• bfed9f2: Check TransferTicket.TicketerId for null (Maksim Strebkov)
• 6660a5d: Fix token supply reverting (Maksim Strebkov)
• 790091c: v1.12.2 (Maksim Strebkov)

v1.12.1

General notes

• Nairobi support;
• bugfixes and improvements.

To update from v1.12.0 to v1.12.1 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically.

Changes in the API models

• field protocol was added to the smart rollup message model;
• smart rollup message type now may have another possible value: migration.

Commits

• c787147: Fix game model in sr_refute operation (Maksim Strebkov)
• a138afb: Update snapshot version (Dmitry Mirgaleev)
• ebce378: Exclude rollups from GetRelatedContracts (Maksim Strebkov)
• a09b55b: Add more filters to /sr_publish (Maksim Strebkov)
• beb763a: Fix max reward constants (Maksim Strebkov)
• 35ab07f: Update Python WS examples in docs (#147) (Lev Gorodetskiy) #147
• bcb30e9: Update /events endpoint to /ws in pysignalr example (#150) (Lev Gorodetskiy) #150
• b109773: Add Nairobi support (Maksim Strebkov)
• 6c9939a: Add Nairobi docker support (dmir)
• ab0adc2: v1.12.1 (Maksim Strebkov)

v1.12.0

General notes

• Mumbai support;
• Prometheus metrics;
• Contract metadata;
• RPC helpers;
• minor improvements.

To update from v1.11.* to v1.12.0 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically.

Prometheus metrics

Tzkt now has an ability to collect app metrics. See how to enable it in tzkt-sync and tzkt-api.

Contract metadata

Tzkt now indexes contract metadata (TZIP-16). However, since the account API model has already had the metadata field, containing Tzkt.Profile info, we have introduced the ?lagacy query parameter (true by default) in the /accounts and /contracts endpoints. When this flag is true, TZIP-16 metadata is hidden and the account.metadata field contains Tzkt.Profile info. When this flag is false, the account.metadata field contains TZIP-16 metadata and the account.extras.profile field contains Tzkt.Profile info. This allows to switch to the new funtionality without breaking API clients.

So, to switch to the new functionality, just add ?legacy=false. In the future, when most API clients are ready, we will remove the ?legacy parameter, making the new functionality default.

Changes in the WebSocket API:

• new operation types are available in the operations subscription.

Changes in the API models

• [BREAKING] field metadata in the account, software, global_constant, protocol, and proposal models was deprecated (use extras instead). It will be removed in the near future (except for the account model - read about contract metadata above);
• field reverse was added to the domain model;
• new account type: smart_rollup;
• new operation types: sr_add_messages, sr_cement, sr_execute, sr_originate, sr_publish, sr_recover_bond, and sr_refute;
• fields smartRollupBonds, smartRollupsCount, smartRollupAddMessagesCount, smartRollupCementCount, smartRollupExecuteCount, smartRollupOriginateCount, smartRollupPublishCount, smartRollupRecoverBondCount, smartRollupRefuteCount, refutationGamesCount, and activeRefutationGamesCount were added to the delegate and user models;
• fields smartRollupOriginationSize, smartRollupStakeAmount, smartRollupChallengeWindow, smartRollupCommitmentPeriod, and smartRollupTimeoutPeriod were added to the protocol model;
• field totalSmartRollupBonds was added to the statistics model;

New API endpoints

• /helpers/inject;
• /helpers/view/{contract}/{view_name};
• /operations/sr_add_messages*;
• /operations/sr_cement*;
• /operations/sr_execute*;
• /operations/sr_originate*;
• /operations/sr_publish*;
• /operations/sr_recover_bond*;
• /operations/sr_refute*;
• /smart_rollups*;
• /smart_rollups/{address};
• /smart_rollups/{address}/stakers;
• /smart_rollups/commitments*;
• /smart_rollups/games*;
• /smart_rollups/inbox*.

(* means that there is also ./count endpoint).

Changes in the DB schema

• all Metadata columns were renamed to Extras;
• column Metadata was added to the Accounts table;
• column Reverse was added to the Domains table;
• columns SmartRollupBonds, SmartRollupsCount, SmartRollupAddMessagesCount, SmartRollupCementCount, SmartRollupExecuteCount, SmartRollupOriginateCount, SmartRollupPublishCount, SmartRollupRecoverBondCount, SmartRollupRefuteCount, RefutationGamesCount, ActiveRefutationGamesCount, PvmKind, GenesisCommitment, LastCommitment, InboxLevel, TotalStakers, ActiveStakers, ExecutedCommitments, CementedCommitments, PendingCommitments, RefutedCommitments, and OrphanCommitments were added to the Accounts table;
• columns SmartRollupCommitmentCounter, RefutationGameCounter, InboxMessageCounter, SmartRollupAddMessagesOpsCount, SmartRollupCementOpsCount, SmartRollupExecuteOpsCount, SmartRollupOriginateOpsCount, SmartRollupPublishOpsCount, SmartRollupRecoverBondOpsCount, and SmartRollupRefuteOpsCount were added to the AppState table;
• columns SmartRollupOriginationSize, SmartRollupStakeAmount, SmartRollupChallengeWindow, SmartRollupCommitmentPeriod, and SmartRollupTimeoutPeriod were added to the Protocols table;
• column TotalSmartRollupBonds was added to the Statistics table;
• tables SmartRollupAddMessagesOps, SmartRollupCementOps, SmartRollupExecuteOps, SmartRollupOriginateOps, SmartRollupPublishOps, SmartRollupRecoverBondOps, and SmartRollupRefuteOps were added;
• tables SmartRollupCommitments, RefutationGames, and InboxMessages were added.

Commits

• page for Taquito extension (#140) #140 (Michael Zaikin)
• 7043fec: Add RPC helpers endpoint (#110) (dmirgaleev) #110
• c04e187: Add AppMetrics (#134) (dmirgaleev) #134
• 09ca040: Add amount filter to /transactions/count (MS)
• eef92d5: Update README.md (Maksim Strebkov)
• 5b1535b: Add /helpers/view endpoint (#141) (dmirgaleev) #141
• 575499c: Add domain reverse records indexing (MS)
• d019820: Add contract metadata indexing, refactor legacy metadata (MS)
• 5423afc: Backward compatibility for extras (Maksim Strebkov)
• 74c7e07: Generate JSONSchema for all entrypoints (including default and intermediary) (#142) (Michael Zaikin) #142
• 89a0c60: Mumbai scaffold (Maksim Strebkov) #144
• 90d1f35: Implement protocol activation (Maksim Strebkov) #144
• 0025e63: Add indexing of 3 smart rollup operation types, and scaffold for the rest ones (Maksim Strebkov) #144
• 010980c: Index smart rollup commitments (Maksim Strebkov) #144
• a5d3daf: Index refutation games (257Byte) #144
• c87371a: Add rest smart rollup operations (257Byte) #144
• 6e6fe01: Index smart rollup inbox (257Byte) #144
• 9bfd058: Minor refactoring and fixes (257Byte) #144
• 8e715d9: Index smart rollup bonds status (257Byte) #144
• 48a7a00: ADd smart rollup commitment stakers and statuses (257Byte) #144
• 7666141: Add DB migration for Mumbai (257Byte) #144
• 818e594: Add new protocol constants (257Byte) #144
• c002f98: Update account, statistics, and protocol API models (257Byte) #144
• 494b6f1: Add 7 new operation types to the API (257Byte) #144
• 884a2bc: Code smells (257Byte) #144
• 7915c92: Update regexes to handle new account types (257Byte) #144
• b36f061: Add smart rollup commitments API endpoints (257Byte) #144
• d67907f: Add commitment info to sr_cement, sr_execute, sr_publish operations (257Byte) #144
• f0b4f53: Add refutation games API endpoints (257Byte) #144
• ab9f0dd: Add refutation game info to sr_refute operation (257Byte) #144
• 0211da4: Minor fixes (257Byte) #144
• 31485d0: Extend sr_originate operation API model (257Byte) #144
• 00ab7bf: Add dissection range info to refutation operations (Maksim Strebkov) #144
• 1404280: Count smart rollup stakers (Maksim Strebkov) #144
• 12c577d: List mumbai2 protocol hash (Maksim Strebkov) #144
• e8e8e94: Add smart rollup inbox API endpoints (Maksim Strebkov) #144
• 082e69f: Add dedicated endpoints for smart rollup accounts (Maksim Strebkov) #144
• 921ca1b: Add smart rollup stakers API endpoint (Maksim Strebkov) #144
• 83e432f: Update docs, fix spelling (Maksim Strebkov) #144
• 2eebee6: Add ARM64 platform (#145) (dmirgaleev) #145
• de9526a: v1.12.0 (Maksim Strebkov)

v1.11.1

General notes

• bugfixes and minor improvements.

To update from v1.11.* to v1.11.1 just update the tzkt-sync and tzkt-api binaries.

Commits

• d280b0b: Snapshot version update (Dmitry Mirgaleev)
• b48c96e: Snapshot version update (Dmitry Mirgaleev)
• 8e54301: Minor fixes (MS)
• 82c782a: Optimize tokens and token transfers endpoints (MS)
• e3de7c1: Update lima activator for flextesa (MS) #135
• 9b76389: Fix null baker ref (MS) #135
• 64fea4f: Update packages (MS)
• b9ad14d: Added command timeout (Dmitry Mirgaleev)
• 40e8600: Add fallback protocol handler, increase API init timeout (AlirezaHaghshenas) #139
• 99da399: Fix typo (MS)
• 2957e9b: v1.11.1 (MS)

v1.11.0

General notes

• Lima support;
• Tezos domains indexing;
• minor API improvements.

To update from v1.10.* to v1.11.0 just update the tzkt-sync and tzkt-api binaries. DB will migrate automatically.
Note, that the DB migration will take some time (about 40 minutes for mainnet and a couple of minutes for testnets).
Or, if you have any issues with DB migration (like not enough disk space), you can restore the DB from the latest snapshot as usual.

General changes

• [BREAKING] we've migrated to .NET 7, so if you build tzkt from sources, you will need to install .NET 7.

Changes in the WebSocket API:

• new operation types are available in the operations subscription.

Changes in the API models

• [BREAKING] field lbSunsetLevel in the protocol constants was deprecated and will be removed in the near future;
• field drainDelegateCount was added to the user model;
• fields drainDelegateCount and updateConsensusKeyCount were added to the delegate model;
• fields drainDelegateOps and updateConsensusKeyOps were added to the block model;

Changes in the API endpoints

• endpoints /accounts and /contracts now allow to filter by address, and request multiple accounts by using .in mode;
• endpoints /operations/drain_delegate* and /operations/update_consensus_key* were added;
• endpoints /domains* were added.

Changes in the DB schema

• all columns of type timestamp were altered to timestamptz;
• columns UpdateConsensusKeyCountand DrainDelegateCount were added to the Accounts table;
• columns UpdateConsensusKeyOpsCount, DrainDelegateOpsCount, DomainsNameRegistry, and DomainsLevel were added to the AppState table;
• column LBSunsetLevel was removed from the Protocols table;
• column Operations in the Blocks table was altered from integer to bigint;
• tables UpdateConsensusKeyOps, DrainDelegateOps, and Domains were added.

Commits

• 466cd44: Lima scaffold (257Byte) #132
• 3d185d9: Lima activation (257Byte) #132
• 52fd90a: Add update_consensus_key op type (257Byte) #132
• 6dd5023: Add drain_delegate op type (257Byte) #132
• 561c518: Deprecate lb sunset level constant (257Byte) #132
• c779365: Add DB migration (257Byte) #132
• f12e613: Simplify drain delegate model (257Byte) #132
• 81d6b00: Add new ops to API, update account models (257Byte) #132
• dea7bf3: Fix typo (257Byte) #132
• a2f4173: Migrate to .NET 7, close #131 (257Byte) #132
• 30515f8: Refactor logger format strings (257Byte) #132
• 1650351: Add tzkt sync tests (257Byte) #132
• 4a769b1: Add domains indexing and API, close #109 (257Byte) #132
• b1d4cda: Add fetching multiple accounts and contracts by addresses (257Byte) #132
• 0face27: Workaround for ghostnet bugs (257Byte) #132
• e41d587: Update docker-compose for lima, add docker file for Tzkt.Sync.Tests (#133) (dmirgaleev) #132
• a44e65a: Update README.md (Maksim Strebkov)
• 9e28cb6: v1.11.0 (257Byte)

v1.10.3

General notes

• bugfixes and minor improvements.

To update from v1.10.* to v1.10.3 just update the tzkt-sync and tzkt-api binaries. In case of updating a kathmandunet indexer, it's strongly recommended to restore the DB from the latest snapshot.

Commits

• 58014fa: Fix voting periods with multiple winners (257Byte)
• ea19d53: Better handle contract events with missed payload (257Byte)
• 998a109: v1.10.3 (257Byte)