feat: ingestion for TenureChange and NakamotoCoinbase tx types (#1753)

* feat: ingestion for TenureChange and NakamotoCoinbase tx types

* fix: add new tx fields to batch tx insert query

* chore: bump stacks-encoding-native-js

* test: fix flaky socket-io timeout test

Author: zone117x

.vscode/launch.json

@@ -48,6 +48,26 @@
       },
       "killBehavior": "polite",
     },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch: w/ postgres",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "runtimeArgs": ["-r", "ts-node/register/transpile-only", "-r", "tsconfig-paths/register"],
+      "args": ["${workspaceFolder}/src/index.ts"],
+      "outputCapture": "std",
+      "internalConsoleOptions": "openOnSessionStart",
+      "preLaunchTask": "deploy:pg",
+      "postDebugTask": "stop:pg",
+      "env": {
+        "STACKS_CHAIN_ID": "0x80000000",
+        "NODE_ENV": "development",
+        "TS_NODE_SKIP_IGNORE": "true"
+      },
+      "killBehavior": "polite",
+    },
     {
       "type": "node",
       "request": "launch",

.vscode/tasks.json

@@ -44,6 +44,29 @@
       },
       "presentation": { "echo": true, "reveal": "always", "focus": false, "panel": "dedicated", "clear": false }
     },
+    {
+      "label": "deploy:pg",
+      "type": "shell",
+      "command": "docker compose -f docker/docker-compose.dev.postgres.yml up --force-recreate -V",
+      "isBackground": true,
+      "problemMatcher": [{
+        "pattern": [{ "regexp": ".", "file": 1, "location": 2, "message": 3 }],
+        "background": { "activeOnStart": true, "beginsPattern": ".", "endsPattern": "." }
+      }],
+      "presentation": { "echo": true, "reveal": "always", "focus": false, "panel": "dedicated", "clear": false }
+    },
+    {
+      "label": "stop:pg",
+      "type": "shell",
+      "command": "docker compose -f docker/docker-compose.dev.postgres.yml down -v -t 0",
+      "presentation": {
+        "echo": true,
+        "reveal": "silent",
+        "focus": false,
+        "panel": "shared",
+        "clear": false
+      }
+    },
     {
       "label": "deploy:subnets",
       "type": "shell",

docs/entities/mempool-transactions/transaction-7-tenure-change.schema.json

@@ -0,0 +1,13 @@
+{
+  "type": "object",
+  "title": "MempoolTenureChangeTransaction",
+  "description": "Describes representation of a Type 7 Stacks transaction: Tenure Change",
+  "allOf": [
+    {
+      "$ref": "./abstract-transaction.schema.json"
+    },
+    {
+      "$ref": "../transactions/transaction-7-tenure-change-metadata.schema.json"
+    }
+  ]
+}

docs/entities/mempool-transactions/transaction.schema.json

@@ -17,6 +17,9 @@
     },
     {
       "$ref": "./transaction-4-coinbase.schema.json"
+    },
+    {
+      "$ref": "./transaction-7-tenure-change.schema.json"
     }
   ]
 }

docs/entities/transactions/transaction-4-coinbase-metadata.schema.json

@@ -22,6 +22,11 @@
           "type": "string",
           "nullable": true,
           "description": "A principal that will receive the miner rewards for this coinbase transaction. Can be either a standard principal or contract principal. Only specified for `coinbase-to-alt-recipient` transaction types, otherwise null."
+        },
+        "vrf_proof": {
+          "type": "string",
+          "nullable": true,
+          "description": "Hex encoded 80-byte VRF proof"
         }
       }
     }

docs/entities/transactions/transaction-7-tenure-change-metadata.schema.json

@@ -0,0 +1,45 @@
+{
+  "type": "object",
+  "title": "TenureChangeTransactionMetadata",
+  "description": "Describes representation of a Type 7 Stacks transaction: Tenure Change",
+  "required": ["tx_type"],
+  "additionalProperties": false,
+  "properties": {
+    "tx_type": {
+      "type": "string",
+      "enum": ["tenure_change"]
+    },
+    "tenure_change_payload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["previous_tenure_end", "previous_tenure_blocks", "cause", "pubkey_hash", "signature", "signers"],
+      "properties": {
+        "previous_tenure_end": {
+          "type": "string",
+          "description": "(Hex string) Stacks Block hash"
+        },
+        "previous_tenure_blocks": {
+          "type": "number",
+          "description": "The number of blocks produced in the previous tenure."
+        },
+        "cause": {
+          "type": "string",
+          "enum": ["block_found", "no_block_found", "null_miner"],
+          "description": "Cause of change in mining tenure. Depending on cause, tenure can be ended or extended."
+        },
+        "pubkey_hash": {
+          "type": "string",
+          "description": "(Hex string) The ECDSA public key hash of the current tenure."
+        },
+        "signature": {
+          "type": "string",
+          "description": "(Hex string) A Schnorr signature from the Stackers."
+        },
+        "signers": {
+          "type": "string",
+          "description": "(Hex string) A bitmap of which Stackers signed."
+        }
+      }
+    }
+  }
+}

docs/entities/transactions/transaction-7-tenure-change.example.json

@@ -0,0 +1,25 @@
+{
+  "tx_id": "0x5e9f3933e358df6a73fec0d47ce3e1062c20812c129f5294e6f37a8d27c051d9",
+  "tx_status": "success",
+  "tx_type": "coinbase",
+  "fee_rate": "0",
+  "sender_address": "ST3WCQ6S0DFT7YHF53M8JPKGDS1N1GSSR91677XF1",
+  "sponsored": false,
+  "post_condition_mode": "deny",
+  "is_unanchored": false,
+  "microblock_hash": "",
+  "microblock_sequence": 2147483647,
+  "microblock_canonical": true,
+  "block_hash": "0x58412b50266debd0c35b1a20348ad9c0f17e5525fb155a97033256c83c9e2491",
+  "block_height": 3231,
+  "burn_block_time": 1594230455,
+  "canonical": true,
+  "tx_index": 0,
+  "tx_result": {
+    "hex": "0x03",
+    "repr": "true"
+  },
+  "coinbase_payload": {
+    "data": "0x0000000000000000000000000000000000000000000000000000000000000000"
+  }
+}

docs/entities/transactions/transaction-7-tenure-change.schema.json

@@ -0,0 +1,13 @@
+{
+  "type": "object",
+  "title": "TenureChangeTransaction",
+  "description": "Describes representation of a Type 7 Stacks transaction: Tenure Change",
+  "allOf": [
+    {
+      "$ref": "./abstract-transaction.schema.json"
+    },
+    {
+      "$ref": "./transaction-7-tenure-change-metadata.schema.json"
+    }
+  ]
+}

docs/entities/transactions/transaction-metadata.schema.json

@@ -16,6 +16,9 @@
     },
     {
       "$ref": "./transaction-4-coinbase-metadata.schema.json"
+    },
+    {
+      "$ref": "./transaction-7-tenure-change-metadata.schema.json"
     }
   ]
 }

docs/entities/transactions/transaction-type.schema.json

@@ -2,5 +2,5 @@
   "title": "TransactionType",
   "description": "String literal of all Stacks 2.0 transaction types",
   "type": "string",
-  "enum": ["token_transfer", "smart_contract", "contract_call", "poison_microblock", "coinbase"]
+  "enum": ["token_transfer", "smart_contract", "contract_call", "poison_microblock", "coinbase", "tenure_change"]
 }