feat: store Stacks block miner address value from new rewards payload introduced in stacks-network/stacks-core#3373 (#1413)

Author: zone117x

docker/docker-compose.dev.stacks-krypton-2.1-transition.yml

@@ -1,14 +1,15 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "zone117x/stacks-api-e2e:stacks2.1-transition-feat-segwit-dcae03a"
+    image: "zone117x/stacks-api-e2e:stacks2.1-transition-d17c6a4"
     ports:
       - "18443:18443" # bitcoin regtest JSON-RPC interface
       - "18444:18444" # bitcoin regtest p2p
       - "20443:20443" # stacks-node RPC interface
       - "20444:20444" # stacks-node p2p
     environment:
       MINE_INTERVAL: 2s
+      REWARD_RECIPIENT: STQM73RQC4EX0A07KWG1J5ECZJYBZS4SJ4ERC6WN
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
       # STACKS_LOG_TRACE: 1
       # STACKS_LOG_DEBUG: 1

docker/docker-compose.dev.stacks-krypton.yml

@@ -1,7 +1,7 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "zone117x/stacks-api-e2e:stacks2.1-feat-segwit-dcae03a"
+    image: "zone117x/stacks-api-e2e:stacks2.1-d17c6a4"
     ports:
       - "18443:18443" # bitcoin regtest JSON-RPC interface
       - "18444:18444" # bitcoin regtest p2p

migrations/1605184662317_miner_rewards.js

@@ -29,6 +29,9 @@ exports.up = pgm => {
       type: 'string',
       notNull: true,
     },
+    miner_address: {
+      type: 'string',
+    },
     coinbase_amount: {
       type: 'numeric',
       notNull: true,
@@ -49,5 +52,6 @@ exports.up = pgm => {
 
   pgm.createIndex('miner_rewards', 'index_block_hash', { method: 'hash' });
   pgm.createIndex('miner_rewards', 'recipient', { method: 'hash' });
+  pgm.createIndex('miner_rewards', 'miner_address');
   pgm.createIndex('miner_rewards', [{ name: 'mature_block_height', sort: 'DESC' }]);
 }

src/datastore/common.ts

@@ -72,6 +72,8 @@ export interface DbMinerReward {
   canonical: boolean;
   /** STX principal */
   recipient: string;
+  /** STX principal */
+  miner_address: string | null;
   coinbase_amount: bigint;
   tx_fees_anchored: bigint;
   tx_fees_streamed_confirmed: bigint;
@@ -1020,6 +1022,7 @@ export interface MinerRewardInsertValues {
   mature_block_height: number;
   canonical: boolean;
   recipient: string;
+  miner_address: string | null;
   coinbase_amount: PgNumeric;
   tx_fees_anchored: PgNumeric;
   tx_fees_streamed_confirmed: PgNumeric;

src/datastore/pg-store.ts

@@ -880,13 +880,14 @@ export class PgStore {
         index_block_hash: string;
         mature_block_height: number;
         recipient: string;
+        miner_address: string | null;
         coinbase_amount: number;
         tx_fees_anchored: number;
         tx_fees_streamed_confirmed: number;
         tx_fees_streamed_produced: number;
       }[]
     >`
-      SELECT id, mature_block_height, recipient, block_hash, index_block_hash, from_index_block_hash,
+      SELECT id, mature_block_height, recipient, miner_address, block_hash, index_block_hash, from_index_block_hash,
         canonical, coinbase_amount, tx_fees_anchored, tx_fees_streamed_confirmed, tx_fees_streamed_produced
       FROM miner_rewards
       WHERE canonical = true AND mature_block_height = ${blockHeight}
@@ -900,6 +901,8 @@ export class PgStore {
         canonical: true,
         mature_block_height: r.mature_block_height,
         recipient: r.recipient,
+        // If `miner_address` is null then it means pre-Stacks2.1 data, and the `recipient` can be accurately used
+        miner_address: r.miner_address ?? r.recipient,
         coinbase_amount: BigInt(r.coinbase_amount),
         tx_fees_anchored: BigInt(r.tx_fees_anchored),
         tx_fees_streamed_confirmed: BigInt(r.tx_fees_streamed_confirmed),

src/datastore/pg-write-store.ts

@@ -434,6 +434,8 @@ export class PgWriteStore extends PgStore {
       mature_block_height: minerReward.mature_block_height,
       canonical: minerReward.canonical,
       recipient: minerReward.recipient,
+      // If `miner_address` is null then it means pre-Stacks2.1 data, and the `recipient` can be accurately used
+      miner_address: minerReward.miner_address ?? minerReward.recipient,
       coinbase_amount: minerReward.coinbase_amount.toString(),
       tx_fees_anchored: minerReward.tx_fees_anchored.toString(),
       tx_fees_streamed_confirmed: minerReward.tx_fees_streamed_confirmed.toString(),

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

@@ -216,6 +216,8 @@ export interface CoreNodeBlockMessage {
     from_stacks_block_hash: string;
     /** STX principal */
     recipient: string;
+    /** STX principal (available starting in Stacks 2.1) */
+    miner_address: string | null;
     /** String quoted micro-STX amount. */
     coinbase_amount: string;
     /** String quoted micro-STX amount. */

src/event-stream/event-server.ts

@@ -265,6 +265,8 @@ async function handleBlockMessage(
       from_index_block_hash: minerReward.from_index_consensus_hash,
       mature_block_height: msg.block_height,
       recipient: minerReward.recipient,
+      // If `miner_address` is null then it means pre-Stacks2.1 data, and the `recipient` can be accurately used
+      miner_address: minerReward.miner_address ?? minerReward.recipient,
       coinbase_amount: BigInt(minerReward.coinbase_amount),
       tx_fees_anchored: BigInt(minerReward.tx_fees_anchored),
       tx_fees_streamed_confirmed: BigInt(minerReward.tx_fees_streamed_confirmed),

src/test-utils/test-builders.ts

@@ -504,6 +504,7 @@ function testMinerReward(args?: TestMinerRewardArgs): DbMinerReward {
     mature_block_height: args?.mature_block_height ?? BLOCK_HEIGHT,
     canonical: args?.canonical ?? true,
     recipient: args?.recipient ?? MINER_RECIPIENT,
+    miner_address: args?.recipient ?? MINER_RECIPIENT,
     coinbase_amount: args?.coinbase_amount ?? COINBASE_AMOUNT,
     tx_fees_anchored: args?.tx_fees_anchored ?? TX_FEES_ANCHORED,
     tx_fees_streamed_confirmed: args?.tx_fees_streamed_confirmed ?? TX_FEES_STREAMED_CONFIRMED,

src/tests/datastore-tests.ts

@@ -289,6 +289,7 @@ describe('postgres datastore', () => {
         mature_block_height: 68456,
         canonical: canonical,
         recipient: recipient,
+        miner_address: recipient,
         coinbase_amount: amount,
         tx_fees_anchored: txFeeAnchored,
         tx_fees_streamed_confirmed: txFeeConfirmed,
@@ -3546,6 +3547,7 @@ describe('postgres datastore', () => {
       from_index_block_hash: '0x33',
       mature_block_height: 3,
       recipient: 'miner-addr1',
+      miner_address: 'miner-addr1',
       coinbase_amount: 1000n,
       tx_fees_anchored: 2n,
       tx_fees_streamed_confirmed: 3n,
@@ -3760,6 +3762,7 @@ describe('postgres datastore', () => {
       mature_block_height: 3,
       from_index_block_hash: '0x11',
       recipient: 'miner-addr1',
+      miner_address: 'miner-addr1',
       coinbase_amount: 1000n,
       tx_fees_anchored: 2n,
       tx_fees_streamed_confirmed: 3n,
@@ -3771,6 +3774,7 @@ describe('postgres datastore', () => {
       mature_block_height: 4,
       from_index_block_hash: '0x22',
       recipient: 'miner-addr2',
+      miner_address: 'miner-addr2',
       coinbase_amount: 1000n,
       tx_fees_anchored: 2n,
       tx_fees_streamed_confirmed: 3n,