fix: report locked STX balance correctly when multiple event entries exist from stack-increase and stack-extend operations (#1363)

* chore: lint fixes

* chore: test moving migration files to non-ts source

* chore: rename migration file exts to js

* chore: fix pg migrations failing from certain jest scripts

* chore: cleanup jest.config.2.1.js

* chore: lint fix (revert)

* test: ensure locked stx balance event data has expected values after pox-2 stack-increase operation

* test: ensure stx unlock height event data has expected value after pox-2 stack-extend operation

* fix: report locked STX balance correctly when multiple event entries exist from stack-increase and stack-extend operations

* chore: refactor PoX-2 operation steps into separate tests

* chore: test scaffolding for pox-2 rewards

* chore: lint fixes

* test: validate Stacking slots and rewards after PoX-2 operations

* chore: update to bitcoin-v0.21.1 in stacks-2.1 test suite

* test: add additional 1 block padding to unlock height waiter for test flakiness

Author: zone117x

.vscode/tasks.json

@@ -25,7 +25,7 @@
     {
       "label": "deploy:krypton",
       "type": "shell",
-      "command": "docker-compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton.yml up",
+      "command": "docker compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton.yml up",
       "isBackground": true,
       "problemMatcher": {
         "pattern": { "regexp": ".", "file": 1, "location": 2, "message": 3 },
@@ -36,7 +36,7 @@
     {
       "label": "stop:krypton",
       "type": "shell",
-      "command": "docker-compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton.yml down -v -t 0",
+      "command": "docker compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton.yml down -v -t 0",
       "presentation": {
         "echo": true,
         "reveal": "silent",
@@ -48,7 +48,7 @@
     {
       "label": "deploy:krypton-2.1-transition",
       "type": "shell",
-      "command": "docker-compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton-2.1-transition.yml up",
+      "command": "docker compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton-2.1-transition.yml up",
       "isBackground": true,
       "problemMatcher": {
         "pattern": { "regexp": ".", "file": 1, "location": 2, "message": 3 },
@@ -59,7 +59,7 @@
     {
       "label": "stop:krypton-2.1-transition",
       "type": "shell",
-      "command": "docker-compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton-2.1-transition.yml down -v -t 0",
+      "command": "docker compose -f docker/docker-compose.dev.postgres.yml -f docker/docker-compose.dev.stacks-krypton-2.1-transition.yml down -v -t 0",
       "presentation": {
         "echo": true,
         "reveal": "silent",

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

@@ -1,13 +1,16 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "zone117x/stacks-api-e2e:stacks2.1-transition-dd8f051"
+    image: "zone117x/stacks-api-e2e:stacks2.1-transition-8fb8b77"
     ports:
-      - "18443:18443"
-      - "18444:18444"
-      - "20443:20443"
-      - "20444:20444"
+      - "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
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
-      NOP_BLOCKSTACK_DEBUG: 1
+      # STACKS_LOG_TRACE: 1
+      # STACKS_LOG_DEBUG: 1
+    extra_hosts:
+      - "host.docker.internal:host-gateway" # fixes `host.docker.internal` on linux hosts

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

@@ -1,15 +1,16 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "zone117x/stacks-api-e2e:stacks2.1-dd8f051"
+    image: "zone117x/stacks-api-e2e:stacks2.1-8fb8b77"
     ports:
-      - "18443:18443"
-      - "18444:18444"
-      - "20443:20443"
-      - "20444:20444"
+      - "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
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
-      NOP_BLOCKSTACK_DEBUG: 1
+      # STACKS_LOG_TRACE: 1
+      # STACKS_LOG_DEBUG: 1
     extra_hosts:
-      - "host.docker.internal:host-gateway"
+      - "host.docker.internal:host-gateway" # fixes `host.docker.internal` on linux hosts

src/migrations/1584604583726_blocks.ts renamed to migrations/1584604583726_blocks.js

@@ -1,8 +1,5 @@
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export const shorthands: ColumnDefinitions | undefined = undefined;
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('blocks', {
     index_block_hash: {
       type: 'bytea',

src/migrations/1584619633448_txs.ts renamed to migrations/1584619633448_txs.js

@@ -1,6 +1,5 @@
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('txs', {
     id: {
       type: 'serial',

src/migrations/1588252682585_stx_events.ts renamed to migrations/1588252682585_stx_events.js

@@ -1,6 +1,5 @@
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('stx_events', {
     id: {
       type: 'serial',

src/migrations/1588256295395_ft_events.ts renamed to migrations/1588256295395_ft_events.js

@@ -1,6 +1,5 @@
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('ft_events', {
     id: {
       type: 'serial',

src/migrations/1588261750265_nft_events.ts renamed to migrations/1588261750265_nft_events.js

@@ -1,6 +1,5 @@
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('nft_events', {
     id: {
       type: 'serial',

src/migrations/1588266401242_contract_logs.ts renamed to migrations/1588266401242_contract_logs.js

@@ -1,6 +1,5 @@
-import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('contract_logs', {
     id: {
       type: 'serial',

src/migrations/1588266891631_smart_contracts.ts renamed to migrations/1588266891631_smart_contracts.js

@@ -1,6 +1,5 @@
-import {  MigrationBuilder } from 'node-pg-migrate';
-
-export async function up(pgm: MigrationBuilder): Promise<void> {
+/** @param { import("node-pg-migrate").MigrationBuilder } pgm */
+exports.up = pgm => {
   pgm.createTable('smart_contracts', {
     id: {
       type: 'serial',