Merge branch 'master' into develop

Author: zone117x

.env

@@ -158,6 +158,9 @@ STACKS_NODE_TYPE=L1
 # Enable FT metadata processing for Rosetta operations display. Disabled by default.
 # STACKS_API_ENABLE_FT_METADATA=1
 
+# Enable legacy API endpoints. Disabled by default.
+# STACKS_API_ENABLE_LEGACY_ENDPOINTS=1
+
 # The Rosetta API endpoints require FT metadata to display operations with the proper `symbol` and
 # `decimals` values. If FT metadata is enabled, this variable controls the token metadata error
 # handling mode when metadata is not found.

CHANGELOG.md

@@ -1,5 +1,32 @@
+## [8.10.0](https://github.com/hirosystems/stacks-blockchain-api/compare/v8.9.0...v8.10.0) (2025-04-18)
+
+
+### Features
+
+* add `Warning` http response deprecation notices ([#2253](https://github.com/hirosystems/stacks-blockchain-api/issues/2253)) ([e62ce79](https://github.com/hirosystems/stacks-blockchain-api/commit/e62ce79756338fdcc43a1641787c704ef1202143))
+
+
+### Bug Fixes
+
+* optimize contract event list db index ([#2258](https://github.com/hirosystems/stacks-blockchain-api/issues/2258)) ([e1044d1](https://github.com/hirosystems/stacks-blockchain-api/commit/e1044d1f2cdbe4a202193794d04a8bbdd0ac9592))
+* optimize query for transactions in block ([#2259](https://github.com/hirosystems/stacks-blockchain-api/issues/2259)) ([e69f9e4](https://github.com/hirosystems/stacks-blockchain-api/commit/e69f9e4149d3bcedee4d47a3e4a8f1ea2b8ff964))
+
+## [8.9.0](https://github.com/hirosystems/stacks-blockchain-api/compare/v8.8.0...v8.9.0) (2025-04-10)
+
+> [!IMPORTANT]
+> This release marks the `/mempool/dropped` endpoint as legacy deprecated, which means we will keep its code in the API but will no longer respond to it from our production deployments.
+> If you still need to use this endpoint in your own API deployment, set the `STACKS_API_ENABLE_LEGACY_ENDPOINTS` to `true` in your environment before starting the API.
+
+### Features
+
+* mark /mempool/dropped endpoint as legacy deprecated ([#2255](https://github.com/hirosystems/stacks-blockchain-api/issues/2255)) ([576d05b](https://github.com/hirosystems/stacks-blockchain-api/commit/576d05bfb843852bd4d6fc2e1f863f983568fbe6))
+
 ## [8.8.0](https://github.com/hirosystems/stacks-blockchain-api/compare/v8.7.0...v8.8.0) (2025-04-02)
 
+> [!IMPORTANT]
+> This release deprecates the [`/extended/v1/address/:addr/balances`](https://docs.hiro.so/stacks/api/accounts/balances) and [`/extended/v1/address/:addr/stx`](https://docs.hiro.so/stacks/api/accounts/stx-balances) endpoints in favor of new endpoints [`/extended/v2/addresses/:addr/balances/stx`](https://docs.hiro.so/stacks/api/accounts/principal-stx-balance) and [`/extended/v2/addresses/:addr/balances/ft`](https://docs.hiro.so/stacks/api/accounts/principal-ft-balances) that are optimized for higher performance.
+>
+> We strongly encourage applications and developers to use the new endpoints as soon as possible, as we plan on eventually removing access the now deprecated endpoints.
 
 ### Features
 

src/api/routes/tx.ts

@@ -16,7 +16,7 @@ import {
   handleTransactionCache,
 } from '../controllers/cache-controller';
 import { DbEventTypeId } from '../../datastore/common';
-import { has0xPrefix } from '@hirosystems/api-toolkit';
+import { has0xPrefix, parseBoolean } from '@hirosystems/api-toolkit';
 
 import { FastifyPluginAsync } from 'fastify';
 import { Server } from 'node:http';
@@ -318,43 +318,46 @@ export const TxRoutes: FastifyPluginAsync<
     }
   );
 
-  fastify.get(
-    '/mempool/dropped',
-    {
-      preHandler: handleMempoolCache,
-      schema: {
-        operationId: 'get_dropped_mempool_transaction_list',
-        summary: 'Get dropped mempool transactions',
-        description: `Retrieves all recently-broadcast transactions that have been dropped from the mempool.
-
-        Transactions are dropped from the mempool if:
-         * they were stale and awaiting garbage collection or,
-         * were expensive, or
-         * were replaced with a new fee`,
-        tags: ['Transactions'],
-        querystring: Type.Object({
-          offset: OffsetParam(),
-          limit: LimitParam(ResourceType.Tx),
-        }),
-        response: {
-          200: PaginatedResponse(MempoolTransactionSchema, {
-            description: 'List of dropped mempool transactions',
+  if (parseBoolean(process.env['STACKS_API_ENABLE_LEGACY_ENDPOINTS'])) {
+    fastify.get(
+      '/mempool/dropped',
+      {
+        preHandler: handleMempoolCache,
+        schema: {
+          deprecated: true,
+          operationId: 'get_dropped_mempool_transaction_list',
+          summary: 'Get dropped mempool transactions',
+          description: `Retrieves all recently-broadcast transactions that have been dropped from the mempool.
+
+          Transactions are dropped from the mempool if:
+           * they were stale and awaiting garbage collection or,
+           * were expensive, or
+           * were replaced with a new fee`,
+          tags: ['Transactions'],
+          querystring: Type.Object({
+            offset: OffsetParam(),
+            limit: LimitParam(ResourceType.Tx),
           }),
+          response: {
+            200: PaginatedResponse(MempoolTransactionSchema, {
+              description: 'List of dropped mempool transactions',
+            }),
+          },
         },
       },
-    },
-    async (req, reply) => {
-      const limit = getPagingQueryLimit(ResourceType.Tx, req.query.limit);
-      const offset = parsePagingQueryInput(req.query.offset ?? 0);
-      const { results: txResults, total } = await fastify.db.getDroppedTxs({
-        offset,
-        limit,
-      });
-      const results = txResults.map(tx => parseDbMempoolTx(tx));
-      const response = { limit, offset, total, results };
-      await reply.send(response);
-    }
-  );
+      async (req, reply) => {
+        const limit = getPagingQueryLimit(ResourceType.Tx, req.query.limit);
+        const offset = parsePagingQueryInput(req.query.offset ?? 0);
+        const { results: txResults, total } = await fastify.db.getDroppedTxs({
+          offset,
+          limit,
+        });
+        const results = txResults.map(tx => parseDbMempoolTx(tx));
+        const response = { limit, offset, total, results };
+        await reply.send(response);
+      }
+    );
+  }
 
   fastify.get(
     '/mempool/stats',

tests/api/setup.ts

@@ -8,5 +8,6 @@ export default (): void => {
   }
   loadDotEnv();
   process.env.PG_DATABASE = 'postgres';
+  process.env.STACKS_API_ENABLE_LEGACY_ENDPOINTS = '1';
   console.log('Jest - setup done');
 };