feat: handle pox-3 force unlocks

Author: zone117x

docs/api/info/get-status.schema.json

@@ -23,6 +23,10 @@
       "type": "integer",
       "nullable": true
     },
+    "pox_v3_unlock_height": {
+      "type": "integer",
+      "nullable": true
+    },
     "chain_tip": {
       "$ref": "../../entities/info/chain-tip.schema.json"
     }

docs/generated.d.ts

@@ -1669,6 +1669,7 @@ export interface ServerStatusResponse {
   status: string;
   pox_v1_unlock_height?: number;
   pox_v2_unlock_height?: number;
+  pox_v3_unlock_height?: number;
   chain_tip?: ChainTip;
 }
 /**

migrations/1701368149776_nakamoto-txs.js

@@ -1,5 +1,13 @@
 /** @param { import("node-pg-migrate").MigrationBuilder } pgm */
 exports.up = pgm => {
+  pgm.addColumn('pox_state', { 
+    pox_v3_unlock_height: {
+      type: 'bigint',
+      notNull: true,
+      default: 0,
+    },
+  });
+
   pgm.addColumns('txs', {
     // `nakamoto-coinbase` tx types
     coinbase_vrf_proof: 'bytea',

src/api/routes/status.ts

@@ -17,6 +17,7 @@ export function createStatusRouter(db: PgStore): express.Router {
       if (poxForceUnlockHeights.found) {
         response.pox_v1_unlock_height = poxForceUnlockHeights.result.pox1UnlockHeight as number;
         response.pox_v2_unlock_height = poxForceUnlockHeights.result.pox2UnlockHeight as number;
+        response.pox_v3_unlock_height = poxForceUnlockHeights.result.pox3UnlockHeight as number;
       }
       const chainTip = await db.getChainTip();
       if (chainTip.block_height > 0) {

src/datastore/common.ts

@@ -569,6 +569,7 @@ export interface DataStoreBlockUpdateData {
   txs: DataStoreTxEventData[];
   pox_v1_unlock_height?: number;
   pox_v2_unlock_height?: number;
+  pox_v3_unlock_height?: number;
 }
 
 export interface DataStoreMicroblockUpdateData {

src/datastore/pg-store.ts

@@ -287,11 +287,17 @@ export class PgStore extends BasePgStore {
     });
   }
 
-  async getPoxForcedUnlockHeightsInternal(
-    sql: PgSqlClient
-  ): Promise<FoundOrNot<{ pox1UnlockHeight: number | null; pox2UnlockHeight: number | null }>> {
-    const query = await sql<{ pox_v1_unlock_height: string; pox_v2_unlock_height: string }[]>`
-      SELECT pox_v1_unlock_height, pox_v2_unlock_height
+  async getPoxForcedUnlockHeightsInternal(sql: PgSqlClient): Promise<
+    FoundOrNot<{
+      pox1UnlockHeight: number | null;
+      pox2UnlockHeight: number | null;
+      pox3UnlockHeight: number | null;
+    }>
+  > {
+    const query = await sql<
+      { pox_v1_unlock_height: string; pox_v2_unlock_height: string; pox_v3_unlock_height: string }[]
+    >`
+      SELECT pox_v1_unlock_height, pox_v2_unlock_height, pox_v3_unlock_height
       FROM pox_state
       LIMIt 1
     `;
@@ -300,10 +306,11 @@ export class PgStore extends BasePgStore {
     }
     const pox1UnlockHeight = parseInt(query[0].pox_v1_unlock_height) || null;
     const pox2UnlockHeight = parseInt(query[0].pox_v2_unlock_height) || null;
+    const pox3UnlockHeight = parseInt(query[0].pox_v3_unlock_height) || null;
     if (pox2UnlockHeight === 0) {
       return { found: false };
     }
-    return { found: true, result: { pox1UnlockHeight, pox2UnlockHeight } };
+    return { found: true, result: { pox1UnlockHeight, pox2UnlockHeight, pox3UnlockHeight } };
   }
 
   async getPoxForceUnlockHeights() {

src/datastore/pg-write-store.ts

@@ -325,6 +325,14 @@ export class PgWriteStore extends PgStore {
           WHERE pox_v2_unlock_height != ${data.pox_v2_unlock_height}
         `;
       }
+      if (isCanonical && data.pox_v3_unlock_height !== undefined) {
+        // update the pox_state.pox_v3_unlock_height singleton
+        await sql`
+          UPDATE pox_state
+          SET pox_v3_unlock_height = ${data.pox_v3_unlock_height}
+          WHERE pox_v3_unlock_height != ${data.pox_v3_unlock_height}
+        `;
+      }
 
       // When receiving first block, check if "block 0" boot data was received,
       // if so, update their properties to correspond to "block 1", since we treat

src/event-stream/core-node-message.ts

@@ -254,6 +254,7 @@ export interface CoreNodeBlockMessage {
   }[];
   pox_v1_unlock_height?: number;
   pox_v2_unlock_height?: number;
+  pox_v3_unlock_height?: number;
 }
 
 export interface CoreNodeParsedTxMessage {

src/event-stream/event-server.ts

@@ -321,6 +321,7 @@ async function handleBlockMessage(
     txs: parseDataStoreTxEventData(parsedTxs, msg.events, msg, chainId),
     pox_v1_unlock_height: msg.pox_v1_unlock_height,
     pox_v2_unlock_height: msg.pox_v2_unlock_height,
+    pox_v3_unlock_height: msg.pox_v3_unlock_height,
   };
 
   await db.update(dbData);