feat: pox-4 support

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',

migrations/1702134678728_pox_4_events.js

@@ -0,0 +1,203 @@
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
+  // Adds pox4_events table which matches previous pox2_events table
+  pgm.createTable('pox4_events', {
+    id: {
+      type: 'bigserial',
+      primaryKey: true,
+    },
+    event_index: {
+      type: 'integer',
+      notNull: true,
+    },
+    tx_id: {
+      notNull: true,
+      type: 'bytea',
+    },
+    tx_index: {
+      type: 'smallint',
+      notNull: true,
+    },
+    block_height: {
+      type: 'integer',
+      notNull: true,
+    },
+    index_block_hash: {
+      type: 'bytea',
+      notNull: true,
+    },
+    parent_index_block_hash: {
+      type: 'bytea',
+      notNull: true,
+    },
+    microblock_hash: {
+      type: 'bytea',
+      notNull: true,
+    },
+    microblock_sequence: {
+      type: 'integer',
+      notNull: true,
+    },
+    microblock_canonical: {
+      type: 'boolean',
+      notNull: true,
+    },
+    canonical: {
+      type: 'boolean',
+      notNull: true,
+    },
+    stacker: {
+      type: 'string',
+      notNull: true,
+    },
+    locked: {
+      type: 'numeric',
+      notNull: true,
+    },
+    balance: {
+      type: 'numeric',
+      notNull: true,
+    },
+    burnchain_unlock_height: {
+      type: 'bigint',
+      notNull: true,
+    },
+    name: {
+      type: 'string',
+      notNull: true,
+    },
+    pox_addr: {
+      type: 'string',
+    },
+    pox_addr_raw: {
+      type: 'bytea',
+    },
+    first_cycle_locked: {
+      // unique to handle-unlock
+      type: 'numeric',
+    },
+    first_unlocked_cycle: {
+      // unique to handle-unlock
+      type: 'numeric',
+    },
+    delegate_to: {
+      // unique to delegate-stx
+      type: 'string',
+    },
+    lock_period: {
+      // unique to stack-stx, delegate-stack-stx
+      type: 'numeric',
+    },
+    lock_amount: {
+      // unique to stack-stx, delegate-stack-stx
+      type: 'numeric',
+    },
+    start_burn_height: {
+      // unique to stack-stx, delegate-stack-stx
+      type: 'numeric',
+    },
+    unlock_burn_height: {
+      // unique to stack-stx, stack-extend, delegate-stack-stx, delegate-stack-extend, delegate-stx
+      type: 'numeric',
+    },
+    delegator: {
+      // unique to delegate-stack-stx, delegate-stack-increase, delegate-stack-extend
+      type: 'string',
+    },
+    increase_by: {
+      // unique to stack-increase, delegate-stack-increase
+      type: 'numeric',
+    },
+    total_locked: {
+      // unique to stack-increase, delegate-stack-increase
+      type: 'numeric',
+    },
+    extend_count: {
+      // unique to stack-extend, delegate-stack-extend
+      type: 'numeric',
+    },
+    reward_cycle: {
+      // unique to stack-aggregation-*
+      type: 'numeric',
+    },
+    amount_ustx: {
+      // unique to stack-aggregation-*, delegate-stx
+      type: 'numeric',
+    },
+  });
+
+  pgm.addConstraint(
+    'pox4_events',
+    'valid_event_specific_columns',
+    `CHECK (
+    CASE name
+      WHEN 'handle-unlock' THEN
+        first_cycle_locked IS NOT NULL AND
+        first_unlocked_cycle IS NOT NULL
+      WHEN 'stack-stx' THEN
+        lock_period IS NOT NULL AND
+        lock_amount IS NOT NULL AND
+        start_burn_height IS NOT NULL AND
+        unlock_burn_height IS NOT NULL
+      WHEN 'stack-increase' THEN
+        increase_by IS NOT NULL AND
+        total_locked IS NOT NULL
+      WHEN 'stack-extend' THEN
+        extend_count IS NOT NULL AND
+        unlock_burn_height IS NOT NULL
+      WHEN 'delegate-stx' THEN
+        amount_ustx IS NOT NULL AND
+        delegate_to IS NOT NULL
+      WHEN 'delegate-stack-stx' THEN
+        lock_period IS NOT NULL AND
+        lock_amount IS NOT NULL AND
+        start_burn_height IS NOT NULL AND
+        unlock_burn_height IS NOT NULL AND
+        delegator IS NOT NULL
+      WHEN 'delegate-stack-increase' THEN
+        increase_by IS NOT NULL AND
+        total_locked IS NOT NULL AND
+        delegator IS NOT NULL
+      WHEN 'delegate-stack-extend' THEN
+        extend_count IS NOT NULL AND
+        unlock_burn_height IS NOT NULL AND
+        delegator IS NOT NULL
+      WHEN 'stack-aggregation-commit' THEN
+        reward_cycle IS NOT NULL AND
+        amount_ustx IS NOT NULL
+      WHEN 'stack-aggregation-commit-indexed' THEN
+        reward_cycle IS NOT NULL AND
+        amount_ustx IS NOT NULL
+      WHEN 'stack-aggregation-increase' THEN
+        reward_cycle IS NOT NULL AND
+        amount_ustx IS NOT NULL
+      ELSE false
+    END
+  )`
+  );
+
+  pgm.createIndex('pox4_events', [
+    { name: 'block_height', sort: 'DESC' },
+    { name: 'microblock_sequence', sort: 'DESC' },
+    { name: 'tx_index', sort: 'DESC' },
+    { name: 'event_index', sort: 'DESC' },
+  ]);
+
+  pgm.createIndex('pox4_events', 'tx_id');
+  pgm.createIndex('pox4_events', 'index_block_hash');
+  pgm.createIndex('pox4_events', 'microblock_hash');
+
+  pgm.createIndex('pox4_events', 'stacker');
+  pgm.createIndex('pox4_events', 'burnchain_unlock_height');
+  pgm.createIndex('pox4_events', 'pox_addr');
+  pgm.createIndex('pox4_events', 'delegator');
+  pgm.createIndex('pox4_events', 'name');
+
+  pgm.createIndex('pox4_events', 'delegate_to');
+  pgm.createIndex('pox4_events', 'unlock_burn_height');
+};
+
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.down = pgm => {
+  pgm.dropTable('pox4_events');
+};

src/api/controllers/db-controller.ts

@@ -59,14 +59,13 @@ import {
   BaseTx,
   DbMinerReward,
   StxUnlockEvent,
-  DbPox2Event,
-  DbPox3Event,
+  DbPoxSyntheticEvent,
 } from '../../datastore/common';
 import { unwrapOptional, FoundOrNot, unixEpochToIso, EMPTY_HASH_256, ChainID } from '../../helpers';
 import { serializePostCondition, serializePostConditionMode } from '../serializers/post-conditions';
 import { getOperations, parseTransactionMemo } from '../../rosetta/rosetta-helpers';
 import { PgStore } from '../../datastore/pg-store';
-import { Pox2EventName } from '../../pox-helpers';
+import { SyntheticPoxEventName } from '../../pox-helpers';
 import { logger } from '../../logger';
 
 export function parseTxTypeStrings(values: string[]): TransactionType[] {
@@ -193,7 +192,7 @@ export function getAssetEventTypeString(
   }
 }
 
-export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
+export function parsePoxSyntheticEvent(poxEvent: DbPoxSyntheticEvent) {
   const baseInfo = {
     block_height: poxEvent.block_height,
     tx_id: poxEvent.tx_id,
@@ -208,7 +207,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
     name: poxEvent.name,
   };
   switch (poxEvent.name) {
-    case Pox2EventName.HandleUnlock: {
+    case SyntheticPoxEventName.HandleUnlock: {
       return {
         ...baseInfo,
         data: {
@@ -217,7 +216,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.StackStx: {
+    case SyntheticPoxEventName.StackStx: {
       return {
         ...baseInfo,
         data: {
@@ -228,7 +227,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.StackIncrease: {
+    case SyntheticPoxEventName.StackIncrease: {
       return {
         ...baseInfo,
         data: {
@@ -237,7 +236,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.StackExtend: {
+    case SyntheticPoxEventName.StackExtend: {
       return {
         ...baseInfo,
         data: {
@@ -246,7 +245,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.DelegateStx: {
+    case SyntheticPoxEventName.DelegateStx: {
       return {
         ...baseInfo,
         data: {
@@ -256,7 +255,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.DelegateStackStx: {
+    case SyntheticPoxEventName.DelegateStackStx: {
       return {
         ...baseInfo,
         data: {
@@ -268,7 +267,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.DelegateStackIncrease: {
+    case SyntheticPoxEventName.DelegateStackIncrease: {
       return {
         ...baseInfo,
         data: {
@@ -278,7 +277,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.DelegateStackExtend: {
+    case SyntheticPoxEventName.DelegateStackExtend: {
       return {
         ...baseInfo,
         data: {
@@ -288,7 +287,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.StackAggregationCommit: {
+    case SyntheticPoxEventName.StackAggregationCommit: {
       return {
         ...baseInfo,
         data: {
@@ -297,7 +296,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.StackAggregationCommitIndexed: {
+    case SyntheticPoxEventName.StackAggregationCommitIndexed: {
       return {
         ...baseInfo,
         data: {
@@ -306,7 +305,7 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
-    case Pox2EventName.StackAggregationIncrease: {
+    case SyntheticPoxEventName.StackAggregationIncrease: {
       return {
         ...baseInfo,
         data: {
@@ -315,8 +314,17 @@ export function parsePox2Event(poxEvent: DbPox2Event | DbPox3Event) {
         },
       };
     }
+    case SyntheticPoxEventName.RevokeDelegateStx: {
+      return {
+        ...baseInfo,
+        data: {
+          amount_ustx: poxEvent.data.amount_ustx.toString(),
+          delegate_to: poxEvent.data.delegate_to,
+        },
+      };
+    }
     default:
-      throw new Error(`Unexpected Pox2 event name ${(poxEvent as DbPox2Event).name}`);
+      throw new Error(`Unexpected Pox2 event name ${(poxEvent as DbPoxSyntheticEvent).name}`);
   }
 }