Merge pull request #2260 from hirosystems/develop

release to master

Author: rafaelcr

migrations/1744989709876_contract-logs-events-index.js

@@ -0,0 +1,47 @@
+/* eslint-disable camelcase */
+
+exports.shorthands = undefined;
+
+exports.up = pgm => {
+  pgm.dropIndex('contract_logs', 'contract_identifier');
+  pgm.dropIndex('contract_logs', [
+    { name: 'block_height', sort: 'DESC' },
+    { name: 'microblock_sequence', sort: 'DESC' },
+    { name: 'tx_index', sort: 'DESC' },
+    { name: 'event_index', sort: 'DESC' },
+  ]);
+
+  pgm.createIndex(
+    'contract_logs',
+    [
+      'contract_identifier',
+      { name: 'block_height', sort: 'DESC' },
+      { name: 'microblock_sequence', sort: 'DESC' },
+      { name: 'tx_index', sort: 'DESC' },
+      { name: 'event_index', sort: 'DESC' },
+    ],
+    { where: 'canonical = TRUE AND microblock_canonical = TRUE' }
+  );
+};
+
+exports.down = pgm => {
+  pgm.dropIndex(
+    'contract_logs',
+    [
+      'contract_identifier',
+      { name: 'block_height', sort: 'DESC' },
+      { name: 'microblock_sequence', sort: 'DESC' },
+      { name: 'tx_index', sort: 'DESC' },
+      { name: 'event_index', sort: 'DESC' },
+    ],
+    { where: 'canonical = TRUE AND microblock_canonical = TRUE' }
+  );
+
+  pgm.createIndex('contract_logs', 'contract_identifier');
+  pgm.createIndex('contract_logs', [
+    { name: 'block_height', sort: 'DESC' },
+    { name: 'microblock_sequence', sort: 'DESC' },
+    { name: 'tx_index', sort: 'DESC' },
+    { name: 'event_index', sort: 'DESC' },
+  ]);
+};

src/api/deprecation-plugin.ts

@@ -0,0 +1,39 @@
+import fp from 'fastify-plugin';
+import { FastifyPluginAsync } from 'fastify';
+
+declare module 'fastify' {
+  interface FastifySchema {
+    deprecatedMessage?: string;
+  }
+}
+
+const pluginCb: FastifyPluginAsync<{ defaultDeprecatedMessage: string }> = async (
+  fastify,
+  options
+) => {
+  fastify.addHook('onSend', async (request, reply) => {
+    if (request.routeOptions.schema?.deprecated) {
+      const warningMessage =
+        request.routeOptions.schema.deprecatedMessage ??
+        options.defaultDeprecatedMessage ??
+        'Endpoint is deprecated';
+      const warning = `299 - "Deprecated: ${warningMessage}"`;
+      if (!reply.getHeader('Warning')) {
+        void reply.header('Warning', warning);
+      }
+    }
+  });
+  await Promise.resolve();
+};
+
+/**
+ * Fastify plugin that adds deprecation warnings to HTTP responses.
+ *
+ * If a route's schema has `deprecated: true`, a `Warning` header will be added to the response.
+ * - If the schema includes a `deprecatedMessage`, it will be used in the warning.
+ * - If not, the plugin uses the `defaultDeprecatedMessage` provided in the plugin options.
+ * - If neither is available, a generic warning message `299 - "Deprecated"` is used.
+ */
+const DeprecationPlugin = fp(pluginCb);
+
+export default DeprecationPlugin;

src/api/init.ts

@@ -57,6 +57,7 @@ import FastifyMetrics from 'fastify-metrics';
 import FastifyCors from '@fastify/cors';
 import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
 import * as promClient from 'prom-client';
+import DeprecationPlugin from './deprecation-plugin';
 
 export interface ApiServer {
   fastifyApp: FastifyInstance;
@@ -271,6 +272,11 @@ export async function startApiServer(opts: {
   // Setup direct proxy to core-node RPC endpoints (/v2)
   await fastify.register(CoreNodeRpcProxyRouter, { prefix: '/v2' });
 
+  // Middleware to annotate http responses with deprecation warnings
+  await fastify.register(DeprecationPlugin, {
+    defaultDeprecatedMessage: 'See https://docs.hiro.so/stacks/api for more information',
+  });
+
   // Wait for all routes and middleware to be ready before starting the server
   await fastify.ready();
 

src/datastore/pg-store-v2.ts

@@ -335,38 +335,37 @@ export class PgStoreV2 extends BasePgStoreModule {
     return await this.sqlTransaction(async sql => {
       const limit = args.limit ?? TransactionLimitParamSchema.default;
       const offset = args.offset ?? 0;
-      const filter =
-        args.block.type === 'latest'
-          ? sql`index_block_hash = (SELECT index_block_hash FROM blocks WHERE canonical = TRUE ORDER BY block_height DESC LIMIT 1)`
-          : args.block.type === 'hash'
-          ? sql`(
-              block_hash = ${normalizeHashString(args.block.hash)}
-              OR index_block_hash = ${normalizeHashString(args.block.hash)}
-            )`
-          : sql`block_height = ${args.block.height}`;
-      const blockCheck = await sql`SELECT index_block_hash FROM blocks WHERE ${filter} LIMIT 1`;
-      if (blockCheck.count === 0)
-        throw new InvalidRequestError(`Block not found`, InvalidRequestErrorType.invalid_param);
       const txsQuery = await sql<(TxQueryResult & { total: number })[]>`
-        WITH tx_count AS (
-          SELECT tx_count AS total FROM blocks WHERE canonical = TRUE AND ${filter}
+        WITH block_ptr AS (
+          SELECT index_block_hash FROM blocks
+          WHERE ${
+            args.block.type === 'latest'
+              ? sql`canonical = TRUE ORDER BY block_height DESC`
+              : args.block.type === 'hash'
+              ? sql`(
+                  block_hash = ${normalizeHashString(args.block.hash)}
+                  OR index_block_hash = ${normalizeHashString(args.block.hash)}
+                ) AND canonical = TRUE`
+              : sql`block_height = ${args.block.height} AND canonical = TRUE`
+          }
+          LIMIT 1
+        ),
+        tx_count AS (
+          SELECT tx_count AS total
+          FROM blocks
+          WHERE index_block_hash = (SELECT index_block_hash FROM block_ptr)
         )
         SELECT ${sql(TX_COLUMNS)}, (SELECT total FROM tx_count)::int AS total
         FROM txs
         WHERE canonical = true
           AND microblock_canonical = true
-          AND ${filter}
+          AND index_block_hash = (SELECT index_block_hash FROM block_ptr)
         ORDER BY microblock_sequence ASC, tx_index ASC
         LIMIT ${limit}
         OFFSET ${offset}
       `;
       if (txsQuery.count === 0)
-        return {
-          limit,
-          offset,
-          results: [],
-          total: 0,
-        };
+        throw new InvalidRequestError(`Block not found`, InvalidRequestErrorType.invalid_param);
       return {
         limit,
         offset,

tests/api/address.test.ts

@@ -1547,6 +1547,9 @@ describe('address tests', () => {
     );
     expect(fetchAddrBalance1.status).toBe(200);
     expect(fetchAddrBalance1.type).toBe('application/json');
+    expect(fetchAddrBalance1.headers['warning']).toBe(
+      '299 - "Deprecated: See https://docs.hiro.so/stacks/api for more information"'
+    );
     const expectedResp1 = {
       stx: {
         balance: '88679',

tests/api/tx.test.ts

@@ -4198,7 +4198,7 @@ describe('tx tests', () => {
     );
     expect(result.status).toBe(200);
     expect(result.type).toBe('application/json');
-    const json = JSON.parse(result.text);
+    let json = JSON.parse(result.text);
     expect(json.total).toBe(2);
     expect(json.results[0]).toStrictEqual({
       anchor_mode: 'any',
@@ -4244,6 +4244,18 @@ describe('tx tests', () => {
       tx_type: 'coinbase',
     });
 
+    result = await supertest(api.server).get(`/extended/v2/blocks/latest/transactions`);
+    expect(result.status).toBe(200);
+    expect(result.type).toBe('application/json');
+    json = JSON.parse(result.text);
+    expect(json.total).toBe(2);
+
+    result = await supertest(api.server).get(`/extended/v2/blocks/1/transactions`);
+    expect(result.status).toBe(200);
+    expect(result.type).toBe('application/json');
+    json = JSON.parse(result.text);
+    expect(json.total).toBe(2);
+
     // Try a non-existent block
     result = await supertest(api.server).get(
       `/extended/v2/blocks/0x00000000000000000001e2ee7f0c6bd5361b5e7afd76156ca7d6f524ee999999/transactions?limit=20&offset=0`