fix: pox 4 revoke events

.github/workflows/ci.yml

@@ -855,7 +855,6 @@ jobs:
       - lint
       - lint-docs
       - test
-      - test-2_5
       - test-bns
       - test-rosetta
       - test-rosetta-cli-construction

client/src/generated/models/RosettaOptions.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Stacks Blockchain API
- * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/get-started/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json) 
  *
  * The version of the OpenAPI document: STACKS_API_VERSION
  * 
@@ -139,6 +139,12 @@ export interface RosettaOptions {
      * @memberof RosettaOptions
      */
     pox_addr?: string;
+    /**
+     * The hex-encoded signer key (buff 33) for PoX.
+     * @type {string}
+     * @memberof RosettaOptions
+     */
+    signer_key?: string;
 }
 
 export function RosettaOptionsFromJSON(json: any): RosettaOptions {
@@ -171,6 +177,7 @@ export function RosettaOptionsFromJSONTyped(json: any, ignoreDiscriminator: bool
         'burn_block_height': !exists(json, 'burn_block_height') ? undefined : json['burn_block_height'],
         'delegate_to': !exists(json, 'delegate_to') ? undefined : json['delegate_to'],
         'pox_addr': !exists(json, 'pox_addr') ? undefined : json['pox_addr'],
+        'signer_key': !exists(json, 'signer_key') ? undefined : json['signer_key'],
     };
 }
 
@@ -203,6 +210,7 @@ export function RosettaOptionsToJSON(value?: RosettaOptions | null): any {
         'burn_block_height': value.burn_block_height,
         'delegate_to': value.delegate_to,
         'pox_addr': value.pox_addr,
+        'signer_key': value.signer_key,
     };
 }
 

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

@@ -1,17 +1,17 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "hirosystems/stacks-api-e2e:stacks3.0-800259e"
+    image: 'hirosystems/stacks-api-e2e:stacks3.0-1d675fd'
     restart: on-failure
     environment:
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
       BLOCKSTACK_USE_TEST_GENESIS_CHAINSTATE: 1
       NOP_BLOCKSTACK_DEBUG: 1
     ports:
-      - "20443:20443"
-      - "20444:20444"
+      - '20443:20443'
+      - '20444:20444'
     volumes:
       - ../stacks-blockchain/:/app/config
       - ../stacks-blockchain/.chaindata:/tmp/stacks-blockchain-data
     extra_hosts:
-      - "host.docker.internal:host-gateway" # fixes `host.docker.internal` on linux hosts
+      - 'host.docker.internal:host-gateway' # fixes `host.docker.internal` on linux hosts

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

@@ -1,16 +1,16 @@
 version: '3.7'
 services:
   stacks-blockchain:
-    image: "hirosystems/stacks-api-e2e:stacks3.0-800259e"
+    image: 'hirosystems/stacks-api-e2e:stacks3.0-1d675fd'
     ports:
-      - "18443:18443" # bitcoin regtest JSON-RPC interface
-      - "18444:18444" # bitcoin regtest p2p
-      - "20443:20443" # stacks-node RPC interface
-      - "20444:20444" # stacks-node p2p
+      - '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: 0.1s
       STACKS_EVENT_OBSERVER: host.docker.internal:3700
       # STACKS_LOG_TRACE: 1
       # STACKS_LOG_DEBUG: 1
     extra_hosts:
-      - "host.docker.internal:host-gateway" # fixes `host.docker.internal` on linux hosts
+      - 'host.docker.internal:host-gateway' # fixes `host.docker.internal` on linux hosts

docs/entities/rosetta/rosetta-construction-options.schema.json

@@ -83,6 +83,10 @@
     "pox_addr": {
       "type": "string",
       "description": "The reward address for stacking transaction. It should be a valid Bitcoin address"
+    },
+    "signer_key": {
+      "type": "string",
+      "description": "The hex-encoded signer key (buff 33) for PoX."
     }
   }
 }

docs/generated.d.ts

@@ -2538,6 +2538,10 @@ export interface RosettaOptions {
    * The reward address for stacking transaction. It should be a valid Bitcoin address
    */
   pox_addr?: string;
+  /**
+   * The hex-encoded signer key (buff 33) for PoX.
+   */
+  signer_key?: string;
 }
 /**
  * The ConstructionMetadataResponse returns network-specific metadata used for transaction construction. Optionally, the implementer can return the suggested fee associated with the transaction being constructed. The caller may use this info to adjust the intent of the transaction or to create a transaction with a different account that can pay the suggested fee. Suggested fee is an array in case fee payment must occur in multiple currencies.

migrations/1706196613000_update-pox4-event-constraint.js

@@ -0,0 +1,115 @@
+/* eslint-disable camelcase */
+
+exports.shorthands = undefined;
+
+exports.up = pgm => {
+  pgm.dropConstraint('pox4_events', 'valid_event_specific_columns', { ifExists: true });
+  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
+      WHEN 'revoke-delegate-stx' THEN
+        delegate_to IS NOT NULL
+      ELSE false
+    END
+  )`
+  );
+};
+
+exports.down = pgm => {
+  pgm.dropConstraint('pox4_events', 'valid_event_specific_columns', { ifExists: true });
+
+  // constraint from migrations/1702134678728_pox_4_events.js
+  // first, remove rows that would violate the constraint
+  pgm.sql("DELETE FROM pox4_events WHERE name = 'revoke-delegate-stx';");
+  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
+  )`
+  );
+};

src/api/controllers/db-controller.ts

@@ -326,7 +326,6 @@ export function parsePoxSyntheticEvent(poxEvent: DbPoxSyntheticEvent) {
       return {
         ...baseInfo,
         data: {
-          amount_ustx: poxEvent.data.amount_ustx.toString(),
           delegate_to: poxEvent.data.delegate_to,
         },
       };