Merge pull request #2135 from hirosystems/develop

Cut beta

Author: zone117x

migrations/1729520843350_stacks_block_tenure-height-signer-signatures.js

@@ -0,0 +1,20 @@
+/* eslint-disable camelcase */
+
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
+
+  pgm.addColumn('blocks', {
+    tenure_height: {
+      type: 'integer',
+    }
+  });
+
+  pgm.addColumn('blocks', {
+    signer_signatures: {
+      type: 'bytea[]',
+    }
+  });
+
+  pgm.createIndex('blocks', 'signer_signatures', { method: 'gin' });
+
+};

src/api/controllers/db-controller.ts

@@ -682,6 +682,8 @@ function parseDbBlock(
       dbBlock.block_time > 0
         ? unixEpochToIso(dbBlock.block_time)
         : unixEpochToIso(dbBlock.burn_block_time),
+    // If `tenure_height` is not available, but `signer_bitvec` is set we can safely assume it's same as `block_height` (epoch2.x rules)
+    tenure_height: dbBlock.tenure_height ?? (dbBlock.signer_bitvec ? -1 : dbBlock.block_height),
     index_block_hash: dbBlock.index_block_hash,
     parent_block_hash: dbBlock.parent_block_hash,
     burn_block_time: dbBlock.burn_block_time,

src/api/pagination.ts

@@ -39,6 +39,7 @@ export enum ResourceType {
   Signer,
   PoxCycle,
   TokenHolders,
+  BlockSignerSignature,
 }
 
 export const pagingQueryLimits: Record<ResourceType, { defaultLimit: number; maxLimit: number }> = {
@@ -94,6 +95,10 @@ export const pagingQueryLimits: Record<ResourceType, { defaultLimit: number; max
     defaultLimit: 100,
     maxLimit: 200,
   },
+  [ResourceType.BlockSignerSignature]: {
+    defaultLimit: 500,
+    maxLimit: 1000,
+  },
 };
 
 export function getPagingQueryLimit(

src/api/routes/v2/blocks.ts

@@ -9,9 +9,16 @@ import { Server } from 'node:http';
 import { CursorOffsetParam, LimitParam, OffsetParam } from '../../schemas/params';
 import { getPagingQueryLimit, pagingQueryLimits, ResourceType } from '../../pagination';
 import { PaginatedResponse } from '../../schemas/util';
-import { NakamotoBlock, NakamotoBlockSchema } from '../../schemas/entities/block';
+import {
+  NakamotoBlock,
+  NakamotoBlockSchema,
+  SignerSignatureSchema,
+} from '../../schemas/entities/block';
 import { TransactionSchema } from '../../schemas/entities/transactions';
-import { BlockListV2ResponseSchema } from '../../schemas/responses/responses';
+import {
+  BlockListV2ResponseSchema,
+  BlockSignerSignatureResponseSchema,
+} from '../../schemas/responses/responses';
 
 export const BlockRoutesV2: FastifyPluginAsync<
   Record<never, never>,
@@ -174,5 +181,53 @@ export const BlockRoutesV2: FastifyPluginAsync<
     }
   );
 
+  fastify.get(
+    '/:height_or_hash/signer-signatures',
+    {
+      preHandler: handleBlockCache,
+      preValidation: (req, _reply, done) => {
+        cleanBlockHeightOrHashParam(req.params);
+        done();
+      },
+      schema: {
+        operationId: 'get_signer_signatures_for_block',
+        summary: 'Get signer signatures for block',
+        description: `Retrieves the signer signatures (an array of signature byte strings) in a single block`,
+        tags: ['Blocks'],
+        params: BlockParamsSchema,
+        querystring: Type.Object({
+          limit: LimitParam(ResourceType.BlockSignerSignature),
+          offset: OffsetParam(),
+        }),
+        response: {
+          200: BlockSignerSignatureResponseSchema,
+        },
+      },
+    },
+    async (req, reply) => {
+      const params = parseBlockParam(req.params.height_or_hash);
+      const query = req.query;
+
+      try {
+        const { limit, offset, results, total } = await fastify.db.v2.getBlockSignerSignature({
+          blockId: params,
+          ...query,
+        });
+        const response = {
+          limit,
+          offset,
+          total,
+          results: results,
+        };
+        await reply.send(response);
+      } catch (error) {
+        if (error instanceof InvalidRequestError) {
+          throw new NotFoundError('Block not found');
+        }
+        throw error;
+      }
+    }
+  );
+
   await Promise.resolve();
 };

src/api/routes/v2/helpers.ts

@@ -31,6 +31,8 @@ export function parseDbNakamotoBlock(block: DbBlock): NakamotoBlock {
     hash: block.block_hash,
     block_time: block.block_time,
     block_time_iso: unixEpochToIso(block.block_time),
+    // If `tenure_height` is not available, but `signer_bitvec` is set we can safely assume it's same as `block_height` (epoch2.x rules)
+    tenure_height: block.tenure_height ?? (block.signer_bitvec ? -1 : block.block_height),
     index_block_hash: block.index_block_hash,
     parent_block_hash: block.parent_block_hash,
     parent_index_block_hash: block.parent_index_block_hash,

src/api/routes/v2/schemas.ts

@@ -47,6 +47,14 @@ export const TransactionLimitParamSchema = Type.Integer({
   description: 'Transactions per page',
 });
 
+export const BlockSignerSignatureLimitParamSchema = Type.Integer({
+  minimum: 1,
+  maximum: pagingQueryLimits[ResourceType.BlockSignerSignature].maxLimit,
+  default: pagingQueryLimits[ResourceType.BlockSignerSignature].defaultLimit,
+  title: 'Block signer signature limit',
+  description: 'Block signer signatures per page',
+});
+
 export const PoxCycleLimitParamSchema = Type.Integer({
   minimum: 1,
   maximum: pagingQueryLimits[ResourceType.PoxCycle].maxLimit,

src/api/schemas/entities/block.ts

@@ -17,6 +17,9 @@ export const BlockSchema = Type.Object(
     block_time_iso: Type.String({
       description: 'An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.',
     }),
+    tenure_height: Type.Integer({
+      description: 'The tenure height (AKA coinbase height) of this block',
+    }),
     index_block_hash: Type.String({
       description:
         'The only hash that can uniquely identify an anchored block or an unconfirmed state trie',
@@ -93,6 +96,9 @@ export const NakamotoBlockSchema = Type.Object({
   block_time_iso: Type.String({
     description: 'An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.',
   }),
+  tenure_height: Type.Integer({
+    description: 'The tenure height (AKA coinbase height) of this block',
+  }),
   index_block_hash: Type.String({
     description:
       'The only hash that can uniquely identify an anchored block or an unconfirmed state trie',
@@ -116,3 +122,7 @@ export const NakamotoBlockSchema = Type.Object({
   execution_cost_write_length: Type.Integer({ description: 'Execution cost write length.' }),
 });
 export type NakamotoBlock = Static<typeof NakamotoBlockSchema>;
+
+export const SignerSignatureSchema = Type.String({
+  description: "Array of hex strings representing the block's signer signature",
+});

src/api/schemas/responses/responses.ts

@@ -12,7 +12,7 @@ import {
   BurnchainRewardSchema,
   BurnchainRewardSlotHolderSchema,
 } from '../entities/burnchain-rewards';
-import { NakamotoBlockSchema } from '../entities/block';
+import { NakamotoBlockSchema, SignerSignatureSchema } from '../entities/block';
 
 export const ErrorResponseSchema = Type.Object(
   {
@@ -182,3 +182,6 @@ export type RunFaucetResponse = Static<typeof RunFaucetResponseSchema>;
 
 export const BlockListV2ResponseSchema = PaginatedCursorResponse(NakamotoBlockSchema);
 export type BlockListV2Response = Static<typeof BlockListV2ResponseSchema>;
+
+export const BlockSignerSignatureResponseSchema = PaginatedResponse(SignerSignatureSchema);
+export type BlockSignerSignatureResponse = Static<typeof BlockSignerSignatureResponseSchema>;

src/datastore/common.ts

@@ -25,6 +25,8 @@ export interface DbBlock {
   tx_count: number;
   block_time: number;
   signer_bitvec: string | null;
+  signer_signatures: string[] | null;
+  tenure_height: number | null;
 }
 
 /** An interface representing the microblock data that can be constructed _only_ from the /new_microblocks payload */
@@ -862,6 +864,7 @@ export interface BlockQueryResult {
   execution_cost_write_length: string;
   tx_count: number;
   signer_bitvec: string | null;
+  tenure_height: number | null;
 }
 
 export interface MicroblockQueryResult {
@@ -1286,6 +1289,8 @@ export interface BlockInsertValues {
   execution_cost_write_length: number;
   tx_count: number;
   signer_bitvec: string | null;
+  signer_signatures: PgBytea[] | null;
+  tenure_height: number | null;
 }
 
 export interface MicroblockInsertValues {

src/datastore/helpers.ts

@@ -186,6 +186,7 @@ export const BLOCK_COLUMNS = [
   'execution_cost_write_length',
   'tx_count',
   'signer_bitvec',
+  'tenure_height',
 ];
 
 export const MICROBLOCK_COLUMNS = [
@@ -465,7 +466,6 @@ export function parseFaucetRequestQueryResult(result: FaucetRequestQueryResult):
 }
 
 export function parseBlockQueryResult(row: BlockQueryResult): DbBlock {
-  // TODO(mb): is the tx_index preserved between microblocks and committed anchor blocks?
   const block: DbBlock = {
     block_hash: row.block_hash,
     index_block_hash: row.index_block_hash,
@@ -487,6 +487,8 @@ export function parseBlockQueryResult(row: BlockQueryResult): DbBlock {
     execution_cost_write_length: Number.parseInt(row.execution_cost_write_length),
     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
+    tenure_height: row.tenure_height,
   };
   return block;
 }
@@ -1282,43 +1284,6 @@ export function convertTxQueryResultToDbMempoolTx(txs: TxQueryResult[]): DbMempo
   return dbMempoolTxs;
 }
 
-export function setTotalBlockUpdateDataExecutionCost(data: DataStoreBlockUpdateData) {
-  const cost = data.txs.reduce(
-    (previousValue, currentValue) => {
-      const {
-        execution_cost_read_count,
-        execution_cost_read_length,
-        execution_cost_runtime,
-        execution_cost_write_count,
-        execution_cost_write_length,
-      } = previousValue;
-      return {
-        execution_cost_read_count:
-          execution_cost_read_count + currentValue.tx.execution_cost_read_count,
-        execution_cost_read_length:
-          execution_cost_read_length + currentValue.tx.execution_cost_read_length,
-        execution_cost_runtime: execution_cost_runtime + currentValue.tx.execution_cost_runtime,
-        execution_cost_write_count:
-          execution_cost_write_count + currentValue.tx.execution_cost_write_count,
-        execution_cost_write_length:
-          execution_cost_write_length + currentValue.tx.execution_cost_write_length,
-      };
-    },
-    {
-      execution_cost_read_count: 0,
-      execution_cost_read_length: 0,
-      execution_cost_runtime: 0,
-      execution_cost_write_count: 0,
-      execution_cost_write_length: 0,
-    }
-  );
-  data.block.execution_cost_read_count = cost.execution_cost_read_count;
-  data.block.execution_cost_read_length = cost.execution_cost_read_length;
-  data.block.execution_cost_runtime = cost.execution_cost_runtime;
-  data.block.execution_cost_write_count = cost.execution_cost_write_count;
-  data.block.execution_cost_write_length = cost.execution_cost_write_length;
-}
-
 export function markBlockUpdateDataAsNonCanonical(data: DataStoreBlockUpdateData): void {
   data.block = { ...data.block, canonical: false };
   data.microblocks = data.microblocks.map(mb => ({ ...mb, canonical: false }));