SMASH 1.6.1

Compatible with node version cardano-node 1.30.1.

Updated

• Update dependencies to match the latest node

Known issues

• Smash eating up a lot of resources #169
• High CPU usage #173

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Operations	✔️
Release Manager	✔️

SMASH 1.6.0

Smash 1.6.0 introduces support for Alonzo, and is expected to be the final release before the Alonzo hard fork.
It also handles chain rollbacks correctly, and other changes and fixes listed below:

Compatible with node version cardano-node 1.29.0.

The underlying database has breaking changes, therefore the database needs to be dropped and re-created.

This version requires a full re-sync!
Before running the new version, first run force-resync, example:

smash-exe -- force-resync --mdir ./schema --config config/shelley-qa-config.yaml

New Features

• [CAD-2547] - Add Prometheus metrics for slot_no #537
• [CAD-2581] - Use the general db-sync plugins system to implement SMASH #151
• [CAD-2651] - Fix/improve caching #153
• [CAD-2671] - Modify cardano-sync to enable reusing from SMASH #527
• [CAD-2724] - CLI option to switch to existing SMASH server filtering #156
• [CAD-2810] - Add CLI for checking of pool metadata hash #162
• [CAD-2811] - Fix error handling to show last 10 results by default #163
• Let Postgres cascade deletes instead of using the deprecated persistant feature
• Use the same rollback logic as db-sync

Resolved issues

• [CAD-2832] - Smash syncing from scratch every restart #165

Known issues

• Smash eating up a lot of resources #169
• High CPU usage #173

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Operations	⏳
Release Manager	✔️

SMASH 1.4.0

Smash 1.4.0 introduces support for the Mary era, and users need to upgrade to this version for Mary.

This version requires a full re-sync!
Before running the new version, first run force-resync, example:

smash-exe -- force-resync --mdir ./schema --config config/shelley-qa-config.yaml

The underlying database has no breaking changes, therefore the database does not need to be dropped and re-created.

Compatible with cardano-node 1.24.2, and cardano-node 1.25.1.

New Features

• [CAD-1357] - Remove any traces of cardano-db-sync #134
• [CAD-2180] - Documentation improvements #137
• [CAD-2184] - Fix Swagger documentation to be consistent, add more info #130
• [CAD-2449] - Add API endpoint for checking valid pool id #139
• [CAD-2450] - Bump up to Mary (Native tokens) support #142

Resolved issues

• [CAD-2408] - Create directory for --state-dir automatically if it does not exist #132
• [CAD-2416] - Database connection inconsistency #133
• [CAD-2476] - SMASH not returning active pools that were previously retired #140

Known issues

• IntersectMBO/cardano-db-sync#434

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Operations	✔️
Release Manager	✔️

SMASH 1.3.0

Smash 1.3.0 introduces support for the Allegra era, and users need to upgrade to this version for Allegra.

The underlying database has no breaking changes, therefore the database does not need to be dropped and re-created. All the user has to do is run SMASH, as usual; it will take care of the migration.

Compatible with cardano-node 1.24.2.

New Features

• [CAD-2169] - Expose API types in a separate package #110
• [CAD-2177] - smash should work also with pool_ids in Bech32 format #78
• [CAD-2182] - Pool insertion and ticker insertion should be added into API
• [CAD-2183] - Add/remove admin user via CLI
• [CAD-2323] - Bump up to Allegra Hard Fork

Resolved issues

• [CAD-2176] - errors endpoint doesn't validate poolId properly
• [CAD-2178] - The retryCount from the /errors endpoint is not correctly incremented
• [CAD-2179] - pool_id delist endpoint is returning 200 for any string (not only for valid pool_ids)
• [CAD-2181] - All queries that don't return anything should return 404

Known issues

• IntersectMBO/cardano-db-sync#434

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Operations	✔️
Release Manager	✔️

SMASH 1.2.0

This update includes new functionality to help stake pools:

• An interface to get the errors that have caused SMASH to not list the pool metadata. This will help SPOs to diagnose the problem with their pool metadata not showing up in wallets.
• An interface to get the list of pool ids that have been delisted by the SMASH server operator's policy.
• A health-check interface to confirm that a SMASH server is operating.

It also includes improvements in logging, DB migration when upgrading, optimisation with data caching.

The underlying database has no breaking changes, therefore the database does not need to be dropped and re-created. All the user has to do is run SMASH, as usual; it will take care of the migration.

Compatible with cardano-node 1.21.1.

New Features

• [CAD-1823] - Stake pools has issues list #90
• [CAD-1824] - Delisted stake pools are provided #83
• [CAD-1838] - Whitelisting (listing) returns delisted stake pools to be visible #87
• [CAD-2074] - Health check endpoint provides the status and the version from the SMASH server, currently, the status is always OK when SMASH is up and running #101

Improvements

• [CAD-1926] - Retired pools are ignored #89
• [CAD-2061] - Logs are improved; information about cause of an error occurred is added #79
• [CAD-1358] - The caching headers for the HTTP server are returned #80
• [CAD-2093] - Qualified module names are used to ensure the reuse of the SMASH library #103
• [CAD-2085] - Migration scripts for SMASH upgrade are used to avoid database drop

Resolved issues

• [CAD-2088] - Made paths relative to the configuration file, not the executable #100

Known issues

• There are known issues regarding UX when using the SMASH admin commands
• There are no delete commands, and all actions must be cleared from the database

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Operations	✔️
Release Manager	✔️

Smash 1.1.0

This is a small update that includes a new query to request a reason for pool metadata lookup failure, bug fixes including TLS library upgrade to 1.5.4, and documentation improvements.

The underlying database has breaking changes, therefore the database should be dropped and recreated.

Compatible with cardano-node 1.19.0.

New Feature

• [CAD-1744] - Easily query reason for pool metadata lookup failure #67

Improvements

• Documentation update #58, #59, #60, #62, #66

Resolved issues

• [CAD-1791] - smash is failing when decoding address #69
• [CAD-1753] - TLS version 1.3 not working correctly #63

Known issues

• There are known issues regarding UX when using the SMASH admin commands.
• There are no delete commands, and all actions must be cleared from the database.

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Operations	✔️
Release Manager	✔️

Smash 1.0.1

This patch release adds pool id to a query requesting pool information.

Compatible with cardano-node 1.18.0 and cardano-db-sync 3.1.0.

Resolved issue

• [CAD-1471] - Query pool id along with hash when looking for pool info #55

Known issues

• There are known issues regarding UX when using the SMASH admin commands.
• There are no delete commands, and all actions must be cleared from the database.

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Release Manager	✔️

Smash 1.0.0

This is the first production release of Stakepool Metadata Aggregation Server that collects, stores and provides Cardano blockchain stake pool information off chain on a server. The metadata is restricted to 512 bytes. See the initial release for the complete feature list.

Compatible with cardano-node 1.18.0 and cardano-db-sync 3.1.0.

New features

• [CAD-1397] - ITN Ticker protection for mainnet and SMASH #38
• [CAD-1446] - Support of delayed registration of metadata #40
• [CAD-1449] - Exponential back-off to pull Stake Pools metadata in case there’s a timeout or an HTTP error returned by the pool metadata server #40
• [CAD-1456] - Blacklisting of pool ids #45

Improvements

• [CAD-1428] - Changed the primary database key to be "poolid", not ticker name #38
• [CAD-1462] - Clarified the insert ticker command name and added error reporting if a ticker already exists #46

Known issues

• There are known issues regarding UX when using the SMASH admin commands.
• There are no delete commands, and all actions must be cleared from the database.

Documentation

Smash documentation

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Release Manager	✔️

Smash 0.1.0

This is initial version of Stakepool Metadata Aggregation Server that collects, stores and provides Cardano blockchain stake pool information off chain on a server. The metadata is restricted to 512 bytes.

Will not retry fetching metadata if hash mismatches or URL is not available.

Compatible with cardano-node 1.18.0 and cardano-db-sync 3.1.0.

New features

• [CAD-762] - Initial API design #5
• [CAD-770] - A simple in-memory database #6
• [CAD-779] - A database backend #8
• [CAD-778] - Block syncing mechanism
• [CAD-1330] - http client for fetching JSON metadata #11
• [CAD-1348] - Block insertion so we don't sync from scratch #17
• [CAD-1353] - JSON size check for offline metadata #13
• [CAD-1354] - Add deny list functionality #20
• [CAD-1355] - Add a flag for switching Basic Authorisation off/on #20
• [CAD-1360] - Add documentation for third party clients #21
• [CAD-1371] - Integrate SMASH against HFC #23

Resolved Issues

[CAD-1361] - Servers return 200 OK when metadata isn't found #16, #17

Known issues

⚠️ IMPORTANT ⚠️

• [CAD-1409] Will not retry fetching metadata if hash mismatches or URL is not available

Documentation

README provides overview and necessary information for building and testing the server

Supported Platforms

• Linux 64-bit

Sign off

Role	Approval
Technical Lead	✔️
QA Engineer	✔️
Release Manager	✔️