baking-bad/tzkt v1.12.0

on GitHub

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)