feat: add total tx count to burn block endpoints

Author: zone117x

docs/api/blocks/get-burn-blocks.example.json

@@ -14,7 +14,8 @@
         "0xb9e9b308cf9621ecbf66ca7b4689fe384b9b67c4588ec827d8163ab602fb935e",
         "0x754562cba6ec243f90485e97778ab472f462fd123ef5b83cc79d8759ca8875f5"
       ],
-      "avg_block_time": 15.3
+      "avg_block_time": 15.3,
+      "total_tx_count": 728
     }
   ]
 }

docs/entities/blocks/burn-block.example.json

@@ -9,5 +9,6 @@
     "0xb9e9b308cf9621ecbf66ca7b4689fe384b9b67c4588ec827d8163ab602fb935e",
     "0x754562cba6ec243f90485e97778ab472f462fd123ef5b83cc79d8759ca8875f5"
   ],
-  "avg_block_time": 15.3
+  "avg_block_time": 15.3,
+  "total_tx_count": 728
 }

docs/entities/blocks/burn-block.schema.json

@@ -9,7 +9,8 @@
     "burn_block_hash",
     "burn_block_height",
     "stacks_blocks",
-    "avg_block_time"
+    "avg_block_time",
+    "total_tx_count"
   ],
   "properties": {
     "burn_block_time": {
@@ -38,6 +39,10 @@
     "avg_block_time": {
       "type": "number",
       "description": "Average time between blocks in seconds. Returns 0 if there is only one block in the burn block."
+    },
+    "total_tx_count": {
+      "type": "integer",
+      "description": "Total number of transactions in the Stacks blocks associated with this burn block"
     }
   }
 }

docs/generated.d.ts

@@ -1470,6 +1470,10 @@ export interface BurnBlock {
    * Average time between blocks in seconds. Returns 0 if there is only one block in the burn block.
    */
   avg_block_time: number;
+  /**
+   * Total number of transactions in the Stacks blocks associated with this burn block
+   */
+  total_tx_count: number;
 }
 /**
  * GET request that returns blocks

src/api/routes/v2/burn-blocks.ts

@@ -1,6 +1,7 @@
 import * as express from 'express';
 import {
   BurnBlockListResponse,
+  BurnBlock,
   NakamotoBlockListResponse,
 } from '@stacks/stacks-blockchain-api-types';
 import { getETagCacheHandler, setETagCacheHeaders } from '../../controllers/cache-controller';
@@ -52,8 +53,9 @@ export function createV2BurnBlocksRouter(db: PgStore): express.Router {
         res.status(404).json({ errors: 'Not found' });
         return;
       }
+      const response: BurnBlock = parseDbBurnBlock(block);
       setETagCacheHeaders(res);
-      res.json(parseDbBurnBlock(block));
+      res.json(response);
     })
   );
 

src/api/routes/v2/helpers.ts

@@ -61,6 +61,7 @@ export function parseDbBurnBlock(block: DbBurnBlock): BurnBlock {
     burn_block_height: block.burn_block_height,
     stacks_blocks: block.stacks_blocks,
     avg_block_time: parseFloat(parseFloat(block.avg_block_time ?? '0').toFixed(2)),
+    total_tx_count: parseInt(block.total_tx_count),
   };
   return burnBlock;
 }

src/datastore/common.ts

@@ -56,6 +56,7 @@ export interface DbBurnBlock {
   burn_block_height: number;
   stacks_blocks: string[];
   avg_block_time: string | null;
+  total_tx_count: string;
 }
 
 export interface DbBurnchainReward {

src/datastore/pg-store-v2.ts

@@ -288,16 +288,18 @@ export class PgStoreV2 extends BasePgStoreModule {
             b.block_hash,
             b.block_time,
             b.block_height,
+            b.tx_count,
             LAG(b.block_time) OVER (PARTITION BY b.burn_block_height ORDER BY b.block_height) AS previous_block_time
           FROM blocks b
           WHERE
             canonical = true AND
             b.burn_block_height IN (SELECT burn_block_height FROM RelevantBlocks)
         ),
-        AverageTimes AS (
+        BlockStatistics AS (
           SELECT
             burn_block_height,
-            AVG(block_time - previous_block_time) FILTER (WHERE previous_block_time IS NOT NULL) AS avg_block_time
+            AVG(block_time - previous_block_time) FILTER (WHERE previous_block_time IS NOT NULL) AS avg_block_time,
+            SUM(tx_count) AS total_tx_count
           FROM BlocksWithPrevTime
           GROUP BY burn_block_height
         )
@@ -311,10 +313,11 @@ export class PgStoreV2 extends BasePgStoreModule {
             ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
           ) AS stacks_blocks,
           (SELECT block_count FROM chain_tip)::int AS total,
-          a.avg_block_time
+          a.avg_block_time,
+          a.total_tx_count
         FROM RelevantBlocks r
         JOIN BlocksWithPrevTime b ON b.burn_block_height = r.burn_block_height
-        JOIN AverageTimes a ON a.burn_block_height = r.burn_block_height
+        JOIN BlockStatistics a ON a.burn_block_height = r.burn_block_height
         ORDER BY r.burn_block_height DESC, b.block_height DESC;
       `;
       return {
@@ -343,14 +346,16 @@ export class PgStoreV2 extends BasePgStoreModule {
             block_hash,
             block_time,
             block_height,
+            tx_count,
             LAG(block_time) OVER (PARTITION BY burn_block_height ORDER BY block_height) AS previous_block_time
           FROM blocks
           WHERE canonical = true AND ${filter}
         ),
-        AverageTimes AS (
+        BlockStatistics AS (
           SELECT
             burn_block_height,
-            AVG(block_time - previous_block_time) FILTER (WHERE previous_block_time IS NOT NULL) AS avg_block_time
+            AVG(block_time - previous_block_time) FILTER (WHERE previous_block_time IS NOT NULL) AS avg_block_time,
+            SUM(tx_count) AS total_tx_count
           FROM BlocksWithPrevTime
           GROUP BY burn_block_height
         )
@@ -363,9 +368,10 @@ export class PgStoreV2 extends BasePgStoreModule {
             ORDER BY b.block_height DESC
             ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
           ) AS stacks_blocks,
-          a.avg_block_time
+          a.avg_block_time,
+          a.total_tx_count
         FROM BlocksWithPrevTime b
-        JOIN AverageTimes a ON a.burn_block_height = b.burn_block_height
+        JOIN BlockStatistics a ON a.burn_block_height = b.burn_block_height
         LIMIT 1
       `;
       if (blockQuery.count > 0) return blockQuery[0];