feat: store total transaction size in blocks table (#2204)

* feat: save block size to database

* feat: store total transaction size in blocks table

* fix: inserts

Author: rafaelcr

migrations/1737567411419_block-tx-total-size.js

@@ -0,0 +1,25 @@
+/* eslint-disable camelcase */
+
+exports.shorthands = undefined;
+
+exports.up = pgm => {
+  pgm.addColumn('blocks', {
+    tx_total_size: {
+      type: 'int',
+      notNull: true,
+      default: 0,
+    },
+  });
+  pgm.sql(`
+    UPDATE blocks
+    SET tx_total_size = (
+      SELECT SUM(OCTET_LENGTH(raw_tx))
+      FROM txs
+      WHERE index_block_hash = blocks.index_block_hash
+    )  
+  `);
+};
+
+exports.down = pgm => {
+  pgm.dropColumn('blocks', ['tx_total_size']);
+};

src/datastore/common.ts

@@ -22,6 +22,7 @@ export interface DbBlock {
   execution_cost_runtime: number;
   execution_cost_write_count: number;
   execution_cost_write_length: number;
+  tx_total_size: number;
   tx_count: number;
   block_time: number;
   signer_bitvec: string | null;
@@ -862,6 +863,7 @@ export interface BlockQueryResult {
   execution_cost_runtime: string;
   execution_cost_write_count: string;
   execution_cost_write_length: string;
+  tx_total_size: number;
   tx_count: number;
   signer_bitvec: string | null;
   tenure_height: number | null;
@@ -1287,6 +1289,7 @@ export interface BlockInsertValues {
   execution_cost_runtime: number;
   execution_cost_write_count: number;
   execution_cost_write_length: number;
+  tx_total_size: number;
   tx_count: number;
   signer_bitvec: string | null;
   signer_signatures: PgBytea[] | null;

src/datastore/helpers.ts

@@ -185,6 +185,7 @@ export const BLOCK_COLUMNS = [
   'execution_cost_write_count',
   'execution_cost_write_length',
   'tx_count',
+  'tx_total_size',
   'signer_bitvec',
   'tenure_height',
 ];
@@ -485,6 +486,7 @@ export function parseBlockQueryResult(row: BlockQueryResult): DbBlock {
     execution_cost_runtime: Number.parseInt(row.execution_cost_runtime),
     execution_cost_write_count: Number.parseInt(row.execution_cost_write_count),
     execution_cost_write_length: Number.parseInt(row.execution_cost_write_length),
+    tx_total_size: row.tx_total_size,
     tx_count: row.tx_count,
     signer_bitvec: row.signer_bitvec,
     signer_signatures: null, // this field is not queried from db by default due to size constraints

src/datastore/pg-write-store.ts

@@ -480,6 +480,7 @@ export class PgWriteStore extends PgStore {
       execution_cost_runtime: block.execution_cost_runtime,
       execution_cost_write_count: block.execution_cost_write_count,
       execution_cost_write_length: block.execution_cost_write_length,
+      tx_total_size: block.tx_total_size,
       tx_count: block.tx_count,
       signer_bitvec: block.signer_bitvec,
       signer_signatures: block.signer_signatures,
@@ -3372,6 +3373,7 @@ export class PgWriteStore extends PgStore {
       execution_cost_runtime: block.execution_cost_runtime,
       execution_cost_write_count: block.execution_cost_write_count,
       execution_cost_write_length: block.execution_cost_write_length,
+      tx_total_size: block.tx_total_size,
       tx_count: block.tx_count,
       signer_bitvec: block.signer_bitvec,
       signer_signatures: block.signer_signatures,

src/event-stream/event-server.ts

@@ -1068,6 +1068,12 @@ export function parseNewBlockMessage(
         write_length: 0,
       }
     );
+  // Compute total transaction size in this block. Remove `0x` prefix and check byte length on all
+  // raw txs.
+  const txTotalSize = parsedTxs.reduce(
+    (acc, { core_tx: { raw_tx } }) => acc + Math.ceil((raw_tx.length - 2) / 2),
+    0
+  );
 
   if (typeof msg.tenure_height !== 'number' && msg.signer_bitvec) {
     logger.warn(
@@ -1093,6 +1099,7 @@ export function parseNewBlockMessage(
     execution_cost_runtime: execCost.runtime,
     execution_cost_write_count: execCost.write_count,
     execution_cost_write_length: execCost.write_length,
+    tx_total_size: txTotalSize,
     tx_count: msg.transactions.length,
     block_time: blockData.block_time,
     signer_bitvec: signerBitvec,

tests/api/address.test.ts

@@ -93,6 +93,7 @@ describe('address tests', () => {
       execution_cost_write_count: 0,
       execution_cost_write_length: 0,
       tx_count: 1,
+      tx_total_size: 1,
       signer_bitvec: null,
       signer_signatures: null,
     };
@@ -1171,6 +1172,7 @@ describe('address tests', () => {
       execution_cost_write_count: 0,
       execution_cost_write_length: 0,
       tx_count: 1,
+      tx_total_size: 1,
       signer_bitvec: null,
       signer_signatures: null,
     };
@@ -2390,6 +2392,7 @@ describe('address tests', () => {
       execution_cost_write_count: 0,
       execution_cost_write_length: 0,
       tx_count: 1,
+      tx_total_size: 1,
       signer_bitvec: null,
       signer_signatures: null,
     };

tests/api/block.test.ts

@@ -87,6 +87,7 @@ describe('block tests', () => {
       execution_cost_write_count: 0,
       execution_cost_write_length: 0,
       tx_count: 1,
+      tx_total_size: 1,
       signer_bitvec: null,
       signer_signatures: null,
     };

tests/api/cache-control.test.ts

@@ -60,6 +60,7 @@ describe('cache-control tests', () => {
       execution_cost_write_count: 0,
       execution_cost_write_length: 0,
       tx_count: 1,
+      tx_total_size: 1,
       signer_bitvec: null,
       signer_signatures: null,
     };